Welcome to StatusBot Wiki & Documentation.¶
Contents:¶
Extensions¶
Extensions are a powerful way to use StatuBot, providing new, custom features. If you need any help, feel free to Join our Discord: https://discord.gg/HvJ4hSA
Warning
Some extensions require a premium subscription to use.
Warning
You need to be an admin on the server you wish to manage extensions for.
List of Extensions¶
StatusBot currently supports 2 monitors with more to come soon!
Minecraft - Adds player count & ping to the MC server to the
HyperChecker - Pings the IP/Domain you've set every 10 seconds & only updates the embed when it detects a change.
.. WARNING:: You can not use HyperChecker & Minecraft extension together.
Viewing Extensions¶
- You can run sb!extensions
or - Go to https://statusbot.xyz/dash & Select a guild, then you can go to your monitors page to view and edit extensions.
Enabling & Disabling Extensions¶
- In the guild you wish to enable an extension for
sb!extensions <monitorID> <extensionName>
Running this will enable the extension for that monitor & running it again disables the extension!
General¶
General bot features/commands. If you need any help, feel free to Join our Discord: https://discord.gg/HvJ4hSA
General¶
- Default Prefix: sb!
- We will be using this prefix throughout the rest of the docs, please replace it with your guild’s prefix when running command.
- Get your current prefix by mentioning the bot.
Configure¶
Note
You need to be an admin to run the commands in this section.
- Configure your server by running:
sb!config
- Run first time server setup by running:
Note
This command can only be run once.
Warning
Coming Soon.
sb!setup
You will be promted about various settings to change.
Commands¶
- For a general overview of commands in your guild, do:
sb!help
- For a more specific look at a command, do:
sb!help <command name>
Monitors¶
Monitors are the way to see the status of an IP/Domain. Here is a simple guide on everything about them. If you need anyhelp, feel free to Join our Discord: https://discord.gg/HvJ4hSA
Warning
You need to be an admin on the guild to create/manage monitors.
Viewing Monitors¶
- Overview of all monitors
For a quick overview of all the monitors on your guild, run:
sb!monitors
This will show you every monitor on your guild, along with the Status, ID & Name of the monitors.
- View Individual monitors
To view a individual monitor, you can run:
sb!monitor <monitor id>
Running this command will provide more information on the monitor.
Note
You get the <monitor id> from running the monitors command.
Creating Monitors¶
- Create a monitor
To create a monitor simply run the following:
sb!create
The bot will prompt you with questions to setup the monitor.
Configuring Monitors¶
- Configuring Monitors
When configuring a monitors settings, the base syntax is:
sb!monitor <monitor id> <setting> <new value>
Note
The <new value> doesn’t have to be there for all settings.
The following tables will provide information on each setting.
Note
All settings are case insensitive in commands
| Setting | New Value Required? | Posible new values | Description |
|---|---|---|---|
| name | Yes | Any string | The name of the monitor |
| ip | Yes | Any valid domain or ip address | The domain or ip of the monitor |
| domain | Yes | Any valid domain or ip address | The domain or ip of the monitor |
| enabled | No | Any value inputed will be ignored | Toggle wether the monitor is enabled or not |
| enable | No | Any value inputed will be ignored | Enable the monitor |
| disable | No | Any value inputed will be ignored | Disable the monitor |
| hidden | No | Any value inputed will be ignored | Toggle wether the monitor ip is hidden or not |
Deleting Monitors¶
- Deleting a monitor
To delete an individual monitor run the following:
sb!delete <monitor id | monitor name>
Note
| means “or”
- Deleting all the monitors
To delete all monitors run the following
Warning
In Developement
sb!delete all