Skip to content

Usage ​

How it works ​

  1. Obtain a Notebook item and use it from your inventory.
  2. The notebook UI opens and a prop attaches to your character's hand with a reading animation.
  3. Write text, embed images or draw on pages using the toolbar.
  4. All changes are saved automatically to the database.
  5. Close the notebook to dismiss the UI and the prop.

Features ​

Pages ​

  • Use the Add Page button to insert a new blank page.
  • Use the Remove Page button to delete the current page.
  • Pages beyond the first 10 are loaded on demand as you navigate.

Text ​

Each page supports rich text content. Write freely on the page surface.

Images ​

Paste a direct image URL to embed it on the page. The URL must use HTTPS and point to an allowed domain (configured in config.lua).

Allowed domains

By default only i.ibb.co and r2.fivemanage.com are accepted. Set Config.AllowedImageDomains to an empty table {} to allow any HTTPS image URL.

Drawing ​

Switch to drawing mode to sketch freehand on the current page.

Title & cover color ​

Click the notebook title to rename it. Use the color picker to change the cover color. Both are saved instantly.

Duplicating ​

Use the Duplicate option (right-click the item in your inventory) to create an identical copy of the notebook. The copy becomes a separate item with its own database record. There is a 5-second cooldown between duplications.

Configuration ​

OptionDefaultDescription
Config.Item"notebook"Inventory item name
Config.AllowedImageDomains{ 'i.ibb.co', 'r2.fivemanage.com' }Allowed image URL hostnames; empty table allows any domain
Config.AttachProp(see config.lua)Prop model name, attachment offset, rotation, bone ID and collision settings
Config.DebugfalseEnable debug logging

Export ​

Other resources can duplicate a notebook programmatically:

lua
local id, error = exports['prp-notebook']:DuplicateNotebook(source, { itemId = notebookDbId })