stuyk / altv-quickstart

The fastest alt:V JS setup on GitHub.

alt:V - Quick Start

---

❤️ Become a Sponsor of my Open Source Work

⌨️ Learn how to script for alt:V

💡 Need a Roleplay Script? Try Athena!

⭐ This repository if you found it useful!

---

This repo will do everything for you; including download the latest server files.

Includes the following:

• Chat
• Chat Commands
• Weapon Commands
• Vehicle Commands
• Kill Feed
• Respawn on Death
• A scale-able folder structure

Requirements

• Git
• NodeJS 13+

Links

• alt:V Website
• alt:V Unofficial Documentation

Installation

GIF Instructions:

Step 1 GIF

Step 2 GIF

Step 3 GIF

Text Instructions:

0. Open a command prompt in a folder.

1. Run this:

git clone https://github.com/Stuyk/altv-quickstart
cd altv-quickstart

2. Run the code block below this.

   2.1. This can be used whenever you need to update your server files.

   2.2. Run the code block below; wait for packages to install.

   2.3. Then follow the instructions on screen.

npm run update

3. Bootup the Server

   3.1. This script downloads for Linux or Windows automatically.

   3.2. Use a screen on Linux to run the server in the background.

   3.3. Use a built in command prompt such as in VSCode to run the server.

   3.4. You may press Ctrl + C to stop the server at any time.

Linux:

./start.sh

Windows (CMD):

altv-server.exe

Windows (Powershell):

./altv-server.exe

Connecting to your Quick-Start alt:V Server

Simply put in the following direct connect url: 127.0.0.1:7788

Broadcasting Your Server

Your server can be broadcasted by getting a token from the alt:V bot in the Discord.

Message Master-Bot#3667 and it will instruct you on what to type.

After doing this simply set announce to true in your server.cfg.

Reconnecting to your Server

If you wish to reconnect to your server after restarting you need to enable debug mode on both your client and your server.

In your server.cfg put the following:

debug: true

In your altv.cfg for your alt:V client put the following: debug: true

This will fully allow you to reconnect to your server by press f8 and typing reconnect <password>

altv-quickstart's Issues

npm run update don't recognize altv-pkg

npm run update gives: "'altv-pkg' is not recognized as an internal or external command,
operable program or batch file." No info on this on the web or similar matter.

libatomic.so.1 no such file or directory

./start.sh

Such an error occurred when I used the command.

error while loading shared libraries: libatomic.so.1: cannot open shared object file: No such file or directory