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

# Getting Started

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

Welcome to SamsHead! This guide will walk you through the installation process and initial configuration to get pixel-perfect player avatars working in-game.

{% hint style="info" %}

### **Requirements**

* **Java 21** or higher.
* **Paper 1.21+** (or derivatives like Purpur).
* **PlaceholderAPI** (Highly recommended).
  {% 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.
{% endstep %}

{% step %}

### ResourcePack Integration

SamsHead automatically detects your environment:

* **ItemsAdder/Nexo**: Files are written directly to their respective content folders.
* **Vanilla**: A built-in HTTP server starts on port `8765` to serve the pack.
  {% endstep %}

{% step %}

### Reload and Verify

Reload your resource pack. Use `/sh reload` to ensure everything is synced. You should see a success message in the console showing the number of cached skins.
{% endstep %}
{% endstepper %}


---

# 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/samshead/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.