- Create a new blank repository
- Locally clone this template repository
- Set the local clone's remote to point to the newly created blank repository
- Push to remote. The template's files should now have populated your new repository!
- Set
project-url
in.github/workflows/add-to-project.yml
to the URL of the repository's associated project - Configure your S3 bucket configs in
mantle.yml
. This is where the mantle state file will be hosted. - Configure your S3 bucket access keys in
Scripts/install-tooling.bat
. - Remove the "USING THIS TEMPLATE" instructions from this README.
Soon(TM)
Compiling builds of this project requires the Windows Subsystem for Linux (WSL). For convenience, this repository includes scripts that will automatically install & configure WSL on your machine when ran.
To set up the environment, follow these steps in the commandline from the root of the repository:
- Run
scripts\install-environment.bat
. WSL should begin installing the latest ubuntu distribution. After installation, it will prompt you for a username & password for your linux user account. Input your desired username & password! Once this is done, simply run thelogout
command to close the linux terminal. - Run
scripts\install-tooling.bat
. This will fetch & install any relevant tooling needed to build the project. - You're all set!
To build the project, you simply need to run the build script & specify the name of the environment you want to target. NOTE : If you are targeting an environment that does not exist yet in mantle.yml
, you will need to follow the DEPLOY instructions first!
- Run
scripts\build.bat
with the name of the environment you want to target as a parameter. For example,scripts\build DEV_ND
.
You can open the place file from there! All of the relevant gamepass IDs, place IDs, etc will be automatically used in the game.
To deploy the project to one of the environments, you need to run the deployment script & specify the name of the environment you want to deploy to. If you want to create a new environment, you can specify it in mantle.yml
.
- Run
scripts\deploy.bat
with the name of the environment you want to deploy to as a parameter. For example,scripts\deploy DEV_ND
would deploy the current place file to the universeDEV_ND
on Roblox.