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 |