> For the complete documentation index, see [llms.txt](https://tne.gitbook.io/tne-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tne.gitbook.io/tne-docs/intro/breakdown-of-main-currency-configuration-file.md).

# Breakdown of Main Currency Configuration File

### **1. Config Version**

* **Key**: `config-version`
* **Description**: Specifies the version of the configuration file for compatibility purposes.
* **Default**: `2`
* **Recommendation**: Do not modify unless necessary.

***

### **2. Basic Currency Information**

#### **Info**

Configurations related to the basic properties of the currency.

| Key            | Description                                                               | Example         |
| -------------- | ------------------------------------------------------------------------- | --------------- |
| `Server`       | The name of the server this currency belongs to (used for data saving).   | `"Main Server"` |
| `Identifier`   | The unique identifier for the currency used in commands.                  | `"USD"`         |
| `UUIDAsId`     | Whether to use the `Identifier` as the currency's UUID (not recommended). | `false`         |
| `Icon`         | The material name to use as the icon for plugin menus.                    | `"PAPER"`       |
| `Major_Single` | Singular form of the currency's major denomination.                       | `"Dollar"`      |
| `Major_Plural` | Plural form of the currency's major denomination.                         | `"Dollars"`     |
| `Minor_Single` | Singular form of the currency's minor denomination.                       | `"Cent"`        |
| `Minor_Plural` | Plural form of the currency's minor denomination.                         | `"Cents"`       |
| `Symbol`       | The character used as the currency symbol.                                | `"$"`           |

***

### **3. Currency Options**

#### **Options**

Settings related to regions, global usage, limits, and initial balances.

**MultiRegion**

* **Description**: Settings for enabling the currency in multiple regions or worlds.

| Key             | Description                                     | Example         |
| --------------- | ----------------------------------------------- | --------------- |
| `Regions.world` | Whether the currency is the default in a world. | `Default: true` |

**Global**

* **Description**: Configurations for global availability.

| Key       | Description                                 | Example |
| --------- | ------------------------------------------- | ------- |
| `Enabled` | Whether the currency is usable globally.    | `true`  |
| `Default` | Whether the currency is the global default. | `true`  |

**Other Options**

| Key             | Description                                                                            | Example                                         |
| --------------- | -------------------------------------------------------------------------------------- | ----------------------------------------------- |
| `Disabled`      | Whether the currency is disabled.                                                      | `false`                                         |
| `Sync`          | Whether the currency is synced across servers.                                         | `true`                                          |
| `MaxBalance`    | The maximum balance allowed for the currency.                                          | `900000000000000000000000000000000000000000000` |
| `Balance`       | The initial balance for accounts (used if no world-specific configurations are found). | `200.0`                                         |
| `Decimal`       | The character used as the decimal separator.                                           | `"."`                                           |
| `DecimalPlaces` | The number of digits displayed after the decimal separator (maximum: 4).               | `2`                                             |
| `Type`          | The currency type (`virtual`, `item`, `experience`, `mixed`).                          | `"virtual"`                                     |
| `Minor_Weight`  | The number of minor units required to equal one major unit.                            | `100`                                           |

***

### **4. Formatting**

#### **Formatting**

Settings for displaying the currency in chat and GUI elements.

| Key               | Description                                                                                    | Example                                           |
| ----------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------- |
| `Format`          | The format string for displaying the currency (variables include `<symbol>`, `<major>`, etc.). | `"<symbol><major.amount><decimal><minor.amount>"` |
| `Prefixes`        | SI prefixes for shortened amounts.                                                             | `"kMGTPEZYXWVUN₮"`                                |
| `JPrefixes`       | Japanese-style prefixes for powers of 10.                                                      | `"万億兆京垓𥝱穣溝澗正載"`                                  |
| `Major_Separate`  | Whether to separate major values every three digits.                                           | `true`                                            |
| `Major_Separator` | The separator used for major values.                                                           | `","`                                             |
| `Balance`         | Whether the currency appears in balance commands.                                              | `true`                                            |

***

### **5. Item Currency Options**

#### **Item**

Configurations for currencies based on physical items.

| Key           | Description                                                                                      | Example |
| ------------- | ------------------------------------------------------------------------------------------------ | ------- |
| `EnderChest`  | Whether to check a player’s Ender Chest for item balances.                                       | `true`  |
| `EnderFill`   | Whether item balances are deposited into the Ender Chest when inventory is full.                 | `true`  |
| `ImportItems` | Whether to import existing item currencies into a player's balance on their first balance check. | `true`  |

***

### **6. Notes**

#### **Note**

Settings for currency notes (physical representations of money). This is only used with the /money note command, not for physical currency items, that's in your denomination's file.

| Key       | Description                                      | Example |
| --------- | ------------------------------------------------ | ------- |
| `Notable` | Whether this currency can be converted to notes. | `false` |
| `Fee`     | The fee for creating a note.                     | `0.00`  |
| `Minimum` | The minimum amount required to create a note.    | `0.00`  |

**Item**

| Key            | Description                                                    | Example    |
| -------------- | -------------------------------------------------------------- | ---------- |
| `Material`     | The material to use for notes.                                 | `"PAPER"`  |
| `Texture`      | The base64 texture for notes if the material is `PLAYER_HEAD`. | `<base64>` |
| `Enchantments` | A list of enchantments applied to notes (optional).            | `[]`       |
| `Flags`        | A list of item flags applied to notes (optional).              | `[]`       |

***

### **7. Currency Conversion**

#### **Converting**

| Key       | Description                                                               | Example |
| --------- | ------------------------------------------------------------------------- | ------- |
| `Example` | Conversion rate from this currency to another (e.g., 1 USD = 2 Examples). | `2.0`   |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://tne.gitbook.io/tne-docs/intro/breakdown-of-main-currency-configuration-file.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
