> 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/guides/getting-started.md).

# Getting Started

## Getting Started <a href="#getting-started" id="getting-started"></a>

Welcome to SamsRank! This guide will walk you through the installation process and initial configuration to get your custom rank tags working in-game.

{% hint style="info" %}

### **Requirements**

* **Java 21** or higher.
* **Paper 1.21+** (or derivatives like Purpur/Folia).
* A valid license key from our [Discord](https://discord.gg/KrvMkMDE2W).
  {% endhint %}

***

## Installation

{% stepper %}
{% step %}

### Download and Install

Place the `SamsRank.jar` file into your server's `plugins/` folder.
{% endstep %}

{% step %}

### Initial Startup

Start your server to generate the default configuration files. The plugin will initially disable itself until you provide a license key.
{% endstep %}

{% step %}

### Register

First, you need to register on the website <https://ranktags.samscreations.eu/>. Then join our Discord server and create a ticket. After that, we will provide you with a license.
{% endstep %}

{% step %}

### Configure License

Open `plugins/SamsRank/config.yml` and enter your credentials:

```
license:
  discord_username: "your_username"
  license_key: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
```

{% endstep %}

{% step %}

### Restart

Restart your server. Upon a successful license check, the plugin will detect your platform (ItemsAdder, Nexo, or Vanilla) and print a startup banner.
{% endstep %}
{% endstepper %}

***

## Folder Structure

SamsRank uses a simplified single-folder system for all platforms:

* `plugins/SamsRank/ranks/`: Drop all your raw `.png` rank templates here.
* `plugins/SamsRank/resourcepack/`: The built-in resource pack is generated here.
* `plugins/SamsRank/lang/`: Language files for plugin messages.

***

## Basic Commands

| Command             | Description                            | Permission         |
| ------------------- | -------------------------------------- | ------------------ |
| `/samsrank convert` | Converts PNGs in the ranks folder      | `samsrank.convert` |
| `/samsrank list`    | Interactive preview of converted ranks | `samsrank.list`    |
| `/samsrank effects` | Browse shader-based rank effects       | `samsrank.effects` |
| `/samsrank reload`  | Reload config and update resource pack | `samsrank.reload`  |


---

# 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/guides/getting-started.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.