rcore.cz
  • rcore.cz
  • Store
  • Discord
  • Web administration
  • Our store
  • YouTube
  • ๐ŸŒCFX Auth system
    • CFX Auth system
    • Transfer script to another account
    • Error: You lack the required entitlement
    • Error: syntax error near '<\1>'
  • Server
    • Updating server
    • onesync
  • Administration
    • How to change IP
    • Forgot your password?
  • FAQ
    • General issues
    • Cannot verify license
    • Cannot hear any music
    • ECONNRESET: Unable to execute a query
  • paid resources
    • ๐Ÿ‘rcore_airhockey
      • How To Play
      • Spawning a Hockey Table
    • ๐Ÿ’ชrcore_armwrestling
      • How to place arm table
    • ๐ŸŽดrcore_banners
      • How to Begin
      • How to Update
      • Common issues & solutions
      • Installation
      • Inventory Items
      • Configs
        • General
        • Billboards
        • Business
        • Permissions
        • Job
        • Config
      • Guides
        • How to change UI logo?
        • How to create new server banner?
        • How to create business?
        • How to buy billboard?
        • How to place banner?
        • Cannot see banners?
        • Expired images
      • API
    • ๐Ÿ€rcore_basketball
      • Configure new hoop
    • ๐Ÿ“rcore_beerpong
      • How to use
    • ๐Ÿ“นrcore_bodycam
      • Integration
      • Anticheat
      • Recordings don't save
    • ๐ŸŽณrcore_bowling
      • Configure new alley
    • ๐ŸŽฅrcore_cam
      • Integration
      • Anticheat
    • โ›บrcore_camping
      • Installation
      • Config
      • Consumable Beer
      • OX Inventory
      • Frameworks
      • API
    • ๐ŸŽชrcore_carnival
      • Create new minigame
    • ๐Ÿƒrcore_casino
      • Installing Maps
        • UncleJust Casino
        • DlcIplLoader
        • Gabz Casino
        • NoPixel Casino
        • K4MB1 Casino
        • rcore_casino_interior
        • Underground Casino Paleto
        • K4MB1 Enterable Diamond Casino
        • Patoche Casino
        • Clawles: Casino Los Santos
        • Molo Casino
        • Jurassic Jackpot Casino
      • Standalone Version
      • Custom Framework
      • Installing on QBCore
      • Installing on ESX
      • Installing Inventory Items
      • The Cashier
      • Society
      • Lucky Wheel & Podium Vehicle
      • Table Games
      • Slot Machines
      • Casino Bar
      • Inside Track
      • Translations
      • Discord Hook
      • MYSQL Info
      • CasinoControl (Exports)
      • Casino Job & Office
      • Changing Odds
    • ๐Ÿ‘•rcore_clothes
      • Dark theme
      • Adding a new clothes shop
      • Components
      • Restriction for certian job
      • Custom clothes price
      • Clothes blacklist / Whitelist
      • esx_accessories
      • qb_apartments
      • cui_character
      • API: Open outfits
      • API: Open clothes shop
    • ๐ŸŽฝrcore_clothing ๐Ÿ†•
      • How to begin
      • Installation
      • Migration
      • Configs
        • Main config
        • Price config
        • Shop config
        • Peds config
        • Undress clothes
      • FAQ
      • Admin mode
        • Modes
        • Image debugging
        • Stock management
      • Adding replace/addon clothes
      • Categorize clothing automatically
      • API
      • Troubleshooting
      • Integration
        • Multichar integration guide
        • esx_multicharacter
        • esx_multicharacter OLD
        • qb-multicharacter
        • crm_multichar
        • codem_multichar
        • okok_multichar
        • qbox_multichar
        • ESX vms_multichar
        • QB vms_multichar
        • qs-multicharacter
        • um_multichar
        • wais_multicharacter v2
        • zr_multichar
        • zsx_multicharacter
    • ๐Ÿ’ƒrcore_dance
      • Installation
      • Config
      • FAQ
      • Troubleshooting
      • API
    • ๐Ÿ“ฑrcore_dispatch
      • Config
      • Add alerts
      • Add jobs
      • Locales
      • Logs
      • Integrations
      • Framework
      • Voice and radio
    • ๐Ÿ”’rcore_doorlock
      • Installation
      • Configuration
      • Migration
      • Business
        • Configuration
        • Locksmith Example
      • Inventory Items
      • Keychain
      • API
    • ๐Ÿบrcore_drunk
      • How to place drink on table
      • Create new item drink
      • ox inventory
      • API
      • How to use
    • ๐Ÿฅšrcore_easter
      • Installation
      • Configuration
      • API
    • โ›ฝrcore_fuel
      • Installation
        • ESX
        • QBCore
      • Inventory
        • ESX
        • QBCore
        • ox_inventory
      • Config
        • New fuel station
        • Change fuel type for vehicle
        • Change fuel capacity for vehicle
        • Setting fuel station to be ownable
        • Wrong fuel type
        • Change gas price
      • Integrations
        • API
        • Vehicle keys integrations
        • Hud/Garage integration
      • Server
        • Commands
    • ๐Ÿ”ซrcore_gangs
      • API
        • Client
        • Server
      • Integration
        • Framework
        • Inventory
        • Dispatch
      • Localization
      • Configuration
        • Custom gang zone
    • ๐Ÿš™rcore_garage
      • qb-phone missing garages name
      • missing screenshots
    • ๐Ÿ“™rcore_guidebook
      • Installation
      • Config
      • Data permissions
      • API
      • Themes
      • ๐Ÿ“™V1 Docs
        • Installation
        • API
        • Themes
    • ๐Ÿ”ซrcore_gunshop
      • QBCore Installation
      • ESX Installation
      • How to change pricing
      • How to enable sales of weapons
      • Enabling MK2 weapons on QBCore
      • Adding the ammunation job for QBCore
      • Adding the ammunation job for ESX
    • ๐ŸŽฏrcore_gunrange
      • Installation
      • API
      • Troubleshooting
      • Frequently Asked Questions
      • Gun Range Editor
    • ๐Ÿจrcore_hotel
      • How to add another hotel example
      • esx_inventoryhud
      • Quasar inventory
      • OX inventory
      • MF inventory
      • Custom wardrobe
    • ๐Ÿง‘rcore_identity
      • How to change date format
      • esx_kasharacter
    • ๐ŸŸ rcore_job_blips
      • Installation
      • Configuration
      • Blip Setup
      • Group Setup
      • API
    • โ›ณrcore_minigolf
      • Builder
      • Company
      • Config
    • ๐Ÿš›rcore_missionpack_legal
      • Migrate from old version
    • ๐Ÿš—rcore_pdm
      • Missing images
      • Blips on minimap
      • Vehicles in stock
      • Missing vehicle names
      • Edit the speed of the vehicle in UI
      • Boss menu + locations
      • Displayed vehicle in the shop
      • How to add a vehicle with a new category
      • QBCore
        • Import missing vehicles from qbcore to rcore_pdm
        • Job data for QBCore framework
        • Import vehicles from database to qbcore
    • ๐Ÿ“rcore_pingpong
      • How To Play
      • Spawning a Pong Table
      • Match Settings
    • ๐Ÿคฝโ€โ™€๏ธrcore_pool
      • Anticheat
      • How to place pool table
    • ๐Ÿ‘ฎrcore_police
      • Installation
      • How to Update
      • Features
      • Inventory
      • Deployer
      • Configs
        • Main Config
      • API
        • Client
        • Server
    • โ›“๏ธrcore_prison
      • Migration from V1
      • How to Begin
      • How to Update
      • Installation
      • Inventory items
      • Configs
        • Main Config
      • Guides
        • Deployer
        • Changing minigame for Cigarette packaging
        • Changing Prison jobs reward
        • Configuring Permissions
        • How to translate in-game panel
        • How to define own stats for Prison GYM?
        • How to define/change default Prisoner outfits?
        • How to define own Prison map?
      • Features
        • Prison Break
        • Solitary
        • Cigar packaging
        • Canteen
        • Dealer
        • Dashboard
        • Chair system
        • Prison Prolog
      • Integrations
        • Inventory
        • Inventory items
      • API
        • Client
        • Server
      • โ›“๏ธV1 Docs
        • Config
        • Inventory
        • API
          • Client
          • Server
        • Locales system
        • Interiors presets
        • Camera prolog
        • Outfits
    • ๐Ÿ“ปrcore_radiocar
      • API
        • Radio item
        • Marker for buying radio
    • ๐Ÿ“‹rcore_report
      • Installation
      • API
      • Ace Permissions
      • Config
      • UI Config
      • Features
      • Console Logs
      • Custom Data
      • Responsivity
    • ๐Ÿชrcore_shops
      • Add new shop
      • How to add weapon
      • Hide blip on minimap / map
      • Restrict shop to certain job
    • ๐Ÿ” rcore_shortcuts
      • API
      • Commands and Hotkeys
      • Permissions
      • Notifications
      • Limits
      • Styles
    • โœจrcore_spray
      • ESX instalation
      • QBCore instalation
      • OX Inventory instalation
      • How to add a new image
      • How to add a new font
      • Gang integration
      • Anticheat
    • ๐Ÿ“ˆrcore_stats
      • Installation
      • Permissions
      • Configs
        • Main config
        • Performance
        • Units
        • Other
      • Translation
      • Changing Default Values
      • API
        • Integration
        • Delete
        • Other
    • ๐Ÿ‘นrcore_tattoos
      • Installation
      • Migrations
      • Add-on tattoos
      • Config
      • Custom Framework
      • Design
      • Tattoo config options
      • Tattoo permissions
      • Troubleshooting
      • API
      • Integrations
        • qb-gangs
      • Business update
        • Config
        • Simple Business
        • Business with jobs
        • Default settings
    • ๐Ÿ“บrcore_television
      • How to add a new television
    • ๐Ÿ”งrcore_tuning
      • Editing your config
      • Configuring your framework
      • Job integration
      • Item integration
      • Editing tuning prices
    • ๐Ÿ“‹rcore_whiteboard
      • Whiteboard type & data
      • Position editor
      • API
      • FAQ
    • ๐ŸŽrcore_xmas
      • Installation
      • Configuration
      • Inventory Items
      • Snowball Damage
      • API
    • ๐Ÿ“ปxradio
      • API
      • Custom menu
      • Ox inventory
  • free resources
    • rcore_arcade
      • How to add msdos games
