WIP discord bot using discord.py.
PCBOT is only supported by python version 3.8.0 and newer.
Before installing the bot, you must make sure you're running python 3.8.0+
$ python -V
Python 3.8.0
The next step is installing discord.py:
pip install discord.py
To get voice support, you can optionally install PyNaCl:
pip install -U PyNaCl
The bot also requires SQLAlchemy in order to function:
pip install -U SQLAlchemy
To install the bot, one can clone the repo:
git clone --recursive https://github.com/pckv/pcbot.git
This is the best way to install as the bot is actively in development.
If you want to update the bot using git, run git pull and either
restart the bot or reload the updated plugins.
Several plugins require additional modules. These modules are not required unless you want a specific plugin to work. Some features and modules are only supported if you're using Linux. The bot will prompt errors when modules are missing, although modules as of now are:
| Module | Notes |
|---|---|
| Pillow | pip install Pillow |
| pendulum | pip install pendulum, might also need pytz |
| cairosvg | pip install cairosvg, only supported for Linux |
| aiofiles | pip install aiofiles, support async file operations in config.py |
| orjson | pip install orjson, faster json library, useful if you have large config files e.g. summary data |
| ffmpeg | Not a python module; see doc in music.py |
| imageio | pip install imageio, support gif in image.py |
| pyrate_limiter | pip install pyrate_limiter, necessary for osu api functionality |
| nltk | pip install nltk, support bigrams in summary.py |
| rosu-pp | pip install rosu-pp-py, support pp calculation in pp.py, requires rust toolchain |
Running the bot is simple. Go to the root directory and run bot.py:
python bot.py
You should get a prompt asking for your bot token. One can also use the --token / -t argument, in for instance a bash script:
#!bin/sh
python bot.py -t TOKENFor more command-line arguments, execute python bot.py -h.
To change the bot prefix, head over to config/bot-meta.json.
The prefix can be any number of characters.
PCBOT has a dedicated info command, by default !pcbot, which
displays info such as the name, owner, uptime, servers and the bot
application description. To change the name of the command to suit
your bot name, change the "name" key in config/bot-meta.json. This
name should avoid any non-alphanumeric characters, although you are
free to include spaces in the name.
The info command will be named after this name, as lowercase and without any spaces.
After running the bot for the first time, you want to make sure you're assigned the owner account. This process is very straight-forward and requires that you have access to the bot log, and can respond to the bot within 60 seconds of reading the log (By default, the log is printed to the terminal).
The first step is to send the command !setowner in a private
message. The bot will wait for a response matching the 3-digit code
logged to the console. The logged message looks something like this:
CRITICAL [bot] 2016-04-24 23:03:49,138: Owner code for assignment: 263
After sending the code in a private message, in this case 263,
your account will be registered as the bot owner.
PCBOT has a folder based plugin system. If you wish to make a plugin,
check out pcbot/builtin.py. There are more features than showcased
in the builtin plugin, however there is no documentation for them yet.
To remove an unwanted plugin from the bot, simply remove it from
the plugins/ folder. You are also free to remove any accompanying
library folder. Keep in mind they will be re-added when updating
the bot using git.
The owner can manage plugins with the !plugin command. See
!help plugin for more information.
The MIT License (MIT)
Copyright (c) 2016 PC
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.