Docs

kyoDeathPhrase

Configuration

Config.Framework = 'auto'        -- 'auto' | 'esx' | 'qbcore' | 'qbox' | 'standalone'
Config.Notification = 'auto'     -- 'auto' | 'kyoNotify' | 'vms_notifyV2' | 'origen_notify' | 'ox_lib' | 'esx' | 'qbcore' | 'qbox' | 'default'
Config.EnableScreenBlur = true   -- blur the game behind the interface
Config.Locale = 'en'             -- 'en' | 'es' | 'fr' | 'de' | 'pt'

With Config.Notification = 'auto', custom resources (kyoNotify, vms, origen) are used first, then the framework or ox_lib.

Admins

Config.AdminGroups = {
    ['superadmin'] = true,
    ['admin'] = true,
    ['mod'] = true,
    ['god'] = true,
}

Config.AdminAcePermission = 'command.adminphrase'

A player is an admin if their framework group is listed or they have the ACE permission.

Commands

Config.Commands = {
    Frase = 'phrase',          -- open the editor
    VerFrase = 'seephrase',    -- preview your banner
    AdminFrase = 'adminphrase' -- admin panel
}

Limits

Config.MaxPhraseLength = 60
Config.MinSoundDuration = 3      -- seconds
Config.MaxSoundDuration = 5      -- seconds
Config.DefaultSoundVolume = 0.05 -- 5 %

Forbidden words

Config.BlacklistWords = {
    -- "word",
}

Case-insensitive. A phrase containing any of these words cannot be saved.

Default phrase

Given to players when they receive access, and used when an admin resets a phrase.

Config.DefaultPhrase = {
    phrase = "YOU WERE KILLED BY {killer} 🤪",
    textColor = "rgba(255, 255, 255, 0.98)",
    bgColor = "rgba(18, 18, 24, 0.92)",
    imageUrl = "https://i.imgur.com/5V8bE1Y.png",
    soundUrl = "",
    showSongInfo = true,
    soundDuration = 4,
}

{killer} is replaced by the killer’s name.

Translations

Lua texts are in locales/*.lua; interface texts in html/js/locales.js.