README.txt

   1 Mirror of Return
   2 ================
   3 Version 0.1.0
   4
   5 ## Description
   6 This mod adds a magical item, the Mirror of Return. This item teleports the user back to a previously
   7 set location, at the cost of some mana (if applicable).
   8
   9 ## Usage
  10 Rightclick with the item onto a node to set the mirror's teleport location.
  11 Leftclick while holding the mirror to immediately teleport back to the mirror's teleport location.
  12 Each mirror has is own teleport location and “remembers” it throughout the game, until a new
  13 teleport location has been set.
  14
  15 Initially, a mirror has no teleport location set, so you have to set it before the first teleportation.
  16
  17 If the Mana mod [mana] is present, setting and teleporting costs mana. The default cost are:
  18
  19 * Setting: 20
  20 * Teleporting back to set position: 100
  21
  22 ## Configuration
  23 You can change the mana costs via minetest.conf. The following settings are used:
  24
  25 * `returnmirror_cost_set`: Mana cost for setting (number)
  26 * `returnmirror_cost_teleport`: Mana cost for teleporting (number)
  27
  28 If a setting is not present, the default cost is used.