Add readme
authorh-v-smacker <hans-von-smacker+github@gmail.com>
Sat, 18 Nov 2017 21:32:47 +0000 (00:32 +0300)
committerh-v-smacker <hans-von-smacker+github@gmail.com>
Sat, 18 Nov 2017 21:32:47 +0000 (00:32 +0300)
README.md [new file with mode: 0644]

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..f4dc49f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+#Freezer mod for Minetest
+
+This mod introduces a common household item, a ~~plumbus~~ freezer. Aka fridge. Its purpose
+is to cool things down, chiefly turning water into ice. But it has been expanded to cover
+other liquids that can be seen in buckets (milk, cactus pulp), and later to cover juices 
+(also introduced in this mod) which can be frozen into popsicles.
+
+[ steel ingot, mese crystal, steel ingot ]
+[ steel ingot,             , steel ingot ]
+[ steel ingot, mese crystal, steel ingot ]
+
+##Ice
+
+1 bucket of water (regular or river) gets turned into 1 block of ice. This allows to craft
+smoothies after a chain of simple transformations.
+
+##Milk and cactus pulp
+
+Buckets of said liquids can be turned into eskimo icecream (an icecream on a wooden stick,
+a canonic kind of icecream in the USSR) and a cactus popsicle respectively. Since a whole 
+bucket is used, the yield is 3 items.
+
+The buckets are returned empty after use. The popsicles leave a fancy stick behind after being eaten.
+
+##Pipeworks
+
+The freezer is pipeworks compatible. All incoming items are places into the source 
+inventory, and attempts to take items return the contents of the destination inventory. 
+The direction of pipe connections is irrelevant.
+
+##The founder
+
+The mod was founded by gpcf, and can be seen at git://gpcf.eu/freezer.git. 
+This is a fork thereof.
\ No newline at end of file