Skip to content

Latest commit

 

History

History
56 lines (33 loc) · 1.66 KB

README.md

File metadata and controls

56 lines (33 loc) · 1.66 KB
Raw

Advanced Roblox Project Boilerplate

This repository provides a comprehensive boilerplate setup tailored for Roblox game development. It is thoughtfully pre-configured with the following essential tools:

📕 Requisites

  • 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.

🚀 Getting Started

  1. Clone this repository:
git clone https://github.com/dev-jhon-yo/project-boilerplate.git
cd project-boilerplate
  1. Create Packages Directory

In the project root, create a folder called Packages. You can do this according to your operation system.

  1. Install tools:
foreman install
  1. To build the place from scratch, execute:
rojo build -o "project-boilerplate.rbxlx"
  1. 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.

🤝 Contributing

If you're interested in contributing or have issues to report, please refer to our contribution guidelines.

🔓 License

This project is licensed under the MIT License. Your creativity is the limit—happy coding!