minetest_returnmirror/README.md

32 lines
1.0 KiB
Markdown

Mirror of Returning
===================
Version 1.0.4
## Description
This mod adds a magical item, the Mirror of Returning. This item teleports the user back to a previously
set location, at the cost of some mana (if applicable).
## Usage
While holding the mirror:
* Rightclick to set the mirror's teleport location.
* Leftclick to immediately teleport back to the mirror's teleport location.
Each mirror has is own teleport location and “remembers” it throughout the game, until a new
teleport location has been set.
Initially, a mirror has no teleport location set, so you have to set it before the first teleportation.
If the Mana mod [mana] is present, setting and teleporting costs mana. The default cost are:
* Setting teleport location: 20
* Teleporting: 200
## Configuration
You can change the mana costs via minetest.conf. The following settings are used:
* `returnmirror_cost_set`: Mana cost for setting (number)
* `returnmirror_cost_teleport`: Mana cost for teleporting (number)
If a setting is not present, the default cost is used.