Beat Saber Mod Database
Branch: master
Clone or download

README.md

ModSaber

Beat Saber Mod Database

Contributing

See the contribution guidelines.

Release Cycle

ModSaber follows a weekly release cycle, with regular deployments on Fridays. Patch versions may be released in between, but expect a new minor release on the regular days.
If no changes have been added since the last release, that week will be skipped.

Deprecation EoL Dates

Features marked as deprecated will typically still work for at least two release cycles. This might be longer depending if whether critcal systems are still depending on the old systems.

Codenames

ModSaber assigns a codename to each major and minor release. They are as follows:
(bonus points if you can guess the source)

Codenames
SNEAKY NIGHTCLUB HEARTBREAKER CASSANOVA TIGER PYTHON
MIDAS HOTROD SHADES TANK STRIKER GAMMA
DISCO JACK FIDDLER BLUE STEEL PISTON ROMEO
SILVER CENTURION SOUTHPAW RED SNAPPER PEACEMAKER HAMMERHEAD IGOR
GEMINI SHOTGUN BONES THE PRODIGAL SON MODEL PRIME

Anything unreleased is codenamed BLEEDING EDGE.

Deploying

  1. Install Docker and Docker Compose
  2. Clone the repo and copy example.env to .env
  3. Fill in environment variables as denoted in .env
  4. Pull external container dependencies with docker-compose pull
  5. Build ModSaber containers with docker-compose build
  6. Start the services with docker-compose up -d
  7. Configure a reverse proxy to listen to port 1280. Make sure you set the max file upload to 10MB or higher

API Routes

Public API routes will be documented in the Wiki

Thanks ❤️

Assistant#8431 Helping design the platform and bug test
williums#0001 Helping design the platform and bug test
Umbranox#6671 Feedback, security consultant, writing the Mod Manager
Megalon#7891 Great ideas and moral support