https://github.com/vanishdevs/vanish_starterpack

A simple script that gives players their starter pack upon first join and interaction with NPC.
https://github.com/vanishdevs/vanish_starterpack

esx fivem ox script

Last synced: 9 months ago
JSON representation

A simple script that gives players their starter pack upon first join and interaction with NPC.

• Host: GitHub
• URL: https://github.com/vanishdevs/vanish_starterpack
• Owner: vanishdevs
• License: gpl-3.0
• Created: 2024-03-21T03:53:36.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-23T22:25:59.000Z (over 1 year ago)
• Last Synced: 2024-10-24T11:25:39.028Z (over 1 year ago)
• Topics: esx, fivem, ox, script
• Language: Lua
• Homepage:
• Size: 49.8 KB
• Stars: 5
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
### Starter Pack

![](https://img.shields.io/github/downloads/vanishdevs/vanish_starterpack/total?logo=github)

![](https://img.shields.io/github/downloads/vanishdevs/vanish_starterpack/latest/total?logo=github)

![](https://img.shields.io/github/contributors/vanishdevs/vanish_starterpack?logo=github)

![](https://img.shields.io/github/v/release/vanishdevs/vanish_starterpack?logo=github)

This script provides a convenient way for players to receive starter packs containing predefined items by interacting with a designated NPC at a certain location. Below, you'll find everything you need to know about installing, configuring, and using this system effectively.

### Preview

[Watch the video](https://streamable.com/5u1eo9)

### Features

- Allows players to interact with an NPC to receive starter packs.

- Customizable NPC ped, position, and animation.

- Easily configurable starter pack contents.

- Server-side functionality to check and mark players who have received starter packs.

### Installation

- Copy the downloaded script files into your server's resource folder.

- Ensure the script is properly included in your server configuration file (`server.cfg`) to ensure it loads correctly when your server starts.

- Run the install.sql query in your database, before starting the script.

- Ensure that you have the necessary dependencies installed, ox_lib.

### Configuration

Configure the following parameters in the config:

- `Coords`: The position where the NPC will be located.

- `Heading`: The heading of the NPC (where it will be facing).

- `PedSettings`: The model & animation of the NPC (can be found in FiveM docs about peds).

- `Items`: The contents of the starter pack, defined as a table where the key is the item name and the value is the quantity.

### Dependencies

Ensure that the following dependencies is installed:

- `esx, qb, qbox, or ox_core`

- `ox_lib`: [Download here](https://github.com/overextended/ox_lib.git)

- `ox_inventory`: [Download here](https://github.com/overextended/ox_inventory.git) (if applicable)