readme update

master
Juraj Vajda 2018-01-23 23:17:37 -05:00
parent f5bc5961eb
commit ea478aa37c
2 changed files with 24 additions and 59 deletions

View File

@ -1,9 +1,11 @@
Telemosaic [telemosaic]
Telemosaic by SaKeL [telemosaic]
=======================
A Minetest mod for user-generated teleportation pads.
Version: 0.5.0
Fork from: https://github.com/bendeutsch/minetest-telemosaic
Rewritten from scratch by SaKel.
License:
Code: LGPL 2.1 (see included LICENSE file)
@ -11,85 +13,47 @@ License:
Report bugs or request help on the forum topic.
![screenshot](screenshot.png)
Description
-----------
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.
This is a mod for MineTest. It provides teleportation pads, called"beacons". The menus and GUIs are included, you set the destination with a simple "key" item. There is GUI for the destination but you can also use signs.
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".
Another difference is the limited default range of the beacons. By default the beacons have no range. To increase the range, you need to place "extenders" around the beacon. The extenders come in different tiers, allowing the extenders to form a pretty pattern; hence the name "telemosaic".
Current behavior
----------------
Beacons are created with 2 diamonds, 3 obsidian blocks, and a wooden
door: first row diamond, door, diamond; second row the obsidian blocks.
Beacons are created with 2 diamonds, 3 obsidian blocks, and a wooden door: first row diamond, door, diamond; second row the obsidian blocks.
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 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 first beacon to the second beacon. To set up a return path, right-click the second beacon with the fragment, and the first beacon with the resulting key again.
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.
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 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.
Beacons will check that their destination is sane: the destinations 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.
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.
If the beacon destination is too far away, the beacon will let you know in chat message how many nodes you are passed from the departure power/range. To extend the range for a beacon, place "extenders" next to it, within a 7x7 horizontal square centered on the beacon. The extenders have to have air/empty space above them otherwise they will not function.
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.
Extenders come in three tiers: tier 1 extends all affected beacons by 10 nodes, tier 2 by 30 nodes, and tier 3 by 90 nodes. Placing or digging extenders will update affected beacons.
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.
Tier 1 extenders are crafted by placing an obsidian block, a wooden door, and another obsidian block in a horizontal row with a diamond above the door in first 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 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.
Protected beacons cannot be configured nor teleported from. You have to protect your beacons and extenders, by default they are not protected.
Future plans
------------
* Particle and sound effects
* Protected beacons (will not teleport if protected)
* When beacon have maximum power/range add field for item with which other players can pay to use the teleporter
* Implement shared protection from protector redo mod (or other mods)
Dependencies
------------
* default
* doors
* dye (optional)
Installation
------------
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
see: http://wiki.minetest.com/wiki/Installing_Mods

View File

@ -34,9 +34,9 @@ local enable_particles = minetest.settings:get_bool("enable_particles")
telemosaic = {}
-- @field extender_ranges
telemosaic.extender_ranges = {
["telemosaic:extender_one"] = 5,
["telemosaic:extender_two"] = 20,
["telemosaic:extender_three"] = 80
["telemosaic:extender_one"] = 10,
["telemosaic:extender_two"] = 30,
["telemosaic:extender_three"] = 90
}
-- @field strengths
telemosaic.strengths = { "one", "two", "three" }
@ -450,6 +450,7 @@ function telemosaic.beacon_rightclick(pos, node, clicker, itemstack, pointed_thi
-- get deprature position from item meta
local pos_stack = meta_stack:get_string("dep_pos")
pos_stack = minetest.string_to_pos(pos_stack)
if not pos_stack then return end
local meta2 = minetest.get_meta(pos_stack)
local range2 = meta2:get_int("range")