Skip to content

Installation

ElGuanteAzul edited this page Sep 21, 2026 · 1 revision

📦 Setup & Installation

Getting started with LemonGui is quick and easy. Follow this guide to install the plugin and its dependencies on your server.

⚠️ Prerequisites

Before installing LemonGui, ensure your server meets the following requirements:

  • Server Software: Spigot, Paper, or any Paper-fork (Paper is highly recommended for better performance and MiniMessage support).
  • Java Version: Java 17 or higher.

Optional Dependencies (Highly Recommended)

To unlock the full potential of LemonGui, we recommend installing the following plugins:

  • PlaceholderAPI: Required if you want to use custom variables (like %player_name% or %player_ping%) in your GUI titles, item lores, and click actions.
  • Vault: Required if you plan to configure monetary costs for clicking items in your GUIs (requires an economy plugin like EssentialsX as well).

📥 Installation Steps

  1. Download the Plugin: Download the latest LemonGui.jar file from our official SpigotMC page.
  2. Upload to Server: Drag and drop the downloaded .jar file into your server's plugins/ folder.
  3. Install Dependencies: If you are using Vault or PlaceholderAPI, ensure their .jar files are also in your plugins/ folder.
  4. Restart the Server: Completely restart your server. (Note: We strongly advise against using /reload or plugin managers like PlugMan for the first installation).
  5. Done! The plugin will automatically generate its configuration folders.

📂 Folder Structure

After the first boot, LemonGui will create the following folder structure inside plugins/LemonGui/:

LemonGui/
├── config.yml        # Main configuration (Prefix, Default Language)
├── languages/        # Localization files (en_US.yml, es_ES.yml)
└── guis/             # Folder where all your visual GUIs are stored (.yml)

Clone this wiki locally