Master Data on Game Server Services | Docs

마스터 데이터 관리

Mon, 01 Jan 0001 00:00:00 +0000

용어 정의

용어	의미
모델 마스터	마스터 데이터 에디터가 임시로 등록하는, 게임 플레이어별로 달라지지 않는 데이터
모델	게임 내에서 사용하는, 게임 플레이어별로 달라지지 않는 데이터
프로퍼티	모델을 바탕으로 작성한, 게임 플레이어별로 다른 데이터

게임을 구성하는 요소에는 소지 아이템의 파라미터나 퀘스트의 구성 데이터 등, 게임 플레이어별로는 달라지지 않는 데이터가 있습니다. 이러한 데이터를 GS2에서는 모델 이라고 부릅니다. 그리고 모델을 바탕으로 게임 플레이어가 소지하는 데이터가 된 것을 프로퍼티 라고 부릅니다.

일반적인 마스터 데이터는 GS2에서는 모델 에 해당하며, GS2에는 모델 마스터 라는 개념이 존재합니다. 모델 / 모델 마스터 의 차이는 데이터의 내용은 동일하지만, 실제로 게임에서 액세스되는 상태인지 여부에 있습니다.

GS2-Account 마스터 데이터 레퍼런스

Mon, 01 Jan 0001 00:00:00 +0000

마스터 데이터 포맷

{
 "version": "2024-07-30",
 "takeOverTypeModels": [
 {
 "type": "[int]슬롯 번호",
 "metadata": "[string?]메타데이터",
 "openIdConnectSetting": {
 "configurationPath": "[string]OpenID Connect 설정 URL",
 "clientId": "[string]클라이언트 ID",
 "clientSecret": "[string]클라이언트 시크릿",
 "appleTeamId": "[string]Apple Developer 팀 ID",
 "appleKeyId": "[string]Apple에 등록된 키 ID",
 "applePrivateKeyPem": "[string]Apple로부터 받은 비밀 키",
 "doneEndpointUrl": "[string?]인증 완료 시 이동하는 URL",
 "additionalScopeValues": [
 {
 "key": "[string]이름",
 "value": "[string?]값"
 }
 ],
 "additionalReturnValues": [
 "[string]OpenID Connect에서 획득하는 추가 반환값"
 ]
 }
 }
 ]
}

	타입	활성화 조건	필수	기본값	값 제한	설명
version	string		✓	2024-07-30		마스터 데이터 포맷 버전
takeOverTypeModels	List<TakeOverTypeModel>				~ 1000 items	인계 정보 타입 모델 인계 정보를 정의하는 모델입니다. 인계 정보란 디바이스 기종 변경이나 플랫폼 간 계정 이동·공유 시에 사용하는 정보입니다. 개인을 식별하는 고유한 문자열과 비밀번호로 구성되며, 그 올바른 조합을 입력함으로써 Account(익명 계정)를 취득할 수 있습니다. 하나의 Account에 대해 여러 개의 인계 정보를 설정할 수 있습니다. 여러 개의 인계 정보를 설정하려면 각각 다른 슬롯을 지정해야 합니다. 슬롯은 0~1024를 지정할 수 있으므로 최대 1,025종류의 인계 정보를 설정할 수 있습니다. 구체적인 예로는 0에는 Sign in with Apple의 계정 정보를, 1에는 Google 계정 정보를 저장하는 등의 방식이 상정되어 있습니다. 어디까지나 이 인계 정보는 데이터 홀더이며, 소셜 계정과의 인증 메커니즘은 별도로 준비해야 합니다.

모델

TakeOverTypeModel

인계 정보 타입 모델

GS2-Buff 마스터 데이터 레퍼런스

Mon, 01 Jan 0001 00:00:00 +0000

마스터 데이터 포맷

{
 "version": "2024-04-15",
 "buffEntryModels": [
 {
 "name": "[string]버프 엔트리 모델 이름",
 "metadata": "[string?]메타데이터",
 "expression": "[문자열 열거형]버프의 적용 타입",
 "targetType": "[문자열 열거형]버프를 적용할 대상의 종류",
 "targetModel": {
 "targetModelName": "[string]버프를 적용할 모델의 종류",
 "targetFieldName": "[string]버프 적용 대상 필드명",
 "conditionGrns": [
 {
 "targetModelName": "[string]버프 적용 조건의 모델 이름",
 "targetGrn": "[string]버프의 적용 조건 GRN"
 }
 ],
 "rate": "[float]보정 레이트"
 },
 "targetAction": {
 "targetActionName": "[string]버프를 적용할 액션의 종류",
 "targetFieldName": "[string]버프 적용 대상 필드명",
 "conditionGrns": [
 {
 "targetModelName": "[string]버프 적용 조건의 모델 이름",
 "targetGrn": "[string]버프의 적용 조건 GRN"
 }
 ],
 "rate": "[float]보정 레이트"
 },
 "priority": "[int]버프의 적용 우선순위",
 "applyPeriodScheduleEventId": "[string?]버프를 적용할 이벤트의 개최 기간 GRN"
 }
 ]
}

	타입	활성화 조건	필수	기본값	값 제한	설명
version	string		✓	2024-04-15		마스터 데이터 포맷 버전
buffEntryModels	List<BuffEntryModel>				~ 100 items	버프 엔트리 모델 버프의 적용량은 버프 엔트리 모델로 관리하며, 동일한 대상에 대해 여러 버프 엔트리 모델을 연결할 수 있습니다. 버프 엔트리 모델의 적용 순서는 버프 엔트리 모델의 `priority` 로 관리하며, `priority` 값이 작을수록 우선순위가 높아집니다. 버프의 적용 방식은 3종류가 있으며 “Rate Add”, “Mul”, “Value Add"가 있습니다. Rate Add 는 버프의 적용 레이트에 가산하는 명령이며, Mul 은 버프의 적용 레이트에 곱하는 명령입니다. Value Add 는 버프 보정 계산 후의 값에 가산을 수행하는 명령입니다. 예를 들어 기본 레이트가 1.0 이고 Rate Add 0.2 를 설정하면 버프 적용 레이트는 1.2 가 됩니다. Mul 0.5 를 설정하면 버프 적용 레이트는 현재 레이트의 0.5배가 됩니다. 버프 엔트리 모델에는 GS2-Schedule 의 이벤트를 연결할 수 있으며, 이벤트 개최 기간 중에만 버프를 적용하도록 설정하는 것도 가능합니다.

모델

BuffEntryModel

버프 엔트리 모델

GS2-Chat 마스터 데이터 레퍼런스

Mon, 01 Jan 0001 00:00:00 +0000

마스터 데이터 포맷

{
 "version": "2020-04-30",
 "categoryModels": [
 {
 "category": "[int]카테고리",
 "rejectAccessTokenPost": "[문자열 열거형?]플레이어의 액세스 토큰을 이용한 게시를 거부한다"
 }
 ]
}

	타입	활성화 조건	필수	기본값	값 제한	설명
version	string		✓	2020-04-30		마스터 데이터 포맷 버전
categoryModels	List<CategoryModel>				~ 1000 items	메시지 카테고리 모델 메시지 카테고리 모델은 채팅 룸에 게시되는 메시지를 분류하기 위한 카테고리를 정의합니다. 각 카테고리는 숫자로 식별되며, 카테고리별로 플레이어의 액세스 토큰을 사용한 게시를 허용할지 거부할지 설정할 수 있습니다. 이를 통해 서버만 게시할 수 있는 시스템 안내 카테고리 등의 사용 사례를 구현할 수 있습니다.

모델

CategoryModel

메시지 카테고리 모델

GS2-Dictionary 마스터 데이터 레퍼런스

Mon, 01 Jan 0001 00:00:00 +0000

마스터 데이터 포맷

{
 "version": "2020-04-30",
 "entryModels": [
 {
 "name": "[string]엔트리 모델 이름",
 "metadata": "[string?]메타데이터"
 }
 ]
}

	타입	활성화 조건	필수	기본값	값 제한	설명
version	string		✓	2020-04-30		마스터 데이터 포맷 버전
entryModels	List<EntryModel>				~ 10000 items	엔트리 모델 엔트리 모델은 GS2-Dictionary에서 도감에 기록 가능한 대상을 정의하는 마스터 데이터입니다. 각 엔트리 모델은 몬스터, 아이템, 아바타 파츠 등 도감에 기록되는 엔티티의 종류를 나타냅니다. 엔트리의 보유 상태는 ‘기록됨 / 미기록’의 2가지 값으로 관리되며, 동일한 엔트리 모델에 대해 수량이나 스택의 개념은 없습니다.

모델

EntryModel

엔트리 모델

GS2-Distributor 마스터 데이터 레퍼런스

Mon, 01 Jan 0001 00:00:00 +0000

마스터 데이터 포맷

