For the complete documentation index, see llms.txt. This page is also available as Markdown.

Configuration

Page dedicated to how to configure our Graffiti

Languages

You can set the language of the script in the configuration file.

  • en: English

  • fr: French

  • pl: Polish

  • de: German

  • es: Spanish

Basics

Defines general behavior and interaction settings for graffiti functionality:

  • Basics.RenderDistance: Maximum distance (in meters) from which graffiti can be seen.

  • Basics.AutomaticlyWash: Controls automatic graffiti removal over time: • status: Set to true to enable automatic cleaning. • time: Time (in seconds) after which graffiti is removed.

  • Basics.Spraying: Configuration for the spraying process: • time: Time (in seconds) it takes to spray graffiti. • allowImages: If true, allows using custom images instead of preset text. • MaxImageResoultion: Maximum allowed dimensions for custom image graffiti. • MaxDistanceToDraw: Max distance from player to surface for placing graffiti.

  • Basics.Washing: Configuration for graffiti removal process: • time: Time (in seconds) it takes to wash off graffiti.

  • Basics.Items: Item-based compatibility settings (ESX / QBCore / QBox supported): • menu.name: Item required to open the graffiti menu (e.g., 'graffiti_can'). • menu.enabled: If true, item is required to use the spray function. • remove.name: Item required to remove graffiti (e.g., 'graffiti_remover'). • remove.enabled: If true, item is required to clean graffiti. • removeAfterUse: Whether items are removed after usage. (Configure in config/server/config_framework.lua)

Admin

Defines admin-related tools and permissions for graffiti management:

  • Admin.aceName: ACE permission required to access graffiti management features (e.g., 'manageGraffiti').

  • Admin.tags: Displays graffiti metadata (creator name and creation time) when nearby: • enabled: If true, shows admin tags on graffiti. • distance: Maximum distance from graffiti to display tag info.

Commands

Defines the commands used to interact with graffiti features:

  • Commands.menu: • name: Command to open the graffiti menu (e.g., /graffitimenu). • enabled: If true, the command is available for use.

  • Commands.remove: • name: Command to remove nearby graffiti (e.g., /graffitiremove). • enabled: If true, the command is available for use.

  • Commands.toggleVisiblity: • name: Command to toggle the visibility of all graffiti (e.g., /graffititoggle). (Primarily for debugging or admin purposes.)

Exports

Defines the exports available for triggering graffiti actions from other scripts:

  • Exports.menu: • name: Name of the export function used to open the graffiti menu (e.g., exports.resourceName:graffitimenu()). • enabled: If true, the export is active and can be called externally.

  • Exports.remove: • name: Name of the export function used to remove nearby graffiti (e.g., exports.resourceName:graffitiremove()). • enabled: If true, the export is active and can be called externally.

Last updated