> For the complete documentation index, see [llms.txt](https://docs.samscreations.eu/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.samscreations.eu/samsrank/plugin-config/configuration.md).

# Configuration

## Configuration Guide <a href="#configuration-guide" id="configuration-guide"></a>

This page covers every setting available in the `config.yml` file. SamsRank uses an auto-patching system that injects new settings into your existing file without overwriting your changes.

***

## License Settings <a href="#configuration-guide" id="configuration-guide"></a>

{% hint style="warning" %}

### Required

You must configure these values for the plugin to function. Join our [Discord](https://discord.gg/KrvMkMDE2W) to get a key.
{% endhint %}

* **`license.discord_username`**: The Discord handle associated with your purchase.
* **`license.license_key`**: Your unique UUID license key.

***

## Platform Settings <a href="#configuration-guide" id="configuration-guide"></a>

* **`platform.preferred`**:
  * `itemsadder`: Forces ItemsAdder mode.
  * `nexo`: Forces Nexo mode.
  * `both`: Enables both (default).

***

## Folder Customization <a href="#configuration-guide" id="configuration-guide"></a>

* **`folders.ranks`**: The root folder for source PNG images (Default: `ranks`).

***

## Auto Delete <a href="#configuration-guide" id="configuration-guide"></a>

* **`auto_delete.enabled`**: If `true`, source PNGs are removed after successful conversion to keep the workspace clean.

***

## ResourcePack Provider <a href="#configuration-guide" id="configuration-guide"></a>

Used when no external platform (ItemsAdder/Nexo) is detected.

* **`resource-pack.enabled`**: Enables the built-in HTTP server.
* **`resource-pack.port`**: The port for the web server (Default: `8765`).
* **`resource-pack.hostname`**: Public IP/Domain for the download link.
* **`resource-pack.required`**: If `true`, players are kicked if they decline the pack.

***

## ResourcePack Settings <a href="#configuration-guide" id="configuration-guide"></a>

* **`samsrank-resourcepack.height`**: Rendered glyph height (Default: `9`).
* **`samsrank-resourcepack.ascent`**: Vertical position offset (Default: `8`).


---

# 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:

```
GET https://docs.samscreations.eu/samsrank/plugin-config/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.