XPSyncAddon

XPSync

xPsMenu

—

## ✨ Features
**xPsMenu** takes the classic ProtectionStones experience and transforms it into a modern, visual, and premium system for your players.

* 🎨 **100% Customizable:** Every single menu, item, lore, and message is fully editable (`gui.yml`, `flags.yml`, `selector.yml`, `config.yml`).
* 🌈 **Hex Colors & MiniMessage:** Full support for modern Hex color codes (`&#FFFFFF`) to make your menus pop out.
* 📋 **Dynamic Region Selector:** A live, auto-updating GUI showing all player regions with an interactive filter (View ALL, OWNERS, or MEMBERS).
* 👤 **Advanced Player Management:** View members and owners using real Player Heads! Kick players directly via Shift + Right-Click.
* ✨ **0-Lag Particle System:** When a protection block is hidden, only the owner will see beautiful magical particles indicating its location (highly optimized, 0 server lag).
* 🚀 **OP / VIP Bypass:** Instantly teleport to your region without the 3-second cooldown using a permission node.
* 🛠️ **Admin Tools:** Nuke all regions from the server database with a single safety-confirmed command.
* 🔌 **Developer API:** Easily hook into the plugin to open menus from other custom plugins or NPCs.

# 🎢 Examples:

Do you want to acquire the best ES/EN configuration?
– ¡Enter the discord!
– It helps us a lot.

—

## 📥 Installation
1. Stop your server.
2. Download the `xPsMenu-v1.0.0.jar` and place it in your `/plugins/` folder.
3. Ensure you have the required dependencies:
* **ProtectionStones** (2.10+)
* **WorldGuard** & **WorldEdit**
* **PlaceholderAPI** (Optional, but highly recommended)
4. Start the server.
5. Customize the configuration files inside `/plugins/xPsMenu/` and type `/psmenu reload`.

—

## ⌨️ Commands & Permissions

### Player Commands
* `Shift + Right Click` (on a protection block) – Opens the main management GUI for that specific region.
* `/psmenu` – Opens the dynamic Region Selector (Shows all your active regions).
* `/psmenu help` – Shows the help menu.

### Admin Commands
* `/psmenu reload` – Reloads all configuration files seamlessly.
* **Permission:** `psmenu.admin`
* `/psmenu clearall confirm` – ⚠️ *DANGER!* Wipes every single ProtectionStones region from the server database.
* **Permission:** `psmenu.admin`

### Extra Permissions
* `psmenu.bypass` – Bypasses the 3-second teleportation delay. Instant teleport!

—

## 📊 Placeholders

### Internal Menu Variables
Use these exclusively inside your `gui.yml` and `flags.yml` to display dynamic data:
* `%region%` – Displays the ID of the region currently being edited.
* `%hidden_status%` – Displays the current state of the block (e.g., Hidden ✘ or Visible ✔ – editable in config).
* *Note: You can also use any global PlaceholderAPI variable inside the menus (like `%player_name%`).*

### PlaceholderAPI Variables (Global)
You can use these variables anywhere on your server (Scoreboards, Holograms, Chat, etc.):
* `%xpsmenu_version%` – Displays the current plugin version.
* `%xpsmenu_player%` – Displays the player’s name.

—

## 💻 Developer API
Building a custom core or an NPC script? You can easily hook into **xPsMenu** to open interfaces for your players using our static API.

### Add to your build.gradle:
“`gradle
dependencies {
compileOnly fileTree(dir: ‘libs’, include: ‘xPsMenu-v1.0.0.jar’)
}
Example Usage:
Java
import jn.willfrydev.xPsMenuAPI;
import org.bukkit.entity.Player;

public class MyCustomPlugin {

public void openMenuForPlayer(Player player, String regionId) {
// Opens the main Editor GUI for a specific region
xPsMenuAPI.openMainMenu(player, “ps10x64y5z”);
}

public void openListForPlayer(Player player) {
// Opens the Dynamic Region Selector GUI for the player
xPsMenuAPI.openSelector(player);
}
}
“`

XPlayerKits

It’s a plugin that allows you to create kits for your players.
This plugin was created due to the lack of an optimized solution for this feature.
It uses very little RAM and is highly customizable.

| | | |
| — | — | — |

**Unlike other plugins that load the data of every single player registered on your server (wasting precious resources), XPlayerKits takes a smarter approach.**
It only loads player data when they actually join, and keeps just the essential information cached. This means **significantly lower RAM usage** without sacrificing performance.

On top of that, XPlayerKits comes with **built-in SQLite support right out of the box**, giving you a reliable and lightweight database solution. No more dealing with the limitations and issues of storing player data in messy YML files.

### Features
– **Migration:** Migrate data and kits from another plugin to save resources and avoid inventory exploits.
– **Kit placeholder requirements:** Use a system to check placeholder conditions.
– **Fully editable inventory:** Customize the kit inventory with an item name system for icons.
– **Claim/Deny actions:** Set actions when claiming or denying a kit, such as commands or sounds.
– **In-game GUI:** Edit kits directly in-game, including properties, icons, and content.
– **One-Time Kits:** Create kits that can only be claimed once, stored in player data.
– **First Join Kit:** Deliver a kit to players the first time they join your server.
– **Database support:** MongoDB, MySQL, and SQLite are supported (Recommended: MongoDB).

### Commands
– `/xkits editor` – Opens the editor for quick kit creation.
– `/xkits kits` – Opens the kit selection menu.
– `/xkits open [rotation/category]` – Opens the kit selection with category or rotation kits.
– `/xkits preview [player]` – Opens preview menu.
– `/xkits give ` – Give kits directly to players without checks.
– `/xkits claim ` – Give kits to players with checks.
– `/xkits reset ` – Reset a player’s data for a specific kit.
– `/xkits resetall ` – Reset all data for a player.
– `/xkits delete ` – Delete a kit.
– `/xkits migrate playerkits2_yml/playerkits2_mysql` – Migrate data from other plugins.
– `/xkits migratekits playerkits2` – Migrate kits from other plugins.

### Permissions
– `xkits.admin` – Allows players to use the `/xkits editor` and `/xkits slots` commands.
– `xkits.preview` – Allows players to use `/xkits preview`.
– `xkits.countdown.bypass` – Allows players to bypass kit countdowns.
– `xkits.onetime.bypass` – Allows players to bypass one-time restrictions.

### Placeholders
– `%xplayerkits_cooldown_%` – Show the time to next claim.
– `%xplayerkits_claimed_onetime_%` – Return yes or no if the kit of player is claimed.
– `%xplayerkits_claimed_cooldown_%` – Return yes or no if the kit of player is in cooldown.

### Actions
| Action | Description | Example |
|————————-|———————————————–|———————————————————–|
| console | Executes a command from the console. | `console:say test` |
| command | Executes a command as the player. | `command:dm open main` |
| sound | Plays a sound to the player. | `sound:ENTITY_ENDERMAN_TELEPORT;1.0f;1.0f` |
| playsound_resource_pack | Plays a sound from a resource pack. | `playsound_resource_pack:ENTITY_ENDERMAN_TELEPORT;1.0f;1.0f` |
| message | Sends a chat message to the player. | `message:You can’t claim this kit.` |
| center_message | Sends a centered message to the player. | `center_message:You can’t claim this kit.` |
| mini_message | Sends a MiniMessage formatted message. | `mini_message:You can’t claim this kit.` |
| broadcast | Sends a message to all players. | `broadcast:You can’t claim this kit.` |
| titles | Sends a title and subtitle to the player. | `titles: