commands - TamaniWolf/ClanBot GitHub Wiki

Wiki ▸ Commands

Table of Content


Admin

Admin Help

adminhelp - A helping list of the available admin commands.

Ping

ping - Checks if the bot is online and responsive.

Info

info - Commands relating to info.
  ⤷ help    - Displays this help text.
  ⤷ bot     - Displays info's to this bot.
  ⤷ member  - Displays info's on You and other Members.
  ⤷ server  - Displays info's on This Server.
  ⤷ channel - Displays info's on this and other Channel.
  ⤷ message - Displays info's on this and other Message.

Here is something for data friends, the info command.

Bot: The Bot info's to it self too.
Member: You can check for info's about yourself or others.
Server: Check what info's the current server has.
Channel: Checks on info's about the current channel or other channels.
Message: Checks on info's about the message just send (the command) or other messages.


Patchnotes

patchnotes - Command relating to the patchnotes.
  ⤷ help - Displays this help text.
  ⤷ list - A list of Patchnotes.
  ⤷ get  - Getting the info of one patchnote.

Update

update - Command relating to the updates.
  ⤷ help  - Displays this help text.
  ⤷ info  - Info's on the update.
  ⤷ check - Check for new updates.
  ⤷ run   - run the new update.

A somewhat better way of getting new updates.


Clear

clear - Clear's an set amount of messages in a channel.
        Can also be set to only one Member.

Mute and Unmute

mute   - Mutes a Member so they can't write/speak in the server for some time.
unmute - Unmutes a Member so they can again write/speak in the server.

Edit Channels

channels - Commands relating to info.
  ⤷ help   - Displays this help text.
  ⤷ list   - A list of set Channels.
  ⤷ set    - Set's the Channel in one of Five Category's.
  ⤷ remove - Removes the Channel from it's Category's.

Channels... a hate-love in itself, but we need them not only to chat but also to let the bot know where to put what. There are Five Category's we can put channels in. Admin, Log, Birthday, Birthday Announcement, Reaction and User. Admin is for everything admin related like admin commands. Log is for the output of the server logs. Birthday is for the birthday commands and Birthday Announcement is for those announcements. Reaction is for reactions and reaction-roles.

Setting a Channel to one of this Category's is simply using /channels set and selecting the list you want the channel to be added to and lastly select the channel you want to set.
Removing is the same just with /channels remove.


Edit Config

config - Commands relating to config.
  ⤷ help           - Displays this help text.
  ⤷ command admin  - Set's the configs and commands for admins 'ON' or 'OFF'.
  ⤷ command member - Set's the configs and commands for members 'ON' or 'OFF'.
  ⤷ database       - Set's the database functions 'ON' or 'OFF'.
  ⤷ logs           - Set's the logging for bots and commands 'ON' or 'OFF'.
  ⤷ reaction       - Set's the word and emoji reactions 'ON' or 'OFF'.
  ⤷ twitch         - Set's the twitch handler and functions 'ON' or 'OFF'.

Those are the config settings for turning stuff on or off. You can decide what commands, settings and/or functions should be used or not.

command admin  - Channels, Config, Language, Reaction, Roles, Info, Patchnotes, Reload, Restart, Shutdown, 
                 Ban, Kick, Mute, Unmute, Adminhelp, Clear, Ping
command member - Convert, Birthday, Blush, Grouphug, Growl, Hug, Hydrate, Slap, Help
database       - CreateDatabase, Birthdays
logs           - BotAction, CommandAction
reaction       - Reactions, Words, Words_meep, Words_haha, Words_easteregg, Words_gay, Words_slap
twitch         - Twitch, Setup, Request, 

Edit Logs

