Skip to content

Commit

Permalink
Merge pull request #16 from gabber235/develop
Browse files Browse the repository at this point in the history
[Docs] Small changes
  • Loading branch information
jhqwqmc authored Aug 30, 2024
2 parents 32de894 + f57efb8 commit 466329b
Show file tree
Hide file tree
Showing 7 changed files with 691 additions and 670 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ If you want to expand your story with PlaceHolderAPI's placeholders, you can do
By just using the PlaceHolderAPI's format, you can make them work. For example, `%player_name%` would give the name of a player.

:::danger[Not working]
If placeholders are not working, make sure you have the placeholder installed. For instance, with `%player_name%`, you must have installed `player` via the PlaceHolderAPI ecloud. To do this, just run: `/papi ecloud install player`.
If placeholders are not working, make sure you have the placeholder installed. For instance, with `%player_name%`, you must have installed `player` via the PlaceHolderAPI ecloud. To do this, just run: `/papi ecloud download player`.
:::

## Use TypeWriter's Placeholders
Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/docs/06-troubleshooting/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ This typically indicates that the adapter is not placed in the correct folder. F
If placeholders from PlaceholderAPI, such as `%player_name%`, aren't being parsed correctly in Typewriter, follow these troubleshooting steps:

1. Identify the required PlaceholderAPI placeholder extension. A list of extensions can be found [here](https://github.com/PlaceholderAPI/PlaceholderAPI/wiki/Placeholders).
2. Install the necessary extension using `/papi ecloud install [extension_name]`. For `%player_name%`, use `/papi ecloud install player`.
2. Install the necessary extension using `/papi ecloud install [extension_name]`. For `%player_name%`, use `/papi ecloud download player`.
3. Check if the placeholder is parsed correctly in normal usage by running `/papi parse me <placeholder>`. For `%player_name%`, use `/papi parse me %player_name%`.
4. If the placeholder works in normal usage but still not in Typewriter, try restarting your server.

Expand Down
1,294 changes: 655 additions & 639 deletions documentation/package-lock.json

Large diffs are not rendered by default.

54 changes: 27 additions & 27 deletions documentation/plugins/code-snippets/snippets.json

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
# Dependencies

For the plugin to properly work you need to have the dependencies of the plugin installed these are:

- **ProtocolLib**: [download](https://www.spigotmc.org/resources/protocollib.1997/)
- **PlaceholderAPI** _(Optional)_: [download](https://www.spigotmc.org/resources/placeholderapi.6245/) **NOTE**: run the command: `/papi ecloud install player` after installation to let it correctly work.

## Soft-dependencies

If you want to add extra features or make other adapters work, you can install plugins like:

- **Citizens**: [download](https://www.spigotmc.org/resources/citizens.13811/)
Expand All @@ -19,5 +22,7 @@ If you want to add extra features or make other adapters work, you can install p
In order for the dependencies to be recognized by Typewriter, you need to install the accompanying [Adapter](adapters).

## Plugin-breakers

These plugins are known to break the plugin so they should **NOT** be installed.

- **interactivechat**: [link](https://www.spigotmc.org/resources/interactivechat-show-items-inventory-in-chat-custom-chat-keywords-bungee-velocity-support.75870/)
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ If you want to expand your story with PlaceHolderAPI's placeholders, you can do
By just using the PlaceHolderAPI's format, you can make them work. For example, `%player_name%` would give the name of a player.

:::danger[Not working]
If placeholders are not working, make sure you have the placeholder installed. For instance, with `%player_name%`, you must have installed `player` via the PlaceHolderAPI ecloud. To do this, just run: `/papi ecloud install player`.
If placeholders are not working, make sure you have the placeholder installed. For instance, with `%player_name%`, you must have installed `player` via the PlaceHolderAPI ecloud. To do this, just run: `/papi ecloud download player`.
:::

## Use TypeWriter's Placeholders
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ This typically indicates that the adapter is not placed in the correct folder. F
If placeholders from PlaceholderAPI, such as `%player_name%`, aren't being parsed correctly in Typewriter, follow these troubleshooting steps:

1. Identify the required PlaceholderAPI placeholder extension. A list of extensions can be found [here](https://github.com/PlaceholderAPI/PlaceholderAPI/wiki/Placeholders).
2. Install the necessary extension using `/papi ecloud install [extension_name]`. For `%player_name%`, use `/papi ecloud install player`.
2. Install the necessary extension using `/papi ecloud install [extension_name]`. For `%player_name%`, use `/papi ecloud download player`.
3. Check if the placeholder is parsed correctly in normal usage by running `/papi parse me <placeholder>`. For `%player_name%`, use `/papi parse me %player_name%`.
4. If the placeholder works in normal usage but still not in Typewriter, try restarting your server.

Expand Down

0 comments on commit 466329b

Please sign in to comment.