CommandPanels/README.md
2025-10-30 22:59:49 +11:00

116 lines
3.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

![TitleLogo](https://commandpanels.net/resource_images/main_logo.png)
## 🏆 Trusted GUI Plugin since 2019
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 custom tools and admin panels, you can design powerful GUIs using YAML or the online editor.
- ✅ Actively maintained for 6+ years
- 🖼️ Online editor for rapid menu building
- 🧠 Advanced logic and data support
- 🌍 Cross-platform (Java + Bedrock)
- 📘 Full documentation and community Discord
---
## Useful Links
- [📘 **Documentation**](https://docs.commandpanels.net)
- [🛠️ **Online Editor**](https://commandpanels.net/editor)
- [💬 **Discord**](https://discord.gg/WFQMTZxa53)
---
## Online Editor
The online editor includes support for **all three panel types**.
Its not just a basic form builder, its a **live YAML editor** with structure checks and visual previews, helping you work faster and avoid YAML errors.
See a showcase of the editor [here](https://youtu.be/6m4KRHe1jkA?si=sDNiFU3PsJzPBKbB)!
![ExampleScreenshot](https://commandpanels.net/resource_images/example_editor.png)
- ⚡ 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
### Inventory Panels
Create fully interactive GUIs for shops, kits, navigation menus, or custom tools.
![RawInventory](https://commandpanels.net/resource_images/raw_inventory.webp)
---
### Dialog Panels
Build structured, custom interfaces that can be used to request custom input.
![RawDialog](https://commandpanels.net/resource_images/raw_dialog.webp)
---
### Floodgate Panels
Bring **full GUI support to Bedrock players** using Geyser and Floodgate.
CommandPanels is one of the only plugins that natively supports this.
![RawFloodgate](https://commandpanels.net/resource_images/raw_floodgate.webp)
---
## About
Minecraft servers rely on GUIs for everything from shops and lobbies to quests and server tools.
CommandPanels provides a **streamlined YAML scripting format** designed to make GUI creation both **accessible** and **deeply customizable**.
- Inline logic & conditions
- Dynamic placeholders
- Persistent & session data
- Full PlaceholderAPI support
- Modern, clean codebase
Developed in Australia 🇦🇺
---
## Server Compatibility
CommandPanels is fully compatible with **Paper** and **Folia** servers.
---
## Our Partner
![ParterLogo](https://commandpanels.net/resource_images/partner_logo.png)
We have proudly partnered with [ReviveNode](http://billing.revivenode.com/aff.php?aff=379)!
CommandPanels users get **15% off their first month** with the promo code: **PANELS**
ReviveNode provides high-performance, reliable Minecraft hosting, making 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.