Configuration

These are the environment variables used for configuring the bot.

Server

Key	Type	Description	Default
BRIDGE_SERVER_HOST	str	The host to connect to.	mc.hypixel.net
BRIDGE_SERVER_PORT	int	The port to connect to on the host.	25565

Account

Key	Type	Description	Default
BRIDGE_ACCOUNT_EMAIL	str	Not actually useful, serves as an internal identifier for the account you're using.

Discord

Key	Type	Description	Default
BRIDGE_DISCORD_TOKEN	str	Discord bot token.
BRIDGE_DISCORD_CHANNEL	int	Channel ID for your bridge messages.
BRIDGE_DISCORD_ALLOWCROSSCHAT	list[int]	Channel IDs for which to allow "Cross Chat", which sends messages from other bridge bots to your guild. Formatted like so: ID,ID,...
BRIDGE_DISCORD_OFFICERCHANNEL	int	Channel ID for your officer chat messages.
BRIDGE_DISCORD_ALLOWOFFICERCROSSCHAT	list[int]	Same as DISCORD_ALLOWCROSSCHAT, but for officer chat.
BRIDGE_DISCORD_COMMANDROLE	int	Your "Guild Staff" role, allows members with the role to take staff actions with the bot (invite, kick, mute, etc.)
BRIDGE_DISCORD_OVERRIDEROLE	int	Your admin role, allows members with the role to use administrative commands such as !override.
BRIDGE_DISCORD_OWNERID	int	Functionally the same as DISCORD_OVERRIDEROLE, but for one user instead.
BRIDGE_DISCORD_PREFIX	str	The prefix for the bot.	!
BRIDGE_DISCORD_WEBHOOKURL	str	If set, the bot will send webhook messages that appear to be from the Minecraft users, instead of embeds from the bot.
BRIDGE_DISCORD_DEBUGWEBHOOKURL	str	Outputs some of the bot's logs to this webhook. Not useful unless you know what you're doing.
BRIDGE_DISCORD_SERVERNAME	str	When using DISCORD_WEBHOOKURL, messages from the bridge bot will use this name as the webhook's name.
BRIDGE_DISCORD_IGNORECROSSCHATWARNING	bool	Silences the warning in the terminal when crosschat is enabled.	false

Settings

Key	Type	Description	Default
BRIDGE_SETTINGS_AUTOACCEPT	bool	Autoaccept guild invites.	false
BRIDGE_SETTINGS_DATELIMIT	int	Date range limit for the !top command. Limited by Hypixel, so changing this value to something bigger will have no effect.	30
BRIDGE_SETTINGS_EXTENSIONS	list[str]	List of discord.py extensions to load. There are two built-in: .game_commands and .mute_sync.
BRIDGE_SETTINGS_PRINTCHAT	bool	If enabled, prints all chat messages to the terminal.	false
BRIDGE_SETTINGS_HIDEINVITEMESSAGES	bool	Hides invite messages from being sent to bridge chat.	false

Redis

Optional and not useful unless you know what you're doing.

Key	Type	Description	Default
BRIDGE_REDIS_HOST	str	Hostname for the redis server.
BRIDGE_REDIS_PORT	int	Port for the redis server.
BRIDGE_REDIS_PASSWORD	str	Redis server password, if requirepass is enabled.
BRIDGE_REDIS_CLIENTNAME	str	Client name to use for pub/sub.
BRIDGE_REDIS_RECEIVECHANNEL	str	Pub/sub channel to receive messages on.
BRIDGE_REDIS_SENDCHANNEL	str	Pub/sub channel to send messages on.

SkyKings

Key	Type	Description	Default
BRIDGE_SKYKINGS_API_KEY	str	Your SkyKings API key. Required for some extensions.
BRIDGE_SKYKINGS_API_URL	str	The SkyKings API url. Should not be changed.	https://api.skykings.net

Hypixel API

Key	Type	Description	Default
BRIDGE_HYPIXEL_API_KEY	str	Your Hypixel API key. Required for some extensions.
BRIDGE_HYPIXEL_API_URL	str	The Hypixel API url. Should not be changed.	https://api.hypixel.net/v2

Extensions

.mute_sync

Key	Type	Description	Default
BRIDGE_MUTE_SYNC_MUTE_ROLE	int	The role to apply for guild mutes.

Also requires that BRIDGE_HYPIXEL_API_KEY and BRIDGE_SKYKINGS_API_KEY are set.

.game_commands

Uses BRIDGE_DISCORD_PREFIX as the prefix for commands.

Key	Type	Description	Default
BRIDGE_GAME_COMMANDS_ENABLED_COMMANDS	list[str]	Commands to enable. Defaults to all if left empty.
BRIDGE_GAME_COMMANDS_USE_ANTISPAM	bool	Adds a random string of characters to the end of each message to try and evade spam filters. Usually not needed.	false
BRIDGE_GAME_COMMANDS_COMMAND_COOLDOWN	float	Cooldown between commands, in seconds.	5.0

Also requires that BRIDGE_HYPIXEL_API_KEY is set. BRIDGE_SKYKINGS_API_KEY is required for some commands.