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"
This commit is contained in:
John Steensen 2016-12-27 14:02:14 -07:00 committed by Griatch
parent a239ddcdeb
commit cc5e09a916

View file

@ -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