Go to file

dependabot[bot] 811cbdf340 chore(deps): bump the minor-and-patch group with 13 updates (#73 )

Bumps the minor-and-patch group with 13 updates:

| Package | From | To |
| --- | --- | --- |
| [aioboto3](https://github.com/terricain/aioboto3) | `15.1.0` | `15.5.0` |
| [aiomysql](https://github.com/aio-libs/aiomysql) | `0.2.0` | `0.3.2` |
| [alembic](https://github.com/sqlalchemy/alembic) | `1.16.5` | `1.17.1` |
| [apscheduler](https://github.com/agronholm/apscheduler) | `3.11.0` | `3.11.1` |
| [bleach](https://github.com/mozilla/bleach) | `6.2.0` | `6.3.0` |
| [cryptography](https://github.com/pyca/cryptography) | `46.0.2` | `46.0.3` |
| [fastapi](https://github.com/fastapi/fastapi) | `0.118.0` | `0.120.4` |
| [newrelic](https://github.com/newrelic/newrelic-python-agent) | `11.0.0` | `11.0.1` |
| [python-dotenv](https://github.com/theskumar/python-dotenv) | `1.1.1` | `1.2.1` |
| [sqlalchemy](https://github.com/sqlalchemy/sqlalchemy) | `2.0.43` | `2.0.44` |
| [sqlmodel](https://github.com/fastapi/sqlmodel) | `0.0.25` | `0.0.27` |
| [pyright](https://github.com/RobertCraigie/pyright-python) | `1.1.406` | `1.1.407` |
| [ruff](https://github.com/astral-sh/ruff) | `0.13.3` | `0.14.3` |


Updates `aioboto3` from 15.1.0 to 15.5.0
- [Changelog](https://github.com/terricain/aioboto3/blob/main/CHANGELOG.rst)
- [Commits](https://github.com/terricain/aioboto3/compare/v15.1.0...v15.5.0)

Updates `aiomysql` from 0.2.0 to 0.3.2
- [Release notes](https://github.com/aio-libs/aiomysql/releases)
- [Changelog](https://github.com/aio-libs/aiomysql/blob/main/CHANGES.txt)
- [Commits](https://github.com/aio-libs/aiomysql/compare/v0.2.0...v0.3.2)

Updates `alembic` from 1.16.5 to 1.17.1
- [Release notes](https://github.com/sqlalchemy/alembic/releases)
- [Changelog](https://github.com/sqlalchemy/alembic/blob/main/CHANGES)
- [Commits](https://github.com/sqlalchemy/alembic/commits)

Updates `apscheduler` from 3.11.0 to 3.11.1
- [Release notes](https://github.com/agronholm/apscheduler/releases)
- [Changelog](https://github.com/agronholm/apscheduler/blob/3.11.1/docs/versionhistory.rst)
- [Commits](https://github.com/agronholm/apscheduler/compare/3.11.0...3.11.1)

Updates `bleach` from 6.2.0 to 6.3.0
- [Changelog](https://github.com/mozilla/bleach/blob/main/CHANGES)
- [Commits](https://github.com/mozilla/bleach/compare/v6.2.0...v6.3.0)

Updates `cryptography` from 46.0.2 to 46.0.3
- [Changelog](https://github.com/pyca/cryptography/blob/main/CHANGELOG.rst)
- [Commits](https://github.com/pyca/cryptography/compare/46.0.2...46.0.3)

Updates `fastapi` from 0.118.0 to 0.120.4
- [Release notes](https://github.com/fastapi/fastapi/releases)
- [Commits](https://github.com/fastapi/fastapi/compare/0.118.0...0.120.4)

Updates `newrelic` from 11.0.0 to 11.0.1
- [Release notes](https://github.com/newrelic/newrelic-python-agent/releases)
- [Commits](https://github.com/newrelic/newrelic-python-agent/compare/v11.0.0...v11.0.1)

Updates `python-dotenv` from 1.1.1 to 1.2.1
- [Release notes](https://github.com/theskumar/python-dotenv/releases)
- [Changelog](https://github.com/theskumar/python-dotenv/blob/main/CHANGELOG.md)
- [Commits](https://github.com/theskumar/python-dotenv/compare/v1.1.1...v1.2.1)

Updates `sqlalchemy` from 2.0.43 to 2.0.44
- [Release notes](https://github.com/sqlalchemy/sqlalchemy/releases)
- [Changelog](https://github.com/sqlalchemy/sqlalchemy/blob/main/CHANGES.rst)
- [Commits](https://github.com/sqlalchemy/sqlalchemy/commits)

Updates `sqlmodel` from 0.0.25 to 0.0.27
- [Release notes](https://github.com/fastapi/sqlmodel/releases)
- [Changelog](https://github.com/fastapi/sqlmodel/blob/main/docs/release-notes.md)
- [Commits](https://github.com/fastapi/sqlmodel/compare/0.0.25...0.0.27)

Updates `pyright` from 1.1.406 to 1.1.407
- [Release notes](https://github.com/RobertCraigie/pyright-python/releases)
- [Commits](https://github.com/RobertCraigie/pyright-python/compare/v1.1.406...v1.1.407)

Updates `ruff` from 0.13.3 to 0.14.3
- [Release notes](https://github.com/astral-sh/ruff/releases)
- [Changelog](https://github.com/astral-sh/ruff/blob/main/CHANGELOG.md)
- [Commits](https://github.com/astral-sh/ruff/compare/0.13.3...0.14.3)

---
updated-dependencies:
- dependency-name: aioboto3
  dependency-version: 15.5.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: minor-and-patch
- dependency-name: aiomysql
  dependency-version: 0.3.2
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: minor-and-patch
- dependency-name: alembic
  dependency-version: 1.17.1
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: minor-and-patch
- dependency-name: apscheduler
  dependency-version: 3.11.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: minor-and-patch
- dependency-name: bleach
  dependency-version: 6.3.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: minor-and-patch
- dependency-name: cryptography
  dependency-version: 46.0.3
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: minor-and-patch
- dependency-name: fastapi
  dependency-version: 0.120.4
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: minor-and-patch
- dependency-name: newrelic
  dependency-version: 11.0.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: minor-and-patch
- dependency-name: python-dotenv
  dependency-version: 1.2.1
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: minor-and-patch
- dependency-name: sqlalchemy
  dependency-version: 2.0.44
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: minor-and-patch
- dependency-name: sqlmodel
  dependency-version: 0.0.27
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: minor-and-patch
- dependency-name: pyright
  dependency-version: 1.1.407
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: minor-and-patch
- dependency-name: ruff
  dependency-version: 0.14.3
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: minor-and-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

2025-11-02 10:18:49 +08:00

.devcontainer

refactor(signalr): remove SignalR server & msgpack_lazer_api

2025-10-03 13:20:12 +00:00

.github

chore(deps): add Dependabot configuration for automated dependency updates (#65 )

2025-11-02 09:49:34 +08:00

.vscode

chore(dev): update develop environment

2025-07-26 15:03:56 +00:00

app

chore(custom-ruleset): Update custom ruleset definitions (#64 )

2025-11-01 17:12:56 +08:00

config

feat(mods): configure ranked mods by file (#49 )

2025-09-30 20:47:04 +08:00

migrations

feat(custom-rulesets): support custom rulesets (#23 )

2025-10-26 21:10:36 +08:00

nginx

chore(dev): update dev environment

2025-08-26 13:18:11 +08:00

scripts

feat(custom-rulesets): support custom rulesets (#23 )

2025-10-26 21:10:36 +08:00

static

chore(custom-ruleset): Update custom ruleset definitions (#64 )

2025-11-01 17:12:56 +08:00

tools

feat(custom-rulesets): support custom rulesets (#23 )

2025-10-26 21:10:36 +08:00

.all-contributorsrc

docs(contributors): add 4aya as a contributor for ideas (#61 )

2025-10-25 18:57:08 +08:00

.dockerignore

feat(storage): expose a path to access local storage

2025-08-12 05:23:16 +00:00

.editorconfig

chore(dev): update dev environment

2025-08-26 13:18:11 +08:00

.env.example

Update .env.example

2025-10-12 02:52:22 +08:00

.gitignore

Add MailerSend and template-based email verification

2025-10-12 00:36:47 +08:00

.pre-commit-config.yaml

chore(deps): upgrade packages

2025-09-13 16:41:35 +00:00

AGENTS.md

docs(dev): add guides for authorization

2025-10-04 07:49:35 +00:00

alembic.ini

refactor(database): rename migrations to make them more clear

2025-09-14 05:56:01 +00:00

CONTRIBUTING.md

docs(all-contributors): add initial contributors list

2025-10-19 18:29:11 +08:00

docker-compose-osurx.yml

deploy(docker): update spectator image to support custom rulesets

2025-10-26 13:14:53 +00:00

docker-compose.yml

deploy(docker): update spectator image to support custom rulesets

2025-10-26 13:14:53 +00:00

docker-entrypoint.sh

Improve JWT claims and chat channel reliability

2025-08-26 13:18:11 +08:00

Dockerfile

fix(ci): remove copy packages directory

2025-10-04 08:38:52 +00:00

Dockerfile-osurx

fix(ci): remove copy packages directory

2025-10-04 08:38:52 +00:00

LICENSE

更换许可

2025-09-17 01:01:33 +08:00

main.py

feat(custom-rulesets): support custom rulesets (#23 )

2025-10-26 21:10:36 +08:00

osu_lazer_api.code-workspace

refactor(signalr): remove SignalR server & msgpack_lazer_api

2025-10-03 13:20:12 +00:00

pyproject.toml

feat(calculator): support generate PerformanceAttributes & DifficultyAttributes from JSON Schema (#59 )

2025-10-25 19:10:53 +08:00

README.en.md

feat(custom-rulesets): support custom rulesets (#23 )

2025-10-26 21:10:36 +08:00

README.md

feat(custom-rulesets): support custom rulesets (#23 )

2025-10-26 21:10:36 +08:00

uv.lock

chore(deps): bump the minor-and-patch group with 13 updates (#73 )

2025-11-02 10:18:49 +08:00

README.en.md

g0v0-server

简体中文 | English

This is an osu! API server implemented with FastAPI + MySQL + Redis, supporting most features of osu! API v1, v2, and osu!lazer.

Features

OAuth 2.0 Authentication: Supports password and refresh token flows.
User Data Management: Complete user information, statistics, achievements, etc.
Multi-game Mode Support: osu! (RX, AP), taiko (RX), catch (RX), mania and custom rulesets (see below).
Database Persistence: MySQL for storing user data.
Cache Support: Redis for caching tokens and session information.
Multiple Storage Backends: Supports local storage, Cloudflare R2, and AWS S3.
Containerized Deployment: Docker and Docker Compose support.

Supported Rulesets

Ruleset	ID	ShortName	PP Algorithm (rosu)	PP Algorithm (performance-server)
osu!	`0`	`osu`	✅	✅
osu!taiko	`1`	`taiko`	✅	✅
osu!catch	`2`	`fruits`	✅	✅
osu!mania	`3`	`mania`	✅	✅
osu! (RX)	`4`	`osurx`	✅	✅
osu! (AP)	`5`	`osuap`	✅	✅
osu!taiko (RX)	`6`	`taikorx`	✅	✅
osu!catch (RX)	`7`	`fruitsrx`	✅	✅
Sentakki	`10`	`Sentakki`	❌	❌
tau	`11`	`tau`	❌	✅
Rush!	`12`	`rush`	❌	❌
hishigata	`13`	`hishigata`	❌	❌
soyokaze!	`14`	`soyokaze`	❌	✅

Go to custom-rulesets to download the custom rulesets modified for g0v0-server.

Quick Start

Using Docker Compose (Recommended)

Clone the project

git clone https://github.com/GooGuTeam/g0v0-server.git
cd g0v0-server

Create a .env file

Please see wiki to modify the .env file.
```
cp .env.example .env
```

Start the service

# Standard server
docker-compose -f docker-compose.yml up -d
# Enable osu!RX and osu!AP statistics (Gu pp algorithm based on ppy-sb pp algorithm)
docker-compose -f docker-compose-osurx.yml up -d

Connect to the server from the game

Use a custom osu!lazer client, or use LazerAuthlibInjection, and change the server settings to the server's address.

Updating the Database

Refer to the Database Migration Guide

Security

Use openssl rand -hex 32 to generate the JWT secret key to ensure the security of the server and the normal operation of the observer server.

Use openssl rand -hex 40 to generate the frontend secret key.

If it is in a public network environment, please block external requests to the /_lio path.

Documentation

Visit the wiki for more information.

License

This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0-only).
Any derivative work, modification, or deployment MUST clearly and prominently attribute the original authors:
GooGuTeam - https://github.com/GooGuTeam/g0v0-server