Shopkeeper

🧭 Overview

The Shopkeeper is a core game mechanic that allows players to purchase items during the preparation phase. Items are grouped into categories to make browsing and purchasing fast and intuitive.


πŸ“¦ Items

All items are stored inside the /items/ folder. Each item has its own file and configuration.

Every item file is made up of modules, which define how the item behaves in the shop.


πŸ“š Categories

Category
Description

Permanent / Upgrades

Items that persist and can be upgraded (e.g., swords, armor).

Consumables

Items that can be purchased repeatedly (e.g., Golden Apples, Ender Pearls).

Eggs

Special items that spawn minions when right-clicked.

TNT

Throwable explosives activated by left-clicking.


πŸ›  Creating Items

  1. Open the /items/ directory.

  2. Choose an existing item file as a template.

  3. Duplicate it.

  4. Rename the copy to your new item’s name.

  5. Edit the configuration to define your item’s behavior.

  • Organize your /items/ folder logically β€” one file per item.

  • Use shared-id for clear upgrade paths.

  • Keep categories small and intuitive for players.

  • Combine modules creatively β€” e.g., Upgrade + Enchant + Mythic for complex items.


🧩 Item Modules

Each module defines a specific part of how the item works.


πŸͺ„ Mythic Module

Marks the item as Mythic, linking it to mythic-related features (e.g., augments, rare effects).


πŸ’° Purchase Module

Defines purchase details and availability.

Key
Description

gold-cost

How much gold the item costs.

round-unlock

Round number when the item becomes available.

consumable

Whether it can be bought multiple times.

category

The category this item belongs to.


πŸ”Ό Upgrade Module

Items with the same shared-id form an upgrade path. Higher upgrade-tier values = better versions.


✨ Enchant Module

Example 1 (basic):

Example 2 (advanced, per-item):

cost-increase-per-purchase is a percentage increase per buy.

Example with 25% increase:

  • Level 1: 500 Gold

  • Level 2: 625 Gold

  • Level 3: 750 Gold


🧱 Equipment Builder Module

Controls what item is given, its visuals, and stats.

Key
Description

ignore-slot

Whether the slot should be ignored when given.

type

The item type (e.g., IRON_HELMET).

attributes

Attribute modifiers (armor, damage, etc.).

enchants

Optional enchantments.

lore

Text lines shown in the tooltip.


πŸ’‘ Examples

βš”οΈ Iron Sword


πŸ§ͺ Potion


πŸͺ„ Breeze Egg


🌟 Sharpness Enchant


πŸƒ Random Augment


🧩 ItemsAdder Integration

Last updated