Admin
Bellow you can find documentation for wormhole administrators and bot owners.
How to set up wormhole on a guild
This section is aimed to guild owners who want to add bot using this module to their guild. First add the bot to your guild. Then please check if the bot has permission to manage it’s future channel. Last please select a wormhole channel with command wormhole channel set. Optionally you can set up guild log channel described in Logging.
Application emojis
You can create special custom emojis to replace guild names in messages. These custom emojis are stored as application emojis and they can be uploaded in discord developer portal. The name of each emoji should match the guild’s name, converted to lowercase, with spaces converted to '_', ASCII characters only (if applicable). For the guild ČVUT FEL, the corresponding emoji should be named cvut_fel.
Command overview
Channel group
The Channel group contains commands to manage channels added to Wormhole.
wormhole channel set <channel>
/command, administrator=True, default ACLevel: GUILD_OWNER
Register a channel as a wormhole. All messages in this channel will be deleted and mirrored to all other wormhole channels. The command will let you choose the channel.
wormhole channel list
/command, administrator=True, default ACLevel: SUBMOD
List all channels registered as wormholes.
wormhole channel remove <channel>
/command, administrator=True, default ACLevel: GUILD_OWNER
Unregister a channel from the wormhole. The command will let you choose the channel.
Slowmode group
The Slowmode group provides commands for managing slowmode across all Wormhole channels.
wormhole slowmode set <time>
/command, administrator=True, default ACLevel: BOT_OWNER
Apply slow mode to all wormhole channels. time is integer in seconds.
wormhole slowmode remove
/command, administrator=True, default ACLevel: BOT_OWNER
Disable slow mode in all wormhole channels.
Note
It is equivalent to wormhole slowmode set 0
Pattern group
A configuration set for Wormhole message moderation using regex patterns. When any part of a message matches a defined pattern, that portion is replaced with the specified replacement before the message is forwarded to Wormhole.
wormhole pattern set <pattern> <replacement>
/command, administrator=True, default ACLevel: MOD
Set regex filtration pattern.
wormhole pattern update <id> <pattern> <replacement>
/command, administrator=True, default ACLevel: MOD
Update regex filtration pattern.
wormhole pattern list
/command, administrator=True, default ACLevel: MOD
Lists regex filtration patterns.
wormhole pattern remove <id>
/command, administrator=True, default ACLevel: MOD
Removes regex filtration pattern from the database and patterns array.
Some usefull patterns
Pattern |
Replacement |
Description |
|---|---|---|
|
|
Mention replacement pattern |
|
|
Hidden link replacement pattern |