GroupeZ Docs

Installation

How to install and configure zCookieClicker on your Minecraft server

This guide covers the installation and initial configuration of zCookieClicker.

Requirements

Before installing, ensure your server meets these requirements:

RequirementVersionStatus
Java17 or higherRequired
Minecraft1.13 or higherRequired
zMenuLatest versionRequired
PlaceholderAPILatest versionOptional

Supported Platforms

PlatformSupport
PaperRecommended
SpigotSupported
PurpurSupported

Installation Steps

1. Download the Plugin

Download zCookieClicker from:

2. Install Dependencies

Install the required dependency:

  1. zMenu - Download from Modrinth and place the .jar in your plugins/ folder. zCookieClicker uses zMenu for all GUI interfaces.

3. Install the Plugin

  1. Stop your server
  2. Place zCookieClicker.jar in your plugins/ folder
  3. Start your server
  4. The plugin will generate all default configuration files

4. Verify Installation

Run /cookie in-game. If the plugin is loaded correctly, it will open the Cookie Clicker GUI.

File Structure

After first startup, zCookieClicker creates the following structure:

plugins/zCookieClicker/
├── config.yml                    # Main configuration
├── messages.yml                  # Plugin messages
├── inventories/
│   ├── cookies.yml               # Main cookie GUI
│   └── cookies-upgrade.yml       # Upgrades GUI
└── patterns/
    └── cookie-upgrade.yml        # Upgrade button pattern

Database Configuration

zCookieClicker supports three storage backends.

SQLite (Default)

SQLite is the default storage method and requires no additional configuration:

sql:
  type: SQLITE

MySQL

For larger servers:

sql:
  type: MYSQL
  user: homestead
  password: secret
  port: 3306
  host: 192.168.10.10
  database: zcookieclicker
  prefix: "zcookieclicker_"
  retry: 5
  debug: false

MariaDB

sql:
  type: MARIADB
  user: homestead
  password: secret
  port: 3306
  host: 192.168.10.10
  database: zcookieclicker
  prefix: "zcookieclicker_"
  retry: 5
  debug: false
OptionDescription
typeStorage type: SQLITE, MYSQL, or MARIADB
userDatabase username
passwordDatabase password
portDatabase port
hostDatabase host address
databaseDatabase name
prefixTable prefix
retryConnection retry attempts
debugEnable SQL debug logging

Make sure to change the default database credentials before deploying to production.

First Configuration

After installation, here are the recommended first steps:

  1. Storage - Choose your storage backend in config.yml
  2. Upgrades - Customize upgrade costs and CPS values
  3. Number Format - Configure how large numbers are displayed
  4. Messages - Customize plugin messages in messages.yml
  5. GUIs - Customize the cookie and upgrade GUIs

See the Configuration section for detailed options.

Troubleshooting

Plugin does not start

  • Check that Java 17+ is installed: java -version
  • Verify that zMenu is installed and loads without errors
  • Check the server console for error messages

GUI not opening

  • Verify zMenu is installed and working properly
  • Check that inventory files exist in plugins/zCookieClicker/inventories/
  • Look for errors in the console

Database connection failed

  • Verify your database credentials in config.yml
  • Ensure the MySQL/MariaDB server is running
  • Check firewall settings if using a remote database
  • Confirm the database exists

Cookies not saving

  • Check database connection is working
  • Enable debug: true in the SQL configuration
  • Verify the database tables were created

Next Steps

Introduction

Introduction to zCookieClicker - A Cookie Clicker mini-game for Minecraft servers

Commands & Permissions

Complete list of all commands and permissions for zCookieClicker

On this page

RequirementsSupported PlatformsInstallation Steps1. Download the Plugin2. Install Dependencies3. Install the Plugin4. Verify InstallationFile StructureDatabase ConfigurationSQLite (Default)MySQLMariaDBFirst ConfigurationTroubleshootingPlugin does not startGUI not openingDatabase connection failedCookies not savingNext Steps
GroupeZ MCP

Documentation in your AI

MCP lets your AI search GroupeZ documentation and read current examples to help you configure your plugins.

Read-only · No documentation API key needed

1. Copy the server URL

Transport: HTTP (Streamable HTTP). Authentication: none. Your tool uses its own model and subscription limits.

  1. Open Plugins in ChatGPT on the web, then + → Add custom MCP server.
  2. Name it ‘GroupeZ Documentation’, paste the URL above and choose ‘No authentication’. Create and install the plugin.
  3. In a conversation, type @ and select the plugin before asking. If needed, enable search, get_page and list_pages in its settings.
Official setup guide

3. Ask a question

Use GroupeZ MCP to help me create a zMenu inventory. Search relevant pages, read the examples and cite your sources.
Other clients and troubleshooting

For clients using mcpServers, adapt this example to their format:

{
  "mcpServers": {
    "groupez-docs": {
      "url": ""
    }
  }
}

Available tools are search, get_page and list_pages. Refresh the connector’s tools after updates. If your AI cannot access them, check that the connector is enabled in the conversation and your account allows custom MCP servers. Opening the URL in a browser is not an MCP test.