GS2-Realtime API 레퍼런스

실시간 통신 기능

대전 및 협력 플레이 기능을 구현합니다.

룸을 생성하면 IP 주소, 포트, 암호화 키의 3가지 정보가 발급됩니다.
룸에 참가하려면 발급된 IP 주소, 포트로 WebSocket을 통해 접속합니다.
통신에는 발급된 암호화 키를 사용합니다.

일반적인 GS2 서비스는 API 요청 횟수에 대해 요금이 발생하지만,
이 서비스는 게임 서버의 시작 시간과 통신 용량에 대해 비용이 발생하며,
통신 횟수에는 비용이 발생하지 않습니다.

룸의 라이프사이클

생성

GS2-Realtime은 룸 생성 요청을 받은 후 서버를 시작합니다.
이때 할당 가능한 빈 룸이 일정 수를 밑돌면,
핫 스탠바이 상태가 되는 룸을 한 번에 추가로 시작합니다.

즉, 요청을 받은 후 서버를 시작하는 콜드 스타트와 핫 스탠바이된 룸을 이용하는 웜 스타트는 룸 생성 요청을 받은 후 실제로 할당되기까지의 시간에 차이가 발생합니다.

콜드 스타트 시 대기 시간의 기준은 40초60초이며,
웜 스타트 시 대기 시간의 기준은 1초
3초입니다.

종료

시작된 룸은 생성 후 5분 동안 아무도 접속하지 않으면 종료됩니다.
이 종료 처리는 핫 스탠바이 중인 룸에도 적용되지만, 핫 스탠바이의 시작 시간은 이용 요금에 가산되지 않습니다.

룸에 참가 중인 모든 플레이어로부터 무통신 상태가 1분간 지속되어도 자동으로 종료됩니다.

룸의 최대 시작 시간은 3시간입니다. 생성 후 3시간이 경과하면 자동으로 종료됩니다.

콜드 스타트 발생 조건

  • 핫 스탠바이를 준비하는 것보다 빠르게 서버 시작 요청을 보낸 경우
  • 게임 서버의 버전 업이 이루어진 경우
  • 시작 요청이 자주 발생하지 않는 규모여서 핫 스탠바이가 준비되어 있지 않은 경우

게임에서 사용하기

Game Engine

게임 엔진용 GS2-Realtime SDK의 모델 사양과 API 레퍼런스

SDK

각종 프로그래밍 언어용 GS2-Realtime SDK의 모델 사양과 API 레퍼런스

설정 및 연동

Deploy/CDK

GS2-Deploy의 스택을 생성할 때 사용하는 템플릿 포맷과, CDK를 이용한 각종 언어의 템플릿 출력 구현 예제

관련 문서

구성과 선택 방법

relay·sync·stateMachine의 차이, 선택 방법, 개발 흐름

튜토리얼: 롤백 방식 동기화

캐릭터의 위치를 서버가 입력으로부터 계산하고, 자신의 캐릭터는 예측하여 지연 없이 움직이기까지의 절차

튜토리얼: 서버 사이드 로직

C#으로 룸의 룰을 작성하고, Unity에서 여러 플레이어가 같은 적을 공격할 수 있게 하기까지의 절차

튜토리얼: 오브젝트 동기화

룰을 작성하지 않고, 각 플레이어 캐릭터의 위치와 RPC를 Unity에서 동기화하기까지의 절차

Godot 클라이언트

공유 오브젝트를 Godot에서 표시·조작하기 위한 노드와 설정

Unity 클라이언트

공유 오브젝트를 Unity에서 표시·조작하기 위한 컴포넌트와 설정

오브젝트 동기화의 구조

sync와 stateMachine 룸에서 오브젝트가 어떻게 동기화되고, 누가 무엇을 변경할 수 있는지

GDScript로 룰 작성하기

stateMachine 룸의 룰을 GDScript로 작성하고, Godot에서 생성·등록하는 방법

룸 정의 레퍼런스

stateMachine 룸에서 실행하는 룰의 작성 방법, Room API, 실행 규칙, 상한값

Photon에서의 이전

Photon(PUN2)으로 만든 멀티플레이를 GS2-Realtime의 sync / stateMachine으로 옮기는 절차와 대응표