Skip to main content

๐Ÿ… CustomCrops

This page covers the compatibility with CustomCrops.

Actionsโ€‹

Set Seasonโ€‹

Changes the season of a designated world to a specific one.

Syntax: customCropsSetSeason <world> <season>

ParameterSyntaxDefault ValueExplanation
worldworldnoneThe target world where the season will be changed
seasonSeasonnoneThe new season to be applied to the designated world.
Example
actions:
setSeason: customCropsSetSeason SPRING world

Conditionsโ€‹

Check Seasonโ€‹

Verifies whether the current season of a designated world matches a specific season.

Syntax: customCropsSeason <season> [world]

ParameterSyntaxDefault ValueExplanation
seasonSeasonnoneThe specific season to be compared against the world's state.
worldworld:nameplayer locationThe world to check for the current season.
Example
conditions:
isSpring: customCropsSeason SPRING
weatherInPlayerWorld: customCropsSeason SUMMER world:%ph.player_home_world%
overworldIsWinter: customCropsSeason WINTER world:overworld

Objectivesโ€‹

Cropโ€‹

Triggers when a player harvests or plants CustomCrops.

Syntax:

  • customCropsCropPlant <crop_id> [amount]
  • customCropsCropHarvest <crop_stage_id> [amount]
ParameterSyntaxDefault ValueExplanation
crop_ididnoneThe unique identifier of the crop/seed.
crop_stage_ididnoneThe ID of the crop at a specific growth stage.
amountamount:Int1The number of crops to harvest or plant.
Example
objectives:
plantTomato: customCropsCropPlant tomato
harvestTomato: customCropsCropHarvest customcrops:tomato_stage_* amount:5
tip

Harvest objectives support wildcards (e.g., tomato_stage_*), allowing you to track multiple growth stages at once.

Potโ€‹

Triggers when a player places or breaks CustomCrops pots.

Syntax:

  • customCropsPotPlace <id> [amount]
  • customCropsPotBreak <id> [amount] [isCancelled]
Example
objectives:
placePot: customCropsPotPlace default amount:5
breakPot: customCropsPotBreak default_* amount:5
tip

Harvest objectives support wildcards (e.g., default_*), allowing you to track multiple growth stages at once.

Watering Canโ€‹

Triggers when a player interacts with watering cans, pots, or sprinklers.

Syntax:

  • customCropsCanFill <watering_can_id> [amount]
  • customCropsCanPot <watering_can_id> [pot_id] [amount]
  • customCropsCanSprinkler <watering_can_id> [sprinkler_id] [amount]
ParameterSyntaxDefault ValueExplanation
item_ididnoneThe unique identifier of the watering can item.
pot_idpots:idallThe unique identifier of the pot to be watered.
sprinkler_idsprinklers:idallThe unique identifier of the sprinkler to interact with.
amountamount:Int1The number of times to perform the action.
Example
objectives:
fillCan: customCropsCanFill watering_can_1 amount:3
canPot: customCropsCanPot watering_can_2 pots:default amount:5
canSprinkler: customCropsCanSprinkler watering_can_* sprinklers:sprinkler_1
tip

Harvest objectives support wildcards (e.g., watering_can_*), allowing you to track multiple growth stages at once.

Sprinklerโ€‹

Triggers when a player places or breaks CustomCrops sprinklers.

Syntax:

  • customCropsSprinklerPlace <sprinkler_id> [amount]
  • customCropsBreakSprinkler <sprinkler_id> [amount]
ParameterSyntaxDefault ValueExplanation
sprinkler_ididnoneThe unique identifier of the sprinkler.
amountamount:Int1The number of sprinklers to place or break.
Example
objectives:
placeSprinklers: customCropsSprinklerPlace sprinkler_1
breakSprinklers: customCropsSprinklerBreak sprinkler_* amount:2
tip

Harvest objectives support wildcards (e.g., sprinkler_*), allowing you to track multiple growth stages at once.

Scarecrowโ€‹

Triggers when a player places or breaks CustomCrops scarecrows.

Syntax:

  • customCropsScarecrowPlace <scarecrow_id> [amount]
  • customCropsScarecrowBreak <scarecrow_id> [amount]
ParameterSyntaxDefault ValueExplanation
scarecrow_ididnoneThe unique identifier of the scarecrow.
amountamount:Int1The number of scarecrows to place or break.
Example
objectives:
placeScarecrow: customCropsScarecrowPlace scarecrow amount:3
breakScarecrow: customCropsScarecrowBreak scarecrow amount:1
warning

Scarecrow ID Check The <scarecrow_id> must match the ID defined in your server's configuration file. You can find these IDs in the following path: yourServer/plugins/CustomCrops/config.yml

Specifically, look for the mechanics.scarecrow.id section to ensure you are using the correct identifier.