Skip to content
This repository has been archived by the owner on Sep 29, 2022. It is now read-only.

Just a bit more to add into "In Depth" #3

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Just a bit more to add into "In Depth" #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fafeaf5
Add quick export explanation from the video
javaarchive Oct 29, 2021
613a8c6
Update README.md
javaarchive Nov 15, 2021
e8d795e
Update README.md
javaarchive Nov 15, 2021
2a4e7da
Update README.md
javaarchive Nov 15, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/getting-started/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ Theatre comes as npm packages, so we need a module [bundler](https://github.com/
:::

Theatre comes in two packages:
* [`@theatre/core`](https://npmjs.com/package/@theatre/core), the core animation library
* [`@theatre/studio`](https://npmjs.com/package/@theatre/studio), the visual editor.
* [`@theatre/core`](https://npmjs.com/package/@theatre/core), the core animation library. Licensed under the Apache 2.0 license.
* [`@theatre/studio`](https://npmjs.com/package/@theatre/studio), the visual editor. Licensed under the [AGPLv3](https://github.com/AriaMinaei/theatre/blob/main/theatre/studio/LICENSE).

Let's add `@theatre/core` as a dependency.

Expand Down Expand Up @@ -175,4 +175,4 @@ If you're using CodeSandbox, make sure to create a `sandbox.config.json` file an
{
"hardReloadOnChange": true,
}
```
```
10 changes: 5 additions & 5 deletions docs/in-depth/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ This is the main way to create a project or access an existing one.

### Exporting

Learn how to export/import projects, and save them to a repository. Currently explained in the [video tutorial](https://youtu.be/icR9EIS1q34?t=1383).
Learn how to export/import projects, and save them to a repository. Currently the state of your project is stored in the localStorage key "theatre-<version without patch>.persistent" which you can access programatically with `localStorage.getItem("theatre-0.4.persistent")`. The state of all the project on the domain can then be found in `historic.innerState.coreByProject` as a map of project ids to project data. Also explained in the [video tutorial](https://youtu.be/icR9EIS1q34?t=1383).

### Project state

The project's state is the actual save file holding the data of your project.
The project's state is the actual save file holding the data of your project. By copying the project state object and specifying it in the config during `getProject` you can load your project without needing for it to be in the user's localstorage already.

* All of the tweaks and animations that you create with Theatre are considered the project's state.
* `@theatre/core` uses project state to run your tweaks and animations.
Expand Down Expand Up @@ -244,10 +244,10 @@ Read more about props the [getting started guide](/getting-started/#create-an-ob

* **Strings**

TODO
TODO, for now see the following [PR](https://github.com/AriaMinaei/theatre/pull/48)
* **Booleans**

TODO
TODO, for now see the following [PR](https://github.com/AriaMinaei/theatre/pull/48)
* **Compounds**

TODO
Expand All @@ -270,5 +270,5 @@ The libraries come bundled with typescript definitions with [TSDoc](https://tsdo

---

This documentation is a work in progress. In the meantime, check [the video tutorial](https://www.youtube.com/watch) which covers much of Theatre.js.
This documentation is a work in progress. In the meantime, check [the video tutorial](https://www.youtube.com/watch?v=icR9EIS1q34) which covers much of Theatre.js.