summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLNJ <git@lnj.li>2017-03-30 14:15:13 +0200
committerLNJ <git@lnj.li>2017-03-30 14:15:13 +0200
commitf912ba59e54a56186909580d7f950e7720b2e432 (patch)
tree2304ef92b674d2ccd24c0fef8174ba8f1849f076 /README.md
parent5f9a4f20aec82aca30720f72669079b760571d2d (diff)
README: Add mod description
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 11 insertions, 2 deletions
diff --git a/README.md b/README.md
index f375b18..62bd7d0 100644
--- a/README.md
+++ b/README.md
@@ -2,10 +2,19 @@
Version 0.1-dev, Status: alpha, License: MIT
## Description
-
+This mod adds simple item storages showing the item's inventory image in the
+front. By left- or right-clicking the image you can take or add stacks. If you
+also hold the shift-key only a single item will be removed/added.
## Notes
+This mod requires Minetest 0.4.14 or later. The `default` mod from MTG or the
+MineClone 2 mods are only optional dependencies for crafting recipes.
+## To-Do
+- [ ] Add a drawer controller for auto-sorting items into a drawer-network
+- [ ] Add half-sized drawers
+- [ ] Add 2x2 and 1x2 drawers
+- [ ] Add compacting drawers for auto-crafting blocks/ingots/fragments
## Bug reports and suggestions
You can report bugs and suggest ideas on [GitHub](http://github.com/lnj2/drawers/issues/new),
@@ -14,7 +23,7 @@ alternatively you can also [email](mailto:git@lnj.li) me.
## Credits
#### Thanks to:
* Justin Aquadro ([@jaquadro](http://github.com/jaquadro)), developer of the
- original Minecraft Mod (also licensed under MIT :smiley:) — Ideas / Inspiration
+ original Minecraft Mod (also licensed under MIT :smiley:) — Textures and Ideas
* Mango Tango <<mtango688@gmail.com>> ([@mtango688](http://github.com/mtango688)),
creator of the Minetest Mod ["Caches"](https://github.com/mtango688/caches/)
— I reused some code by you. :)