Roost Easy Chickens

GITHUB

Create custom Roost Ultimate chickens without maintaining a pile of JSON, models, lang files, tags and recipes by hand.

Roost Easy Chickens adds an in-game editor and a simple configuration layer for modpack authors. Define what a chicken produces, its tier, parents, recipe timings and appearance; REC generates the Roost config/resources and KubeJS integration needed to make it work.

Features

• /rec editor in-game chicken editor
• Create, edit, disable and delete custom chickens
• Output item + output count
• Breeding parents
• Copy breeding
• Configurable breeding/copy/Roost times
• Configurable seed tiers
• Reuse any existing Roost chicken texture
• Optional custom item/mob PNG textures
• Automatic config and texture synchronization for connected clients
• Automatic models, language entries and tags
• Automatic KubeJS Roost recipes
• Validation for output IDs, parents, templates and textures
• Helpful suggestions for mistyped IDs
• /rec list, /rec info, /rec validate, /rec reload, /rec give

Compatibility

Minecraft: 1.21.1
Loader: NeoForge 21.1.x+
Roost Ultimate: 4.1.x and 4.2.x
KubeJS: Required

REC automatically supports both Roost content layouts:

• Roost Ultimate 4.1.x: legacy config/roostultimate/chicken_config_v*.json
• Roost Ultimate 4.2.x: CRLib crlib/chicken_config_v*.json

With Roost Ultimate 4.2.x, CRLib is already a Roost dependency and REC automatically writes resources to the CRLib resource area.

Quick Start

1. Install Roost Ultimate, KubeJS and Roost Easy Chickens on both client and server.
2. Start the game/server once.
3. Run /rec editor as an operator.
4. Create your chicken and save it.
5. Connected clients automatically receive updated REC configuration and custom textures.
6. Restart the client and server when the editor tells you a registry-level change requires it.

REC's source configuration lives at:

config/roost_easy_chickens/chickens.json

Most users never need to edit it manually.

Synchronization

REC automatically synchronizes its chicken configuration and custom textures with clients that are currently connected to the server.

This means chickens created or edited through the in-game editor can be distributed to connected players without manually copying REC configuration files or textures to every client.

When a new chicken is created while players are connected, REC sends the updated configuration to those clients. After the required restart, both sides can register the new chicken.

If a completely new chicken is added while a client is offline, that client may still need the updated configuration before its next full game startup, since new Roost chicken types are registered during Minecraft initialization.

Creating a Chicken

Open the editor with:

/rec editor

From there you can configure:

• Chicken name
• Chicken ID
• Tier
• Output item
• Output amount
• Breeding parents
• Breeding time
• Breeding seed tier
• Copy breeding
• Copy time
• Copy seed tier
• Roost production time
• Roost seed tier
• Existing chicken texture template
• Custom item texture
• Custom mob texture

REC handles the generated Roost configuration, models, language entries, tags and recipes automatically.

Custom Textures

You can reuse the appearance of an existing Roost chicken or provide your own textures.

Custom textures can be managed through the REC editor.

Recommended texture sizes:

Item texture: 16x16 PNG
Mob texture:  64x32 PNG

REC synchronizes custom textures with connected clients automatically.

Commands

/rec editor
/rec list
/rec info <id>
/rec validate
/rec reload
/rec give <id>

/rec editor

Opens the in-game chicken editor.

/rec list

Lists all chickens managed by REC.

/rec info <id>

Displays configuration information for a managed chicken.

/rec validate

Checks the current configuration for problems such as:

• Invalid output item IDs
• Missing parents
• Invalid texture templates
• Missing custom textures
• Duplicate IDs
• Invalid tiers or values

REC may also provide suggestions for mistyped IDs.

/rec reload

Regenerates recipe-level configuration that can be updated without restarting the game.

/rec give <id>

Gives the selected custom chicken to the command user.

Restart Requirements

New chicken types are registered by Roost during Minecraft startup.

Because of this, the following changes require a client + server restart:

• Adding a new chicken
• Removing a chicken
• Registry-level chicken changes

Recipe-only changes can generally be applied using:

/rec reload

The editor will warn you when a restart is required.

Recommended Workflow

For the smoothest multiplayer workflow:

1. Have players connected to the server.
2. Open /rec editor.
3. Create or edit your chicken.
4. Save the configuration.
5. Allow REC to synchronize the configuration and textures.
6. Restart the server and clients if prompted.
7. Continue playing with the new chicken available.

For Modpack Authors

REC is designed to make custom Roost Ultimate progression significantly easier to maintain.

Instead of manually managing:

chicken_config_v*.json
models/item/
textures/
lang/
tags/
breeding recipes
copy recipes
roost output recipes

you can manage custom chickens from a single REC configuration or directly through the in-game editor.

The main configuration file is:

config/roost_easy_chickens/chickens.json

Requirements

• Minecraft 1.21.1
• NeoForge 21.1.x+
• Roost Ultimate 4.1.x or 4.2.x
• KubeJS

For Roost Ultimate 4.2.x installations, CRLib is already required by Roost Ultimate.

Notes

• Install REC on both the client and server.
• KubeJS is required.
• Roost Ultimate is required.
• New registry-level chicken types require a restart.
• Connected clients receive REC configuration and texture synchronization automatically.
• REC supports both the legacy Roost 4.1.x configuration layout and the newer Roost 4.2.x CRLib layout.

Roost Easy Chickens is an unofficial addon for Roost Ultimate.

Credits: Roost Ultimate Mod: Tarantei