/altv-updater-js

altv-server installer/updater command line app

Primary LanguageTypeScript

altv-srv -- alt:V Multiplayer Server installer / updater

⚠️  This project will be discontinued in favor of altv-cli!

If you need a fast and reliable altv cdn client, check out the linked repository.

how-to-install

# installing the installer and its needed packages
npm i -g altv-srv

Advantages

  • fast
  • pretty console prints
  • c#-Module support
  • go-module support (unfinished)
  • angelscript-module support
  • python-module support (once it's finished)
  • js-module support
  • js-bytecode-module support
  • altv-voice-server support
  • only update if outdated

CLI-usage

Usage: altv-srv <cmd> [options]

Commands:
altv-srv install <branch>  Install alt:V Multiplayer server and its modules   [aliases: i]
altv-srv delete            Delete the alt:V Multiplayer server and its files  [aliases: d]

Options:
--version  Show version number                                                [boolean]
-h, --help     Show help                                                      [boolean]

Example

# Install full server (server + data) & js + js-bytecode module
altv-srv install release -d ./my-server -m server data js js-bytecode
### Notice:
# To be able to run the server you have to at least install server & data

Install options

altv-srv install <branch>

Install alt:V Multiplayer server and its modules

Positionals:
  directory, dir, d  Set relative server path                   [string] [default: "./"]

Options:
      --version  Show version number                            [boolean]
  -h, --help     Show help                                      [boolean]
  -m, --modules  Specify modules to download
         [array] [choices: "js", "javascript", "c#", "cs",
                           "csharp", "go", "as", "angelscript",
                           "py", "python", "voice", "server",
                           "jsb", "js-bytecode", "bytecode"]
                           [default: ["server","js"]]
  -o, --others   Generate server.cfg and on linux start.sh      [boolean] [default: false]

Delete options

altv-srv delete

Delete the alt:V Multiplayer server and its files

Positionals:
  directory, dir, d  Set relative server path        [string] [default: "./"]

Options:
      --version  Show version number                 [boolean]
  -h, --help     Show help                           [boolean]
      --hard     Remove server.cfg, logs, resources  [boolean] [default: false]

script usage

Install

import { install } from "altv-srv";

const os = "x64_linux";
// os is optional, default is the system os
await install("./", "release", ["server", "js"], os);

Remove

import { remove } from "altv-srv";

// hard removes logs, resources & cache folder, default: false
const hard = true;
const os = "x64_linux";
// os is optional again
await remove("./", hard, os);

If you notice something you think its not intended feel free to open an issue