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/ao/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.
- 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 `'`).

---

## TODO

All Robocop features are now supported.

<details>
<summary>List of added Kurisu/Robocop features</summary>
<p>

- [x] .py configs
- [x] membercount command
- [x] Meme commands and pegaswitch (honestly the easiest part)
- [x] source command
- [x] robocop command
- [x] Verification: Actual verification system
- [x] Verification: Reset command
- [x] Logging: joins
- [x] Logging: leaves
- [x] Logging: role changes
- [x] Logging: bans
- [x] Logging: kicks
- [x] Moderation: speak
- [x] Moderation: ban
- [x] Moderation: silentban
- [x] Moderation: kick
- [x] Moderation: userinfo
- [x] Moderation: approve-revoke (community)
- [x] Moderation: addhacker-removehacker (hacker)
- [x] Moderation: probate-unprobate (participant)
- [x] Moderation: lock-softlock-unlock (channel lockdown)
- [x] Moderation: mute-unmute
- [x] Moderation: playing
- [x] Moderation: botnickname
- [x] Moderation: nickname
- [x] Moderation: clear/purge
- [x] Moderation: restrictions (people who leave with muted role will get muted role on join)
- [x] Warns: warn
- [x] Warns: listwarns-listwarnsid
- [x] Warns: clearwarns-clearwarnsid
- [x] Warns: delwarnid-delwarn
- [x] .serr and .err (thanks tomger!)

</p>
</details>

---

The main goal of this project, to get Robocop functionality done, is complete.

Secondary goal is adding new features:

- [ ] Purge: On purge, send logs in form of txt file to server logs
- [ ] New verification feature: Using log module from akbbot for logging attempts and removing old attempts
- [ ] New moderation feature: watch-unwatch (using log module from akbbot)
- [ ] New feature: Modmail
- [ ] New feature: Submiterr (relies on modmail)
- [ ] New feature: Highlights (problematic words automatically get posted to modmail channel, relies on modmail)
- [ ] Feature creep: Shortlink completion (gl/ao/etc)
- [ ] Feature creep: Pleroma embedding
- [ ] New moderation feature: timelock (channel lockdown with time, relies on robocronp)

<details>
<summary>Completed features</summary>
<p>

- [x] Better security, better checks and better guild whitelisting
- [x] Feature creep: Reminds
- [x] A system for running jobs in background with an interval (will be called robocronp)
- [x] Commands to list said jobs and remove them
- [x] New moderation feature: timemute (mute with time, relies on robocronp)
- [x] New moderation feature: timeban (ban with expiry, relies on robocronp)
- [x] Improvements to lockdown to ensure that staff can talk
- [x] New moderation feature: Display of mutes, bans and kicks on listwarns (.userlog now)
- [x] New moderation feature: User notes
- [x] New moderation feature: Reaction removing features (thanks misson20000!)
- [x] New moderation feature: User nickname change
- [x] New self-moderation feature: .mywarns
- [x] Remove sh, remove risky stuff from eval

</p>
</details>

<details>
<summary>TODO for robocronp</summary>
<p>

- [ ] Reduce code repetition on mod_timed.py
- [x] Allow non-hour values on timed bans

the following require me to rethink some of the lockdown code, which I don't feel like

- [ ] lockdown in helper
- [ ] timelock command
- [ ] working cronjob for unlock

</p>
</details>

---

## Thanks to

- ReSwitched community, for being amazing
- ihaveamac/ihaveahax and f916253 for the original kurisu/robocop
- tomGER for working hard on rewriting the .err/.serr commands, those were a nightmare
- misson20000 for adding in reaction removal feature and putting up with my many BS requests on PR reviews
Change dpybotbase branding to robocop branding 2018-12-23 12:49:09 +00:00			`# Robocop-ng`

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
Extend readme bonzi buddy intensifies 2018-12-26 11:32:57 +00:00			`Code is based on https://gitlab.com/ao/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.
			`- 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			`---`

