diff options
Diffstat (limited to 'display_api/README.md')
-rw-r--r-- | display_api/README.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/display_api/README.md b/display_api/README.md new file mode 100644 index 0000000..f51996d --- /dev/null +++ b/display_api/README.md @@ -0,0 +1,14 @@ +# Display Lib + +This library's purpose is to ease creation of nodes with one or more displays on sides. For example, signs and clocks. Display can be dynamic and/or different for each node instance. + +**Limitations**: This lib uses entities to draw display. This means display has to be vertical. So display nodes rotation are limitated to "upside up" positions. + +**Dependancies**:default + +**License**: LPGL + +**API**: See [API.md](https://github.com/pyrollo/display_modpack/blob/master/display_api/API.md) document please. + +For more information, see the [forum topic](https://forum.minetest.net/viewtopic.php?t=19365) at the Minetest forums. + |