diff --git a/wiki/Commands.md b/wiki/Commands.md index c1970bd..0484d55 100644 --- a/wiki/Commands.md +++ b/wiki/Commands.md @@ -30,210 +30,200 @@ This page shows all commands, including with a detailed description of what ever - [`/papi reload`](#papi-reload) ---- + ### Parse Commands These commands are used to parse placeholders into their respective values. Useful for debugging. -#### `/papi bcparse` -**Description**: -Parses placeholders of a String and broadcasts the result to all players. +- #### `/papi bcparse` + **Description**: + Parses placeholders of a String and broadcasts the result to all players. + + **Arguments**: + * `` - The Player to parse values of the placeholder (Use `me` for yourself). + * `` - The text to parse. + + **Example**: + ``` + /papi bcparse funnycube My name is %player_name%! + ``` -**Arguments**: -* `` - The Player to parse values of the placeholder (Use `me` for yourself). -* `` - The text to parse. +- #### `/papi cmdparse` + **Description**: + Parses placeholders of a String and executes it as a command. -**Example**: -``` -/papi bcparse funnycube My name is %player_name%! -``` + **Arguments**: + - `` - The player to parse placeholders against. Use `me` for yourself. + - `` - The Text to parse and execute as command. Please leave away the `/` of the command. + + **Example**: + ``` + /papi cmdparse funnycube say My name is %player_name%! + ``` + +- #### `/papi parse` + **Description**: + Parses the placeholders in a given text and shows the result. + + **Arguments**: + * `` - The Player to parse values of the placeholder (Use `me` for yourself). + * `` - The text to parse. + + **Example**: + ``` + /papi parse funnycube My group is %vault_group% + ``` + +- #### `/papi parserel` + **Description**: + Parses a relational placeholder. + + **Arguments**: + * `` - The first player. + * `` - the second player to compare with. + * `` - The actual placeholder to parse. + + **Example**: + ``` + /papi parserel funnycube extended_clip %placeholder% + ``` ---- -#### `/papi cmdparse` -**Description**: -Parses placeholders of a String and executes it as a command. -**Arguments**: -- `` - The player to parse placeholders against. Use `me` for yourself. -- `` - The Text to parse and execute as command. Please leave away the `/` of the command. - -**Example**: -``` -/papi cmdparse funnycube say My name is %player_name%! -``` - ----- -#### `/papi parse` -**Description**: -Parses the placeholders in a given text and shows the result. - -**Arguments**: -* `` - The Player to parse values of the placeholder (Use `me` for yourself). -* `` - The text to parse. - -**Example**: -``` -/papi parse funnycube My group is %vault_group% -``` - ----- -#### `/papi parserel` -**Description**: -Parses a relational placeholder. - -**Arguments**: -* `` - The first player. -* `` - the second player to compare with. -* `` - The actual placeholder to parse. - -**Example**: -``` -/papi parserel funnycube extended_clip %placeholder% -``` - ----- ### eCloud Commands These commands all start with `/papi ecloud` and are used for things related about the [[Expansion Cloud]]. -#### `/papi ecloud clear` -**Description**: -Clears the cache for the eCloud. +- #### `/papi ecloud clear` + **Description**: + Clears the cache for the eCloud. + +- #### `/papi ecloud disable` + **Description**: + Disables the connection to the eCloud. + +- #### `/papi ecloud download` + **Description**: + Allows you to download an expansion from the eCloud + + **Arguments**: + - `` - The expansion to download. + - `[version]` - The specific version of the expansion to download (Optional) + + **Example**: + ``` + /papi ecloud download Vault + /papi ecloud download Vault 1.5.2 + ``` + +- #### `/papi ecloud enable` + **Description**: + Enables the connection to the eCloud + +- #### `/papi ecloud info` + **Description**: + Gives information about a specific Expansion. + + **Arguments**: + - `` - The Expansion to retrieve information from. + - `[version]` - The Expansion's version to get information from. + + **Example**: + ``` + /papi ecloud info Vault + ``` + +- #### `/papi ecloud list` + **Description**: + 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. + + **Arguments**: + - `|installed>` - List all Expansions, Expansions of a specific author or all Expnansions you have installed. + + **Example**: + ``` + /papi ecloud list all + /papi ecloud list clip + /papi ecloud list installed + ``` + +- #### `/papi ecloud placeholders` + **Description**: + List all placeholders of an Expansion. + + **Arguments**: + - `` - The Expansion to list placeholders of. + + **Example**: + ``` + /papi ecloud placeholders Vault + ``` + +- #### `/papi ecloud refresh` + **Description**: + Refresh the cached data from the eCloud. + +- #### `/papi ecloud status` + **Description**: + Displays the actual Status of the eCloud. ---- -#### `/papi ecloud disable` -**Description**: -Disables the connection to the eCloud. ----- -#### `/papi ecloud download` -**Description**: -Allows you to download an expansion from the eCloud - -**Arguments**: -- `` - The expansion to download. -- `[version]` - The specific version of the expansion to download (Optional) - -**Example**: -``` -/papi ecloud download Vault -/papi ecloud download Vault 1.5.2 -``` - ----- -#### `/papi ecloud enable` -**Description**: -Enables the connection to the eCloud - ----- -#### `/papi ecloud info` -**Description**: -Gives information about a specific Expansion. - -**Arguments**: -- `` - The Expansion to retrieve information from. -- `[version]` - The Expansion's version to get information from. - -**Example**: -``` -/papi ecloud info Vault -``` - ----- -#### `/papi ecloud list` -**Description**: -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. - -**Arguments**: -- `|installed>` - List all Expansions, Expansions of a specific author or all Expnansions you have installed. - -**Example**: -``` -/papi ecloud list all -/papi ecloud list clip -/papi ecloud list installed -``` - ----- -#### `/papi ecloud placeholders` -**Description**: -List all placeholders of an Expansion. - -**Arguments**: -- `` - The Expansion to list placeholders of. - -**Example**: -``` -/papi ecloud placeholders Vault -``` - ----- -#### `/papi ecloud refresh` -**Description**: -Refresh the cached data from the eCloud. - ----- -#### `/papi ecloud status` -**Description**: -Displays the actual Status of the eCloud. - ----- ### Expansion Commands These commands can be used to manage the expansions that you have currently installed. -#### `/papi info` -**Description**: -Gives you information about the specified Expansion. +- #### `/papi info` + **Description**: + Gives you information about the specified Expansion. -**Argument(s)**: -- `` - The Expansion to get info from (Needs to be registered and active). + **Argument(s)**: + - `` - The Expansion to get info from (Needs to be registered and active). + + **Example**: + ``` + /papi info Vault + ``` -**Example**: -``` -/papi info Vault -``` +- #### `/papi list` + **Description**: + 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. + +- #### `/papi register` + **Description**: + 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. + The file needs to be inside `/plugins/PlaceholderAPI/expansions`. + + **Arguments**: + - `` - The file to register (including the file-extension). + + **Example**: + ``` + /papi register MyExpansion.jar + ``` + +- #### `/papi unregister` + **Description**: + Unregisters the specified expansion. + + **Arguments**: + - `` - The expansion to unregister. + + **Example**: + ``` + /papi unregister MyExpansion.jar + ``` ---- -#### `/papi list` -**Description**: -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. ----- -#### `/papi register` -**Description**: -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. -The file needs to be inside `/plugins/PlaceholderAPI/expansions`. - -**Arguments**: -- `` - The file to register (including the file-extension). - -**Example**: -``` -/papi register MyExpansion.jar -``` - ----- -#### `/papi unregister` -**Description**: -Unregisters the specified expansion. - -**Arguments**: -- `` - The expansion to unregister. - -**Example**: -``` -/papi unregister MyExpansion.jar -``` - ----- ### Other Commands These are other commands of PlaceholderAPI that don't fit any of the above categories. -#### `/papi dump` -**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. +- #### `/papi dump` + **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. -#### `/papi reload` -**Description**: -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. \ No newline at end of file +- #### `/papi reload` + **Description**: + 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.