A Minetest mod which provides a simple API to display messages at the center of the screen.

Go to file

Wuzzy 2100a02fb8 Move to MIT License		2019-03-20 15:14:17 +01:00
depends.txt	Initial commit	2015-06-16 18:40:54 +02:00
description.txt	Initial commit	2015-06-16 18:40:54 +02:00
init.lua	Remove core.colorize	2017-02-09 12:52:58 +01:00
mod.conf	Add mod.conf	2016-11-04 02:08:57 +01:00
README.md	Move to MIT License	2019-03-20 15:14:17 +01:00
settingtypes.txt	Allow to config message duration	2016-11-04 04:06:22 +01:00

README.md

Central Message

Overview

Description: Simple API and server command to display short messages at the center of the screen
Author: Wuzzy
License of everything: MIT License
Shortname: central_message
Version: 0.3.0 (using Semantic Versioning 2.0.0, see SemVer)

Longer description

This Minetest mod allows other mods to display a short message at the center of the screen. Each message is displayed for a few seconds, then it is removed. When multiple messages are pushed quickly in succession, the messages will be “stacked” on the screen.

This mod adds the server command “cmsg” as well as an API for mods to display messages. The syntax is “/cmsg <player> <text>”. If <player> is “*”, the message is sent to all players.

This mod can be useful to inform about all sorts of events and is an alternative to use the chat log to display special events.

Some usage examples:

Messages about game events, like victory, defeat, next round starting, etc.
Error message directed to a single player
Informational messages
Administational messages to warn players about a coming server shutdown
Show messages by using a command block from Mesecons

Settings

This mod can be configured via minetest.conf.

Currently, these settings are recognized:

central_message_max: Limit the number of messages displayed at once, by providing a number. Use 0 for no limit. Default: 7
central_message_time: How long (in seconds) a message is shown. Default: 5
central_message_color: Set the message color of all messages. Value must be of format (R,G,B). Default: (255,255,255) (white).

API

`cmsg.push_message_player(player, message)`

Display a new message to one player only.

Parameters

player: An ObjectRef to the player to which to send the message
message: A string containing the message to be displayed to the player

Return value

Always nil.

`cmsg.push_message_all(message)`

Display a new message to all connected players.

Parameters

player: An ObjectRef to the player to which to send the message
message: A string containing the message to be displayed to all players

Return value

Always nil.