๐Ÿ“‚Installation

Follow these easy steps to set up the Collectibles Pickup Script on your FiveM server! ๐Ÿš€


Step 1: Download the Script

๐Ÿ“ฅ Download the script files from the source (e.g., Tebex) where you purchased them.


Step 2: Install the Script and Add to server.cfg

  1. ๐Ÿ“‚ Place the w_collectables folder into your server's resources directory.

  2. โœ๏ธ Open your server.cfg file and add the following line:

    ensure w_collectables

Step 3: Import the SQL File

  1. ๐Ÿ—‚๏ธ Locate the SQL file included with the script.

  2. โš™๏ธ Import it into your database using a tool like phpMyAdmin, HeidiSQL, or any database management software.

  3. โœ… This step ensures all required tables are created for the script to function.


Step 4: Configure the Script

๐Ÿ”ง Key Configuration Files

File

Location

Purpose

config.lua

shared folder

Adjust global settings, permissions, and framework options.

discord.lua

serverConfigs

Configure Discord-related features (optional).

Locales

locales folder

Add or modify language files for UI localization.

๐ŸŒ Adding a New Locale:

  1. Create a .lua file in the locales folder.

  2. Add your translations to the file.

  3. The new language will automatically appear as an option in the UI.


Step 5: Set Up Permissions

The script uses ACE permissions to control access to the admin interface.

Examples:

๐Ÿ‘ฅ Group Permissions: Add this to give admin groups access:

add_ace group.admin "pickups.admin" allow

๐Ÿ‘ค Individual Permissions: Replace the placeholders with the relevant identifier:

  • SteamID:

    add_ace identifier.steam:110000112345678 "pickups.admin" allow
  • License Key:

    add_ace identifier.license:123456789abcdef "pickups.admin" allow
  • Discord ID:

    add_ace identifier.discord:123456789012345678 "pickups.admin" allow
  • IP Address:

    add_ace identifier.ip:192.168.1.1 "pickups.admin" allow

๐Ÿ”ง Customizing Permission Name:

  1. Open framework.lua in the serverConfigs folder.

  2. Change the default permission name (pickups.admin) to fit your serverโ€™s structure. For example:

     acePermissions = 'pickups.admin',

Step 6: Restart Your Server

๐Ÿ”„ Apply Changes:

  1. Save the changes in server.cfg.

  2. Restart your server to load the script and apply all updates.


Step 7: Ready to Use!

๐ŸŽฎ Player Experience:

  • Players can now explore the map, collect pickups, and earn rewards.

๐Ÿ› ๏ธ Admin Tools:

  • Admins can manage pickups and rewards through the intuitive interface.


Quick Reference Table

Step

Description

๐Ÿ“ฅ Download

Get the script from Tebex or your source.

๐Ÿ“‚ Install

Place it in the resources folder and add it to server.cfg.

๐Ÿ—‚๏ธ Import SQL

Import the SQL file to your database.

๐Ÿ”ง Configure

Edit config.lua and other files for custom settings.

๐Ÿ›ก๏ธ Set Permissions

Add ACE permissions for groups or individuals.

๐Ÿ”„ Restart

Restart the server to apply changes.

๐ŸŽฎ Ready to Play

Enjoy the script and its features!


Last updated