modpacks.ch by CreeperHost No ads. Just mods.
Back to mods
Catch and Release LIB project artwork

Vintage Story Mod DB · Vintage Story mod

Catch and Release LIB

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

Choose a version Pick your version below, then grab the matching file.

Quick answer

Which Catch and Release LIB release should I use?

Updated 12 days ago
Latest stable file 1.1.3
Game version 1.22.0, 1.22.1, 1.22.2
Loader Built-in Vintage Story mod system

Catch and Release LIB 1.1.3 targets 1.22.0, 1.22.1, 1.22.2. It must be installed on the client. Installation on the dedicated server is optional. No extra mods listed for this file.

Where it goes

Is Catch and Release LIB required on the client, server, or both?

It must be installed on the client. Installation on the dedicated server is optional.

Client Required
Dedicated server Optional
Loader for this release Built-in Vintage Story mod system
Required install it here Optional supported, not mandatory Not supported do not install here Source doesn’t say do not assume

This release supports both sides, but the source does not require it on the server.

Understand Vintage Story dependencies Read the Vintage Story installation guide

What else does Catch and Release LIB 1.1.3 need?

1.1.3. Change the file and its required mods may change too.

No extra mods listed for this file

This file does not list any required mods. Do not add a library just because a different file uses it.

This file does not list any required or optional mods.

Before you install it

Add Catch and Release LIB without breaking your instance.

Built for Catch and Release LIB 1.1.3. Pick another file and the loader, install side or required mods may change.

  1. 01

    Stick to this file

    Use 1.1.3. It targets 1.22.0, 1.22.1, 1.22.2; another release may have different loader, side or dependency requirements.

  2. 02

    Bring the mods it needs

    This file does not list any required mods. Do not add a library just because a different file uses it.

  3. 03

    Put it on the correct side

    It must be installed on the client. Installation on the dedicated server is optional.

  4. 04

    Pick the file you checked

    Use the “Get this file” button beside 1.1.3. It opens that exact file at the source.

About this project

What does Catch and Release LIB add?

Shared library for Catch and Release: Butterflies and Catch and Release: Fish.

Contains common code for "cages" and storing creatures within those cages.

image   

 

 

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:

  1. Create shape + animations for caged creature entities
  2. Entity definition for caged creature(s). Including:
Caged creature behaviour snipped
behaviors: [
    {
        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
        }]
    }
]
  1. Shape for your cage(s) (plus textures if needed)
  2. Custom cage block(s). Including:
Cage config attribute
attributes: {
    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
    },
}
  1. Recipe(s) for cage(s)

Project description from Vintage Story Mod DB.

Pick your setup

Catch and Release LIB releases for each Vintage Story version.

Choose the version and loader you play, then open the matching release.

8 available setups

Check the dependencies, then try the file in a copied instance before changing a world you care about.

Recent files

Catch and Release LIB versions and loaders

6 of 6 releases match

Looking for an older file? The official Vintage Story Mod DB project page is in Resources.