mirror of
https://github.com/rockyhawk64/CommandPanels.git
synced 2025-11-18 07:14:17 +01:00
update readme
This commit is contained in:
parent
ba489b1128
commit
4172e4866e
109
README.md
109
README.md
@ -1,61 +1,114 @@
|
|||||||

|

|
||||||
|
|
||||||
## Trusted GUI Plugin since 2019
|
## 🏆 Trusted GUI Plugin since 2019
|
||||||
|
|
||||||
CommandPanels makes it easy to create interactive menus without coding.
|
CommandPanels isn't like other menu plugins it's a **GUI framework**. it gives you true dynamic control through **logic**, **data**, and **panel variety**.
|
||||||
From shops and quests to server tools, you can design custom GUIs with YAML or the online editor.
|
From shops and quests to custom tools and admin panels, you can design powerful GUIs using YAML or the online editor.
|
||||||
|
|
||||||
- ✅ Actively maintained for 6+ years
|
- ✅ Actively maintained for 6+ years
|
||||||
- 🖼️ Online editor for faster menu building
|
- 🖼️ Online editor for rapid menu building
|
||||||
- 🌍 Cross-platform support (Java + Bedrock)
|
- 🧠 Advanced logic and data support
|
||||||
- 📘 Full docs and community Discord
|
- 🌍 Cross-platform (Java + Bedrock)
|
||||||
|
- 📘 Full documentation and community Discord
|
||||||
|
|
||||||
## Useful Links
|
---
|
||||||
|
|
||||||
### [📘 Documentation](https://docs.commandpanels.net)
|
## 🌐 Useful Links
|
||||||
### [🛠️ Online Editor](https://commandpanels.net/editor)
|
|
||||||
### [💬 Join Discord](https://discord.gg/WFQMTZxa53)
|
- [📘 **Documentation**](https://docs.commandpanels.net)
|
||||||
|
- [🛠️ **Online Editor**](https://commandpanels.net/editor)
|
||||||
|
- [💬 **Discord**](https://discord.gg/WFQMTZxa53)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Online Editor
|
## Online Editor
|
||||||
The online editor includes support for all three panel types. This means you can visually create and edit Dialog, Inventory, and Floodgate panels with ease, previews are not 1:1 but will significantly speed up development and testing.
|
|
||||||
|
The online editor includes support for **all three panel types**.
|
||||||
|
It’s not just a basic form builder, it’s a **live YAML editor** with structure checks and visual previews, helping you work faster and avoid YAML errors.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
- ⚡ Visual layout builder with slot highlighting
|
||||||
|
- 🧹 Automatic indentation & structure checks
|
||||||
|
- ✅ Works with Inventory, Dialog, and Floodgate panels
|
||||||
|
- 🧠 Supports complex panels, not just simple menus
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Real Logic. Real Data.
|
||||||
|
|
||||||
|
CommandPanels lets you build menus that **react to players**, not just display static items.
|
||||||
|
|
||||||
|
- Inline `$AND`, `$OR`, `$NOT` operators and grouping
|
||||||
|
- Multiple items in a single slot with logical fallbacks
|
||||||
|
- **Persistent** or **session-based data** usable anywhere, even in other plugins via PlaceholderAPI
|
||||||
|
|
||||||
|
**Example Condition:**
|
||||||
|
~~~
|
||||||
|
conditions: "$NOT (%player_name% $EQUALS Steve) $AND %vault_eco_balance% $ATLEAST 5000"
|
||||||
|
~~~
|
||||||
|
|
||||||
|
This allows for **powerful, dynamic behavior** without scripting.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## GUI Types
|
## GUI Types
|
||||||
|
|
||||||
### Inventory Panels *(can be used for complex GUI creation)*
|
### Inventory Panels
|
||||||
|
Create fully interactive GUIs for shops, kits, navigation menus, or custom tools.
|
||||||
|
|
||||||

|

|
||||||
### Dialog Panels *(can be used for custom interfaces and requesting player input)*
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Dialog Panels
|
||||||
|
Build structured, custom interfaces that can be used to request custom input.
|
||||||
|
|
||||||

|

|
||||||
### Floodgate Panels *(can be used for Bedrock players on your server)*
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Floodgate Panels
|
||||||
|
Bring **full GUI support to Bedrock players** using Geyser and Floodgate.
|
||||||
|
CommandPanels is one of the only plugins that natively supports this.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## About
|
## About
|
||||||
Minecraft servers use graphical interfaces (GUIs) for a wide range of features,
|
|
||||||
from server lobbies and player shops to quests and custom tools. CommandPanels provides a
|
|
||||||
streamlined YAML scripting format designed to make GUI creation both accessible and highly customizable.
|
|
||||||
|
|
||||||
With built-in support for variables, persistent data, placeholders,
|
Minecraft servers rely on GUIs for everything from shops and lobbies to quests and server tools.
|
||||||
conditions, and more, you can design interactive menus tailored to your server's needs without complex programming.
|
CommandPanels provides a **streamlined YAML scripting format** designed to make GUI creation both **accessible** and **deeply customizable**.
|
||||||
|
|
||||||
CommandPanels supports three distinct panel types, each with unique capabilities:
|
- Inline logic & conditions
|
||||||
|
- Dynamic placeholders
|
||||||
- Inventory Panels allow you to build item-based interfaces where players can interact with and manipulate items directly.
|
- Persistent & session data
|
||||||
- Dialog Panels are perfect for creating structured, menu-based conversations and navigation systems, ideal for quests or guided menus.
|
- Full PlaceholderAPI support
|
||||||
- Floodgate Panels enable full GUI support for Bedrock Edition players through Geyser and Floodgate, ensuring cross-platform compatibility.
|
- Modern, clean codebase
|
||||||
|
|
||||||
Developed in Australia 🇦🇺
|
Developed in Australia 🇦🇺
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Server Compatibility
|
## Server Compatibility
|
||||||
|
|
||||||
This plugin is a **Paper** plugin, it will only work on Paper and its forks.
|
CommandPanels is fully compatible with **Paper** and **Folia** servers.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Our Partner
|
## Our Partner
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
We have proudly partnered with [ReviveNode](http://billing.revivenode.com/aff.php?aff=379)!
|
We have proudly partnered with [ReviveNode](http://billing.revivenode.com/aff.php?aff=379)!
|
||||||
CommandPanels users have been offered 15% off on the first month by using the Promocode: **PANELS**
|
CommandPanels users get **15% off their first month** with the promo code: **PANELS**
|
||||||
|
|
||||||
ReviveNode is a leading Minecraft hosting provider that offers affordable and high-quality server hosting solutions.
|
ReviveNode provides high-performance, reliable Minecraft hosting, making them the perfect partner for CommandPanels.
|
||||||
Their focus on performance, reliability, and customer support makes them the perfect partner for CommandPanels.
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Trusted by Servers Worldwide
|
||||||
|
|
||||||
|
For over 6 years, CommandPanels has powered **thousands of Minecraft servers**.
|
||||||
|
Whether you're running survival, MMO, minigames, or custom networks, it can handle it.
|
||||||
Loading…
Reference in New Issue
Block a user