Background

Alec's Tamework! (Assets)

ModsAlec's Tamework! (Assets)
Alec's Tamework! (Assets)

Alec's Tamework! (Assets)

CurseForge
Mobs\CharactersResource PacksLibraryMiscellaneous

Legacy asset pack to accompany the Alec's Tamework! (Plugin) v2.0.3 or older. Temporarily split into this separate asset pack until Hytale has fixed referencing asset packs inside plugins from other mods.

DownloadCurseForgeSource Code

Cats
Tamework
Nametags
Animal Husbandry

Discord GitHub Repo stars

Alec's Tamework!

A modular taming framework for Hytale that focuses on fast setup and giving modders reusable systems for companion NPCs. Add ownership, taming, capture/spawn, command tools, and rich NPC interactions without huge custom instruction trees in every role.

This is a Library!

This mod does not add anything to the game on it's own. If you are a player looking for taming/breeding/etc features, check out Alec's Animal Husbandry, which adds all the features of Tamework to the vanilla Livestock and Predator mobs.

Core Features

  • Interaction System - Use TwInteractionConfig assets to create NPC interactions quickly and easily.
    • Full asset-editor GUI support unlike large vanilla instruction chains.
    • Requires far less JSON than the base interaction flow in most cases.
    • Interaction prompts update automatically from requirements.
    • Role parameters let one interaction config drive many NPC roles.
    • TriggerNpcHook + TameworkHook bridges optimized interactions into custom instruction logic.
  • Ownership and Tamed Components - Enforce ownership and tamed status with simple actions/sensors.
    • Sensors for ownership and tamed status.
    • Global and per-role behavior controls for who can interact with or damage owned NPCs.
  • Capture/Spawn NPCs With Metadata - Capture saves metadata and restores the same NPC on spawn.
    • Includes random attachments such as varying textures, models, etc.
    • Includes persisted progression state such as ownership/tamed, happiness, needs, breeding readiness/cooldowns, traits, life stage, and attachment selections.
    • Ownership can optionally be cleared on capture and re-set on spawn to enable player trading of captured NPCs.
  • Naming Items - Name tamed NPCs with an in-game input UI using TwNameItemConfig + TameworkNameNpc.
    • Works with any custom item; not a fixed nametag item
    • Per-item rules for roles, ownership, allowed characters, rename rules, and more
  • Command Item System - Build custom command tools with TwCommandItemConfig + TameworkCommand.
    • Link/unlink NPCs to each tool.
    • Left-click executes the selected command; right-click opens the radial command wheel.
    • Radial menu includes a linked-companions side panel with loaded/unloaded/dead status and per-NPC actions (Recall, Set Home, Return Home, Unlink, Revive when enabled and ready).
    • Linked panel rows update status/health/cooldowns in-place while open.
    • Unlink safety is configurable via TwGlobalConfig.Command.LinkedPanelRequireUnlinkConfirm.
    • Supports command steps like state changes, target assignment, move-to-ping, set/return-home, and hook triggers.
    • Includes off-screen command queueing + chunk preload retries for recall/return-home relocation with safer placement for recall/revive.
    • Companion command behavior (recall/return-home/respawn distances and timing) can be scoped per role with TwCompanionConfig.
    • Command relocation infrastructure tuning remains global in TwGlobalConfig.Command (RelocationRetryIntervalMs, RelocationMaxWaitMs, RelocationMaxRetryAttempts).
  • Happiness and Needs System - Shared progression state for companion wellbeing and behavior pressure.
    • Role-priority config resolution for happiness (TwHappinessConfig) and needs (TwNeedsConfig).
    • Hunger/thirst decay, passive refill, resource-seek support, and needs-driven happiness penalties.
    • In-game balancing commands such as /tw gethappiness, /tw sethappiness, /tw getneeds, and /tw setneeds.
  • Breeding System - Config-driven breeding flow with readiness, pairing, and offspring lifecycle handling.
    • Readiness/cooldown rules from TwBreedingConfig, including alarm/timer-backed gating.
    • Nearby partner matching, pair approach sequencing and offspring spawn flow.
    • Supports baby variants and life-stage progression integration.
  • Traits and Inheritance System - Deterministic trait assignment and inheritance for long-term variation.
    • Deterministic trait rolls with duplicate/conflict controls and role-scoped trait pools (TwTraitConfig).
    • Inheritance/mutation flows with trait modifiers for health, speed, damage, harvest, and other gameplay effects.
    • In-game authoring/debug commands such as /tw gettraits, /tw settraits, /tw addtrait, and /tw getlifestage.
  • Coop Integration - Optional Tamework intake policy overlays for vanilla coops.
    • Configure per-coop behavior through TwCoopConfig assets keyed by CoopId.
    • Tamework policy checks run before vanilla coop admission flow to keep compatibility with vanilla capacity/species gates.
  • Examples and Documentation - Plenty of examples and thorough documentation to help you integrate Tamework.

Roadmap

  • NPC XP/leveling system
    • Gain XP passively when with owner or when doing certain configurable actions
  • Talent trees
    • Create your own talent trees for your NPCs
    • Allow unlocking new behaviors, stat increases, etc.
    • Will include a talent tree UI

Quick Start (2.3.x)

  1. Add the dependency in your manifest.json:
"Dependencies": {
  "Alechilles:Alec's Tamework!": "2.3.0"
},
"IncludesAssetPack": true

