[CGMZ] Fishing (Patreon)

Adds a fishing system for each vehicle. Fish can be caught per vehicle, map, or region. You can set up fish to be rarer than others.

! SEE BOTTOM OF POST FOR UPDATES !

Hi all,

Today we have another port from my CSCA collection from VX Ace: Fishing! This was initially part of the vehicle system script from Ace, which I had split into smaller plugins for each area of functionality. This means to add fishing to your game, you don't need to worry about vehicle battle config or vehicle interior config if you don't want as those are separate plugins.

Anyways, this plugin adds a fishing system for each vehicle (boat, ship, and airship). Each vehicle can catch different fish, and you can also have different fish per map or per region. You can make some fish common while others are rare.

This plugin integrates with CGMZ Professions to automatically add experience to a "fishing" profession you may have set up when a fish is caught. It also allows you to have a level requirement to catch certain fish. This plugin also integrates with CGMZ Toast Manager for toast windows when fish are caught or not caught. You can also configure the plugin to use the normal game message window (what you see when you use the Show Text event command) to tell the player what they caught.

Update 2/26/2022: You should now no longer be able to fish outside of a vehicle. This will be added back in later once fishing outside vehicles is added, but for now it doesn't make much sense to allow it.

Alpha Update March 23, 2023: Hi all, this plugin has been updated today to add some more ways fish can be differentiated. Now fish can require either shallow (boat passable) or deep (ship passable) water to be caught. You can also require certain weather to be active, such as rain, to catch certain fish. I also added a plugin command to force start the player fishing.

This update adds global sound effects for casting, catching, and missing (no catch) a fish. This is an array of sound effects you can set up with as many possible sound effects as you want, from which the plugin will randomly pick one each time it is appropriate to play the sound effect.

This update also added the option to let your fishing profession level affect the fish catch weight. With this, you can now cause rarer fish to become more common as the player levels up their fishing profession, if you are using [CGMZ] Professions.

This update adds the much requested feature of land fishing. You no longer need to be in a vehicle to fish, you just need to be facing a fishable body of water (determined by ship passage settings). There are a few new settings for this, including a none vehicle type so you can make fish that can only be caught from land, and others that can only be caught from vehicles even in the same waters. Below is a gif of how this looks:

This update also added controller support. Now your controller players can fish too. This comes with [CGMZ] Rumble integration, and you can rumble the controller when a fish is caught to provide some haptic feedback to the player and help better immerse them in your game.

This update added some plugin commands meant to assist in any events you may have surrounding fishing. You can now get the total amount of a specific type of fish caught into a variable, and you can also get the total amount of all fish caught into a variable. This could be used for something like a fishing contest, where you want to check how many of a specific fish a player has caught in the contest. I am sure you will come up with tons of fun ideas for how this can be used in your events.

This update also causes the plugin to warn in the dev tools console instead of crash when it detects invalid json in a plugin parameter. This is caused by user error when setting up the plugin parameters, typically deleting a parameter that has some minimum requirement such as an object or array parameter. These warnings are still important to fix, as they will cause the plugin to be unable to read those parameters with setup errors. 

This version adds a fishing journal scene! You can now allow your players to see info about your fish after they have caught it at least once. Things that can be displayed here include the total amount caught, amount per catch, level requirement, exp gain, quality, rarity, location, and a description. See below image for how the fishing journal can look:

 This new scene includes integrations with [CGMZ] Scene Backgrounds and [CGMZ] Controls Window. The existing integrations were also improved. There is now a rumble option for when no fish is caught, and there are a lot more toast manager options for each toast window. You will need to set up any existing rumble and toast parameters again, as your old settings will be lost. The order with [CGMZ] Toast Manager is no longer important.

This version adds fish catch chance and a chance bonus per level, if using [CGMZ] Professions. This differs from fish weight because weight determines which fish will get hooked on the line, while chance determines if that fish will actually be caught. Previously, the player would always catch fish unless they were fishing in water that did not have any eligible fish. The chance per level works the same was as the weight bonus per level, in that you can make fish initially hard to catch and get easier as the player levels up.

The catch chance was added as a possible info line in the fishing journal, and the fishing journal can now also leave a custom amount of blank space.

An integration with [CGMZ] Window Backgrounds was added. You can now set a preset for both the list and display window in the fishing journal scene.

Some bugs were also fixed. This update fixed a crash that occurred when not using [CGMZ] Professions. [CGMZ] professions is not intended to be required, so this plugin should work without it installed. 

This version improves some integrations. A [CGMZ] Window Settings integration was added, which allows more control over the windows in the fishing journal scene including windowskin, tone, padding, etc.

The [CGMZ] Toast Manager integration was changed to use the new preset id system. Any toast manager options that were not already part of the integration should now work with this plugin as a result.

This update also added the ability to have multiple fishing professions. You still set up the main fishing profession, however each fish can now have its own fishing profession. If left blank, the profession used will be the main fishing profession. If set, the fish specific profession will be used instead. This should allow you to make various fish that are caught by different means, for example fly fishing, regular fishing, ice fishing, etc.

This version adds custom text, images, and headers for the fishing journal. You can now describe in text and images more about the fish the player can catch. Text can have its own alignment, and positioning. Images can also have their own alignment, and be shown inline with text or in block mode and take up the entire line. This means if you want to show text on the left and an image on the right in the same space, you can do that. Headers follow standard header rules, but can have custom text.

There is no limit to how much custom text, images, or headers you can use.

You can now set fish to not display in the fishing journal, even if they have been caught. You can use this to add trash fishing items that can be caught but which do not show up in the journal, and many other uses.

If the fishing journal has no fish logged yet, you can now show a brief message letting the player know fish get logged in the journal when caught. If there are no fish, the list window will no longer have a blank entry selected.