From 0a66372c3fcc9db0bff10c6bff447a62c4b643f0 Mon Sep 17 00:00:00 2001 From: Pascal Serrarens Date: Thu, 9 Apr 2026 17:36:19 +0200 Subject: [PATCH] Extended docs --- Documentation/Animations.md | 9 +++++++++ Documentation/Installation.md | 7 ++++++- Documentation/Models.md | 6 ++++++ Documentation/Models.md.meta | 7 +++++++ Documentation/ToC.md | 3 ++- Documentation/ToC.md.meta | 7 +++++++ 6 files changed, 37 insertions(+), 2 deletions(-) create mode 100644 Documentation/Animations.md create mode 100644 Documentation/Models.md create mode 100644 Documentation/Models.md.meta create mode 100644 Documentation/ToC.md.meta diff --git a/Documentation/Animations.md b/Documentation/Animations.md new file mode 100644 index 0000000..e014d71 --- /dev/null +++ b/Documentation/Animations.md @@ -0,0 +1,9 @@ +Animations +========== +The NanoBrain Ant comes with walking animations and an animator. These can be used with any hexapod model but as the rigs of these hexapods can be very different[1](#notes-1) our software provides an animation projection to solve this. H2O + +Notes +===== +1. + The animation retargeting of Unity's Mecanim only works for Humanoid models. +2. bla bla \ No newline at end of file diff --git a/Documentation/Installation.md b/Documentation/Installation.md index fdb7b13..c89f3d1 100644 --- a/Documentation/Installation.md +++ b/Documentation/Installation.md @@ -1,4 +1,5 @@ -# Package Installation +Package Installation +==================== You can import the NanoBrain Ant package in Unity directly with the Package Manager git package importer. @@ -7,3 +8,7 @@ See Unity: [Installing from a Git URL](https://docs.unity3d.com/Manual/upm-ui-gi Use the link from 'Clone with HTTP' (for example: https://git.passer.life/CreatureControl/Ant.git) In this way you can always retrieve the latest version by pressing the Update button in the Package Manager. Optionally, you can use a tag to retrieve a specific version. For example: https://git.passer.life/CreatureControl/Ant.git#0.1.0. This will give you a stable version which does not change. Updating can be done by retrieving the package with a link to a new release. + +Samples Installation +-------------------- +In the Unity Package manager, select the NanoBrain Ant package and look for the `Samples` tab in the details pane on the right. There you can import the `Models`. \ No newline at end of file diff --git a/Documentation/Models.md b/Documentation/Models.md new file mode 100644 index 0000000..2fff92d --- /dev/null +++ b/Documentation/Models.md @@ -0,0 +1,6 @@ +Models +====== + +The package comes with a number of models which can be found in the [Samples][1] folder. These models are rigged and can be used in combination with the [Animations](Animations.md). + +[1]: Installation.md (How to install the Samples) \ No newline at end of file diff --git a/Documentation/Models.md.meta b/Documentation/Models.md.meta new file mode 100644 index 0000000..d109915 --- /dev/null +++ b/Documentation/Models.md.meta @@ -0,0 +1,7 @@ +fileFormatVersion: 2 +guid: 731873261aa9ec328a9dc16c8544f77e +TextScriptImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Documentation/ToC.md b/Documentation/ToC.md index 97e524f..f081963 100644 --- a/Documentation/ToC.md +++ b/Documentation/ToC.md @@ -3,4 +3,5 @@ Table of Contents ----------------- - [Installation](Installation.md) - +- [Models](Models.md) +- [Animations](Animations.md) \ No newline at end of file diff --git a/Documentation/ToC.md.meta b/Documentation/ToC.md.meta new file mode 100644 index 0000000..e28cc36 --- /dev/null +++ b/Documentation/ToC.md.meta @@ -0,0 +1,7 @@ +fileFormatVersion: 2 +guid: b701b64b684e35fe59bf744821ec5ed6 +TextScriptImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: