2020-10-12 10:00:28 +00:00
|
|
|
subscribe-bot
|
|
|
|
|
=============
|
|
|
|
|
|
|
|
|
|
Subscribes to OSU map updates and stores versions for later review.
|
|
|
|
|
|
|
|
|
|
Please don't run a separate bot, the official one is `subscribe-bot#8789`. If
|
2020-10-14 20:58:01 +00:00
|
|
|
you want to contribute or test the bot, instructions on how to run it are below.
|
|
|
|
|
|
|
|
|
|
Join the [Discord][2]
|
2020-10-12 10:00:28 +00:00
|
|
|
|
|
|
|
|
How to run
|
|
|
|
|
----------
|
|
|
|
|
|
|
|
|
|
1. Build the bot using a Go compiler that supports modules (1.11 or higher).
|
|
|
|
|
Running `go build` in the root of the repo should work.
|
|
|
|
|
1. Create a configuration file called `config.toml` (can be called something
|
|
|
|
|
else as long as you pass it into the executable as a command-line argument).
|
|
|
|
|
- `client_id` (int) and `client_secret` (string) are oauth-related settings
|
|
|
|
|
you can obtain from the OSU settings page.
|
|
|
|
|
- `bot_token` (string) is Discord's bot auth{entication,orization} token,
|
|
|
|
|
you can get that from Discord developers' page.
|
|
|
|
|
- `repos` (path) is a path to where map repositories should be stored.
|
|
|
|
|
1. Run the executable, passing `-config {path}` in case you want to use a
|
|
|
|
|
different config file than `config.toml`.
|
|
|
|
|
|
2020-10-14 19:08:38 +00:00
|
|
|
Architecture
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
There's several independent services running within:
|
|
|
|
|
|
|
|
|
|
- Discord bot, which posts updates to the relevant channels in discord
|
|
|
|
|
- Web server, which hosts an HTTP server allowing you to view changes
|
|
|
|
|
- Scraper, which actually polls the OSU API for new updates
|
|
|
|
|
|
2020-10-12 10:00:28 +00:00
|
|
|
License
|
|
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
[GPL3][1]
|
|
|
|
|
|
|
|
|
|
[1]: https://www.gnu.org/licenses/gpl-3.0.en.html
|
2020-10-14 20:58:01 +00:00
|
|
|
[2]: https://discord.gg/eqjVG2H
|
