A flexible and straightforward template CLI for Roblox projects, inspired by roblox-project-template
- Flexible: create-roblox was designed with various workflows and usecases in mind, featuring a wide range of options and configurations for both games and packages.
- Easy to use: create-roblox attempts to get rid of the complexity surrounding Roblox project setup: there's no need to look through the sea of existing tools, we've picked out the best ones for you.
- DX-centered: create-roblox is made to make your life easier, not harder. Project templates work out of the box, requiring minimal setup to get started with your project.
- Minimal learning curve: create-roblox will produce a README file with all information about the tools you've included in your project, including documentation and links to their respective repositories, so you can get to efficiently using them right away.
- Wally support
- Support for string requires, through Darklua
- Support for continuous integration with GitHub Actions, with Stylua and Selene
- Support for a wide range of UI libraries out of the box, like Roact, Fusion and Vide.
- Support for a wide range of storybook plugins out of the box, like Flipbook, UI Labs and Hoarcekat.
- Support for both packages and games, adapting seamlessly to your needs.
- Packages that work out of the box, including support for Zap and Cmdr
- Install the package globally:
npm install -g create-roblox - Run
create-robloxin your desired directory and follow the instructions - Follow the generated README for instructions, and you're good to go!
- Run
npm create robloxornpx create-robloxin your desired directory and follow the instructions - Follow the generated README for instructions, and you're good to go!
Contributions are always welcomed; I can't keep this up to date myself forever, so if there are any packages/tools/whatever that are deemed worth adding, feel free! Code should follow the Prettier and ESLint rules for this repository. To contribute, fork this repository, make your changes, and create a pull request. Please make sure to test your changes before creating a pull request.
This project is licensed under the MIT License - see the LICENSE.md file for details.