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

# Installation

> Installation guide for the LuckPerms Configuration.

## Requirements

Before installing the LuckPerms Configuration, ensure you have the following:

<ResponseField name="LuckPerms" type="Required" required>
  Download and install [LuckPerms](https://luckperms.net/download) from the official website.
</ResponseField>

<ResponseField name="Chat Plugin" type="Required" required>
  Install a chat plugin to display rank prefixes and suffixes. Popular options include:

  * EssentialsChat
  * ChatControl
  * LitChat
  * DiscordSRV
  * Any chat formatting plugin
</ResponseField>

<ResponseField name="Java 8+" type="Required" required>
  Ensure your server is running Java 8 or higher for compatibility.
</ResponseField>

## Installation Steps

<Steps>
  <Step title="Prepare Server">
    Ensure LuckPerms and a chat plugin are installed and enabled on your server.
  </Step>

  <Step title="Extract Files">
    Download and extract the `LuckPerms.zip` file to your computer.
  </Step>

  <Step title="Select Style">
    Choose one of the 3 available styles:

    * **Style 1 - SmallCaps:** Modern small-caps styling
    * **Style 2 - DefaultFont:** Clean default font
    * **Style 3 - DefaultBracket:** Professional bracket format
  </Step>

  <Step title="Upload Configuration File">
    Copy the selected `.json.gz` file to your server's `LuckPerms` folder (usually `plugins/LuckPerms/`).
  </Step>

  <Step title="Import Configuration">
    Execute one of these commands in your server console or as an admin in-game:

    ```
    /lp import Style1-SmallCaps
    ```

    or

    ```
    /lp import Style2-DefaultFont
    ```

    or

    ```
    /lp import Style3-DefaultBracket
    ```
  </Step>

  <Step title="Verify Import">
    Check that the import was successful. You should see a confirmation message in the console.
  </Step>

  <Step title="Restart Server">
    Restart your server to fully apply all changes.
  </Step>

  <Step title="Test Ranks">
    Give a player a test rank using `/lp user <name> parent add <rank>` and verify the prefix displays.
  </Step>
</Steps>

## After Installation

<Note>
  The configuration will be loaded successfully and ready to use immediately after import!
</Note>

**Available Ranks Include:**

* Staff ranks (Owner, Admin, Moderator, Helper)
* Donator ranks (Diamond, Platinum, Gold, Silver, Bronze)
* Achievement ranks
* 40 total groups with full permissions

<Tip>
  All ranks are pre-configured with appropriate permissions. You can modify permissions per rank using the LuckPerms commands or web editor at `http://localhost:8080` (default).
</Tip>

## Need Help?

If you encounter any issues during installation, check the [FAQs](/configurations/luckperms/faqs) or reach out to support on our [Discord](https://ph4ntom.org/discord).