|
9 | 9 | - [Automated promotion to voice](#automated-promotion-to-voice) |
10 | 10 | - [Automated response add-on](#automated-response-add-on) |
11 | 11 | - [Battle spectate add-on](#battle-spectate-add-on) |
| 12 | +- [Commands guide add-on](#commands-guide-add-on) |
12 | 13 | - [HashPoke command exceptions](#hashpoke-command-exceptions) |
13 | 14 | - [Pastebin add-on](#pastebin-add-on) |
14 | 15 | - [YouTube link recognition add-on](#youtube-link-recognition-add-on) |
@@ -44,6 +45,25 @@ You can optionally change the value of `Promotion_Command`, in order to change t |
44 | 45 | - `SPECTATE_TOURNAMENT_BATTLES`: True to spectate tournament battles |
45 | 46 | - `SPECTATE_SERVER_BATTLES`: True to spectate server battles announced in the `Lobby` room. |
46 | 47 |
|
| 48 | +## Commands guide add-on |
| 49 | + |
| 50 | +**Description**: This add-on turns the `.help` command into an interactive guide, making used of the `/sendhtmlpage` server command. The guide is divided in sections and the sections in pages. You can download the official guide from the Wiki (default), or configure your own guide via the control panel (new section: `Commands Guide`). |
| 51 | + |
| 52 | +**Add-on files**: |
| 53 | + |
| 54 | + - English version: [commands-guide](./commands-guide.js) |
| 55 | + - Spanish version: [commands-guide-es](./commands-guide-es.js) |
| 56 | + |
| 57 | +**Restrictions**: |
| 58 | + |
| 59 | + - The bot requires the rank of **global bot** in order to be able to use the `/sendhtmlpage` server command. |
| 60 | + - The bot must be present in the `Lobby` room of the server. |
| 61 | + - Showdown-ChatBot version must be equal or greater than `2.16.1`. |
| 62 | + |
| 63 | +**Configuration**: You can configure the commands guide by accessing the `Commands Guide` section of the control panel. |
| 64 | + |
| 65 | +Also, you can change the `MAX_COMMANDS_PER_PAGE` constant in order to change the number of commands per page. |
| 66 | + |
47 | 67 | ## HashPoke command exceptions |
48 | 68 |
|
49 | 69 | **Description**: This add-on adds a control panel section, named `HashPoke`, that allows you to configure exceptions for the `hashpoke` command. That way, you can set the resulting pokemon for certain usernames. |
|
0 commit comments