🔧Installation

Basic installation instructions for Cats Adovanced Name

---

QBCore or Qbox or ESX

1. Copy this resource to your server's resources directory

2. Add the following lines to your server.cfg

   ensure oxmysql
   ensure ox_lib
   ensure cats-advanced-name

3. Install the required database tables:

   • Use the install.sql file to create the necessary tables

//install.sql(since version 2.0.0)
-- Table to store player nicknames
CREATE TABLE IF NOT EXISTS player_nicknames (
    id INT AUTO_INCREMENT PRIMARY KEY,
    identifier VARCHAR(60) NOT NULL,
    nickname VARCHAR(50) NOT NULL,
    created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
    UNIQUE INDEX idx_identifier_nickname (identifier, nickname)
);

-- Table to store current nicknames
CREATE TABLE IF NOT EXISTS player_current_nickname (
    identifier VARCHAR(60) PRIMARY KEY,
    current_nickname VARCHAR(50) NOT NULL,
    updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP
);

-- Table to store player display settings
CREATE TABLE IF NOT EXISTS player_display_settings (
    identifier VARCHAR(60) PRIMARY KEY,
    is_visible BOOLEAN DEFAULT TRUE,
    name_label VARCHAR(50) DEFAULT NULL,
    active_marks JSON DEFAULT NULL,
    first_join BOOLEAN DEFAULT TRUE,
    pve_disabled_permanently BOOLEAN DEFAULT FALSE,
    updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP
);

If you were using a version prior to 2.0.0, you can migrate your database to the new table structure using the server administrator command /cats_advanced_name_db_convert