釣りミニゲーム – GALV_Fishing.js

Galv's Fishing Mini Game
----------------------------------------------------------------------------
This plugin adds a fishing mini game where the player can catch fish. It's
not plug-and-play and requires a lot of setting up. Make sure to read all
the plugin settings as they contain a lot of options you can tweak.

The demo has examples of the mini game setup and working, however it is up
to you as a developer to trial and error and decide on the best rod strength
as well as fish pull strength and detect/take to use to balance it for your
players.

INFORMATION:

1. New folder
A new folder is required in your project: /img/fishing/
This is where graphics related to fishing are kept. Use the images in the
plugin demo or as templates to create your own.

2. Fishing spots aka ponds
The mini game works by using an event that contains a bunch of script calls
that can randomly build a list of fish that will appear in the fishing spot.
Once the fish list script calls have run, then the script call to run the
fishing mini game is used.

3. Creating fish
In the plugin settings there are a lot of listings to use to create fish
with different attributes. Each fish has a number (eg. Fish 1) and this
number will be used when choosing which fish to add to a pond.
NOTE: These "Fish" can be used for any object under the water such as
chests, rocks, monsters. They are all classified as "Fish".

The fish settings are separated by commas, and in case of settings with
multiple values those values are separated by a |.

img,spd,pull,move,lvl,x,item,baits,range,stats,length,weight,ctxt,cevent,anim

img = the image used from /img/fishing/ folder. (Fish can be any size)
spd = the swim speed of the fish.
pull = the higher their pull, the more difficult it is to reel in and
the quicker the line will break. Stronger rods will be able to
pull in fish with a higher pull more easily.
move = A number to determine how the fish moves.
-1 unmovable - use for things like rocks to snag the line
- will constantly stress the line when reeling in
0 inanimate - used for things like chests or quest items
- will constantly stress the line when reeling in
- will move to their starting Y position if pulled
- away from it (eg. sink if starts at bottom)
1 passive - normal fish movement
- will stress the line only when fish is pulling
2 erratic - fish changes direction more often
will stress the line only when fish is pulling
lvl = low|high - where the fish can swim. 10 = ground, 0 = water surface
eg: 0|10
x = 0 far left, 10 far right, -1 for random.
the fish will start in this x position.
item = the item id that will be gained if the fish is caught
baits = id|id|id - a list of bait id's that the fish will eat.
It will ignore any other bait that doesn't have one of those id's
eg: 3|5|6|10
range = detect|take - detect is the distance from bait a fish will notice
take is the distance from bait a fish will bite
eg: 20|2
stats = true or false if fish is to display in stats window
length = low|high - For fish stats - A random number between low & high
eg: 40|80
weight = low|high - For fish stats - A random number between low & high
eg: 10|23
ctxt = text displayed instead of the item name when catching a fish and
when displayed in the fish stat scene.
cevent = When this fish is caught, it will exit fishing and run common event
anim = animation id played instead of default when caught

4. Fishing
In order to cast a rod and start fishing, the player must equip both a rod
and a bait. These are items with certain notetags (further down). Rods can
have a power value to make them faster or better at reeling fish in and bait
has a sink speed and baitId that is used to determine what fish will eat it.

When reeling in, the player can hold down the 'ok' button or the right
arrow. Reeling a fish in that is pulling on the line causes the line stress
and the player must manage the stress of the line by trying not to reel
while the fish is pulling the opposite direction. Once a fish is pulled all
the way to the right and at the surface of the pond, it is caught and the
player obtains the specified item and the fish's stats are recorded.

5. Spritesheets
The fishing rod spritesheet uses a bunch of rows to show fishing.
1. Standing idle
2. Casting
3. Reeling in (normal)
4. Not reeling (normal)
5. Reeling in (while fish pulling)
6. Not reeling (while fish pulling)

The fish spritesheets (remember 'fish' is a term for all objects here)
uses 4 frames in a single row to animate.

