summaryrefslogtreecommitdiff
path: root/castle_shields/README.md
diff options
context:
space:
mode:
authorVanessa Dannenberg <vanessa.e.dannenberg@gmail.com>2018-08-03 09:31:05 -0400
committerVanessa Dannenberg <vanessa.e.dannenberg@gmail.com>2018-08-03 09:31:05 -0400
commit2fa93b219eadfcdcf8f1d472aad046fc62d5b99d (patch)
treecff2e96e78cd89aa965976553d2ff8989b5a02b5 /castle_shields/README.md
parent76594f4bd5f825eaf1245965e2c0933bec47320d (diff)
downloaddreambuilder_modpack-2fa93b219eadfcdcf8f1d472aad046fc62d5b99d.tar
dreambuilder_modpack-2fa93b219eadfcdcf8f1d472aad046fc62d5b99d.tar.gz
dreambuilder_modpack-2fa93b219eadfcdcf8f1d472aad046fc62d5b99d.tar.bz2
dreambuilder_modpack-2fa93b219eadfcdcf8f1d472aad046fc62d5b99d.tar.xz
dreambuilder_modpack-2fa93b219eadfcdcf8f1d472aad046fc62d5b99d.zip
update castles, cottages, digistuff, gloopblocks, locks,
maptools, mesecons, pipeworks, technic, unified inventory, unified dyes, and xban2
Diffstat (limited to 'castle_shields/README.md')
-rw-r--r--castle_shields/README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/castle_shields/README.md b/castle_shields/README.md
new file mode 100644
index 0000000..51d7703
--- /dev/null
+++ b/castle_shields/README.md
@@ -0,0 +1,23 @@
+## Castle Shields
+
+by: Philipbenr, DanDuncombe and FaceDeer
+
+Licence: MIT
+
+=-=-=-=-=-=-=-=-=-=
+
+This mod adds decorative wall-mounted shields. It comes with three default shields, but it's very easy to mix and match the colours and patterns to generate additional shields for your server; see default_shields.lua for a good place to insert your own, or make use of the castle_shields.register_shield method in your own mods.
+
+The three default shields were defined thusly:
+
+* castle_shields.register_shield("shield_1", "Mounted Shield", "red", "blue", "slash")
+* castle_shields.register_shield("shield_2", "Mounted Shield", "cyan", "yellow", "chevron")
+* castle_shields.register_shield("shield_3", "Mounted Shield", "grey", "green", "cross")
+
+The following colors are permitted:
+
+"black", "blue", "brown", "cyan", "dark_green", "dark_grey", "green", "grey", "magenta", "orange", "pink", "red", "violet", "white", "yellow"
+
+The following patterns are permitted:
+
+"slash", "chevron", "cross" \ No newline at end of file