Oh hey, look who is here! Welcome to the Axiol bot documentation.
The first recommended command after you have invited the bot to your guilds is .plugins. Go ahead I'm waiting.......done? Great!
Now you will see all the plugins which Axiol provides, here you can manage them by reacting to their respective emojis in the embed.
To change the prefix use the command .prefix. In case after changing the prefix you forget what it was, then just ping (mention) Axiol and ask it the prefix just you like you would to anyone else! For example:
Oh hey @Axiol, what's your prefix?
@Axiol prefix?
@Axiol What was your prefix again?
I forgot the prefix @Axiol, can you help me?
The prefix used in all examples will be the default one therefore a dot ., use your own prefix for the commands if you changed it.
For every role, user, member and text channel either their mention or ID can be used, for example:
This...
.avatar @Bolt#8905.alertchannel #π§ͺο½testing.addmodrole @Moderator
and this...
.avatar 791950104680071188.alertchannel 843516136540864512.addmodrole 843563902078812171
are same.
Also note that User and Member are different, whenever there is Member in a command that means only people which are in the server can be used, while User is global therefore a person does not need to be in the guild for you to use any command which requires a User.
Looks great so far? Let's move on! Here are some quick links to the plugins
- π‘οΈ AutoMod
- π€ ChatBot
- π― Fun
- π Karma
- π Leveling
- π¨ Moderation
- β¨ ReactionRoles
- β Verification
- π Welcome
- β‘οΈ Extras This is not a plugin
Command permissions fall under the settings category therefore can be accessed using the command .help settings.
Using command permissions you can set a role to have the permission to use any command which Axiol provides, for example setting the role "X" for the command "Y" will only let members having the "X" role use command "Y". Here are the commands for this:
setperm <plugin_name>: Using this command will send an embed with all commands from the plugin defined, the next message which you will send will be used to set command permission, the format iscommand_name role; here the command name is used without the prefix otherwise it will trigger the actual command, then seperated by a space you need to enter your role; whether it be the mention or ID, doing so will create the command permission where users having that role can only use that command, to cancel this proccess simply typecancel, sending the message in the wrong format will result in bot sending a warning message, this won't cancel the entire proccess so you can always try again without having to start over, this only stops if you entercancel.removeperm <command> <role>: This simply removes a command permission of the role from a command.allperms: This shows all plugin names inside which the command names which have command permission setted up followed by the roles which an use that command.
Another note that make sure to read the error messagaes, descriptions and help embeds properly, majority of the problems reported are due to users not reading things properly and getting stuck on basic things.
Understood? Hope so you did, let's go to the plugins part now!
Help command: .help automod
By default the plugin is disabled.
Shows all auto moderation filters, the enabled/disabled emoji before their names shows their status whether they are enabled or disabled
To configure each filter, use the command .filter <filter_name>. There are four filters: badwords, links, invites, mentions
To change the response of each filter react to the gear emoji. To toggle between enable/disable, react to the other emoji which would be either the disable emoji if currently that filter is enabled and would be enable emoji if currently that filter is disabled.
All filter configuration commands are only visible in that filter's embed only if the filter is enabled.
BadWords and Mentions filters have some extra configurations available, let's have a look into that:
* BadWords:
.addbadword <your_word> - To add any badword in the list which bot would delete
.removebadword <you_word> - To remove any badword, make sure that the word is already in the bad word list or else it won't work
.allbadwords - To view all bad words, this will show all words
* Mentions
.mentionamount - To add a custom amount of mentions which the bot would delete for mass mentions, remember that only unique mentions are deleted!
This command blacklists a channel from auto moderation, members are immune to all filters in that channel.
By default, all channels are whitelisted hence protected with auto moderation but if any channel has been blacklisted using the previous command then they can be whitelisted again using this command.
This commands adds a role in the moderator role list therefore members having any of the roles which are in the list are immune to all auto moderation actions by the bot.
Any role which has been added as a moderator role earlier can be removed from the list using this command, members having this role would no longer be immune to auto moderation.
Use this command to see all moderator roles which you have added to the list, moderator is the just a common usage and example but you can add any roles :D
Use the command to toggle betwen ignorebots mode, this mode decides whether other bots will be affected by auto moderation by Axiol or not, using the command returns an embed which tells the current status of ignorebots mode, to switch just react to the emoji which Axiol will add itself, it would be either the enable emoji or disable depending on the current status.
Help command: .help chatbot
By default this plugin is enabled, therefore Axiol will reply to all pings and disabling this plugin would make Axiol not reply to any messages or pings.
This commands sets a channel to a chatbot channel therefore all messages in that channel will be replied by Axiol and members would not need require to ping!
This commands removes a channel from chatbot channel list if it is there, therefore Axiol would no longer reply to all messages there.
This commands shows all channels which are chatbot channels, the channels shown in the embed are where the bot replies to all messages by everyone.
If the chatbot does anything wrong, behaves weirdly or does not work then a quick report to the support server can be sent with just this command without needing to join the server and reporting manually, the description has no limit so it can be as long as you want.
Help command: .help fun
By default this plugin is enabled.
Makes you join a typing race queue quickly! The queue in which you are joined is the one with highest number of players out of all other queues to start the match quickly, in case there are not active queues then Axiol will inform you with that.
This creates a new type racing match! In case there aren't any publically avaialable queues then you can create your own, the player amount is the total number of players required to start the match; not minimum or maximum.
Using this command you can join any typing race queue, every match (or queue) has a unique code using which anyone can join, the code is case sensitive.
To leave the queue you are currently in, you can use this command. You don't need to define the match using code or name since one user can join only one queue at a time. There is no confirmation for leaving.
Test your typing speed! There are two types of test right now: time and word
- Time based typing test is where you need to type as much as you can under the time you specify, note that your goal is not to complete the entire text given!
- Word based typing test is the opposite of time based one, here you need to complete the entire text under 60 seconds, this test is quicker and starts right after you enter the command and has much smaller text.
2 seconds are subtracted from total time taken to cover up time taken for image to load and user to start typing.
Use this command to create an embed! These embeds are not useful right now which means you would need to create new embed everytime, if you wish to not set anything which Axiol asks then just type skip. As you keep going on, the original embed becomes the preview therefore edits itself to the embed you are creating after each step. This will be the proccess:
- You would need to set the colour, either you can react to one of the colour circle emojis or react to the paint brush emoji to set a custom hex, when you are done press the continue emoji at the last (not compulsary, can be skipped with the default color)
- Axiol will ask for title (compulsary, title is required)
- Axiol will ask for descrption (not compulsary, can be skipped by typing 'skip')
- Axiol will ask for thumbnail, a file or link can be used; only static images (pngs, jpgs etc) supported (not compulsary, can be skipped)
- The embed is ready to be sent! However you are free to add fields, footer, image and author by reacting to the respective emojis in the new embed sent, at this point you will see a tick emoji in your original embed (which became the preview) just click on the tick emoji to send it to the channel which you defined at the beginning when using the command!
Shows the avatar or profile picture as many say of the user! Notice that it's user not member which means avatar of anyone from discord whether they are in server or not can be viewed.
Help command: .help karma
By default this plugin is disabled, very similar to leveling the only difference being members earn points for being nice!
Shows the karma of the user! If the user is not defined then the karma of the person who used the command is shown, depending on the user's karma average, a small description about the performence is also there!
Shows the karma board! This also shows the average guild karma and has a format very similar to leveling leaderboard, the person who used the command can move to different pages using the arrow reactions in the embed:
* βοΈ for first page
* β¬
οΈ for previous page
* β‘οΈ for next page
* βΆοΈ for last page
This blacklists a channel with karma therefore any member messaging anything in that channel won't gain any karma, by default no channels are blacklisted.
By default all channels are blacklisted therefore giving members karma based on their messages, if any channel has been blacklisted using the previous command then they can be whitelisted again using this command.
Help command: .help leveling
By default the plugin is disabled.
Shows server rank of a user by returning an embed with all information and box emojis for progress bar x) Use the command without user field to check your own rank, note that this is user therefore xp of members who have left the server is also available.
Returns an embed with the entire server leaderboard and a clean pagination, to move between pages the system is exactly the same as karma board with one extra option in center:
* βοΈ for first page
* β¬
οΈ for previous page
* π for top 10 users bargraph image
* β‘οΈ for next page
* βΆοΈ for last page
The bargraph emoji is a bit different than shown here, it was not possible to show custom discord emoji here.
Sends a bargraph image of top users in the leaderboard, the amount field left blank returns top 10 users however the amount can be defined upto 30, more than that was slow and harder to fit in >.<
Same as bargraph just shows piechart instead
Adds more XP to a user, the maximum amount which can be given to someone is 10000000, giving someone XP using this command does not send the levelup alert message.
Removes xp from a user, the maximum amount is same as .givexp command therefore 10000000, removing more XP than what user current has puts them in debt therefore negative XP.
Shows all the level related information which includes highest xp member, xp range, xp blacklisted channels, alert status, alert channel and rewards by if there are any.
This sends an embed which has all leveling related configurations which admins can change, let's have a look at them one by one:
.xprange <min_value> <max_value>: This sets the xp range between which members will be given random xp, setting up the same xp in both min value and max value will make the xp static therefore giving everyone same xp everytime..blacklist <channel>: This blacklists a channel from XP hence members won't gain any XP in the channel which are in the blacklisted list, by default no channels are blacklisted..whitelist <channel>: By default all channels are whitelist hence give members XP, any channel which has been blacklisted using the command just before this can be whitelisted again with this..togglealerts: This is a quick way to turn on/off alerts, if level up alerts are turned on then they are disabled and if they are disabled then are enabled right after entering the command, no confirmation or reaction required..reward <level> <role>: Add a role reward for a level! The level field should only be the level itself therefore a number, whenever members reach the level setted up they are automatically given the role.removereward <level>: Removes any role reward from a level if it has been setted up earlier using the command just before this.
Help command: .help moderation
By default the plugin is enabled, reasons in ban, kick are optional and required in warn.
Permanantly bans a user from guild, user ID can be used too therefore users which are not in the server can also be banned, bans using this command are permanant and can only be reversed manually or by using the next command.
Unbans a previously banned user from the guild.
Kicks a member out of the server, which means they can join again.
This creates a 'Muted' role on first time usage and 'send messages' permission is disabled from all channels then the member is assigned the role therefore disabling their ability to send messages hence 'Muting', if there is a 'Muted' role already then it is used without creating any new one.
Removes the 'Muted' role from member therefore lets them send messages again.
Warns a member, the reason is required. Right now warnings does not have any special punishments
Removes a warning from a member, the position is the number in which the warn is placed in the list, after removing a warn the warns below it are moved one position upwards to take the place of the warn removed.
Shows all warns of the member with their reasons and position.
Deletes the number of messages defined in the amount field from the channel where the command is used, amount can only be a number.
Changes nickname of the member to the new nick defined in the command.
Adds a role to the member.
Removes a role from the member.
This gets confusing a bit but hey I got you covered! The role1 is the role of which the members are given role2, this means every member in the server who has role1 gets role2, this may take some time depending on the number of members, after entering the command a confirmation embed is sent, reacting to the tick emoji will update everyone silently, and reacting to the enable emoji will update members with live stats which will send a message after the member gets updated with the role and cross emoji will cancel it.
This works exactly same as the previous command (.massrole) the only difference being role2 is removed from people with role1.
Help command: .help reactionroles
By default the plugin is enabled.
This creates a reaction role, which means after using the command, the message having the id in the channel defined in the command gets a react which is the emoji defined in the command and whenever someone reacts to the emoji they are given the role defined
This removes a reaction role, since a message can only have one unique emoji simply using the messageid and emoji removes the reaction role
Shows all reaction roles setted up in the server with pagination similar to leaderboard
This marks a message with unique reaction role therefore a member can only react once and take on emoji from all reaction role defined in a single message.
This unmarks a message with unique reaction role hence letting users reaction resulting in letting them choose as many self roles as they want.
Help command: .help verification
By default this plugin is disabled. There are two types of verification named 'Command verification' and 'Bot verification'. On first time enabling it, Axiol will ask for the channel to create it the verification channel, after sending the channel name it will create a 'Not Verified' and set up proper permissions, in case some role named 'Not Verified' is found then Axiol will ask whether you want it to use the existing role, create new one while leaving the previous one or create a completely new fresh one and removing the previous one.
This shows the verification information of the server which includes the verification channel, the verified role, the role which is given after a member is verified and a description of the type of verification the guild has.
Since there are only two types of verification avaiable, using this command will switch the verification type quickly without any confirmation.
This adds a role which will be given to the members after they verify successfully, this is not required for members to be able to get verfied and view all channels again. At one time only one verified role can be added which means using this command again after setting up a verifyrole will replace the previous role with the new one.
This removes the verifed role, the role is not needed to define since only one verified role can be setted up. Note: Verification is prone to most issues due to permissions, usage of this command is heavily recommended if that happens, in case you still face any issues then feel free to join the support server or DM me (Bolt#8905)
Help command: .help welcome
By default this plugin is disabled. On first time enabling it, Axiol will ask for the channel where it will welcome members.
Shows the current guild welcome card, it's not an embed since there is also a message outside the embed so together they form the embed 'card'.
Changes the welcome channel where members will be greeted.
After using this command Axiol will ask for the welcome message, the next message in the same channel by the member who used the command will be setted as the new welcome message. Note that this is the message which is outside the actual embed and this is where the member is pinged, don't confuse it with the greeting!
Similarly to the previous command, Axiol will ask for the welcome greeting. Greeting is the embed description.
After using the command the next file or link which you will send will become the embed image, gifs won't work!
This will create a autorole which will be given to the members when they join, only works with welcome!
This resets the welcome card to the default one
These are the default welcome messages which are picked randomly and used:
{member} We hope you brought some milk π₯
{member} Hopped into the server!
{member} Glad to have you here today!
We hope you brought some sweets π© {member}
Have a pizza slice π {member}
{member} Woooohooo! We are excited to have you here <a:hyper_cat:809781548210978828>
{member} just joined, hide your cookies!πͺ
Swooooooosh! {member} just landed β
{member} joined the party <a:party_parrot:810545477668962315>
Roses are red, violets are blue, {member} hopped into the server, are they a kangaroo π¦?
Help commands: .help extras
This is not a plugin but some extra commands which are also useful.
Shows the server stats! If the Verification is enabled then number of members which are not verified is also shown.
Shows bot information including number of server it's in, total number of members, creater, creation date and ping.
Using this command a direct suggestion to the Support Server suggestion channel will be sent, there is no limit for the size of the idea.
Sends the invite link of Axiol.
Sends the GitHub link of Axiol's source code.