Charfred is a modular, run-it-yourself bot for Discord, with a mixed bag of capabilities, including extensions and a cli-tool for Minecraft server administration.

This repository only contains the base bot and administrative extensions, but there are a lot more available in a seperate repository here.

To use Charfred you will have to install and run the bot yourself;

Additionally the Minecraft related extensions will not function if Charfred is not hosted on the same machine as your Minecraft server(s).

Python 3.6 or higher required

Clone this repository:

git clone https://github.com/Kellador/Charfred_Bot.git

Install with pip:

pip install -e </path/to/cloned/repo>

This will install charfred as a command usable from your current python environment.

On first startup you will have to give Charfred a bot token via cli argument:

charfred --token <yourbottokenhere>

this will initialize the bot config file and save the bot token for later, so afterwards you only need to run charfred to start him up.

The rest of this readme is a work in progress, so just enjoy this cat gif for now:

found on imgur, credit to sheepfilms