A template for Roblox developers to integrate advanced CLI tools like Rojo into GitHub workflows, streamlining build, test, and deploy processes.
This repository serves as a template designed specifically for Roblox developers looking to enhance their development workflow through advanced integration with CLI (Command Line Interface) tools such as Rojo and Tarmac. It aims to streamline the process of building, testing, and deploying Roblox games and assets by leveraging these powerful tools within GitHub Actions workflows. By utilizing this template, developers can automate repetitive tasks, ensure consistency across projects, and significantly reduce manual intervention required during the development lifecycle.
To get started, simply clone this repository and follow the setup instructions detailed further. You can customize everything according to your needs.
git clone https://github.com/iceeburr/roblox-template
You can either do it manually or use the all-in-one install.sh script. You can find other useful command snippets in there as well.
./scripts/install.sh
Manual Setup:
First, please head over to the aftman releases page and download the latest version. Open your terminal and cd into the directory. Finally run ./aftman self-install.
Now you can run aftman install, followed by wally install.
That's it! Read how to build the place file further. (or use the build.sh script)
Aftman is required to be installed for all scripts.
Use Cases
Actions:
- Sourcemap - will generate a sourcemap.json of the project.
- Packages - will install wally packages & update custom ones with git submodules.
- Types - will fix broken wally types
- Builds - will build the place file.
- Serves - will automatically start serving the place file.
- Starts - will automatically open the place file in studio.
- CQ - Runs code quality checks.
- ❌ - Script does not execute the action.
- ✅ - Script will execute the action.
| Name | Sourcemap | Packages | Types | Builds | Serves | Starts | CQ |
|---|---|---|---|---|---|---|---|
| install.sh | ✅ | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ |
| build.sh | ❌ | ❌ | ❌ | ✅ | ❌ | ❌ | ❌ |
| serve.sh | ❌ | ❌ | ❌ | ✅ | ✅ | ❌ | ❌ |
| start.sh | ❌ | ❌ | ❌ | ✅ | ✅ | ✅ | ❌ |
| types.sh | ✅ | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ |
| packages.sh | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ |
| cq.sh | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ |
There are several ways how you can potentially contribute to this project. One important way to contribute is to actually report bugs/issues you might identify. In addition you can also bring up feature/enhancements requests. Another way is to help translating the README to a wider range of different languages by committing to the translations folder.
Make sure you read the Code of Conduct and Contributing Guide first, as well as all other support guides.
This template is distributed and licensed under the MIT License. See LICENSE for more detailed information. This is NOT legal advice!