{
 "version": "2019-03-01",
 "distributorModels": [
 {
 "name": "[string]배포 모델 이름",
 "metadata": "[string?]메타데이터",
 "inboxNamespaceId": "[string?]넘친 리소스를 전송할 GS2-Inbox 네임스페이스 GRN",
 "whiteListTargetIds": [
 "[string]GS2-Distributor를 통해 처리할 수 있는 대상 리소스 GRN 프리픽스"
 ]
 }
 ]
}

	타입	활성화 조건	필수	기본값	값 제한	설명
version	string		✓	2019-03-01		마스터 데이터 포맷 버전
distributorModels	List<DistributorModel>				~ 100 items	배포 모델 배포 모델이란 리소스 입수 시 소지 한도를 초과하여 입수했을 때의 정책을 설정하는 엔티티입니다. GS2-Distributor를 통해 입수 처리를 수행함으로써, 넘친 리소스를 GS2-Inbox의 메시지로 전송할 수 있습니다.

모델

DistributorModel

배포 모델

GS2-Enchant 마스터 데이터 레퍼런스

Mon, 01 Jan 0001 00:00:00 +0000

마스터 데이터 포맷

{
 "version": "2023-07-18",
 "balanceParameterModels": [
 {
 "name": "[string]밸런스 파라미터 모델 이름",
 "metadata": "[string?]메타데이터",
 "totalValue": "[long]합계값",
 "initialValueStrategy": "[문자열 열거형]초기값 설정 방침",
 "parameters": [
 {
 "name": "[string]이름",
 "metadata": "[string?]메타데이터"
 }
 ]
 }
 ],
 "rarityParameterModels": [
 {
 "name": "[string]레어리티 파라미터 모델명",
 "metadata": "[string?]메타데이터",
 "maximumParameterCount": "[int]부여할 파라미터의 최대 수",
 "parameterCounts": [
 {
 "count": "[int]부여 수",
 "weight": "[int]추첨 가중치"
 }
 ],
 "parameters": [
 {
 "name": "[string]이름",
 "metadata": "[string?]메타데이터",
 "resourceName": "[string]게임에서 사용하는 파라미터 리소스 종류를 나타내는 이름(GS2의 동작에는 사용되지 않음)",
 "resourceValue": "[long]게임에서 사용하는 파라미터 리소스 값(GS2의 동작에는 사용되지 않음)",
 "weight": "[int]추첨 가중치"
 }
 ]
 }
 ]
}

	타입	필수	기본값	값 제한	설명
version	string	✓	2023-07-18		마스터 데이터 포맷 버전
balanceParameterModels	List<BalanceParameterModel>			~ 10000 items	밸런스 파라미터 모델 밸런스 파라미터의 추첨 조건을 정의합니다. 밸런스 파라미터는 고정된 합계 값을 여러 파라미터 슬롯에 분배합니다. 예를 들어 합계 파워가 100인 무기에 대해 ATK=60, DEF=30, SPD=10과 같이 배분됩니다. 초기값 설정 방침에 따라 값의 할당 방법이 결정됩니다: `average`는 균등하게 분배하고, `lottery`는 합계 값을 무작위로 배분합니다.
rarityParameterModels	List<RarityParameterModel>			~ 10000 items	레어리티 파라미터 모델 레어리티 파라미터의 추첨 조건을 정의합니다. 레어리티 파라미터는 가중 추첨 시스템을 사용하여 부여되는 파라미터의 수와 할당되는 구체적인 값을 모두 결정합니다. 먼저, 부여 수 모델 목록에서 가중 추첨을 통해 채울 파라미터 슬롯 수가 결정됩니다. 그런 다음, 각 슬롯의 값이 파라미터 값 모델 목록에서 가중 추첨으로 선택되어, 제어된 확률 분포에 따른 무작위 장비 속성을 제공합니다.

모델

BalanceParameterModel

밸런스 파라미터 모델

GS2-Enhance 마스터 데이터 레퍼런스

Mon, 01 Jan 0001 00:00:00 +0000

마스터 데이터 포맷

{
 "version": "2020-08-22",
 "rateModels": [
 {
 "name": "[string]강화 레이트 모델 이름",
 "description": "[string?]설명문",
 "metadata": "[string?]메타데이터",
 "targetInventoryModelId": "[string]강화 대상으로 사용할 수 있는 GS2-Inventory 인벤토리 모델의 GRN",
 "acquireExperienceSuffix": "[string]GS2-Experience에서 획득한 경험치를 저장하는 프로퍼티 ID에 부여하는 서픽스",
 "materialInventoryModelId": "[string]강화 소재로 사용할 수 있는 GS2-Inventory 인벤토리 모델 GRN",
 "acquireExperienceHierarchy": [
 "[string]ItemModel의 메타데이터에 저장할, 획득 경험치를 정의하는 JSON 데이터의 계층 구조 정의"
 ],
 "experienceModelId": "[string]강화 결과로 얻는 GS2-Experience 경험치 모델 GRN",
 "bonusRates": [
 {
 "rate": "[float]경험치 보너스 배율 (1.0 = 보너스 없음)",
 "weight": "[int]추첨 가중치"
 }
 ]
 }
 ],
 "unleashRateModels": [
 {
 "name": "[string]한계돌파 레이트 모델명",
 "description": "[string?]설명문",
 "metadata": "[string?]메타데이터",
 "targetInventoryModelId": "[string]한계돌파 대상에 사용할 수 있는 GS2-Inventory 인벤토리 모델 GRN",
 "gradeModelId": "[string]그레이드 모델 GRN",
 "gradeEntries": [
 {
 "gradeValue": "[long]대상 그레이드",
 "needCount": "[int]동일 종류의 아이템을 몇 개 소비할지"
 }
 ]
 }
 ]
}

	타입	필수	기본값	값 제한	설명
version	string	✓	2020-08-22		마스터 데이터 포맷 버전
rateModels	List<RateModel>			~ 10000 items	강화 레이트 모델 강화 레이트는 강화에 사용하는 소재와 강화 대상을 정의한 데이터입니다. 소재 데이터와 강화 대상 데이터는 모두 GS2-Inventory에서 관리되고 있어야 합니다. 강화로 얻는 경험치는 GS2-Inventory의 메타데이터에 JSON 형식으로 기록됩니다. 여기서는 메타데이터의 어느 계층에 경험치 값이 저장되어 있는지를 기재해야 합니다. 강화 시 일정 확률로 `대성공`과 같은 형태로 입수할 수 있는 경험치량에 보정값을 적용할 수 있습니다. 그 추첨 확률도 이 엔티티에서 정의합니다.
unleashRateModels	List<UnleashRateModel>			~ 10000 items	한계돌파 레이트 모델 아이템의 한계돌파(해방) 조건을 정의합니다. GS2-Inventory에서 관리되는 아이템과 GS2-Grade의 그레이드 모델을 연결하여 그레이드 진행을 가능하게 합니다. 각 그레이드 레벨에서 소비하는 동일 종류 아이템의 수를 개별적으로 설정할 수 있어, 각 한계돌파 단계의 비용을 세밀하게 제어할 수 있습니다.

모델

RateModel

강화 레이트 모델

GS2-Exchange 마스터 데이터 레퍼런스

Mon, 01 Jan 0001 00:00:00 +0000

마스터 데이터 포맷

