🇱🇷
zMenu
Marketplace
English
English
  • 🍾Getting started
  • 🔌Installing zMenu
  • ➕Supported Plugins
  • 👍zMenu+
  • â›°ī¸Configurations
    • â„šī¸Informations
    • 📜Commands and Permissions
    • đŸĒ§PlaceHolder
    • How to create an inventory step by step
    • 👨‍đŸ’ģInventories
    • âšī¸Buttons
    • 🏁Requirements
    • â˜ĸī¸Actions
    • đŸĒItems
    • Global Placeholders
    • 🔋Patterns
    • Commands
    • 🛝Player data
    • đŸĻŦConfig.json
  • API
    • â„šī¸Getting Started with zMenu API
    • Creating a Basic Button
    • Creating a Pagination Button
    • Creating a Custom Loader
    • Creating a Custom Action
    • Creating a Custom Material Loader
    • Creating a Custom Permission System
    • Creating and Using Inventory Files
  • Plugin Initialization and Registration
  • đŸ—ƒī¸Plugin's files
  • Update to new API
Powered by GitBook
On this page
  • Requirements
  • Installation
  • Snapshots
Edit on GitHub
  1. API

Getting Started with zMenu API

PreviousConfig.jsonNextCreating a Basic Button

Last updated 1 day ago

This tutorial will guide you through creating a plugin using the , a powerful system to create advanced and dynamic inventory menus for Minecraft servers.

Requirements

  • Java 21+

  • Spigot or Paper (1.20.4+ recommended)

  • Basic knowledge of plugin development

Installation

To use the zMenu API in your plugin, you need to add the repository and dependency to your build system.

Maven

Add the repository:

<repositories>
  <repository>
    <id>groupez</id>
    <url>https://repo.groupez.dev/releases</url>
  </repository>
</repositories>

Add the dependency:

<dependencies>
  <dependency>
    <groupId>fr.maxlego08.menu</groupId>
    <artifactId>zmenu-api</artifactId>
    <version>1.1.0.0</version>
    <scope>provided</scope>
  </dependency>
</dependencies>

Gradle Kotlin DSL

Add the repository:

repositories {
    maven {
        name = "groupez"
        url = uri("https://repo.groupez.dev/releases")
    }
}

Add the dependency:

dependencies {
    compileOnly("fr.maxlego08.menu:zmenu-api:1.1.0.0")
}

Gradle Groovy DSL

Add the repository:

repositories {
    maven {
        name "groupez"
        url "https://repo.groupez.dev/releases"
    }
}

Add the dependency:

dependencies {
    compileOnly "fr.maxlego08.menu:zmenu-api:1.1.0.0"
}

Snapshots

If you want to test development versions, replace releases by snapshots in the repository URL:

  • https://repo.groupez.dev/snapshots

â„šī¸
zMenu API