|
1 | | -# DumbCode Studio v1 |
| 1 | +# Turborepo starter |
2 | 2 |
|
3 | | -The Dumbcode Studio v1 is meant to be the model for the first release version of the DumbCode Studio. We have had the great opportunity to work with out community to design this beutiful piece of software. We have gone through 3 main phases of the studio to get it to this point and we are very happy to bring it to the public finally after all these years! |
| 3 | +This is an official Yarn v1 starter turborepo. |
4 | 4 |
|
5 | | -## What does it do? |
| 5 | +## What's inside? |
6 | 6 |
|
7 | | -The DumbCode Studio is a conjunction of tools for creating entity mods for minecraft. It includes: |
8 | | -- A Project File Handler |
9 | | -- A Modeler |
10 | | -- An Animator |
11 | | -- Texture Mapper |
12 | | -- Texturing tools |
13 | | -- A variety of export options, including to our Lib format DumbLibrary |
| 7 | +This turborepo uses [Yarn](https://classic.yarnpkg.com/) as a package manager. It includes the following packages/apps: |
14 | 8 |
|
15 | | -## Project Management v2 |
| 9 | +### Apps and Packages |
16 | 10 |
|
17 | | -The project page has always been the hub for the studio. This is the place where you start and finish all your projects. As the Studio evolved over this past year we found it to need a bit of an overhaul in what faces the user. We took the react rewrite as an opportunity to rethink it and make it the most user friendly the community has ever seen it. We've also brought a bunch of new features to project management like remote projects to incorperate things directly with your git repositories. |
| 11 | +- `docs`: a [Next.js](https://nextjs.org) app |
| 12 | +- `web`: another [Next.js](https://nextjs.org) app |
| 13 | +- `ui`: a stub React component library shared by both `web` and `docs` applications |
| 14 | +- `eslint-config-custom`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`) |
| 15 | +- `tsconfig`: `tsconfig.json`s used throughout the monorepo |
18 | 16 |
|
19 | | -## The Modeler |
| 17 | +Each package/app is 100% [TypeScript](https://www.typescriptlang.org/). |
20 | 18 |
|
21 | | -The modeler is the team's goal to take what we've learned from other modeling softwares like Tabula and Blockbench for Minecraft mods, and professional modeling softwares like Rhinoceros to create a fully functional piece of software for creating blocky style models. Our goal is for studio models to be useful for your games or mods in a more user friendly way than ever before. |
| 19 | +### Utilities |
22 | 20 |
|
23 | | -Our command backed interface makes the software very easily expandable in the future and we plan to keep adding new features well into the future. |
| 21 | +This turborepo has some additional tools already setup for you: |
24 | 22 |
|
25 | | -## The animator v3 |
| 23 | +- [TypeScript](https://www.typescriptlang.org/) for static type checking |
| 24 | +- [ESLint](https://eslint.org/) for code linting |
| 25 | +- [Prettier](https://prettier.io) for code formatting |
26 | 26 |
|
27 | | -The DumbCode animator v1 was a proof of concept to animate Tabula models for our minecraft mods. The prototype version turned out to be a huge improvement to our workflow so we refined it in v2 with new features and a new more friendly interface which allowed some community members to provide feedback too. The 3rd version is meant to be the final visual change for the animator. It takes the v2 animator and makes it more accessible for any and all users. Those experienced with other softwares and even new animators will find this new version to be much simpler than before while allowing for more complex animations to take place in less screen realistate while sticking to our original design goals. |
| 27 | +### Build |
28 | 28 |
|
29 | | -## The Texture Mapper |
| 29 | +To build all apps and packages, run the following command: |
30 | 30 |
|
31 | | -This version of the studio breaks apart the texture mapping and texturing tools into seperate tasks, This makes the controlls on the texturer more reliable for your textureres and allows for simplified user interfaces. In the future we want to make texture mapping as painless as possible, and this is the first step towards that future. |
| 31 | +``` |
| 32 | +cd my-turborepo |
| 33 | +yarn run build |
| 34 | +``` |
32 | 35 |
|
33 | | -## The Texturer v2 |
| 36 | +### Develop |
34 | 37 |
|
35 | | -In this version we've taken the Texturer to a new level. Originally we made the texturer to be a simple mapping tool with some painting options to make it easy to get your bearings on a model in an external texturing tool. We've decided to allow for the user to create a full worspace for texturing the models further than ever before in a tool like the studio. We don't think this will be the final stage of the Texturer but we do believe that it's the first step towards it being great. |
| 38 | +To develop all apps and packages, run the following command: |
36 | 39 |
|
37 | | -## Summary and Disclaimer |
| 40 | +``` |
| 41 | +cd my-turborepo |
| 42 | +yarn run dev |
| 43 | +``` |
38 | 44 |
|
39 | | -DumbCode has been working on this project for a long time, and are very excited to make it useful to the public in the near future. Public functionality will come soon, and is technically avalible. |
| 45 | +### Remote Caching |
40 | 46 |
|
41 | | -More news to come and make sure to keep up with us on [Discord](https://www.dumbcode.net/discord) and on our [Website](https://www.dumbcode.net/) for news to come. |
| 47 | +Turborepo can use a technique known as [Remote Caching](https://turborepo.org/docs/core-concepts/remote-caching) to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines. |
42 | 48 |
|
43 | | -### Contributing |
| 49 | +By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can [create one](https://vercel.com/signup), then enter the following commands: |
44 | 50 |
|
45 | | -## Getting Started |
| 51 | +``` |
| 52 | +cd my-turborepo |
| 53 | +npx turbo login |
| 54 | +``` |
46 | 55 |
|
47 | | -First, run the development server: |
| 56 | +This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview). |
48 | 57 |
|
49 | | -```bash |
50 | | -yarn dev |
51 | | -``` |
| 58 | +Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your turborepo: |
52 | 59 |
|
53 | | -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. |
| 60 | +``` |
| 61 | +npx turbo link |
| 62 | +``` |
54 | 63 |
|
55 | | -## Learn More |
| 64 | +## Useful Links |
56 | 65 |
|
57 | | -To learn more about Next.js, take a look at the following resources: |
| 66 | +Learn more about the power of Turborepo: |
58 | 67 |
|
59 | | -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. |
60 | | -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. |
| 68 | +- [Pipelines](https://turborepo.org/docs/core-concepts/pipelines) |
| 69 | +- [Caching](https://turborepo.org/docs/core-concepts/caching) |
| 70 | +- [Remote Caching](https://turborepo.org/docs/core-concepts/remote-caching) |
| 71 | +- [Scoped Tasks](https://turborepo.org/docs/core-concepts/scopes) |
| 72 | +- [Configuration Options](https://turborepo.org/docs/reference/configuration) |
| 73 | +- [CLI Usage](https://turborepo.org/docs/reference/command-line-reference) |
0 commit comments