theatre README

The project's README from github.com/theatre-js/theatre. As one markdown file: README.md.

Theatre.jsTheatre.js

Motion Design, for the web

GitHub branch checks state Join us on Discord Follow Theatre.js on Twitter Watch on YouTube

✨ Update: Theatre.js 1.0 is around the corner. We have temporarily moved development to a private repo so we can iterate faster. We'll push our work back to this public repo soon. Terms and license will remain OSS, as before. (Also, 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.js can be used both programmatically and visually.


You can use Theatre.js to:

Documentation and Tutorials

The docs are at theatrejs.com/docs:

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 (theatre-js/theatre)

Searching Database…

12.8K ·GitHub
What is this?Theatre.js is an animation library for high-fidelity motion graphics on the web. It is designed for detailed animation — intricate movement and nuance — and can be used both programmatically and visually.
Is it a library I code against, or a visual editor app?Both halves work together: @theatre/core is the runtime library your project ships with, while @theatre/studio is the visual editor you use only while designing. Your final bundle includes only the core.
How do I get it into my project and start using it?Add the packages to a JavaScript project — @theatre/core at runtime and @theatre/studio while developing — then follow the crash course and docs at theatrejs.com/docs.
Do I need to be using THREE.js or React for it to work?No — it integrates well with both, but at bottom it can animate any JavaScript variable, so it fits whatever stack you already have.
Is the project under active development right now?Development has temporarily moved to a private repo so the team can iterate faster on Theatre.js 1.0. They plan to push work back to the public repo soon, and the terms and license will remain OSS.
Can I ship commercial projects with it, given the dual Apache and AGPL licenses?Yes. Core is Apache-2.0, and that is the license of your final bundle. The AGPL-3.0 studio is only used during design and development, so it never ships to your users.
What can I use it to animate?3D objects made with THREE.js or other 3D libraries, HTML/SVG via React, micro-interactions, generative interactive art — or any other JS variable you want to choreograph.
Are there tutorials to learn from?Yes — theatrejs.com/docs hosts video tutorials and a crash course, plus guides like animating with music and Yuri Artiukh's stream covering Theatre.js with THREE.js.
Creator
theatre-js
Size
27 MB
Stars
12.8K
Updated
CommitApr 11
Age
12y
Commits · 90 Days