First Gui - ParzivalExe/guiapi GitHub Wiki

Create a Gui

Create a command

To create a Gui you will create a new Object from the type Gui. So start with a new Command Class and named it GuiTestCommand.

public class GuiTestCommand implements Commandeer {
    @Override
    public boolean onCommand(CommandSender sender, Command cmd, String label, String[] args) {
        if(sender instance Player) {
            Player player = (Player) sender;
            /*CREATE THE GUI*/
        }
        return true;
    }
}

We have to ask if the sender is a Player with the statement if(sender instanceof Player) because we can only open the Gui to a real player (since only a real player can see and interact with an inventory). Of course you have to set this new command class in the onEnable method.

@Override
public void onEnable() {
    ...
    getCommand("MyFirstGui").setExecutor(new GuiTestCommand());
    ...
}

Don't forget to write this command in your plugin.yml.

The first Gui

After this normal code we will create our first gui. For this you need a new Object from the type Gui. Write the following Code under the creation of the variable player:

Gui gui = new Gui("first gui").

In this code you create a new Gui with the variable name gui. The Name of this Gui is "first gui".

Open a Gui

If you run this command it will do nothing, because you have to open the Gui. You can open a gui with the method openGui(Player player). Add the following line in our code: gui.openGui(player).

The Gui will be shown to the player you write as the first argument. In our example we will open the Gui for the player who perform this command so we took your CommandSender casted to a player.

After that your full code for the TestCommand should look like this:

public class GuiTestCommand implements CommandExecutor {
    
    @Override
    public boolean onCommand(CommandSender sender, Command cmd, String label, String[] args) {
        if(sender instanceof Player) {
            Player player = (Player) sender;
            Gui gui = new Gui("first gui");
            gui.openGui(player);
        }
    }
}

Export this plugin and run it on a Bukkit or Spigot server. Remember that you also need the Gui API in the plugins folder. When you perform this command you will see an inventory with the name first gui.

In the next article I will show you how you can create your first component and set it into the gui. If you want to see this article click here