🖥️Installation

In order to ensure a successful installation, please follow the instructions very carefully.

Dependencies

oxmysql

Installation

• Download the latest build of oxmysql (not the source code).

• Extract the contents of the archive to your resources folder.

• Start the resource near the top of your resources in your server.cfg.

Required version

Your oxmysql version must be 2.0.0 or above in order to work with our system.

Use the built version

Make sure you have downloaded the built version of oxmysql! If you download the source code, then the resource won't start and queries are unable to execute.

The built version can be downloaded from the releases page (oxmysql.zip).

ox_lib

Installation

• Download the latest build of ox_lib (not the source code).

• Extract the contents of the archive to your resources folder.

• Start the resource near the top of your resources in your server.cfg.

Use the built version

Make sure you have downloaded the built version of ox_lib! If you download the source code, then it won't function correctly and the application will have problems.

The built version can be downloaded from the releases page (ox_lib.zip).

Installing the resource

1. Make sure you have the dependencies listed above installed.

2. Extract the contents of the archive to your resources folder.

3. Ensure the resource is set to start up with the server.

Framework

If you're using QB, QBX or ESX, your framework will be automatically detected.

For other frameworks, please follow the provided instructions:

Using other frameworks

Firstly, in editable_shared/config.lua change the framework to CUSTOM.

Secondly, in editable_server/framework.lua, go to the supportedFrameworks variable and fill in the following:

• resourceName

• loadFramework

• prepareInventory

• giveItem

• removeItem

• getCash

• removeCash

• getIdentifier

• getVehicleIdentifier

• getLoggingText

Youtube API key

Fill out youtubeApiKey in editable_server/config.lua.

We have detailed insturctions on how to obtain the API key at ️2️⃣ Obtaining Youtube API key. We recommend following those instructions carefully to get your API key.

Using the resource

Use the command /speakers in-game to open the speaker creation menu.

Speaker types

Speaker types grant you access to an unlimited amount of different, customizable speakers, each with their own unique properties, such as different 3D models, audio filters and many more.

A set of predefined speaker types will be automatically generated for your comfort and in order to demonstrate the endless abilities of our resource.

🚩Use the command /speakertypes to create new or edit existing speaker types.

🎧 Using forced filters

For maximum immersion we have introduced a unique funcionality.

Forced filters are filters that automatically apply audio effects to speakers in specific situations.

Types of forced filters:

➖Always on - applied always, regardless of context.

➖Interior difference - applied the speaker and player are in different interiors.

➖Vehicle based - applied when the speaker is inside a vehicle with closed windows/doors.

When creating new speaker types, you can customize filter intensity and other parameters.

⚙️ Permissions

When creating new speaker types, permissions are a required field. Here's a list of available permissions and their functions:

• PERMISSION_QUEUE: Enables queue usage

• PERMISSION_CARRY: Allows carrying (requires attachData in speaker type)

• PERMISSION_STORE: Enables storage after creation (ideal for one-time use)

• PERMISSION_PUBLIC: Allows marking as public

• PERMISSION_RENAME: Enables renaming

• PERMISSION_FILTERS: Allows extra filter usage

• PERMISSION_SETTINGS: Grants access to settings menu

• PERMISSION_PERMANENT: Allows marking as permanent

• PERMISSION_ADD_GROUP: Enables adding to a speaker group

• PERMISSION_PLAY_MUSIC: Allows music playback (useful for group-only speakers)

• PERMISSION_PAUSE_RESUME: Enables pause/resume functionality

• PERMISSION_VOLUME_RANGE: Allows volume/range adjustments

• PERMISSION_VEHICLE_ATTACH: Enables vehicle attachment

• PERMISSION_GIZMO: Allows gizmo usage (for vehicle attachment or moving permanent speakers)

Speaker groups

Speaker groups allow you to connect different speakers to play the same audio.

This allows you to create very immersive surround sound environments, basically granting you your own sandbox audio tool.

🚩Use the command /speakergroup to create or access speaker groups.

All available commands

/speakers

This command can be used to access the speaker creation menu.

See 1️⃣ Speaker creation for more info.

/speakertypes

This command can be used to access the Speaker types menu.

/speakergroup

This command can be used to access the Speaker groups menu.

/musicvolume

This command can be used to control the volume of the resource.

Instead players having to go to the Windows Volume Mixer and mess with the Chromium Subprocess Volume, players can adjust their personal volume in-game.

Vehicles

Speakers can be attached to vehicles and their states saved to your database.

This ensures that speakers remain attached to player-owned vehicles even after storage and respawning.

To enable this feature:

➖ In editable_server/config.lua, set vehicleSaving to true.

➖ In editable_server/framework.lua, make sure getVehicleIdentifier function is filled.

➖ Based on your garage resource, add the vehicle created event

qb-garages

In qb-garages/server/main.lua add this line (like in the screenshot):

TriggerEvent('rahe-speakers:server:vehicleCreated', source, veh)

Click this link to view the code on Github: qb-garages/server/main.lua

esx_garage

In esx_garage/server/main.lua add this line (like in the screenshot):

TriggerEvent('rahe-speakers:server:vehicleCreated', source, vehicle)

Click this link to view the code on Github: esx_garage/server/main.lua

cd_garage

In cd_garage/configs/client_customise_me.lua add this line (like in the screenshot) to the function VehicleSpawned:

TriggerServerEvent('rahe-speakers:server:vehicleSpawnedByClient', VehToNet(vehicle))

jd_advanced

If you are using jg-advancedgarages, everything will work out of box as long as you have filled previous prequisites.

CUSTOM

🚩If your garage resource is spawning vehicles on client-side

After vehicle creation, trigger this event:

TriggerServerEvent('rahe-speakers:server:vehicleSpawnedByClient', VehToNet(vehicle))

Note: Make sure to pass vehicle network ID to the event.

🚩If your garage resource is spawning vehicles on server-side

After vehicle creation, trigger this event:

TriggerEvent('rahe-speakers:server:vehicleSpawnedByServer', source, vehicleEntityId)

Note: Make sure to pass player source and vehicle entity ID to the event.

That's it! Speaker states will be saved when attached to database-saved vehicles.