Skip to content

README.md

Latest commit

 

History

History
172 lines (109 loc) · 8.77 KB

README.md

File metadata and controls

172 lines (109 loc) · 8.77 KB

Official Add-ons for Showdown-ChatBot

This is a list of official add-ons: developed by the authors of the bot ar accepted by them.

The add-ons are sorted alphabetically.

Index:

AI Ask add-on

Description: This add-on adds an .ask command that allows users to ask questions and receive AI-powered responses. It supports OpenAI (GPT), Google Gemini, and Anthropic Claude. The bot reads recent chat messages and remembers previous conversations with each user for context-aware responses.

Add-on file: ai-ask

Added commands:

Command syntax Description
.ask <question> Ask the AI a question and receive a response

Configuration: Open the ai-ask.js file and edit the constants at the top before installing:

  • AI_PROVIDER: The AI provider to use ('openai', 'gemini', or 'claude')
  • AI_API_KEY: Your API key for the selected provider
  • DEFAULT_ALLOWED_GROUP: Group allowed to use the command by default. Can be a symbol or a group name, including excepted (for excepted users) and user (for all users). You can change this permission on specific rooms using the set ask, <group> command.

API Keys:

Automated promotion to voice

Description: This add-on automatically promotes users to room voice when they join specific rooms. This may be useful in certain cases. Note: The bot account needs to be able to promote to voice for this to work.

Add-on file: auto-voice

Configuration: In order to configure the add-on, change the value of the following constants before installing:

  • Rooms: The list of rooms where this feature will be enabled

You can optionally change the value of Promotion_Command, in order to change the promotion command.

Automated response add-on

Description: This add-on makes the bot automatically respond to certain message patterns. For example: If an user says good luck in battle, it will respond with Have fun!. It can serve as a template to create your own custom auto-response add-on.

Add-on file: auto-response

Battle spectate add-on

Description: This add-on makes the bot automatically join battles in order to spectate them. Note: The Battle Log module also implements this feature. Use this add-on only if you want to keep the Battle Log module disabled.

Add-on file: battle-spectate

Configuration: In order to configure the add-on, change the value of the following constants before installing:

  • SPECTATE_TOURNAMENT_BATTLES: True to spectate tournament battles
  • SPECTATE_SERVER_BATTLES: True to spectate server battles announced in the Lobby room.

Commands guide add-on

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).

Add-on files:

Restrictions:

  • The bot requires the rank of bot in a room, and the user must also be in that room, in order for the /sendhtmlpage server command to work.
  • Showdown-ChatBot version must be equal or greater than 2.16.1.

Configuration: You can configure the commands guide by accessing the Commands Guide section of the control panel.

Also, you can change the MAX_COMMANDS_PER_PAGE constant in order to change the number of commands per page.

HashPoke command exceptions

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.

Add-on file: hpoke-exceptions

Pastebin add-on

Description: This add-on adds a set of commands to import and export certain think in bulk. The export process is done via temporal links of the control panel, while the import process is done via Pastebin links. This allows the staff to configure these settings without access to the control panel.

Add-on files:

Added commands:

Command syntax Description
setrand <Command>, <Pastebin link> Imports the options for a random command. The Pastebin must have the options separated in each line.
getkuncdata Exports the data of the game of Kunc.
setkuncdata <Pastebin link> Imports the data of the game of Kunc.
gettriviadata Exports the data of the game of Trivia.
settriviadata <Pastebin link> Imports the data of the game of Trivia.
gethangmandata Exports the data of the game of Hangman.
sethangmandata <Pastebin link> Imports the data of the game of Hangman.
getanagramsdata Exports the data of the game of Anagrams.
setanagramsdata <Pastebin link> Imports the data of the game of Anagrams.

For the Kunc data, the following format is used: Species||move1,move2.... Example:

Pikachu||Thunderbolt,Fake Out,Iron Tail,Extreme Speed
Cinderace||Acrobatics,Pyro Ball,High Jump Kick,Court Change

For the Trivia data, the following format is used: Clue||answer,answer.... Example:

Which is the fastest Pokemon?||Regieleki
Which is the signature move of Chatot?||Chatter

For Hangman and Anagrams data, the following format is used: `Clue||word,word...``. Example:

Fruit||Apple,Orange,Strawberry,Pear
Animal||Cat,Dog,Rabbit,Chicken,Cow,Pig,Sheep

Configuration: You can change the permission for the commands by changing the value of the PERMISSION_REQUIRED constant:

// Name of the permission required for the commands
const PERMISSION_REQUIRED = "randadmin";

PokePaste preview add-on

Description: This add-on watches chat messages for PokePaste links and automatically posts a formatted preview with title/author, team icons, and a click-to-export section with copy button.

Add-on file: pokepast-preview

Configuration: In order to configure the add-on, change the values of these constants in the file:

  • ENABLED_ROOMS: List of room IDs where previews are enabled. Empty list means all rooms.
  • COOLDOWN_MS: Cooldown in milliseconds for repeated previews of the same paste in the same room.
  • CACHE_TTL_MS: Cache duration in milliseconds for fetched Pokepaste data.
  • SHOW_NOTES: Whether notes from Pokepaste should be displayed in the preview.

YouTube link recognition add-on

Description: An addon that recognizes the YouTube links sent in chat and automatically analyzes it and responds with the video title and author.

Add-on file: youtube

Configuration: In order to configure the add-on, change the value of the following constants before installing: