changes: no player tp, no random, places with spaces, correct rounding

3 files changed, 330 insertions, 0 deletions

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..1625c17
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..eb1c299
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+minetest CSM which implements waypoints on top of the /teleport server side command.
+
+requirements
+------------
+
+tested with minetest 0.4.17 and 5.0.
+
+in 5.0, the server *must* have send_chat_message enabled, which is not the default.
+
+additionally, this mod will *only* work if your account has the "teleport" privilege.
+it will *not* let ordinary users teleport, unless that is a default privilege.
+
+installation
+------------
+
+make sure the mod is installed at `~/.minetest/clientmods/cs_waypoints`
+
+make sure `~/.minetest/clientmods/mods.conf` exists and contains:
+
+```
+load_mod_cs_waypoints = true
+```
+
+usage
+-----
+
+* .wp_set NAME: set a waypoint at your current location
+* .wp_unset NAME: remove a waypoint
+* .wp_list: list all waypoints
+* .tw NAME: teleport to a waypoint
+* .tw PLAYERNAME WAYPOINT_NAME: teleport another player to a waypoint
+* .tr: teleport to a random location
+* .tr ELEVATION: teleport to a random location at a given elevation (y value)
diff --git a/init.lua b/init.lua
new file mode 100644
index 0000000..70ab5c1
--- /dev/null
+++ b/init.lua
@@ -0,0 +1,176 @@
+local mod_name = minetest.get_current_modname()
+
+local function log(level, message)
+    minetest.log(level, ('[%s] %s'):format(mod_name, message))
+end
+
+log('action', 'CSM loading...')
+
+local mod_storage = minetest.get_mod_storage()
+
+
+local function load_waypoints()
+    if string.find(mod_storage:get_string('waypoints'), 'return') then
+        return minetest.deserialize(mod_storage:get_string('waypoints'))
+    else
+        return {}
+    end
+end
+
+local waypoints = load_waypoints()
+
+
+local function safe(func)
+    -- wrap a function w/ logic to avoid crashing the game
+    local f = function(...)
+        local status, out = pcall(func, ...)
+        if status then
+            return out
+        else
+            log('warning', 'Error (func):  ' .. out)
+            return nil
+        end
+    end
+    return f
+end
+
+
+local function round(x)
+    -- approved by kahan
+--    if x % 2 ~= 0.5 then
+        return math.floor(x+0.5)
+--    else
+--        return x - 0.5
+--    end
+end
+
+
+local function pairsByKeys(t, f)
+    local a = {}
+    for n in pairs(t) do
+        table.insert(a, n)
+    end
+    table.sort(a, f)
+    local i = 0
+    return function()
+        i = i + 1
+        if a[i] == nil then
+            return nil
+        else
+            return a[i], t[a[i]]
+        end
+    end
+end
+
+
+local function lc_cmp(a, b)
+    return a:lower() < b:lower()
+end
+
+
+local function tostring_point(point)
+    return ('%i %i.5 %i'):format(round(point.x), round(point.y), round(point.z))
+end
+
+
+minetest.register_chatcommand('wp_set', {
+    params = '<name>',
+    description = 'set a waypoint',
+    func = safe(function(param)
+        waypoints = load_waypoints()
+        local point = minetest.localplayer:get_pos()
+        waypoints[param] = point
+        mod_storage:set_string('waypoints', minetest.serialize(waypoints))
+
+        minetest.display_chat_message(
+            ('set waypoint "%s" to "%s"'):format(param, tostring_point(point))
+        )
+    end),
+})
+
+
+minetest.register_chatcommand('wp_unset', {
+    params = '<name>',
+    description = 'remove a waypoint',
+    func = safe(function(param)
+        waypoints = load_waypoints()
+        waypoints[param] = nil
+        mod_storage:set_string('waypoints', minetest.serialize(waypoints))
+
+        minetest.display_chat_message(
+            ('removed waypoint "%s"'):format(param)
+        )
+    end),
+})
+
+
+minetest.register_chatcommand('wp_list', {
+    params = '',
+    description = 'lists waypoints',
+    func = safe(function(_)
+        for name, point in pairsByKeys(waypoints, lc_cmp) do
+            minetest.display_chat_message(
+                ('%s -> %s'):format(name, tostring_point(point))
+            )
+        end
+    end),
+})
+
+
+minetest.register_chatcommand('tw', {
+    params = '(<playernamename>) <waypoint>',
+    description = 'teleport (a player) to a waypoint',
+    func = safe(function(param)
+--        local playername, wpname = string.match(param, '^(%S+)%s+(%S+)$')
+--        if playername and wpname then
+--            local waypoint = waypoints[wpname]
+--            if waypoint ~= nil then
+--                local args = ('%s %s'):format(playername, tostring_point(waypoint))
+--                minetest.run_server_chatcommand('teleport', args)
+--            else
+--                minetest.display_chat_message(('waypoint "%s" not found.'):format(wpname))
+--            end
+--        else
+            local wpname = param
+            local waypoint = waypoints[wpname]
+            if waypoint ~= nil then
+                minetest.run_server_chatcommand('teleport', tostring_point(waypoint))
+            else
+                minetest.display_chat_message(('waypoint "%s" not found.'):format(wpname))
+            end
+--        end
+
+    end),
+})
+
+
+
+-- 
+-- 2019-07-11 Och_Noe   disabled
+-- random teleporting is too dangerous
+-- 
+-- minetest.register_chatcommand('tr', {
+--     params = '<ELEV> | <PLAYER> | <PLAYER> <ELEV>',
+--     description = '/teleport (a player) to a random location',
+--     func = safe(function(param)
+--         local x = math.random(-30912, 30927)
+--         local y = math.random(-30912, 30927)
+--         local z = math.random(-30912, 30927)
+--         local name = ''
+-- 
+--         if string.match(param, '^([%a%d_-]+) (%d+)$') ~= nil then
+--             name, y = string.match(param, "^([%a%d_-]+) (%d+)$")
+-- 
+--         elseif string.match(param, '^([%d-]+)$') then
+--             y = string.match(param, '^([%d-]+)$')
+-- 
+--         elseif string.match(param, '^([%a%d_-]+)$') ~= nil then
+--             name = string.match(param, '^([%a%d_-]+)$')
+--         end
+-- 
+--         local args = ('%s %s %s %s'):format(name, x, y, z)
+--         minetest.run_server_chatcommand('teleport', args)
+--     end),
+-- })
+
+