> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sentrystudios.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> How to deploy SentryLore, configure database persistence, and verify item formatting.

Welcome to the **SentryLore** installation guide. Engineered for modern high-performance servers, SentryLore works right out of the box with zero mandatory external dependencies.

***

## System Prerequisites

Java 17 / 21 TargetFolia CompatibleZero Dependencies

> [!WARNING]
>
> **Java Runtime:** SentryLore strictly requires **Java 17** or **Java 21**. Running on older runtimes will result in immediate startup failure.

> **Supported Platforms**
>
> Native support for PaperMC, Purpur, and Folia (1.20.x through 1.21.x).

> **Standalone Architecture**
>
> Zero mandatory external dependencies! Runs out of the box.

> **PlaceholderAPI (Optional)**
>
> Supports `%sentrylore_version%` and `%sentrylore_registered_items%` expansions.

***

## Installation Steps

**1. Download SentryLore Binary**

Acquire the latest production `SentryLore.jar` from your BuiltByBit purchases or the Sentry Studios Client Portal.

**2. Upload to Plugins Directory**

Transfer `SentryLore.jar` into your server's `/plugins` folder:

**plugins**

**SentryLore.jar**

**3. Reboot Server**

Restart your server. Avoid using `/reload` or PlugMan; a clean reboot ensures the item pipeline and NBT listener events attach cleanly.

**4. Verify In-Game Formatting**

Join the server and hold any sword, armor piece, or painting in your main hand. SentryLore will immediately attach the custom category badge and Small Caps rarity header:

```text Server Console theme={null}
Verifying license key...
License verified! Thank you for supporting Sentry Studios.
Dependencies checked: PlaceholderAPI, Vault, LuckPerms
[SentryLore] Enabled v1.0.0 (HWID: e3b0c44298fc1c14) [Hooks: PlaceholderAPI]
```

***

## Troubleshooting

> **Plugin fails with UnsupportedClassVersionError**
>
> Your server runtime is running Java 8 or Java 11. SentryLore targets Java 17 bytecode. Update your startup flags to use Java 17 or 21.

> **Items are not getting formatted in-game**
>
> Ensure that `layout.enabled` or `dev-mode` has not been set to suppress default tooltips in `config.yml`. If running custom item plugins (e.g. ItemsAdder, Oraxen, MMOItems), ensure SentryLore has permission to format those items.

> **Floating nametags appearing on placed paintings or mobs**
>
> SentryLore natively strips custom nametags from placed decorative entities (Paintings, Armor Stands, and Spawn Eggs). Ensure SentryLore event listeners are enabled.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.