roblox-ts template
A roblox-ts template for fully managed rojo projects.
[](https://www.roblox.com/games/17834656300)
[](https://www.roblox.com/games/17613681043)
[](https://discord.com/invite/JFvZY5JSBT)
[!CAUTION]
You likely do not need a fully managed rojo project. For the vast majority of
projects, a more simple setup will suffice. If you are new to roblox-ts, I
would strongly advise against using the vast majority of the tooling in this
project. Instead, I would recommend starting with a more simple setup such as
the default flamework template, or the
roblox-ts-template by
MonzterDev.
This is my personal template for use in the roblox-ts ecosystem, utilizing
popular libraries and tools such as Flamework, React, and Reflex. For a
comprehensive list of packages, refer to the package.json file.
The primary objective of this project is to provide a streamlined approach for
initiating new projects, complete with frequently used patterns that I adopt
already configured. Additionally, it integrates my own customized eslint-config,
which is a highly opinionated guide for writing clean and consistent code.
[!NOTE]
This aims to be a fully-fledged solution to fully managed rojo projects but does
not currently have any built-in support for handing models. Eventually this
functionality will exist. For now, you can investigate
Lune to figure out solutions that will work
for your use case.
How to use:
- Press the green
Use this template button on the top right of the page to
create a new repository.
- Clone the repository to your local machine.
- Run
pnpm install to install all the dependencies.
- Run
pnpm run dev:start to start the development server.
- Start coding! 🎉
Resources
The following is a list of primary resources that are used in this project (in
alphabetical order):
Packages
Roblox Tools
Development Tools
Guide
The following is a guide to the tools of the project and how to typically use
them.
Developing
While in development, I would typically use the pnpm run dev:start command to
compile the project and start the development server. This will compile the
code, build the project, and then automatically open the place file in Roblox
Studio.
To publish the project, I would use the pnpm run prod:build command to build
the game project with the production configuration. This will delete your
current out folder, replace it with the new build, and then automatically runs
darklua on the project (outputting the game project to the dist folder). This
allows us to completely remove any development only code, such that it does not
exist in the final game project. This process is currently automated when you
merge a pull request into the main branch.
Tip
All of the commands can be found in the package.json file under the scripts
section. These can be accessed in VSCode through the NPM SCRIPTS tab in the
sidebar, where you can run them by clicking the play button next to the command.
Contributing
As this is a personal template, I am not typically seeking contributions.
However, if you discover any bugs, feel free to create a pull request or an
issue, and I will address it. If you wish to suggest a feature or improvement,
please submit an issue first to initiate discussion!
Credits 🙏
Some of the code in this template has been taken from others and modified for my
usage, and I would like to give credit to the following people and projects: