게임 서버 로컬 디버깅 및 PlayFab과의 통합

​

개요

​

기본 설정 - Windows

• 게임 서버를 GSDK와 통합하고 빌드하세요. 자세한 내용은 PlayFab Game Server SDK(GSDK)와 게임 서버 통합을 참조하세요.
• 게임 서버와 해당 종속성을 zip 아카이브로 압축합니다. 컨테이너 모드에서 제대로 실행되려면 zip 아카이브에 컨테이너 이미지에 포함되지 않은 시스템 DLL이 포함되어야 합니다. 자세한 내용은 필요한 시스템 DLL 확인을 참조하세요.

• 로컬 디버깅 도구 세트를 다운로드하고 선택한 폴더(예: C:\PlayFabVmAgent)에 추출합니다.
• LocalMultiplayerAgent MultiplayerSettings.json Generator json 파일을 검토하는 동안 아래의 다음 옵션에 대해 자세히 알아보세요.
• 추출된 폴더 위치로 이동하여 텍스트 편집기(예: Visual Studio Code)에서 MultiplayerSettings.json 파일을 엽니다. 다음 속성을 업데이트합니다:
  • LocalFilePath - 이전에 만든 게임 서버 자산 zip 파일에 대한 전체 로컬 경로(워크스테이션에서), 예: D:\\MyAmazingGame\\asset.zip(JSON 형식을 위해 백슬래시는 이스케이프해야 함).
  • StartGameCommand - 컨테이너 내 게임 서버 실행 파일의 전체 경로. 예를 들어 실행 파일 이름이 mygame.exe인 경우 샘플 경로는 C:\\Assets\\mygame.exe가 될 수 있습니다. StartGameCommand 경로는 Process와 Container에서 다릅니다. Container의 StartGameCommand 경로는 컨테이너 또는 asset 폴더의 리소스에 대한 절대 경로입니다. Process의 StartGameCommand 경로는 첫 번째 지정된 asset이 작업 디렉터리가 되는 상대 경로입니다.
  • PortMappingsList - 실행 중일 때 게임에서 사용할 수 있는 포트입니다. NodePort는 워크스테이션에서 열리는 포트이고, GamePort.Number는 컨테이너에서 실행할 때 게임 서버가 바인딩해야 하는 포트입니다. GamePort 섹션을 게임 서버가 클라이언트를 수신 대기하는 프로토콜 및 포트와 일치하도록 업데이트합니다. 게임 서버에 여러 포트가 필요한 경우 기존 포트 구성을 복사/붙여넣기하고 NodePort를 증가시킨 다음, GamePort.Number와 GamePort.Name을 필요한 포트로 업데이트합니다. 프로세스로 실행할 때 GamePort.Number는 무시되며, 프로세스는 NodePort에 바인딩해야 합니다. 두 경우를 모두 처리하려면 다음 중 하나를 수행하세요:
    • 포트를 동일한 값으로 설정
    • 런타임에 GSDK 구성에서 GamePort.Name 키로 값을 확인 - 이는 항상 바인딩할 올바른 포트를 반환합니다.
• MultiplayerSettings.json 파일에는 편집할 수 있는 추가 필드가 있습니다:
  • ResourceLimits(선택 사항) - 지정된 경우 docker가 CPU/메모리 사용량을 제한합니다. 경고: 서버가 허용된 메모리를 초과하면 종료됩니다. ResourceLimits는 container 모드에서만 지정할 수 있습니다.
  • SessionCookie(선택 사항) - RequestMultiplayerServer API 호출의 일부로 게임 서버에 전달되는 세션 쿠키.
  • OutputFolder(선택 사항) - 출력 및 구성 파일이 생성되는 드라이브 또는 폴더에 대한 절대 경로입니다. 게임 서버가 이 경로 아래에 추출되므로 충분한 공간이 있는지 확인하세요. 지정하지 않으면 에이전트 폴더가 사용됩니다.
  • MountPath - 자산을 마운트할 컨테이너 내부의 경로입니다. 이 필드는 프로세스 모드에서 실행할 때 지정할 필요가 없습니다. 샘플 값 C:\\Assets를 사용하는 것을 권장합니다(JSON 형식을 위해 백슬래시는 이스케이프해야 함).
  • AgentListeningPort - 에이전트가 게임 서버와 통신하기 위해 바인딩되는 포트를 지정합니다. 열린 포트라면 어떤 것이든 작동합니다. 다른 프로세스가 56001에 바인딩하는 경우 이 값을 변경해야 합니다(또는 다른 프로세스를 종료).

