# 🎉 LuxEnderJoin - Plugin Documentation

📋 Overview

LuxEnderJoin is a powerful Spigot/Paper plugin that allows server administrators to customize and manage player join, leave, and first-time join messages through an intuitive GUI interface.

Messages support MiniMessage formatting for advanced text styling and colors.

✨ Key Features

🎨 GUI-based message editor
✨ Full MiniMessage format support
📝 Separate prefix and message body customization
🔄 Real-time config reloading
⚙️ Easy-to-use interface
📚 Built-in documentation links

📦 Installation Instructions

Step 1: Download the Plugin

download the pre-built JAR file:
LuxEnderJoin-1.0-SNAPSHOT.jar

Step 2: Install the Plugin

Navigate to your server's plugins folder
Place the LuxEnderJoin-1.0-SNAPSHOT.jar file inside
Restart your server or use:

/reload confirm

Step 3: Verify Installation

After restart, you should see in console:

[LuxEnderJoin] Config loaded successfully!
[LuxEnderJoin] LuxEnderJoin has been enabled!

Step 4: Configuration

The plugin will automatically create a config.yml file in:

plugins/LuxEnderJoin/

You can edit this file directly or use the in-game GUI.

🎮 Commands

Main Command

/lej menu

Description: Opens the LuxEnderJoin configuration GUI
Permission: luxenderjoin.admin (or OP)
Usage: Simply type /nej menu to open the interface

🔐 Permissions

Admin Permission

lej.admin

Description: Allows player to access the /nej menu command
Default: OP only

Grant using LuckPerms:

/lp user <player> permission set luxenderjoin.admin true

Using default Bukkit permissions:

Add to your permissions plugin
Or use:

/op <player>

📖 How to Use the Plugin

Accessing the Menu

Type:

/lej menu

A GUI window will open with 3 colored buttons:

🟩 Green: First Join Message
🟦 Blue: Join Message
🟥 Red: Leave Message

Editing Messages

Step 1: Select Message Type

Click one of the three buttons (First Join, Join, or Leave).

Step 2: Choose Edit Option

In the submenu, you’ll see:

📄 Edit Prefix (Yellow Paper) – Position 11
📝 Edit Body Text (Yellow Paper) – Position 15
💚 Confirm & Reload Config (Green Concrete) – Position 22

Step 3: Edit in Chat

Click "Edit Prefix" or "Edit Body Text"
The GUI closes
Type your new prefix or message body in chat
The config automatically saves and the menu reopens

Step 4: Confirm Changes

Click the green Confirm & Reload Config button.
The config reloads and you receive a success message.

🎨 Message Format: MiniMessage

🎨 Color Tags

<black>         - Black
<dark_blue>     - Dark Blue
<dark_green>    - Dark Green
<dark_aqua>     - Dark Aqua
<dark_red>      - Dark Red
<dark_purple>   - Dark Purple
<gold>          - Gold/Orange
<gray>          - Gray
<dark_gray>     - Dark Gray
<blue>          - Blue
<green>         - Green
<aqua>          - Aqua/Cyan
<red>           - Red
<light_purple>  - Light Purple
<yellow>        - Yellow
<white>         - White

✏️ Text Styles

<bold>           - Bold Text
<italic>         - Italic Text
<underlined>     - Underlined Text
<strikethrough>  - Strikethrough
<obfuscated>     - Obfuscated/Magic Text

🧪 Examples

Simple Colored Message

<green>Welcome to the server, %player%!</green>

Prefix with Styling

<gray>[<gold><bold>Join</bold></gold>]</gray>

Mixed Colors and Styles

<red><bold>ATTENTION:</bold></red> <yellow>%player% has joined!</yellow>

With Reset Tags

Prefix:

<gray>[<gold><bold>Join</bold></gold>]</gray>

Body:

<reset><aqua>Welcome back!

🧩 Placeholder

%player%

Replaced with the actual player's name.

⚙️ Configuration File

Location:

plugins/LuxEnderJoin/config.yml

Default Config

Messages:
  NoPermission: '<red>You do not have permission to do this!</red>'
  UnknownCommand: '<red>Unknown command. Type /gamerule help for a list of commands.</red>'
  JoinMessage: '<gray>Welcome to the server, %player%!</gray>'
  Join_prefix: '<gray>[<gold><bold>Join</bold></gold>]</gray> '
  QuitMessage: '<gray>Goodbye, %player%!</gray>'
  Quit_prefix: '<gray>[<gold><bold>Quit</bold></gold>]</gray> '
  First_Join_Message: '<gray>Welcome to the server, %player%!</gray>'
  First_join_prefix: '<gray>[<gold><bold>FirstJoin</bold></gold>]</gray> '

Editing the Config

Via GUI (Recommended): Use /nej menu
Direct Edit: Modify the YAML file and click "Confirm & Reload Config" in-game

📝 Step-by-Step Example

Example: Change Join Message

Open the menu:

/lej menu

Click the blue button (Join Message).

Click yellow "Edit Body Text".

Type in chat:

<aqua><bold>%player%</bold></aqua> <gold>has entered the realm!</gold>

You will see:

Join Message body updated successfully!
New body: <aqua><bold>%player%</bold></aqua> <gold>has entered the realm!</gold>

Menu reopens. Click Confirm & Reload Config.

Result In-Game:

[Join] Player has entered the realm!

(With aqua bold player name and gold text)

🐛 Troubleshooting

Plugin Won't Load

Error:

IllegalArgumentException: The embedded resource 'config.yml' cannot be found

Solution:

mvn clean package

Changes Not Applying

Click the green Confirm & Reload Config button
Or use:

/reload confirm

Message Not Showing Colors

Issue: Legacy color codes (&c, &6, etc.) will NOT work.