> 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/samswheel/home.md).

# Home

Welcome to the SamsWheel documentation!

## SamsWheel <a href="#samshead" id="samshead"></a>

SamsWheel is a **premium** Fortune Wheel plugin for Minecraft servers. Unlike chest-menu crates, every wheel is a real, animated wheel built from **display** entities that lives in your world.. **players** walk up, right-click, and watch it physically spin to a prize!

{% hint style="success" %}

### **Configure everything in-game**

SamsWheel ships with a full in-game editor. Look around to move the cursor, click to edit, and design an entire wheel like rewards, cost, animation, colours and holograms without ever opening a config file!
{% endhint %}

***

### Compatibility

{% tabs %}
{% tab title="Software" %}

* **Java:** 21+
* **Server Version:** 1.21+
* **Supported Software:** Paper (and forks like Purpur)
  {% endtab %}

{% tab title="Integrations" %}

* **PlaceholderAPI:** win-chance placeholders
* **Vault:** money (economy) cost
  {% endtab %}
  {% endtabs %}

***

### Key Features

{% columns %}
{% column %}
{% hint style="info" icon="tire-flat" %}

#### **Physical In-World Wheels**

The wheel is a real spinning object in the world, not a GUI. Place as many as you like, anywhere.
{% endhint %}
{% endcolumn %}

{% column %}
{% hint style="success" icon="gear" %}

#### **In-Game HUD Editor**

You can build and tweak wheels through a beautiful UI! No YAML required.
{% endhint %}
{% endcolumn %}
{% endcolumns %}

{% columns %}
{% column %}
{% hint style="warning" icon="wand-magic-sparkles" %}

#### **Animations & Win Effects**

Easing styles, overshoot/pulse motion, and winning effects like Firework, Rocket, Burst and Spiral.
{% endhint %}
{% endcolumn %}

{% column %}
{% hint style="danger" icon="puzzle-piece" %}

#### **Flexible Rewards**

Weighted chances, custom commands, lore and per-reward messages, sounds and colours!
{% endhint %}
{% endcolumn %}
{% endcolumns %}

***

### Navigation

{% content-ref url="/pages/F5AK4UTD98Kp6Br0yniV" %}
[GUIDES](/samswheel/guides/getting-started.md)
{% endcontent-ref %}

{% content-ref url="/pages/BvDH2JxSgjSkmFUOhqgF" %}
[DEVELOPERS](/samswheel/developers/developer-api.md)
{% endcontent-ref %}

***

{% hint style="info" %}

#### Support me!

If you enjoy using SamsWheel, feel free to [Buy me a coffee](https://ko-fi.com/sam1qk)! Thank you! 🧡
{% endhint %}