📓 FX-NOTEBOOK

Advanced notebook system for RedM with page system, shared job notebooks, item-based notebooks, and full framework compatibility.

---

📦 INSTALLATION

ensure fx-notebook

• Place the script inside resources/fx-notebook • Add ensure fx-notebook to your server.cfg • Restart your server • Make sure oxmysql is started before this script

---

⚙️ DEPENDENCIES

oxmysql

• Required for database system • Script will not work without it • You can manage database using HeidiSQL / phpMyAdmin

---

🗄️ SQL INSTALLATION

CREATE TABLE IF NOT EXISTS `fx_notebook` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `name` varchar(50) NOT NULL,
  `job` longtext DEFAULT NULL,
  `data` longtext DEFAULT NULL,
  PRIMARY KEY (`id`),
  UNIQUE KEY `ux_fx_notebook_name` (`name`)
);

• Stores all notebook data • name → unique notebook identifier • data → saved pages and content • Required for system to work

---

📦 VORP ITEM INSTALL

('notebook', 'Notebook', ...),
('paper', 'Paper', ...),
('notepaper', 'Note Paper', ...),
('quill', 'Quill', ...)

• Required items for VORP • notebook → main item • paper → adds pages • notepaper → extracted page item • quill → required for editing

---

📦 RSG ITEM INSTALL

notebook = { name = 'notebook', label = 'Notebook', unique = true, useable = true },
paper = { name = 'paper', label = 'Paper', useable = true },
notepaper = { name = 'notepaper', label = 'Note Paper', useable = true },
quill = { name = 'quill', label = 'Quill', useable = true },

• Required items for RSG • notebook should be unique • quill required for editing system

---

⚙️ BASIC SETTINGS

Config.Language = "en"
Config.DefaultPageCount = 10
Config.DefaultJobPageCount = 100

• Language → system language • DefaultPageCount → pages for normal notebook • DefaultJobPageCount → pages for shared notebook

---

✏️ EDIT SYSTEM

Config.NeedQuill = true
Config.QuillItem = "quill"
Config.UsageQuillLimit = "20"

• Requires item to edit notebook • Limits how many times quill can be used • Prevents unlimited editing

---

📄 PAGE SYSTEM

Config.PaperItem = "paper"
Config.AddPaperCount = 2

• Adds new pages to notebook • Each paper gives extra pages • Used for expanding notebook

---

Config.CutePaperItem = "notepaper"

• Extracts pages as item • Allows sharing notes

---

📘 NOTEBOOK ITEM

Config.NotebookItem = "notebook"

• Defines main notebook item • Required to open system

---

🧠 JOB NOTEBOOK SYSTEM

Config.Jobs = {
    {
        name = "BlackwaterSheriff",
        job = false,
        coords = vector3(...)
    }
}

• Shared notebooks in world • Can be restricted by job • Players interact at location

---

🎒 ITEM-BASED SHARED NOTEBOOK

Config.UsableJobNotebooks = {
    sheriff_notebook = {
        name = "RhodesSheriff",
        job = { sheriff = 0 }
    }
}

• Shared notebooks via item • Job restricted usage • Uses same database system

---

📍 INTERACTION DISTANCE

Config.OpenJoobBookDist = 1.1

• Distance to open shared notebook • Prevents long-distance access

---

🖼️ DEFAULT SETTINGS

Config.DefaultImage = "/ui/css/img/image.png"

• Default notebook image • Used if no custom image

---

🛡️ SECURITY SYSTEM

Config.AntiRat = function(src,message)

• Protects against malicious input • Kicks players if exploit detected • Prevents code injection

---

🔔 NOTIFY SYSTEM

Notify({
  text = "Page added",
  type = "success"
})

• Framework-based notification system • Supports VORP / RSG / REDEMRP

---

⚠️ IMPORTANT NOTES

• oxmysql must be running • Notebook names must be unique • Items must match config • Quill required if enabled • Paper required for adding pages

---

🚨 COMMON MISTAKES

• Notebook not saving → SQL not installed • Cannot edit → missing quill • Pages not added → wrong paper item • Job notebook not opening → wrong job config • Duplicate name → DB conflict

---

🏁 SUMMARY

FX-NOTEBOOK provides:

• Full notebook system • Page management system • Shared job notebooks • Item-based notebooks • Security protection system • Full framework compatibility

---

© Fixitfy Development