The splash spritesheet works the same but uses 5 frames

The casting spritesheet works the same but frames are specified in the
plugin settings and can be changed to look however you like.

6. Fish Stats
Fish are only added to the stats scene if they have their stats setting set
to true. The scene will display the name of the ITEM obtained from a fish
in the stat scene or if no item, the name of the GRAPHIC for the fish.

Fish stats can be obtained and stored in game variables to use in dialogue
during your game. See below in script calls section for that.

----------------------------------------------------------------------------
Note Tags for ITEMS
----------------------------------------------------------------------------

<rod:x> specify an item as a rod with x being rod strength
<rodImg:x> image to use from /img/fishing/ folder. Leave out to use
the default rod graphic from plugin settings

<bait:x> specify an item as bait with a number id that is used to
determine which fish will take the bait.
<baitImg:x> image to use from /img/fishing/ folder. Leave out to use
the default bait graphic from plugin settings
<baitSink:x> How quickly the bait sinks. eg. 0.5 is slow, 3 is fast
Defaults to 1 if left blank

----------------------------------------------------------------------------
Note Tags for ACTORS
----------------------------------------------------------------------------
If the 'Fisher Rod XY Offset' values do not work for every actor you have
(perhaps you have different size character graphics) then you can use these
two note tags to override the plugin settings for certain actors:

<rod_x:x> override the Fisher Rod XY Offset X value
<rod_y:y> override the Fisher Rod XY Offset Y value

----------------------------------------------------------------------------
SCRIPT for CONDITIONAL BRANCH
----------------------------------------------------------------------------

Galv.FISH.hasData(id) checks if the player has caught fish with id


----------------------------------------------------------------------------
SCRIPT for CONTROL VARIABLES
----------------------------------------------------------------------------

Galv.FISH.data(id,'data') returns data for fish with id. data can be:
'weight', 'length', 'amount'

Galv.FISH.totalCaught() returns total number of all fish caught

----------------------------------------------------------------------------
EVENT SCRIPT CALLS
----------------------------------------------------------------------------
Fish added to the pond will remain in the fish list for the fishing scene.
Catching fish will not remove them from the fishing scene permanently, they
will be returned when exiting and re-entering the scene again. You must
clear the pond in order to create a new fish list for the fishing scene.

Galv.FISH.addFish(x,x,x); Add specified fish id's to the pond. Any
amount can be added separated by commas.

Galv.FISH.randFish(id,min,max); Add random amount of a fish id to pond

Galv.FISH.clearPond(); Clears all added fish from the pond.

Galv.FISH.run(); starts fishing scene. Do a fadeout event command
before this for fading transition.

Galv.FISH.viewStats(); view the fish stat scene

$gamePlayer._rodEquipped = x; equip player with item id x for rod
(MUST BE A ROD ITEM WITH ROD TAG!)
$gamePlayer._baitEquipped = x; equip player with item id x for bait
(MUST BE A BAIT ITEM WITH BAIT TAG!)

Galv.FISH.changePond(setting,value); Can change pond settings (below)
default settings:
- 'bg' 'back1' img in /img/fishing/ folder
- 'surface' 'surface1' img in /img/fishing/ folder
- 'under' 'under1' img in /img/fishing/ folder
- 'underOverlay' 'under1_1' img in /img/fishing/ folder
- 'land' 'land1' img in /img/fishing/ folder
- 'splash' 'splash' anim in /img/fishing/ folder
- 'speed' [0.3,0.3,1] [bg,surface,underOverlay] scroll
- 'music' {name:'Field1',pan:0,pitch:100,volume:80};

EXAMPLES:
Galv.FISH.changePond('bg','back2'); change the background image
Galv.FISH.changePond('speed',[0,0,0.5]); change scroll speed for bgs
Galv.FISH.changePond('music',{name:'Field1',pan:0,pitch:100,volume:80});