​

GSDK 통합 확인

• MultiplayerSettings.json 파일에서 RunContainer를 false로 설정합니다.
• Powershell 창(관리자 권한)에서:
  • 작업 디렉터리를 도구 세트가 추출된 폴더로 변경합니다.
  • LocalMultiplayerAgent.exe를 실행합니다. 이 시점에서 LocalMultiplayerAgent는 http 리스너를 설정하고 게임 자산을 압축 해제하며 별도의 프로세스에서 게임 서버를 시작합니다. 그런 다음 LocalMultiplayerAgent는 게임 서버와 통합된 GSDK에서 하트비트를 기다립니다.
• GSDK가 올바르게 통합된 경우 LocalMultiplayerAgent는 다음 출력을 인쇄합니다:
  • CurrentGameState - Initializing(이는 선택 사항이며 게임 서버가 GSDK::ReadyForPlayers를 직접 호출하고 GSDK::Start를 호출하지 않는 경우 표시되지 않을 수 있음)
  • CurrentGameState - StandingBy
  • CurrentGameState - Active
  • CurrentGameState - Terminating
• 종료 콜백이 올바르게 설정된 경우 상태가 terminating으로 설정된 직후 게임 서버가 종료됩니다. PlayFab 플랫폼에서의 비정상 종료를 피하기 위해 게임 서버가 종료되는지 확인하는 것이 중요합니다.
• LocalMultiplayerAgent도 게임과 함께 종료되어야 합니다.

​

게임에 대한 연결 테스트

​

컨테이너화 확인

​

사전 요구 사항

• 2018년 4월(1803) 업데이트가 있는 Windows 10 Pro(또는 그 이상).
• Docker를 다운로드합니다. 또는 Docker 웹사이트 메인 페이지에서 다운로드할 수도 있습니다.

​

설정

• Docker가 Windows 컨테이너를 사용하도록 설정되어 있는지 확인
• Powershell 창(관리자 권한)에서:
  • 도구 세트가 추출된 폴더로 이동합니다.
  • docker 네트워크를 설정하고, LocalMultiplayerAgent와 통신하기 위한 방화벽 규칙을 추가하고, Microsoft/PlayFab-Multiplayer에서 PlayFab docker 이미지를 가져오는 Setup.ps1을 실행합니다. 스크립트를 처음 실행할 때 컨테이너 이미지를 다운로드하는 데 몇 분이 걸릴 수 있습니다.

​

컨테이너 내에서 게임 서버 실행

• MultiplayerSettings.json 파일에서 RunContainer를 true로 설정합니다.
• 도구 세트가 추출된 폴더(C:\PlayFabVmAgent)에서 Powershell 창(관리자 권한)을 열고 LocalMultiplayerAgent.exe를 실행합니다. 이렇게 하면 컨테이너 내에서 게임 서버가 시작됩니다. 결국 Powershell 창에서 게임 상태 변경 출력이 표시되어야 합니다(위의 GSDK 통합 확인 섹션과 유사).

​

컨테이너 내에서 실행되는 게임 서버에 대한 연결 테스트

​

Linux 컨테이너와 함께 LocalMultiplayerAgent 사용

• GitHub의 Releases 페이지에서 최신 버전의 LocalMultiplayerAgent 다운로드
• Windows에 Docker Desktop 설치
• Linux 컨테이너에서 실행 중인지 확인
• 하드 드라이브 중 하나를 마운트해야 합니다. 지침은 여기에서 찾을 수 있습니다.
• 게임 서버 이미지는 컨테이너 레지스트리에 게시되거나 로컬에서 빌드될 수 있습니다.
• “PlayFab”이라는 Docker 네트워크를 생성하는 SetupLinuxContainersOnWindows.ps1 Powershell 파일 실행
• LocalMultiplayerSettings.json 파일을 적절히 구성합니다. 아래 MultiplayerSettingsLinuxContainersOnWindowsSample.json에 포함된 샘플을 확인할 수 있습니다:

