Skip to content

Commit be02171

Browse files
adamgrahamadamgraham
committed
Update README and manual docs
1 parent 2f07656 commit be02171

File tree

4 files changed

+69
-39
lines changed

4 files changed

+69
-39
lines changed

‎.docfx/manual/avatar-masks.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,23 @@ Mask assets can be used in Animator Controllers, when specifying Animation Layer
66

77
A benefit of using Masks is that they tend to reduce memory overheads since body parts that are not active do not need their associated animation curves. Also, the unused curves need not be calculated during playback which will tend to reduce the CPU overhead of the animation.
88

9-
## Included Assets
9+
### Included Assets
1010

1111
The **Animation Library** package contains 16+ avatar masks to represent different humanoid body parts:
1212

13-
- Humanoid-Arms
14-
- Humanoid-FullBody
15-
- Humanoid-Hands
16-
- Humanoid-Head
17-
- Humanoid-LeftArm
18-
- Humanoid-LeftHand
19-
- Humanoid-LeftLeg
20-
- Humanoid-Legs
21-
- Humanoid-LowerBody
22-
- Humanoid-RightArm
23-
- Humanoid-RightHand
24-
- Humanoid-RightLeg
25-
- Humanoid-Root
26-
- Humanoid-Torso
27-
- Humanoid-TorsoHead
28-
- Humanoid-UpperBody
13+
- Arms
14+
- FullBody
15+
- Hands
16+
- Head
17+
- LeftArm
18+
- LeftHand
19+
- LeftLeg
20+
- Legs
21+
- LowerBody
22+
- RightArm
23+
- RightHand
24+
- RightLeg
25+
- Root
26+
- Torso
27+
- TorsoHead
28+
- UpperBody

‎.docfx/manual/index.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Overview
22

3-
The **Animation Library** package contains assets and scripts for animating Unity objects.
3+
The **Animation Library** package contains assets and scripts for animating Unity objects. Animation behaviors include Blink, FollowPath, Move, Orbit, Rotate, Scale, SmoothFollow, SmoothLookAt, and more. The package also contains several animation-related data structures and predefined avatar masks.
44

55
### Behaviors
66

@@ -25,9 +25,3 @@ The **Animation Library** package contains assets and scripts for animating Unit
2525
- [Vector2AnimationCurve](xref:Zigurous.Animation.Vector2AnimationCurve)
2626
- [Vector3AnimationCurve](xref:Zigurous.Animation.Vector3AnimationCurve)
2727
- [Vector4AnimationCurve](xref:Zigurous.Animation.Vector4AnimationCurve)
28-
29-
### Source Code
30-
31-
The source code for the **Animation Library** package is in the following repository:
32-
33-
- https://github.com/zigurous/unity-animation-library

‎.docfx/manual/installation.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,9 @@
22

