VoxeLibre/mods/HUD/mcl_formspec/FORMSPEC_GUIDE.md

25 lines
981 B
Markdown
Raw Normal View History

2021-09-18 11:05:17 +02:00
# MineClone2 Formspec Guide
***This guide will learn you rules about creation of formspecs for the MineClone2 game.***
2021-09-17 23:58:58 +02:00
2021-09-18 11:05:17 +02:00
Formspecs are an important part of game and mod development.
2021-09-17 23:58:58 +02:00
First of all, MineClone2 aims to support ONLY last formspec version. Many utility functions will not work with formspec v1 or v2.
Label font size should be 25 to be minecraft like. We arent modifying formspec prepend in order to not break existing mods.
2021-09-18 11:05:17 +02:00
Just add this code to apply it to your formspec:
2021-09-17 23:58:58 +02:00
```lua
2021-09-18 11:05:17 +02:00
mcl_formspec.apply_label_size
2021-09-17 23:58:58 +02:00
```
2021-09-18 11:05:17 +02:00
The typical width of an 9 slots width inventory formspec is `0.375 + 9 + ((9-1) * 0.25) + 0.375 = 11.75`
2021-09-17 23:58:58 +02:00
Margins is 0.375
2021-09-18 11:05:17 +02:00
2021-09-18 09:53:45 +02:00
Space between 1st inventory line and the rest of inventory is 0.45
2021-09-17 23:58:58 +02:00
Labels should have 0.375 space above if there is no other stuff above and 0.45 between content
2021-09-18 00:36:33 +02:00
+ 0.375 under
According to minetest modding book, table.concat is faster than string concatenation, so this method should be prefered (the code is also more clear)