ScheduleBot | Dota Edition

A Discord bot that makes scheduling easy

Note: you're currently viewing the Dota version. This version supports Dota 2 inhouses and its configuration is a bit trickier because you need a Steam Bot. If you're looking for the standard version, go here.

ScheduleBot is a bot that manages events, such as a practice game with your team, or a league inhouse, or a tournament match.

Features

• Dota inhouses: the Dota version makes it easy to create inhouses, as you can link an event to an inhouse. A Dota bot will automatically create a lobby and invite every player who have confirmed their attendance.
• Time zone handling: ScheduleBot manages timezons for you. If there are European and American people on your team, if an European creates an event, Americans will be able to convert it to their timezone with the convert command.
• Confirm and reject handling: ScheduleBot allows users to confirm or deny their attendance to an event, so you can see who and how many people are you gonna play with. ScheduleBot can also limit how many people can attend an event.
• Admin commands: ScheduleBot allows elevated privilege commands with schedulebot-admin. Admins can perform actions such as removing events, or blacklisting an user to prevent them to use the bot.
• Linking an event to a role: ScheduleBot allows events to be linked to a role, so that members of that role can be notified when they are required to confirm or deny attendance to an event.

Local installation

To run ScheduleBot Dota Edition locally, you will need:

• NodeJS 6 or above.
• PostgreSQL.
  • You'll need to create an empty database for ScheduleBot.
• git, so you can easily clone this repo (optional).
• A second Steam account for your bot.

Start by cloning this repo, and then install the dependencies:

$ git clone https://github.com/MeLlamoPablo/schedulebot.git
$ cd schedulebot
$ npm install

And edit the bot's settings in config.js. You can edit or leave whatever you want, but you should at least edit:

• master_channel with the Discord channel where your bot will operate.
  • If you don't know how to get it, go to Discord's settings, then Appearance, then check Developer Mode. After that, right click on your channel, and click Copy ID.
• default_timezone with the time zone which will be used by the bot.
• db with yout postgres database settings.
• steam.profile_url with your Steam bot's profile URL.

Now, make sure that your postgres server is running, and run the database setup script:

$ npm run setup

The script will take your database settings from config.js, so you can just go ahead and press enter. When asked if you want to connect over SSL, unless you have configured your postgres server to use it, you should say no. Then follow the script's instructions to finish the setup.

After that, you need to configure your Steam credentials:

$ npm run setup-steam

Follow the script's instructions and you're good to go. You can run then your bot with:

$ npm run bot

Usage guide

After installing your bot, you might want to check out the usage guide.

Updating

Updating your bot is easy. First, you need to know which version you have installed. To do so, go to Discord and run the command:

@ScheduleBot --help

Note: replace @ScheduleBot with your app's prefix. Take note of the current version.

After that, stop your bot. Then, replace your current files with the latest version files. If you used git to clone the repository, this is easy:

$ git pull --all

If you forked this repo to deploy to Heroku, this will not work, because it's pulling from your repo, and not from this one. To solve that, first configure this repo (MeLlamoPablo/schedulebot) as a remote for your fork (YOUR_GITHUB_USERNAME/schedulebot). Then, fetch this repo (change master to dota or heroku-dota, depending on what branch you're working with).

After that, perform another npm install to make sure that you get any new dependencies or update existing ones:

$ npm install

However, after all of this your bot is not ready yet. A database update is also required:

$ npm run update

When prompted to select the current version, select the version you took note of. When prompted to select the target version, you generally want to select the latest. After that, enter your database credentials, and your database will also be updated to the selected version.

You're now ready to run your bot again.

Deploying to Heroku

If you wanted to host ScheduleBot locally, you'd need to have your computer on 24/7 to have your bot always online. To avoid that, we could use a PaaS provider, such as Heroku. Heroku's free plan is good enough for hosting our bot. To learn how to deploy the bot to heroku, go here.

Changelog

The change log can be found at the releases section.

License

Apache-2.0 © Pablo Rodríguez