KRS Notepad

Overview

The script introduces a usable item that opens a notepad UI. Players can create, edit, and delete notes, then hand the notebook to other players so they can read the contents. Notes are typically stored in the database to survive server restarts.

Feature Highlights

• Inventory item (notepad or krs_notepad) that opens a custom NUI window
• Persistent storage using MySQL with configurable cleanup
• Page-based navigation with support for 50+ entries per notebook
• Server-side events to copy or transfer notes between players
• Optional printing or PDF export depending on configuration

Installation Steps

1. Download the latest release from the KRS developer (GitHub or Tebex, depending on the distribution).

2. Place the folder (usually krs-notepad) inside resources/[standalone]/.

3. Add ensure krs-notepad to server.cfg after qb-core but before scripts that rely on the notepad events.

4. Insert the SQL file included with the download to create the notes table:

   CREATE TABLE IF NOT EXISTS `krs_notepad` (
     `id` INT NOT NULL AUTO_INCREMENT,
     `owner` VARCHAR(50) NOT NULL,
     `title` VARCHAR(100) DEFAULT NULL,
     `pages` LONGTEXT NOT NULL,
     `created_at` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
     PRIMARY KEY (`id`)
   );

5. Register the item inside qb-core/shared/items.lua:

   ['krs_notepad'] = {
     ['name'] = 'krs_notepad',
     ['label'] = 'Notepad',
     ['weight'] = 200,
     ['type'] = 'item',
     ['image'] = 'notepad.png',
     ['unique'] = true,
     ['useable'] = true,
     ['shouldClose'] = true,
     ['combinable'] = nil,
     ['description'] = 'A lined notebook filled with scribbled notes.'
   },

6. Restart the server and spawn the item to confirm the UI loads correctly.

Configuration

Open config.lua to tailor the experience:

• Config.AllowedJobs: Restrict creation or editing to certain jobs (detective, police, etc.).
• Config.MaxPages: Limit the number of pages each notebook can hold.
• Config.AllowTransfer: Toggle whether players can hand the notepad to someone else while the UI is open.
• Config.AutoSave: Control how often notes are saved to the database while typing.
• Config.Locale: Adjust interface labels if translations are provided.

Usage Guide

1. Give players the krs_notepad item through shops, job lockers, or admin commands.
2. When used, the UI opens and allows players to type their notes.
3. Notes save when players exit the UI, drop the notepad, or transfer it to another character.
4. Officers or staff can review the notebook by using the item after it changes hands.

Best Practices

• Back up the krs_notepad database table regularly if you rely on notebooks for investigations.
• Pair the script with a printing resource or screenshot workflow for court cases.
• Adjust the maximum page count to balance performance and RP needs.
• Communicate retention policies so players know whether notes are purged automatically.

Support

• Consult the README packaged with the download for licensing and configuration notes.
• Join the author’s Discord (linked inside the README) for updates, bug fixes, or feature requests.
• Report issues with detailed reproduction steps, server console logs, and any client errors from the F8 console.