Check user documentation

See https://gitlab.com/4w/mtimer/issues/8
This commit is contained in:
Dirk Sohler 2019-03-16 23:26:16 +01:00
parent bfc2c5adc5
commit 85c109e23a
No known key found for this signature in database
GPG Key ID: B9751241BD7D4E1A
5 changed files with 5 additions and 5 deletions

@ -4,9 +4,9 @@
*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. *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) ![HUD element](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. Use it on your public server 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
@ -18,7 +18,7 @@ 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. 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 (F10 by default) to see all available parameters because the chat display might be too small.
### Variables ### Variables
@ -32,7 +32,7 @@ Using a string being a variable is not possible (`{foobar}` will always render t
### Confirmations ### Confirmations
While pressing enter in an input field applies the changes not all formspecs have input fields. Sometimes there only schemes or just buttons. Pressing enter in an input field applies the changes. Not all formspecs have input fields. Sometimes there only schemes or just buttons.
Using those formspecs is the same except setting things works instantly. So by clicking the bottom right on the scheme in the formspec below directly places the timer there. Using those formspecs is the same except setting things works instantly. So by clicking the bottom right on the scheme in the formspec below directly places the timer there.
@ -48,7 +48,7 @@ In the timer format configuration formspec shown above a text area is used where
### Formspecs Look Weird ### Formspecs Look Weird
On very small screens the configuration formspecs might look very crammed with text being cut off or overlaying other text. This is due to how formspecs work and is not fixable without massive engine changes. On very small screens the configuration formspecs might look very crammed with text being cut off or overlaying other text. This is due to how formspecs work and is not fixable without massive Minetest engine changes.
Same in the other direction: On very large screens the formspecs seem unnecessary huge with much empty space. Same here: This is not fixable without re-implementing formspec generation from scratch in Minetest. Same in the other direction: On very large screens the formspecs seem unnecessary huge with much empty space. Same here: This is not fixable without re-implementing formspec generation from scratch in Minetest.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 32 KiB

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 135 KiB

After

Width:  |  Height:  |  Size: 164 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 42 KiB

After

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 40 KiB

After

Width:  |  Height:  |  Size: 42 KiB