Play
Welcome to the Gaius Play Docs!
Gaius Play is the leveling bot offering many variables and factors in its immersive leveling system, such as customizable level/xp boosting, various equations, and unique options, to help engage your community's text and/or voice activity and enable users to show off their rank with flare.
The purpose of this documentation is to provide an in-depth comprehensive guidance and walkthrough on every module, feature, and command for Gaius Play and provide detailed examples and explanations to foster greater understanding of everything Gaius.
Gaius Play is split into modules, in which a set of relevant commands are grouped into, and these docs will provide a rundown of each module and their associated commands in a top-down approach.
Leveling can be linear and straightforward or complex like a tree (Premium version required).
Setting Up Gaius
When Play is in your server, you'll notice that no bot role is created in the bot's name. The very first task is to create and/or assign a role to Play if you want Play to give/remove reward roles. Some communities prefer to have a special bot role (for example, Bot City Gang) for a group of bots without the role that usually comes with a bot, so we keep that option available.
Permissions
The only staff permission truly needed for Play is Manage Roles because it cannot assign reward roles otherwise.
The list below details the minimum needed requirements in order for Play to function properly:
- View Channels
- Manage Roles (for the Leveling module)
- Send Messages
- Embed Links
- Attach Files
- Add Reactions (for help messages)
- Connect (for VC xp)
- Use Voice Activity (for VC xp)
If a role is assigned to Play, it is very important that its highest role with the Manage Roles perm is higher than the highest role you want it to assign anyone and that it has the Manage Roles perm.
Prefix
Changes Play's prefix used for commands
Make sure that Play's prefix is unique from the other bots.
Required Permissions
Manage Server
Syntax
>prefix newPrefixHere
Examples
>prefix !! | Changes Play's default prefix to !!
!!prefix prefix ! | This is a common mistake...the example below shows how to fix this.
prefix !prefix ! | Changes the above's prefix to !
WARNING
Kicking/Banning any Gaius bot then bringing it back will NOT reset the prefix or any settings.
If you forgot your prefix or don't know what you have changed it to, then try the !checkprefix command (by saying !checkprefix).
If you get a weird prefix, such as prefix !, and want to change it to !, then do prefix !prefix !
Modules
Play is separated into several modules and all modules are disabled by default, which means that in order to begin leveling setup or any other features, enabling the modules is the first step of the actual setup process through commands. This is so that only the features you want to have enabled for your server are enabled, and no more. The listed order of the modules below is in the order that they appear in the list subcommand for module (ie >module list).
Make sure that all modules you are want to enable for your server are enabled before proceeding onto the commands in the following pages, especially the leveling module.
Required Permissions
Manage Server
Syntax
>module moduleName
Examples
>help module | Displays the embedded help message for module
>module list | Lists all of Play's available features and says whether each module is disabled or enabled
>module leveling | Enables/Disables the leveling module
List of Available Modules
Help Command
Whenever quick help or information is needed for a command, using the help command is the most efficient action. It will respond with an embedded interactive help message, which you can navigate by saying any of the listed available options.
Required Permissions
None
Syntax
>help | Displays the embedded interactive help message
The help message expires after a certain amount of time. If it no longer responds, it simply expired and the command has to be sent again.
All commands that are tied to a module will be in the named module in the help message. All other commands that are always enabled are in the "Other" section.
FAQ
Q. Will kicking Play reset the bot?
- No, kicking/banning Gaius Play will never reset your settings or prefix.
Q. Why aren't my commands aren't working? Is the bot offline?
- This could be for a number of reasons. Here are a list of solutions (beginning with some of the most common solutions):
- Say
!checkprefixin your server. If Gaius has permission to speak in and see the channel, it will always respond with the current prefix.- If there is no response, try to @Gaius...this will pop up taggable users in a list, along as their online status icon on the lower-left of the user avatar. In the unlikely event that it is a gray icon, then Gaius is offline in your server and should be back online within a few minutes.
- If Gaius is online, make sure Gaius has permission to speak in the channel (Server Settings > Roles and/or Edit Channel > Permissions).
- If Gaius is not listed when you try to @gaius, then it likely does not have permission to see the channel, which is either because it does not have a role to see the channel(s), or it cannot see the channel in your channel settings.
- If Gaius responds with its current prefix, check your enabled modules with the
module listcommand. Most commands are tied with a module, which means if, for example, the leveling module is not enabled, thenlevel up,award, andsetboostwill also be disabled.
- If this does not solve your issue, the next step is to contact support.
Q. How do I see all the commands?
- The help command is man's best friend (not dogs).
Video
Not yet available
If you have or find a video on Gaius specifically for what is covered in this wiki page, you can send the info to Fairy 狐 紫#0001 via DM (You must be in the support server in order to make contact).
Points of Interest
Leveling Configuration
Leveling/Command Tuning
Leveling Commands (Staff)
Level Boosting
Leveling
The leveling module is the largest and most extensive module for Play with countless combinations. The very first step is to enable the leveling module by saying "module leveling".
Setup
Welcome to Gaius Play, here we'll be going over the setup of the leveling module so you can engage your community!
Initial Start
- Invite the bot (Official Site)
- Make sure Gaius Play has Manage Roles
- Make sure Gaius Play role is higher than the ones you want to be assigned via leveling
- Know your prefix! If you ever forget !checkprefix
-
Enable the leveling module by doing >module leveling
https://docs.google.com/spreadsheets/d/1pjp0JRkI1gDvFnmgnD9pU6YU9Ut2ZRdn2Pauq-R8vR0
Rewards
Setting up reward roles is optional for those of you who just want the points!
Adding rewards is interactive, as seen here, and only takes a few seconds to add each reward in a straightforward fashion.
You can even set up custom level-up messages for all your reward roles to give them a more personal feel!
Commands
Addreward
Add rewards to be given in the reward system. You can either add rewards through a single input or go through a setup that will ask for each property. You can provide 'none' or 'global' for the previous.
| Command | Description | Example |
|
>addreward rolename/@mention/ID |
Begins the process of adding the provided role as a reward role |
>addreward 12345678901234567 >addreward @Newbie |
| >addreward role level % previous % roles %% response | Adds the provided role as a reward role at Level 10 with a specified previous role and a given response. |
>addreward Rolename 10 % none %% Congrats you got the first role! |
Editreward
Edit a reward tied to the leveling system. Each part is edited individually by its property, and you may also set whether this role is a default reward.
| Command | Description | Example |
|
>editreward role level # |
Edits a reward's required level | >editreward @Role level 10 |
| >editreward role message new message | Edits a reward's achievement message | >editreward @Role message New Message Here |
| >editreward role default off/role | Edits a reward's default status when users choose more than one role in the tree leveling | >editreward @Role default @Role |
| >editreward role global | Edits a reward's global status |
>editreward @Role global (NOTE: When using this for a role with a previous role, all previous roles will be removed from the global role) |
| >editreward role previous roles%list | Edits a reward's previous role(s) |
>editreward @role previous @NewRole%@OtherRole |
Delreward
Delete a reward role from the system. No further modifications to your system will be done, and any gaps must be filled by your usage of the 'editreward' command.
| Command | Description | Example |
| >delreward role/id | Deletes a role from the rewards list | >delreward @Role |
Listrewards
List all the rewards for your reward system. If you have too many rewards, a page system will be generated to look through. You may also get specifics about a single reward by providing a role.
| Command | Description | Example |
| >listrewards [role] | Lists the server's reward list OR gets the specifics about a reward role |
>listrewards @Role >listrewards |
Examples
- >addreward Level1 - Respond with the required level to start the leveling system and answer the questions.
- >addreward Level2 - Respond with the required level and answer the questions.
- >addreward Level3 - Respond with the required level and answer the questions.
You can have up to 6 reward roles for free. Unlimited for Premium.
Now you have the basics! Essentially you're creating a chain of roles people will level through. Once they have enough XP for Level2, they'll gain that role and start earning towards the Level3 role and so on!
Leveling Settings
Now that you have your reward roles setup, it's time to configure how easy or difficult it is to level up on your server.
STANDARD SETTINGS
As seen here, you have a number of available options to make your level system truly customized for your community.
These are the standard settings available to all servers.
See here for the Premium server version.
Leveling Module Settings
| Command | Description | Example |
| >configure current | Displays current leveling configurations | >configure current |
| >configure showlevels [#StartingFrom] | Displays amount of XP needed for each level | >configure showlevels 20 |
| >configure explain property | Displays a help message for a specified property below | >configure explain equation |
| >configure equation 1, 2, 3, OR 4 | Sets the equation for leveling (Learn more below) | >configure equation 1 |
| >configure modifier # | After level 1, every levels cost will be multiplied by this number | >configure modifier 80 |
| >configure base # | Level 1 will cost a specified XP amount | >configure base 15 |
| >configure random | Toggles the action for one of the achieved reward roles to be randomly assigned if the user does not select one of the reward choices in the tree leveling | >configure random |
| >configure texttime # | Users will earn XP every # minutes for talking in Text Channels | >configure texttime 5 |
| >configure textamount # | Sets how much XP is gained based on activity in text channels | >configure textamount 1 |
| >configure voicetime # | Users will earn XP every # minutes for talking in Voice Channels | >configure voicetime 5 |
| >configure voiceamount # | Sets how much XP is gained based on activity in voice channels | >configure voiceamount 1 |
| >configure autoremove on/off | When users receive a new reward role, should they keep the previous role(s)? | >configure autoremove on |
| >configure vcrequirement # | Sets the number of required human users to be in a Voice Channel in order to gain XP | >configure vcrequirement 2 |
Level Up Messages
When utilizing the messages for the response setting and reward role messages you can use variables to make it more personal.
Setup
| Command | Description | Example |
| >configure channel #channel | Sets which channel level-up messages go | >configure channel #bot-channel |
| >configure message Message is typed next. | Sets a message to be sent when a user levels up | >configure message Congrats, %user. You've reached Level %level! |
Variables
| Variable | Description |
| >configure message %user has reached %level! |
Sets the default response for level-ups This can be customized per reward role when adding or editing a reward role. |
| %user | Username |
| %tag | User mention |
| %level | New level number |
| %guild | Guild name |
| %role | New reward role received |
Equations
These change how your settings work. We don't recommend changing this unless you feel you need to!
| Equation | Description |
| >configure equation 1 | A variable equation that uses the base and modifier amounts to change how fast the scaling happens per level |
| >configure equation 2 |
A basic bell curve equation that steadily gets harder and harder to achieve levels
|
| >configure equation 3 | A basic linear equation that adds the modifier to the previous level's value |
| >configure equation 4 | A single term plus constant quadratic equation that linearly increases in difficulty after each level Graph |
| >configure equation 5 | Equation 5 is a 2 term no constant quadratic equation that has the difference in levels linearly dependent on the modifier. |
| >configure equation 6 | Equation 6 is a conglomeration of equations that has a sharp increase in xp requirements which falls off to a constant 1500 in later levels |
FAQ
Q. Will kicking Play reset the bot?
- No, kicking/banning Gaius Play will never reset your settings or prefix.
Q. Why aren't my commands aren't working? Is the bot offline?
- This could be for a number of reasons. Here are a list of solutions (beginning with some of the most common solutions):
- Say
!checkprefixin your server. If Gaius has permission to speak in and see the channel, it will always respond with the current prefix.- If there is no response, try to @Gaius...this will pop up taggable users in a list, along as their online status icon on the lower-left of the user avatar. In the unlikely event that it is a gray icon, then Gaius is offline in your server and should be back online within a few minutes.
- If Gaius is online, make sure Gaius has permission to speak in the channel (Server Settings > Roles and/or Edit Channel > Permissions).
- If Gaius is not listed when you try to @gaius, then it likely does not have permission to see the channel, which is either because it does not have a role to see the channel(s), or it cannot see the channel in your channel settings.
- If Gaius responds with its current prefix, check your enabled modules with the
module listcommand. Most commands are tied with a module, which means if, for example, the leveling module is not enabled, thenlevel up,award, andsetboostwill also be disabled.
- If this does not solve your issue, the next step is to contact support.
Q. How do I see all the commands?
- The help command is man's best friend (not dogs).
Video
Not yet available
If you have or find a video on Gaius specifically for what is covered in this wiki page, you can send the info to Fairy 狐 紫#0001 via DM (You must be in the support server in order to make contact).
Points of Interest
Leveling Configuration
Leveling/Command Tuning
Leveling Commands (Staff)
Level Boosting
Gaius Play is the leveling bot offering many variables and factors in its immersive leveling system, such as customizable level/xp boosting, various equations, and unique options, to help engage your community's text and/or voice activity and enable users to show off their rank with flare.
The purpose of this documentation is to provide an in-depth, comprehensive informational guidance on every module, feature, and command for Gaius Play and provide detailed examples and explanations to foster greater understanding of everything Gaius.
Gaius Play is split into modules, in which a set of relevant commands are grouped into, and these docs will provide a rundown of each module and their associated commands in a top-down approach.
Leveling can be linear and straightforward or complex like a tree (Premium version required).
Setup - Premium
Welcome to Gaius Play, here we'll be going over the setup of the leveling module so you can engage your community!
Initial Start - Premium
- Invite the bot (Official Site)
- Make sure Gaius Play has Manage Roles
- Make sure Gaius Play role is higher than the ones you want to be assigned via leveling
- Know your prefix! If you ever forget !checkprefix
-
Enable the leveling module by doing >module leveling
https://docs.google.com/spreadsheets/d/1pjp0JRkI1gDvFnmgnD9pU6YU9Ut2ZRdn2Pauq-R8vR0
Rewards
Setting up reward roles is optional for those of you who just want the points!
Adding rewards is interactive, as seen here, and only takes a few seconds to add each reward in a straightforward fashion.
You can even set up custom level-up messages for all your reward roles to give them a more personal feel!
Commands
Addreward
Add rewards to be given in the reward system. You can either add rewards through a single input or go through a setup that will ask for each property. You can provide 'none' or 'global' for the previous.
| Command | Description | Example |
| >addreward rolename/@mention/ID | Begins the process of adding the provided role as a reward role | >addreward 12345678901234567>addreward @Newbie |
| >addreward role level % previous % roles %% response | Adds the provided role as a reward role at Level 10 with a specified previous role and a given response. | >addreward Rolename 10 % none %% Congrats you got the first role! |
Editreward
Edit a reward tied to the leveling system. Each part is edited individually by its property, and you may also set whether this role is a default reward.
| Command | Description | Example |
| >editreward role level # | Edits a reward's required level | >editreward @Role level 10 |
| >editreward role message new message | Edits a reward's achievement message | >editreward @Role message New Message Here |
| >editreward role default off/role | Edits a reward's default status when users choose more than one role in the tree leveling | >editreward @Role default @Role |
| >editreward role global | Edits a reward's global status | >editreward @Role global (NOTE: When using this for a role with a previous role, all previous roles will be removed from the global role) |
| >editreward role previous roles%list | Edits a reward's previous role(s) | >editreward @role previous @NewRole%@OtherRole |
Delreward
Delete a reward role from the system. No further modifications to your system will be done, and any gaps must be filled by your usage of the 'editreward' command.
| Command | Description | Example |
| >delreward role/id | Deletes a role from the rewards list | >delreward @Role |
Listrewards
List all the rewards for your reward system. If you have too many rewards, a page system will be generated to look through. You may also get specifics about a single reward by providing a role.
| Command | Description | Example |
| >listrewards [role] | Lists the server's reward list OR gets the specifics about a reward role | >listrewards @Role>listrewards |
Examples
- >addreward Level1 - Respond with the required level to start the leveling system and answer the questions.
- >addreward Level2 - Respond with the required level and answer the questions.
- >addreward Level3 - Respond with the required level and answer the questions.
You can have up to 6 reward roles for free. Unlimited for Premium.
Now you have the basics! Essentially you're creating a chain of roles people will level through. Once they have enough XP for Level2, they'll gain that role and start earning towards the Level3 role and so on!
Tree Leveling (Premium)
In order to create a branch, all you need to do is set the required level and role to be the same as another role(s).
You can create branches anywhere and even create MMORPG style systems.
Leveling Settings
Now that you have your reward roles setup, it's time to configure how easy or difficult it is to level up on your server.
ALL GUILDS WILL NOW BE USING >CONFIGURE INSTEAD OF >LEVELSET
STANDARD SETTINGS
As seen here, you have a number of available options to make your level system truly customized for your community.
These are the standard settings available to all servers.
See here for the Premium server version.
Leveling Module Settings
| Command | Description | Example |
| >configure current | Displays current leveling configurations | >configure current |
| >configure showlevels [#StartingFrom] | Displays amount of XP needed for each level | >configure showlevels 20 |
| >configure explain property | Displays a help message for a specified property below | >configure explain equation |
| >configure equation 1, 2, OR 3 | Sets the equation for leveling (Learn more below) | >configure equation 1 |
| >configure modifier # | After level 1, every levels cost will be multiplied by this number | >configure modifier 80 |
| >configure base # | Level 1 will cost a specified XP amount | >configure base 15 |
| >configure random | Toggles the action for one of the achieved reward roles to be randomly assigned if the user does not select one of the reward choices in the tree leveling | >configure random |
| >configure texttime # | Users will earn XP every # minutes for talking in Text Channels | >configure texttime 5 |
| >configure textamount # | Sets how much XP is gained based on activity in text channels | >configure textamount 1 |
| >configure voicetime # | Users will earn XP every # minutes for talking in Voice Channels | >configure voicetime 5 |
| >configure voiceamount # | Sets how much XP is gained based on activity in voice channels | >configure voiceamount 1 |
| >configure autoremove on/off | When users receive a new reward role, should they keep the previous role(s)? | >configure autoremove on |
| >configure vcrequirement # | Sets the number of required human users to be in a Voice Channel in order to gain XP | >configure vcrequirement 2 |
Level Up Messages
When utilizing the messages for the response setting and reward role messages you can use variables to make it more personal.
Setup
| Command | Description | Example |
| >configure channel #channel | Sets which channel level-up messages go | >configure channel #bot-channel |
| >configure message Message is typed next. | Sets a message to be sent when a user levels up | >configure message Congrats, %user. You've reached Level %level! |
Variables
| Variable | Description |
| >configure message %user has reached %level! |
Sets the default response for level-ups This can be customized per reward role when adding or editing a reward role. |
| %user | Username |
| %tag | User mention |
| %level | New level number |
| %guild | Guild name |
| %role | New reward role received |
Question Messages (Premium)
When utilizing the messages for the response setting and reward role messages you can use variables to make it more personal.
Setup
| Command | Description | Example |
| >configure questionmessage Question? | Sets a default level-up message (Learn more below) | >configure questionmessage Congratulations you have leveled up to level %level. You have 8 choices to rank up with. %choices Please reply with the role you wish to rank up with. |
|
>configure questionchannel #channel |
Sets which channel the question messages go when a user should decide to choose one of the currently available roles | >configure questionchannel #bot-channel |
Variables
| Variable | Description |
| %user | Username |
| %tag | User mention |
| %level | New level number |
| %guild | Guild name |
| %role | New reward role received |
| %count | Amount of reward role choices available at that level |
| %choices | Lists of choices the user can choose from |
Equations
These change how your settings work. We don't recommend changing this unless you feel you need to!
| Equation | Description |
| >configure equation 1 | A variable equation that uses the base and modifier amounts to change how fast the scaling happens per level |
| >configure equation 2 |
A basic bell curve equation that steadily gets harder and harder to achieve levels
|
| >configure equation 3 | A basic linear equation that adds the modifier to the previous level's value |
| >configure equation 4 | A single term plus constant quadratic equation that linearly increases in difficulty after each level Graph |
Importing Mee6 Data (Premium)
If you're transitioning from Mee6, you can use the >import command to import data from Mee6. This will also switch your equation to #2, which is the Mee6 leveling equation.
Tuning
Leveling Tuning
Ignore
Set a channel, member, or role to be ignored by the leveling system for xp gain. You can specify whether you wish to ignore text xp, voice xp, or all xp. If nothing is specified, then all xp will be ignored. You can use 'list' to get a list of current ignores.
| Command | Description | Example |
| >ignore [/text/all] role/channel/member | Ignores XP gain for text, VC, or both for a role, channel, or user | >ignore text @BillyBob#0000 >ignore vc @IgnoreRole >ignore all #bot-channel |
| >ignore list | Lists the current ignores in the server | >ignore list |
Recog
Remove an experience ignore from a member, channel, or role. You can also list all ignores with 'list'.
| Command | Description | Example |
| >recog role/channel/member | Unignores XP gain for a role, channel, or user | >recog @BillyBob#0000 >recog @IgnoreRole >recog #bot-channel |
Command Tuning
Restrict
Restrict usage of a command or module to a member, role, or channel, which overrides original command permissions.
| Command | Description | Example |
| >restrict command member/ID | Restricts usage to a user | >restrict level @User |
| >restrict command role/ID | Restricts usage to a role | >restrict level @Role |
| >restrict command channel/ID | Restricts usage to a channel | >restrict level #channel |
Allow
Allow usage of a command or module to member, role, channel, or entire server, which overrides original command permissions.
| Command | Description | Example |
| >allow command member/ID | Allows usage to a user | >allow level @User |
| >allow command role/ID | Allows usage to a role | >allow level @Role |
| >allow command channel/ID | Allows usage to a channel | >allow level #channel |
| >allow command guild | Allows usage to the entire server | >allow level guild |
Block
Block usage of a command or module to a member, role, or in a specific channel, overriding original command permissions.
| Command | Description | Example |
| >block command member/ID | Blocks usage from a user | >block level @User |
| >block command role/ID | Blocks usage from a role | >block level @Role |
| >block command channel/ID | Blocks usage from a channel | >block level #channel |
| >block command guild | Blocks usage from the entire server | >block level guild |
Free
Free a command of all, or specific, permission overrides. You can either leave the type blank, or provide a channel, role, member, or 'guild' to specify which overrides to remove.
| Command | Description | Example |
| >free command [type] | Frees all permissions tuning for the command | >free level |
| >free command User/ID | Frees permissions tuning of that type for the command | >free level @BillyBob#0000 |
| >free command role/ID | Frees permissions tuning of that type for the command | >free level @NotActuallyIgnoreRole |
| >free command channel/ID | Frees permissions tuning of that type for the command | >free level #not-actually-bot-channel |
| >free command guild | Frees permissions tuning for the command in the entire server | >free level guild |
Staff
A useful overview of what your staff can use.
Commands
Award
Gives or sets a member or role text/voice xp or amount of levels. You can set a members xp with 'set'.
| Command | Description | Example |
| >award member/role #xp [text/voice] | Awards a member or role a certain amount of text or voice xp | >award @MemeMan 10 text |
| >award member/role level #level [text/voice] | Awards a member or role a certain amount of levels | >award @TheChad level 5 voice |
| >award member/role set #xp [text/voice] | Sets a member or role to a certain text or voice xp | >award @CoolCats set 500 text |
| >award member/role set level #level [text/voice] | Sets a member or role to a certain level | >award @NPC set level 5 |
Reclaim
Removes a certain amount (or all) of a member's (text or voice) xp. Providing 'left' removes all xp from members no longer in the server.
| Command | Description | Example |
| >reclaim all/#xp amount [text/voice] member | Resets the users XP, optionally reward roles too | >reclaim all voice @SmolPanda |
| >reclaim left |
Removes level data for users not in the server anymore |
>reclaim left |
Testperm
Tests a specific member's permissions for a specified module or command.
| Command | Description | Example |
| >testperm command/module member | Tests a specified user's perms for a command or module | >testperm level @JohnDoe |
Testvc
Begins the debug process for a specific user for vc xp gain. Notifications will be sent in the channel the command was used in. Useful checking if a user is gaining xp or how much xp is being gained.
| Command | Description | Example |
| >testvc [member] | Begins the debug process for a specific user for vc xp gain. | >testperm @JingleJangle |
Level Up Note
For premium owners using the Tree Leveling, users can do >level up to redo their choices.
Public
A useful overview of what your community can use.
Notes for VC xp:
1) 2 or more users
2) Bots do not count
4) XP is only awarded for VC after disconnecting
5) The bot must be able to view/connect to the channel
Commands
Leaderboard
Checks the server's full leaderboard, the voice xp leaderboard, or the text xp leaderboard. You can also check where you or someone else is in the leaderboard.
| Command | Description | Example |
| >leaderboard [text/voice] | Displays the server leaderboard | >leaderboard |
| >leaderboard # | Displays the server leaderboard up to # | >leaderboard 35 |
| >leaderboard me | Displays the leaderboard around you | >leaderboard me |
| >leaderboard [text/voice] [member] | Displays the leaderboard around a specified member | >leaderboard voice @SadCat |
Level
Checks your or someone else's current level and amount of xp and upcoming rewards. You can also use level up if you are missing rewards.
| Command | Description | Example |
| >level | Displays your current profile | >level |
| >level @mention/UserID | Displays the user's profile | >level @BigChungus |
| >level up | Triggers the manual update of your reward role(s) and data | >level up |
Restart
Restarts your roles or xp in the server. Providing 'roles' removes all your reward roles, and providing 'xp' removes all your experience AND roles. Admins can also provide 'server' to restart the entire server's roles or xp and roles.
| Command | Description | Example |
| >restart xp/roles | Restarts one's own roles or roles AND xp | >restart xp |
| >restart server xp/roles | Restarts the entire server's roles or roles AND xp NOTE: This requires Play to recognize you as an admin |
>restart server roles |
Level Up Tips
If a user leaves and rejoins, this command will restore their roles so long as their level data is saved until you clear the system of users no longer in the server.
If you're using a Gaius+ authorized server utilizing Tree Leveling you can remove peoples reward roles, when they do >level up they will be able to redo their choices.
XP Boosting
A straightforward walkthrough for setting up customized XP boosting for your server's activity needs.
Commands
Setboost
Sets a boost for channels, members, roles, or the entire server. A start date MUST be specified. You can specify the duration, the expiration, or if the boost repeats.
The boost amount is added to the total XP (e.g. a boost amount of .8 will result in 1.8 xp).
| Command | Description | Example |
| >setboost channel amount cumulative/minimum flags | Sets a channel for XP boosting for an additional specified amount of XP with various customizable flags | >setboost #Channel 1 minimum %start 1m 1h 2w |
| >setboost role amount cumulative/minimum flags | Sets a channel for XP boosting for an additional specified amount of XP with various customizable flags | >setboost @Role .5 cumulative %start 12:00 pm tzEST 12/05 %expire 1w 2m 3h |
| >setboost member amount cumulative/minimum flags | Sets a channel for XP boosting for an additional specified amount of XP with various customizable flags | >setboost @Member 1.6 minimum %start 1w 2d 3h 4m %expire 15:00 %tzEST 7/09/2021 %repeats 1w |
| >setboost guild amount cumulative/minimum flags | Sets a channel for XP boosting for an additional specified amount of XP with various customizable flags | >setboost guild 2 cumulative %start 10:00 am tzEST 01/07/2021 %duration 3h |
Delboost
Deletes a registered boost. This REQUIRES a channel, role, or user mention/ID or 'guild' input.
| Command | Description | Example |
| >delboost channelName/ID >delboost RoleName/ID >delboost userName/ID |
Deletes the registered boost from the specified channel, role, or user |
>delboost #anime-night |
|
>delboost guild
|
Deletes the registered boost from the server |
>delboost guild
|
Flags
You use w/d/h/m format for all flags. For 'starts' and 'expires' you may use time and date in the format hh:mm tzTimezone dd/mm OR dd/mm/yyyy
| Flag | Description |
| %start | The date, time, or time until the boost starts |
| %expire | The date, time, or time until the boost expires |
| %duration | The period of time until the boost expires from start time |
| %repeats | The time until the boost repeats after expiring |
Listboosts
Lists current and future boosts. Provides all the details, such as start time, end time, duration, and repetition.
| Command | Description | Example |
| >listboosts | Lists current and future boosts | >listboosts |
Definitions
A reference to help with deciding how to customize XP boosts.
| Term | Definition |
| Cumulative | The boost amount "stacks" or adds itself by its own amount (e.g. 0.8 > 1.6 > 2.4 > 3.2 > ...) |
| Minimum | The absolute minimum amount that participants receive during boost durations |
| w/d/h/m format | week(s)/day(s)/hour(s)/minute(s) |
| hh:mm tzTimezone dd/mm | Specific time in a certain timezone on a specified day/month |
| dd/mm/yyyy | day/month/year |
Colors
REQUIRES: Manage Roles
Custom hexadecimal colors to help create a more vibrant community
Commands
| Command | Description | Example |
| >module colors | Enable/Disable the module | >module colors |
| >addcolor name ColorCode | Adds a hexadecimal color with a specified name to the list of available colors | >addcolor FreshSpring #aef747 |
| >ColorName | Adds the specified color to whom used the command | >FreshSpring |
| >delcolor | Deletes the specified color name from the list of available colors | >delcolor FreshSpring |
| >listcolors | Lists the available hexadecimal colors | >listcolors |
Games
An assortment of board games that are suitable for use in discord. This module is constantly in work as the games themselves are quite complicated.
(changeme)
Enable or disable the games module by sending:
>module games
Bullshit (3+ Players)
Play a game of bullshit with your friends. Please note that this is assuming you already know how to play bullshit, if you do not then please visit this link. https://gamerules.com/rules/bullshit-card-game/ This game supports multiple rules that can be configured via the 'game' command which has the full explanations of each rule.
When starting a game, the bot will ask each user pinged if they wish to play or not, if not enough users are left to play the start up will be aborted. Note, you must ping yourself if you wish to play, the bot does not auto include the person doing the command. This allows for locking of the command to staff.
Once the game starts, the bot will randomly choose a person to go first and the continue on.
An explanation on the various text based commands will be given in each channel the bot creates.
| Command | Description/Example |
| >bullshit *member* *member* [*member*] | >bullshit @Member @Member @Member |
| >game bullshit bullshitgame option | For Bullshit the following options are: 'current', 'category'. |
|
>forcequit *Bullshit* [*channel*] (Moderator only) |
Ends the running game. |
Checkers (2+ Players)
Checkers is the classic game of moving, jumping and kinging pieces. There are a few things you need to remember when playing checkers for discord.
1. Moves are made by letter number pairs, A1, b2, c3, etc. You can use capitals or lowercase. Invalid moves will get a notification from the bot. You may also move and select a piece at the same time. Select a piece with the first space pair and move with the second space pair, eg: a6 b5.
2. Nothing is perfect, I am sorry you do not have the best eyesight, but this is the best I can do, I also had an artist do the king pieces so they would be as noticable as possible.
3. The bot will automatically detect double jumps, but they are not enforced, simply deselect the piece with change or saying the spot it is current in.
4. Win condition will automatically be determined when your opponent no longer has any more pieces. There are also keyword commands to use as well:
• Change will deselect your current piece, saying the same space again will also deselect it, eg A5. A5.
• Forfeit will forfeit the game, leading to your loss and the end of the game.
• Recall will recall the board in case it is lost to chat, this command has a 60 second timer though, use it sparingly In order to start the game you must mention a player, be it yourself or another member.
| Command | Description | Example |
| >checkers leave | Leaves the current game | >checkers leave |
| >checkers member | Initiates a game, chosen members can approve or decline the invitation. | >checkers @Member |
|
>forcequit *checkers* [*channel*] (Moderator only) |
Ends the running game. | >forcequit checkers #mylittlepony |
Connect4 (2 players)
Classic connect 4 game. Ping another member to play, and click the reactions to drop pieces in. To leave a current game, use the 'leave' subcommand.
| Command | Description |
| >connect4 leave | Leaves the current game |
| >connect4 @member | Initiates a game, chosen members can approve or decline the invitation. |
|
>forcequit *connect4* [*channel*] (Moderator only) |
Ends the running game. |
Gofish (3+ Players)
Play a game of gofish with your friends. Please note that this is assuming you already know how to play gofish, if you do not then please visit this link. https://bicyclecards.com/how-to-play/go-fish/
This game supports multiple rules that can be configured via the 'game' command which has the full explanations of each rule.
When starting a game, the bot will ask each user pinged if they wish to play or not, if not enough users are left to play the start up will be aborted. Note, you must ping yourself if you wish to play, the bot does not auto include the person doing the command. This allows for locking of the command to staff.
Once the game starts, the bot will randomly choose a person to go first and the continue on.
An explanation on the various text based commands will be given in each channel the bot creates.
| Command | Description | Example |
| >gofish *member* *member* [*member*] | Initiates a game, chosen members can approve or decline the invitation. | >gofish @Member @Member @Member |
| >game gofish gofishgame option | Configure the game system, including the category where each game will be held, some extra game settings, and spectators. The following options are: 'explain', 'current', 'category', 'pairs' |
>game gofish category #GoFish >game gofish explain >game gofish current >game gofish category >game gofish pairs |
|
>forcequit *Gofish* [*channel*] (Moderator only) |
Ends the running game. |
Minesweeper (1 Player with back seat gamers)
Welcome to minesweeper, hopefully you don't get your leg blown off... I guess I should explain to your how to play yes? You can customize the board if you would like.
#X# will make a board with the dimensions you listed, note, you must include the x. You can then also add a number after this to denote how many mines to use as well.
As you will notice, the grid has been labelled for your ease of use, rows are letters, columns are numbers. In order to mark a space, simply indicate it by saying a letter and number pair, eg: A7. If your choice was valid, then you can go ahead and click the nice buttons I've set up underneath the board.
You win if you find all the bombs (no marking the entire board with flags) or reveal all non bomb spaces and you lose when you blow yourself up.
Good luck!
| Command | Description |
| >sweep | Begins a default game, the board can be customized by including >sweep #x# DIMENSION #MINES The "x" must be included |
| >recall | If lost, recalls game session to bottom of channel just don't spam this. |
| >sweep forcequit | Forces the game to end |
|
>forcequit *Minesweeper* [*channel*] (Moderator only) |
Ends the running game. |
Notes
| 1.↖ "Reveal" button - This is your 'reveal' button. Click it if you're sure there's no bomb in the space you indicated and I'll reveal it. |
| 2.🚩"Marker" button - Click it if you're sure there's a bomb here, just don't click the arrow by accident. |
| 3.❌"Cancel Selection" button - Contrary to popular belief this is not a quit button, this is your 'cancel' button. If you don't want to select whatever spot you had, forgot which you selected, or dont like where you placed a flag, click this. |
| 4.🏳️"Quit Game" button - This is your quit button, if you're a wuss and can't afford to lose a limb, click this |
| 5. At game start, type space location, then click the desired action button to continue. |
Uno (2+ Players)
Play a game of uno with your friends. Please note that this is assuming you already know how to play uno, if you do not then please visit this link. https://www.unorules.com/ This game supports multiple rules that can be configured via the 'game' command which has the full explanations of each rule. When starting a game, the bot will ask each user pinged if they wish to play or not, if not enough users are left to play the start up will be aborted. Note, you must ping yourself if you wish to play, the bot does not auto include the person doing the command. This allows for locking of the command to staff. Once the game starts, the bot will randomly choose a person to go first and the continue on. An explanation on the various text based commands will be given in each channel the bot creates.
| Command | Description | Example |
|
>uno member member [member]
|
Initiates a game, chosen members can approve or decline the invitation. | >uno @Member @Member @Member |
| >gamelb uno [me/member]
|
View the leaderboard, wins losses and total games, for the card games. | >gamelb uno me >gamelb uno @Member |
| >game uno unogame option | Configure the game system, including the category where each game will be held, some extra game settings, and spectators. For Uno the following options are: 'explain', 'current', 'category', 'drawstack', 'forcedplay', 'continualdraw', 'nolimitwilddraw4', 'shufflecards', 'spectator'. |
>game uno explain >game uno current >game uno category >game uno drawstack >game uno forcedplay >game uno continualdraw >game uno nolimitwilddraw4 >game uno shufflecards >game uno spectator |
|
>forcequit *uno* [*channel*] (Moderator only) |
Ends the running game. |
Animals
Commands
REQUIRES: Send Links
| Command | Description |
| >module animals | Enable/Disable the module |
| >bird | Get a random picture of a bird. Yes, that is it, do you require more? |
| >bunny | Get a random picture of a bunny, yes a white fluffy bunny! Well maybe not white, but good enough! |
| >cat | Get a random picture of a cat, no, I do not have real ones, pictures will have to suffice. |
| >dog | Get a random picture of a dog, you can look, but you can not touch, a cruel fate indeed. |
| >fox | Get a random picture of a fox, it's what you would get if you put a cat's brain in a dog's body, sneaky and shy, but still adorable. |
| >frieza | Get a random picture of Lord Frieza, yes, Lord frieza, do not ask how much we paid out in life insurance to get these. |
| >gecko | Get a random picture of a gecko. You can pick one of these absolute blessings of creation at your local petstore |
| >guts | Get a random picture of Guts, yes, the Black Swordsman, if ya think your life is screwed up, you aint seen nothing yet. |
| >holo | Get a random picture of Holo, the whimsical wolf goddess of the harvest. Do not feed wheat or blood. |
| >kangaroo | Kangaroos currently outnumber the aussies. Humans didn't conquer Australia, the Roos simply let us live there. |
| >koala | Koalas are adorable until you realize that that is the only thing really going for them. Kinda like pandas, except fun size. |
| >panda | Pandas will often forget about their own babies, and you complain about not being able to remember your parent's birthday, tsk tsk. |
| >raccoon | Trash pandas, more commonly known as raccoons, are simply just nature's garbage men, and we don't even pay them for their service. Ungrateful humans, you lot. |
| >redpanda | Get a random picture of a red panda, unlike actual pandas, they have a sense of self preservation. |
| >seaslug | Get a random picture of a seaslug, warning, this is not a menu, do not eat. |
| >snake | Get a random picture of a snake. In my opinion they should be called danger noodles, but I also do not want to have to read out >dangernoodle. |
Starboard
Let your community support their favorite content and also award users for their works!
REQUIRES: Manage Messages, Send Links
Setup
Configuration for the channel where the starred messages will be posted, what emoji will trigger the starboard, the threshold for a message to be moved to the starboard channel, and the reward for getting a 'starred' message.
| Command | Description | Example |
|
>starboard channel channel |
Channel where starboarded messages will be posted | >starboard channel #channel |
|
>starboard emoji emoji |
Emoji that triggers starboard | >starboard emoji 
|
| >starboard threshold number | Number of reacts needed to get into the starboard channel | >starboard threshold 3 |
| >starboard reward number/off | Awarded XP who gets their message into the starboard channel |
>starboard reward 100 |
Demo
Tools
A couple tools for facilitating games or solving simple disputes.
Commands
| Command | Description | Example |
| >coin [%s] [#coins] | Flips a number of coins either all at once or after a short period of time | >coin %s 5 |
| >dice [%s] [d#sides] [#dice] | Rolls Di(c)e at short intervals or all at once with a specified number of faces per die | >dice %s 5 >dice 2 d6 |
| >calc |
Basic calculator/temperature converter c2f, f2c, c2k, f2k, k2f, or k2c |
>calc 34.63 + 63 / 92 * 5.15 |
| >debug perms >debug cantaccess >debug canaccess >debug roles >debug manage |
Debug the bot, specifically the permissions the bot has and the channels/roles it can manage. |
|
| >get user >get [webp/png/jpg/gif/av] user |
Get information about a user. If the user is not in the server the information will be limited. Provide a valid format to get only the user's avatar. Use 'av' as the format for whatever default avatar the user has. |
>get @12312412412123 |
| >guildinfo |
Get generalized information about the current server, this includes bot specific information such as enabled modules and the current bot permissions. |
|
| >me >me [webp/png/jpg/gif] |
Get information about yourself as a member of the server. |
>me >me png |
| >ping |
It's a ping command, if you do it MAYBE I'll respond... maybe |
|
| >say message >say channel message |
With this command you can make all your friends jealous by pretending to be me, which of course you want to do, who wouldn't? That said, please don't make me say anything stupid. I would ask you not say anything you wouldn't say, but I know what you say, and I don't want to repeat it. |
>say I am a bot |
| >status >status # |
Get the status of the bot, including uptime of specific shards and total numbers across all the shards.
|
>status |
Other
Other commands not bound to a module (always on).
Commands
| Command | Description | Example |
| >claim | Claim your special little role in the support server to show that you have more money than the rest of the peasants. | |
| >guildinfo | Gets server info, including enabled modules and current bot permissions | >guildinfo |
| >help [command] | Help...? | >help |
| >inviteme | Gets the bot's invite link | >inviteme |
| >joke |
Displays a random joke.
WARNING: |
>joke |
| >ping | PONG!! | >ping |
| >status >status shard# |
Gets bot and specific shards' status and statistical numbers | >status >status shard2 |