Build truly beautiful experiences on the web!
Threed Studio is a 3D animation editor with a set of design, lighting and motion tools. It helps you create any 3D scene, from a simple product presentation to a complete game made with Three.js.
Feel free to contribute or inspire yourself to build something out of it.
The goal is to incorporate all the editing capabilities provided by Three.js and its ecosystem into the editor's interface, granting users the freedom to accomplish practically everything they would be able to do if they were directly coding with this technology.
The product ought to have the capability to construct any 3D experiences on the web, leveraging Three.js exclusively for this purpose. I believe it would be splendid to fully harness the 3D modeling potential offered by this technology and bestow that very same power upon users through the editor tools.
Moreover, we aim to implement certain functionalities that streamline the creation of more complex things, such as character control in a third-person game or even scroll-based animations, ideal for crafting websites and web presentations.
What really helped us.
- threejs
- pmndrs/react-three-fiber
- pmndrs/drei
- pmndrs/postprocessing
- pmndrs/zustand
- radix-ui
- reactflow
- monaco-editor
- tailwindcss
- the-base-mesh
- lucide
- cmdk
- console-feed
- @tabler/icons-react
- nanoid
- r3f-perf
- react-color
- react-headless-pagination
- react-hot-toast
- react-json-tree
- mantine/hooks
- nanoid
- threed.world
- docs.threed.world
guide - studio.threed.world
app - threed.world/community
- threed.world/contribute
- dev.threed.world
environment - develop-threed.vercel.app
environment - github.com/open-threed/studio/discussions
forum
Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on studio.threed.world.
Read our Code of Conduct to keep our community approachable and respectable.
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
To get an overview of the project, read this README. Here are some resources to help you get started with open source contributions:
- Finding ways to contribute to open source on GitHub
- Set up Git
- GitHub flow
- Collaborating with pull requests
To navigate our codebase with confidence, see the introduction to working in the threed-studio repository. For more information on how we use our code patterns, see the threed-studio code pattern reference.
Check to see what types of contributions we accept before making changes. Some of them don't even require writing a single line of code.
If you spot a problem, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.
Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.
- Fork the repository.
- Create a working branch and start with your changes.
- Commit your update and create a pull request for a review.
Commit the changes once you are happy with them. Don't forget to self-review to speed up the review process.
When you're finished with the changes, create a pull request, also known as a PR.
- Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
- Don't forget to link PR to issue if you are solving one.
- Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a Open ThreeD team member will review your proposal. We may ask questions or request additional information.
- We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the PR. You can make any other changes in your fork, then commit them to your branch.
- As you update your PR and apply changes, mark each conversation as resolved.
- If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.
Congratulations! The ThreeD Studio community thanks you.
Once your PR is merged, your contributions will be publicly visible on the ThreeD Studio.
Now that you are part of the Open ThreeD community, see how else you can contribute to the project.