logs - Commands relating to logs.
  ⤷ help    - Displays this help text.
  ⤷ channel - Set's Create, Delete, Update for channel 'ON' or 'OFF'.
  ⤷ emoji   - Set's Create, Delete, Update for emoji 'ON' or 'OFF'.
  ⤷ message - Set's Delete, Bulk Delete, Update for message 'ON' or 'OFF'.
  ⤷ roles   - Set's Create, Delete, Update for roles 'ON' or 'OFF'.
  ⤷ invite  - Set's Create, Delete for invite 'ON' or 'OFF'.
  ⤷ event   - Set's Create, Delete, Update, User Add, User Remove for event 'ON' or 'OFF'.
  ⤷ member  - Set's Add, Remove, Update for member 'ON' or 'OFF'.
  ⤷ Ban     - Set's Add, Remove for Ban 'ON' or 'OFF'.
  ⤷ guild   - Set's Add, Remove, Update for guild 'ON' or 'OFF'.
  ⤷ misc    - Set's Integrations Update, Command Permissions Update for misc 'ON' or 'OFF'.

Same as with the Config, but for the server logs. It is your decision what you want to be logged.


Edit Language

language - Commands relating to language.
  ⤷ help - Displays this help text.
  ⤷ list - A list of set Languages.
  ⤷ set  - Set's a supported language for text output.

Note: Language's are currently only partially supported.


Edit Logs

logs - Commands relating to logs.
  ⤷ help    - Displays this help text.
  ⤷ list    - A list of set Logs.
  ⤷ channel - Logs for channel actions.
  ⤷ emoji   - Logs for emoji actions.
  ⤷ message - Logs for message actions.
  ⤷ roles   - Logs for roles actions.
  ⤷ invite  - Logs for invite actions.
  ⤷ event   - Logs for event actions.
  ⤷ member  - Logs for member actions.
  ⤷ ban     - Logs for ban actions.
  ⤷ guild   - Logs for guild actions.
  ⤷ misc    - Logs for misc actions.

Edit Reaction

reaction - Commands relating to reaction.
  ⤷ help             - Displays this help text.
  ⤷ list             - A list of set Reactions.
  ⤷ set role         - Set's a Reaction Role.
  ⤷ set reactions    - Adds a Reaction to a Message.
  ⤷ edit             - Edits a Reaction Role.
  ⤷ remove role      - Removes a Reaction Role.
  ⤷ remove name      - Removes a Reaction or Reaction Role by Name.
  ⤷ remove reactions - Removes a Reaction.

Note: The reaction command and/or the reaction function itself may malfunction at times and is not recommended to be used as of right now.

Ah yes, reactions, if for assigning a role, a poll or for fun it is an useful tool.
To let the bot react to a message you will use 'reaction set reaction'. In the field 'channel' you select the channel you want the reaction to be in, in 'message' you put in the id of the message to react to, the field 'emoji' is for the emoji to be used as an reaction.

For the reaction role you will do the same as for the reaction but with 'reaction set role' and adding 'role', where you select the role to be assigned, and 'name', where you give the reaction role a name to make it easier to find it in some cases.

Removing reactions and reaction roles are just as easy as adding them. Removing by role is as simple as that 'reaction remove role' and select in 'role' the role, removing by name is the same but with 'reaction remove name' and 'name'.
Removing an reaction is is a bit different but not hard. it is identical to adding one, 'reaction remove reactions' select the channel in 'channel', put in the message id in 'message' and get the emoji of the reaction in 'emoji'.

The edit command is right now not functioning.


Edit Roles

roles - Commands relating to roles.
  ⤷ help   - Displays this help text.
  ⤷ list   - A list of set Roles.
  ⤷ set    - Set's the Roles as Admin, Member or NSFW Roles.
  ⤷ remove - Removes the Roles from Admin, Member or NSFW Roles.

This command is here to help the bot to understand who can do what. The lists are currently divided in 4 groups 'Admin', 'Member', 'NSFW' and 'Mute'. There are not only organizational differences to this 4 lists but also use. Admin can use admin commands, NSFW has in some commands differentiating texts in nsfw channels. Member and Mute are right now just there.

To set an Role as one of the three choices you use 'roles set'. In 'options' you can select from the 4 lists one you want to assign a role to. In 'role' you can select the role you want to add to the selected list. You can also edit the role with the set command.

