altv-typescript
altv-typescript copied to clipboard
A Typescript Boilerplate for alt:V with simple setup and usage.
Typescript Boilerplate for alt:V - v5.3.0
Super Fast Compilation
[!IMPORTANT]
This boilerplate will no longer be updated. Consider using Rebar Framework for more up-to-date practices, and a plugin system.
Variants
Features
A simple Typescript Boilerplate that builds incredibly fast using the SWC Library.
- Auto Refresh Server
- Auto Compile TypeScript Files
- Auto Download Resources
- Single Resource Code Support
- Fastest Auto Reconnect Time on Recompile
- Compile Multiple Resources at Once
Installation
Clone the Repository
Use the command below in any terminal, command prompt, etc.
git clone https://github.com/Stuyk/altv-typescript
Install the Repository
Use the command below in any terminal, command prompt, etc.
cd altv-typescript
npm install
Download Server Files
Use the command below in any terminal, command prompt, etc. This will download all necessary server files from an additional package used by this project.
npm run update
Start Production Server (Windows)
Run this command to run the server in production mode.
npm run windows
Start Production Server (Linux)
Run this command to run the server in production mode.
npm run linux
Start Developer Server
Run this command to run the server in development mode.
This will automatically reconnect your alt:V Client if you have debug
mode turned on.
npm run dev
End Server Runtime
Use the key combination ctrl + c
to kill your server in your terminal, command prompt, etc.
How to Add Mods, and New Resources
Always add your already compiled resources & mods into the resources
folder.
How to ignore specific resources from compiling
Add file name .nocompile
to the resource folder you want to ignore from compiling.