updated Readme and some settings descriptions. Added screenshots

README.md

@@ -3,9 +3,29 @@ Blink Teleport mod for Minetest
 
 Dependencies
 ------------
-
 Minetest 5.0.0+
 
+Description
+-------------
+
+Blink is a short distance teleport with a cooldown period. The further you blink, the longer the cooldown. You can also place a temporary marker that will display your destination if you were to blink. This will add a new dynamic to PvP and/or survival servers.
+
+
+
+Features
+-------------
+
+* By default you cannot blink into or out of protected areas (configurable)
+* Ability to specify a protection owner to allow blinking (Useful for public areas)
+* Height check disallows blinking into a space too short for the player
+* If you blink into a player or mob, you will move directly behind them and face their back
+-   currently compatible with all of Mobs Redo, NSSM, Creeper, and DMobs
+* Swoosh sound included (7 sounds played randomly)
+* Default max blink distance is 20 nodes (configurable)
+* Able to set static cooldown and/or dynamic cooldown (0.1s for each block travelled + the static cooldown)
+
+![Before Blink](screenshot_1.png)
+![After Blink](screenshot_2.png)
 
 Configuration
 -------------
@@ -17,18 +37,15 @@ For server owners: Check `settingtypes.txt` and modify your `minetest.conf`
 according to the wanted setting changes.
 
 
-
 TODO
 --------
 
-* Create mesh for marker circle
+* Add tool wear and repair
-* Add crafting
+* Use place marker button twice in the same place to blink there
-* Add number of uses
-* Add height check for destination
-* Add blink behind mobs/players
-* Check if entity was recently put down and if blinking close enough to it, don't recalculate destination
-* Possibly add a priv and priv check?
 * Localize
+* Maybe switch to first weapon in hotbar when blinking behind players or mobs
+* Clean up and document code
+
 
 License
 -------

init.lua

@@ -1,17 +1,9 @@
 --[[ To Do:
---Create mesh for marker circle
+Add tool wear and repair
---Add crafting
+Use place marker button twice in the same place to blink there
-Add number of uses
---Add height check for destination
---Add blink behind mobs/players
-Check if marker was recently put down and if blinking close enough to it, don't recalculate destination
 Localize
---Add swoosh sound
+Maybe switch to first weapon in hotbar when blinking behind players or mobs
---Flash different color if no space to blink
+Clean up and document code
---Add Raycast to check line-of-sight when blinking behind a player/entity
---Fix valid_entities and add more compatibility
-Possibly switch to first weapon in hotbar when blinking behind players/mobs
--Make cooldown time condider calculation from distance travelled
 ]]
 
 

settingtypes.txt

@@ -19,5 +19,5 @@ blink_behind (Blink Behind) bool true
 #Time to show destination marker
 display_time (Display Time) float 6.0
 
-# Any areas owned by this user are considered public and will allow users to blink
+# Any areas owned by this user are considered public and will allow users to blink. Recommend to create a non-use user account for the purpose of allowing blink in protected areas (e.g. user called allow_blink). Note that anyone can add the user to their protected area to allow anyone to blink in their area.
 public_username (Public areas username) string ""