> For the complete documentation index, see [llms.txt](https://starboycustoms.gitbook.io/starboycustoms-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://starboycustoms.gitbook.io/starboycustoms-docs/script-installation-guide.md).

# ⚙️ Script Installation Guide

Powerful Features. Simple Installation. Professional Configuration.

Welcome to the official **StarBoyCustoms Script Installation Guide**.

This guide will walk you through installing your purchased FiveM script, configuring the resource, managing dependencies, and troubleshooting common installation issues.

Whether you're installing your first StarBoyCustoms script or expanding an established FiveM server, our documentation is designed to make the process as straightforward as possible.

**🚀 DOWNLOAD. INSTALL. CONFIGURE. LAUNCH.**

***

### 📦 1. Overview

StarBoyCustoms scripts are designed to introduce new functionality, enhance gameplay, and improve your overall FiveM server experience.

Each resource may have different installation requirements depending on its features, supported frameworks, and integrations.

Depending on the purchased product, your download may include:

* ⚙️ **Script Resource Files** — Client-side, server-side, and shared scripts.
* 📄 **Resource Manifest** — The `fxmanifest.lua` file used by FiveM.
* 🛠️ **Configuration Files** — Settings for customising supported features.
* 🎨 **User Interface Files** — HTML, CSS, JavaScript, and associated assets where applicable.
* 🗄️ **Database Files** — SQL files or database setup instructions where required.
* 🔗 **Integration Files** — Framework, inventory, or dependency-related components.
* 📖 **Documentation** — Product-specific installation and configuration instructions.

#### 🔧 Framework Compatibility

Depending on the individual product, supported configurations may include:

* ESX
* QBCore
* Qbox
* Standalone

**Framework compatibility varies between scripts.**

> 💡 **Important:** Always check your purchased script's product-specific documentation before installing. Some resources require additional dependencies, database tables, or configuration.

***

### 🚀 2. Script Installation

Follow these steps to install your purchased StarBoyCustoms script.

#### Step 1 — Download Your Script

Download your purchased resource from the official **StarBoyCustoms Tebex Store**.

Extract the downloaded `.zip` archive using:

* Windows Extract
* WinRAR
* 7-Zip

Once extracted, locate the main script resource folder.

**Keep the original files and folder structure intact.**

#### Step 2 — Upload the Script Resource

Navigate to your FiveM server's resource directory:

```
resources/
```

Upload the extracted script folder.

We recommend organising your scripts inside a dedicated category folder.

**Example folder structure:**

```
resources/
└── [starboy]/
    └── scriptname/
        ├── fxmanifest.lua
        ├── client/
        ├── server/
        ├── shared/
        ├── config.lua
        └── ...
```

Your actual folder structure may differ depending on the purchased script.

**⚠️ Do not rename, remove, or relocate supplied files unless the product documentation specifically instructs you to do so.**

#### Step 3 — Install Required Dependencies

Some StarBoyCustoms scripts require additional resources to function correctly.

Examples may include:

* Framework resources
* Inventory systems
* Database libraries
* UI libraries
* Interaction or targeting systems

Always check your product's documentation for its exact requirements.

**Example server.cfg dependency order:**

```cfg
# Framework and dependencies
ensure oxmysql
ensure ox_lib

# StarBoyCustoms resource
ensure scriptname
```

This is an illustrative example only. Install and start `oxmysql` or `ox_lib` only if your purchased script requires them.

> ⚠️ **Important:** Required dependencies should normally start before the StarBoyCustoms resource that uses them.

#### Step 4 — Configure server.cfg

Open your server's configuration file:

```
server.cfg
```

Add the following line:

```cfg
ensure scriptname
```

Replace `scriptname` with the exact name of your script's resource folder.

**Example:**

```cfg
ensure StarBoyAdminV2
```

The name must match the actual resource folder.

#### Step 5 — Restart Your Server

Save your configuration and restart your FiveM server.

Alternatively, use the server console:

```cfg
refresh
ensure scriptname
```

Run these as two separate commands.

Check your server console for any startup errors.

✅ **Your script resource should now be loaded.**

Additional configuration may be required before its features become available.

***

### ⚙️ 3. Script Configuration

Many StarBoyCustoms scripts include configuration options that allow server owners to customise supported features.

#### Step 1 — Locate the Configuration

Depending on the script, configuration files may be located at:

```
scriptname/config.lua
```

Or:

```
scriptname/shared/config.lua
```

Some scripts may use JSON files or other configuration formats.

Always refer to the purchased product's documentation for the correct location.

#### Step 2 — Edit Your Settings

Open the relevant configuration file using a suitable text editor.

Recommended editors include:

* Visual Studio Code
* Notepad++
* Another editor supporting Lua and your script's configuration format

Configuration options may include:

**🎨 Interface Settings**\
Customisable colours, branding, or interface behaviour where supported.

**⚙️ General Settings**\
Enable or disable available functionality.

**🔐 Permissions**\
Configure access to restricted features.

**🌍 Locations**\
Modify coordinates or interaction locations where supported.

**🔗 Integrations**\
Select supported frameworks or external systems.

**📝 Logging**\
Configure supported debugging and logging features.

> 💡 Not every script includes all these settings. Available options depend on the individual product.

#### Step 3 — Save & Apply Changes

After editing the configuration:

1. Save your changes.
2. Check for syntax errors.
3. Restart the relevant resource.
4. Test the affected features in-game.

**Always keep a backup of your original configuration before making changes.**

***

### 🔗 4. Framework & Dependency Setup

StarBoyCustoms scripts may integrate with existing FiveM frameworks and server resources.

#### Framework Integration

Depending on the product, supported frameworks may include:

**🟢 ESX**\
Integration with supported ESX server configurations.

**🔵 QBCore**\
Integration with supported QBCore systems.

**🟣 Qbox**\
Integration with supported Qbox environments.

**⚪ Standalone**\
Resources that can operate without a full roleplay framework.

#### Dependency Requirements

Some scripts may require additional resources for:

* Database operations
* Inventory functionality
* Player interactions
* User interface components
* Notifications
* Framework integration

**Only install dependencies specifically required by your purchased script.**

#### Startup Order

If a script requires dependencies, configure the startup order accordingly.

```cfg
# Required dependencies
ensure dependencyname

# StarBoyCustoms script
ensure scriptname
```

Replace the example names with the actual resources required by your product.

***

### 🗄️ 5. Database Installation

Some StarBoyCustoms scripts require database tables to save and retrieve information.

**Not every script requires a database.**

#### Step 1 — Check for SQL Files

Look for an included SQL file, such as:

```
install.sql
```

Or refer to the product documentation for database setup instructions.

#### Step 2 — Back Up Your Database

Before importing or modifying database tables, create a backup of your existing server database.

#### Step 3 — Import the SQL File

If your script requires an SQL import:

1. Open your preferred database management tool.
2. Select the correct FiveM server database.
3. Import the supplied SQL file.
4. Confirm the required tables were created successfully.

#### Step 4 — Verify Database Connectivity

Confirm that your database resource is configured correctly and starts before scripts that depend on it.

> ⚠️ **Important:** Do not import SQL files from unrelated products or modify existing database tables without checking the supplied instructions.

***

### 🔐 6. Permissions & Access

Some StarBoyCustoms scripts include restricted functionality intended for administrators, staff, or specific player groups.

Depending on the product, permissions may be managed through:

* FiveM ACE permissions
* Framework groups
* Job or role permissions
* Script-specific configuration
* Other supported permission systems

#### Example ACE Configuration

If your script supports ACE permissions, its documentation will specify the correct permission identifiers.

**Illustrative example:**

```cfg
add_ace group.admin example.permission allow
```

Replace `example.permission` with the actual permission identifier documented by your script.

**Do not assume this example grants access to any StarBoyCustoms resource.**

#### Security Recommendations

* Grant restricted permissions only to trusted users.
* Avoid giving unnecessary administrator access.
* Review permission settings before making a script publicly available.
* Keep sensitive credentials out of publicly accessible files.

***

### 🔄 7. Updating Your Scripts

Keeping your resources updated can help maintain compatibility and resolve reported issues.

#### Step 1 — Check for Updates

Review the official StarBoyCustoms announcements or your product's available release information.

#### Step 2 — Back Up Your Existing Resource

Before updating, save copies of:

* Your current script resource
* Configuration files
* Custom modifications
* Relevant database data, where applicable

#### Step 3 — Review Update Instructions

Check whether the update includes:

* New configuration options
* Additional dependencies
* Database changes
* Changed file structures
* Updated permissions

#### Step 4 — Install the Update

Follow the update instructions provided with the new version.

Do not automatically overwrite your existing configuration without checking for changes.

#### Step 5 — Restart & Test

Restart the relevant resources and verify that the script functions correctly.

> 💡 **Important:** Update procedures vary by product. Always follow the release-specific instructions where provided.

***

### 🧪 8. Installation Checklist

Before making your script available to players, complete the following checks:

* Script downloaded and extracted successfully.
* Complete resource folder uploaded.
* Original file structure preserved.
* `fxmanifest.lua` located correctly.
* Required dependencies installed.
* Dependencies started in the correct order.
* Script added to `server.cfg`.
* Configuration reviewed and saved.
* Database setup completed, if required.
* Permissions configured, if applicable.
* Resource starts without console errors.
* Script functionality tested in-game.

Once all applicable checks pass, your resource should be ready for normal server use.

***

### 🛠️ 9. Troubleshooting

#### ❌ Script Isn't Starting

**Possible causes:**

* Incorrect resource folder name.
* Missing `fxmanifest.lua`.
* Incorrect `server.cfg` entry.
* Missing dependencies.
* Invalid configuration.

**Solutions:**

1. Verify the resource folder name.
2. Confirm `fxmanifest.lua` is present.
3. Check the `ensure` entry.
4. Verify all required dependencies are installed.
5. Review the server console.

#### ❌ Script Starts but Doesn't Work

**Possible causes:**

* Incomplete configuration.
* Unsupported framework settings.
* Missing integrations.
* Incorrect permissions.

**Solutions:**

1. Review the script configuration.
2. Confirm framework compatibility.
3. Check dependency startup order.
4. Verify any required permissions.
5. Review client and server console errors.

#### ❌ User Interface Isn't Appearing

**Possible causes:**

* Missing UI files.
* Incorrect manifest references.
* Script functionality not triggered.
* Client-side errors.

**Solutions:**

1. Confirm all supplied UI files are present.
2. Check the resource manifest.
3. Verify the required interaction or command.
4. Review the FiveM F8 console.

#### ❌ Database Errors

**Possible causes:**

* Missing database tables.
* Incorrect database connection.
* Missing database dependency.
* Outdated database structure.

**Solutions:**

1. Verify database connectivity.
2. Confirm required tables exist.
3. Check the database dependency.
4. Review the supplied SQL instructions.
5. Check server console errors.

#### ❌ Permission Denied

**Possible causes:**

* Incorrect ACE permissions.
* Missing framework permissions.
* Incorrect role configuration.

**Solutions:**

1. Review the product's permission requirements.
2. Confirm the correct player group or role.
3. Verify permission identifiers.
4. Restart the resource if required.

#### ❌ Script Causes Console Errors

Review the full error message.

Common causes include missing dependencies, configuration syntax errors, incorrect file paths, and incompatible resource versions.

**Keep a copy of the error message when requesting support.**

***

### 💬 10. Support & Assistance

Having trouble installing or configuring your StarBoyCustoms script?

Our official support community is available to help with product-related technical issues.

#### Before Opening a Support Ticket

Please provide:

* ⚙️ Your purchased script name
* 🖥️ Your FiveM framework
* 📦 Relevant dependencies and versions
* ❗ Full server or client console errors
* 📸 Screenshots of the issue
* 📝 A clear description of the problem
* 🔄 Any changes made before the issue occurred

**Never share passwords, database credentials, licence keys, or other sensitive information in support tickets.**

#### 🔗 Official Links

💬 **Discord Support**<br>

{% embed url="<https://discord.gg/43Fuyt6KP5>" %}

🛒 **Official Tebex Store**<br>

{% embed url="<https://starboycustoms.tebex.io>" %}

▶️ **Official YouTube**<br>

{% embed url="<https://www.youtube.com/@OfficialStarBoyCustoms>" %}

***

### 👑 Thank You for Choosing StarBoyCustoms!

We appreciate your support and hope you enjoy your new FiveM resource.

Our goal is to provide modern, professionally developed scripts alongside documentation that makes installation and configuration straightforward.

For product-specific instructions, always refer to the relevant resource documentation.

**⚙️ POWERFUL FEATURES. SIMPLE INSTALLATION. PROFESSIONAL CONFIGURATION.**

#### ⭐ STARBOYCUSTOMS

**YOUR SERVER. YOUR WORLD. YOUR WAY.**

👑 **INNOVATION. PERFORMANCE. THE STARBOY STANDARD.**
