Waktaverse Games Backend SDK (Node.js) ·

이 라이브러리는 Waktaverse Games에서 제공하는 API를 쉽게 이용할 수 있는 TS/JS Backend Client이에요.
클라이언트 단에서 모든 요청을 처리하는 GameSDK와 달리, 온라인 멀티플레이를 지원하는 서버 기반 게임에 적합한 SDK입니다.

잠깐! 이 라이브러리를 사용하시기 전 아래 내용을 확인해 주세요!

이 라이브러리는 서버에 설치되어 작동하는데 목적으로 한 SDK로, 클라이언트 단에서 사용하면 안됩니다.
클라이언트 단(Frontend)에서 사용하려면 GameSDK를 사용해주세요.

설치하기

$ npm install --save @wakgames/backend-sdk

SDK 사용법

기본 사용법

WakGames 클래스를 불러와 사용하면 됩니다.

import {WakGames} from '@wakgames/backend-sdk';

const wakGames = new WakGames({
  clientId: 'wakttu',
  redirectUrl: 'https://example.com/callback',
});

초기화

Serialize Field를 필수로 설정해야 합니다.

clientId : 개발자 포탈에서 확인된 Client ID.
redirectUrl : 개발자 포탈에서 설정한 Callback URL.

API

모든 API는 Promise를 반환합니다. (Async)
Promise 인자는 결과 데이터와 상태 코드로 구성된 RestAPI Response 객체입니다.
(단, Authorize API는 창을 열어야 할 URL을 담은 object를 반환합니다.)

API 호출이 실패한 경우 Fetch Exception이 발생하고, Fetch API를 이용하듯이 예외처리가 가능합니다.
상세한 설명은 JSDoc을 참고해주세요.

기여하기

이 라이브러리는 누구나 기여할 수 있어요. 라이브러리에 기여하고 싶다면 아래 문서를 참고해주세요. (기여 가이드라인)

라이선스

MIT License. LICENSE 파일을 참고하세요.
본 레포지토리를 상업적 용도로 Fork/재배포 하는 행위를 금합니다.

kms0219kms/Waktaverse-Games-BackendSdk-Nodejs