33
Use the Unity [Package Manager](https://docs.unity3d.com/Manual/upm-ui.html) to install the **Animation Library** package.
44

5-
To install the **Animation Library** package:
6-
7-
1. Open the Package Manager in **Window > Package Manager**
8-
2. Click the **add** (`+`) button in the status bar
9-
3. Select **Add package from git URL** from the add menu
5+
1. Open the Package Manager in `Window > Package Manager`
6+
2. Click the add (`+`) button in the status bar
7+
3. Select `Add package from git URL` from the add menu
108
4. Enter the following Git URL in the text box and click Add:
119

1210
```https://github.com/zigurous/unity-animation-library.git```
@@ -16,10 +14,16 @@ For more information on the Package Manager and installing packages, see the fol
1614
- [Unity’s Package Manager](https://docs.unity3d.com/Manual/Packages.html)
1715
- [Installing from a Git URL](https://docs.unity3d.com/Manual/upm-ui-giturl.html)
1816

19-
## Importing
17+
### Importing
2018

2119
Import the package namespace in each class/script you want to use it. You may need to regenerate project files/assemblies first.
2220

2321
```csharp
2422
using Zigurous.Animation;
2523
```
24+
25+
### Source Code
26+
27+
The source code for the **Animation Library** package is in the following repository:
28+
29+
- https://github.com/zigurous/unity-animation-library

‎README.md

Lines changed: 41 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,53 @@
11
# Animation Library
22

3-
The Animation Library package contains assets and scripts for animating Unity objects. Included animation scripts are Blink, Move, Orbit, Rotate, Scale, SmoothFollow, SmoothLookAt, and more. The package also contains several animation data structures and humanoid avatar masks.
3+
The **Animation Library** package contains assets and scripts for animating Unity objects. Animation behaviors include Blink, FollowPath, Move, Orbit, Rotate, Scale, SmoothFollow, SmoothLookAt, and more. The package also contains several animation-related data structures and predefined avatar masks.
4+
5+
## Installation
6+
7+
Use the Unity [Package Manager](https://docs.unity3d.com/Manual/upm-ui.html) to install the **Animation Library** package.
8+
9+
1. Open the Package Manager in `Window > Package Manager`
10+
2. Click the add (`+`) button in the status bar
11+
3. Select `Add package from git URL` from the add menu
12+
4. Enter the following Git URL in the text box and click Add:
13+
14+
```https://github.com/zigurous/unity-animation-library.git```
15+
16+
For more information on the Package Manager and installing packages, see the following pages:
17+
18+
- [Unity’s Package Manager](https://docs.unity3d.com/Manual/Packages.html)
19+
- [Installing from a Git URL](https://docs.unity3d.com/Manual/upm-ui-giturl.html)
20+
21+
### Importing
422

523
Import the package namespace in each class/script you want to use it. You may need to regenerate project files/assemblies first.
624

725
```csharp
826
using Zigurous.Animation;
927
```
1028

11-
## Installation
29+
## Index
1230

13-
The Unity Package Manager can load a package from a Git repository on a remote server.
31+
### Behaviors
1432

15-
To load a package from a Git URL:
33+
- [AnimatedSprite](https://docs.zigurous.com/com.zigurous.animation/api/Zigurous.Animation.AnimatedSprite.html)
34+
- [Blink](https://docs.zigurous.com/com.zigurous.animation/api/Zigurous.Animation.Blink.html)
35+
- [FollowPath](https://docs.zigurous.com/com.zigurous.animation/api/Zigurous.Animation.FollowPath.html)
36+
- [Move](https://docs.zigurous.com/com.zigurous.animation/api/Zigurous.Animation.Move.html)
37+
- [Orbit](https://docs.zigurous.com/com.zigurous.animation/api/Zigurous.Animation.Orbit.html)
38+
- [Rotate](https://docs.zigurous.com/com.zigurous.animation/api/Zigurous.Animation.Rotate.html)
39+
- [RotateAround](https://docs.zigurous.com/com.zigurous.animation/api/Zigurous.Animation.RotateAround.html)
40+
- [Scale](https://docs.zigurous.com/com.zigurous.animation/api/Zigurous.Animation.Scale.html)
41+
- [SmoothFollow](https://docs.zigurous.com/com.zigurous.animation/api/Zigurous.Animation.SmoothFollow.html)
42+
- [SmoothLookAt](https://docs.zigurous.com/com.zigurous.animation/api/Zigurous.Animation.SmoothLookAt.html)
1643

17-
1. Open the Package Manager window
18-
2. Click the add (`+`) button in the status bar
19-
3. Select **Add package from git URL** from the add menu
20-
4. Enter the following Git URL in the text box and click Add:
21-
`https://github.com/zigurous/unity-animation-library.git`
44+
### Data Structures
45+
46+
- [AnimatorParameter](https://docs.zigurous.com/com.zigurous.animation/api/Zigurous.Animation.AnimatorParameter.html)
47+
- [Timing](https://docs.zigurous.com/com.zigurous.animation/api/Zigurous.Animation.Timing.html)
48+
- [Timing01](https://docs.zigurous.com/com.zigurous.animation/api/Zigurous.Animation.Timing01.html)
49+
- [TimingRange](https://docs.zigurous.com/com.zigurous.animation/api/Zigurous.Animation.TimingRange.html)
50+
- [TimingRange01](https://docs.zigurous.com/com.zigurous.animation/api/Zigurous.Animation.TimingRange01.html)
51+
- [Vector2AnimationCurve](https://docs.zigurous.com/com.zigurous.animation/api/Zigurous.Animation.Vector2AnimationCurve.html)
52+
- [Vector3AnimationCurve](https://docs.zigurous.com/com.zigurous.animation/api/Zigurous.Animation.Vector3AnimationCurve.html)
53+
- [Vector4AnimationCurve](https://docs.zigurous.com/com.zigurous.animation/api/Zigurous.Animation.Vector4AnimationCurve.html)

0 commit comments

Comments
 (0)