Casper Gaming Developer Corner
Casper Gaming Developer Corner

Documentation

Back to Plugin


Quick InfoVersion: Alpha R6
Made for RPG Maker MZ 1.9.0

Catch WeightThe fish catch weight is how often that fish will be caught. This plugin determines the catch by adding up all possible fish catch weight, generating a random number, and subtracting fish catch weights until the random number is reached. A higher catch weight will mean the fish is more common.

Text CodesText in toast windows and other areas of the plugin supports all standard text codes, such as \c[x] or \i[x].

The catch message additionally supports the following unique text codes:
%amt - this will be replaced with the amount of fish caught
%fish - this will be replaced with the fish item icon and name.
%n - this will create a new line of text

FAQQ: I added the plugin and now my game is crashing?
A: Make sure all of the parameters are filled out (not blank) unless otherwise instructed.

Q: I added a fish and now my game is crashing?
A: You need to set up fish objects when you create them. This plugin assumes you will only create fish that are catchable, so some params like region ID or vehicle are required and this plugin does not waste resources handling cases of these params being empty.

IntegrationsThis plugin has additional features if also using the following CGMZ plugins:

[CGMZ] Professions
This plugin can integrate with CGMZ Professions to add features:
1) Profession level requirements to catch fish
2) Automatic exp awarded for profession upon successful fish

[CGMZ] Toast Manager
This plugin can integrate with CGMZ Toast Manager to add features:
1) Toast window on fishing catch
2) Toast window on fishing no catch

[CGMZ] Rumble - Allows you to rumble the gamepad when a fish is caught or not caught with separate options for catches vs misses.

[CGMZ] Scene Backgrounds - Show a custom scene background in the fishing journal scene, including scrolling images and weather.

[CGMZ] Controls Window - Show gamepad or keyboard controls in the fishing journal scene, depending on the player's last input type.

Plugin CommandsThis plugin supports the following plugin commands:
Start Fishing - Forces the player to (attempt to) start fishing

Saved GamesThis plugin is fully compatible with saved games. This means you can:

✓ Add this plugin to a saved game and it will work as expected.
✓ Change any plugin params and changes will be reflected in saved games.
✓ Remove the plugin with no issue to save data.

Filename

The filename for this plugin MUST remain CGMZ_Fishing.js. This is what it comes as when downloaded. The filename is used to load parameters and execute plugin commands. If you change it, things will begin behaving incorrectly and your game will probably crash. Please do not rename the js file.


Known Issues

This plugin currently has no known issues that need to be fixed. If you believe you have encountered a bug, please report it to Casper Gaming.


Compatibility

This plugin currently has no known compatibility issues with other RMMZ plugins. If you believe you have encountered a conflict, please report it to Casper Gaming.


Version HistoryVersion AlphaR2
  • Added sound effects when casting/catching/missing
  • Added fish weight bonus per profession level
Version AlphaR3
  • Added land fishing (no vehicle required)
  • Added plugin command to get the amount of times a fish has been caught
  • Added plugin command to get the total amount of all fish caught
  • Added controller support
  • Added option to rumble controller when fish caught
  • Now warn instead of crash when invalid json detected
Version AlphaR4
  • Added fishing journal scene with numerous supporting parameters
  • Added [CGMZ] Scene Backgrounds integration
  • Added [CGMZ] Controls Window integration
  • Improved [CGMZ] Rumble support
  • Improved [CGMZ] Toast Manager support
Version AlphaR5
  • Added catch chance and chance bonus per level
  • Catch Chance and Custom Space added to fishing journal
  • Added [CGMZ] Window Background integration
  • Fixed bug that made [CGMZ] Professions required
  • Map parameter for fish converted from number type to map type
Version AlphaR6
  • Added support for multiple fishing professions
  • Added [CGMZ] Window Settings integration
  • Improved [CGMZ] Toast Manager integration

Back to Plugin