mirror of
https://github.com/minetest-mods/teleport-request.git
synced 2025-01-08 22:17:27 +01:00
Make README.md better
This commit is contained in:
parent
2f31f0c317
commit
f36d5de9de
20
README.md
20
README.md
@ -5,11 +5,11 @@
|
||||
## Privileges:
|
||||
Each command needs a privilege. These are the following privileges:
|
||||
- **tp** is requiered in order to use all commands.
|
||||
- **tp_tpc** is requiered in order to use "/tpc"
|
||||
- **tp_tpc** is requiered in order to use "/tpe"
|
||||
- **tp_tpc** is requiered in order to use "/tpj"
|
||||
- **tp_tpc** is requiered in order to use `/tpc`
|
||||
- **tp_tpc** is requiered in order to use `/tpe`
|
||||
- **tp_tpc** is requiered in order to use `/tpj`
|
||||
- **interact** is also requiered to use all commands.
|
||||
**tp_admin** overrides everything: e.g. you can teleport to players even when they haven't decided to accept, or not. You can also teleport him/her to you.
|
||||
**tp_admin** overrides everything: e.g. you can teleport to players even when they haven't decided to accept, or not. You can also teleport him/her to you (this happens only when `enable_immediate_teleport` is enabled on `config.lua`).
|
||||
Players can also teleport to coordinates, however, if the area is protected, the teleport will be denied.
|
||||
|
||||
## How to use:
|
||||
@ -20,34 +20,34 @@ These are the following commands available in-game:
|
||||
``` /tpr [playername] ```
|
||||
- **Name:** Teleport Request
|
||||
- **Description:** Requests permission to teleport to another player, where [playername] is their exact name.
|
||||
- **Required Privileges:** "interact", "tp"
|
||||
- **Required Privileges:** `interact, tp`
|
||||
- **Example Usage:** */tpr RobbieF* - requests permission from RobbieF to teleport to them.
|
||||
- **Notes:** Usernames are case-sensitive. If you have "tp_admin" privilege, you will immediately teleport to the specificed player.
|
||||
|
||||
``` /tphr [playername] ```
|
||||
- **Name:** Teleport Here Request
|
||||
- **Description:** Request permission to teleport another player to you.
|
||||
- **Required Privileges:** "interact", "tp"
|
||||
- **Required Privileges:** `interact, tp`
|
||||
- **Example Usage:** /tphr RobbieF - requests RobbieF to teleport to you.
|
||||
- **Notes:** Usernames are case-sensitive. If you have "tp_admin" privilege, RobbieF will teleport to you immediately.
|
||||
|
||||
``` /tpc [x,y,z] ```
|
||||
- **Name:** Teleport to Coordinates
|
||||
- **Description:** Teleport to coordinates.
|
||||
- **Required Privileges:** "interact", "tp_tpc", "tp"
|
||||
- **Required Privileges:** `interact, tp_tpc, tp`
|
||||
- **Notes:** Honors area protection: if the area is protected, it must be owned by you in order to teleport to it, or you must have "areas" privilege in order to teleport to those coordinates (this does not apply if "areas" mod is not detected).
|
||||
|
||||
``` /tpj [axis] [distance] ```
|
||||
- **Name:** Teleport Jump
|
||||
- **Description:** Teleport a specified distance along a single specified axis.
|
||||
- **Required Privilege:** "interact", "tp", "tp_tpc"
|
||||
- **Required Privilege:** `interact", tp, tp_tpc`
|
||||
- **Available Options for *axis*:** x, y, z
|
||||
- **Example Usage:** '/tpj y 10' - teleport 10 nodes into the air.
|
||||
|
||||
``` /tpe ```
|
||||
- **Name:** Teleport Evade
|
||||
- **Description:** In a sticky situation? Evade your enemy by teleporting to several nearby coordinates in random pattern. There's no knowing where you'll end up.
|
||||
- **Required Privileges:** "interact", "tp_tpc", "tp"
|
||||
- **Required Privileges:** `interact, tp_tpc, tp`
|
||||
- **Example Usage:** '/tpe' - teleports you to a random number of random coordinates in an evasive pattern.
|
||||
|
||||
``` /tpy ```
|
||||
@ -71,7 +71,7 @@ Report bugs or suggest ideas by [creating an issue](https://github.com/ChaosWorm
|
||||
If you know how to fix an issue, or want something to be added, consider opening a [pull request](https://github.com/ChaosWormz/teleport-request/compare).
|
||||
|
||||
## License
|
||||
LGPL-2.1 for everything (click [here](https://github.com/ChaosWormz/teleport-request/blob/master/LICENSE.md) for more information).
|
||||
[LGPL-2.1](https://github.com/ChaosWormz/teleport-request/blob/master/LICENSE.md) for everything.
|
||||
|
||||
## Contributors:
|
||||
- [RobbieF](https://minetest.tv) | [GitHub](https://github.com/Cat5TV)
|
||||
|
Loading…
Reference in New Issue
Block a user