diff --git a/README.txt b/README.txt index d058b7a..e2b85ce 100644 --- a/README.txt +++ b/README.txt @@ -11,5 +11,15 @@ see: LICENSE =-=-=-=-=-=-=-=-=-= -This mod adds decorative wall-mounted shields +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/screenshot.png b/screenshot.png new file mode 100644 index 0000000..b2cfd5f Binary files /dev/null and b/screenshot.png differ