rbms IR · 연동 가이드

클라이언트 연동 가이드

rbms-player 를 이 IR 서버에 연결해 스코어를 제출하고 랭킹을 조회하는 방법입니다.

1. 서버 주소 지정

rbms-player 를 실행할 때 --server 플래그로 이 IR 의 API 베이스를 지정합니다. 경로 끝의 /api 까지 포함해야 합니다.

rbms-player --server https://bms.hyuns.uk/api --player <플레이어_ID>

2. 계정 만들기

가입 화면에서 계정을 만들면 아이디가 그대로 IR 플레이어 ID 가 됩니다. 이미 계정이 있다면 로그인만 하면 됩니다.

3. API 토큰 발급

설정 화면의 API 토큰 탭에서 토큰을 발급합니다. 평문 토큰은 발급 직후 한 번만 표시되므로 그 자리에서 저장하세요. 이전에 발급한 토큰은 계속 유효하므로 필요 없으면 목록에서 폐기하세요.

Authorization: Bearer rbms_<발급받은_토큰>

4. 제출 확인

플레이를 마치면 클라이언트가 스코어를 제출합니다. 같은 기록을 다시 보내도 중복 생성되지 않고 기존 score_id 가 돌아옵니다.

5. guest 제출

서버가 guest 제출을 허용한 경우 토큰 없이도 제출할 수 있습니다. guest 기록은 항상 unranked 이고 랭킹과 개인 베스트에 반영되지 않습니다.

6. unranked 가 되는 조건

autoplay · 스크래치 자동 · 어시스트 사용 · 판정폭 변경 · TOTAL 오버라이드 · 미등록 클라이언트 빌드 · guest 제출 중 하나라도 해당하면 unranked 로 기록되며 랭킹에서 제외됩니다.