Hello all, here is a guide to help you create mods for Freshwater Frenzy.

Firstly, the following features will only work if Freshwater Frenzy is installed:

• Breeding.
  
• Accessories.
  
• pH/acid.
  
• Bridge/platform tanks, unless you include the tc3d files in the mod.
  
• Land/occupies land care requirement.
  
• Posters

If you include these behaviours on an object and try to include it in a non-DLC game they will either fail gracefully (disappear) or sometimes fail disgracefully (missing text/models will cause errors).

To stop this happening you can include a tag on your object's data files to make them only appear in games which have freshwater enabled. Here is an example for the piranha:

{
"id": "1_red_bellied_piranha",
"dlcTag":"freshwater frenzy",
"tags": [
"animal",
"serrasalmidae"
],
"menuTag":"serrasalmidae",
"menuButton":"livestock",
"perSpecNumbering": true,
"hosting": {
"hostedOn": [
"tank"
]
},
"contained": {
"advancedSpotMovement": {
"speed": 0.018,
"behaviours": {
"flickMove": 85,
"swim": 15
},
"flickMoveTurnMagnitude": 35.0,
"swimLength": 20,
"slowDownPeriod": 20.0,
"speedingUpPeriod": 60.0,
"pauseLength": 600,
"flickMoveDistance": 0.02,
"turnFrames": 60
}
},

... data definition continues

That one line at the top. That's all you need:

Add that and your objects will automatically only appear in freshwater levels and sandboxes. Nice huh?

But we can go one step further. To avoid disappointing players, you can tag the workshop item as needing the DLC to download.

https://drive.google.com/file/d/15aGVb5Nji40iJ5uUgnt4pU24Ih3Q3JJJ/view?usp=sharing

That way people will only download things they can actually use. Less messy and everyone's happy.

Other than the features mentioned above, I believe everything else will work in both vanilla and freshwater (try it first!).

Feel free to post any questions below. :)

== EDIT: ==
One thing I didn't make clear above. For the features listed above, they will only work correctly in a freshwater-enabled game e.g. freshwater campaign or a sandbox with freshwater enabled.

However they aren't restricted to freshwater animals. You can still create marine animals which breed, or marine land animals!

But at the risk of repeating myself, they will only work correctly in a freshwater-enabled game IE give them the following tag, even if they are not a freshwater animal.


And mark the workshop item as requiring the DLC.

Hope that makes sense!

Note: pH reall is limited to freshwater animals.