# Configuration

### General

All configurable  parameters are defined in the `{game}/x64/scripts/config/TheInsurgentsDescriptiveInventoryConfig/{language}.lua` files.

Each language comes with its own configuration file (more info [here](/the-insurgents-descriptive-inventory/overview/configuration/language.md)).

These configuration files can be modified via any text editor.

### Layout

```lua
local function config(contents)
  local inventory = {
    {contentId0, text0},
    ...
  }

  return inventory
end

return config
```

### Parameters

The following lists all configurable parameters and their purposes:

#### `config`

A function that returns all configurable parameters.

It is called with the following arguments:

<table><thead><tr><th width="155.59991455078125">Name</th><th width="351.00006103515625">Description</th><th>Example</th></tr></thead><tbody><tr><td><code>contents</code></td><td>A nested metatable where each category is itself a lookup metatable that maps inventory content names to numeric identifiers and vice versa.</td><td><code>contents.equipment.bangle</code></td></tr></tbody></table>

For more information on how these arguments can be used, you can refer to the [Name vs Identifier](/the-insurgents-descriptive-inventory/overview/configuration/name-vs-identifier.md) page.

#### `contentId`

The content identifier of the item, equipment, and so on.

#### `text`

The new text of the content.

You can use various text tags such as `{icon:fire}` and `{rgb:50,60,70}` to further form and style the text.

### Notes

{% hint style="warning" %}
Parameters are processed top to bottom. So if a content is used more than once, only the first one will actually have an effect.
{% endhint %}

{% hint style="info" %}
For a list of content identifiers, you can view the inventory content spreadsheet in [Resources](/the-insurgents-descriptive-inventory/getting-started/resources.md).
{% endhint %}

{% hint style="info" %}
For a list of text tags, you can view [The Insurgent's Handbook](https://xeavin.gitbook.io/the-insurgents-handbook/text/text-tags) wiki.

You can also use entirely new text tags (e.g. status effect icons) by using the [Text Extension](https://xeavin.gitbook.io/the-insurgents-manifesto/text-extension/general) of The Insurgent's Manifesto.
{% endhint %}

{% hint style="info" %}
For a spreadsheet that helps with creating descriptions more easily, you can view the description calculator spreadsheet in [Resources](/the-insurgents-descriptive-inventory/getting-started/resources.md).
{% endhint %}

{% hint style="info" %}
Instead of using an actual line break in a text, you can also use `\n` instead. That way the configuration file stays properly formatted as in there being one line for one content and text.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://xeavin.gitbook.io/the-insurgents-descriptive-inventory/overview/configuration.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
