51 lines
1.9 KiB
Markdown
51 lines
1.9 KiB
Markdown
|
### Overview
|
||
|
|
This repo holds all of the animations to be used for Animation DB, used for embodied speech. It also is a skill
|
||
|
|
that can be used to test .keys files as they are developed. For the sake of brevity we refer to this repo as the "ADA".
|
||
|
|
|
||
|
|
### Installation
|
||
|
|
|
||
|
|
These steps will create an ADA repo in your current directory:
|
||
|
|
```
|
||
|
|
$ git clone https://github.jibo.com/CharacterAI/jibo-anim-db-animations
|
||
|
|
$ cd jibo-anim-db-animations
|
||
|
|
$ yarn i
|
||
|
|
```
|
||
|
|
|
||
|
|
### Editing animations within the ADA
|
||
|
|
|
||
|
|
You can use the Jibo SDK to edit animations within the ADA just as you would any other skill's animations. However, since animations within the ADA
|
||
|
|
often reference other animations in the ADA by name, the ADA must be linked in as a dependency of itself.
|
||
|
|
|
||
|
|
If you plan to edit animations within the ADA, perform this step after you have completed the clone step above:
|
||
|
|
```
|
||
|
|
$ yarn link
|
||
|
|
$ yarn link jibo-anim-db-animations
|
||
|
|
```
|
||
|
|
|
||
|
|
### Linking the ADA into the SDK Monorepo:
|
||
|
|
|
||
|
|
Often when developing a skill (in the SDK Monorepo) you need assets from a specific branch of the ADA for testing. You can accomplish this by linking
|
||
|
|
that branch of the ADA into the SDK Monorepo.
|
||
|
|
|
||
|
|
From the directory that you cloned `jibo-anim-db-animations`:
|
||
|
|
```
|
||
|
|
$ cd ~/path/to/jibo-anim-db-animations
|
||
|
|
$ git checkout your-branch
|
||
|
|
$ yarn link
|
||
|
|
```
|
||
|
|
then, in your SDK Monorepo:
|
||
|
|
```
|
||
|
|
$ cd ~/path/to/sdk
|
||
|
|
$ yarn link jibo-anim-db-animations
|
||
|
|
```
|
||
|
|
**IMPORTANT**: _DO NOT_ link `jibo-anim-db-animations` into any other directory (e.g your skill, or `skills/be`).
|
||
|
|
|
||
|
|
From there, `bootstrap`/`build`/`sync` the SDK Monorepo as you normally do.
|
||
|
|
|
||
|
|
|
||
|
|
# Additional Scripts
|
||
|
|
|
||
|
|
1. Get a list of each unique anim db category and meta entry and which .keys file it was found in:
|
||
|
|
1. Run node scripts/categories-meta.js to see the results.
|
||
|
|
1. TIP: The output can be quite long and will get cut off by the terminal, alternatively: run node scripts/categories-meta.js > info.txt and then open info.txt.
|