> ## 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 install and set up SentryLore on your server.

Installing SentryLore is incredibly simple. The plugin is designed to be plug-and-play, meaning it automatically generates its required configurations and begins formatting your lore immediately upon startup.

## System Prerequisites

<Warning>
  **Java Requirement:** SentryLore strictly requires **Java 17** or **Java 21**. Running on outdated Java runtimes (such as Java 8 or 11) will result in immediate startup failures.
</Warning>

<CardGroup cols={2}>
  <Card title="Supported Platforms" icon="server" iconType="duotone">
    Fully supports Spigot, PaperMC, Purpur, and Folia (1.16 - 1.21).
  </Card>

  <Card title="Dependencies" icon="puzzle-piece" iconType="duotone">
    SentryLore has **no** mandatory external dependencies! It works standalone right out of the box.
  </Card>
</CardGroup>

***

## Installation Steps

<Steps>
  <Step title="Download the Plugin">
    Log in to your BuiltByBit account or the Sentry Studios client portal. Navigate to your purchases and download the latest `SentryLore.jar` file.
  </Step>

  <Step title="Upload to Plugins Folder">
    Transfer the downloaded `SentryLore.jar` file into your server's `/plugins` directory using SFTP or your server panel's file manager.

    <Tree />
  </Step>

  <Step title="Restart Your Server">
    Restart your server. We highly recommend doing a full server reboot rather than using `/reload` or PlugMan to ensure the RPG formatting engine hooks safely into the server's item pipeline.
  </Step>

  <Step title="Verify Installation">
    Check the console to verify that the plugin has successfully enabled and generated its default `config.yml`. Once the server is online, log in and examine any tool, weapon, or armor piece to see the new dynamic lore in action!
  </Step>
</Steps>

***

## Troubleshooting

<AccordionGroup>
  <Accordion title="Plugin fails to load on startup" icon="triangle-exclamation" iconType="duotone">
    The most common cause is an outdated Java version. Verify your server is running **Java 17** or **Java 21**. Use `java -version` in your console to confirm.
  </Accordion>

  <Accordion title="Items are not getting formatted" icon="gem" iconType="duotone">
    Ensure that you haven't disabled global formatting in the `config.yml`. If you are using another plugin that strictly overwrites item lore (like MMOItems or CustomEnchants), SentryLore may defer to them to prevent conflicts.
  </Accordion>
</AccordionGroup>