> For the complete documentation index, see [llms.txt](https://docs.olziedev.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.olziedev.com/projects/playerwarps/commands.md).

# Commands & Permissions

{% hint style="info" %}
**Command not working?**

The command needs to be enabled in the **config.yml** for it to function properly. If the issue still persists please report it.
{% endhint %}

## Player Commands (pw\.commands)

| Command                                                        | Description                                                                                                                                                                    | Permission    |
| -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |
| /pw help                                                       | Displays this menu.                                                                                                                                                            | N/A           |
| /pw \<warp>                                                    | Teleports to the player warp.                                                                                                                                                  | pw\.warp      |
| /pw set \<name> \[player]                                      | Sets a warp to your location.                                                                                                                                                  | pw\.limit.<#> |
| /pw remove \<warp>                                             | Removes the warp.                                                                                                                                                              | pw\.remove    |
| /pw desc set/remove \<warp> \<desc>                            | Manage warp descriptions.                                                                                                                                                      | pw\.desc      |
| /pw list \[page] \[player]                                     | Lists all the current player warps.                                                                                                                                            | pw\.list      |
| /pw near \[page]                                               | List all the nearby player warps.                                                                                                                                              | pw\.near      |
| /pw open \[menu] \[options]                                    | Opens the player menu.                                                                                                                                                         | pw\.open      |
| /pw search \<query> \[options]                                 | Search for a warp/player.                                                                                                                                                      | pw\.search    |
| /pw amount \[player]                                           | Check how much warps you have.                                                                                                                                                 | pw\.amount    |
| /pw rtp                                                        | Teleport to a random warp.                                                                                                                                                     | pw\.rtp       |
| /pw icon \<set/remove> \<warp>                                 | Manage warp icons.                                                                                                                                                             | pw\.icon      |
| /pw category set/remove/list/clear \<warp> \[category]         | Set a warp category.                                                                                                                                                           | pw\.category  |
| /pw tags set/remove/list \<warp> \[tag] \[value]               | Set a warp tag.                                                                                                                                                                | pw\.tags      |
| /pw rate \<warp> \<rate> \<description>                        | Rate a warp.                                                                                                                                                                   | pw\.rate      |
| /pw lock \<warp> \[true/false]                                 | Lock a warp.                                                                                                                                                                   | pw\.lock      |
| /pw cost set/remove \<warp> \<cost>                            | Manage Warp costs.                                                                                                                                                             | pw\.cost      |
| /pw reset \<warp>                                              | Re-set a warps location.                                                                                                                                                       | pw\.reset     |
| /pw rename \<warp> \<name>                                     | Rename a warp.                                                                                                                                                                 | pw\.rename    |
| /pw setowner \<warp> \<player>                                 | <p>Transfer a warp's ownership.<br>Players with <code>pw\.admin.setowner</code> can append <code>-force</code> to ignore confirmation process if enabled and limit checks.</p> | pw\.setowner  |
| /pw password set/remove \<warp> \<password>                    | Manage warp passwords.                                                                                                                                                         | pw\.password  |
| /pw whitelist set/remove/list/disable/enable \<warp> \<player> | Manage warp whitelist.                                                                                                                                                         | pw\.whitelist |
| /pw ban set/remove/list \<warp> \[player] \[time] \[reason]    | Manage warp banning.                                                                                                                                                           | pw\.ban       |
| /pw managers set/remove/list \<warp> \[player]                 | Manage warp managers.                                                                                                                                                          | pw\.managers  |
| /pw favourite \<warp> \[player]                                | Add a warp to your favourites.                                                                                                                                                 | pw\.favourite |
| /pw info \<warp>                                               | View information about a warp.                                                                                                                                                 | pw\.info      |
| /pw settings \<warp>                                           | Open the warp settings gui.                                                                                                                                                    | pw\.settings  |
| /pw tags set/remove/list/clear \<warp>                         | Manage your warp tags.                                                                                                                                                         | pw\.tags      |

## Admin Commands

| Command                          | Description                     | Permission          |
| -------------------------------- | ------------------------------- | ------------------- |
| /pw removeall \<player>          | Removes all the player's warps. | pw\.admin.removeall |
| /pw reload                       | Reloads all the config files.   | pw\.admin.reload    |
| /pw addwarps \<player> \<amount> | Add more warps to a player.     | pw\.admin.addwarps  |

## Rest API Commands

| Command                          | Description               | Permission             |
| -------------------------------- | ------------------------- | ---------------------- |
| /pw apitokens                    | Shows the help menu.      | pw\.apitokens          |
| /pw apitokens delete \[player]   | Delete your API token.    | pw\.apitokens.delete   |
| /pw apitokens generate \[player] | Generate a new API token. | pw\.apitokens.generate |

{% hint style="info" %}
**Permissions not working?**

The <> in some permissions are placeholders, you will need to replace them with a valid value like requested.
{% endhint %}

## Player Permissions

| Permission               | Description                                                |
| ------------------------ | ---------------------------------------------------------- |
| pw\.desc.color           | Put colors in warp descriptions.                           |
| pw\.rate.color           | Put colors in rate descriptions.                           |
| pw\.set.color            | Put colors in warp names.                                  |
| pw\.warp.notify          | Get notified upon warp teleportation.                      |
| pw\.amount.others        | View other players' warp amount.                           |
| pw\.set.sign             | Create a warp via a sign if enabled in config.             |
| pw\.warp.sign            | Create/destroy a sign to tp to warps if enabled in config. |
| pw\.category.\<category> | Allows the player to set a warp to that category.          |
| pw\.warp.delay           | Bypass the warp wait delay.                                |
| pw\.warp.delay.move      | Bypass warp movement for warp delay.                       |
| pw\.warp.safe            | Bypass warp safe check.                                    |
| pw\.cost.bypass          | Bypass warp teleportation costs.                           |
| pw\.cooldown.visit       | Bypass warp visit cooldown.                                |
| pw\.cooldown.teleport    | Bypass warp teleport cooldown.                             |
| pw\.cooldown.set         | Bypass warp setting cooldown.                              |
| pw\.cooldown.rate        | Bypass warp rating cooldown.                               |
| pw\.cooldown.sponsor     | Bypass warp sponsor cooldown.                              |

## Admin Permissions

| Permission               | Description                                                                                 |
| ------------------------ | ------------------------------------------------------------------------------------------- |
| pw\.admin.bypass         | Bypass any restriction with the warp addons.                                                |
| pw\.admin.update         | When a player joins they receive update notifications.                                      |
| pw\.admin.set            | Set a warp for another player.                                                              |
| pw\.admin.nopurge        | Bypass the purging warp feature.                                                            |
| pw\.admin.category       | Set any other warp categories including your own.                                           |
| pw\.admin.tags           | Set any other warp tags including your own.                                                 |
| pw\.admin.setowner       | Transfer any other warp owners including your own.                                          |
| pw\.admin.rent           | Bypass the warp renting feature.                                                            |
| pw\.admin.ban            | Manage any other warp bans including your own and also bypasses teleport restriction.       |
| pw\.admin.managers       | Manage any other warp managers including your own.                                          |
| pw\.admin.whitelist      | Manage any other warp whitelists including your own and also bypasses teleport restriction. |
| pw\.admin.rename         | Rename any other warp including your own.                                                   |
| pw\.admin.remove         | Remove any other warp including your own.                                                   |
| pw\.admin.reset          | Re-set any other warp locations including your own.                                         |
| pw\.admin.desc           | Manage any other warp descriptions including your own.                                      |
| pw\.admin.list           | View a list of warps for another player.                                                    |
| pw\.admin.icon           | Manage any other warp icons including your own.                                             |
| pw\.admin.cost           | Manage any other warp costs including your own.                                             |
| pw\.admin.lock           | Lock any other warp including your own and also bypasses teleport restriction.              |
| pw\.admin.viewlock       | View locked warps in the warp menu.                                                         |
| pw\.admin.sponsor        | Sponsor any other warp including your own.                                                  |
| pw\.admin.delsponsor     | Remove the warp as a sponsor.                                                               |
| pw\.admin.teleport       | Force a player to teleport to that warp.                                                    |
| pw\.admin.favourite      | Add a warp to another players favourite warp list.                                          |
| pw\.admin.disabledworlds | Bypass the disabled worlds restriction.                                                     |
| pw\.admin.open           | Use open options for opening a menu.                                                        |
| pw\.admin.notify         | Bypass the warp teleport notification (pw\.warp.notify).                                    |
| pw\.admin.rate           | Remove a players rating from a warp.                                                        |
| pw\.admin.apitokens      | Remove/Generate other players' API tokens.                                                  |

## Open Options Syntax

Open options are an easy way for you to change how the open command is processed, here are the latest options and examples for Player Warps.

| Option | Description                                           | Example             |
| ------ | ----------------------------------------------------- | ------------------- |
| player | Open the menu for that player.                        | -player NotchIsCool |
| view   | View the menu as that player.                         | -view Olzie12       |
| search | Add a search input to the search menu for the player. | -search "farm"      |
| warp   | Define specific warp for specific warp menus.         | -warp Farm          |

With the examples shown above this is how its used in the command:`/pw open <menu> -player NotchIsCool -view Olzie12`. This will open the menu for NotchIsCool but the contents of the menu will be viewed as Olzie12, this is good for checking other players warps in a menu.

Another example: `/pw open <menu> -view Olzie12`. This will open the menu for the executor (if it isn't console) and will be viewing it as Olzie12.

I mentioned above with the console executor, yes using the command in console will always need the `player` option to open it for that player.

For players to be able to use this, they will need `pw.admin.open` and is not suggested to give this to any normal player as they can just view menus as other players and edit their warps.

\
Using the `search` option allows you to automatically enter a search input when a menu (that allows searching) has been opened, there isn't a required permission like all the others. You will need to surround the value in speech marks. For example `/pw open <search menu> -search "farm`". This will search for any warps containing or being called `"farm"`.