Skip to content

README.md

Latest commit

 

History

History
52 lines (33 loc) · 1.61 KB

README.md

File metadata and controls

52 lines (33 loc) · 1.61 KB

Warning

IN DEVELOPMENT! This is an early preview that is open already, but not complete!

CreateMod Tweaks Monorepo

Contains everything to run the https://createmod-tweaks.net and to generate the necessary databases, extract the various items, and in deliver the packager and editor to manage your own tweaks within one single data-pack.

Pre-requisites

The following tools are expected to be installed on your machine:

Optionally:

Once you have both, use the following command to install local tooling:

proto install

Development

The general tooling is done through Moon, a monorepo manager and automation runner. This is used for both development and continuous integration.

The main technology is with Typescript using Deno, but this may expand into Rust.

We currently have the following workspaces:

  • packages: Re-usable parts within the monorepo as packages.
  • content: Markdown or JSON content for custom pages and general organization.
  • apps: Independent applications that are deployed as Micro-Frontends
  • website: The website itself to show the various tweaks.

With moon, you would use the following syntax:

moon <workspace>:<task>

Where the task are usually: up down restart start build compile cli

Contributions

While discussions and pull requests are welcomed, if you can wait a little-bit for the MVP version so that there is something to contribute to!