Clamor

Clamor 1.0.0: the first release. The megaphone, with an interval, an optional price in an economy, crafted at the Workbench.

Works with Hytale 0.7.x (Update 7). Tested on 0.7.5, in game, on a local server: the recipe, the announcement screen, the banner and the chat, the interval, the queue, charging, the megaphone in the Z wheel and the admin menu.

The first version of Clamor brings the megaphone: an item crafted at the Workbench that opens the announcement screen with a right-click. The announcement goes to every online player, in a banner at the top of the screen and in the chat, one at a time, with a minimum interval between each player's announcements, set by the admin. It is free, or costs an amount in the server's economy, if the admin wants. Other mods can announce through the API.

The megaphone

Crafted at the Workbench, under Utility, with 2 Copper Ingots, 1 Light Leather and 2 Plant Fiber. Admins also get it in creative mode, among the tools, or with /give Clamor_Megaphone. With it in hand, right-click opens the announcement screen; the megaphone is never used up.

The megaphone 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. Right-click also opens it, but only when the item in hand doesn't use right-click, like the pickaxe; blocking with a sword and placing blocks keep working. While the megaphone is picked in the wheel, the middle button doesn't pick the targeted block.

The announcement

Up to 100 characters, with no line breaks. It shows to every online player in a blue banner at the top of the screen, below the compass, in full, in up to two lines, with the sender's name in gold, and in the chat as [Megaphone] Name: text, with a short sound. The banner fades at the edges over the map, carries the megaphone's wax seal and a gold line at the bottom that shrinks while the announcement is on the air. Each announcement stays 8 seconds on screen, and the others wait their turn: the screen says whether yours is already on the air or how many are ahead of it, and the banner shows "+N in queue". Someone who joins in the middle of an announcement sees the banner on the next one. The text goes as it was written: colors, commands and emoji don't pass.

The interval

Each player waits 5 minutes between announcements, by default. The screen shows the interval and a countdown of how long is left. The admin changes the time in the menu (/clamor admin) or in config.json (AnnouncementIntervalSeconds), and zero turns it off.

The queue has a limit

Up to 50 announcements wait their turn, by default. With the queue full, a new announcement is refused until it moves, and the player sees why. The admin changes the limit in the menu or in config.json (MaxWaitingAnnouncements).

Charging

The admin can charge for each announcement in the server's economy: through VaultUnlocked, in any economy registered in it and in the currency of your choice, or through the economy of another mod that registers itself in Clamor. The price and the provider are in the menu (/clamor admin) and in config.json (ChargeProvider, ChargeCurrency, AnnouncementPrice). The player sees the price and the balance on the screen, with numbers in their language's format; without enough money, nothing is charged or announced. If the server crashes in the middle of a charge, the next start resolves it without charging twice, or, with VaultUnlocked, leaves the announcement for the admin to check. Announcements from other mods are never charged.

The look

The megaphone screen and the admin menu use the common look of the author's mods: the game's blue background, gold details, the wax seal with the megaphone in the middle of the title bar and buttons with a subtle gradient. The admin opens a preview screen with every piece with /clamor kit.

The admin menu

/clamor admin opens the menu, in two sections, Announcements and Charge, with each option in a row: the name, a short description, what applies now, spelled out, and the field. The interval and the queue limit have arrows, and the price is an amount field with the currency next to it; at 0, the announcement is free. Save writes config.json and takes effect at once, for everyone; a wrong field refuses the Save, with the reason. /clamor reload reloads the file, and /clamor shows the loaded version.

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 mod authors

Another mod puts an announcement in the megaphone queue with its own name as the sender, without the interval, and an economy can charge players' announcements as a provider, writing the price in each player's language. The API contract is version 1.

Languages

English, Portuguese, German, Spanish, French, Russian and Chinese.