Getting Started
So you just got your Home Bot, and you're not sure where to start. Well, you've come to the right place.
On this page, we'll go over:
Firstly, let's talk about Modules.
Every Home Bot runs on a very structural command structure called Modules. Metaphorically, if a Home Bot was a book, and its commands were the pages, Modules are the book's chapters. Each Module is a group of several commands, and most have a primary Module configuration command (outlined in each Module's page) that must be used first before being able to use the Module's other commands/functionalities.
There are outliers, of course. Some features, such as the AFK Command, belong to no Module in particular and require no Module configuration. Alternatively, some Modules don't have a Module configuration command and you can jump right into using it.
All of this will be made clear in each Module's page.
Secondly, let's explore how to assign commands to certain channels or roles.
Configuring Modules is all nice and dandy, but the majority of the Modules' commands will be locked behind the Administration permission. This is to give you home owners a comfortable time to read through the documentation and configure Modules before assigning commands to your staff groups or community roles.
Now, how exactly do you configure command permissions? Well, it's quite easy.
On desktop, go to Server Settings -> Integrations and select your Home Bot from the list. The new window will show you all of your Home Bot's commands.
You can make changes to each command by creating overwrites. Clicking a command in the list will open a popup where you can make changes.
Lastly, let's check out how to change your Home Bot's status and view your membership details.
Two simple commands, right below.
Home (/home
)
/home
)Only the Membership holder can use this command.
View your Home Bot membership details.
Config Bot Status (/config bot status
)
/config bot status
)By default, only members with the Administration permission can use this command.
Change your Home Bot's custom status.
state
: The state of the bot; this can be Online
, Idle
, or Do Not Disturb
.
status
: the status of the bot; tthis can be Watching
, Playing
, Streaming
, or Listening
.
message
: This is the message that will go alongside the status.
Last updated