https://github.com/gelbpunkt/idlerpg

A fantasy RPG bot for Discord.
https://github.com/gelbpunkt/idlerpg

discord-bot discord-py rpg text-adventure

Last synced: 18 days ago
JSON representation

A fantasy RPG bot for Discord.

• Host: GitHub
• URL: https://github.com/gelbpunkt/idlerpg
• Owner: Gelbpunkt
• License: agpl-3.0
• Created: 2019-01-22T14:48:16.000Z (about 6 years ago)
• Default Branch: current
• Last Pushed: 2024-06-20T10:00:18.000Z (7 months ago)
• Last Synced: 2024-06-21T00:21:10.985Z (7 months ago)
• Topics: discord-bot, discord-py, rpg, text-adventure
• Language: Python
• Homepage: https://idlerpg.xyz
• Size: 216 MB
• Stars: 180
• Watchers: 14
• Forks: 70
• Open Issues: 45
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# IdleRPG

[![CI](https://git.travitia.xyz/Kenvyra/IdleRPG/badges/current/pipeline.svg)](https://git.travitia.xyz/Kenvyra/IdleRPG)

[![Dockerhub](https://img.shields.io/badge/Pull%20IdleRPG-from%20Dockerhub-orange)](https://hub.docker.com/r/gelbpunkt/idlerpg)

[![okapi](https://img.shields.io/badge/Pull%20okapi-from%20Dockerhub-black)](https://hub.docker.com/r/gelbpunkt/okapi)

[![teatro](https://img.shields.io/badge/Pull%20teatro-from%20Dockerhub-green)](https://hub.docker.com/r/gelbpunkt/teatro)

This is the code for the IdleRPG Discord Bot.

You may [submit an issue](https://git.travitia.xyz/Kenvyra/IdleRPG/issues) or [open a pull request](https://git.travitia.xyz/Kenvyra/IdleRPG/merge_requests) at any time.

## License

The IdleRPG Project is licensed under the terms of the [GNU Affero General Public License 3.0](https://git.travitia.xyz/Kenvyra/IdleRPG/blob/current/LICENSE) ("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.

```sh

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.

```sh

git clone https://git.travitia.xyz/Kenvyra/IdleRPG.git

cd IdleRPG

./scripts/setup.sh

systemctl start "podman-*"

```

## Utility

IdleRPG uses [black](https://github.com/ambv/black), [flake8](https://github.com/PyCQA/flake8) and [isort](https://github.com/timothycrosley/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.