wolf2789 / altv-typescript

A Typescript Boilerplate for alt:V with simple setup and usage.

Typescript Boilerplate for alt:V - v3.0.5

[ altv.mp | stuyk.com ]

^{Super Fast Compilation & Auto Reconnection}

⌨️ Learn how to script for alt:V

❤️ Become a Sponsor of my Open Source Work

💡 Need a Roleplay Script? Try Athena!

⭐ This repository if you found it useful!

Features

A simple Typescript Boilerplate that builds incredibly fast using the SWC Library.

• Full alt:V Type Support for VSCode
• Development Mode with Super Fast Auto Reconnection
• Built in auto-copy for non-typescript files.
• Built in handling of multiple resources for compilation.
• Built in server restart after compilation.
• Easily expandable resource directory.
• altv-pkg support for auto-downloading alt:V Server Binaries.
• Prettier Configuration for code formatting.

Installation

• Install NodeJS 16+
• Install GIT

Clone the Repository

Use the command below in any terminal, command prompt, etc.

git clone [email protected]:Stuyk/altv-typescript.git

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

Build Typescript Files

Use the command below in any terminal, command prompt, etc. This will build your TypeScript code into JavaScript.

npm run build

Start the Server

Use any of the following commands to start it.

Based on your environment.

Linux	Windows	Windows Development
npm run linux	npm run windows	npm run dev

End Server Runtime

Use the key combination ctrl + c to kill your server in your terminal, command prompt, etc.