🛠️ Guild ConfigurationGuild Config

🌟 Guild Config File

Guild configuration defines the default settings for a guild, including its icon, creation cost, level system, and upgrades. All examples below are presented in JSON format.

{
  "icon": {...},
  "create_cost": 1000,
  "upgrade": {...},
  "level_system": {...}
}

icon

• Description: Default icon used when a guild is created.

• Guild owners can change this icon in their guild settings later.

create_cost

• Description: The price in in-game currency to create a guild.

🌟 Guild Upgrade System

The Upgrade System defines guild perks and characters that can be unlocked or upgraded as the guild progresses. It is fully configurable in JSON and allows unlimited customization.

---

🔹 Structure Overview

"upgrade": {
  "perks": {},
  "characters": {}
}

• perks — guild-wide upgrades that add new abilities, quests, or shop items.

• characters — special roles that provide modifiers (e.g., faster quest cooldowns, shop discounts).

---

🔹 Perks

Perks are organized by type and can have multiple levels. Each level defines requirements, icon, and optional effects like adding quests or shop items.

Example: Mining Perk

"perks": {
  "mining": [
    {
      "requirements": {"exp": 0, "money": 0},
      "icon": {
        "material": "WOODEN_PICKAXE",
        "display_name": "Mining I",
        "lore": [
          "Adds mining shop items and quests",
          "Next upgrade: 200$"
        ]
      },
      "add_shop_items": [
        {"item": {"material": "COAL"}, "amount": 100, "price": 0.5}
      ],
      "add_quests": ["mining_1"]
    },
    {
      "requirements": {"exp": 0, "money": 200},
      "icon": {
        "material": "STONE_PICKAXE",
        "display_name": "Mining II",
        "lore": [
          "Adds more mining shop items and quests",
          "Next upgrade: 500$"
        ]
      },
      "add_shop_items": [
        {
          "item": {"material": "COAL"}, "amount": 100, "price": 0.5
        },
        {
          "item": {"material": "IRON_INGOT"}, "amount": 64, "price": 3.0
        }
      ],
      "add_quests": ["mining_1","mining_2"]
    }
  ]
}

Explanation:

• requirements — experience and money needed to unlock this level.

• icon — visual representation in the UI (material, display name, lore).

• add_shop_items — items added to the guild shop at this perk level.

• add_quests — quests unlocked for the guild at this perk level.

You can create unlimited perks and levels per perk type.

---

🔹 Characters

Characters are guild roles with modifiers. Each character can have multiple levels with different effects.

Example: Adventurer

"characters": {
  "adventurer": [
    {
      "requirements": {"exp": 0, "money": 0},
      "icon": {
        "material": "PLAYER_HEAD",
        "display_name": "Adventurer",
        "lore": ["Reduces guild quest cooldowns"]
      },
      "adders": ["quests_update:-1"]
    }
  ]
}

Explanation:

• requirements — experience and money needed to unlock the character level.

• icon — visual representation (material, name, lore).

• adders — modifiers applied by the character (e.g., quests_update:-1 reduces quest cooldowns).

You can define unlimited characters with unlimited levels and any effects you want.

Adder	Description
max_members	Increases the maximum number of players allowed in the guild.
shop_update	Reduces the update/cooldown time of the guild shop.
shop_discount	Applies a discount to items in the guild shop.
shop_size	Increases the number of items available in the guild shop.
quests_exp	Multiplies the experience gained from guild quests.
quests_money	Multiplies the money earned from guild quests.
quests_update	Reduces the cooldown time for guild quests.
quests_size	Increases the number of available guild quests.

🌟 Guild Level System

The Guild Level System defines how a guild progresses, including maximum players, shop size, quests, and other perks. Each level can have its own requirements, rewards, and modifiers.

---

🔹 Structure Overview

"level_system": {
  "base_max_players": 10,
  "base_shop_size": 5,
  "base_shop_update": 20,
  "base_quests_size": 3,
  "base_quests_update": 20,
  "base_shop_items": [],
  "base_quests": [],
  "levels": {}
}

Base parameters:

Parameter	Description
base_max_players	Default maximum number of players in the guild.
base_shop_size	Default number of items in the guild shop.
base_shop_update	Default cooldown (in minutes) for shop updates.
base_quests_size	Default number of available guild quests.
base_quests_update	Default cooldown (in minutes) for quest updates.
base_shop_items	List of items available in the shop at level 1.
base_quests	List of quests available at level 1.

---

🔹 Levels

Each level can define:

• requirements — experience and money needed to unlock the level.

• display_name — the name displayed in the UI.

• adders — modifiers applied at this level (e.g., increase max players, shop size, quest cooldown, etc.).

• add_shop_items — items added to the shop when the level is reached.

• add_quests — quests unlocked at this level.

Example Level 2

"levels": {
  "2": {
    "requirements": {
      "exp": 200,
      "money": 0
    },
    "display_name": "2 Level",
    "adders": [
      "max_players:+20"
    ],
    "add_shop_items": [
      {
        "item": {
          "material": "DIAMOND"
        },
        "amount": 10,
        "price": 100.0
      }
    ]
  }
}

Explanation:

• Guild reaches Level 2 after gaining 200 XP.

• Money requirement is 0 in this example.

• The adders parameter increases the maximum number of players by 20.

• The guild shop receives 10 diamonds priced at 100 each.

• You can add more modifiers, shop items, or quests for each level.

You can create unlimited levels with custom rewards and modifiers.