Home

The New Menu Library

Welcome to the documentation for The New Menu Library! This library provides a powerful and flexible framework for creating graphical user interfaces (GUIs) in Minecraft plugins. Whether you want to create custom menus for Folia, Spigot, Paper or Sponge, this library is for you!

Table of Contents

1. Overview
2. Getting Started
   • Installation
   • Example Usage
3. Features
4. Structure
   • Introduction
   • Menu Class
     • Key Features
   • Page Class
     • Key Features
   • Icon Class
     • Key Features
   • StateIcon Class
     • Key Features
   • IconBuilder Class
     • Key Methods
   • MenuBuilder Class
     • Key Methods
   • PageBuilder Class
     • Key Methods
   • Useful Classes
     • Constraint Interface
       • ICON_PERMISSION
       • ICON_MESSAGE
     • IconAction Class
       • ChatAction
       • DataAction
       • RunnableAction
       • SwitchMenuAction
       • SwitchPageAction
   • Conclusion
5. Contributing
6. License

Overview

The New Menu Library is designed to simplify the process of creating interactive menus and UIs in Minecraft plugins. It provides a clean and intuitive API for constructing menus, defining icons, and handling player interactions. Whether you're a seasoned developer or new to plugin development, this library aims to enhance the user experience by making menu creation easy and enjoyable.

Documentation

Menu

The Menu class represents a menu in the library. It provides methods for adding pages, handling player interactions, and more.

Icon

The Icon class represents an icon in a menu. Icons can have actions, constraints, and dynamic item providers.

MenuBuilder

The MenuBuilder class is a builder for creating instances of the Menu class. It provides methods for setting menu properties and adding pages.

IconBuilder

The IconBuilder class is a builder for creating instances of the Icon class. It provides methods for setting icon properties, adding actions, and applying constraints.

For detailed documentation and usage examples, refer to the specific class documentation.

License

This library is licensed under the GNU Affero General Public License (AGPL-3.0). See the LICENSE file for details.