update readme and add screenshot and digilines docs

README.md

@@ -4,99 +4,56 @@
 
 A Minetest mod for user-generated teleportation pads.
 
-Version: 0.5.0
+![screenshot](screenshot.png?raw=true "screenshot")
 
-License:
-  Code: LGPL 2.1 (see included LICENSE file)
-  Textures: CC-BY-SA (see http://creativecommons.org/licenses/by-sa/4.0/)
-  textures/telemosaic_beacon_protected_overlay.png MIT (https://notabug.org/TenPlus1/protector)
+## Description
 
-Report bugs or request help on the forum topic.
+This is a mod for Minetest. It provides teleportation pads, called "beacons". Unlike other teleportation mods, no menus or GUIs are used; you set the destination with a simple "key" item. There is no tooltip for the destination either, so signs are recommended.
 
-Description
------------
+Another difference is the limited default range of the beacons. To increase the range, you need to place "extenders" around the beacon. The extenders come in different colors, allowing the extenders to form a pretty pattern; hence the name "telemosaic".
 
-This is a mod for MineTest. It provides teleportation pads, called
-"beacons". Unlike other teleportation mods, no menus or GUIs are used;
-you set the destination with a simple "key" item. There is no
-tooltip for the destination either, so signs are recommended.
+## Notes
 
-Another difference is the limited default range of the beacons.
-To increase the range, you need to place "extenders" around the beacon.
-The extenders come in different colors, allowing the extenders to
-form a pretty pattern; hence the name "telemosaic".
+This is a maintained fork of https://github.com/bendeutsch/minetest-telemosaic with various improvements and changes, optimized for multiplayer environments.
 
-Current behavior
-----------------
+* Beacons no longer teleport players automatically, they must be right-clicked by a player.
+* More chat messages are sent to inform and help players with non-functional telemosaics.
+* Telemosaic keys can be preserved by holding shift when right-clicking a beacon.
+* Beacons can be enabled and disabled by punching them with a telemosaic key.
+* If the `digilines` mod is installed, beacons can be controlled by digilines.
+* and other small changes...
 
-Beacons are created with 2 diamonds, 3 obsidian blocks, and a wooden
-door: first row diamond, door, diamond; second row the obsidian blocks.
+## Usage
 
-Right-clicking a beacon with a default mese crystal fragment remembers
-the position in the fragment, which turns into a telemosaic key.
-Right-clicking a second beacon with the key sets up a teleportation
-route from the second beacon to the first beacon. To set up a return
-path, right-click the second beacon with the fragment, and the first
-beacon with the resulting key again.
+Right-clicking a beacon with a default mese crystal fragment creates a telemosaic key with the position of the beacon.
 
-The beacons do not need to be strictly paired this way: rings or
-star-shaped networks are also possible. Each beacon has only a
-single destination, but can itself be the destination of several
-others.
+Right-clicking a second beacon with the key sets the destination of the second beacon to the position of the first beacon. To set up a return path, right-click the second beacon with the fragment, and then first beacon with the resulting key again.
 
-Beacons will check that their destination is sane: the destination
-still needs to be a beacon, and the two nodes above it should be
-clear for walking / standing in. If your Minetest version supports
-it, the beacon will emerge the area prior to checking and teleporting.
-Emerging is merely a convenience, though.
+The beacons do not need to be strictly paired this way: rings or star-shaped networks are also possible. Each beacon has only a single destination, but can itself be the destination of several others.
 
-Beacons have a maximum range of 20 nodes. If the destination is
-too far away, the beacon will turn red and will not function.
-To extend the range for a beacon, place "extenders" next to it,
-within a 7x7 horizontal square centered on the beacon.
+Once linked, you teleport between beacons by right-clicking them. Before teleporting, beacons will check that their destination is sane: the destination still needs to be a beacon, and the two nodes above it should be clear for walking/standing in.
 
-Extenders come in three tiers: tier 1 extends all affected beacons
-by 5 nodes, tier 2 by 20 nodes, and tier 3 by 80 nodes. Placing
-or digging extenders will update affected beacons.
+Beacons have a default range of 20 nodes. If the destination is too far away, the beacon will turn red and will not function. To extend the range for a beacon, place "extenders" next to it, within a 7x7 horizontal square centered on the beacon, and at the same level or one node below the beacon.
 
-Tier 1 extenders are crafted by placing an obsidian block, a wooden
-door, and another obsidian block in a horizontal row. Tier 2 extenders
-are crafted with an obsidian block in the middle, surrounded by a cross
-of four tier 1 extenders. Tier 3 extenders are crafted with an obsidian
-block surrounded by four tier 2 extenders.
+Extenders come in three tiers, with each being more powerful than the tier below. By default, tier 1, tier 2, and tier 3 extenders increase the range of nearby beacons by 5, 20, and 80 nodes, respectively.
 
-Extenders can be colored with any of the dyes found in the dye mod.
-Colored extenders work just like regular extenders, both for
-teleporting and for recipes. To "uncolor" an extender, dye it grey.
+Extenders can be colored with any of the dyes found in the `dye` mod. Colored extenders work just like regular extenders, both for teleporting and for recipes.
 
-Settings
-------------
+## Digilines
 
-* `telemosaic_right_click_teleport` allow teleport on rightclick
+When the `digilines` mod is installed, telemosaic beacons can be controlled by sending digiline messages. By default, all beacons use the channel "telemosaic", but you can change the channel name via digilines.
 
-Future plans
-------------
+For full documentaion, see [digilines.md](digilines.md).
 
-* Particle and sound effects
-* Protected beacons (will not teleport if protected)
+## Dependencies
 
-Dependencies
-------------
-* default
-* doors
-* dye (optional)
+* `default`
+* `doors`
+* `dye` (optional)
+* `digilines` (optional)
 
-Installation
-------------
+## License
 
-Unzip the archive, rename the folder to to `bewarethedark` and
-place it in minetest/mods/
-
-(  Linux: If you have a linux system-wide installation place
-    it in ~/.minetest/mods/.  )
-
-(  If you only want this to be used in a single world, place
-    the folder in worldmods/ in your worlddirectory.  )
-
-For further information or help see:
-http://wiki.minetest.com/wiki/Installing_Mods
+* Code: LGPL 2.1 (see included LICENSE file)
+* Textures: CC-BY-SA (see http://creativecommons.org/licenses/by-sa/4.0/)
+* textures/telemosaic_beacon_protected_overlay.png MIT (https://notabug.org/TenPlus1/protector)

digilines.md

@@ -0,0 +1,75 @@
+# Telemosaic digilines documentation
+
+An overview of all commands and functionality, with example Lua code.
+
+For convenience, and for using digiline buttons, all commands can also be sent as text.
+
+### Change the digiline channel
+
+**Lua:**
+
+```lua
+digiline_send("telemosaic", {command = "setchannel", channel = "whatever"})
+```
+
+**Text:** `setchannel whatever`
+
+### Disable a beacon
+
+**Lua:**
+
+```lua
+digiline_send("telemosaic", {command = "disable"})
+```
+
+**Text:** `disable`
+
+### Enable a beacon
+
+**Lua:**
+
+```lua
+digiline_send("telemosaic", {command = "enable"})
+```
+
+**Text:** `enable`
+
+### Set a new destination
+
+**Lua:**
+
+```lua
+digiline_send("telemosaic", {command = "setdest", x = 0, y = 0, z = 0})
+```
+
+or
+
+```lua
+digiline_send("telemosaic", {command = "setdest", pos = {x = 0, y = 0, z = 0}})
+```
+
+**Text:** `setdest 0,0,0`
+
+Note that the destination will only be set if it's valid (beacon at destination).
+
+### Get data from a beacon
+
+**Lua**
+
+```lua
+digiline_send("telemosaic", {command = "get"})
+```
+
+**Text:** `get` or `GET`
+
+Returns a table containing the following:
+
+```lua
+{
+    state = "active",  -- or "disabled", "off", or "error"
+    pos = {x = 1, y = 2, z = 3},
+    destination = {x = 4, y = 5, z = 6},
+    origin = {x = 1, y = 2, z = 3},  -- same as 'pos'
+    target = {x = 4, y = 5, z = 6},  -- same as 'destination'
+}
+```