Skip to content
Mint Client

Plugins Folder Structure

The folder structure of the plugins folder is designed to organize all necessary files and libraries required for developing and managing plugins using the Mint CLI. Below is a detailed breakdown of the various directories and their purposes.

Working Directory

The Working Directory is where the Mint CLI is placed. This folder contains essential components like the CLI executable, a data directory for libraries, the plugins directory, and the api_key.txt file used for authentication.

  • Directoryplugins-mint/
    • mint-cli.exe The Mint CLI executable file
    • Directorydata/ Directory containing required libraries and tools
      • …
    • Directoryplugins/ Directory where all plugins are stored
      • …
    • api_key.txt File containing the API key for authentication

Data Directory

The Data Directory holds all the necessary libraries, the Java Development Kit (JDK), and Minecraft libraries needed for plugin development. It also includes the plugin template and version information.

  • Directorydata/
    • Directoryjdk/
      • Directoryjava-8/
        • …
      • Directoryjava-17/
        • …
      • Directoryjava-21/
        • …
    • Directorylibs/
      • Minecraft.jar
      • MintClient.jar
    • Directorytemplate/
      • …
    • VERSION.txt

Plugins Directory

The Plugins Directory is where all your active plugins reside. Every time you download, upload, or work on a plugin using the Mint CLI, this directory is utilized.

  • Directoryplugins/
    • Directorytest-plugin/
      • …
    • Directoryautofish-plugin/
      • …
    • Directoryexample-plugin/
      • …

Plugin Folder Structure

Each plugin folder follows a specific structure to ensure it can be built and run properly. Here’s a breakdown of the structure for an individual plugin:

  • The .vscode/ folder contains the Visual Studio Code workspace and settings for opening and editing the plugin in VS Code.
  • The plugin.yaml file is the configuration file where you can customize the plugin’s name, description, and visibility.
  • The src/ folder contains the Java source code files, which will be compiled into the actual plugin.
  • Directoryexample-plugin/
    • Directory.vscode/
      • settings.json
      • example-plugin.code-workspace
    • Directorysrc/
      • Directorycom/
        • Directoryexample/
          • ExamplePlugin.java
    • plugin.yaml

Key Elements of a Plugin Folder:

  1. .vscode/: Contains the workspace and settings to configure the plugin for development in Visual Studio Code.
  2. plugin.yaml: Defines metadata like the plugin’s name, description, and visibility.
  3. src/: This is where the actual plugin code is stored, organized in Java packages.