Skip to content

Gelbpunkt/IdleRPG

Repository files navigation

IdleRPG

CI Dockerhub okapi teatro

This is the code for the IdleRPG Discord Bot.

You may submit an issue or open a pull request at any time.

License

The IdleRPG Project is licensed under the terms of the GNU Affero General Public License 3.0 ("AGPL"). It is a GPLv3 with extra clause for use over networks (see section 13).

AGPL for humans.

Running it

For development

Note: This requires you to have Podman and Git working. Development instances will wipe storage when stopped.

git clone https://git.travitia.xyz/Kenvyra/IdleRPG.git
cd IdleRPG
./scripts/beta.sh
podman build -t idlerpg:latest .
podman run --rm -it --name idlerpg --pod idlerpgbeta -v $(pwd)/config.py:/idlerpg/config.py:Z idlerpg:latest

For hosting permanently

This is fully unsupported and we only provide basic tools. The setup script might be outdated and is unmaintained.

git clone https://git.travitia.xyz/Kenvyra/IdleRPG.git
cd IdleRPG
./scripts/setup.sh
systemctl start "podman-*"

Utility

IdleRPG uses black, flake8 and isort for code style. Please always run ./scripts/format.sh before submitting a pull request and fix any problems.

./scripts/dumpdb.sh db_name will update the database scheme from the postgres container.