Asset pack note: Tamework ships as a jar with embedded Common/ + Server/ assets. At load time, Tamework also enforces early asset-pack ordering and removes legacy standalone Alec's Tamework! (Assets) packs/archives when detected.

  1. Choose your interaction path:
    Tamework's optimized system (TameworkInteract + TwInteractionConfig) or vanilla instruction flow (full control but a lot more work).
    This quick-start guide will use TameworkInteract, but you can find more information on the components for use with the vanilla flow here.

  2. Copy a template:
    Server/NPC/Roles/_Core/Templates/Template_Tamework_Example.json or Template_Tamework_Example_Simple.json

  3. Copy a matching NPC role and tweak values:
    Server/NPC/Roles/Creature/Mammal/Mob_Tamework_Example.json (or the simple variant)

  4. Create a TwInteractionConfig under:
    <ModRoot>/Server/Tamework/Interactions/

  5. Wire the interaction instruction in your template:

"InteractionInstruction": {
  "Actions": [
    {
      "Type": "LockOnInteractionTarget",
      "TargetSlot": { "Compute": "MasterTargetSlot" }
    },
    { "Type": "TameworkInteract" }
  ]
}

Optional prompt updater (see the example template for full usage):

{
  "Continue": true,
  "Sensor": { "Type": "Any" },
  "Actions": [ { "Type": "TameworkInteractPrompt" } ]
}

  1. Spawner items (optional):
    Create a TwSpawnerConfig asset under <ModRoot>/Server/Tamework/Items/Spawners/ and wire your item with TameworkSpawn.

  2. Naming items (optional):
    Create a TwNameItemConfig asset under <ModRoot>/Server/Tamework/Items/Naming/ and add TameworkNameNpc to your item’s Interactions.

  3. Command items (optional):
    Create a TwCommandItemConfig asset under <ModRoot>/Server/Tamework/Items/Commands/ and add TameworkCommand interactions to your tool item:

"Interactions": {
  "Primary": {
    "Interactions": [ { "Type": "TameworkCommand" } ]
  },
  "Secondary": {
    "Interactions": [ { "Type": "TameworkCommand", "CommandId": "OpenSelectionMenu" } ]
  }
}

  1. Coop intake policy overlays (optional):
    Create a TwCoopConfig under <ModRoot>/Server/Tamework/Farming/Coops/ keyed to your coop id (CoopId, for example Coop_Chicken) to enforce Tamework capture policy checks before coop admission.

  2. After editing spawner, naming, or command item configs, use /tw reloadconfig.

  3. Add translations in Server/Languages/en-US/server.lang.

Configuration Overview

  • TwGlobalConfig: sectioned global defaults and runtime tuning (General, InteractionDefaults, Command infrastructure).
    Location: <ModRoot>/Server/Tamework/Global/*.json
  • TwCompanionConfig: role-scoped companion behavior policy (OwnershipProtection + per-role Command behavior tuning) with priority + parent fallback support.
    • Command.DeadRespawnCooldownMins is supported as a human-friendly alias and overrides Command.DeadRespawnCooldownMs when both are set.
      Location: <ModRoot>/Server/Tamework/Companion/*.json
  • TwSpawnerConfig: spawner capture/spawn behavior.
    Location: <ModRoot>/Server/Tamework/Items/Spawners/*.json
  • TwNameItemConfig: naming item behavior.
    Location: <ModRoot>/Server/Tamework/Items/Naming/*.json
  • TwCommandItemConfig: command-tool behavior and command list.
    Location: <ModRoot>/Server/Tamework/Items/Commands/*.json
  • TwBreedingConfig: breeding eligibility/timing/inheritance behavior.
    Location: <ModRoot>/Server/Tamework/Breeding/*.json
  • TwHappinessConfig: shared happiness progression and equilibrium modifiers.
    Location: <ModRoot>/Server/Tamework/Happiness/*.json
  • TwNeedsConfig: hunger/thirst progression, passive refill, and needs-resource seek behavior.
    Location: <ModRoot>/Server/Tamework/Needs/*.json
  • TwTraitConfig: role-scoped trait pools and inheritance behavior.
    Location: <ModRoot>/Server/Tamework/Traits/*.json
    Notes: each trait definition can now optionally set IconPath for linked-panel icon rendering; when omitted, the UI falls back to first-letter glyphs.
  • TwCoopConfig: coop-id scoped intake policy overlays for captured NPC insertion.
    Location: <ModRoot>/Server/Tamework/Farming/Coops/*.json
  • After editing spawner, naming, or command item configs, use /tw reloadconfig.

Contributor Architecture Snapshot

  • Runtime systems use orchestrators plus focused services (selection, validation, persistence, UI view-models, relocation, feedback) instead of single monolithic handlers.
  • Main orchestrators:
    • SpawnerFeatureHandler (with Spawner*Service collaborators)
    • NamingFeatureHandler (with Naming*Service collaborators)
    • CommandItemFeatureHandler (with Command*Service collaborators)
  • Detailed contributor map: docs/Architecture.md

Documentation (Wiki)

Issue Reporting

If you run into a bug or behavior issue, please submit a report:
https://github.com/Alechilles/AlecsTamework/issues

Creator

alechilles
alechilles
Mod Architect

Information

19,486
Downloads
Version
.Alec's Tamework! (Assets) v2.0.3.zip
Updated
Feb 3, 2026
Support
Early Access

Project Links

WebsiteSource

Help the community thrive by sharing your feedback and reporting issues on the official tracker.