Skip to content

ZetaPlugins/CookieClickerZ

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

banner


paper purpur github modrinth discord-plural gitbook

CookieClickerZ is a Minecraft Cookie Clicker plugin, that brings the popular Cookie Clicker game to your Minecraft Server. You can either customize the plugin to the last detail or use the standard installation for the traditional cookieclicker experience.

Features

  • âś… As many clicker blocks as you want
  • âś… Customizable upgrades
  • âś… Events
  • âś… Prestige system
  • âś… Achievements
  • âś… Top list
  • âś… Offline cookie gathering
  • âś… Anti-cheat system
  • âś… Fully customizable messages, sounds, and items
  • âś… HEX colors and gradients support
  • âś… PlaceholderAPI placeholders
  • âś… SQLite and MySQL support
  • âś… Admin commands

Permissions

  • cookieclickerz.useclicker - Allows the player to use the clicker block (default: true)
  • cookieclickerz.upgrades - Allows the player to open the upgrades shop (default: true)
  • cookieclickerz.prestige - Allows the player to open the prestige menu (default: true)
  • cookieclickerz.top - Allows the player to open the top menu (default: true)
  • cookieclickerz.viewachievements - Allows the player to open the achievements menu (default: true)
  • cookieclickerz.numcheatsheet - Allows the player to open the numcheatsheet (default: true)
  • cookieclickerz.admin.manageclickers - Allows the player to manage clickers (default: op)
  • cookieclickerz.admin.managecookies - Allows the player to manage other players cookies (default: op)
  • cookieclickerz.admin.manageprestige - Allows the player to manage other players prestige (default: op)
  • cookieclickerz.admin.manageevents - Allows the player to manage events (default: op)
  • cookieclickerz.admin.manageachievements - Allows the player to manage other players achievements (default: op)
  • cookieclickerz.admin.giveupgrade - Allows the player to give upgrades to other players (default: op)
  • cookieclickerz.buyupgrade. - Allows the player to buy a certain upgrade (if requirePermission is true for that upgrade) (default: op)

Placeholders

  • %cookieclickerz_totalcookies% - A users total cookies
  • %cookieclickerz_totalcookies_formatted% - A users total cookies (formatted, e.g. 1M, 3B, 5.1T)
  • %cookieclickerz_cookiesperclick% - The amount of cookies a user gets per click
  • %cookieclickerz_offlinecookies% - The amount of cookies a user gets while offline
  • %cookieclickerz_prestige% - The prestige of a user
  • %cookieclickerz_totalclicks% - A users total clicks

Leaderboard

The leaderboard placeholders follow this format:

%cookieclickerz_<category>_top_<index>_<field>%
  • <category> is what leaderboard to show. This can be cookies for total cookies or cpc for cookies per click.
  • <index> is the position in the leaderboard (e.g. 1 for the first place or 3 for the third place). The limit for this can be set in the config.yml (default limit: 10).
  • field is what about this player to show. This can be:
    • name: The name of the player
    • amount: The amount depending on what cateory you chose
    • formattedamount: The same as amount, but formatted (e.g. 1000000 -> 1M)

Configuration

You can customize the plugin to your liking by editing the config.yml, upgrades.yml, and prestige.yml files located in the plugins/CookieClickerZ folder.

config.yml
#       _____           _    _         _____ _ _      _               ______
#     / ____|          | |  (_)       / ____| (_)    | |             |___  /
#    | |     ___   ___ | | ___  ___  | |    | |_  ___| | _____ _ __     / /
#    | |    / _ \ / _ \| |/ / |/ _ \ | |    | | |/ __| |/ / _ \ '__|   / /
#    | |___| (_) | (_) |   <| |  __/ | |____| | | (__|   <  __/ |     / /__
#     \_____\___/ \___/|_|\_\_|\___|  \_____|_|_|\___|_|\_\___|_|    /_____|

# !!! COLOR CODES !!!
# This plugin supports old color codes like: &c, &l, &o, etc
# It also supports minimessage, which is a more advanced way to format messages:
# https://docs.advntr.dev/minimessage/format.html
# With these, you can also add HEX colors, gradients, hover and click events, etc