Change dpybotbase branding to robocop branding 2018-12-23 12:49:09 +00:00			`## TODO`

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			`All Robocop features are now supported.`
restrictions: implement This means that we have achieved feature parity with robocop. 2018-12-23 23:53:14 +00:00
Extend readme bonzi buddy intensifies 2018-12-26 11:32:57 +00:00			`<details>`
more readme changes 2018-12-27 12:14:13 +00:00			`<summary>List of added Kurisu/Robocop features</summary>`
Extend readme bonzi buddy intensifies 2018-12-26 11:32:57 +00:00			`<p>`
Move checks and errcodes to a new folder called helpers 2018-12-26 11:36:55 +00:00
Switch to .py config 2018-12-23 13:13:39 +00:00			`- [x] .py configs`
Get membercount and rules commands done 2018-12-23 13:39:26 +00:00			`- [x] membercount command`
mute/unmute: added 2018-12-23 20:50:05 +00:00			`- [x] Meme commands and pegaswitch (honestly the easiest part)`
			`- [x] source command`
			`- [x] robocop command`
Add verification god i hate this so much 2018-12-23 17:13:40 +00:00			`- [x] Verification: Actual verification system`
reset: Added reset command 2018-12-23 16:31:12 +00:00			`- [x] Verification: Reset command`
logging: Add logging! 2018-12-23 19:03:40 +00:00			`- [x] Logging: joins`
			`- [x] Logging: leaves`
			`- [x] Logging: role changes`
			`- [x] Logging: bans`
			`- [x] Logging: kicks`
Extend readme bonzi buddy intensifies 2018-12-26 11:32:57 +00:00			`- [x] Moderation: speak`
Add ban and kick Also, message escaping stuffs were added to common and meme was updated accordingly 2018-12-23 15:33:59 +00:00			`- [x] Moderation: ban`
ban/kick: fix them, and add silentban 2018-12-23 15:44:16 +00:00			`- [x] Moderation: silentban`
Add ban and kick Also, message escaping stuffs were added to common and meme was updated accordingly 2018-12-23 15:33:59 +00:00			`- [x] Moderation: kick`
Add userinfo, extend TODO 2018-12-23 15:07:59 +00:00			`- [x] Moderation: userinfo`
Approve/revoke: added 2018-12-23 19:32:48 +00:00			`- [x] Moderation: approve-revoke (community)`
approve/revoke/addhacker/removehacker/probate/unprobate: Re-make and combine commands 2018-12-23 19:59:42 +00:00			`- [x] Moderation: addhacker-removehacker (hacker)`
			`- [x] Moderation: probate-unprobate (participant)`
