Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 24 additions & 3 deletions source/bridge/extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

Our bridge bots allow you to write your own extensions to add-on to the bridge bot, using the discord.py extension system.

We also have a few built-in extensions that you can use, such as the `.mutesync` extension.

## Built-in Extensions

These extensions are shipped with your bridge bot, and require no extra installation. They just need to be configured.

### MuteSync

Allows you to sync guild mutes with a role in your Discord server to
prevent people from talking in the bridge channel while muted in-game.

This extension required a Hypixel API key, as well as a SkyKings API key.
This extension requires a Hypixel API key for fetching guild mutes, as well as a SkyKings API key for converting usernames to Discord IDs.

Add this extension by adding `.mutesync` to the `extensions` list in the `config.json` file.

Expand All @@ -28,6 +28,26 @@ Hypixel API keys can be obtained at [developer.hypixel.net/](https://developer.h

You can view information on SkyKings API keys at [skykings.net/api](https://skykings.net/api/#section/Authentication).

### Game Commands

Allows you to use commands for viewing statistics in-game through the Bridge.

This extension requires a Hypixel API key for fetching player statistics, and uses the configured Discord prefix as a command prefix.

Add this extension by adding `.game_commands` to the `extensions` list in the `config.json` file.

#### Configuration

```json
{
"hypixel_api_key": "key",
"enabled_commands": [],
"use_antispam": false,
"command_cooldown": 5.0
}
```
Hypixel API keys can be obtained at [developer.hypixel.net/](https://developer.hypixel.net/).

## Adding Extensions

To add an extension, add the extension path to the `extensions` list in the `config.json` file.
Expand All @@ -36,6 +56,7 @@ To add an extension, add the extension path to the `extensions` list in the `con
{
"extensions": [
".mutesync",
".game_commands",
".myextension.extension" // would refer to extensions/myextension/extension.py
]
}
Expand Down
4 changes: 2 additions & 2 deletions source/bridge/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,9 @@ Run the `!update` command in Discord, or, use the following commands in your bri

```shell
# Update files
git pull
./venv/bin/python main.py update

# Restart the bot
# If you do not know what the process name is, you can get it with `pm2 ls`
pm2 restart <process-name>
```
```