# If set to true, CookieClickerZ will check for updates and let you know if there's a newer version
checkForUpdates: true

# Set the language to any code found in the "lang" folder (don't add the .yml extension)
# You can add your own language files. Use https://github.com/KartoffelChipss/CookieClickerZ/tree/main/src/main/resources/lang/en-US.yml as a template
# Default languages are: en-US, de-DE, ru-RU, cs-CZ
lang: "en-US"

# The the cookie name
# This is to conveniently change the cookie name in most messages. You will probably also want to adjust some other messages in your respective language file.
cookieName: "Cookies"

# The item that will be displayed in the middle of the main gui
mainItem: "COOKIE"

offlineCookies:
  # If set to true, players will earn cookies while they are offline
  enabled: true
  # Wether or not to send a message to the player when they join informing them about the cookies they earned while offline
  joinMessage: true

# Wether or not to show a hologram above the clicker block
# You need to have DecentHolograms or FancyHolograms installed for this to work (although DecentHolograms is recommended):
# https://modrinth.com/plugin/decentholograms
# You can change the content of the hologram in the language file
hologram: true


# === LEADERBOARD ===

# [!] After changing any of these settings, you need to restart the server for them to take effect

leaderboard:
    # Leaderboard calculations are expensive, so they are only calculated every interval.
    # If you don't use it and want to save some performance, you can disable it all together.
    enabled: true
    # The number of top players to show on the leaderboard
    size: 10
    # The interval (in seconds) at which the leaderboard will be updated
    updateInterval: 60


# === EVENTS ===

events:
  # Toggle Events, like Click Frenzy, Cookie Frenzy, etc
  enabled: true
  # The probability of an event happening for each click
  rates:
    COOKIE_FRENZY: 0.005
    LUCKY: 0.007
    CLICK_FRENZY: 0.002
    RUIN: 0.002
    CURSED_FINGER: 0.002


# === SOUNDS ===

# The sound that will be played when a player clicks a block
# You can find a list of sounds here: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Sound.html
clickSound: "BLOCK_WOODEN_BUTTON_CLICK_ON"
# The sound that will be played when a player buys an upgrade
upgradeSound: "ENTITY_PLAYER_LEVELUP"
# The sound that will be played when a player prestiges
prestigeSound: "ENTITY_PLAYER_LEVELUP"
# The sound when there was an error
errorSound: "ENTITY_VILLAGER_NO"


# === ANTICHEAT ===

anticheat:
  cps:
    # If set to true, the plugin will check for the amount of clicks per second
    enabled: true
    # The maximum amount of clicks per second a player is allowed to do
    max: 15
    # The message that will be sent to a player if they click too fast
    message: "&cYou are clicking too fast!"
    # The commands that will be executed if a player clicks too fast
    commands:
    #- "kick %player% &cYou are clicking too fast!"

  nomovement:
    # If set to true, the plugin will check if a player is moving
    enabled: true
    # The maximum amount of time a player is allowed to not move (in seconds)
    max: 15
    # The message that will be sent to a player if they are not moving
    message: "&cYou are not moving!"
    # The commands that will be executed if a player is not moving
    commands:
    # - "kick %player% &cYou are not moving!"


# === EXPERT ===
# This section is only relevant if you are an expert and know what you are doing

playerCache:
    # If set to true, the plugin will use a cache to store player data
    enabled: true
    # The amount of time (in seconds) the plugin will wait before saving the whole cache to the database
    saveInterval: 60
    # The maximum amount of players that will be stored in the cache
    maxSize: 1000


# === STORAGE ===

storage:
  # The type of storage to use. You have the following options:
  # "SQLite" | "MySQL"
  type: "SQLite"

  # This section is only relevant if you use a remote database
  host: "localhost"
  port: 3306
  database: "cookieclicker"
  username: "root"
  password: "password"
upgrades.yml
# === UPGRADES ===

