README.md

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