Installation

This guide will walk you through installing prp-scenes on your FiveM server.

Installation steps

1

Download the resource

Download prp-scenes from the CFX portal and place it in your resources folder.

2

Add to server.cfg

Add prp-scenes to your server.cfg after all dependencies.

ensure oxmysql
ensure ox_lib
ensure prp-bridge
ensure prp-scenes

3

Optional: graffiti items

Add the graffiti items to your inventory resource if you want graffiti mode — see Items below.

4

Optional: webhook

Set LogWebhookUrl in editable/sv_config.lua to log scene creation and deletion to Discord.

5

Configure presets

Edit editable/sh_presets.lua to configure the default scene presets available to players.

6

Configure progress bars

Edit editable/sh_progressbars.lua to configure graffiti spray and removal progress bar durations.

7

Optional: inventory icons

Custom inventory icons are included in the installation/inventory icons folder. Copy them to your inventory resource's image directory if you'd like to use them.

Items

The graffiti items are optional - only add them if you want to use the graffiti feature. The regular /scene command works without any items.

Add the items below to your ox_inventory into data/items.lua.

-- Graffiti (optional)
["spray_can"] = {
    label = "Spray Can",
    weight = 1,
    stack = false
},
["spray_remover"] = {
    label = "Spray Remover",
    weight = 1,
    stack = false,
},

Database

The required table is created automatically on first server start:

CREATE TABLE IF NOT EXISTS scenes_new (
    id          INT AUTO_INCREMENT PRIMARY KEY,
    author      TEXT NOT NULL,
    displayData LONGTEXT NOT NULL,
    coords      LONGTEXT NOT NULL,
    rotation    LONGTEXT,
    isStaff     TINYINT(1) DEFAULT 0 NOT NULL,
    createdAt   DATETIME DEFAULT CURRENT_TIMESTAMP() NOT NULL,
    expiresAt   DATETIME DEFAULT CURRENT_TIMESTAMP() NOT NULL,
    deleted     TINYINT(1) DEFAULT 0 NOT NULL,
    skipHistory TINYINT(1) DEFAULT 0 NOT NULL
);