From 3c5d211e391519cb77294af9c5d7dd700b9e3785 Mon Sep 17 00:00:00 2001 From: Fulminazzo Date: Wed, 11 Dec 2024 23:31:01 +0100 Subject: [PATCH] Added bukkit section --- gui/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/gui/README.md b/gui/README.md index 00ad659e..222920dd 100644 --- a/gui/README.md +++ b/gui/README.md @@ -92,3 +92,11 @@ Note that this **will include calls to `WrappersYAGLParser#addAllParsers()` and therefore it is **not necessary** to include them later. ### Bukkit +The `bukkit` module contains **Bukkit** related objects and converters. +It provides two main classes: +- [GUIManager](bukkit/src/main/java/it/fulminazzo/yagl/GUIManager.java), + which acts as a **listener** for all the **GUI events**. + As already stated from the Javadoc, the user **should not register it** in their plugin, + since this process is **automatic**; +- [GUIAdapter](bukkit/src/main/java/it/fulminazzo/yagl/GUIAdapter.java), + which allows the developer to directly **convert YAGL GUIs to Bukkit inventories** and viceversa.