altv-pkg

alt:V PKG

An easy to use resource installer for alt:V

---

A community resource that allows users to easily install resources and ask questions during the installation process, install dependencies, clone the repository, and then handle the responses in their post install script.

This was created to easily install resources from your server's base directory.

Find resources on alt:V Hub

Visit the official alt:V GTA:V Client Website

❤️ Become a Sponsor of my Open Source Work

⌨️ Learn how to script for alt:V

⭐ This repository if you found it useful!

How to Use

Install with Command Line

Make sure to get NodeJS Version 13+.

If you get module not found errors. You don't have 13+.

npm install -g altv-pkg

Powershell Users

If you have issues running the altv-pkg command.

Simply run the following to unblock powershell from running scripts.

Ensure you use powershell with administrative permission.

Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy Unrestricted -Force;

Download Server Files with Command Line

You should be running this in a directory with existing server files or where you want to download the alt:V Server Framework for JavaScript.

altv-pkg d <branch_name>

ie. altv-pkg d release

Install with Command Line

You should be running this in your base server directory where package.json is.

If you don't have a package.json do npm init.

Also make sure to create a folder called resources.

altv-pkg i <author>/<reponame>

ie. altv-pkg i stuyk/altv-discord-auth

If the repo is NOT supported it will tell you.

Remove with Command Line

You should be running this in your base server directory where package.json is.

altv-pkg r <author>/<reponame>

Resource Creators

If you wish to add support to your resource for this file. Please add .altv file to your repository with installation instructions. You can also specify [] inside of your .altv file to skip all instructions.

Use This Badge

Only all the cool devs do it. 😎

[![Generic badge](https://img.shields.io/badge/.altv_pkg_support-Yes!-4E753E.svg)](https://shields.io/)

Instruction Types

package

Installs an npm package automatically.

question

Ask a question for the user to respond to in the comnand line.

Responses are recorded to resources/<your_repo>/responses.json

postinstall

Specify a script for node to run at the end of the script.

This file should be located in your repository.

Instructions Example

Here is a baseline example of your .altv file could look.

Yes, you can have multiple instructions of the same type.

[
    {
        "type": "package",
        "name": "sjcl",
        "version": "latest"
    },
    {
        "type": "question",
        "question": "What is your favorite color?"
    },
    {
        "type": "postinstall",
        "file": "post.js"
    }
]

Explanation

1. Add sjcl to package.json dependencies.
2. Ask the user a question and store the response in responses.json
3. Run a postinstall script called post.js with NodeJS.

Author

Created by Stuyk (Trevor Wessel)

https://github.com/sponsors/Stuyk/

https://patreon.com/stuyk

alt:V Installer Supported Resources

• Make a pull request to append your files to the bottom of this list.