Powered by GitBook
On this page
  • Debug
  • Framework
  • Language
  • Commands
  • Keys
  • DisablePageContentCopy
  • DisableDataPermissions
  • UseFrameworkNotify
  • Framework triggers
  • ๐Ÿงช Experimental
  • IFrameInsertIntoPage

Was this helpful?

  1. paid resources
  2. rcore_guidebook

Config

Here you can find description of all available settings in config.lua.

Debug

Config.Debug - Enable debug mode.

If you encounter anything weird happening in the script, please turn on debug mode and screenshot F8 and server console logs and send it to us on our Discord.

If you want to show only certain debug logs in your console, comment out the ones you don't want to see in DebugLevel like this:

    Debug = true,
    DebugLevel = {
        -- 'INFO',
        'CRITICAL',
        'SUCCESS',
        'ERROR',
        -- 'DEBUG',
    },

Framework

Framework = 0

  • you can leave this as 0 for automatic framework detection

  • if you want to force the framework, set it to

    • 1 = ESX

    • 2 = QBCore

    • 3 = Other

Language

Locale = 'en'

If you want to change a language:

  1. go to rcore_guidebook_v2\locales

  2. copy en.lua, paste it and rename it to your language code (example: de.lua)

  3. translate everything inside the file

  4. change Locale in config.lua to your language code (example: Locale = 'de')

