Serqan commited on
Commit
8fb97a4
·
verified ·
1 Parent(s): 8269350

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +141 -1
README.md CHANGED
@@ -1,5 +1,145 @@
1
  ---
2
  license: other
3
  license_name: motionsmith-runtime-multiple-third-party-licenses
4
- license_link: LICENSE
 
 
 
 
 
 
5
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: other
3
  license_name: motionsmith-runtime-multiple-third-party-licenses
4
+ tags:
5
+ - unreal-engine
6
+ - animation
7
+ - motion-generation
8
+ - nvidia-kimodo
9
+ - ai-animation
10
+ - motionsmith
11
  ---
12
+
13
+ # MotionSmith Runtime
14
+
15
+ **MotionSmith Runtime** is the external AI runtime package used by **MotionSmith - AI Animation Studio** for Unreal Engine.
16
+
17
+ It provides the Python environment, NVIDIA Kimodo components, motion-generation model, LLM2Vec text-encoder adapters, backend workers, and supporting dependencies required by MotionSmith.
18
+
19
+ This repository is intended for use with the MotionSmith Unreal Engine plugin and is not a standalone application.
20
+
21
+ ## Runtime Version
22
+
23
+ **MotionSmith Runtime 1.0.0 — Win64**
24
+
25
+ Runtime package:
26
+
27
+ `releases/1.0.0/MotionSmithRuntime-1.0.0-Win64.zip`
28
+
29
+ SHA-256:
30
+
31
+ `98acde53cc8c16d2496f5512978f1f5227075930417ebdd9db36ed123abddf03`
32
+
33
+ ## Installation
34
+
35
+ The recommended installation method is through MotionSmith inside Unreal Engine.
36
+
37
+ Open:
38
+
39
+ **Editor Preferences → Plugins → MotionSmith**
40
+
41
+ Then use:
42
+
43
+ **Install MotionSmith Runtime**
44
+
45
+ MotionSmith downloads this Runtime package, verifies its SHA-256 checksum, installs it to the local MotionSmith Runtime directory, and validates the required components.
46
+
47
+ Default installation location on Windows:
48
+
49
+ `%LOCALAPPDATA%\MotionSmith\Runtime`
50
+
51
+ Manual extraction is normally not required.
52
+
53
+ ## Included Components
54
+
55
+ The Runtime package includes:
56
+
57
+ - Python 3.12 runtime
58
+ - CUDA-enabled PyTorch environment
59
+ - NVIDIA Kimodo runtime components
60
+ - Kimodo-SOMA-RP-v1.1 motion model
61
+ - MotionSmith backend workers
62
+ - MotionCorrection dependencies
63
+ - LLM2Vec MNTP adapter
64
+ - LLM2Vec supervised adapter
65
+ - Tokenizer and text-encoder support files
66
+ - Runtime diagnostics and validation resources
67
+ - Required third-party Python dependencies
68
+ - Third-party license and attribution files
69
+
70
+ ## Meta Llama 3
71
+
72
+ **Meta Llama 3 model weights are NOT included in this repository or in the MotionSmith Runtime package.**
73
+
74
+ MotionSmith uses **Meta Llama 3 8B Instruct** together with LLM2Vec for text encoding.
75
+
76
+ Users obtain Meta Llama 3 separately from the official Meta repository on Hugging Face after accepting the applicable Meta license and access terms.
77
+
78
+ MotionSmith can download and configure the model from within its setup interface using the user's own Hugging Face read token.
79
+
80
+ The Hugging Face token is used only for the requested download and is not stored permanently by MotionSmith.
81
+
82
+ Existing local Meta Llama 3 installations can also be selected manually.
83
+
84
+ **Built with Meta Llama 3.**
85
+
86
+ ## Runtime Validation
87
+
88
+ MotionSmith validates the Runtime before generation and checks components including:
89
+
90
+ - Runtime version
91
+ - Python
92
+ - PyTorch
93
+ - CUDA availability
94
+ - NVIDIA Kimodo
95
+ - Motion model
96
+ - LLM2Vec adapters
97
+ - Meta Llama 3
98
+ - Backend worker availability
99
+
100
+ The MotionSmith Diagnostics / Pre-Flight system reports whether the environment is ready for animation generation.
101
+
102
+ ## Platform
103
+
104
+ Current release target:
105
+
106
+ - Windows 64-bit
107
+ - Unreal Engine 5.8
108
+ - NVIDIA CUDA-capable GPU
109
+
110
+ MotionSmith Runtime 1.0.0 has been tested with the MotionSmith 1.0.0 Unreal Engine plugin.
111
+
112
+ ## Licensing
113
+
114
+ This repository contains components distributed under multiple independent licenses.
115
+
116
+ No single license applies to every component contained in the MotionSmith Runtime package.
117
+
118
+ Third-party license texts, notices, source information, and attribution records are included under:
119
+
120
+ `Licenses/`
121
+
122
+ Major components include software and/or model assets from projects such as:
123
+
124
+ - NVIDIA Kimodo
125
+ - LLM2Vec / McGill-NLP
126
+ - Python
127
+ - PyTorch
128
+ - Hugging Face libraries
129
+ - Other third-party Python dependencies
130
+
131
+ Each component remains subject to its respective license terms.
132
+
133
+ See the repository `LICENSE` file and the `Licenses/` directory inside the Runtime package for details.
134
+
135
+ ## Distribution
136
+
137
+ This Runtime repository exists to support legitimate installations of MotionSmith.
138
+
139
+ Do not treat the complete Runtime archive as a separately licensed standalone product or assume that all bundled third-party components may be redistributed independently of their respective licenses.
140
+
141
+ ## MotionSmith
142
+
143
+ **MotionSmith - AI Animation Studio** provides AI-assisted human motion generation, continuation, editing, pose authoring, timeline workflows, and retargeting inside Unreal Engine.
144
+
145
+ Powered by NVIDIA Kimodo.