FC2D_MODEL(5)

NAME
fc2d_model - Facecam2D model file format

DESCRIPTION
Facecam2D uses zip archive files using the .fma (Facecam2D model archive) file extension, to store models. These zip files contain a mandatory toml file called model.toml, which describes the model and its parts. This file is called the model descriptor. Any model file that does not contain model.toml in the root of the archive is invalid.

Example model.toml:

    [format]
    version_major = 0
    version_minor = 3
    [model_info]
    name = "Example Model"
    version = "1.0"
    [[part]]
    texture = "tex/head.png"
    bind = "head"
    [[part]]
    bind = "head"
    follow = "face"
    factor = 0.75
    	[[textures]]
    	file = "tex/face-closedmouth.png"
    	[[textures]]
    	file = "tex/face-openmouth.png"
    	trigger = "mouth-open"

In addition to the model descriptor, the model archive can contain other files (e.g. textures) that can be anywhere in the archive, including the root. Unnecessary files should not be present in the archive, but archives with unnecessary files are still valid.

KEYS

  format

version_major
    Integer: Major version of the model format (e.g. 0 for v0.3).

version_minor
    Integer: Minor version of the model format (e.g. 3 for v0.3).

  model_info

name
    String: The name of the model (will be displayed in the window title).

version
    String: A version string for the model (currently unused).

  part

texture
    String: Path to a texture file in the archive. Required if [[textures]] is not present in the part.

bind
    String: A bind point which the part will be bound to. Possible values: null, head, face

follow
    String: A bind point which the part will follow depending on factor. The part will copy the position of bind but move in the direction of follow.

factor
    Float: How far the part will move towards the follow point. If negative, the part will move in the opposite direction.

  textures

file
    Path to a texture file in the archive. Required if texture is not present in the part.

trigger
    A trigger that will cause the part to use this texture. Possible values: null, mouth-open

When specifying multiple textures, the first one specified will be used by default.