Removing a role from a list works identical to adding a role to a list. Select the list in 'options' and select the role you want to remove.
If the Role got removed from the server you can also run an 'roles check' to the the ID and remove it by the id with 'roles remove id' and Select the list in 'options' and enter the id in the 'id' field.


Member

Help

help - A helping list of the available member commands and infos.

Birthday

birthday - Commands relating to birthdays.
  ⤷ help         - Displays this help text.
  ⤷ next         - Get a list of users who recently had or will have a birthday.
  ⤷ set date     - Set's or updates your birthday.
  ⤷ set announce - Set's whenever your birthday will be announced or not.
  ⤷ set timezone - Set's the timezone your want to use.
  ⤷ remove       - Removes your birthday information from this bot.
  ⤷ get          - Gets a user's birthday.

Setting the date of your own birthday to let others know when you have is strait forward. In date you will need to set the date in the format: The first three letters of the Month Jan a binding line - and the Day in numbers with an leading Zero 01, written out it will look like this Jan-01.
For timezone we use IANA/Olson timezone Database (Thank you Luxon :3 ) search for the timezone you want to use and copy-past it in to the field.

You can also decide if you want your birthday to be announced by setting it to 'Yes' or 'No' and also if you want to change your timezone.
Removing your birthday from the database is also an option. Admins can also remove birthdays from other members.

Using the command 'birthday get' will get you the birthday of the member you selected or your own if not.


Fun commands

blush    - Tell you or someone else was made Blush.
grouphug - Grouphug all.
growl    - Just Growl or at someone you mentioned.
hug      - Hug other users by mention them.
hydrate  - Tell everyone or just one mentioned to remember to hydrate.
slap     - Slap yourself or someone else mentioned.

Convert

convert - Commands relating to convert.
  ⤷ length      - Convert one length unit to another length unit.
  ⤷ temperature - Convert one temperature unit to another temperature unit.
  ⤷ area        - Convert one area unit to another area unit.
  ⤷ volume      - Convert one volume unit to another volume unit.
  ⤷ weight      - Convert one weight unit to another weight unit.
  ⤷ time        - Convert one time unit to another time unit.
  ⤷ number      - convert Short and Long Scale with another.

Working in an international environment on Discord is always fun but also faces to be difficult. Converting the units the other Country's are using is one of this difficulty's we will face. We can not know all converting formulas out of our heats to know what 10 Liter is in Gallons, 2.5 Mile in Kilometer or 46 °Fahrenheit in Celsius. There fore this command can help us.

The input of each unit follows the same scheme From Unit To Unit The Number to Convert with the difference being the choices of units to choose from. The maximum value(number) you can enter is 9007199254740991 and -9007199254740991. One-hundred-Ninety-Nine-Billion-Two-hundred-Fifty-Fore-Million-Seven-hundred-Forty-Thousand-Nine-hundred-Ninety-One You can convert from and in to the Metric System, the Imperial System (US) and Units that where labeled International.

A list of Units you can choose from:

Length      - Meter, Kilometer, Centimeter, Millimeter, Light Years, Inches, Feet, Yards, Miles,
              Nautical Miles
Temperature - Kelvin, Celsius, Fahrenheit, Rankine
Area        - Square Meter, Square Kilometer, Square Centimeter, Square Millimeter, Square Inches,
              Square Foots, Square Yards, Square Miles, Acres, Hectares
Volume      - Liter, Milliliter, Pints, Cups, Tablespoons, Teaspoons, Gallons, Barrels, Fluid Ounces,
              Cubic Meters, Cubic Kilometers, Cubic Centimeters, Cubic Millimeters, Cubic Inches,
              Cubic Foots, Cubic Yards, Cubic Miles
Weight      - Grams, Kilograms, Milligrams, Metric Tons, Imperial Tons, Pound/lbs, Kilo-pounds, Ounces,
              Quarters, Grains
Time        - Minutes, Hours, Seconds, Milliseconds, Days, Months, Weeks, Years, Decades, Century's
Number      - Long Scale, Short Scale
⚠️ **GitHub.com Fallback** ⚠️