Mirrorlandia_minetest/teleport-request
1
0
Fork 0
mirror of https://github.com/minetest-mods/teleport-request.git synced 2025-01-07 21:47:30 +01:00
Code Issues Projects Releases Wiki Activity

Improve README.md

Browse Source
This commit is contained in:
Panquesito7 2019-11-30 22:15:49 -06:00
parent e84ff67522
commit 0ab6de5e42
No known key found for this signature in database
GPG Key ID: 3C482B03FD220E68
1 changed files with 23 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
README.md
View File

@ -1,21 +1,25 @@
# Teleport Request # Teleport Request
A mod that allows players to send a teleport request. Allows players to request from another player to be teleported to them.
**(See "How to use" below for more information.)**
## Privileges ## Privileges
Each command needs a privilege. These are the following privileges: Each command needs a privilege. These are the following privileges:
- **tp** is requiered in order to use all commands. - `tp` is required in order to use all commands.
- **tp_tpc** is requiered in order to use `/tpc` - `tp_tpc` is required in order to use `/tpc`.
- **tp_tpc** is requiered in order to use `/tpe` - `tp_tpc` is required in order to use `/tpe`.
- **tp_tpc** is requiered in order to use `/tpj` - `tp_tpc` is required in order to use `/tpj`.
- **interact** is also requiered to use all commands. - `interact` is required 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 (this happens only when `enable_immediate_teleport` is enabled on `config.lua`). - `tp_admin` gives more control to admins:
- Admins can teleport to players even when they haven't decided to accept, or not.
- Admins can teleport players to him/her, if the `enable_immediate_teleport` setting is enabled.
- Admins can teleport to protected coordinates.
Players can also teleport to coordinates, however, if the area is protected, the teleport will be denied. Players can also teleport to coordinates, however, if the area is protected, the teleport will be denied.
## How to use ## How to use
Each command does a function. "**Example Usage**" is an example of how to use the command. Each command does a function. "**Example Usage**" is an example of how to use the command.
Note there must be 2 players in order to make the commands to work: a player must send a request to another player (**see https://wiki.minetest.net/Server or see https://wiki.minetest.net/Setting_up_a_server for more information**). Note there must be 2 players in order to make the commands to work: a player must send a request to another player.
There are two methods of sending a request:
There are two ways of sending a request:
1. A request which teleports you to the specified player (command `/tpr <player>`). 1. A request which teleports you to the specified player (command `/tpr <player>`).
2. A request which teleports the specified player to you (command `/tphr <player>`). 2. A request which teleports the specified player to you (command `/tphr <player>`).
@ -26,14 +30,14 @@ These are the following commands available in-game:
- **Name:** Teleport Request - **Name:** Teleport Request
- **Description:** Requests permission to teleport to another player, where [playername] is their exact name. - **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. - **Example Usage:** `/tpr RobbieF` requests permission from RobbieF to teleport to them.
- **Notes:** Usernames are case-sensitive. If you have the `tp_admin` privilege, you will immediately teleport to the specificed player (does not apply if `enable_immediate_teleport` setting is disabled, enabled by default). - **Notes:** Usernames are case-sensitive. If you have the `tp_admin` privilege, you will immediately teleport to the specificed player (does not apply if `enable_immediate_teleport` setting is disabled, enabled by default).
``` /tphr [playername] ``` ``` /tphr [playername] ```
- **Name:** Teleport Here Request - **Name:** Teleport Here Request
- **Description:** Request permission to teleport another player to you. - **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. - **Example Usage:** `/tphr RobbieF` requests RobbieF to teleport to you.
- **Notes:** Usernames are case-sensitive. If you have the `tp_admin` privilege, RobbieF will teleport to you immediately (does not apply if `enable_immediate_teleport` setting is disabled, enabled by default). - **Notes:** Usernames are case-sensitive. If you have the `tp_admin` privilege, RobbieF will teleport to you immediately (does not apply if `enable_immediate_teleport` setting is disabled, enabled by default).
``` /tpc [x,y,z] ``` ``` /tpc [x,y,z] ```
@ -47,13 +51,13 @@ These are the following commands available in-game:
- **Description:** Teleport a specified distance along a single specified axis. - **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 - **Available Options for *axis*:** x, y, z
- **Example Usage:** '/tpj y 10' - teleport 10 nodes into the air. - **Example Usage:** `/tpj y 10` teleport 10 nodes into the air.
``` /tpe ``` ``` /tpe ```
- **Name:** Teleport Evade - **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. - **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. - **Example Usage:** `/tpe` teleports you to a random number of random coordinates in an evasive pattern.
``` /tpy ``` ``` /tpy ```
- **Description:** Accept a user's request to teleport to you or teleport you to them. - **Description:** Accept a user's request to teleport to you or teleport you to them.
@ -61,9 +65,7 @@ These are the following commands available in-game:
``` /tpn ``` ``` /tpn ```
- **Description:** Deny a user's request to teleport to you or teleport you to them. - **Description:** Deny a user's request to teleport to you or teleport you to them.
## Dependencies ## Optional dependencies
There are no dependencies.
However, optional dependencies are:
- [areas](https://github.com/minetest-mods/areas) - [areas](https://github.com/minetest-mods/areas)
- [intllib](https://github.com/minetest-mods/intllib) - [intllib](https://github.com/minetest-mods/intllib)
- [beerchat](https://github.com/pandorabox-io/beerchat) - [beerchat](https://github.com/pandorabox-io/beerchat)
@ -71,10 +73,10 @@ However, optional dependencies are:
- [gamehub](https://github.com/shivajiva101/minetest-gamehub) - [gamehub](https://github.com/shivajiva101/minetest-gamehub)
## Requirements ## Requirements
This mod requires MT/MTG 5.0.0+ to run. This mod requires MT 5.0.0+ to run.
Older versions not supported. Older versions not supported.
## Bugfixes & suggestions ## Issues, suggestions, features & bugfixes
Report bugs or suggest ideas by [creating an issue](https://github.com/ChaosWormz/teleport-request/issues/new). Report bugs or suggest ideas by [creating an issue](https://github.com/ChaosWormz/teleport-request/issues/new).
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). 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).
@ -82,7 +84,6 @@ If you know how to fix an issue, or want something to be added, consider opening
[LGPLv2.1+](https://github.com/ChaosWormz/teleport-request/blob/master/LICENSE.md) for everything. [LGPLv2.1+](https://github.com/ChaosWormz/teleport-request/blob/master/LICENSE.md) for everything.
## Contributors ## Contributors
List of contributors (in no particular order): List of contributors (in no particular order):
- [RobbieF](https://minetest.tv) | [GitHub](https://github.com/Cat5TV) - [RobbieF](https://minetest.tv) | [GitHub](https://github.com/Cat5TV)
@ -112,13 +113,13 @@ Or another way to do it, is changing the values in `settingtypes.txt`.
## Installation ## Installation
- Unzip the archive, rename the folder to `tpr` and - Unzip the archive, rename the folder to `tpr` and
place it in ..minetest/mods/ place it in .. minetest/mods/
- GNU/Linux: If you use a system-wide installation place - GNU/Linux: If you use a system-wide installation place
it in ~/.minetest/mods/. it in ~/.minetest/mods/.
- If you only want this to be used in a single world, place - If you only want this to be used in a single world, place
the folder in ..worldmods/ in your world directory. the folder in .. worldmods/ in your world directory.
For further information or help, see: For further information or help, see:
https://wiki.minetest.net/Installing_Mods https://wiki.minetest.net/Installing_Mods