🎣 CustomFishing

This page covers the compatibility with CustomFishing.

Objectives

Fishing

Tracks when a player catches a specific fish or a set of fish.

Syntax: customFishingCaughtFish <fish_id> [amount] [location] [range]

Parameter	Syntax	Default Value	Explanation
fish_id	id	none	The unique identifier of the fish.
amount	amount:Int	1	The number of fish required to complete the objective.
location	location:Location	Everywhere	The location at which the item must be caught. Range must also be defined.
range	range:Double	Everywhere	The range around the location(hook).

Example

objectives:
  catchCarp: customFishingCaughtFish tuna_fish_golden_star
  catchRareFish: customFishingCaughtFish tuna_fish,pike_fish amount:5 location:123;456;789;fishWorld range:10
  catchGoldenStartFish: customFishingCaughtFish *_golden_star amount:7

tip

Harvest objectives support wildcards (e.g., *_golden_star), allowing you to track multiple fish types or rarities at once

Fishing Groups

Tracks when a player catches any fish belonging to a specific group.

Syntax: customFishingCaughtGroup <group_id> [amount] [location] [range]

Parameter	Syntax	Default Value	Explanation
group_id	id	none	The unique identifier of the fish group.
amount	amount:Int	1	The number of fish from this group required.
location	location:Location	Everywhere	The location at which the item must be caught. Range must also be defined.
range	range:Double	Everywhere	The range around the location(hook).

Example

objectives:
  catchOceanGroup: customFishingCaughtGroup ocean amount:10
  catchSpecialGroups: customFishingCaughtGroup no_star,pound amount:3 location:123;456;789;fishWorld range:10
  catchStarAndOceanGroup: customFishingCaughtGroup *_star,*_ocean

tip

Harvest objectives support wildcards (e.g., *_star), allowing you to track multiple groups simultaneously.

Activate Totem

Tracks when a player activates a specific fishing totem.

Syntax: customFishingActivateTotem <totem_id> [amount] [location] [range]

Parameter	Syntax	Default Value	Explanation
totem_id	id	none	The unique identifier of the fish.
amount	amount:Int	1	The number of crops to harvest or plant.
location	location:Location	Everywhere	The item must be caught at the center of the totem (coreLocation).
range	range:Double	Everywhere	The range around the location(hook).

Example

objectives:
  activateDoubleTotem: customFishingActivateTotem double_loot_totem
  activateAllTotem: customFishingActivateTotem *_totem amount:2

Totem ID Check

<totem_id> must exactly match an ID defined in your totem configuration files.

You can find all available totem IDs here:
yourServer/plugins/CustomFishing/contents/totem/*.yml

For detailed instructions on creating and using totems,
please refer to the official documentation:
CustomFishing Totem Format Documentation

tip

Totem objectives support wildcards (e.g., *_totem), allowing you to track the activation of various totem types.

Items

CustomFishing usage is integrated to the Items system and thus used for events and conditions.

In addition, you can also add quest-item argument to tag them as "QuestItem".

Example

items:
  catFishSilverStar: customFishing cat_fish_silver_star
  goldFish: customFishing gold_fish quest-item
conditions:
  hasCatFishSilverStar: hand catFishSilverStar
actions:
  giveGoldFish: give goldFish:3