CodeCraze Notes

Thank you for choosing CodeCraze Notes! This document will guide you through the installation, configuration, and usage of our Post-it system.

## 1. Installation
1. Extract the `cz_note` folder into your server's `resources` directory.
2. Add `ensure cz_note` to your `server.cfg`.
3. (Optional) If you are using an item-based system, see the 'Item Setup' section below.

---

## 2. Configuration (`config.lua`)
Open `config.lua` to customize the script for your server:

- **Framework**: Set `Config.Framework` to `'qb'`, `'esx'`, or `'standalone'`.
- **Locale**: Choose between `'en'` or `'de'`.
- **UseItem**: Set to `true` if players must have an item to create a note.
- **Database**: This script uses a **JSON-based database** (`notes.json`). No SQL installation is required!

---

## 3. Item Setup (Optional)

### QBCore:
Add the following to your `shared/items.lua`:
```lua
['postit'] = {['name'] = 'postit', ['label'] = 'Post-it', ['weight'] = 100, ['type'] = 'item', ['image'] = 'postit.png', ['unique'] = false, ['useable'] = true, ['shouldClose'] = true, ['combinable'] = nil, ['description'] = 'A small yellow sticky note.'},

ESX:

Simply ensure the item postit exists in your items table. If you are using a modern ESX version, players can use it immediately once the item is added to their inventory.

---

4. How to Use

Creating a Note:

1. Type /post or use the Post-it item.

2. A UI will appear. Write your message and click Save.

3. You will enter Placement Mode.

   • WASD: Move the note around.

   • Arrow Keys: Fine-tune rotation.

   • Shift / Ctrl: Move the note up or down.

   • LMB (Left Click): Place the note in the world.

   • RMB (Right Click): Cancel placement.

Reading/Picking Up:

• Walk up to a placed note.

• Press [E] to read the full message in fullscreen.

• Press [F] to pick up the note and remove it from the world.

---

5. Support & Updates

If you encounter any issues or have feature requests, please contact us via:

• Tebex: Through your buyer dashboard.

• Discord: Join our official CodeCraze Development server. https://discord.gg/y5cjpM4KZB

Tip: Always keep the 'notes.json' file backed up if you want to preserve notes across server wipes/updates.