Skip to content

Commit

Permalink
manis - add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
HENDRIX-ZT2 committed Apr 9, 2024
1 parent 73b2cfa commit 778c2d3
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 1 deletion.
35 changes: 35 additions & 0 deletions docs/Guides/Plugin/Animations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Animations

## Manis

Manis animations are sampled across all frames for different bones and transform channels. They are generally used for advanced character animation that requires dynamics, constraints or blending between animations.

### Import

Select a target armature you want to animate before importing a manis file.

!!! construction "Limitations"
Compressed animations are currently imported incompletely. Specifically, only every 32nd rotation keyframe is imported.

### Export

Transforms in blender actions are stored relative to the armature, but absolute in manis. As a result, manis export must know which actions belong to which armature:

- If you have a single action per armature, setting it as the current action in the Action Editor is enough.
- To export multiple actions from an armature, stash them in the NLA Editor.

Export does not read the keyframes directly, but samples the visual transforms across an action's frame range. Constraints are automatically baked. Bones that don't move during an action are automatically discarded.

!!! construction "Limitations"
Export only produces uncompressed animations, which occupy a lot of disk space and RAM in-game.

## Banis

Banis animations are rigidly sampled for all bones in a model. They are generally used for simple building or character animations, such as:

- guests
- feeders
- exhibit animals

!!! construction "Limitations"
The transforms used by banis are currently not fully understood. Import is experimental and close to expected for some banis, but totally broken for others. Export is not useable in production.
2 changes: 1 addition & 1 deletion version.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
b4d3cdf36 - Mon Apr 8 19:33:37 2024 +0200
73b2cfa5a - Mon Apr 8 20:22:21 2024 +0200

0 comments on commit 778c2d3

Please sign in to comment.