Skip to content

Commit 60511ef

Browse files
committed
Updating documentation
1 parent 3492c7a commit 60511ef

File tree

4 files changed

+11
-4
lines changed

4 files changed

+11
-4
lines changed

Docs/README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Documentation
22

3-
## Legacy engine integration
3+
## Engine integration
44

55
In order to use the ACL plugin in *Unreal Engine 4.20* and earlier, you will need to manually integrate a few engine changes. These changes can be found in the following *GitHub* branches:
66

@@ -63,3 +63,10 @@ ACL splits animation sequences into smaller segments and compresses those indepe
6363
Three boolean flags are also provided to control the per segment range reduction for debugging purposes.
6464

6565
Two values control how segments are partitioned: *Ideal Num Key Frames Per Segment and Max Num Key Frames Per Segment*. ACL will attempt to have segments of the ideal number of key frames while never exceeding the maximum value provided. The default values are sensible and should be suitable for everyday use.
66+
67+
## Performance metrics
68+
69+
* [Carnegie-Mellon University database performance](./Docs/cmu_performance.md)
70+
* [Paragon database performance](./Docs/paragon_performance.md)
71+
* [Matinee fight scene performance](./Docs/fight_scene_performance.md)
72+
* [Decompression performance](./Docs/decompression_performance.md)

Docs/cmu_performance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Carnegie-Mellon University database performance
22

3-
| | ACL Plugin v0.1.0 | UE 4.19.2 |
3+
| | ACL Plugin v0.1.0 | UE v4.19.2 |
44
| ------- | -------- | -------- |
55
| **Compressed size** | 70.60 MB | 99.94 MB |
66
| **Compression ratio** | 20.25 : 1 | 14.30 : 1 |

Docs/fight_scene_performance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Matinee fight scene performance
22

3-
| | ACL Plugin v0.1.0 | UE 4.19.2 |
3+
| | ACL Plugin v0.1.0 | UE v4.19.2 |
44
| ------- | -------- | -------- |
55
| **Compressed size** | 8.67 MB | 23.67 MB |
66
| **Compression ratio** | 7.20 : 1 | 2.63 : 1 |

Docs/paragon_performance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Paragon database performance
22

3-
| | ACL Plugin v0.1.0 | UE 4.19.2 |
3+
| | ACL Plugin v0.1.0 | UE v4.19.2 |
44
| ------- | -------- | -------- |
55
| **Compressed size** | 226.02 MB | 392.97 MB |
66
| **Compression ratio** | 18.92 : 1 | 10.88 : 1 |

0 commit comments

Comments
 (0)