magic-compass/README.md

Magic Compass

Teleport system for Minetest

How to use it

Look for the "Magic Compass" item in your creative inventory, put it in your hand and left click it to open the locations menu

Customisation

1. be sure the world has been launched at least once with Magic Compass active
2. go to your world folder/magic_compass
3. open an existing .yml file or create a new one (Magic Compass can read multiple locations from multiple files)
4. follow the template down below, where ID is an actual number

ID:
  description:
  icon:
  teleport_to: X, Y, Z
  cooldown: (optional, default none)
  requires: (optional privileges required to use the teleport: separate them with `, `, default none)
  hidden_by_default: (optional, put `true` to hide the icon to players who don't have the required privileges)

For more information, check out the instructions.txt file inside that folder.

For using the API, check out the DOCS.

Want to help?

Feel free to:

• open an issue
• submit a merge request. In this case, PLEASE, do follow milestones and my coding guidelines. I won't merge features for milestones that are different from the upcoming one (if it's declared), nor messy code
• contact me on Matrix, on my server dev room

Credits

• Deny sound by suntemple (tweaked by me)
• Images by me, under CC BY-SA 4.0