메인 콘텐츠로 건너뛰기

Documentation Index

Fetch the complete documentation index at: https://docs.hyperx.dev/llms.txt

Use this file to discover all available pages before exploring further.

개요

유저 라이프사이클은 Unity 클라이언트가 HyperX 프로젝트 안에서 플레이어를 만들고, 로그인하고, 현재 유저 정보를 확인하는 첫 흐름입니다. 가장 짧은 첫 경험은 다음 순서입니다.
  1. HyperX.Core.Init으로 프로젝트를 초기화합니다.
  2. HyperX.Core.Users.StartGuest로 게스트 유저를 등록하거나 로그인합니다.
  3. HyperX.Core.Users.Me로 현재 유저와 대표 캐릭터를 확인합니다.
  4. 콘솔의 프로젝트 Users 화면에서 생성된 유저를 확인합니다.

게스트 유저 시작

using UnityEngine;

public class HyperXBootstrap : MonoBehaviour
{
    async void Start()
    {
        await HyperX.Core.Init("프로젝트코드");

        string guestToken = SystemInfo.deviceUniqueIdentifier;
        var session = await HyperX.Core.Users.StartGuest(
            guestToken,
            country: "KR",
            language: "ko"
        );

        var me = await HyperX.Core.Users.Me(session.AccessToken);
        Debug.Log($"HyperX user: {me.Id}, character: {me.Name}");
    }
}
StartGuest는 같은 인증 토큰으로 이미 등록된 유저가 있으면 자동으로 로그인합니다. 처음 실행과 재실행 모두 같은 코드로 처리할 수 있습니다.

콘솔에서 확인

Unity에서 위 코드를 실행한 뒤 콘솔에서 해당 프로젝트를 열고 Users 메뉴로 이동합니다. 유저 목록에서는 다음 정보를 확인할 수 있습니다.
  • 유저 ID
  • 인증 ID
  • 가입 방식
  • 국가/언어
  • 대표 캐릭터
  • 최근 로그인 시각
이 화면은 SDK 연동이 실제로 유저를 생성했는지 확인하는 첫 디버깅 지점입니다.

현재 유저 이름 변경

await HyperX.Core.Users.UpdateName(session.AccessToken, "Ari");

var updated = await HyperX.Core.Users.Me(session.AccessToken);
Debug.Log(updated.Name);
이름을 변경하기 전에 사용할 수 있는 이름인지 확인할 수도 있습니다.
var result = await HyperX.Core.Users.CheckName(session.AccessToken, "Ari");

if (result.Available)
{
    await HyperX.Core.Users.UpdateName(session.AccessToken, "Ari");
}

캐릭터 생성과 대표 캐릭터 변경

var character = await HyperX.Core.Users.CreateCharacter(
    session.AccessToken,
    name: "Ari2"
);

await HyperX.Core.Users.UpdateRepresentativeCharacter(
    session.AccessToken,
    character.Id
);

로그아웃

await HyperX.Core.Users.Logout(session.AccessToken);
로그아웃하면 해당 access token은 더 이상 사용할 수 없습니다. 다시 플레이하려면 StartGuest 또는 LoginGuest를 호출하세요.

참고

  • 현재 SDK는 GUEST 유저 흐름을 우선 지원합니다.
  • authenticationToken은 같은 유저를 다시 찾기 위한 값입니다. Unity 첫 테스트에서는 SystemInfo.deviceUniqueIdentifier를 사용할 수 있습니다.
  • 게스트 토큰을 직접 관리하는 게임은 저장 파일, 계정 연동, 플랫폼 ID 등 프로젝트 정책에 맞는 값을 전달하면 됩니다.
  • 서버 오류는 HyperXServerException으로 전달되며 에러 코드, 메시지, trace ID를 확인할 수 있습니다.