Commands

Commands = {
    Help = 'help',
    SendHelp = 'sendhelp',
    Admin = 'helpadmin',
    Navigate = 'pointgps',
},

These are all the defauls commands you can use in the guidebook.

If you want to change them, just change the value to your desired command name like this: Help = 'serverguide',

Keys

Keys = {
    OpenGuidebook = 'F9',
    HelpPointOpen = Keys.E,
},

You can also open guidebook with a key, we are using RegisterCommand so every player can rebind the key in the GTA settings (key bindings > fivem)

If you leave Config.RegisterOpenKey = false script will not register any key command.

Here you can find all available key binds: https://docs.fivem.net/docs/game-references/controls/ ๐Ÿ‘‰ If you can't find your desired key at the link above, it is unfortunately not possible to use it.

Example:

Config.RegisterOpenKey = 'F9'

Turned off

Config.RegisterOpenKey = false

DisablePageContentCopy

DisablePageContentCopy = false

This value disables text highlight using players mouse and Ctrl+C of page content.

DisableDataPermissions

DisableDataPermissions = false

This value disables (job) restrictions for categories, pages and help points (if disabled, all previously restricted data will be visible to everyone)

UseFrameworkNotify

UseFrameworkNotify = false

If true, default framework notification system will be used instead of guidebook notifications.

Framework triggers

Do not change these unless you know what you are doing. These are only used if your framework/load event/notify event are renamed from the default ones.

If left blank, everything is automatically done for you.

FrameworkTriggers = {
    resourceName = '', -- [ ESX = 'es_extended' / QBCore = 'qb-core' ] Set the resource name, if left blank, automatic detection will be performed
    load = '',         --[ ESX = 'esx:getSharedObject' / QBCore = 'QBCore:GetObject' ] Set the shared object event, if left blank, default will be used (deprecated for QBCore)
    notify = '',       -- [ ESX = 'esx:showNotification' / QBCore = 'QBCore:Notify' ] Set the notification event, if left blank, default will be used
},

๐Ÿงช Experimental

โ—โ— NO SUPPORT WILL BE PROVIDED, USE AT YOUR OWN RISK - All experimental features may not work as expected

IFrameInsertIntoPage

IFrameInsertIntoPage = false

If true, you will be able to add iframe (embed website) to guidebook pages

PreviousInstallationNextData permissions

Last updated 1 year ago

Was this helpful?

๐Ÿ“™