Electus LogoElectus Documentation

Installation

Step-by-step installation guide.

Installation Steps

Please ensure you follow these steps carefully. If you are having trouble installing, please join our Discord for support.

Download the package

Download the package from Portals

Install dependencies

Ensure your selected framework, inventory, target system, and upload provider are started before electus_graffiti.

Add script to server.cfg

Add electus_graffiti to your server.cfg after its dependencies:

ensure electus_graffiti

Run the SQL file

electus_graffiti.sql

Run the SQL file electus_graffiti.sql to set up the database tables

Configure the script

In config/config.lua, set your framework, inventory, target system, upload method, image limits, and optional Electus Gangs integration.

Select upload method

In config/config.lua, choose an upload method with Config.UploadMethod.

Graffiti images are exported as WebP when the client supports it, with PNG as a fallback.

MethodSetup
FivemanageSet the FIVEMANAGE_MEDIA_API_KEY convar or your upload API key in server_config/config.lua.
QboxSet the QBOX_CDN_API_KEY convar.
LBPresignedInstall and start lb-presigned before electus_graffiti.

Use Config.UploadMethod = "auto" if you want the bridge to detect lb-presigned, FIVEMANAGE_MEDIA_API_KEY, or QBOX_CDN_API_KEY automatically.

Restart your server

Restart your server to apply the changes.