Repository navigation
Development
Philippe edited this page Nov 13, 2026
·
1 revision
git clone https://github.com/Two-Play/Crafty-Discord-bot.git
cd Crafty-Discord-bot
python -m venv venv
source venv/bin/activate
pip install -r requirements-dev.txtpython -m unittest # all tests
python -m unittest tests.test_servers_cog
coverage run -m unittest && coverage report
flake8 core tests # max line length 120
pylint coreCI runs the tests on every push. The code is clean under flake8 and pylint; please keep it that way.
All code lives in the core package:
| Module | Purpose |
|---|---|
main.py |
Entry point (python -m core) |
config.py |
Reads the environment variables into Settings
|
crafty.py |
Client for the Crafty REST API |
bot.py |
The Discord bot and its error handling |
cogs/ |
Server commands, admin commands and auto stop |
flags.py |
Feature flags |
log.py |
Logging setup and the in-memory log for the dashboard |
web/ |
The web dashboard |
CLAUDE.md in the repository describes the architecture in more detail.
- Fork the repository and create a branch from
develop. - Make your changes with tests, and run the tests and linters.
- Open a pull request against
develop.masteris the release branch.
Bugs and ideas go to the issue tracker.
Setup
Usage
Help