-
Notifications
You must be signed in to change notification settings - Fork 0
Usage
A brief page on how to download and use the bot for your server.
Navigate to Releases and look for the latest release, then download the MDCBot.vx.x.x.jar file.
Since MDCBot is a Java based discord bot, you need to have Java downloaded. Make sure java is installed by typing java -version into your command line. Once Java is installed, you can simply type java -jar <path to bot> into your command line, or just double click the jar to launch it.
When running the bot for the first time, it will generate a MDCBot configuration folder in your home directory. Inside this folder you will need to place your Bot Token inside the token.txt. You won't need to do this unless you want to change bot users.
After setting the token, just relaunch the bot and it'll be in your server!
All of the bots features can be found with using --help or looking on the main page of this repository!
What are commands? Simply, commands are tasks that are run when a user gives a signal. To indicate a command, MDCBot uses the -- prefix before the command label, which is the command name. To see a full command list, you can type --commands.
Commands are composed of a label and optional or required arguments. A basic command looks something like this
--commandLabel [required-argument] <optional-argument>
Some commands involve sub commands, where the first argument is the sub command. In this case, an argument will almost always be required as the default command with no arguments will likely do nothing. An example of this is the timeout command. On it's own, timeout does nothing. It has two sub commands: @target and roll. It's structure is as follows.
--timeout [@user/roll]
This means the command timeout requires sub command (first argument) @user or roll. The actual finished command would look as follows:
--timeout @MyFriend#2241
or
--timeout roll
Commands with sub commands can become slightly complex, as some sub commands take arguments while others do not. The simple way to use these commands is to understand which sub command takes what arguments. If you look at the Commands page, you can see every command, sub command, and their arguments.
What are reactions? Reactions are essentially listeners. They listen for certain events and react upon them. Typically, they won't require much user interaction. They're based on user actions. A simple of example of this is the CoolReaction. It occurs when a user sends a message with :thecool: in the message at some point. The reaction causes the bot to add the ":thecool:" emoji reaction to the message. A more complex reaction is the DuelReaction. It reacts to duel events, such as DuelCreation and DuelAttack and uses this to either accept duel requests or participate in its own duel.
As a user, you don't really need to worry about how to use reactions. They just happen.