84daaaf94a
Addresses the lack of options we currently have for surfacing issues in
our application via debugging tools. Prioritizes performance and
usability (visually) over clarity in some places that could have been
object mapped.
A logger with three separate audiences:
* `internal`: Logs for developers maintaining Theatre.js
* `dev`: Logs for developers using Theatre.js
* `public`: Logs for everyone
This logger supports:
* multiple logging levels (error, warn, debug, trace),
* multiple audience levels (internal, dev, public),
* multiple categories (general, todo, troubleshooting)
* named and keyed loggers (e.g.
`rootLogger.named("Project", project.id)`)
* console styling with deterministic coloring
* console devtool maintains accurate sourcemap link to logging origin
(e.g. `coreExports.ts:71` as opposed to `logger.ts:45` or whatever)
* swappable logger
* customizable filtering
* Accepts lazy `args`: `args: () => object` via
`logger.lazy.<level>("message", () => <expensive computation>)` (e.g.
`logger.lazy.debugDev("Loaded project state", () => ({ save: bigProject.exportToSaveable() }))`)
|
||
|---|---|---|
| .github | ||
| .husky | ||
| .vscode | ||
| .yarn | ||
| contributing | ||
| devEnv | ||
| ecosystem-tests | ||
| examples | ||
| packages | ||
| scripts | ||
| theatre | ||
| .editorconfig | ||
| .eslintrc.js | ||
| .gitignore | ||
| .prettierignore | ||
| .prettierrc | ||
| .yarnrc.yml | ||
| babel.config.js | ||
| CHANGELOG.md | ||
| CONTRIBUTING.md | ||
| credits.txt | ||
| jest.config.js | ||
| lerna.json | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
| tsconfig.base.json | ||
| wallaby.conf.js | ||
| yarn.lock | ||
Motion Design, for the web
✨ Update: We're hiring – join the core team!
Theatre.js is an animation library for high-fidelity motion graphics. It is designed to help you express detailed animation, enabling you to create intricate movement, and convey nuance.
Theatre can be used both programmatically and visually.
You can use Theatre.js to:
-
Animate 3D objects made with THREE.js or other 3D libraries
Art by drei.lu
-
Animate HTML/SVG via React or other libraries
-
Design micro-interactions
-
Choreograph generative interactive art
-
Or animate any other JS variable
Documentation and Tutorials
The docs are at docs.theatrejs.com:
- Getting started guide
- In depth guide
- API docs
- Extensions
- Video tutorials
- Crash course
- Animating with music
- Yuri Artiukh's stream with a section on using Theatre with THREE.js
- <Add your own tutorials here>
Community and support
Join our friendly community on Discord, follow the updates on twitter or write us an email.
Development and contributing
If you want to change the source of Theatre, have a look at the guide here.
Proposing fixes and changes
You can always get help with bugfixes or discuss changes with our community on Discord, or directly open an issue on Github.
Helping with outstanding issues
Feel free to chime in on any issue. We have also labeled some issues with "Help wanted" or "Good first issue" if you're just getting started with the codebase.
Helping with documentation
The documentation website's repo is here.
Writing/recording tutorials
If you make tutorials or video content about Theatre, tell us to showcase it here :)
License
Your use of Theatre.js is governed under the Apache License Version 2.0:
- Theatre's core (
@theatre/core) is released under the Apache License. Same goes for most packages in this repository. - The studio (
@theatre/studio) is released under the AGPL 3.0 License. This is the package that you use to edit your animations, setup your scenes, etc. You only use the studio during design/development. Your project's final bundle only includes@theatre/core, so only the Apache License applies.