Clamor

Clamor

A megaphone for Hytale servers: announcements to every online player, in a banner at the top of the screen and in the chat.

Clamor is a server plugin. Everything runs on the server, so players need nothing installed. Every announcement is saved in a daily history file and in the server log.

Clamor is in English, Portuguese, German, Spanish, French, Russian and Chinese. Each player sees it in their game language, with no setup.

Features

📣 The megaphone

• An item crafted at the Workbench, under Utility, with 2 Copper Ingots, 1 Light Leather and 2 Plant Fiber. Admins also get it in the creative inventory, among the tools, or with /give Clamor_Megaphone.
• With the megaphone in hand, right-click opens the announcement screen. The item is never used up.
• It is also a utility item, like the torch: in the utility slot and picked in the Z wheel, the middle mouse button opens the screen with any weapon or tool in hand.

📢 The announcement

• Up to 100 characters, to every online player, in a banner at the top of the screen, below the compass, with the sender's name in gold, and in the chat as [Megaphone] Name: text, with a short sound.
• Each announcement stays 8 seconds on screen, and the others wait in a queue: the screen says whether yours is on the air or how many are ahead of it, and the banner shows "+N in queue".
• The text goes as it was written: colors, commands and emoji don't pass.

⏱️ Free, with an interval

• Each player waits a minimum interval between announcements, 5 minutes by default. The screen shows a countdown. Zero turns it off.
• The queue holds up to 50 announcements by default. With the queue full, a new one is refused until it moves.

🪙 Charge for announcements (optional)

• The admin can make each announcement cost money in the server's economy: through VaultUnlocked, in any economy registered in it and in the currency you choose, or through an economy mod that registers itself in Clamor through its API.
• The player sees the price and their balance on the screen, in their language's number format. Without enough money, nothing is charged and nothing is announced.
• A charge is never made twice, even if the server crashes in the middle. Announcements from other mods are never charged.

📜 The history

• Each announcement is saved in one file per day in mods/Merlinz_Clamor/history/, with who sent it, the name, the text and the time, and in the server log.

🔌 For other mods

• A public API: another mod puts an announcement in the queue with its own name as the sender, without the interval.
• An economy mod can be the charge provider, writing the price in each player's language.

🛠️ Admin menu

• /clamor admin opens an in-game admin menu in two sections, Announcements and Charge, with each option in a row: its name, a short description, what applies now, and the field. Save writes config.json and takes effect at once, for everyone.
• The banner, the megaphone screen and the menu share the look of the author's other mods: the game's blue, gold details and a wax seal with a megaphone.

Requirements

Hytale server	0.7.x (Update 7). Tested on 0.7.5
VaultUnlocked	Optional: lets announcements cost money in any economy registered in it. Tested with 2.20.1
An economy mod with its own provider	Optional: the same, through the Clamor API

Each Clamor version supports one Hytale update. The Hytale API changes with each update, so don't update your server to a new Hytale update before a Clamor version for it is out.

Clamor	Hytale
1.0.0	0.7.x (Update 7), tested on 0.7.5

Installation

1. Stop the server.
2. Put Clamor-<version>.jar in the server's mods folder. Keep only one Clamor jar there.
3. Start the server. Clamor creates its files in mods/Merlinz_Clamor/, and the console shows Clamor loaded.
4. Make yourself OP (/op add <name> in the console) and type /clamor in the game to check the loaded version.
5. To charge for announcements, pick a provider in config.json (ChargeProvider) or in the admin menu.

Back up the whole mods/Merlinz_Clamor/ folder: config.json, pending.json and history/. The queue and each player's interval live in memory and need no backup.

Commands

Players need no command: the megaphone is an item. The admin commands are below. A subcommand also needs the permission of /clamor. OPs have all of them.

Command	What it does	Permission
/clamor	Shows the loaded version	merlinz.clamor.command.clamor
/clamor admin	Opens the admin menu	merlinz.clamor.command.clamor.admin
/clamor reload	Reloads config.json with no restart	merlinz.clamor.command.clamor.reload
/clamor kit	Opens a preview screen with every piece of the window look. Changes nothing	merlinz.clamor.command.clamor.kit

Configuration

mods/Merlinz_Clamor/config.json, applied with /clamor reload or from the admin menu:

Key	Default	What it does
AnnouncementIntervalSeconds	300	Seconds each player waits between announcements, from 0 (off) to 86400 (one day)
MaxWaitingAnnouncements	50	How many announcements can wait in the queue, not counting the one on screen, from 1 to 1000
ChargeProvider	None	Who charges for the announcement: None (free), VaultUnlocked, or the id of a provider registered by another mod
ChargeCurrency	empty	The currency, only with VaultUnlocked. Empty uses the economy's default
AnnouncementPrice	10	The price of each announcement, in the currency's unit, from 0 (free) to 1,000,000,000,000

A file with an error is refused, with the reason in the console, and the settings from before stay. On startup, a file with an error keeps Clamor from loading: the reason is in the console.

Known limits

• The translations of German, Spanish, French, Russian and Chinese have not been reviewed by native speakers yet. Server logs and config file errors are always in English.
• The queue and the intervals live in memory: a restart empties the queue, and no one has to wait.
• VaultUnlocked has no operation id, so a charge that was interrupted by a crash can't be safely repeated: the announcement waits for the admin to check in pending.json, and the admin menu shows how many there are.
• A mod that binds the middle mouse button on the player takes it over: the megaphone still opens with right-click.

License

Free to use on any number of servers, including monetized servers. You may not republish, redistribute, sell or distribute modified versions of Clamor. See the license on this page for the full text.

Clamor is an unofficial mod. It is not made, endorsed or supported by Hypixel.

---

Support

Clamor is free. If it helps your server, you can support its development on Ko-fi. Thank you!