About Catch and Release LIB
From Vintage Story ModDBShared library for Catch and Release mods.
Shared library for Catch and Release: Butterflies and Catch and Release: Fish.
Contains common code for "cages" and storing creatures within those cages.

Below is for modders who want to extend the mod or create their own caged creatures
TODO: Documentation on API. If anyone is interested in using this for further mods, come and discuss in Catch and Release post in the VS Discord.
Example how to setup new cages:
- Create shape + animations for caged creature entities
- Entity definition for caged creature(s). Including:
{
code: "taskai",
aitasks: [{
code: "crlib.CreatureCaged",
priority: 0,
movespeed: 0.6, <- How fast caged creature moves
turnspeed: 2.5, <- How fast caged creature turns to target position
moveAnim: "fly", <- Name of animation for when moving
restAnim: "feed", <- Name of animation for when sleeping
restTime: "Day", <- Creature sleeps during "Day" "Night" or "None" (to not rest)
restDaylightLevel: 0.7, <- Daylight amount to trigger sleeping (basically, time of day)
groundOnRest: true <- When resting, does the creature find the ground first
}]
}
]
- Shape for your cage(s) (plus textures if needed)
- Custom cage block(s). Including:
cageConfig: {
cageName: "crbutterfly:cage_name", <- Just some display test when refering to this type of cage
fits: 4, <- How many creatures fit in the cage
radius: 0.3, <- Size of the cage (for the purpose of determining creatures walking around)
height: 0.5, <- Height of the cage (for the purpose of flying creatures - 0 for walking creatures)
bottom: 0.05, <- Offset the 'floor' of the cage
validItems: "game:creature-butterfly-*", <- What creature items can be placed in the cage
dropsEntity: "game:butterfly-", <- What creature items fall out of a broken cage
spawnEntity: "crbutterfly:cagedbutterfly-", <- What creature entities 'wander' in the cage
displays: 1 <- How many items to display in a cage
},
}
- Recipe(s) for cage(s)
Highlights
From source dataGame versions
Supports 4 Vintage Story versions, the newest being 1.22.3.
Footprint
Rated a light load on a server.
Catch and Release LIB on Nxeon
From our catalogue- One-click install
- Supported on Nxeon Vintage Story servers. We download it from Vintage Story ModDB, place it, and restart the server.
- Server side
- Required on the server
- Server load
- light
- Smallest plan we suggest
- Vintage Story — 1 GB (1 GB RAM). This follows our own load rating above, not a benchmark.
Run Catch and Release LIB on a Vintage Story server
Pick a server or deploy a new one above; it is installed in one click.
What kind of mod it is
From the catalogLibraries & compatibility
Foundations and fixes other mods build on. Usually installed because something else needs it.
Runs on your server
From source side supportVintage Story ModDB lists Catch and Release LIB as required on the server. Check its Vintage Story ModDB page to see whether players need it too.
Compatibility
- Game
- Vintage Story
- Runs on
- Serverrequired on the server
- Game versions
- 1.22.3 and 3 earlier
Verified at the source
- ✓Vintage Story ModDBOfficial listing, checked 2026-09-24Open ↗
- ✓AuthorMortalityGames, as published on Vintage Story ModDB
- ✓LicenseNot published by the sourceFree












