GTA V Role Play playground for alt:V server

[ altv.mp | Thanks Stuyk ]

Documentation links

• ALT Client Docs
• ALT Server Docs
• Native Docs
• Unofficial alt:V Docs

⭐ This repository if you found it useful!

Development

alt:V has a lot of Boilerplates for TypeScript. However, they have one feature missing. They fail to create an environment where you can support multiple resource compilations. This boilerplate aims to fix that and allow multiple resources to be compiled at once and all your mods.

Features

• Full alt:V Type Support for VSCode
• Built in script auto-compilation through npm run watch.
• Built in auto-copy for non-typescript files.
• Built in handling of multiple resources for compilation.
• Easily expandable resource directory.
• altv-pkg support for auto-downloading alt:V Server Binaries.
• Prettier Configuration for code formatting.

Installation

Get NodeJS 13+

Login to github packages. For password use your github access token or create new one with read packages permission

npm login --scope=@durtyfree --registry=https://npm.pkg.github.com

Install the node modules

npm install

Download Server Files

npm run update

Build Typescript Files

npm run build

Start the Server

Use any of the following commands to start it.

Based on your environment.

Linux	Windows (CMD)	Windows (Powershell)
./start.sh	altv-server.exe	./altv-server.exe

Development Mode

If you wish to work your game-mode simply open up VSCode. Open up a terminal and split it (Ctrl + Shift + 5).

Run the following in a terminal:

npm run watch

Run your server in another terminal:

Linux	Windows (CMD)	Windows (Powershell)
./start.sh	altv-server.exe	./altv-server.exe

End Server Runtime

ctrl + c to kill your server.

Reload changed resources

Directly on running server terminal type reload RESOURCE_NAME to reload module.

src vs src-copy

src

This folder should be used to write your typescript based game modes.

src-copy

This folder should be used to copy car mods, mlos, etc. to your resources folder after compilation.

Simply add your modded resources, resource dependencies, etc. into this folder.

The build script will handle the rest.

Ingame keybindings

• E Raises his hand and whistles. If you are close to the vehicle - opens the door. If you are in the vehicle opens a window. If you are near the trunk / hood opens it

• F Sits in the driver's seat. Do not turn off the engine by exiting and holding the F key

• G Sits as a passenger in the nearest seat

• B Pointing finger

• X Raises his hands (surrenders)

• C Hold to Crouch