VoxelEngine/doc/en/rigging.md

Rigging

Skeletons

Entity skeletons are created via json files in the skeletons folder.

Important

The skeleton is a non-indexable content unit. When loading it, the pack prefix is ​​added to the name (example: drop in the base pack -> base:drop).

A skeletal element, or bone, consists of a transformation matrix defining its position, rotation and scale relative to the parent element (bone) or entity if the element is the root, a model and a list of sub-elements.

A skeleton file has the following structure:

{
    "root": {
        "name": "name",
        "model": "model_name",
        "offset": [x, y, z],
        "nodes": [
            ...
        ]
    }
}

• root - root element
• name - name of the element to get the index (optional field)
• model - name of the model to display the element (optional field)
• offset - element offset relative to the parent (optional field)
• nodes - list of elements - sub-elements, which are affected by the matrix of this element (optional field)

At the moment, positioning, rotation, scaling is done through scripting, as well as animation.

The process of working with skeletons will be simplified in the future.

Models are loaded automatically; adding them to preload.json is not required.

Models

Models should be located in the models folder. Currently only OBJ format is supported.

Important

When loading an obj model, the *.mtl file is ignored.

A texture is defined by a material name that matches the texture naming format used in preload.json.

Textures are loaded automatically; it is not necessary to specify the textures used by the model in preload.json.