ryuko-ng/README.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 `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).
Warn on commands where user often leaves (by force orotherwise) if it happens 2020-06-26 23:01:38 +00:00			`# robocop-ng`
Change dpybotbase branding to robocop branding 2018-12-23 12:49:09 +00:00
Robocronp: Add robocronp and some timed commands - Added: .timemute - Added: .timeban - Added: .listjobs - Added: .deletejob - Many bugfixes are also included~ You'll need to restart your copy of robocop-ng after pulling this. 2018-12-27 21:36:18 +00:00			`Next-gen rewrite of Kurisu/Robocop bot used on ReSwitched bot with discord.py rewrite, designed to be relatively clean, consistent and un-bloated.`
Change dpybotbase branding to robocop branding 2018-12-23 12:49:09 +00:00
Fix my gitlab url 2019-11-26 06:52:23 +00:00			`Code is based on https://gitlab.com/a/dpybotbase and https://github.com/916253/Kurisu-Reswitched.`
Initial commit 2018-03-08 22:47:53 +00:00
updates to readme 2018-03-08 23:03:45 +00:00
Extend readme bonzi buddy intensifies 2018-12-26 11:32:57 +00:00			`---`

			`## How to run`

			- Copy `config.py.template` to `config.py`, configure all necessary parts to your server.
Add a tiny note to README about role position 2019-08-06 09:54:23 +00:00			`- (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.`
Extend readme bonzi buddy intensifies 2018-12-26 11:32:57 +00:00			`- Install python3.6+.`
			- Install python dependencies (`pip3 install -Ur requirements.txt`, you might need to put `sudo -H` before that)
Improve steps for people moving from kurisu or robocop 2018-12-27 12:00:22 +00:00			- If you're moving from Kurisu or Robocop: Follow `Tips for people moving from Kurisu/Robocop` below.
Extend readme bonzi buddy intensifies 2018-12-26 11:32:57 +00:00			- Run `Robocop.py` (`python3 Robocop.py`)

			`To keep the bot running, you might want to use pm2 or a systemd service.`

Improve steps for people moving from kurisu or robocop 2018-12-27 12:00:22 +00:00			`---`

			`## 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 `'`).
Rename warnsv2.json to userlog.py 2018-12-27 11:19:33 +00:00
updates to readme 2018-03-08 23:03:45 +00:00			`---`

Do a black pass and add black to contributing guidelines FORK MAINTAINERS: I'm so, so sorry, but this was planned since forever. If you need help integrating this, feel free to contact me. 2020-04-20 22:05:32 +00:00			`## 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 .`.

			`---`

Readme changes Made it so that there's no confusion as to who "I" refers to after to after the move from my own repo to reswitched org. 2019-04-25 07:10:56 +00:00			`## Credits`

Update list of maintainers 2020-03-14 13:26:47 +00:00			`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.`
Readme changes Made it so that there's no confusion as to who "I" refers to after to after the move from my own repo to reswitched org. 2019-04-25 07:10:56 +00:00
			`I (ave) would like to thank the following, in no particular order:`
Extend readme bonzi buddy intensifies 2018-12-26 11:32:57 +00:00
			`- ReSwitched community, for being amazing`
Robocronp: Add robocronp and some timed commands - Added: .timemute - Added: .timeban - Added: .listjobs - Added: .deletejob - Many bugfixes are also included~ You'll need to restart your copy of robocop-ng after pulling this. 2018-12-27 21:36:18 +00:00			`- ihaveamac/ihaveahax and f916253 for the original kurisu/robocop`
Extend readme bonzi buddy intensifies 2018-12-26 11:32:57 +00:00			`- misson20000 for adding in reaction removal feature and putting up with my many BS requests on PR reviews`
Readme changes Made it so that there's no confusion as to who "I" refers to after to after the move from my own repo to reswitched org. 2019-04-25 07:10:56 +00:00			`- 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).`
Improve steps for people moving from kurisu or robocop 2018-12-27 12:00:22 +00:00