coinsShopkeeper

βš’οΈ Shopkeeper

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.


⭐ Features

  • Category-based Browsing: Items are organized into logical groups (Weapons, Potions, etc.).

  • Upgrade Paths: Items can evolve through tiers using a shared ID system.

  • Module System: Highly customizable item behavior through specialized configuration modules.

  • Dynamic Availability: Items can be locked behind specific round numbers.


πŸ“‚ Structure

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

Every item file is built using modules, which define how the item behaves and appears in the shop.

circle-info

Organize your /items/ folder logically β€” one file per item. Use shared-id for clear upgrade paths.


🧩 Item Modules

Modules are the building blocks of an item. You can mix and match them to create unique gear.

πŸ’° Purchase Module

Defines how much an item costs and when it becomes available.

Key
Type
Description

gold-cost

integer

Price in gold.

round-unlock

integer

Minimum round number required to purchase.

consumable

boolean

If true, the item can be bought multiple times.

category

string

The tab name in the shop UI.


πŸ”Ό Upgrade Module

Allows items to be part of a progression chain.

Key
Type
Description

shared-id

string

Common ID for all tiers of the same item.

upgrade-tier

integer

The level of this specific item in the chain.


✨ Enchant Module

Used for creating enchantments that can be applied to other items.

Key
Type
Description

is-enchant

boolean

Marks the item as an enchantment.

max-purchases

integer

Maximum times this can be applied.

cost-increase-per-purchase

integer

Percentage price increase per purchase.

apply-to

list

List of item types this enchantment can affect.


πŸ›‘οΈ Equipment Builder Module

Controls the physical item given to the player, including its stats and visuals.

Key
Description

type

The Bukkit Material name.

custom

ItemsAdder or namespace:id reference.

attributes

List of attribute modifiers (e.g., speed, damage).

ignore-slot

If true, finds the first empty slot instead of using the defined index.


πŸ“‹ Examples

βš”οΈ Iron Sword (Tier 2)

A permanent weapon that upgrades from a Stone Sword.

chevron-rightView Configurationhashtag

πŸ§ͺ Splash Potion

A simple consumable item.

chevron-rightView Configurationhashtag

πŸͺ„ Random Augment (Mythic)

An item that executes a command when purchased.

chevron-rightView Configurationhashtag

Last updated