Notes Module

The Notes Module provides a comprehensive player notes system for staff to track player behavior and incidents.

🚀 Features

Core Functionality

Player Notes - Add notes to player profiles
Note History - Complete note tracking
Staff Tracking - Who added each note
Note Management - View, edit, and delete notes
Search Functionality - Find notes by content or staff

Advanced Features

Note Categories - Organize notes by type
Note Privacy - Control who can see notes
Note Templates - Predefined note formats
Bulk Operations - Manage multiple notes
Export Functionality - Export notes to files

📋 Commands

Notes Commands

`/notes <player>`

View all notes for a player.

Permission: zenith.notes

Parameters:

player - Player name to view notes for

Examples:

/notes Player123
/notes Player456

`/notes <player> add <note>`

Add a note to a player.

Permission: zenith.notes

Parameters:

player - Player name to add note to
note - Note content

Examples:

/notes Player123 add "Frequently asks for items"
/notes Player456 add "Helped new players, very friendly"

`/notes <player> clear`

Clear all notes for a player.

Permission: zenith.notes

Parameters:

player - Player name to clear notes for

Examples:

/notes Player123 clear
/notes Player456 clear

⚙️ Configuration

Module Settings

enabled: true

settings:
  max-notes: 100
  note-length-limit: 500
  auto-timestamp: true
  staff-tracking: true
  categories:
    - "General"
    - "Behavior"
    - "Incident"
    - "Positive"
    - "Warning"

Messages

messages:
  staff:
    note_added: "&#00FF00Note added to {player}!"
    note_cleared: "&#00FF00Notes cleared for {player}!"
    no_notes: "&#FF5555No notes found for {player}!"
    note_limit: "&#FF5555Note limit reached for {player}!"

  player:
    note_added: "&#00FF00A note has been added to your profile."
    note_cleared: "&#FF5555All notes have been cleared from your profile."

🔐 Permissions

Required Permissions

Permission	Description
`zenith.notes`	View and manage notes
`zenith.notes.add`	Add notes to players
`zenith.notes.clear`	Clear player notes
`zenith.notes.view`	View player notes

Permission Examples

permissions:
  - zenith.notes: true

What they can do:

✅ View all notes
✅ Add notes to any player
✅ Clear notes from any player
✅ Manage note categories

permissions:
  - zenith.notes.view: true
  - zenith.notes.add: true

What they can do:

✅ View player notes
✅ Add notes to players
❌ Clear notes from players

permissions:
  - zenith.notes.view: true

What they can do:

✅ View player notes
❌ Add or clear notes

📊 Database Schema

Notes Table Structure

CREATE TABLE zn_notes (
    id INT PRIMARY KEY AUTO_INCREMENT,
    player_uuid VARCHAR(36) NOT NULL,
    player_name VARCHAR(16) NOT NULL,
    staff_uuid VARCHAR(36) NOT NULL,
    staff_name VARCHAR(16) NOT NULL,
    note_content TEXT NOT NULL,
    category VARCHAR(50),
    created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
    updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP
);

🔧 API Integration

Add Note via API

POST /zenith/api/notes
Authorization: Bearer your-token-here

{
  "player": "Player123",
  "note": "Frequently asks for items",
  "category": "Behavior"
}

Get Notes via API

GET /zenith/api/notes?player=Player123
Authorization: Bearer your-token-here

Clear Notes via API

DELETE /zenith/api/notes?player=Player123
Authorization: Bearer your-token-here

📝 Note Categories

Available Categories

Category	Description	Use Case
General	General observations	Default category
Behavior	Behavioral issues	Problematic behavior
Incident	Specific incidents	Rule violations
Positive	Positive actions	Good behavior
Warning	Warning notes	Pre-punishment notes

Category Usage

# Example note categories
categories:
  - name: "General"
    color: "&#FFFFFF"
    description: "General observations"

  - name: "Behavior"
    color: "&#FFAA00"
    description: "Behavioral issues"

  - name: "Incident"
    color: "&#FF5555"
    description: "Specific incidents"

  - name: "Positive"
    color: "&#00FF00"
    description: "Positive actions"

  - name: "Warning"
    color: "&#FF0000"
    description: "Warning notes"

🛠️ Troubleshooting

Common Issues

Issue: Notes not saving

Check if module is enabled
Verify permissions
Check database connection
Ensure note length is within limits

Issue: Cannot view notes

Check view permissions
Verify player name
Check database connection
Ensure notes exist

Issue: Note limit reached

Check note limit configuration
Clear old notes if needed
Increase limit in configuration
Archive old notes

Debug Mode

Enable debug mode for detailed logging:

debug:
  enabled: true
  console: true
  file: true

📈 Performance

Optimization Tips

Use MySQL/MariaDB for large servers
Regular database maintenance
Monitor note table size
Implement note archiving

Monitoring

Track note frequency
Monitor note categories
Check staff activity
Review note content

Need help with the Notes Module? Join our Discord: https://discord.gg/2qCMn6KHj4