{
    "RunContainer": true,
    "OutputFolder": "C:\\output\\UnityServerLinux",
    "NumHeartBeatsForActivateResponse": 10,
    "NumHeartBeatsForTerminateResponse": 60,
    "TitleId": "",
    "BuildId": "00000000-0000-0000-0000-000000000000",
    "Region": "WestUs",
    "AgentListeningPort": 56001,
    "ContainerStartParameters": {
        "ImageDetails": {
            "Registry": "mydockerregistry.io",
            "ImageName": "mygame",
            "ImageTag": "0.1",
            "Username": "",
            "Password": ""
        }
    },
    "PortMappingsList": [
        [
            {
                "NodePort": 56100,
                "GamePort": {
                    "Name": "game_port",
                    "Number": 7777,
                    "Protocol": "TCP"
                }
            }
        ]
    ],
    "SessionConfig": {
        "SessionId": "ba67d671-512a-4e7d-a38c-2329ce181946",
        "SessionCookie": null,
        "InitialPlayers": [ "Player1", "Player2" ]
    }
}

• 이전 모든 단계를 수행한 후 LocalMultiplayerAgent.exe -lcow 명령으로 LocalMultiPlayerAgent를 실행할 수 있습니다(lcow는 Linux Containers On Windows의 약자).

​

문제 해결

• 컨테이너 모드에서 게임 서버가 “Container … exited with exit code 1”과 유사한 오류로 즉시 종료되지만 프로세스 모드에서는 잘 작동하는 경우. 자산 패키지에 필요한 모든 시스템 DLL이 포함되어 있는지 확인하세요.
• 모든 로그는 MultiplayerSettings.json 파일에 지정된 OutputFolder 아래에 있습니다. LocalMultiplayerAgent는 시작할 때마다 타임스탬프를 폴더 이름으로 하는 새 폴더를 생성합니다. GSDK를 통해 방출된 모든 게임 서버 로그는 GameLogs 폴더 내에 있습니다.
  게임 서버가 컨테이너에서 실행 중인 경우 살펴봐야 할 추가 디렉터리 계층이 있을 수 있습니다.
• GSDK는 GameLogs 폴더에 디버그 로그를 씁니다. 이 로그는 게임 서버에서 출력한 로그와 함께 GameLogs 폴더 내에 있습니다.
• 방화벽(windows 및 기타 백신 프로그램)이 포트에서 트래픽을 허용하도록 구성되어 있는지 확인하세요.
• 다음과 유사한 오류가 발생하는 경우: Docker API responded with status code=InternalServerError, response={"message":"failed to create endpoint <container_name> on network playfab: hnsCall failed in Win32: The specified port already exists". It's likely there is already a container running on the specified port. LocalMultiplayerAgent가 조기 종료된 경우 발생할 수 있습니다. docker ps 명령을 사용하여 실행 중인 컨테이너를 찾은 다음 docker kill <container_name>을 사용하여 종료하세요.
• Failed to find network 'playfab'을 포함하는 오류가 발생하는 경우. Setup.ps1을 다시 실행해 보세요.
• Unhandled Exception 오류가 발생하는 경우 PowerShell을 관리자로 실행 중일 수 있습니다.
• OutputFolder는 다른 시스템 변수에 의해 차례로 사용될 수 있으므로 절대 경로를 사용했는지 확인하세요. 예를 들어 GSDK_CONFIG_FILE은 이러한 종속성이 있으므로 상대 경로(또는 잘못된 값)는 게임 서버 구성 로딩 오류를 초래할 수 있습니다.

​

알려진 제한 사항

1. 디버깅이 끝난 후 컨테이너가 종료되지 않을 수 있습니다. 이 경우 다음 PowerShell 명령을 관리자 권한으로 실행하세요. 이 명령은 LocalMultiplayerAgent에서 시작되지 않은 컨테이너를 포함한 모든 컨테이너를 중지하고 제거합니다.

docker stop $(docker ps -aq)
docker rm $(docker ps -aq)