From cc5e09a9160a4be33833b937ef878b3032b65d5f Mon Sep 17 00:00:00 2001
From: John Steensen <john.steensen@live.com>
Date: Tue, 27 Dec 2016 14:02:14 -0700
Subject: [PATCH] Updated rpsystem.py with install instructions.

Added the following to the docstring:

Verbose Installation Instructions:
    1. In typeclasses/character.py:
       Import the ContribRPCharacter class:
           "from evennia.contrib.rpsystem import ContribRPCharacter"
       Inherit ContribRPCharacter:
           Change "class Character(DefaultCharacter):" to
           "class Character(ContribRPCharacter):"
       If you have any overriden calls in at_object_creation(self):
           Add "super(Character,self).at_object_creation()" as the top line.
    2. In typeclasses/rooms.py:
           Import the ContribRPRoom class:
           "from evennia.contrib.rpsystem import ContribRPRoom"
       Inherit ContribRPRoom:
           Change "class Character(DefaultRoom):" to
           "class Character(ContribRPRoom):"
    3. In typeclasses/objects.py
           Import the ContribRPObject class:
           "from evennia.contrib.rpsystem import ContribRPObject"
       Inherit ContribRPObject:
           Change "class Character(DefaultObject):" to
           "class Character(ContribRPObject):"
    4. Reload the server (@reload or from console: "evennia reload")
    5. Force typeclass updates as required:
       Example for your character: "@type/reset/force me =
       typeclasses.characters.Character"
---
 evennia/contrib/rpsystem.py | 27 ++++++++++++++++++++++++++-
 1 file changed, 26 insertions(+), 1 deletion(-)

diff --git a/evennia/contrib/rpsystem.py b/evennia/contrib/rpsystem.py
index c4e1597e27..1b29cd5ab4 100644
--- a/evennia/contrib/rpsystem.py
+++ b/evennia/contrib/rpsystem.py
@@ -67,7 +67,32 @@ I see:
 Tall man (assuming his name is Tom) sees:
     The godlike figure looks at Tom and says "Hello".
 
-
+Verbose Installation Instructions:
+    1. In typeclasses/character.py:
+       Import the ContribRPCharacter class: 
+           "from evennia.contrib.rpsystem import ContribRPCharacter"
+       Inherit ContribRPCharacter:
+           Change "class Character(DefaultCharacter):" to 
+           "class Character(ContribRPCharacter):"
+       If you have any overriden calls in at_object_creation(self): 
+           Add "super(Character,self).at_object_creation()" as the top line.
+    2. In typeclasses/rooms.py:
+           Import the ContribRPRoom class: 
+           "from evennia.contrib.rpsystem import ContribRPRoom"
+       Inherit ContribRPRoom:
+           Change "class Character(DefaultRoom):" to 
+           "class Character(ContribRPRoom):"
+    3. In typeclasses/objects.py
+           Import the ContribRPObject class: 
+           "from evennia.contrib.rpsystem import ContribRPObject"
+       Inherit ContribRPObject:
+           Change "class Character(DefaultObject):" to 
+           "class Character(ContribRPObject):"
+    4. Reload the server (@reload or from console: "evennia reload") 
+    5. Force typeclass updates as required: 
+       Example for your character: "@type/reset/force me = 
+       typeclasses.characters.Character"
+          
 """
 from builtins import object