Releases: Srirus-Project/sirius-api-proxy
Release list
v1.3.0
Full Changelog: v1.2.3...v1.3.0
v1.2.3
v1.2.2
v1.2.1
Upgrade note
1.2.1 replaces the Global protocol bundle (protocol/global/1.0.1, now 47 files including
PlayerLogin). A 1.2.1 binary refuses to start with the earlier two-RPC bundle and exits with
Error: ProtocolDefinition. If a Global protocol_directory points outside the release
package, replace it with the package's protocol/global/1.0.1 before restarting. Deployments that
use the protocol directory shipped in the package are unaffected. See
CHANGELOG and
docs/REGIONS.md.
Global profile and event-deck lookups of a player that does not exist (including players of
another Global region) drop the account session and can disable the account in 1.2.1; this is
fixed in v1.2.2.
Full Changelog: v1.2.0...v1.2.1
v1.2.0
v1.1.0
This release separates Japan, TW/HK/MO, EN Region and Korea instead of treating Global as one backend. China (cn) is reserved and rejected before networking until its endpoints and protocol are verified.
- Add explicit region/platform identity and independent JP/Global native protobuf codecs, with compatible dynamic startup and hot reload.
- Add
GET /api/v1/regionsand GlobalGET /api/v1/servers; report region, supported RPCs and Master/resource versions in/api/v1/system. - Emit region-bearing resource snapshots and reject known endpoints belonging to another region.
- Preserve JP behavior when region/platform are omitted. Global discovery and anonymous Version are supported; unverified Global player/ranking/account/announcement operations return HTTP 501 without an upstream call.
Upgrade both proxy and updater together. v1.0.0 updater cannot consume new schema-2 snapshots. Use one proxy instance and separate configuration, tokens and storage per region. See region support and migration.
Validation: local formatting/build/Clippy, 46 API tests, packaged JP/Global native startup and CN rejection, plus live anonymous discovery/version queries against TW, EN and KR. Release archives are gated on Linux x64, macOS arm64 and Windows x64 build/test/smoke jobs.
Global SDK login and end-to-end Global asset acquisition/decryption are not included or claimed verified. No credentials, game keys or unused game protocol inventory are distributed.
Upgrade validation on yhm01 passed with the final Linux candidate: the v1.1.0 pair fetched and verified a JP schema-2 catalog, and v1.1.0 updater verified all 13,367 existing v1.0.0 resource files (8,199,248,661 bytes; 11,275 decrypted bundles).
Sirius API Proxy v1.0.0
First stable release of Sirius API Proxy, an unofficial Rust API proxy for BanG Dream! Our Notes, derived from Haruki-Sekai-API.
- Version, announcements, public profiles, rankings and event deck queries through an explicit RPC allowlist.
- Separate public and internal tokens; private account responses remain internal.
- Build-time native Protobuf codecs with compatible runtime proto reload.
- Verified Master data import/update, local JSON snapshots and version-pinned asset metadata.
- Configurable
session_lock: enabled by default; setfalseand restart to permit concurrent upstream calls. Server-side concurrency reliability remains unconfirmed.
Installation
Download the archive matching your OS and architecture, verify its SHA-256 checksum, and extract the complete directory. Copy sirius-api-config.example.yaml to sirius-api-config.yaml, provide the referenced environment secrets, and follow README.md. Keep the bundled protocol/ directory available. No external protoc, Redis or database is required.
Archives cover Linux x64, macOS ARM64 and Windows x64. Each includes configuration examples, runtime protocol definitions, documentation, licenses and a per-file SHA-256 manifest. Application version 1.0.0 is independent of the JP iOS 1.0.3 protocol baseline.
Scope
Game-server availability is outside the proxy's control. Existing game credentials are required for authenticated queries; this service does not register or transfer accounts. Consult the deployment checks for live business cases that still require valid game data.