fd845ecb40
FORK MAINTAINERS: I'm so, so sorry, but this was planned since forever. If you need help integrating this, feel free to contact me.
53 lines
2.4 KiB
Markdown
Executable file
53 lines
2.4 KiB
Markdown
Executable file
# Robocop-ng
|
|
|
|
Next-gen rewrite of Kurisu/Robocop bot used on ReSwitched bot with discord.py rewrite, designed to be relatively clean, consistent and un-bloated.
|
|
|
|
Code is based on https://gitlab.com/a/dpybotbase and https://github.com/916253/Kurisu-Reswitched.
|
|
|
|
|
|
---
|
|
|
|
## How to run
|
|
|
|
- Copy `config.py.template` to `config.py`, configure all necessary parts to your server.
|
|
- (obviously) Add the bot to your guild. Many resources about this online.
|
|
- If you haven't already done this already, **move the bot's role above the roles it'll need to manage, or else it won't function properly**, this is especially important for verification as it doesn't work otherwise.
|
|
- Install python3.6+.
|
|
- Install python dependencies (`pip3 install -Ur requirements.txt`, you might need to put `sudo -H` before that)
|
|
- If you're moving from Kurisu or Robocop: Follow `Tips for people moving from Kurisu/Robocop` below.
|
|
- Run `Robocop.py` (`python3 Robocop.py`)
|
|
|
|
To keep the bot running, you might want to use pm2 or a systemd service.
|
|
|
|
---
|
|
|
|
## Tips for people moving from Kurisu/Robocop
|
|
|
|
If you're moving from Kurisu/Robocop, and want to preserve your data, you'll want to do the following steps:
|
|
|
|
- Copy your `data` folder over.
|
|
- Rename your `data/warnsv2.json` file to `data/userlog.json`.
|
|
- Edit `data/restrictions.json` and replace role names (`"Muted"` etc) with role IDs (`526500080879140874` etc). Make sure to have it as int, not as str (don't wrap role id with `"` or `'`).
|
|
|
|
---
|
|
|
|
## Contributing
|
|
|
|
Contributions are welcome. If you're unsure if your PR would be merged or not, either open an issue, ask on ReSwitched off-topic pinging ave or DM ave.
|
|
|
|
You're expected to use [black](https://github.com/psf/black) for code formatting before sending a PR. Simply install it with pip (`pip3 install black`), and run it with `black .`.
|
|
|
|
---
|
|
|
|
## Credits
|
|
|
|
Robocop-NG was initially developed by @aveao and @tumGER. It is currently maintained by @aveao. Similarly, the official robocop-ng on reswitched discord guild is hosted by @aveao too.
|
|
|
|
I (ave) would like to thank the following, in no particular order:
|
|
|
|
- ReSwitched community, for being amazing
|
|
- ihaveamac/ihaveahax and f916253 for the original kurisu/robocop
|
|
- misson20000 for adding in reaction removal feature and putting up with my many BS requests on PR reviews
|
|
- Everyone who contributed to robocop-ng in any way (reporting a bug, sending a PR, forking and hosting their own at their own guild, etc).
|
|
|