aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorh-v-smacker <hans-von-smacker+github@gmail.com>2018-11-12 02:33:22 +0300
committerh-v-smacker <hans-von-smacker+github@gmail.com>2018-11-12 02:33:22 +0300
commit719fac36eb95efa604d31ecc87ea37b8a7b3b039 (patch)
treef4c0d9311b63c38dc963998f1af0325bd2bb3863
parent516164976d6aaa54ba669c0e1dd9c1ecce5416c0 (diff)
downloadglass_stained-719fac36eb95efa604d31ecc87ea37b8a7b3b039.zip
glass_stained-719fac36eb95efa604d31ecc87ea37b8a7b3b039.tar.gz
glass_stained-719fac36eb95efa604d31ecc87ea37b8a7b3b039.tar.bz2
readme
-rw-r--r--README.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2279eb2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,42 @@
+# STAINED GLASS
+
+This mod adds stained glass varieties for aesthetic purposes.
+
+Also it introduces several pane varieties (glass, obsidian, iron bars)
+for completeness' sake.
+
+The stained glass types are made by arranging various dyes around a
+glass block in a pattern. In total, there are 12 color schemes.
+
+Furthermore, combining several of individual
+stained glass panes produces shaped pieces (double, triple/L-shaped,
+quadruple/2x2, noncuple/3x3), where all but one of the nodes can noclip
+through solid objects. This is meant to be used with non-rectangular
+window frames, allowing to fill them in without gaps.
+
+The recipes literally follow the shapes they create:
+
+```
+double:
+X
+X
+
+triple:
+X
+XX
+
+quadruple:
+XX
+XX
+
+noncuple:
+XXX
+XXX
+XXX
+
+where X is the given pane type
+
+```
+
+The combined pieces can always be broken down into the constituent
+individual panes.