summaryrefslogtreecommitdiff
path: root/castle_shields
diff options
context:
space:
mode:
Diffstat (limited to 'castle_shields')
-rw-r--r--castle_shields/README.md23
-rw-r--r--castle_shields/README.txt25
2 files changed, 23 insertions, 25 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
diff --git a/castle_shields/README.txt b/castle_shields/README.txt
deleted file mode 100644
index e2b85ce..0000000
--- a/castle_shields/README.txt
+++ /dev/null
@@ -1,25 +0,0 @@
-=-=-=-=-=-=-=-=-=-=
-
-Castles Mod
-by: Philipbenr And DanDuncombe
-
-=-=-=-=-=-=-=-=-=-=
-
-Licence: MIT
-
-see: LICENSE
-
-=-=-=-=-=-=-=-=-=-=
-
-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