Mirrorlandia_minetest/mtimer
1
0
Fork 0
mirror of https://gitlab.com/4w/mtimer.git synced 2024-11-30 19:23:52 +01:00
Code Issues Projects Releases Wiki Activity

documentation update

Browse Source
This commit is contained in:
Dirk Sohler 2019-02-23 16:08:04 +01:00
parent 5875f97856
commit 3fd5d23181
No known key found for this signature in database
GPG Key ID: B9751241BD7D4E1A
2 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -1,3 +1,13 @@
**_mTimer_ is a mod for showing ingame and reallife times and periods**
## Description
*mTimer* is a mod that allows players to individually configure and show a timer as permanent HUD element that automatically updates every second. The timer can show the real-world time and the ingame time as well as the current play session starting time and duration in freely configurable formats.
![Main Menu](screenshots/hud_element.png)
Use it on your public servers to give your players additional value (players can individually hide the timer if they want) while being on your server or use it in your singleplayer world to stay informed or – when creating creative content for others to watch – give your viewers a hint on when the footage was recorded.
## Configuration ## Configuration
The timer display and settings are entirely configured on a per-player basis via configuration formspecs. Configurations are set when leaving the formspec via the buttons or when pressing enter or clicking the apply button (where available). Pressing the escape key cancels the changes. The timer display and settings are entirely configured on a per-player basis via configuration formspecs. Configurations are set when leaving the formspec via the buttons or when pressing enter or clicking the apply button (where available). Pressing the escape key cancels the changes.
@ -8,6 +18,8 @@ For opening the main menu simply enter the `/mtimer` chat command. From the main
Simply click the button of the option you want to configure. Simply click the button of the option you want to configure.
Configuration formspecs can be accessed directly by providing the respective parameter to the `/mtimer` chat command. Run `/mtimer help` to see a list of available parameters. You might need to bring up the console (F12 by defualt) to see all available parameters because the chat display might be too small.
### Variables ### Variables
Some formspecs allow you to use variables. The variables and their current (i.e. the moment when opening the formspec) values are shown below the input field. Some formspecs allow you to use variables. The variables and their current (i.e. the moment when opening the formspec) values are shown below the input field.

BIN
screenshots/hud_element.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 27 KiB