CropClick Wiki

Jul 31, 2020
CropClick Wiki
  • Hello and welcome to the CropClick Wiki!

    Code (YAML):
    # If this is true then the plugin is activated
    Activated
    : true

    # If this is true then the auto farm is activated
    Activated-Dispenser
    : true

    # If this is true then the player with permissions will receive an update message for the plugin when it got a new update
    Activated-Update-Message-Player
    : true

    # If this is true then the console will receive an update message for the plugin when it got a new update
    Activated-Update-Message-Console
    : true

    Crops-Value
    :

      # The number of wheat the player will receive when it clicks a wheat crop.
      Wheat
    : 1

      # The number of wheat seeds the player will receive when it clicks a wheat crop.
      Wheat-Seeds
    : 3

      # The number of beetroots the player will receive when it clicks a beetroot crop.
      Beetroot
    : 1

      # The number of beetroot seeds the player will receive when it clicks a beetroot crop.
      Beetroot-Seeds
    : 2

      # The number of carrots the player will receive when it clicks a carrot crop.
      Carrot
    : 4

      # The number of potatoes the player will receive when it clicks a potato crop.
      Potato
    : 4

      # The chance of getting a poison potato drop when clicking a potato crop.
      Poison-Potato-Percent
    : 33

      # The number of nether warts the player will receive when it clicks a netherwart crop.
      Netherwart
    : 4

      # The number of nether warts the player will receive when it clicks a sugarcane crop.
      Sugarcane
    : 4

      # The number of nether warts the player will receive when it clicks a cactus crop.
      Cactus
    : 4

    # If the value equals true then it is enabled and if the value equals false then it is disabled

    Activated-Crops
    :
      Wheat
    : true
      Beetroot
    : true
      Potato
    : true
      Carrot
    : true
      Netherwart
    : true
      Wheat-Seeds
    : true
      Beetroot-Seeds
    : true
      Poison-Potato-Percent
    : true
      Sugarcane
    : true
      Cactus
    : true

    Settings
    :
     # If this is false then players will not be able to right-click crops. While if it is true then right-clicking plants will work.
      Can-Right-Click
    : true

      # If this is false then players will not be able to left-click/punch crops. While if it is true then left-click/punch plants will not work.
      Can-Left-Click
    : false

      # If this is false then players will not be able to jump on crops. While if it is true then the player can jump on the crops.
      Can-Jump-On
    : true
     
      # If Mode equals CropClick then it will give more random amounts of drops.
      # While when it equals Vanilla then it will give the number of drops that Vanilla Minecraft gives you by punching a crop.
      Mode
    : CropClick
     
      # Settings for MCMMO
      MCMMO
    :

        # This setting is the amount of MCMMO XP the player will receive when right-clicking a crop.
        XP
    : 50
     
      # Settings for Jobs Reborn
      Jobs
    :

        # This setting is the amount of Jobs XP the player will receive when right-clicking a crop.
        XP
    : 10.0
     
        # This setting is the amount of Jobs Money the player will receive when right-clicking a crop.
        Money
    : 10.0
     
        # This setting is the amount of Jobs Points the player will receive when right-clicking a crop.
        Points
    : 10.0
     
      # Settings for Particles
      Particles
    :

        # This setting shows you what particles you have active at the moment.
        Active
    : []
     
        # This setting value is the number of particles that will spawn when right-clicking a crop.
        # For example if you have HEART and BARRIER active then it will spawn 1 heart and 1 barrier.
        # The recommended max amount is 20.
        Amount
    : 1
     
        # This setting value is the offset which is the amount of radius the particles will spawn from when the player clicks the crop.
        # For example if you have HEART and BARRIER active and then click the crop it will spawn the particles 1 block radius around the player.
        # The recommended max amount is 20.
        Offset
    : 1
     
      # Settings for Sounds
      Sounds
    :

        # This setting shows you what sounds you have active at the moment.
        Active
    : []
     
      # Settings for Permissions
      Permissions
    :

        # This setting shows you what permissions you have active at the moment.
        # For example if you have cropclick.reload enabled then the player with permission will only be able to use it while
        # if it is disabled then any player can use the command.
        Active
    : []

      #Settings for Toggle
      Toggle
    :

        #This is the list of players that have the plugin enabled.
        Enabled
    : []

        #This is the list of players that have the plugin disabled.
        Disabled
    : []
     

    Code (YAML):
    # This permission allows the player to use all the commands.
    cropclick.*

    # This permission allows the player to right-click wheat crops.
    cropclick.click.wheat

    # This permission allows the player to right-click beetroot crops.
    cropclick.click.beetroot

    # This permission allows the player to right-click carrot crops.
    cropclick.click.carrot

    # This permission allows the player to right-click potato crops.
    cropclick.click.potato

    # This permission allows the player to right-click potato crops and receive a poisonous potato.
    cropclick.click.potato-percent

    # This permission allows the player to right-click netherwart crops.
    cropclick.click.netherwart

    # This permission allows the player to right-click sugarcane crops.
    cropclick.click.sugarcane

    # This permission allows the player to right-click cactus crops.
    cropclick.click.cactus

    # This permission allows the player to use the activate command.
    cropclick.activate

    # This permission allows the player to use the deactivate command.
    cropclick.deactivate

    # This permission allows the player to use the GUI command.
    cropclick.gui

    # This permission allows the player to use the link command.
    cropclick.link

    # This permission allows the player to use the unlink command.
    cropclick.unlink

    # This permission allows the player to use the remove command.
    cropclick.remove.

    # This permission allows the player to use the reset command.
    cropclick.reset

    # This permission allows the player to use the reload command.
    cropclick.reload

    # This permission allows the player to use the set command.
    cropclick.set

    # This permission allows the player to enable/disable the plugin for them.
    cropclick.toggle

    # This permission allows the player to enable/disable the plugin for them and other players.
    cropclick.toggle.other

    # This permission allows the player to use the selector command.
    cropclick.selector

    # This permission allows the player to use the linker command.
    cropclick.linker
    # This permission allows the player to use the help command.
    cropclick.help

    # This permission allows the player to use the linker tool.
    cropclick.use.linker

    # This permission allows the player to use the selector tool.
    cropclick.use.selector
     

    How to add it to your plugin
    If you are a dev you already know how to make a new project or add a jar to your IDE so I'll skip this in the how to use and if you do not know how to do please ask me in the discord server or google it.

    Code (Java):
    CropClickApi api = new CropClickApi(); // Reference to the api.

    //Supported Plugins

    // Checks if MCMMO exists in the plugin folder.
    api.mcMMOAcitve() // Returns a boolean

    // Checks if Jobs Reborn exists in the plugin folder.
    api.jobsAcitve() // Returns a boolean

    //Working

    // Checks if the API is working.
    api.working() // Returns a boolean

    //Default Config

    // Gets the value of the path in the config.yml file.
    api.getConfig(String path) // Returns an Object

    // Changes the value of the path in the config.yml file.
    api.changeConfig(String path, Object value) // Returns a boolean

    // Reloads all the configs.
    api.reloadConfigs()

    //AutoFarm Config

    /** InfoPacket Object (including id, linked, location, x, y, z)
    *InfoPacket is a new class I created which allows you as a dev to get for example
    *a crops id, location, x, y, z, and link if it is linked to an autofarm system or not.
    **/


    // Gets the value of the path in the autofarm.yml file.
    api.getAutoFarmConfig(String path) // Returns an Object

    // Checks if the type exists in the autofarm.yml file.
    api.existsInAutoFarm(String type, Location loc) // Returns a boolean

    // Gets the registered types InfoPacket from the id.
    api.getByID(String type, int id) // Returns an Object

    // Gets the registered types InfoPacket from the location.
    api.getByLocation(String type, Location loc) // Returns an InfoPacket

    /*
    * Checks the config for the linked type and then returns its InfoPacket.
    */

    api.getInfoOfLinked(String type, Location locOfDispenser) // Returns an InfoPacket

    // Version Checker

    /*
     * Creator(COCO)
     * https://www.spigotmc.org/threads/an-actually-decent-plugin-update-checker.344327/
     * Checks for a new update (only for 1.8 and above)
     */

    api.getLatestVersion() // Returns UpdateResult
     

    Requirements: WorldGuard, Worldedit versions from 1.13 and above.

    Flag "cropclick"

    The cropclick flag functions as follows if you have a region and add the flag "cropclick" assigned with a "deny" then none of the events from cropclick will trigger in the region. If you aren't a member/owner of the region then you'll be able to use all the events in the region.

    If you assign the flag "cropclick" with either "none" or "allow" then the plugin will function as usual and everyone in the region will have access to use the cropclick events.​
  • Loading...
  • Loading...