## Now Includes a Universal, Non-Destructive Asset Patcher! - Add, merge, and insert JSON into *any* Hytale asset at runtime - Apply one patch file across multiple target assets - Gate optional integrations on installed mods - Supports hot-reloading - Inspired by Hytalor - [Learn More](https://wiki.hytalemodding.dev/mod/alecs-tamework/asset-patches) # Alec's Tamework! Alec's Tamework is a modular NPC framework and asset patcher for Hytale built to let modders add rich NPC features through assets, templates, and config-driven systems instead of writing custom Java code. It is designed to empower artists, designers, and less technical modders who want advanced companion behavior without first building their own framework. Tamework also aims to establish a shared standard for tameable NPCs in Hytale so different mods can work on top of similar ownership, naming, command, progression, and companion-management systems instead of forcing players to learn a different workflow for every mod. ## This Is a Library Tamework is a framework dependency for other mods. It does not add a standalone gameplay expansion by itself. If you are a player looking for gameplay built on Tamework, start with [Alec's Animal Husbandry](https://www.curseforge.com/hytale/mods/alecs-animal-husbandry) or the wiki for the specific mod you are using. ## Why Tamework - **No Java required for most integrations**: the main integration path is built around JSON assets, templates, role wiring, and `Tw*Config` files rather than custom Java systems. - **Non-destructive asset patching**: Add, merge, and insert JSON into one or many Hytale assets at runtime, with installed-mod conditions and hot-reload support. - **A shared standard for tameable NPCs**: mods built on Tamework can present familiar ownership, naming, command, linked-panel, breeding, and progression behavior instead of inventing incompatible one-off systems. - **Optimized interactions**: build taming, feeding, mounting, harvesting, breeding, and custom interactions with `TwInteractionConfig` and `TameworkInteract`. - **Ownership and tame-state systems**: use reusable builders and role-scoped policy for owner checks, protection rules, and companion behavior. - **Spawner, naming, and command items**: capture and respawn NPCs with metadata, name companions with custom items, and build command tools with radial and linked-panel support. - **Linked companion runtime**: manage loaded, unloaded, dead, and lost companions through a linked panel with recall, home, revive, and related flows. - **Progression systems**: add happiness, needs, breeding, life stage, and trait-driven variation through config-driven systems. - **Advanced extension points when needed**: bridge into custom logic through hooks and optional integrations without giving up the higher-level framework. ## What Integration Looks Like Integrating Tamework is usually a content-authoring workflow, not a programming workflow. Mods can use it in two ways: ### Required Dependency - Wire your desired Tamework behavior directly into your NPC, item, config, and other server-side assets. - Add configs for the Tamework systems you want to support. - Add Alec's Tamework as a required dependency when deploying to CurseForge. ### Optional Dependency - Keep your base assets clean of any references to Tamework functionality. - Create asset patches under `Server/Tamework/Patches` that add Tamework actions, interactions, configs, and other JSON-based behavior at runtime only when Tamework is installed. Use `Targets` for shared operations across several assets and `When.ModInstalled` for optional cross-mod gates. - Add configs for the Tamework systems you want to support. - Add Alec's Tamework as an optional dependency when deploying to CurseForge. In both cases, no Java is required: copy and adapt examples, enable the systems you want through comprehensive configs, and polish. The full setup and implementation details can be found in the wiki. Player-facing Tamework config strings support `server.lang` keys. Built-in talents, traits, command labels, interaction messages, happiness labels, and major UI labels use language keys so translation packs can override copy without changing behavior assets. ## Documentation - [Wiki Home](https://wiki.hytalemodding.dev/mod/alecs-tamework) - [Player Guides](https://wiki.hytalemodding.dev/mod/alecs-tamework/player-guides) - [Modder Documentation](https://wiki.hytalemodding.dev/mod/alecs-tamework/modder-documentation) - [Developer Documentation](https://wiki.hytalemodding.dev/mod/alecs-tamework/developer-documentation) ## Roadmap - [Tamework Roadmap](https://curious-bench-850.notion.site/32c1f4061f368026b735f19a8187a480?v=32c1f4061f3680ab877b000cdda43a23) ## Issue Reporting If you run into a bug, integration issue, or behavior problem, report it in the Discord server: https://discord.gg/E8n8RgTTdq

Telemetry

Alec's Tamework utilizes Alec's Telemetry to report crash, error, performance, and usage telemetry data to the developer.

This data does not contain any personally identifiable information, and is exclusively used to diagnose issues in the mod to provide a better user experience.

You may disable this feature at any time in the `/tw settings` menu in the Telemetry section.

Creators

Details