mod: changed bot name
This commit is contained in:
@@ -12,7 +12,7 @@ If you have any trouble with operation of this bot, please do not hesitate to re
|
|||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
|
|
||||||
Hildebrand is a Discord trivia buzzer bot. It creates a shared buzzer in a text
|
Hildibrand is a Discord trivia buzzer bot. It creates a shared buzzer in a text
|
||||||
channel, plays a buzzer sound in voice, identifies the first participant to
|
channel, plays a buzzer sound in voice, identifies the first participant to
|
||||||
buzz, and can mute the other participants so the winner can answer.
|
buzz, and can mute the other participants so the winner can answer.
|
||||||
|
|
||||||
@@ -32,19 +32,15 @@ will be used:
|
|||||||
Members also need permission to use application commands in the chosen text
|
Members also need permission to use application commands in the chosen text
|
||||||
channel.
|
channel.
|
||||||
|
|
||||||
Place the Hildebrand bot role above the roles of the participants it must mute.
|
|
||||||
Discord does not allow a bot to mute a member whose highest role is equal to or
|
|
||||||
higher than the bot's highest role. Server owners cannot be muted by a bot.
|
|
||||||
|
|
||||||
> [!IMPORTANT]
|
> [!IMPORTANT]
|
||||||
> Do not grant Hildebrand the full Administrator permission. The channel and
|
> Do not grant Hildibrand the full Administrator permission. The channel and
|
||||||
> voice permissions listed above are sufficient.
|
> voice permissions listed above are sufficient.
|
||||||
|
|
||||||
## Quick start for a trivia host
|
## Quick start for a trivia host
|
||||||
|
|
||||||
1. Join the voice channel where the trivia game will take place.
|
1. Join the voice channel where the trivia game will take place.
|
||||||
2. In the text channel where you want the buzzer to appear, run `/start`.
|
2. In the text channel where you want the buzzer to appear, run `/start`.
|
||||||
3. Wait for Hildebrand to join voice and post **The buzzer is ready!**.
|
3. Wait for Hildibrand to join voice and post **The buzzer is ready!**.
|
||||||
4. Ask players to join the same voice channel and use the **BUZZ!** button in
|
4. Ask players to join the same voice channel and use the **BUZZ!** button in
|
||||||
the bot's message.
|
the bot's message.
|
||||||
5. After a player answers, select **Reset** to begin the next question.
|
5. After a player answers, select **Reset** to begin the next question.
|
||||||
@@ -65,8 +61,8 @@ started. The first accepted button press does all of the following:
|
|||||||
3. Plays the buzzer sound in the voice channel.
|
3. Plays the buzzer sound in the voice channel.
|
||||||
4. Server-mutes the other human participants currently in that channel.
|
4. Server-mutes the other human participants currently in that channel.
|
||||||
|
|
||||||
Hildebrand does not mute the session host or winning player itself. Bots are
|
Hildibrand does not mute the session host or winning player itself. Bots are
|
||||||
not muted. Any pre-existing server mute still applies, however: Hildebrand
|
not muted. Any pre-existing server mute still applies, however: Hildibrand
|
||||||
leaves it alone and will not later remove that moderator-applied mute.
|
leaves it alone and will not later remove that moderator-applied mute.
|
||||||
|
|
||||||
Players receive a private Discord response that only they can see if they try
|
Players receive a private Discord response that only they can see if they try
|
||||||
@@ -81,10 +77,10 @@ the member who selected it.
|
|||||||
|
|
||||||
| Control | Command | Result |
|
| Control | Command | Result |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| **Reset** | `/reset` | Clears the previous winner, opens the buzzer, and unmutes members muted by Hildebrand. Use this between questions. |
|
| **Reset** | `/reset` | Clears the previous winner, opens the buzzer, and unmutes members muted by Hildibrand. Use this between questions. |
|
||||||
| **Lock** | `/lock` | Closes the buzzer and mutes everyone currently in the voice channel except the host and the current winner, if there is one. |
|
| **Lock** | `/lock` | Closes the buzzer and mutes everyone currently in the voice channel except the host and the current winner, if there is one. |
|
||||||
| **Unlock** | `/unlock` | Opens the buzzer and unmutes members muted by Hildebrand, but keeps the previous winner's name in the message. |
|
| **Unlock** | `/unlock` | Opens the buzzer and unmutes members muted by Hildibrand, but keeps the previous winner's name in the message. |
|
||||||
| — | `/stop` | Unmutes members muted by Hildebrand, disconnects the bot from voice, ends the session, and disables the old controls. |
|
| — | `/stop` | Unmutes members muted by Hildibrand, disconnects the bot from voice, ends the session, and disables the old controls. |
|
||||||
|
|
||||||
`/start` creates a session in the voice channel occupied by the person who runs
|
`/start` creates a session in the voice channel occupied by the person who runs
|
||||||
the command. The buzzer message is posted in the text channel where the command
|
the command. The buzzer message is posted in the text channel where the command
|
||||||
@@ -102,7 +98,7 @@ was run.
|
|||||||
## Ending a session safely
|
## Ending a session safely
|
||||||
|
|
||||||
Always run `/stop` before the bot is shut down or restarted. This lets
|
Always run `/stop` before the bot is shut down or restarted. This lets
|
||||||
Hildebrand unmute the members it muted and disconnect cleanly.
|
Hildibrand unmute the members it muted and disconnect cleanly.
|
||||||
|
|
||||||
If Hildebrand reports that it could not unmute one or more participants, fix
|
If Hildebrand reports that it could not unmute one or more participants, fix
|
||||||
its **Mute Members** permission or role position and run `/stop` again. The
|
its **Mute Members** permission or role position and run `/stop` again. The
|
||||||
@@ -115,11 +111,11 @@ active; start a new session with `/start`.
|
|||||||
|
|
||||||
## Operational limits
|
## Operational limits
|
||||||
|
|
||||||
- A running Hildebrand instance supports only **one active session in total**,
|
- A running Hildibrand instance supports only **one active session in total**,
|
||||||
even if the bot has been added to multiple Discord servers.
|
even if the bot has been added to multiple Discord servers.
|
||||||
- A session remains tied to the voice channel selected at `/start`. Moving the
|
- A session remains tied to the voice channel selected at `/start`. Moving the
|
||||||
host or the bot does not move the session.
|
host or the bot does not move the session.
|
||||||
- Hildebrand mutes the people present when a player buzzes or the host selects
|
- Hildibrand mutes the people present when a player buzzes or the host selects
|
||||||
**Lock**. It does not continuously mute people who join the channel later.
|
**Lock**. It does not continuously mute people who join the channel later.
|
||||||
- Control of an active session cannot be transferred to another member. The
|
- Control of an active session cannot be transferred to another member. The
|
||||||
original host must stop it, or the bot operator must restart the bot and an
|
original host must stop it, or the bot operator must restart the bot and an
|
||||||
@@ -155,12 +151,12 @@ Do not delete the active buzzer message while a session is running.
|
|||||||
Check all of the following:
|
Check all of the following:
|
||||||
|
|
||||||
- The bot has **Mute Members** in the voice channel.
|
- The bot has **Mute Members** in the voice channel.
|
||||||
- The Hildebrand role is above each affected player's highest role.
|
- The Hildibrand role is above each affected player's highest role.
|
||||||
- The affected account is not the server owner.
|
- The affected account is not the server owner.
|
||||||
- The player is in the session's original voice channel.
|
- The player is in the session's original voice channel.
|
||||||
|
|
||||||
Hildebrand intentionally does not unmute a member who was already server-muted
|
Hildibrand intentionally does not unmute a member who was already server-muted
|
||||||
before Hildebrand tried to mute them.
|
before Hildibrand tried to mute them.
|
||||||
|
|
||||||
### A player cannot buzz
|
### A player cannot buzz
|
||||||
|
|
||||||
@@ -177,7 +173,7 @@ operator to restart the instance and manually clear any remaining server mutes.
|
|||||||
### A host is no longer available
|
### A host is no longer available
|
||||||
|
|
||||||
There is no host-transfer command. Ask the original host to run `/stop`. If
|
There is no host-transfer command. Ask the original host to run `/stop`. If
|
||||||
that is impossible, the bot operator must restart Hildebrand; afterward, a
|
that is impossible, the bot operator must restart Hildibrand; afterward, a
|
||||||
Discord administrator should manually unmute anyone left server-muted and a
|
Discord administrator should manually unmute anyone left server-muted and a
|
||||||
new host can run `/start`.
|
new host can run `/start`.
|
||||||
|
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ Licensed by [Eclipse Public License 2.0](./LICENSE)
|
|||||||
|
|
||||||
## What is this?
|
## What is this?
|
||||||
|
|
||||||
Hildebrand is a Discord trivia buzzer bot. It creates a shared buzzer in a text
|
Hildibrand is a Discord trivia buzzer bot. It creates a shared buzzer in a text
|
||||||
channel, plays a buzzer sound in voice, identifies the first participant to
|
channel, plays a buzzer sound in voice, identifies the first participant to
|
||||||
buzz, and can mute the other participants so the winner can answer.
|
buzz, and can mute the other participants so the winner can answer.
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user