Instructions

Overview

This configuration allows the creation of various notepads with different themes and functionalities.

Configuration Details

Config Table

The Config table serves as the central component for the notepad system. It uses the following fields:

paper: Refers to the item players must add as paper to the notepad.

INFO

By default, it is set to 'papers,' the item i used in my server:

lua

Config.paper = 'papers'

However, you have the flexibility to change it to suit your preferences. For instance, if you have another item named 'wooden_paper' you can simply rename it:

lua

Config.paper = 'wooden_paper'

Now, players need to use the 'wooden_paper' item instead.

paperBox: A table defining a box, allowing players to obtain a specific amount of defined item in Config.paper by opening it.

INFO

In the last example, we renamed papers to wooden_paper. Now, if a player owns a paperbox and uses it, they will receive 50 wooden papers.

lua

Config.paperBox = {
    item_name = 'paperbox',
    amount = 50
}

items: A table containing various notepad types available for players.

The items field is a table housing different notepad types for players. Each notepad is defined by a sub-table with the following fields:

INFO

Fields:

notepad: A boolean value indicating if the item is a notepad (always set to true for notepads).
item_name: The item name representing the notepad.
maxPaper: The maximum number of papers the notepad can hold.
theme: The notepad's theme, set to note for a note.
wishlist: An optional field defining a list of items players can add to their notepad as a wishlist.

lua

Config.items = {
    -- this is the item where we save the note into its metadata.
    note = {
        item_name = 'note'
    },

    -- this is a notepad.
    notepad = {
        notepad = true,
        item_name = 'backpack1',
        maxPaper = 30,
        theme = 'note'
    }
}