FReZ-Hytale-mod-HelloWorld

An example and base plugin for Hytale, demonstrating essential features such as announcement management, commands, and integration with the Hytale API.

Features

Automated Announcement System:

Broadcast periodic messages to players.
Support for global and world-specific (universe) announcements.
Dynamic placeholders: {online} (online players), {playersMax} (server capacity).

Announcement Management:

Full suite of commands to create, list, edit, and delete announcements in-game or via the console.
Graphical User Interface (GUI) for players, allowing visual management of announcements.

Administrative Commands:

Integrated permission system (helloworld.announce.admin, helloworld.announce.reload).
Hot-reload configuration support.

Installation

Download the plugin's .jar file from the Releases section.
Place the file into the mods folder of your Hytale server.
Start your server.

Configuration

The config.json configuration file is automatically generated upon the first launch.

{
  "announceInterval": 300,
  "globalAnnouncements": [
    "Welcome to our Hytale server!",
    "Don't forget to visit our website."
  ],
  "universeAnnouncements": {
    "lobby": [
      "Welcome to the lobby!"
    ],
    "minigame_world": [
      "May the best player win!"
    ]
  }
}

announceInterval: Time in seconds between each automated announcement.
globalAnnouncements: List of messages broadcasted server-wide.
universeAnnouncements: Dictionary of messages specific to each world.

Commands and Permissions

Command	Description	Required Permission
`/announce`	Opens the management panel (GUI) for players, or displays help for the console.	`helloworld.announce.admin`
`/announce list`	Lists all configured announcements with their IDs.	`helloworld.announce.admin`
`/announce create <message> [--world=<world>]`	Creates a new announcement. Optional: specify a target world.	`helloworld.announce.admin`
`/announce delete <index>`	Deletes an announcement by its ID (index).	`helloworld.announce.admin`
`/announce edit <index> <new_message>`	Edits the text of an existing announcement.	`helloworld.announce.admin`
`/announce reload`	Reloads the plugin configuration from the file.	`helloworld.announce.reload`

Author

Developed by jeanniardJ (JonasBadBoys).

Simple HelloWorld