This repository provides a comprehensive boilerplate setup tailored for Roblox game development. It is thoughtfully pre-configured with the following essential tools:
-
Selene: A blazing-fast modern Lua linter written in Rust.
-
Stylua: An opinionated Lua code formatter.
-
Rojo: Rojo is a project management tool.
-
Foreman: Toolchain manager for Roblox projects.
-
Wally: Wally is a modern package manager for Roblox projects inspired by Cargo.
- Clone this repository:
git clone https://github.com/dev-jhon-yo/project-boilerplate.git
cd project-boilerplate
- Create Packages Directory
In the project root, create a folder called Packages
. You can do this according to your operation system.
- Install tools:
foreman install
- To build the place from scratch, execute:
rojo build -o "project-boilerplate.rbxlx"
- Afterward, open
project-boilerplate.rbxlx
in Roblox Studio and initiate the Rojo server:
rojo serve
Feel free to customize configurations and explore additional functionalities provided by each tool according to your project's requirements.
If you're interested in contributing or have issues to report, please refer to our contribution guidelines.
This project is licensed under the MIT License. Your creativity is the limit—happy coding!