osu/subscribe-bot
1
0
Fork 0
Code Issues 3 Pull requests Releases Wiki Activity
Subscribe to OSU mappers https://vc.osu.technology
35 commits 3 branches 0 tags 331 KiB
Go 88.1%
HTML 9.4%
CSS 1.7%
Makefile 0.8%
Find a file
Michael Zhang 172a5265bc
patch went the wrong way
2020-10-14 16:57:15 -05:00
config web 2020-10-14 14:08:38 -05:00
db add the list command 2020-10-14 14:33:23 -05:00
discord patch went the wrong way 2020-10-14 16:57:15 -05:00
osuapi add logic to avoid fetching multiple tokens in parallel 2020-10-14 15:19:06 -05:00
scrape add the list command 2020-10-14 14:33:23 -05:00
web patch went the wrong way 2020-10-14 16:57:15 -05:00
.gitignore refactor into modules 2020-10-12 08:47:28 -05:00
go.mod add patches 2020-10-14 15:58:01 -05:00
go.sum add patches 2020-10-14 15:58:01 -05:00
LICENSE add debug flag and GPL license 2020-10-12 09:25:50 -05:00
main.go build git commit hash into project 2020-10-14 16:14:57 -05:00
Makefile build git commit hash into project 2020-10-14 16:14:57 -05:00
README.md add patches 2020-10-14 15:58:01 -05:00

README.md

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 you want to contribute or test the bot, instructions on how to run it are below.

Join the Discord

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.
  2. 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.
  3. Run the executable, passing -config {path} in case you want to use a different config file than config.toml.

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

License

GPL3