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

# Dynamic Description

<figure><img src="/files/iL13vAW3a2bHXQOfkvxd" alt=""><figcaption></figcaption></figure>

### Overview

Dynamic Description is a mod that reads equipment and action data from the game in real-time and renders it using a template-based layout system, working alongside The Insurgent's Descriptive Inventory.

The mod automatically extracts item information directly from memory, allowing you to display comprehensive inventory details with full customization control over layout, text, and styling.

***

#### Core Features

#### <mark style="color:$primary;">Automatic Data Reading</mark>

Dynamic Description reads equipment and action data directly from game memory in real-time. No manual data entry required—the mod automatically extracts all available information for each item.

#### <mark style="color:$primary;">Template System</mark>

Create and customize layouts using a flexible template system. Each item type (weapons, armor, magicks, etc.) has its own template file, giving you complete control over how information is displayed.

#### <mark style="color:$primary;">Custom Tags and Pre-rendered Content</mark>

Use custom dynamic tags (`dt:equipment:*`, `dt:action:*`, `dt:customAttribute:*`) to render item properties with pre-formatted labels, icons, and styling. Tags handle formatting automatically, so you focus on layout and content selection.

#### <mark style="color:$primary;">Hot Reload</mark>

Modify templates and settings without restarting the game. Changes apply instantly through the symbol refresh system, making iteration fast and seamless.

#### <mark style="color:$primary;">Text Editing and Translation</mark>

Full control over all displayed text through the `i18n.lua` file. Edit names, labels, notes, and translations. Custom labels can be overridden at runtime via symbols for dynamic text updates.

#### <mark style="color:$primary;">Extensive Customization</mark>

Customize every aspect of item descriptions:

* Layout and spacing
* Image size and alignment
* Text formatting and styling
* Label text and fallbacks

#### <mark style="color:$primary;">API</mark>

Gain more control over the attributes.

* Add new attributes
* Customize existing ones

#### <mark style="color:$primary;">Comprehensive Inventory Information</mark>

The mod displays complete information for equipment, magicks, technicks, and items including:

**Equipment:**

* Name, category, type, license requirements
* Base attributes (attack power, defense, stats)
* Linked attributes (HP/MP bonuses, elemental affinities)
* Special attributes (Unused offsets)
* Augments
* Elements
* On equip effects
* On hit effects
* Immunities
* Elemental affinities (weak, immune, half, absorb, potency)
* Notes

**Actions (Magicks, Technicks, Items):**

* Name, category, license requirements
* Base attributes (Power, range, MP/Mist cost etc)
* Special attributes (Unused offsets)
* Accuracy and hit rates
* Charge time and area of effect
* Elements
* On hit effects
* Notes