annotate orpg/dieroller/HOWTO.txt @ 39:ed322725b928 ornery-orc tip

Traipse 'OpenRPG' {110114-00} Traipse is a distribution of OpenRPG that is designed to be easy to setup and go. Traipse also makes it easy for developers to work on code without fear of sacrifice. 'Ornery-Orc' continues the trend of 'Grumpy' and adds fixes to the code. 'Ornery-Orc's main goal is to offer more advanced features and enhance the productivity of the user. Update Summary (Closed) New Features: New to Map, can re-order Grid, Miniatures, and Whiteboard layer draw order New to Server GUI, can now clear log New Earthdawn Dieroller New IronClaw roller, sheet, and image New ShapeShifter PC Sheet Updates: Update to Warhammer PC Sheet. Rollers set as macros. Should work with little maintanence. Update to Browser Server window. Display rooms with ' " & cleaner Update to Server. Handles ' " & cleaner Update to Dieroller. Cleaner, more effecient expression system Update to Hidden Die plugin, allows for non standard dice rolls Update to location.py, allows for more portable references when starting Traipse Update to the Features node Fixes: Fix to InterParse that was causing an Infernal Loop with Namespace Internal Fix to XML data, removed old Minidom and switched to Element Tree Fix to Server that was causing eternal attempt to find a Server ID, in Register Rooms thread Fix to Server, removing wxPython dependencies where not needed Fix to metaservers.xml file not being created Fix to Single and Double quotes in Whiteboard text Fix to Background images not showing when using the Image Server Fix to Duplicate chat names appearing Fix to Server GUI's logging output Fix to FNB.COLORFUL_TABS bug Fix to Gametree for XSLT Sheets Fix to Gametree for locating gametree files Fix to Send to Chat from Gametree Fix to Gametree, renaming and remapping operates correctly Fix to aliaslib, prevents error caused when SafeHTML is sent None
author sirebral
date Fri, 14 Jan 2011 05:24:52 -0600
parents ff154cf3350c
children
rev   line source
28
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
1 HOW TO CREATE A NEW DIE ROLLER
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
2
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
3 So you want a make a new roller or add a new option? here's a short guide.
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
4
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
5
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
6 Step 1: Create a new die roller sub class.
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
7
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
8 You need to derive a new die roller class from an existing die roller class.
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
9 Most likely, this will be the std die roller class.
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
10
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
11 The basics would look like this:
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
12
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
13 class new_roller(std):
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
14 def __init__(self,source=[]):
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
15 std.__init__(self,source)
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
16 .....
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
17
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
18 ....
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
19
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
20 Step 2: Implement new methods and/or override existing ones.
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
21
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
22 Now, you just need to implement any new die options and override any
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
23 existing ones that you want to act differently. The most common options
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
24 to override are the sum and __str__ functions. Sum is used to determine
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
25 the result of the rolls and __str__ is used to display the results in
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
26 a user friendly string.
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
27
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
28 For example:
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
29
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
30 class new_roller(std):
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
31 def __init__(self,source=[]):
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
32 std.__init__(self,source)
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
33 .....
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
34
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
35 def myoption(self,param):
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
36 ....
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
37
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
38 def sum(self):
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
39 ....
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
40
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
41 def __str__(self):
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
42 ....
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
43
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
44 REMEMBER!
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
45 Always return an instance of your die roller for each option expect str and sum.
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
46
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
47
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
48 Step 3:
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
49
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
50 Modify Utils.py
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
51
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
52 You need to make some minor modifications to utils.py to facilitate
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
53 your new roller. You need to a) add an import call for your roller,
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
54 and b) add your roller to the list of available rollers.
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
55
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
56 For example:
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
57
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
58 from die import *
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
59 # add addtional rollers here
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
60 from myroller import *
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
61 ....
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
62
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
63 rollers = ['std','wod','d20','myroller']
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
64
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
65 Step 4: You're done!
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
66
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
67 Test it and make sure it works. When you think its done, send it to
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
68 the openrpg developers and they might include it in future releases.
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
69
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
70 -Chris Davis
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
71
ff154cf3350c Traipse 'OpenRPG' {100203-00}
sirebral
parents: 0
diff changeset
72