lockdown: Add lockdown 2018-12-23 20:33:03 +00:00			`- [x] Moderation: lock-softlock-unlock (channel lockdown)`
mute/unmute: added 2018-12-23 20:50:05 +00:00			`- [x] Moderation: mute-unmute`
playing: Add playing Also this commit includes DRAM optimization (aka I sneakily cleaned tomGER's code a bit)~ 2018-12-23 17:36:40 +00:00			`- [x] Moderation: playing`
botnickname/nickname: added 2018-12-23 17:56:27 +00:00			`- [x] Moderation: botnickname`
			`- [x] Moderation: nickname`
purge: add 2018-12-23 20:59:08 +00:00			`- [x] Moderation: clear/purge`
restrictions: implement This means that we have achieved feature parity with robocop. 2018-12-23 23:53:14 +00:00			`- [x] Moderation: restrictions (people who leave with muted role will get muted role on join)`
warn: add 2018-12-23 22:11:01 +00:00			`- [x] Warns: warn`
listwarns/listwarnsid: add 2018-12-23 22:36:36 +00:00			`- [x] Warns: listwarns-listwarnsid`
clearwarns/clearwarnsid: added 2018-12-23 23:25:30 +00:00			`- [x] Warns: clearwarns-clearwarnsid`
delwarn/delwarnid: add This concludes the kurisu rewrite, other than restrictions. 2018-12-23 23:41:25 +00:00			`- [x] Warns: delwarnid-delwarn`
mute/unmute: added 2018-12-23 20:50:05 +00:00			`- [x] .serr and .err (thanks tomger!)`
Move checks and errcodes to a new folder called helpers 2018-12-26 11:36:55 +00:00
Extend readme bonzi buddy intensifies 2018-12-26 11:32:57 +00:00			`</p>`
			`</details>`
Update README with better TODO 2018-12-23 20:36:30 +00:00
			`---`

Cleanup, fix README.md Fixing some markdown bugs, and moving completed tasks into a details pop-out. 2019-02-09 08:11:13 +00:00			`The main goal of this project, to get Robocop functionality done, is complete.`

			`Secondary goal is adding new features:`
Update README with better TODO 2018-12-23 20:36:30 +00:00
Push some stuff I forgot to push 2019-01-07 08:49:19 +00:00			`- [ ] Purge: On purge, send logs in form of txt file to server logs`
Update README with better TODO 2018-12-23 20:36:30 +00:00			`- [ ] New verification feature: Using log module from akbbot for logging attempts and removing old attempts`
restrictions: Don't rely on role names, use role ids instead 2018-12-27 09:10:29 +00:00			`- [ ] New moderation feature: watch-unwatch (using log module from akbbot)`
Update README with better TODO 2018-12-23 20:36:30 +00:00			`- [ ] New feature: Modmail`
more readme changes 2018-12-27 12:14:13 +00:00			`- [ ] New feature: Submiterr (relies on modmail)`
			`- [ ] New feature: Highlights (problematic words automatically get posted to modmail channel, relies on modmail)`
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			`- [ ] Feature creep: Shortlink completion (gl/ao/etc)`
			`- [ ] Feature creep: Pleroma embedding`
Cleanup, fix README.md Fixing some markdown bugs, and moving completed tasks into a details pop-out. 2019-02-09 08:11:13 +00:00			`- [ ] New moderation feature: timelock (channel lockdown with time, relies on robocronp)`

			`<details>`
			`<summary>Completed features</summary>`
			`<p>`

			`- [x] Better security, better checks and better guild whitelisting`
remind: add remind, make crons more robust 2018-12-30 20:36:11 +00:00			`- [x] Feature creep: Reminds`
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			`- [x] A system for running jobs in background with an interval (will be called robocronp)`
			`- [x] Commands to list said jobs and remove them`
			`- [x] New moderation feature: timemute (mute with time, relies on robocronp)`
			`- [x] New moderation feature: timeban (ban with expiry, relies on robocronp)`
			`- [x] Improvements to lockdown to ensure that staff can talk`
Massive cleanup of code, many new features - added logging and listing of kick/ban/mute events - add usernotes (.note to add a note to a user, .notes to fetch them) - split off mod.py into many files, cleanup on many features - renamed .listwarns to .userlog - renamed .mywarns to .myuserlog 2018-12-27 10:56:24 +00:00			`- [x] New moderation feature: Display of mutes, bans and kicks on listwarns (.userlog now)`
			`- [x] New moderation feature: User notes`
Extend readme bonzi buddy intensifies 2018-12-26 11:32:57 +00:00			`- [x] New moderation feature: Reaction removing features (thanks misson20000!)`
			`- [x] New moderation feature: User nickname change`
			`- [x] New self-moderation feature: .mywarns`
clearwarns/clearwarnsid: added 2018-12-23 23:25:30 +00:00			`- [x] Remove sh, remove risky stuff from eval`
Extend readme bonzi buddy intensifies 2018-12-26 11:32:57 +00:00
Cleanup, fix README.md Fixing some markdown bugs, and moving completed tasks into a details pop-out. 2019-02-09 08:11:13 +00:00			`</p>`
			`</details>`

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			`<details>`
			`<summary>TODO for robocronp</summary>`
			`<p>`

Cleanup, fix README.md Fixing some markdown bugs, and moving completed tasks into a details pop-out. 2019-02-09 08:11:13 +00:00			`- [ ] Reduce code repetition on mod_timed.py`
			`- [x] Allow non-hour values on timed bans`
Aliases on exit 2018-12-27 21:50:18 +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			`the following require me to rethink some of the lockdown code, which I don't feel like`

Cleanup, fix README.md Fixing some markdown bugs, and moving completed tasks into a details pop-out. 2019-02-09 08:11:13 +00:00			`- [ ] lockdown in helper`
			`- [ ] timelock command`
			`- [ ] working cronjob for unlock`
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
			`</p>`
			`</details>`

Extend readme bonzi buddy intensifies 2018-12-26 11:32:57 +00:00			`---`

			`## Thanks to`

			`- 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			`- tomGER for working hard on rewriting the .err/.serr commands, those were a nightmare`
			`- misson20000 for adding in reaction removal feature and putting up with my many BS requests on PR reviews`
Improve steps for people moving from kurisu or robocop 2018-12-27 12:00:22 +00:00