Chat Freeze Module

The Chat Freeze Module allows staff to temporarily freeze all chat on the server for announcements or emergencies.

🚀 Features

Core Functionality

Freeze Chat - Temporarily disable all chat messages
Broadcast Notifications - Announce chat freeze to all players
Bypass Protection - Staff can still chat when frozen
Status Check - Check current chat freeze status

Advanced Features

Custom Messages - Configurable freeze/unfreeze messages
Staff Notifications - Real-time alerts to staff
Short Message Mode - Display concise messages to players
Auto-Unfreeze - Optional automatic unfreeze (time-based)

📋 Commands

`/chatfreeze freeze`

Freeze all chat on the server.

Permission: zenith.chatfreeze

Usage:

/chatfreeze freeze

`/chatfreeze unfreeze`

Unfreeze all chat on the server.

Permission: zenith.chatfreeze

Usage:

/chatfreeze unfreeze

`/chatfreeze status`

Check current chat freeze status.

Permission: zenith.chatfreeze

Usage:

/chatfreeze status

💬 Messages

Staff Messages

messages:
  staff:
    chat_frozen: "{prefix}&#55FF55Chat has been %smcaps%FROZEN%smreset%!"
    chat_unfrozen: "{prefix}&#55FF55Chat has been %smcaps%UNFROZEN%smreset%!"
    chat_already_frozen: "{prefix}&#FF5555Chat is already %smcaps%FROZEN%smreset%!"
    chat_already_unfrozen: "{prefix}&#FF5555Chat is already %smcaps%UNFROZEN%smreset%!"
    chat_status_frozen: "{prefix}&#FF5555Chat is currently %smcaps%FROZEN%smreset%!"
    chat_status_unfrozen: "{prefix}&#55FF55Chat is currently %smcaps%UNFROZEN%smreset%!"

messages:
  player:
    chat_frozen_message: "{prefix}&#FF5555Chat is currently %smcaps%FROZEN%smreset%! Please wait for staff to unfreeze it."

Shown when: use_short_message: false

messages:
  player:
    chat_frozen_short: "{prefix}&#FF5555Chat is %smcaps%FROZEN%smreset%!"

Shown when: use_short_message: true

Notification Messages

messages:
  notifications:
    chat_frozen_notification: "{prefix}&#FFFF55Chat has been %smcaps%FROZEN%smreset% by {staff}!"
    chat_unfrozen_notification: "{prefix}&#55FF55Chat has been %smcaps%UNFROZEN%smreset% by {staff}!"

⚙️ Configuration

Module Settings

enabled: true

settings:
  # Short or long message to players
  use_short_message: false  # true = short message, false = long message

  # Notify all players when frozen/unfrozen
  notify_players: true  # true = notify all players, false = only notify staff

Configuration Examples

settings:
  use_short_message: true
  notify_players: true

Best for:

Quick announcements
Minimal disruption
Time-sensitive messages

settings:
  use_short_message: false
  notify_players: true

Best for:

Longer maintenance
Detailed explanations
Clear communication

settings:
  use_short_message: true
  notify_players: false

Best for:

Quiet freeze
No player notifications
Staff investigations

🔐 Permissions

Required Permissions

Permission	Description
`zenith.chatfreeze`	Use chat freeze commands
`zenith.chatfreeze.bypass`	Bypass chat freeze (can still chat)
`zenith.chatfreeze.notifications`	Receive chat freeze notifications

Permission Examples

Full Access
Limited Access

permissions:
  - zenith.chatfreeze: true
  - zenith.chatfreeze.bypass: true
  - zenith.chatfreeze.notifications: true

What they can do:

✅ Freeze/unfreeze chat
✅ Still chat when frozen
✅ Receive notifications

permissions:
  - zenith.chatfreeze: true

What they can do:

✅ Freeze/unfreeze chat
❌ Chat when frozen
❌ Receive notifications

🎯 Use Cases

Server Announcements

# Freeze chat
/chatfreeze freeze

# Server announcement
# (announcement here)

# Unfreeze chat
/chatfreeze unfreeze

Result:

All chat frozen
Clear announcement visible
Players wait for unfreeze

Scenario: Toxic chat needs immediate freeze

/chatfreeze freeze
# Investigate situation
# Take appropriate action
/chatfreeze unfreeze

Scenario: Announcing a new event

/chatfreeze freeze
# Announce event details
/chatfreeze unfreeze

🔔 Staff Notifications

Broadcast Notifications

When chat is frozen or unfrozen, staff receive notifications:

Configuration:

messages:
  notifications:
    chat_frozen_notification: "{prefix}&#FFFF55Chat has been %smcaps%FROZEN%smreset% by {staff}!"
    chat_unfrozen_notification: "{prefix}&#55FF55Chat has been %smcaps%UNFROZEN%smreset% by {staff}!"

To notify only staff:

settings:
  notify_players: false

To notify all players:

settings:
  notify_players: true

🛠️ Troubleshooting

Common Issues

Issue: Chat not freezing

Check if module is enabled
Verify permissions
Check command syntax

Issue: Players can still chat

Verify they don’t have bypass permission
Check if chat freeze is actually active
Check for conflicting plugins

Issue: No notifications received

Check zenith.chatfreeze.notifications permission
Verify notification message is not empty
Check staff notification settings

Debug Mode

Enable debug mode for detailed logging:

debug:
  enabled: true
  console: true
  file: true

📈 Performance

Optimization Tips

Lightweight - Minimal performance impact
No Database - No queries required
Simple State - Boolean state management
Efficient Checks - Minimal overhead on chat events

Monitoring

Track freeze frequency
Monitor freeze duration
Review staff activity
Analyze use cases

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