Master Data Reference of GS2-Guild
Reference of the format of master data and various models to be imported
Master Data Format
{
"version": "2024-04-25",
"guildModels": [
{
"name": "[string]Guild Model name",
"metadata": "[string?]Metadata",
"defaultMaximumMemberCount": "[int]Maximum number of guild members that will be applied when creating a guild",
"maximumMemberCount": "[int]Maximum number of guild members that can be applied",
"inactivityPeriodDays": "[int]Number of days of inactivity of the guild master to select a new guild master from the guild members",
"roles": [
{
"name": "[string]Role Model Name",
"metadata": "[string?]Metadata",
"policyDocument": "[string]Policy document for permissions to apply to roles"
}
],
"guildMasterRole": "[string]Role that guild masters have",
"guildMemberDefaultRole": "[string]Role that guild members have in the initial state",
"rejoinCoolTimeMinutes": "[int]Cool time until you can join again after leaving the guild (minutes)",
"maxConcurrentJoinGuilds": "[int?]Maximum number of guilds that can be joined at the same time",
"maxConcurrentGuildMasterCount": "[int?]Maximum number of guild masters that can exist at the same time"
}
]
}| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| version | string | ✓ | 2024-04-25 | Format version of master data | ||
| guildModels | List<GuildModel> | ~ 100 items | Guild Model A guild model is an entity that sets the maximum number of people who can join the guild and the permission settings for each position within the guild. |
Model
GuildModel
Guild Model
A guild model is an entity that sets the maximum number of people who can join the guild and the permission settings for each position within the guild.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| guildModelId | string | ✓* | ~ 1024 chars | Guild Model GRN * Automatically configured on the server | ||
| name | string | ✓ | ~ 128 chars | Guild Model name Guild model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| metadata | string | ~ 2048 chars | Metadata Arbitrary values can be set in the metadata. Since they do not affect GS2’s behavior, they can be used to store information used in the game. | |||
| defaultMaximumMemberCount | int | ✓ | 1 ~ 2147483646 | Maximum number of guild members that will be applied when creating a guild | ||
| maximumMemberCount | int | ✓ | 1 ~ 2147483646 | Maximum number of guild members that can be applied | ||
| inactivityPeriodDays | int | ✓ | 7 | 1 ~ 365 | Number of days of inactivity of the guild master to select a new guild master from the guild members | |
| roles | List<RoleModel> | ✓ | 1 ~ 10 items | List of permission settings for each position in the guild | ||
| guildMasterRole | string | ✓ | ~ 128 chars | Role that guild masters have | ||
| guildMemberDefaultRole | string | ✓ | ~ 128 chars | Role that guild members have in the initial state | ||
| rejoinCoolTimeMinutes | int | ✓ | 0 | 0 ~ 2147483646 | Cool time until you can join again after leaving the guild (minutes) | |
| maxConcurrentJoinGuilds | int | 1 ~ 10 | Maximum number of guilds that can be joined at the same time | |||
| maxConcurrentGuildMasterCount | int | 1 ~ 100 | Maximum number of guild masters that can exist at the same time |
RoleModel
Role Model
The role model defines the role within the guild and sets the permissions for each role.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| name | string | ✓ | ~ 128 chars | Role Model Name Role model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| metadata | string | ~ 2048 chars | Metadata Arbitrary values can be set in the metadata. Since they do not affect GS2’s behavior, they can be used to store information used in the game. | |||
| policyDocument | string | ✓ | ~ 10240 chars | Policy document for permissions to apply to roles |