Subscribe to OSU mappers
https://vc.osu.technology
config | ||
db | ||
discord | ||
osuapi | ||
scrape | ||
web | ||
.gitignore | ||
go.mod | ||
go.sum | ||
LICENSE | ||
main.go | ||
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
- 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. - 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) andclient_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.
- Run the executable, passing
-config {path}
in case you want to use a different config file thanconfig.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