8415e1f787
progress! |
||
---|---|---|
robocop_ng | ||
.dockerignore | ||
.gitignore | ||
Dockerfile | ||
LICENSE | ||
poetry.lock | ||
pyproject.toml | ||
README.md | ||
requirements.txt | ||
SECURITY.md |
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
robocop_ng/config_template.py
torobocop_ng/config.py
, configure all necessary parts to your server. - Enable the
Server Members
privileged intent (guide here) for the bot. You don't need to give Discord your passport as Robocop-NG is not designed to run at >1 guild at once, let alone >100. - (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 putsudo -H
before that). You can also install with poetry with justpoetry install
. - If you're moving from Kurisu or Robocop: Follow
Tips for people moving from Kurisu/Robocop
below. - Run
robocop_ng/__init__.py
(cd robocop_ng;python3 __init__.py
). Alternatively, if you didpoetry install
, runpython3 -m robocop_ng
in the same directory as your config files.
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 todata/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 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
- linuxgemini for helping out with Yubico OTP revocation code (which is based on their work)
- 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).