Add README.md

master
Pedro Gimeno 2017-12-21 14:21:23 +01:00
parent c5cd0d603b
commit 7cbfb185d9
1 changed files with 22 additions and 0 deletions

22
README.md Normal file
View File

@ -0,0 +1,22 @@
# Digiplay
This adds some interesting items to the Digilines mod.
## Multicolour Light block
This block can be controlled and read via a digiline. The channel can only be configured once; to change it, the node must be dug and placed again. Anyone can set it, not just the placer. The channel will be a string, even when digits are entered. An empty channel name is not allowed.
The digiline signal must be a string with one of these formats:
- "on" - light on
- "off" - light off
- "#rgb" - change colour (3 hex digits)
- "#rrggbb" - colour (6 hex digits)
- "on#rgb"
- "off#rgb"
- "on#rrggbb"
- "off#rrggbb" - change both light on/off status and colour
Despite accepting any hex colours, due to Minetest limitations only 125 are possible, which are all possible combinations of values 00, 40, 80, C0 and FF in each of R, G and B (values 00-33 count as 00, values 34-66 count as 40, values 67-99 count as 80, values 9A-CC count as C0, and values CD-FF count as FF)
After being configured, it will send on the selected channel the string "l <playername>" when the node is punched (l for left-clicked) and the string "r <playername>" when the node is right-clicked (with the actual player's name, of course).