Update README.md to make contributing easier (#80)
* Update README.md Made changes to README.md to mention ryuko-ng and also to make contributing easier by modifying "How to run manually". * Update README.md oops i missed a spot * Update README.md * Remove stuff about requirements.txt Needs feedback * how could i forget about marysaka Add marysaka in Credits * missed a spot again * Improvements ? * slow and steady * Definitely improvements * more markdown
This commit is contained in:
parent
72fd725a94
commit
df77d6f4db
1 changed files with 16 additions and 15 deletions
31
README.md
31
README.md
|
@ -1,8 +1,8 @@
|
||||||
# robocop-ng
|
# ryuko-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.
|
Discord bot for handling Ryujinx moderation tasks and such, (n)ext-(g)en rewrite of Robocop
|
||||||
|
|
||||||
Code is based on https://gitlab.com/a/dpybotbase and https://github.com/916253/Kurisu-Reswitched.
|
Code is based on https://github.com/reswitched/robocop-ng.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
@ -20,24 +20,24 @@ You can see the migration instructions for your cogs here: https://discordpy.rea
|
||||||
|
|
||||||
## How to run
|
## How to run
|
||||||
|
|
||||||
- Copy `robocop_ng/config_template.py` to `robocop_ng/config.py`, configure all necessary parts to your server.
|
- Copy `robocop_ng/config_template.py` to `robocop_ng/config.py` and **configure all necessary parts for your server**.
|
||||||
- Enable all privileged intents ([guide here](https://discordpy.readthedocs.io/en/latest/intents.html?highlight=intents#privileged-intents)) for the bot. You don't need to give Discord your passport as Robocop-NG is not designed to run in >1 guild at once, let alone >100.
|
- Enable all privileged intents ([guide here](https://discordpy.readthedocs.io/en/latest/intents.html?highlight=intents#privileged-intents)) for the bot. You don't need to give Discord your passport as Ryuko-NG is not designed to run in >1 guild at once, let alone >100.
|
||||||
- (obviously) Add the bot to your guild. There are many resources about this online.
|
- Add the bot to your guild. There are 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.
|
- 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.
|
||||||
- If you're moving from Kurisu or Robocop: Follow `Tips for people moving from Kurisu/Robocop` below.
|
- If you're moving from Kurisu or Robocop: Follow [Tips for people moving from Kurisu/Robocop](https://github.com/Ryujinx/ryuko-ng#tips-for-people-moving-from-kurisurobocop) below.
|
||||||
|
|
||||||
### Running with docker
|
### Running with docker
|
||||||
|
|
||||||
- `docker build . -t robocopng`
|
- `docker build . -t robocopng`
|
||||||
- Assuming your robocop-ng repo is on `~/docker/`: `docker run --restart=always -v ~/docker/robocop-ng:/usr/src/app --name robocop_ng robocopng:latest`
|
- Assuming your robocop-ng repo is on `~/docker/`: `docker run --restart=always -v ~/docker/robocop-ng:/usr/src/app --name robocop_ng robocopng:latest`
|
||||||
|
|
||||||
For updates I just `git pull;docker rm -f robocop_ng` then run the two commands above again.
|
For updates, run `git pull;docker rm -f robocop_ng` then run the two commands above again.
|
||||||
|
|
||||||
### Running manually
|
### Running manually
|
||||||
|
|
||||||
- Install python3.8+.
|
- Install python3.8+.
|
||||||
- Install python dependencies (`pip3 install -Ur requirements.txt`, you might need to put `sudo -H` before that). You can also install with [poetry](https://python-poetry.org/) with just `poetry install`.
|
- Install dependencies with [poetry](https://python-poetry.org/) using `poetry install`.
|
||||||
- Run `robocop_ng/__init__.py` (`cd robocop_ng;python3 __init__.py`). Alternatively, if you did `poetry install`, run `python3 -m robocop_ng` in the same directory as your config files.
|
- Run `robocop_ng/__main__.py` (`cd robocop_ng;python3 __main__.py`).
|
||||||
|
|
||||||
To keep the bot running, you might want to use pm2 or a systemd service.
|
To keep the bot running, you might want to use pm2 or a systemd service.
|
||||||
|
|
||||||
|
@ -55,7 +55,7 @@ If you're moving from Kurisu/Robocop, and want to preserve your data, you'll wan
|
||||||
|
|
||||||
## Contributing
|
## 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.
|
Contributions are welcome. If you're unsure if your PR would be merged or not, ask in the [Ryujinx discord guild](https://discord.gg/ryujinx) pinging Berry.
|
||||||
|
|
||||||
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 .`.
|
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 .`.
|
||||||
|
|
||||||
|
@ -63,13 +63,14 @@ You're expected to use [black](https://github.com/psf/black) for code formatting
|
||||||
|
|
||||||
## Credits
|
## 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.
|
Ryuko-NG is a fork of [Robocop-NG](https://github.com/reswitched/robocop-ng) that is mainly maintained by [@TSRBerry](https://github.com/TSRBerry) and [@marysaka](https://github.com/marysaka).
|
||||||
|
|
||||||
I (ave) would like to thank the following, in no particular order:
|
[Robocop-NG](https://github.com/reswitched/robocop-ng) was initially developed by [@aveao](https://github.com/aveao) and @tumGER. It is currently maintained by [@aveao](https://github.com/aveao). Similarly, the official robocop-ng on the ReSwitched discord guild is hosted by [@aveao](https://github.com/aveao) too.
|
||||||
|
|
||||||
|
I would like to thank the following, in no particular order:
|
||||||
|
|
||||||
- ReSwitched community, for being amazing
|
- ReSwitched community, for being amazing
|
||||||
- ihaveamac/ihaveahax and f916253 for the original kurisu/robocop
|
- 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
|
- 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)
|
- 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).
|
- Everyone who contributed to robocop-ng/ryuko-ng in any way (reporting a bug, sending a PR, forking and hosting their own at their own guild, etc).
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue