HyBroadcaster Wiki - Configuration

How to Configure

HyBroadcaster version 2.0.0-beta supports two ways to schedule messages. Choose the one that fits your needs.

1. Global Configuration

These settings affect the entire plugin behavior. You can find them at the root of config.json.

enableLagProtection TRUE

Prevents message storms after server lag.

showTimestamp FALSE

Adds [HH:mm] prefix to all messages.

useUtc FALSE

Use UTC time instead of local server time.

enableScheduledMessages TRUE

Turn the automatic announcer ON or OFF.

debugMode FALSE

Show detailed logs in console for troubleshooting.

toastPrefix [ANNOUNCEMENT]

Custom prefix for Toast/Emblem notifications.

{
  "simpleMode": true,
  "showTimestamp": true,
  "toastPrefix": "&b&l[ANNOUNCEMENT] ",
  "enableLagProtection": true,
  "scheduledMessages": [...]
}

2. Scheduling Methods

Option A

Simple Mode (Recommended)

Use simple durations like "10s", "5m", "1h". Enable this in your config first.

"simpleMode": true,
"scheduledMessages": [
  {
    "schedule": "10m", // Every 10 minutes
    "message": "Hello World!"
  }
]

Option B

Cron Mode (Advanced)

Use standard Cron expressions for precise scheduling (e.g., specific days or hours).

"simpleMode": false,
"scheduledMessages": [
  {
    "schedule": "0 18 * * 5", // Fridays at 18:00
    "message": "It's Friday!"
  }
]

3. Message Types

Toast (Emblem)

Appears as a notification at the top of the screen.

{
  "schedule": "5m",
  "isToast": true,
  "message": "This is a toast!"
}

Title (Center Screen)

Appears in the center of the screen with a big title.

{
  "schedule": "30m",
  "isToast": false,
  "title": "&bHello",
  "message": "&7Welcome!"
}

4. Sound System

Play an audible alert with your message. Use vanilla SFX or custom sounds.

Recommended Sounds

SFX_Avatar_Powers_Enable_Local - Celestial tone (Best)
SFX_Discovery_Z1_Medium - Soft discovery
SFX_Memories_Unlock_Local - Epic achievement
SFX_Discovery_Z1_Short - Village arrival tone

View all Hytale sounds →

{
  "schedule": "10m",
  "message": "Visit our store!",
  "sound": "SFX_Avatar_Powers_Enable_Local"
}

5. Default config.json

Below is the complete official configuration file for HyBroadcaster. Click to expand.

▼

{
  "pluginName": "HyBroadcaster",
  "version": "2.0.0",
  "debugMode": false,
  "simpleMode": false,
  "enableLagProtection": true,
  "enableScheduledMessages": true,
  "useUtc": false,
  "toastPrefix": "[ANNOUNCEMENT] ",
  "showTimestamp": false,
  "scheduledMessages": [
    {
      "schedule": "*/30 * * * *",
      "isToast": true,
      "title": "WELCOME",
      "message": "Welcome to the server! Visit our website for exclusive news.",
      "sound": "SFX_Avatar_Powers_Enable_Local"
    },
    {
      "schedule": "0 */2 * * *",
      "isToast": true,
      "title": "SERVER TIP",
      "message": "Did you know? You can use /help to see all available commands.",
      "sound": "SFX_Discovery_Z1_Short"
    },
    {
      "schedule": "0 12 * * *",
      "isToast": true,
      "title": "VOTE",
      "message": "Support the server by voting! You will get exclusive rewards."
    },
    {
      "schedule": "0 * * * *",
      "isToast": true,
      "title": "",
      "message": "Remember to follow the server rules: be respectful and have fun."
    },
    {
      "schedule": "0 18 * * 5",
      "isToast": false,
      "title": "DISCORD",
      "message": "Join our official Discord community for giveaways and events!"
    }
  ]
}

6. Manual Commands

Send manual announcements to all players using these administrative commands.

/announce <message> hybroadcaster.admin

Displays an announcement in the center of the screen for all players.

/announce Hello everyone!
/announce Attention! --sound SFX_Avatar_Powers_Enable_Local

Tip: For the sound to work correctly, place the flag --sound at the end of the message.

/announce toast <message> hybroadcaster.admin

Sends a "Toast" type notification (chat with prefix) to all players.

/announce toast Maintenance in 5 min
/announce toast Bonus active --sound SFX_Memories_Unlock_Local