central_message/README.md

60 lines
2.2 KiB
Markdown
Raw Normal View History

2015-06-16 18:40:54 +02:00
# Central Message
## Overview
2017-02-09 12:43:57 +01:00
* Description: Simple API and server command to display short messages at the center of the screen
2015-06-16 18:40:54 +02:00
* Author: Wuzzy
* License of everything: WTFPL
* Shortname: `central_message`
2016-11-12 19:18:58 +01:00
* Version: 0.3.0 (using Semantic Versioning 2.0.0, see [SemVer](http://semver.org/))
2015-06-16 18:40:54 +02:00
## Longer description
This Minetest mod allows other mods to display a short message at the center of the screen.
2016-11-04 04:09:40 +01:00
Each message is displayed for a few seconds, then it is removed.
2015-06-16 18:40:54 +02:00
When multiple messages are pushed quickly in succession, the messages will be “stacked”
on the screen.
2017-02-09 12:43:57 +01:00
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.
2015-06-16 18:40:54 +02:00
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:
2016-11-09 04:49:00 +01:00
2015-06-16 18:40:54 +02:00
* 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
2017-02-09 12:43:57 +01:00
* Show messages by using a command block from Mesecons
2015-06-16 18:40:54 +02:00
## Settings
This mod can be configured via `minetest.conf`.
Currently, these settings are recognized:
2016-11-04 03:55:09 +01:00
* `central_message_max`: Limit the number of messages displayed at once, by providing a number. Use `0` for no limit. Default: `7`
2016-11-12 19:17:12 +01:00
* `central_message_time`: How long (in seconds) a message is shown. Default: `5`
2016-11-04 02:08:30 +01:00
* `central_message_color`: Set the message color of all messages. Value must be of format `(R,G,B)`. Default: `(255,255,255)` (white).
2015-06-16 18:40:54 +02:00
## API
### `cmsg.push_message_player(player, message)`
2015-06-16 18:40:54 +02:00
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)`
2015-06-16 18:40:54 +02:00
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`.