Update Commands.md

This commit is contained in:
Andre_601 2021-05-07 23:45:29 +02:00 committed by GitHub
parent 0f118f12bc
commit c3922de323
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -30,10 +30,11 @@ This page shows all commands, including with a detailed description of what ever
- [`/papi reload`](#papi-reload) - [`/papi reload`](#papi-reload)
---- ----
### Parse Commands ### Parse Commands
These commands are used to parse placeholders into their respective values. Useful for debugging. These commands are used to parse placeholders into their respective values. Useful for debugging.
#### `/papi bcparse` - #### `/papi bcparse`
**Description**: **Description**:
Parses placeholders of a String and broadcasts the result to all players. Parses placeholders of a String and broadcasts the result to all players.
@ -46,8 +47,7 @@ Parses placeholders of a String and broadcasts the result to all players.
/papi bcparse funnycube My name is %player_name%! /papi bcparse funnycube My name is %player_name%!
``` ```
---- - #### `/papi cmdparse`
#### `/papi cmdparse`
**Description**: **Description**:
Parses placeholders of a String and executes it as a command. Parses placeholders of a String and executes it as a command.
@ -60,8 +60,7 @@ Parses placeholders of a String and executes it as a command.
/papi cmdparse funnycube say My name is %player_name%! /papi cmdparse funnycube say My name is %player_name%!
``` ```
---- - #### `/papi parse`
#### `/papi parse`
**Description**: **Description**:
Parses the placeholders in a given text and shows the result. Parses the placeholders in a given text and shows the result.
@ -74,8 +73,7 @@ Parses the placeholders in a given text and shows the result.
/papi parse funnycube My group is %vault_group% /papi parse funnycube My group is %vault_group%
``` ```
---- - #### `/papi parserel`
#### `/papi parserel`
**Description**: **Description**:
Parses a relational placeholder. Parses a relational placeholder.
@ -90,20 +88,19 @@ Parses a relational placeholder.
``` ```
---- ----
### eCloud Commands ### eCloud Commands
These commands all start with `/papi ecloud` and are used for things related about the [[Expansion Cloud]]. These commands all start with `/papi ecloud` and are used for things related about the [[Expansion Cloud]].
#### `/papi ecloud clear` - #### `/papi ecloud clear`
**Description**: **Description**:
Clears the cache for the eCloud. Clears the cache for the eCloud.
---- - #### `/papi ecloud disable`
#### `/papi ecloud disable`
**Description**: **Description**:
Disables the connection to the eCloud. Disables the connection to the eCloud.
---- - #### `/papi ecloud download`
#### `/papi ecloud download`
**Description**: **Description**:
Allows you to download an expansion from the eCloud Allows you to download an expansion from the eCloud
@ -117,13 +114,11 @@ Allows you to download an expansion from the eCloud
/papi ecloud download Vault 1.5.2 /papi ecloud download Vault 1.5.2
``` ```
---- - #### `/papi ecloud enable`
#### `/papi ecloud enable`
**Description**: **Description**:
Enables the connection to the eCloud Enables the connection to the eCloud
---- - #### `/papi ecloud info`
#### `/papi ecloud info`
**Description**: **Description**:
Gives information about a specific Expansion. Gives information about a specific Expansion.
@ -136,8 +131,7 @@ Gives information about a specific Expansion.
/papi ecloud info Vault /papi ecloud info Vault
``` ```
---- - #### `/papi ecloud list`
#### `/papi ecloud list`
**Description**: **Description**:
Lists either all Expansions on the eCloud, only those by a specific author or only those that you have [installed](#papi-ecloud-download). Lists either all Expansions on the eCloud, only those by a specific author or only those that you have [installed](#papi-ecloud-download).
Installed Expansions show as green in the list and Expansions that are installed and have an update available show as gold. Installed Expansions show as green in the list and Expansions that are installed and have an update available show as gold.
@ -152,8 +146,7 @@ Installed Expansions show as green in the list and Expansions that are installed
/papi ecloud list installed /papi ecloud list installed
``` ```
---- - #### `/papi ecloud placeholders`
#### `/papi ecloud placeholders`
**Description**: **Description**:
List all placeholders of an Expansion. List all placeholders of an Expansion.
@ -165,21 +158,20 @@ List all placeholders of an Expansion.
/papi ecloud placeholders Vault /papi ecloud placeholders Vault
``` ```
---- - #### `/papi ecloud refresh`
#### `/papi ecloud refresh`
**Description**: **Description**:
Refresh the cached data from the eCloud. Refresh the cached data from the eCloud.
---- - #### `/papi ecloud status`
#### `/papi ecloud status`
**Description**: **Description**:
Displays the actual Status of the eCloud. Displays the actual Status of the eCloud.
---- ----
### Expansion Commands ### Expansion Commands
These commands can be used to manage the expansions that you have currently installed. These commands can be used to manage the expansions that you have currently installed.
#### `/papi info` - #### `/papi info`
**Description**: **Description**:
Gives you information about the specified Expansion. Gives you information about the specified Expansion.
@ -191,14 +183,12 @@ Gives you information about the specified Expansion.
/papi info Vault /papi info Vault
``` ```
---- - #### `/papi list`
#### `/papi list`
**Description**: **Description**:
Lists all active/registered expansions. Lists all active/registered expansions.
This is different to [/papi ecloud list installed](#papi-ecloud-list) in the fact, that it also includes expansions that were installed through a plugin (That aren't a separate jar-file) and it also doesn't show which one have updates available. This is different to [/papi ecloud list installed](#papi-ecloud-list) in the fact, that it also includes expansions that were installed through a plugin (That aren't a separate jar-file) and it also doesn't show which one have updates available.
---- - #### `/papi register`
#### `/papi register`
**Description**: **Description**:
Registers an expansion from a specified filename. Registers an expansion from a specified filename.
This is useful in cases, where you downloaded the expansion manually and don't want to restart the server. This is useful in cases, where you downloaded the expansion manually and don't want to restart the server.
@ -212,8 +202,7 @@ The file needs to be inside `/plugins/PlaceholderAPI/expansions`.
/papi register MyExpansion.jar /papi register MyExpansion.jar
``` ```
---- - #### `/papi unregister`
#### `/papi unregister`
**Description**: **Description**:
Unregisters the specified expansion. Unregisters the specified expansion.
@ -226,14 +215,15 @@ Unregisters the specified expansion.
``` ```
---- ----
### Other Commands ### Other Commands
These are other commands of PlaceholderAPI that don't fit any of the above categories. These are other commands of PlaceholderAPI that don't fit any of the above categories.
#### `/papi dump` - #### `/papi dump`
**Description**: **Description**:
Pastes useful information from PlaceholderAPI such as plugin version, server version and installed expansions to https://paste.helpch.at for simple sharing and support. Pastes useful information from PlaceholderAPI such as plugin version, server version and installed expansions to https://paste.helpch.at for simple sharing and support.
#### `/papi reload` - #### `/papi reload`
**Description**: **Description**:
Reloads the config settings. Reloads the config settings.
You need to use this command after [downloading Expansions](#papi-ecloud-download) from the eCloud or they won't be properly registered. You need to use this command after [downloading Expansions](#papi-ecloud-download) from the eCloud or they won't be properly registered.