The one-stop shop for all official osu! tournament correspondence and information!

Please refer to the API documentation for more information.

For a guide on how to use the Mappool Compliance API in your mappooling sheets, consult this wiki article.

• Node v22 (LTS)
• pnpm
• MongoDB
• Cloudflare R2 Object Storage bucket for storing uploaded files (optional)
• an osu! API v2 client

• Clone the repository
• Set up a MongoDB database
• Set up a Cloudflare R2 bucket (optional)
• Run pnpm install
• Set up config.json from config.example.json with the following fields:
  • connection: MongoDB connection URL
  • session: session string, grab a random string from this website
  • baseUrl: base URL of the website
  • automation: boolean for whether to run automation jobs or not
  • osuApp: credentials for the osu! API v2 client
  • osuBot: credentials for the osu! bot API client
  • discord: Discord webhook setup
  • r2: the Cloudflare R2 bucket's credentials (optional)
  • complianceApi: the Mappool Compliance API's credentials (optional)
• Set up checklist.json from checklist.example.json
• Run pnpm dev, the project will be served in http://localhost:8088

If you need all automation jobs to run when the project starts, use pnpm dev:automation.

For documentation on how to create a new automation job, see the jobs README page.

For running a specific migration, run pnpm migrate <migration-name>. You can list all available migrations by running pnpm migrate.

For documentation on how to create a new migration, see the migrations README page.

This is purely for self-documentation purposes.

• --skip-deploy: Skip the deployment of the project to production
• --skip-client-refresh: Skip the client refresh notification

• DeepWiki Overview