# You can add as many upgrades as you want following this structure
wooden_pickaxe:
  # The name of the upgrade
  name: "&6Wooden Pickaxe"
  # The price of the upgrade
  baseprice: "50"
  # The price multiplier for each upgrade
  priceMultiplier: 1.1
  # The material that will be displayed in the shop
  item: "WOODEN_PICKAXE"
  # The amount of cookies per click the upgrade will add
  cpc: "1"
  # The amount of cookies the player will get while offline
  offlineCookies: "0"
  # Custom mdoel ID to apply a texture to the item (requires a resource pack)
  customModelId: 300
  # Wether the player needs the cookieclickerz.buyupgrade.<upgrade> permission to buy this upgrade
  requirePermission: false

...

# Add more items as needed following this structure
prestige.yml
# === PRESTIGE ===

# If set to true, the plugin will enable the prestige system
enabled: true

# You can add or remove as many prestige levels as you want. (Everything beyond the 29th level will be ignored)
levels:
  1:
    # The name of the prestige level
    name: "&8&l> <!b>&6Prestige I"
    # Additional lore for the prestige level (optional)
    # You can use the placeholders %price% and %multiplier% in the lore
    lore:
      #- "This is some additional lore for Prestige I"
    # If true, the original lore will be hidden and only the additional lore will be shown
    hideOriginalLore: false
    # The price of the prestige level
    cost: "1M"
    # The multiplier that will be applied to the player's cookies
    multiplier: 2
    # The commands that will be executed when a player prestiges to this level
    # You can use %player% to insert the player's name
    commands:
      - "say %player% has just prestiged to Prestige I!"

  2:
    name: "&8&l> <!b>&6Prestige II"
    cost: "10M"
    multiplier: 3

  3:
    name: "&8&l> <!b>&6Prestige III"
    price: "100M"
    multiplier: 4

  4:
    name: "&8&l> <!b>&6Prestige IV"
    cost: "1B"
    multiplier: 5

  5:
    name: "&8&l> <!b>&6Prestige V"
    cost: "10B"
    multiplier: 6
achievements.yml
# === Clicks Achievements ===
clicks_clicker_rookie:
  commands:
  # - "say %player% has earned the achievement Clicker Rookie!"

clicks_finger_workout:
  commands:
  # - "say %player% has earned the achievement Finger Workout!"

clicks_click_champion:
  commands:
  # - "say %player% has earned the achievement Click Champion!"

...
achievementCategories.yml
# This file contains the settings for the achievemnt categories.

clicks:
  # This is the texture for the head item representing the "clicks" category.
  # You can find these values in the "Value" field in the "For Developers" section on minecraft-heads.com
  head: "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvNTMyYTU4MzhmZDljZDRjOTc3ZjE1MDcxZDY5OTdmZjVjN2Y5NTYwNzRhMmRhNTcxYTE5Y2NlZmIwM2M1NyJ9fX0="

cookies:
  head: "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvNjA1ZWY4ODE5ZmI2YTkyMTQ4MjQ5ZmY0OGMzOTE0ZTkyYzI3M2U3ODc0NTIzZmY3OTMwYjlmNWNjOTNjZWFhZSJ9fX0"

upgrades:
  head: "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvOTVmZDY3ZDU2ZmZjNTNmYjM2MGExNzg3OWQ5YjUzMzhkNzMzMmQ4ZjEyOTQ5MWE1ZTE3ZThkNmU4YWVhNmMzYSJ9fX0="

events:
  head: "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvZjJiYTllYWQ5N2M4ZmI0NGIxNTZhZGU5Y2IyMTRlYTkxMjQzNGEyY2M0N2M0ZGVjNTBmMjEwMjFjNzVkZDJkNyJ9fX0="

prestige:
  head: "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvOTkwY2JkNzJlNDFhOWJkNDExYmU5MjliNzNmZDI2OTIwNjM2OGIyODEwZDZjNjgxOTkxOGNiOGViNjYyMjRmNCJ9fX0="

misc:
  head: "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvMjAzNzEyMDYyZTgyYTA3OTdmZDdiMGMxMDU3NmVkOTI0ODBmZGM5NGJkMmUwMGMyMTk2MWIzNGJlNjBlODU4ZSJ9fX0="
...

Usage

About

CookieClickerZ - A highly customizable, fun CookieClicker plugin for Minecraft!

Topics

Resources

License

Stars

Watchers

Forks

Contributors 4

  •  
  •  
  •  
  •  

Languages