Skip to content

Home

Jump to bottom
Zach | xDest edited this page Mar 9, 2018 · 3 revisions

Welcome to the ComBot wiki!

How to setup ComBot

Getting the Launcher

First, navigate to Releases to find most recent version.

Setup Steps

  1. Open cmd, or Terminal on Mac, and run the command java -jar C:\path\to\ComBotLauncher.jar. This will generate the ComBot data folder.

  2. Navigate towards C:\Users\you\ComBot, or on Mac /Users/you/ComBot, or on linux ~/ComBot

  3. Inside the ComBot folder, enter the settings folder and open the token.txt file. Place your bot token inside this file and save.

  4. Like in step 1, run the command java -jar C:\path\to\...\ComBotLauncher.jar. This time, assuming your token is valid, ComBot should start up normally!

  5. Your Bot is now setup! There's more information about Permissions here. Permissions dictate who can do what with your bot. You will need to at least add your own id to the permissions.json file.

Usage help

ComBot's main feature is its plugins. Inside the ComBot folder, alongside settings, is a plugins folder. Any plugin you download or acquire that you wish to use has to be placed inside of the plugins folder. If you place new plugins or change / remove plugins while ComBot is running, you can run the restart command in a channel where the bot can read.

Again, if you need any extra assistance, you can join the Discord

Commands

ComBot has very few commands built in, but the ones that are felt necessary.

shutdown

  • Permission required: bot.shutdown
  • Description: Of course, it shuts down the bot.

restart

  • Permission required: bot.restart
  • Description: This restarts ComBot. It terminates ComBot and creates a new instance of it. If any changes were made to permissions / config / plugins, they will be present in this new version.

perm

  • Permission required: bot.perm
  • Usage: perm <user/role/everyone> [userId/roleName] <permission>
  • Description: As of writing, this command isn't yet implemented. The idea behind this command is to make it easier to change permissions for users/roles/everyone.

plugins

  • Permission required: bot.plugins.list
  • Usage: plugins
  • Description: As of writing, this command is implemented but not present in the current release. This command lists all of the current plugins running on ComBot.

addplugin

  • Permission required: bot.plugins.add
  • Usage: addplugin <required file attachment (.jar)>
  • Description: As of writing, this command is implemented but not present in the current release. This command uploads and, if necessary, overwrites, the plugin provided in the command message to the plugins of your bot.

plinfo

  • Permission required: bot.plugins.info
  • Usage: plinfo <plugin name>
  • Description: As of writing, this command is implemented but not Present in the current release. This command gets the info provided in the plugin.txt of a plugin. If not present, you will be notified of so.
Clone this wiki locally