{
 "version": "2019-08-19",
 "rateModels": [
 {
 "name": "[string]교환 레이트 모델 이름",
 "metadata": "[string?]메타데이터",
 "verifyActions": [
 {
 "action": "[string]검증 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 }
 ],
 "consumeActions": [
 {
 "action": "[string]소비 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 }
 ],
 "timingType": "[문자열 열거형]교환 종류",
 "lockTime": "[int]교환 실행부터 실제로 보상을 받을 수 있게 될 때까지의 대기 시간(분)",
 "acquireActions": [
 {
 "action": "[string]입수 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 }
 ]
 }
 ],
 "incrementalRateModels": [
 {
 "name": "[string]코스트 상승형 교환 레이트 모델의 이름",
 "metadata": "[string?]메타데이터",
 "consumeAction": {
 "action": "[string]소비 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 },
 "calculateType": "[문자열 열거형]코스트 상승량 계산 방식",
 "baseValue": "[long]베이스 값",
 "coefficientValue": "[long]계수",
 "calculateScriptId": "[string]코스트 계산 스크립트의 GRN",
 "exchangeCountId": "[string]교환 실행 횟수를 관리하는 GS2-Limit의 횟수 제한 모델 GRN",
 "maximumExchangeCount": "[int]교환 횟수 상한",
 "acquireActions": [
 {
 "action": "[string]입수 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 }
 ]
 }
 ]
}

	타입	필수	기본값	값 제한	설명
version	string	✓	2019-08-19		마스터 데이터 포맷 버전
rateModels	List<RateModel>			~ 10000 items	교환 레이트 모델 교환 레이트 모델은 리소스와 리소스를 교환할 때 사용하는 레이트를 정의하는 엔티티입니다. 즉시 교환할 수 있는 레이트뿐만 아니라, 현실 시간으로 일정 시간이 경과한 후에 교환할 수 있는 레이트도 설정할 수 있습니다. 현실 시간의 경과가 필요한 교환 레이트에는 즉시 교환을 실행하는 데 필요한 리소스를 추가로 정의할 수 있습니다.
incrementalRateModels	List<IncrementalRateModel>			~ 10000 items	코스트 상승형 교환 레이트 모델 일반적인 교환 레이트는 항상 일정한 레이트로 교환을 제공합니다. 상승형 교환 레이트에서는 교환 횟수에 따라 코스트가 상승하는 레이트를 정의할 수 있습니다. 예를 들어, 첫 번째 교환에서는 1:1로 교환할 수 있지만, 두 번째 교환에서는 2:1로 교환하게 되는 것과 같은 레이트를 정의할 수 있습니다. 이러한 레이트를 정의함으로써 플레이어가 게임을 진행함에 따라 얻을 수 있는 리소스의 가치를 높일 수 있습니다. 교환 횟수는 현실 시간의 경과에 따라 리셋할 수 있습니다. 이 기능을 이용하면 매일 또는 매주 교환에 필요한 코스트를 리셋할 수 있습니다.

모델

RateModel

교환 레이트 모델

GS2-Experience 마스터 데이터 레퍼런스

Mon, 01 Jan 0001 00:00:00 +0000

마스터 데이터 포맷

{
 "version": "2019-01-11",
 "experienceModels": [
 {
 "name": "[string]경험치 모델 이름",
 "metadata": "[string?]메타데이터",
 "defaultExperience": "[long]경험치 초기값",
 "defaultRankCap": "[long]랭크 캡 초기값",
 "maxRankCap": "[long]랭크 캡의 최댓값",
 "rankThreshold": {
 "metadata": "[string?]메타데이터",
 "values": [
 "[long]랭크업 경험치 임계값"
 ]
 },
 "acquireActionRates": [
 {
 "name": "[string]보상 가산 테이블 이름",
 "mode": "[string]보상 가산 테이블의 종류",
 "rates": [
 "[double]가산량(배율)"
 ],
 "bigRates": [
 "[string]가산량(배율)"
 ]
 }
 ]
 }
 ]
}

	타입	활성화 조건	필수	기본값	값 제한	설명
version	string		✓	2019-01-11		마스터 데이터 포맷 버전
experienceModels	List<ExperienceModel>				~ 100 items	경험치 모델 경험치와 랭크 시스템의 규칙을 정의합니다. 랭크업에 필요한 경험치의 임계값, 기본 랭크 캡, 최대 랭크 캡을 설정합니다. 랭크 캡은 스테이터스가 도달할 수 있는 최대 랭크를 제한하며, 스테이터스별로 최대 랭크 캡까지 인상할 수 있습니다(예: 한계돌파). 옵션으로 현재 랭크에 따라 보상 배율을 조정하는 입수 액션 레이트 테이블을 포함할 수 있습니다.

모델

ExperienceModel

경험치 모델

GS2-Formation 마스터 데이터 레퍼런스

Mon, 01 Jan 0001 00:00:00 +0000

마스터 데이터 포맷

{
 "version": "2019-09-09",
 "moldModels": [
 {
 "name": "[string]폼 저장 영역 모델의 이름",
 "metadata": "[string?]메타데이터",
 "initialMaxCapacity": "[int]폼을 저장할 수 있는 초기 캐파시티",
 "maxCapacity": "[int]폼을 저장할 수 있는 최대 캐파시티",
 "formModel": {
 "name": "[string]폼 모델명",
 "metadata": "[string?]메타데이터",
 "slots": [
 {
 "name": "[string]슬롯 모델명",
 "propertyRegex": "[string]프로퍼티로 설정 가능한 값의 정규 표현식",
 "metadata": "[string?]메타데이터"
 }
 ]
 }
 }
 ],
 "propertyFormModels": [
 {
 "name": "[string]프로퍼티 폼 모델 이름",
 "metadata": "[string?]메타데이터",
 "slots": [
 {
 "name": "[string]슬롯 모델명",
 "propertyRegex": "[string]프로퍼티로 설정 가능한 값의 정규 표현식",
 "metadata": "[string?]메타데이터"
 }
 ]
 }
 ]
}

	타입	필수	기본값	값 제한	설명
version	string	✓	2019-09-09		마스터 데이터 포맷 버전
moldModels	List<MoldModel>			~ 100 items	폼 저장 영역 모델 폼 저장 영역 모델은 파티 편성이라면 「불 속성 파티」「물 속성 파티」와 같은 형태로 저장하는 것을 상정하고 있습니다. 저장할 수 있는 영역의 수는 제한할 수 있으며, 개별적으로 확장할 수도 있습니다.
propertyFormModels	List<PropertyFormModel>			~ 100 items	프로퍼티 폼 모델 프로퍼티 폼 모델은 편성 상태를 나타내는 엔티티입니다. Mold / Form과의 차이점은, 슬롯 수를 정의하고 각 슬롯에 편성을 기록하는 것이 Mold / Form이며, 보유하고 있는 장비에 스킬을 설정하는 것처럼 수를 사전에 정하기 어려운 편성을 표현할 때 사용하는 것이 프로퍼티 폼 모델입니다.

모델

FormModel

폼 모델

GS2-Grade 마스터 데이터 레퍼런스

Mon, 01 Jan 0001 00:00:00 +0000

마스터 데이터 포맷

{
 "version": "2023-12-25",
 "gradeModels": [
 {
 "name": "[string]그레이드 모델 이름",
 "metadata": "[string?]메타데이터",
 "defaultGrades": [
 {
 "propertyIdRegex": "[string]프로퍼티 ID 정규 표현식",
 "defaultGradeValue": "[long]기본 그레이드 값"
 }
 ],
 "experienceModelId": "[string]GS2-Experience 경험치 모델 GRN",
 "gradeEntries": [
 {
 "metadata": "[string?]메타데이터",
 "rankCapValue": "[long]랭크 캡 값",
 "propertyIdRegex": "[string]프로퍼티 ID 정규 표현식",
 "gradeUpPropertyIdRegex": "[string]그레이드업용 프로퍼티 ID 정규 표현식"
 }
 ],
 "acquireActionRates": [
 {
 "name": "[string]보상 가산 테이블 이름",
 "mode": "[string]보상 가산 테이블 종류",
 "rates": [
 "[double]배율 값"
 ],
 "bigRates": [
 "[string]배율 값 (빅 넘버)"
 ]
 }
 ]
 }
 ]
}

	타입	활성화 조건	필수	기본값	값 제한	설명
version	string		✓	2023-12-25		마스터 데이터 포맷 버전
gradeModels	List<GradeModel>				~ 100 items	그레이드 모델 그레이드 모델이란 캐릭터나 장비의 랭크를 나타내는 엔티티로, 그레이드에 따라 GS2-Experience의 랭크 캡을 설정할 수 있습니다.

모델

GradeModel

그레이드 모델

GS2-Guild 마스터 데이터 레퍼런스

Mon, 01 Jan 0001 00:00:00 +0000

마스터 데이터 포맷

{
 "version": "2024-04-25",
 "guildModels": [
 {
 "name": "[string]길드 모델 이름",
 "metadata": "[string?]메타데이터",
 "defaultMaximumMemberCount": "[int]기본 최대 멤버 수",
 "maximumMemberCount": "[int]최대 멤버 수 상한",
 "inactivityPeriodDays": "[int]무활동 기간(일수)",
 "roles": [
 {
 "name": "[string]롤 모델 이름",
 "metadata": "[string?]메타데이터",
 "policyDocument": "[string]정책 문서"
 }
 ],
 "guildMasterRole": "[string]길드 마스터 롤 이름",
 "guildMemberDefaultRole": "[string]기본 멤버 롤 이름",
 "rejoinCoolTimeMinutes": "[int]재가입 쿨타임(분)",
 "maxConcurrentJoinGuilds": "[int?]동시 가입 가능 길드 최대 수",
 "maxConcurrentGuildMasterCount": "[int?]동시 존재 가능 길드 마스터 최대 수"
 }
 ]
}

	타입	활성화 조건	필수	기본값	값 제한	설명
version	string		✓	2024-04-25		마스터 데이터 포맷 버전
guildModels	List<GuildModel>				~ 100 items	길드 모델 길드 모델이란 길드에 가입 가능한 최대 인원수 설정 및 길드 내 직책별 권한 설정을 가지는 엔티티입니다.

모델

GuildModel

길드 모델

GS2-Idle 마스터 데이터 레퍼런스

Mon, 01 Jan 0001 00:00:00 +0000

마스터 데이터 포맷

{
 "version": "2023-06-06",
 "categoryModels": [
 {
 "name": "[string]카테고리 모델 이름",
 "metadata": "[string?]메타데이터",
 "rewardIntervalMinutes": "[int]보상 간격(분)",
 "defaultMaximumIdleMinutes": "[int]기본 최대 방치 시간(분)",
 "rewardResetMode": "[문자열 열거형]보상 리셋 모드",
 "acquireActions": [
 {
 "acquireActions": [
 {
 "action": "[string]입수 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 }
 ]
 }
 ],
 "idlePeriodScheduleId": "[string?]방치 기간 스케줄ID",
 "receivePeriodScheduleId": "[string?]수취 기간 스케줄ID"
 }
 ]
}

	타입	활성화 조건	필수	기본값	값 제한	설명
version	string		✓	2023-06-06		마스터 데이터 포맷 버전
categoryModels	List<CategoryModel>				~ 100 items	카테고리 모델 카테고리 모델이란, 방치 보상을 얻을 수 있는 대기 카테고리를 설정하는 엔티티입니다. 설정에는 대기 시간별 보상이나 최대 대기 시간 등의 정보가 포함됩니다.

모델

CategoryModel

카테고리 모델

GS2-Inbox 마스터 데이터 레퍼런스

Mon, 01 Jan 0001 00:00:00 +0000

마스터 데이터 포맷

{
 "version": "2020-03-12",
 "globalMessages": [
 {
 "name": "[string]글로벌 메시지 이름",
 "metadata": "[string]메타데이터",
 "readAcquireActions": [
 {
 "action": "[string]입수 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 }
 ],
 "expiresTimeSpan": {
 "days": "[int]일수",
 "hours": "[int]시간",
 "minutes": "[int]분"
 },
 "messageReceptionPeriodEventId": "[string?]메시지 수신 기간 이벤트 ID"
 }
 ]
}

	타입	활성화 조건	필수	기본값	값 제한	설명
version	string		✓	2020-03-12		마스터 데이터 포맷 버전
globalMessages	List<GlobalMessage>				~ 1000 items	글로벌 메시지 글로벌 메시지는 게임 플레이어 전체에게 메시지를 전달하는 구조입니다. 글로벌 메시지에는 유효 기간을 설정할 수 있으며, 각 게임 플레이어는 글로벌 메시지를 수신하는 처리를 실행함으로써 유효 기간 내의 글로벌 메시지 중 아직 수신하지 않은 메시지를 자신의 메시지함에 복사합니다.

모델

GlobalMessage

글로벌 메시지

GS2-Inventory 마스터 데이터 레퍼런스

Mon, 01 Jan 0001 00:00:00 +0000

마스터 데이터 포맷

{
 "version": "2019-02-05",
 "inventoryModels": [
 {
 "name": "[string]인벤토리 모델 이름",
 "metadata": "[string?]메타데이터",
 "initialCapacity": "[int]초기 크기",
 "maxCapacity": "[int]최대 크기",
 "protectReferencedItem": "[bool?]참조된 아이템 보호",
 "itemModels": [
 {
 "name": "[string]아이템 모델 이름",
 "metadata": "[string?]메타데이터",
 "stackingLimit": "[long]스택 가능한 최대 수량",
 "allowMultipleStacks": "[bool]복수 스택 허용",
 "sortValue": "[int]표시 순서"
 }
 ]
 }
 ],
 "simpleInventoryModels": [
 {
 "name": "[string]심플 인벤토리 모델 이름",
 "metadata": "[string?]메타데이터",
 "simpleItemModels": [
 {
 "name": "[string]심플 아이템 모델 이름",
 "metadata": "[string?]메타데이터"
 }
 ]
 }
 ],
 "bigInventoryModels": [
 {
 "name": "[string]거대 인벤토리 모델 이름",
 "metadata": "[string?]메타데이터",
 "bigItemModels": [
 {
 "name": "[string]거대 아이템 모델 이름",
 "metadata": "[string?]메타데이터"
 }
 ]
 }
 ]
}

	타입	필수	기본값	값 제한	설명
version	string	✓	2019-02-05		마스터 데이터 포맷 버전
inventoryModels	List<InventoryModel>			~ 50 items	인벤토리 모델 인벤토리는 게임 플레이어가 소유한 아이템을 담는 가방과 같은 것입니다. 인벤토리에는 용량을 설정할 수 있으며, 용량을 초과하여 소유할 수 없습니다.
simpleInventoryModels	List<SimpleInventoryModel>			~ 50 items	심플 인벤토리 모델 일반적인 InventoryModel에서는 인벤토리 안에 저장할 수 있는 아이템의 용량 제한을 설정할 수 있었습니다. 하지만 심플 인벤토리에는 그러한 기능이 없으며, 단순히 아이템의 소지 수량을 보유할 뿐입니다. 다만 심플 인벤토리에서는 여러 아이템의 증감 처리를 한 번의 처리로 실행할 수 있는 API를 사용할 수 있습니다.
bigInventoryModels	List<BigInventoryModel>			~ 50 items	거대 인벤토리 모델 일반적인 InventoryModel이나 SimpleInventoryModel에서는 인벤토리에 저장할 수 있는 아이템의 수가 int64 범위로 제한되었습니다. 인플레이션 계열 게임에서는 더 넓은 범위의 값이 필요한 경우가 있습니다. 거대 인벤토리 모델에서는 인벤토리에 저장할 수 있는 아이템의 수가 최대 1024자리의 정수값을 가질 수 있습니다.

모델

InventoryModel

인벤토리 모델

GS2-Limit 마스터 데이터 레퍼런스

Mon, 01 Jan 0001 00:00:00 +0000

마스터 데이터 포맷

{
 "version": "2019-04-05",
 "limitModels": [
 {
 "name": "[string]횟수 제한 모델명",
 "metadata": "[string?]메타데이터",
 "resetType": "[문자열 열거형]리셋 타이밍",
 "resetDayOfMonth": "[int]리셋 날짜",
 "resetDayOfWeek": "[문자열 열거형]리셋 요일",
 "resetHour": "[int]리셋 시각",
 "anchorTimestamp": "[long]경과 일수를 계산하는 기준 일시",
 "days": "[int]리셋 일수"
 }
 ]
}

	타입	활성화 조건	필수	기본값	값 제한	설명
version	string		✓	2019-04-05		마스터 데이터 포맷 버전
limitModels	List<LimitModel>				~ 100 items	횟수 제한 모델 횟수 제한 모델에는 사용 횟수를 리셋하는 타이밍을 설정할 수 있습니다. 리셋 간격은 “매일”, “매주”, “매월”, “리셋하지 않음”, “일정 일수마다” 5가지 중에서 선택할 수 있습니다. 또한, 횟수 제한의 최대값은 마스터 데이터 쪽에서는 고정하지 않습니다. 이는 게임 내 컨텍스트에 따라 허용되는 최대 횟수를 동적으로 변경할 수 있도록 하기 위함입니다. 예를 들어 스텝업 가챠처럼, - 구매 횟수 카운터가 3회 미만일 때 구매할 수 있는 상품 - 위 상품을 구매할 수 없을 때, 구매 횟수 카운터가 5회 미만이면 구매할 수 있는 다른 상품 과 같이, 상황에 따라 “최대 횟수"를 전환할 수 있는 설계를 상정하고 있습니다.

모델

LimitModel

횟수 제한 모델

GS2-LoginReward 마스터 데이터 레퍼런스

Mon, 01 Jan 0001 00:00:00 +0000

마스터 데이터 포맷

{
 "version": "2023-07-11",
 "bonusModels": [
 {
 "name": "[string]로그인 보너스 모델명",
 "metadata": "[string?]메타데이터",
 "mode": "[문자열 열거형]모드",
 "periodEventId": "[string?]기간 이벤트 GRN",
 "resetHour": "[int]리셋 시간(UTC)",
 "repeat": "[문자열 열거형]반복",
 "rewards": [
 {
 "acquireActions": [
 {
 "action": "[string]입수 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 }
 ]
 }
 ],
 "missedReceiveRelief": "[문자열 열거형]미수령 구제 기능",
 "missedReceiveReliefVerifyActions": [
 {
 "action": "[string]검증 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 }
 ],
 "missedReceiveReliefConsumeActions": [
 {
 "action": "[string]소비 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 }
 ]
 }
 ]
}

	타입	활성화 조건	필수	기본값	값 제한	설명
version	string		✓	2023-07-11		마스터 데이터 포맷 버전
bonusModels	List<BonusModel>				~ 100 items	로그인 보너스 모델 로그인 보너스 모델에는 로그인 보너스의 배포 스케줄을 설정합니다. 배포 스케줄에는 《스케줄 모드》와 《스트리밍 모드》가 있습니다. 스케줄 모드에서는 GS2-Schedule의 이벤트 지정이 필수이며, 해당 이벤트의 시작일로부터 경과한 일수에 따라 보너스를 배포합니다. 도중에 놓친 날짜가 발생한 경우, 그 날의 보너스는 배포되지 않습니다. 스트리밍 모드에서는 매일 보너스에 설정된 보상을 처음부터 순서대로 배포합니다. 스트리밍 모드에서는 반복 설정이 가능합니다. 이 경우 스트림의 끝에 도달하면 다시 처음부터 배포를 시작합니다. 스케줄 모드·스트리밍 모드 모두 미수령 구제 기능이 있습니다. 일정한 비용을 지불함으로써 놓친 보너스를 수령할 수 있습니다. 단, GS2-Schedule의 이벤트가 연결되어 있는 경우, 이벤트 시작일로부터 경과한 일수보다 앞선 보너스는 받을 수 없습니다. 미수령 구제 기능은 스트리밍 모드이면서 반복이 활성화된 경우에는 사용할 수 없습니다. 스케줄 모드·스트리밍 모드 모두, 설정 가능한 보너스의 최대 일수는 100일입니다.

모델

BonusModel

로그인 보너스 모델

GS2-Lottery 마스터 데이터 레퍼런스

Mon, 01 Jan 0001 00:00:00 +0000

마스터 데이터 포맷

{
 "version": "2019-02-21",
 "lotteryModels": [
 {
 "name": "[string]추첨 모델 이름",
 "metadata": "[string?]메타데이터",
 "mode": "[문자열 열거형]추첨 모드",
 "method": "[문자열 열거형]추첨 방법",
 "prizeTableName": "[string]배출 확률 테이블 이름",
 "choicePrizeTableScriptId": "[string]배출 확률 테이블을 결정하는 GS2-Script의 스크립트 GRN"
 }
 ],
 "prizeTables": [
 {
 "name": "[string]배출 확률 테이블 이름",
 "metadata": "[string?]메타데이터",
 "prizes": [
 {
 "prizeId": "[string]경품 ID",
 "type": "[string]경품 종류",
 "acquireActions": [
 {
 "action": "[string]입수 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 }
 ],
 "drawnLimit": "[int?]최대 배출 수",
 "limitFailOverPrizeId": "[string]제한 시 페일오버 경품 ID",
 "prizeTableName": "[string]배출 확률 테이블의 이름",
 "weight": "[int]배출 가중치"
 }
 ]
 }
 ]
}

	타입	필수	기본값	값 제한	설명
version	string	✓	2019-02-21		마스터 데이터 포맷 버전
lotteryModels	List<LotteryModel>			~ 100 items	추첨 모델 추첨 모델은 배출 방식과 배출 테이블의 참조 방법을 정의하는 엔티티입니다. 배출 방식은 2종류가 마련되어 있으며, 일반 추첨은 매번 일정한 확률로 추첨하는 방식이고, 박스 추첨은 상자 안에 미리 정해진 수량의 경품이 들어 있어 추첨할 때마다 상자에서 경품을 꺼내는 추첨 방식입니다. 추첨 처리를 수행할 때 배출 확률 테이블을 사용하는데, GS2-Script를 사용하면 여러 번 추첨을 실행할 때 배출 확률 테이블 일부만 다른 테이블로 교체할 수 있습니다. 이 구조를 이용하면 10연 가챠에서 1회만 다른 추첨 확률 테이블을 적용하는 것이 가능해집니다.
prizeTables	List<PrizeTable>			~ 100 items	배출 확률 테이블 경품에는 입수 액션을 직접 지정하거나, 다른 배출 확률 테이블을 참조하도록 설정할 수도 있습니다. 배출 확률 테이블을 중첩시키면, 예를 들어 1단계에서 SSR / SR / R 등의 레어도를 추첨하고, 2단계에서 해당 레어도에 대응하는 구체적인 콘텐츠를 추첨하는 등의 설정이 가능합니다. 이 구조를 통해 게임 전체의 레어도별 배출 확률을 관리하고 조정하기가 더 쉬워집니다.

모델

PrizeTable

배출 확률 테이블

GS2-Matchmaking 마스터 데이터 레퍼런스

Mon, 01 Jan 0001 00:00:00 +0000

마스터 데이터 포맷

{
 "version": "2020-06-24",
 "ratingModels": [
 {
 "name": "[string]레이팅 모델 이름",
 "metadata": "[string?]메타데이터",
 "initialValue": "[int]레이트 값의 초기값",
 "volatility": "[int]레이팅의 변동성"
 }
 ],
 "seasonModels": [
 {
 "name": "[string]시즌 모델 이름",
 "metadata": "[string?]메타데이터",
 "maximumParticipants": "[int]최대 참가 인원수",
 "experienceModelId": "[string?]티어 관리용 경험치 모델 GRN",
 "challengePeriodEventId": "[string]챌린지 기간 이벤트 GRN"
 }
 ]
}

	타입	필수	기본값	값 제한	설명
version	string	✓	2020-06-24		마스터 데이터 포맷 버전
ratingModels	List<RatingModel>			~ 50 items	레이팅 모델 GS2에서는 레이팅 알고리즘으로 Glicko-2를 채택하고 있습니다. Glicko-2에는 여러 파라미터가 있지만, GS2-Matchmaking에서는 이를 종합적으로 나타내는 변동성이라는 하나의 파라미터로 통합하고 있습니다. 변동성은 변화의 크기를 나타내는 파라미터로, 값이 클수록 레이팅 값의 변동 폭이 커집니다.
seasonModels	List<SeasonModel>			~ 50 items	시즌 모델 시즌 매치메이킹에서, 일정 기간 동안 유효한 영속 개더링의 기간·최대 참가 인원수·티어 연동 설정을 정의하는 마스터 데이터입니다. GS2-Schedule을 통해 기간을 관리하며, 필요에 따라 GS2-Experience와 연동하여 동일한 티어 내에서 영속 개더링을 형성합니다.

모델

RatingModel

레이팅 모델

GS2-MegaField 마스터 데이터 레퍼런스

Mon, 01 Jan 0001 00:00:00 +0000

마스터 데이터 포맷

{
 "version": "2022-08-28",
 "areaModels": [
 {
 "name": "[string]에어리어 모델 이름",
 "metadata": "[string?]메타데이터",
 "layerModels": [
 {
 "name": "[string]레이어 모델 이름",
 "metadata": "[string?]메타데이터"
 }
 ]
 }
 ]
}

	타입	활성화 조건	필수	기본값	값 제한	설명
version	string		✓	2022-08-28		마스터 데이터 포맷 버전
areaModels	List<AreaModel>				~ 50 items	에어리어는 공간을 분할하는 것으로, 같은 좌표라도 에어리어가 다르면 별도의 공간으로 취급할 수 있습니다.

모델

AreaModel

에어리어는 공간을 분할하는 것으로, 같은 좌표라도 에어리어가 다르면 별도의 공간으로 취급할 수 있습니다.

GS2-Mission 마스터 데이터 레퍼런스

Mon, 01 Jan 0001 00:00:00 +0000

마스터 데이터 포맷

{
 "version": "2019-05-28",
 "groups": [
 {
 "name": "[string]미션 그룹 모델 이름",
 "metadata": "[string?]메타데이터",
 "tasks": [
 {
 "name": "[string]미션 태스크 모델 이름",
 "metadata": "[string?]메타데이터",
 "verifyCompleteType": "[string]달성 조건 종류",
 "targetCounter": {
 "counterName": "[string]카운터 모델명",
 "scopeType": "[string]스코프 종류",
 "resetType": "[string?]목표 리셋 타이밍",
 "conditionName": "[string]조건 이름",
 "value": "[long]목표값"
 },
 "verifyCompleteConsumeActions": [
 {
 "action": "[string]검증 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 }
 ],
 "completeAcquireActions": [
 {
 "action": "[string]입수 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 }
 ],
 "challengePeriodEventId": "[string?]보상을 받을 수 있는 기간을 설정한 GS2-Schedule 이벤트 GRN",
 "premiseMissionTaskName": "[string?]이 태스크에 도전하기 위해 달성해 두어야 하는 태스크의 이름",
 "counterName": "[string]카운터 모델명",
 "targetResetType": "[string?]목표 리셋 타이밍",
 "targetValue": "[long]목표값"
 }
 ],
 "resetType": "[문자열 열거형]리셋 타이밍",
 "resetDayOfMonth": "[int]리셋하는 날짜",
 "resetDayOfWeek": "[문자열 열거형]리셋하는 요일",
 "resetHour": "[int]리셋 시각",
 "completeNotificationNamespaceId": "[string?]미션 태스크를 달성했을 때의 푸시 통지",
 "anchorTimestamp": "[long]경과 일수를 계산하는 기준 일시",
 "days": "[int]리셋하는 일수"
 }
 ],
 "counters": [
 {
 "name": "[string]카운터 모델명",
 "metadata": "[string?]메타데이터",
 "scopes": [
 {
 "scopeType": "[string]스코프의 종류",
 "resetType": "[string]리셋 타이밍",
 "resetDayOfMonth": "[int]리셋할 날짜",
 "resetDayOfWeek": "[string]리셋할 요일",
 "resetHour": "[int]리셋 시각",
 "conditionName": "[string]조건명",
 "condition": {
 "action": "[string]검증 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 },
 "anchorTimestamp": "[long]경과 일수를 계산하는 기준 일시",
 "days": "[int]리셋하는 일수"
 }
 ],
 "challengePeriodEventId": "[string?]카운터를 조작할 수 있는 기간을 설정한 GS2-Schedule 이벤트 GRN"
 }
 ]
}

	타입	필수	기본값	값 제한	설명
version	string	✓	2019-05-28		마스터 데이터 포맷 버전
groups	List<MissionGroupModel>			~ 20 items	미션 그룹 모델 미션 그룹은 카운터의 리셋 타이밍으로 태스크를 그룹화하는 엔티티입니다. 예를 들어, 데일리 미션으로 하나의 그룹, 위클리 미션으로 하나의 그룹이 됩니다.
counters	List<CounterModel>			~ 1000 items	카운터 모델 카운터 모델은 미션 태스크의 달성 조건으로 설정할 수 있는 엔티티입니다. 카운터 값은 여러 미션 그룹에서 참조할 수 있기 때문에, 하나의 카운터를 위클리 미션과 데일리 미션 같은 여러 미션 그룹의 달성 조건으로 설정할 수 있습니다.

모델

CounterModel

카운터 모델

GS2-Money2 마스터 데이터 레퍼런스

Mon, 01 Jan 0001 00:00:00 +0000

마스터 데이터 포맷

{
 "version": "2024-06-20",
 "storeContentModels": [
 {
 "name": "[string]스토어 콘텐츠 모델 이름",
 "metadata": "[string?]메타데이터",
 "appleAppStore": {
 "productId": "[string?]프로덕트 ID"
 },
 "googlePlay": {
 "productId": "[string?]프로덕트 ID"
 }
 }
 ],
 "storeSubscriptionContentModels": [
 {
 "name": "[string]스토어 구독 콘텐츠 모델 이름",
 "metadata": "[string?]메타데이터",
 "scheduleNamespaceId": "[string]구독 기간을 연동시킬 GS2-Schedule의 네임스페이스 GRN",
 "triggerName": "[string]구독 기간을 반영하는 트리거 이름",
 "triggerExtendMode": "[문자열 열거형]구독 기간을 트리거에 반영할 때의 모드",
 "rollupHour": "[int]날짜 변경 시각(UTC)",
 "reallocateSpanDays": "[int]구독 계약 정보를 다른 사용자에게 할당할 수 있게 되는 기간(일)",
 "appleAppStore": {
 "subscriptionGroupIdentifier": "[string?]구독 그룹 ID"
 },
 "googlePlay": {
 "productId": "[string?]프로덕트 ID"
 }
 }
 ]
}

	타입	필수	기본값	값 제한	설명
version	string	✓	2024-06-20		마스터 데이터 포맷 버전
storeContentModels	List<StoreContentModel>			~ 1000 items	스토어 콘텐츠 모델 다양한 스토어 플랫폼의 콘텐츠를 저장하는 모델입니다.
storeSubscriptionContentModels	List<StoreSubscriptionContentModel>			~ 1000 items	스토어 구독 콘텐츠 모델 다양한 스토어 플랫폼의 구독 콘텐츠를 저장하는 모델입니다.

모델

StoreContentModel

스토어 콘텐츠 모델

GS2-Quest 마스터 데이터 레퍼런스

Mon, 01 Jan 0001 00:00:00 +0000

마스터 데이터 포맷

{
 "version": "2019-05-14",
 "groups": [
 {
 "name": "[string]퀘스트 그룹 모델 이름",
 "metadata": "[string?]메타데이터",
 "quests": [
 {
 "name": "[string]퀘스트 모델 이름",
 "metadata": "[string?]메타데이터",
 "contents": [
 {
 "metadata": "[string?]메타데이터",
 "completeAcquireActions": [
 {
 "action": "[string]입수 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 }
 ],
 "weight": "[int]추첨 가중치"
 }
 ],
 "challengePeriodEventId": "[string?]도전 가능 기간 이벤트 GRN",
 "firstCompleteAcquireActions": [
 {
 "action": "[string]입수 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 }
 ],
 "verifyActions": [
 {
 "action": "[string]검증 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 }
 ],
 "consumeActions": [
 {
 "action": "[string]소비 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 }
 ],
 "failedAcquireActions": [
 {
 "action": "[string]입수 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 }
 ],
 "premiseQuestNames": [
 "[string]퀘스트 모델 이름"
 ]
 }
 ],
 "challengePeriodEventId": "[string?]도전 가능 기간 이벤트 GRN"
 }
 ]
}

	타입	활성화 조건	필수	기본값	값 제한	설명
version	string		✓	2019-05-14		마스터 데이터 포맷 버전
groups	List<QuestGroupModel>				~ 10 items	퀘스트 그룹 모델 퀘스트 그룹은 여러 퀘스트를 그룹화하기 위한 엔티티로, 퀘스트 진행은 그룹 내에서 동시에 하나만 실행할 수 있습니다. 즉, 퀘스트를 병렬로 진행할 수 있도록 하려면 그룹을 분리해야 합니다.

모델

QuestGroupModel

퀘스트 그룹 모델

GS2-Ranking 마스터 데이터 레퍼런스

Mon, 01 Jan 0001 00:00:00 +0000

마스터 데이터 포맷

{
 "version": "2019-09-17",
 "categories": [
 {
 "name": "[string]카테고리 모델 이름",
 "metadata": "[string?]메타데이터",
 "minimumValue": "[long?]점수 최솟값",
 "maximumValue": "[long?]점수 최댓값",
 "sum": "[bool]합산 모드",
 "orderDirection": "[문자열 열거형]정렬 방향",
 "scope": "[문자열 열거형]랭킹 종류",
 "globalRankingSetting": {
 "uniqueByUserId": "[bool]사용자 ID별 유니크",
 "calculateIntervalMinutes": "[int]집계 간격(분)",
 "calculateFixedTiming": {
 "hour": "[int?]시",
 "minute": "[int?]분"
 },
 "additionalScopes": [
 {
 "name": "[string]스코프 이름",
 "targetDays": "[long]집계 대상 일수"
 }
 ],
 "ignoreUserIds": [
 "[string]랭킹에 반영하지 않을 사용자 ID"
 ],
 "generation": "[string?]세대"
 },
 "entryPeriodEventId": "[string?]점수 등록 기간 이벤트 ID",
 "accessPeriodEventId": "[string?]접근 기간 이벤트 ID"
 }
 ]
}

	타입	활성화 조건	필수	기본값	값 제한	설명
version	string		✓	2019-09-17		마스터 데이터 포맷 버전
categories	List<CategoryModel>				~ 1000 items	카테고리 모델 카테고리마다 서로 다른 랭킹을 생성할 수 있습니다. 카테고리에는 등록 가능한 스코어의 최소값·최대값을 설정할 수 있으며, 해당 범위를 벗어나는 스코어는 폐기됩니다. 랭킹을 집계할 때 스코어가 작은 것을 상위(오름차순)로 할지, 큰 것을 상위(내림차순)로 할지를 설정할 수 있습니다. 랭킹의 종류로 `글로벌`과 `스코프`를 선택할 수 있습니다. 글로벌은 모든 플레이어가 동일한 결과를 참조하는 것이며, 스코프는 친구 내 랭킹이나 길드 내 랭킹처럼 게임 플레이어마다 결과가 다른 랭킹입니다. 글로벌 랭킹은 카테고리별로 랭킹 집계 간격을 15분~24시간으로 설정할 수 있습니다. 스코프 랭킹은 실시간으로 집계 결과가 반영됩니다. 랭킹 데이터에는 세대라는 설정이 있으며, 세대를 변경함으로써 등록된 스코어를 리셋할 수 있습니다.

모델

CategoryModel

카테고리 모델

GS2-Ranking2 마스터 데이터 레퍼런스

Mon, 01 Jan 0001 00:00:00 +0000

마스터 데이터 포맷

{
 "version": "2024-05-30",
 "globalRankingModels": [
 {
 "name": "[string]글로벌 랭킹 모델 이름",
 "metadata": "[string?]메타데이터",
 "minimumValue": "[long?]스코어 최솟값",
 "maximumValue": "[long?]스코어 최댓값",
 "sum": "[bool]스코어 합산",
 "orderDirection": "[문자열 열거형]정렬 방향",
 "entryPeriodEventId": "[string?]스코어 등록 가능 기간 이벤트 GRN",
 "rankingRewards": [
 {
 "thresholdRank": "[int]순위 임계값",
 "metadata": "[string?]메타데이터",
 "acquireActions": [
 {
 "action": "[string]입수 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 }
 ]
 }
 ],
 "accessPeriodEventId": "[string?]랭킹 데이터 접근 가능 기간 이벤트 GRN",
 "rewardCalculationIndex": "[문자열 열거형]보상 계산 인덱스"
 }
 ],
 "clusterRankingModels": [
 {
 "name": "[string]클러스터 랭킹 모델 이름",
 "metadata": "[string?]메타데이터",
 "clusterType": "[문자열 열거형]클러스터 타입",
 "minimumValue": "[long?]최소 점수",
 "maximumValue": "[long?]최대 점수",
 "sum": "[bool]점수 합산",
 "orderDirection": "[문자열 열거형]정렬 방향",
 "entryPeriodEventId": "[string?]스코어 등록 가능 기간 이벤트 GRN",
 "rankingRewards": [
 {
 "thresholdRank": "[int]순위 임계값",
 "metadata": "[string?]메타데이터",
 "acquireActions": [
 {
 "action": "[string]입수 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 }
 ]
 }
 ],
 "accessPeriodEventId": "[string?]랭킹 데이터 접근 가능 기간 이벤트 GRN",
 "rewardCalculationIndex": "[문자열 열거형]보상 계산 인덱스"
 }
 ],
 "subscribeRankingModels": [
 {
 "name": "[string]구독 랭킹 모델 이름",
 "metadata": "[string?]메타데이터",
 "minimumValue": "[long?]최소 점수",
 "maximumValue": "[long?]최대 점수",
 "sum": "[bool]점수 합산",
 "orderDirection": "[문자열 열거형]정렬 방향",
 "entryPeriodEventId": "[string?]스코어 등록 가능 기간 이벤트 GRN",
 "accessPeriodEventId": "[string?]랭킹 데이터 접근 가능 기간 이벤트 GRN"
 }
 ]
}

	타입	필수	기본값	값 제한	설명
version	string	✓	2024-05-30		마스터 데이터 포맷 버전
globalRankingModels	List<GlobalRankingModel>			~ 10 items	글로벌 랭킹 모델 글로벌 랭킹은 모든 플레이어를 대상으로 한 랭킹을 구현하기 위한 모델입니다. 상위 1000위까지의 랭킹을 표시할 수 있습니다. GS2-Schedule의 반복 이벤트와 연결하면 반복 횟수에 따라 랭킹을 초기화할 수 있습니다.
clusterRankingModels	List<ClusterRankingModel>			~ 10 items	클러스터 랭킹 모델 클러스터 랭킹은 길드나 게더링 내의 플레이어를 대상으로 하는 랭킹을 구현하기 위한 모델입니다. 상위 1000위까지의 랭킹을 표시할 수 있습니다. GS2-Schedule의 반복 이벤트와 연동하면 반복 횟수에 따라 랭킹을 초기화할 수 있습니다.
subscribeRankingModels	List<SubscribeRankingModel>			~ 10 items	구독 랭킹 모델 구독한 다른 플레이어의 점수를 집계하여 랭킹을 작성하는 모델입니다.

모델

GlobalRankingModel

글로벌 랭킹 모델

GS2-Schedule 마스터 데이터 레퍼런스

Mon, 01 Jan 0001 00:00:00 +0000

마스터 데이터 포맷

{
 "version": "2019-03-31",
 "events": [
 {
 "name": "[string]이벤트 이름",
 "metadata": "[string?]메타데이터",
 "scheduleType": "[문자열 열거형]스케줄 타입",
 "absoluteBegin": "[long?]절대 시작 일시",
 "absoluteEnd": "[long?]절대 종료 일시",
 "relativeTriggerName": "[string]이벤트 시작 트리거 이름",
 "repeatSetting": {
 "repeatType": "[string]반복 종류",
 "beginDayOfMonth": "[int]반복 시작일",
 "endDayOfMonth": "[int]반복 종료일",
 "beginDayOfWeek": "[string]반복 시작 요일",
 "endDayOfWeek": "[string]반복 종료 요일",
 "beginHour": "[int]반복 시작 시각(시)",
 "endHour": "[int]반복 종료 시각(시)",
 "anchorTimestamp": "[long]기준 타임스탬프",
 "activeDays": "[int]활성 일수",
 "inactiveDays": "[int]비활성 일수"
 }
 }
 ]
}

	타입	활성화 조건	필수	기본값	값 제한	설명
version	string		✓	2019-03-31		마스터 데이터 포맷 버전
events	List<Event>				~ 100 items	이벤트 이벤트의 기간에는 절대 기간과 상대 기간의 2가지 종류가 있습니다. 절대 기간은 예를 들어 YYYY년 MM월 DD일 00:00(UTC) ~ YYYY년 MM월 DD일 23:59(UTC)와 같은 고정된 기간이며, 상대 기간은 트리거를 당긴 시점부터 24시간과 같이 게임 플레이어마다 다른 기간을 이벤트 기간으로 하는 것입니다. 이벤트에는 개최 기간뿐만 아니라 반복도 설정할 수 있게 되어 있어 이벤트 기간 중 월요일 10:00 ~ 11:00만을 이벤트 기간으로 하는 설정도 가능합니다.

모델

Event

이벤트

GS2-SeasonRating 마스터 데이터 레퍼런스

Mon, 01 Jan 0001 00:00:00 +0000

마스터 데이터 포맷

{
 "version": "2024-02-23",
 "seasonModels": [
 {
 "name": "[string]시즌 모델 이름",
 "metadata": "[string?]메타데이터",
 "tiers": [
 {
 "metadata": "[string?]메타데이터",
 "raiseRankBonus": "[int]랭크 승급 보너스",
 "entryFee": "[int]참가료",
 "minimumChangePoint": "[int]최소 변동 포인트",
 "maximumChangePoint": "[int]최대 변동 포인트"
 }
 ],
 "experienceModelId": "[string]경험치 모델 ID",
 "challengePeriodEventId": "[string?]챌린지 기간 이벤트 ID"
 }
 ]
}

	타입	활성화 조건	필수	기본값	값 제한	설명
version	string		✓	2024-02-23		마스터 데이터 포맷 버전
seasonModels	List<SeasonModel>				~ 50 items	시즌 모델 시즌 기간 동안 적용되는 티어 구조와 포인트 변동 규칙을 정의하는 마스터 데이터입니다. 각 티어별 포인트 변동 범위·참가료·랭크업 보너스를 설정하고, 포인트 관리에 사용할 Experience 모델을 지정합니다. 실제 포인트 및 티어의 사용자 데이터는 GS2-Experience에 의해 관리됩니다.

모델

SeasonModel

시즌 모델

GS2-SerialKey 마스터 데이터 레퍼런스

Mon, 01 Jan 0001 00:00:00 +0000

마스터 데이터 포맷

{
 "version": "2022-09-13",
 "campaignModels": [
 {
 "name": "[string]캠페인 모델 이름",
 "metadata": "[string?]메타데이터",
 "enableCampaignCode": "[bool]캠페인 코드에 의한 교환을 허용할지 여부"
 }
 ]
}

	타입	활성화 조건	필수	기본값	값 제한	설명
version	string		✓	2022-09-13		마스터 데이터 포맷 버전
campaignModels	List<CampaignModel>				~ 1000 items	캠페인 모델 캠페인 모델은 캠페인을 정의하고 시리얼 코드와 연결하여 관리하는 데 사용됩니다.

모델

CampaignModel

캠페인 모델

GS2-Showcase 마스터 데이터 레퍼런스

Mon, 01 Jan 0001 00:00:00 +0000

마스터 데이터 포맷

{
 "version": "2019-04-04",
 "showcases": [
 {
 "name": "[string]진열대 이름",
 "metadata": "[string?]메타데이터",
 "salesPeriodEventId": "[string?]진열대의 판매 기간을 설정한 GS2-Schedule 이벤트 GRN",
 "displayItems": [
 {
 "displayItemId": "[string]진열 상품 ID",
 "type": "[string]종류",
 "salesItem": {
 "name": "[string]상품 이름",
 "metadata": "[string?]메타데이터",
 "verifyActions": [
 {
 "action": "[string]검증 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 }
 ],
 "consumeActions": [
 {
 "action": "[string]소비 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 }
 ],
 "acquireActions": [
 {
 "action": "[string]입수 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 }
 ]
 },
 "salesItemGroup": {
 "name": "[string]상품 그룹 이름",
 "metadata": "[string?]메타데이터",
 "salesItems": [
 {
 "name": "[string]상품 이름",
 "metadata": "[string?]메타데이터",
 "verifyActions": [
 {
 "action": "[string]검증 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 }
 ],
 "consumeActions": [
 {
 "action": "[string]소비 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 }
 ],
 "acquireActions": [
 {
 "action": "[string]입수 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 }
 ]
 }
 ]
 },
 "salesPeriodEventId": "[string?]이 진열 상품의 판매 기간을 설정한 GS2-Schedule의 이벤트 GRN"
 }
 ]
 }
 ],
 "randomShowcases": [
 {
 "name": "[string]랜덤 진열대 이름",
 "metadata": "[string?]메타데이터",
 "maximumNumberOfChoice": "[int]선택되는 상품의 최대 수",
 "displayItems": [
 {
 "name": "[string]랜덤 진열 상품 ID",
 "metadata": "[string?]메타데이터",
 "verifyActions": [
 {
 "action": "[string]검증 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 }
 ],
 "consumeActions": [
 {
 "action": "[string]소비 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 }
 ],
 "acquireActions": [
 {
 "action": "[string]입수 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 }
 ],
 "stock": "[int]재고 수",
 "weight": "[int]추첨 가중치"
 }
 ],
 "baseTimestamp": "[long]진열 상품 재추첨 기준 시간",
 "resetIntervalHours": "[int]진열 상품을 재추첨하는 간격(시간)",
 "salesPeriodEventId": "[string?]진열대의 판매 기간을 설정한 GS2-Schedule의 이벤트 GRN"
 }
 ]
}

	타입	필수	기본값	값 제한	설명
version	string	✓	2019-04-04		마스터 데이터 포맷 버전
showcases	List<Showcase>			~ 100 items	진열대 `진열대`에는 진열할 상품을 정의할 수 있습니다. 또한 `진열대`의 상품 판매 기간을 설정할 수 있습니다.
randomShowcases	List<RandomShowcase>			~ 100 items	랜덤 진열대 랜덤 진열대는 지정한 주기로 교체되는, 랜덤으로 선별된 상품이 진열되는 진열대 모델입니다. 선별되는 상품은 상품 풀에 등록된 상품 중에서 지정된 수량이 상품별로 설정된 가중치에 기반하여 랜덤으로 선택됩니다. 랜덤 진열대에는 GS2-Schedule의 이벤트를 연결하여 판매 기간을 설정할 수 있습니다.

모델

Showcase

진열대

GS2-SkillTree 마스터 데이터 레퍼런스

Mon, 01 Jan 0001 00:00:00 +0000

마스터 데이터 포맷

{
 "version": "2023-09-06",
 "nodeModels": [
 {
 "name": "[string]노드 모델명",
 "metadata": "[string?]메타데이터",
 "releaseVerifyActions": [
 {
 "action": "[string]검증 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 }
 ],
 "releaseConsumeActions": [
 {
 "action": "[string]소비 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 }
 ],
 "returnAcquireActions": [
 {
 "action": "[string]입수 액션에서 실행할 액션의 종류",
 "request": "[string]액션 실행 시 사용되는 요청의 JSON 문자열"
 }
 ],
 "restrainReturnRate": "[float]반환율",
 "premiseNodeNames": [
 "[string]노드 모델명"
 ]
 }
 ]
}

	타입	활성화 조건	필수	기본값	값 제한	설명
version	string		✓	2023-09-06		마스터 데이터 포맷 버전
nodeModels	List<NodeModel>				~ 1000 items	노드 모델 스킬 트리 내의 노드를 정의하는 모델로, 해방 비용·전제 조건·반환 동작을 포함합니다. 각 노드에는 검증 액션(해방 전 조건 확인), 소비 액션(지불할 비용), 먼저 해방되어야 하는 전제 노드를 설정할 수 있습니다. 노드를 구속(미해방 상태로 되돌림)하면, 소비한 리소스가 반환율에 따라 부분적으로 반환됩니다. 반환 입수 액션은 소비 액션에 반환율을 곱하여 자동으로 계산됩니다.

모델

NodeModel

노드 모델

GS2-Stamina 마스터 데이터 레퍼런스

Mon, 01 Jan 0001 00:00:00 +0000

마스터 데이터 포맷

{
 "version": "2019-02-14",
 "staminaModels": [
 {
 "name": "[string]스태미나 모델 이름",
 "metadata": "[string?]메타데이터",
 "recoverIntervalMinutes": "[int]회복 간격(분)",
 "recoverValue": "[int]회복량",
 "initialCapacity": "[int]최대값의 초기값",
 "isOverflow": "[bool]오버플로우 가능 여부",
 "maxCapacity": "[int]오버플로우 시 최대값",
 "maxStaminaTable": {
 "name": "[string]스태미나 최대값 테이블 이름",
 "metadata": "[string?]메타데이터",
 "experienceModelId": "[string]경험치 모델 ID",
 "values": [
 "[int]스태미나 최대값"
 ]
 },
 "recoverIntervalTable": {
 "name": "[string]회복 간격 테이블 이름",
 "metadata": "[string?]메타데이터",
 "experienceModelId": "[string]경험치 모델 ID",
 "values": [
 "[int?]스태미나 회복 간격(분)"
 ]
 },
 "recoverValueTable": {
 "name": "[string]스태미나 회복량 테이블 이름",
 "metadata": "[string?]메타데이터",
 "experienceModelId": "[string]경험치 모델 ID",
 "values": [
 "[int?]스태미나 회복량"
 ]
 }
 }
 ]
}

	타입	활성화 조건	필수	기본값	값 제한	설명
version	string		✓	2019-02-14		마스터 데이터 포맷 버전
staminaModels	List<StaminaModel>				~ 100 items	스태미나 모델 스태미나의 최대값, 회복 간격, 회복량과 같은 파라미터를 정의할 수 있습니다. GS2-Experience와 연동하여 최대값이나 회복량을 제어할 수도 있습니다.

모델

StaminaModel

스태미나 모델

GS2-Version 마스터 데이터 레퍼런스

Mon, 01 Jan 0001 00:00:00 +0000

마스터 데이터 포맷

{
 "version": "2019-10-09",
 "versionModels": [
 {
 "name": "[string]버전 모델 이름",
 "metadata": "[string?]메타데이터",
 "scope": "[문자열 열거형]판정에 사용할 버전 값의 종류",
 "type": "[문자열 열거형]버전 체크 모드",
 "currentVersion": {
 "major": "[int]메이저 버전",
 "minor": "[int]마이너 버전",
 "micro": "[int]마이크로 버전"
 },
 "warningVersion": {
 "major": "[int]메이저 버전",
 "minor": "[int]마이너 버전",
 "micro": "[int]마이크로 버전"
 },
 "errorVersion": {
 "major": "[int]메이저 버전",
 "minor": "[int]마이너 버전",
 "micro": "[int]마이크로 버전"
 },
 "scheduleVersions": [
 {
 "currentVersion": {
 "major": "[int]메이저 버전",
 "minor": "[int]마이너 버전",
 "micro": "[int]마이크로 버전"
 },
 "warningVersion": {
 "major": "[int]메이저 버전",
 "minor": "[int]마이너 버전",
 "micro": "[int]마이크로 버전"
 },
 "errorVersion": {
 "major": "[int]메이저 버전",
 "minor": "[int]마이너 버전",
 "micro": "[int]마이크로 버전"
 },
 "scheduleEventId": "[string?]버전 체크를 활성화하는 GS2-Schedule 이벤트 GRN"
 }
 ],
 "needSignature": "[bool]판정할 버전 값에 서명 검증이 필요한지 여부",
 "signatureKeyId": "[string]암호화 키 GRN",
 "approveRequirement": "[문자열 열거형]승인 필요 여부"
 }
 ]
}

	타입	활성화 조건	필수	기본값	값 제한	설명
version	string		✓	2019-10-09		마스터 데이터 포맷 버전
versionModels	List<VersionModel>				~ 100 items	버전 모델 버전 모델에는 로그인은 허용하지만 버전 업그레이드가 가능함을 알리는 경고 버전과, 로그인을 허용하지 않는 에러 버전을 설정할 수 있습니다. 현재 버전을 클라이언트에 신고하도록 할 때, 서명 유무를 지정할 수 있습니다. 서명 있음을 선택한 경우, 클라이언트는 허위 버전을 신고할 수 없게 됩니다.

모델

VersionModel

버전 모델

마스터 데이터의 CI/CD

Mon, 01 Jan 0001 00:00:00 +0000

마스터 데이터 업데이트 작업을 자동화함으로써 사람의 실수를 줄이고 개발 사이클을 빠르게 만들 수 있습니다.

자동화 흐름

일반적인 자동화 흐름은 다음과 같습니다.

데이터 작성: Excel이나 Google 스프레드시트, CSV 등으로 마스터 데이터를 작성합니다.
변환: 스프레드시트에서 GS2의 마스터 데이터 형식(JSON)으로 변환합니다.
커밋: 변환 후의 JSON 또는 GS2-Deploy의 템플릿을 Git 저장소에 커밋합니다.
배포: CI 도구(GitHub Actions, CircleCI 등)가 변경 사항을 감지하여 GS2에 반영합니다.

배포 자동화

GS2-Deploy를 사용하는 경우

GS2-Deploy의 템플릿에 마스터 데이터를 담아 둔 경우, CI에서 GS2-Deploy의 스택을 업데이트함으로써 반영할 수 있습니다.