OBSIDREL / DOCS

Documentation

Guides, tutorials and technical references for the Obsidrel ecosystem.

DocumentationEntity models and animation

Entity models and animation

Obsidrel separates the server entity from its displayed model. The Core Showcase includes entity model assets and examples of animated controller setups.

  1. Create the model with a consistent origin, scale and naming.
  2. Export using an importer/format supported by your installed build.
  3. Keep original assets in an editable pack source.
  4. Point the entity model YAML to the correct namespaced paths.
  5. Build and distribute the resource pack.
  6. Verify appearance before connecting movement and animations.

The Core example documents model.path, model.parent, model.texture, model.offset and model.scale. Animation names referenced by movement must correspond to actual assets/controller states.

A successful import does not guarantee perfect geometry or animation fidelity. Preserve the original project, inspect importer warnings and test in-game.

Safe creation, editing and validation

Import a small known-good model, check pivots and pack textures, then validate idle/walk animations one at a time. Treat SUCCESS_WITH_WARNINGS as requiring inspection, not as perfect fidelity.

Keep a copy of the original file. Make small changes, verify the YAML and test in the appropriate runtime. Studio preview does not replace the real server validation.

Related reference: Methods and features.

Entity-specific integration: spawn and death actions

Unlike standalone recipes, the entity loader explicitly supports actions.spawn and actions.death, lists of reusable Action IDs invoked on spawn/death. The following is a fragment inside a complete entity, not a standalone YAML definition:

yaml
  actions:
    spawn: [my_spawn_action]
    death: [my_death_action]

Create these Actions under resources/actions/. Death events may have a different player context from a right-click action: choose steps compatible with the event. Verify spawn, death and restart before enabling rewards. See Actions and Conditions.

Required: all entity definitions need non-empty model.path and model.texture values. Use existing Showcase JSON/PNG assets or a properly imported/created model; never present an entity definition without these fields as functional YAML.

Was this article helpful?Loading ratings…

Help us improve Obsidrel documentation. One vote per account and article. Discord AI feedback can also contribute when the answer cites this article.