added README.md

README.md

@@ -0,0 +1,47 @@
+
+This mod allows to set RPG-like texts for NPC where the NPC "says" something
+to the player and the player can reply with a selection of given replies -
+which most of the time lead to the next dialog.
+
+Terminology
+===========
+dialog           A text said by the NPC, with diffrent replys the player can
+                 select from.
+
+option           A reply/answer to the text the NPC said.
+
+precondition     All listed preconditions have to be true in order for the NPC
+                 to offer this option.
+
+effect           Further effects (like setting variables, handing out items)
+                 selecting a particular option has.
+
+
+How to configure NPC and add dialogs
+====================================
+There are two ways:
+1. Just talk to them and click on the "I am your owner"-Dialog. This opens up
+   a menu where you can edit most things.
+2. Use /giveme to get the staff you want, wield the staff and point it at the
+   NPC you want to change. This is much more powerful. Lua code can be
+   entered and later executed by the NPC.
+
+
+The privs
+=========
+npc_talk_owner   will allow players to edit their *own* NPC by talking to them.
+                 Does *not* include usage of the staffs!
+                 Ought to be given to all players.
+         
+npc_talk_master  allows players to edit *any* NPC supported by this mod.
+                 Does *not* include usage of the staffs!
+                 Ought to be given to selected trusted players who want to
+                 help others with their NPC configuration and/or support
+                 NPCs owned by the server.
+
+npc_master       allows players to edit *any* NPC supported by this mod.
+                 *Does* include usage of the staffs.
+                 This is very powerful and allows to enter and execute lua
+                 code without restrictions.
+                 Only grant this to staff members you really trust.
+