> For the complete documentation index, see [llms.txt](https://humble-development.gitbook.io/advancedgearx/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://humble-development.gitbook.io/advancedgearx/readme.md).

# Overview

### What is AdvancedGearX?

AdvancedGearX is a Hytale server plugin that brings **custom armor sets and weapons with powerful effects** to your server — no modding, no code changes, no client modifications required. Everything is handled server-side.

No more hassle creating or editing custom weapons and armor through mod files. Define everything through a simple config or directly in the **in-game UI** while your server is live.

***

### What it does

**Armor Sets** — 4-piece gear sets (helmet, chestplate, leggings, gauntlets) that grant effects when the full set is worn. Equip all four, effects activate. Remove one, they're gone.

**Weapons** — Individual items that trigger effects on attack or defense. Can optionally require a specific armor set to unlock their full potential.

Both are managed entirely in-game or via JSON — your choice.

***

### Key Features

**Armor Sets**

* Define full 4-piece armor sets with custom display names and descriptions
* Effects trigger automatically when the full set is worn
* Built-in tooltip support via DynamicTooltipsLib

**Weapons**

* Define weapons tied to specific item IDs
* Optionally require a specific armor set to be worn for effects to activate
* Tooltip support out of the box

**Effect System**

* Powerful DSL for defining effects
* Supports ATTACK, DEFENSE, and BUFF trigger types
* Effects include: damage boost, damage reduction, health removal, healing, burn, freeze, and custom messages
* Grouped effects with shared chance and cooldown
* Per-effect target control (attacker or victim)

**In-Game UI**

* Full create and edit UI for armor sets and weapons
* No need to manually edit JSON files
* Effect list manager with add, edit, remove support
* Grouped effect editor

**Commands**

* `/agx createarmor` — open create armor set UI
* `/agx editarmor <setname>` — open edit armor set UI
* `/agx givearmor <player> <setname>` — give a full tagged armor set
* `/agx createweapon` — open create weapon UI
* `/agx editweapon <weaponname>` — open edit weapon UI
* `/agx giveweapon <player> <weaponname>` — give a tagged weapon
* `/agx reload` — reload both config files

**Permissions**

* All commands require `advancedgearx.admin`

**Aliases**

* `/agx` and `/advancedgearx` both work

***

### Config Files

* `armorsets.json` — defines all armor sets, their pieces, and effects
* `weapons.json` — defines all weapons and their effects

Both files are auto-generated with examples on first run.