f4stz4p/idlerpg

The place where the IdleRPG Discord Bot is developed at.

IdleRPG

This is the code for the IdleRPG Discord Bot.

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

The master branch is always the latest stable version. For development versions, check other branches please.

License

The IdleRPG Project is dual-licensed under the terms of the GNU Affero General Public License 3.0 ("AGPL") for non-commercial and the Travitia License for commercial use. A copy of the AGPL can be found in the LICENSE.md file. The Travitia license can be obtained by sending a formal request to business [at] travitia <dot> xyz with usecase, name and address. "Commercial use" includes any kind of revenue made with or based upon the software, even donations.

The AGPL allows you to:

• Modify the code
• Distribute it

It however does not allow you to:

• Sublicense
• Hold liable

You must:

• Include the copyright
• Include the License
• Disclose the source
• State changes

Summary and information taken from here.

Current goals

1. Prettify and fix v3.4 code

Todo in v3.4:

• Subclass context and .send to allow escaping mass-mentions by default
• Re-use the data from checks as ctx attributes
• Cleanup, remove unnecessary code, beautify
• Use custom converters instead of own handling every time
• Move battles to a backend function
• Rewrite everything

Can I selfhost?

Yes, as long as you provide the code for everyone.

How do I test my changes?

Note: This requires you to have Redis and Postgres working, and, depending on what you are doing, Lavalink.

git clone https://github.com/Gelbpunkt/IdleRPG
cd IdleRPG
(edit config.py.example to your database credentials)
./setup.sh
(do changes now)
systemctl start idlerpg

A systemd unit file has been bundled as idlerpg.service.

Contributing

IdleRPG uses black for code style. Please always run test.sh before submitting a pull request.

Make sure black is done and flake8 throws no issues, then you are ready to submit a PR.

Make sure you sign the CLA here, else we cannot merge your changes.