STG ScriptsDocumentation
Sticky Notes

Installation

Install STG Sticky Notes on your FiveM server, import the database table, add the item and start it.

Sticky Notes

STG Sticky Notes

ESXQBCoreQBOX
View in store

Download the script

Sign in to the Cfx.re portal with the account you used at checkout and download stg-stickynotes from Granted Assets.

Move the resource

Extract the zip and place the stg-stickynotes folder inside the [STG] category folder in your resources directory. Keep the [SETUP] folder from the zip at hand for the next steps.

resources/
└── [STG]/
    ├── stg_lib/
    └── stg-stickynotes/

Install the dependencies

Sticky Notes needs ox_lib, oxmysql, ox_target and stg_lib. Skip this step if your server already runs them.

Import the database table

Run [SETUP]/stg_stickynotes.sql on your database. It creates the stg_stickynotes table where every note placed in the world is saved.

Add the item

Players open the note editor with the stickynote item. Add it to your inventory and copy stickynote.png from [SETUP]/item-image/ into your inventory's image folder, for example ox_inventory/web/images or qb-inventory/html/images. QBOX servers, and any ESX or QBCore server running ox_inventory, use the ox_inventory tab.

Add this to ox_inventory/data/items.lua:

['stickynote'] = {
    label = 'Sticky Note',
    weight = 0,
    stack = true,
    close = true,
    description = 'A blank sticky note. Write on it and stick it anywhere.'
},

Add this to QBShared.Items in qb-core/shared/items.lua:

stickynote = { name = 'stickynote', label = 'Sticky Note', weight = 0, type = 'item', image = 'stickynote.png', unique = false, useable = true, shouldClose = true, description = 'A blank sticky note. Write on it and stick it anywhere.' },

Run this query on your database:

INSERT INTO items (name, label)
VALUES
    ('stickynote', 'Sticky Note');

Using another item name? Change Config.Item to match. See Configuration.

Start the script

Make sure [STG] starts after your framework, your inventory, oxmysql, ox_lib and ox_target in server.cfg:

ensure oxmysql
ensure ox_lib
# your framework: es_extended, qb-core or qbx_core
# your inventory, for example ox_inventory
ensure ox_target
ensure stg_lib
ensure [STG]

Then restart the whole server.

config/config.lua ships with example entries in Config.AdminMenu.identifiers. Replace them with your own staff identifiers before you go live, otherwise the admin panel is open to whoever owns those ids. See Admin panel.

Nothing happens or the console shows an error? See Common Errors.

Next steps

Still having trouble?

Open a ticket on our Discord. Our team answers around 15 hours a day.

Get help on Discord

On this page