osu
/
subscribe-bot
1
0
Fork 0
Code Issues 3 Pull Requests Releases Wiki Activity
Subscribe to OSU mappers https://vc.osu.technology
59 Commits 3 Branches 0 Tags 572 KiB
Go 88.1%
HTML 9.4%
CSS 1.7%
Makefile 0.8%
Go to file
Michael Zhang 25cf58bfc2
swap target=blank 		2021-07-22 03:34:08 -05:00
config web 2020-10-14 14:08:38 -05:00
db mapper page 2021-07-22 03:32:53 -05:00
discord More efficient home page, and limit to 10 2021-07-21 18:12:40 -05:00
osuapi check error 2021-07-22 01:34:33 -05:00
scrape remove tracked mapper restriction for now 2021-07-21 17:18:49 -05:00
web swap target=blank 2021-07-22 03:34:08 -05:00
.gitignore use sqlite instead of bolt 2021-07-21 17:09:06 -05:00
LICENSE add debug flag and GPL license 2020-10-12 09:25:50 -05:00
Makefile a 2021-07-20 14:40:30 -05:00
README.md add patches 2020-10-14 15:58:01 -05:00
go.mod remove bolt dependency 2021-07-21 17:11:56 -05:00
go.sum remove bolt dependency 2021-07-21 17:11:56 -05:00
main.go More efficient home page, and limit to 10 2021-07-21 18:12:40 -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