Server Announcements

Overview

The Server Announcements Mod provides a simple way for servers to show important notices to players. It focuses only on displaying server notices and does not affect gameplay.

Quick Start: Press F10 to open the mod window. The key can be reassigned in the settings.

---

Purpose

Helps ensure players see important information such as:

• Server rules
• Maintenance notices
• Event announcements
• Mod requirements or compatibility notes

---

Design Principles

Minimal Invasiveness

• Does not modify gameplay logic
• Does not alter save data
• Does not change networked game state
• Operates only at the UI/display layer

If the notice system fails, the game continues normally.

---

Architecture

Host + Client Model

• Host defines notice content and version
• Client displays notice UI
• If the client does not have the mod → no errors, no impact

---

Notice Types

Text Notices (Toast)

Used for short updates.

Examples

• "Server restarting in 10 minutes"
• "Event starting now"

Behavior

• Appears briefly
• Auto-fades
• Does not block gameplay

First-Join Notice (Banner)

Used for persistent information:

• Server rules
• Community guidelines
• Required mods

---

Content Delivery

All notices are text based and transmitted via game network messages.

Notes

• Supports rich text (bold, italic, color)
• Host can update content via the F10 settings window
• Requires CodeTalker for message delivery
• Clients without the mod receive announcements via chat in a simplified format

---

Banner Behavior

When Shown

• First time a player joins
• When notice version changes
• When host manually broadcasts
• Scheduled announcements (if enabled)

User Interaction

• OK: Dismisses banner (shown again next session)
• Don't show for a while: Hides for 24 hours (ignored if the banner content changes)
• X: Closes (shown again next session)

---

Safety

The mod uses defensive checks and error handling.
If the notice system fails, gameplay remains unaffected.