Fish
Add a fish players can catch: which water it lives in, when it bites, how heavy it is and what it sells for.
The fish table adds new fish. Each entry says the fish’s name, the kind of water it lives in, its rarity, its weight range and its sell price. A fish automatically becomes an item (a material): catch it and it goes into the bag, where it can be sold or used in cooking.
In the editor#
Open the Fish tab under Food & gathering in the left column. Press Add to start a new fish, or Copy from game to start from a base game fish.
| Field | What it does |
|---|---|
| Name | The name players see in the codex and bag (up to 32 characters, Other languages underneath). |
| Water | River, Sea or Icy water. |
| Rarity | Common, Uncommon, Rare or Legendary. Rarer fish are harder to catch and sell for more. |
| Catch chance | Among fish of the same rarity, a higher number means it is caught more often. |
| Time of day | Any time, Night or Day. |
| Rain only | When on, it only bites on rainy days. |
| Level needed | The player must reach this level to catch it. |
| Weight range | Catches weigh within this range, in kg. |
| Body color | The main colour of the fish in the water. |
| Belly color | The colour of the lighter parts. Leave it empty to match the body. |
| Price | Base price when sold to a merchant. |
| Codex note | One plain sentence, shown as a clue until the player catches one. |
| Shape | Round, Slim, Tall, Long, Flat, Squid or Giant: how the fish looks when pulled out of the water. |
This tab has no preview. The top-bar Test reloads the game with your mod and drops you in a flat test field, which is a quick way to confirm it loads without problems. The test field has no villages, water or farm plots, so to see this in action, turn the mod on under My Mods and play in a world.
Advanced: writing the JSON by hand#
Below is the same content as it looks in the file. The editor saves exactly this format. You can also press Open folder at the top of the editor and edit the file in an outside text editor; when you save, the editor picks up the change. Fields the form does not show are kept as they are. Where the file goes and how it is listed: Mod folder and mod.json.
The table is one JSON file; put its path under content.fish in mod.json.
Smallest working example#
A rare fish that only bites at night in cold water, weighing 2 to 6 kg, selling for 20:
[
{
"id": "glacier_pike",
"name": "Glacier pike",
"names": { "zh-TW": "冰川梭魚" },
"water": "COLD",
"rarity": "RARE",
"weight": 3,
"time": "night",
"kg": [2, 6],
"color": "#9fd6e8",
"value": 20,
"hint": "Bites at night under the ice.",
"form": "long"
}
]Fields#
| Field | Required? | What it means | Allowed values |
|---|---|---|---|
id | Yes | The fish’s name inside your mod | Starts with a lowercase letter or digit; only lowercase letters, digits and underscores; up to 48 characters |
name, names | At least one | Fish name | Up to 32 characters each |
water | Yes | Which kind of water it lives in | RIVER, SEA, COLD |
rarity | No | Rarity | COMMON (default) UNCOMMON RARE LEGENDARY |
weight | No | Bite chance weight; bigger means easier to hook | 0.1 to 10. Default 3 |
time | No | When it bites | any (default) day night |
needsRain | No | When true, it only shows up in the rain | true or false |
minLevel | No | Player level needed to catch it | Whole number, 1 to 200 |
kg | Yes | Weight range [lightest, heaviest] | Two numbers, each 0.01 to 1000; the second cannot be smaller than the first |
color | Yes | Main colour of the fish | "#rrggbb" |
modelColor | No | Second colour of the model | "#rrggbb"; same as color if missing |
value | No | Sell price | Whole number, 1 to 200. Default 8 |
hint, hints | No | A fishing tip, also used as the item description | Up to 120 characters each |
form | No | The fish’s outline | round slim tall long flat squid giant |
How it points at other things#
The fish table does not point at anything else. The caught fish is a material item, and you refer to it by its own local id elsewhere:
- In Loot, write
"item": "glacier_pike"to let an enemy drop the fish. - In Crops, a
productcan be the fish id too (crops load after fish). - To use your own fish in a dish or a recipe you need two mods, because those tables load before fish within one mod. Put the fish in one mod and write
@fishmod/glacier_pikein the other, which must list the fish mod independsOn.
Common mistakes#
- Forgetting
water,kgorcolor. The game says that field is missing. - Writing
kgas one number. It must be a list of two numbers like[2, 6]. - The second
kgnumber smaller than the first, such as[6, 2]. - A
valuewith decimals or above 200. waterwritten asriver(lowercase) orLAKE. OnlyRIVER,SEAandCOLDwork.- A misspelled
formortime.
Related pages#
- Dishes: cook the fish into a meal.
- Loot: let enemies drop fish.
- Items: a caught fish is an item.
- The mod editor: build this kind of content with forms and test it in the game.