From 778c2d3be345cdc2ee5e4b61386412f0de4ddbad Mon Sep 17 00:00:00 2001
From: HENDRIX-ZT2 <28632661+HENDRIX-ZT2@users.noreply.github.com>
Date: Tue, 9 Apr 2024 16:11:37 +0200
Subject: [PATCH] manis - add docs

---
 docs/Guides/Plugin/Animations.md | 35 ++++++++++++++++++++++++++++++++
 version.txt                      |  2 +-
 2 files changed, 36 insertions(+), 1 deletion(-)
 create mode 100644 docs/Guides/Plugin/Animations.md

diff --git a/docs/Guides/Plugin/Animations.md b/docs/Guides/Plugin/Animations.md
new file mode 100644
index 000000000..fbb11d953
--- /dev/null
+++ b/docs/Guides/Plugin/Animations.md
@@ -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.
\ No newline at end of file
diff --git a/version.txt b/version.txt
index 497f523a2..323f03baf 100644
--- a/version.txt
+++ b/version.txt
@@ -1 +1 @@
-b4d3cdf36 - Mon Apr 8 19:33:37 2024 +0200
\ No newline at end of file
+73b2cfa5a - Mon Apr 8 20:22:21 2024 +0200
\ No newline at end of file