annotate orpg/dieroller/HOWTO.txt @ 31:fc48380f0c9f ornery-orc

Traipse Beta 'OpenRPG' {100503-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 (Patch-2) New Features: New Namespace method with two new syntaxes New Namespace Internal is context sensitive, always! New Namespace External is 'as narrow as you make it' New Namespace FutureCheck helps ensure you don't receive an incorrect node New Namespace 2.0 documentation in the User Manual New Namespace plugin, Allows Traipse users to use the Standard syntax !@ :: @! New Mini Library with minis from Devin Knight New PluginDB access for URL2Link plugin New to Forms, they now show their content in Design Mode New to Update Manager, checks Repo for updates on software start New to Mini Lib node, change title in design mode New to Game Tree, never lose a node, appends a number to the end of corrupted trees New to Server GUI, Traipse Suite's Debug Console New Warhammer PC Sheet Updates: Update to White Board layer, uses a pencil image for color button Update to Grid Layer, uses a grid image for color button Update to Chat Window, size of drop down menus Update to default lobby message Update to template Text node Update to 4e PC Sheet node Update to how display names are acquired Update to Server, added some 'Pious' technology Update to features node Fixes: Fix to Server GUI startup errors Fix to Server GUI Rooms tab updating Fix to Chat and Settings if non existant die roller is picked Fix to Dieroller and .open() used with .vs(). Successes are correctly calculated Fix to Alias Lib's Export to Tree, Open, Save features Fix to alias node, now works properly Fix to Splitter node, minor GUI cleanup Fix to Backgrounds not loading through remote loader Fix to Node name errors Fix to rolling dice in chat Whispers Fix to Splitters Sizing issues Fix to URL2Link plugin, modified regex compilation should remove memory leak Fix to mapy.py, a roll back due to zoomed grid issues Fix to whiteboard_handler, Circles work by you clicking the center of the circle Fix to Servers parse_incoming_dom which was outdated and did not respect XML Fix to a broken link in the server welcome message Fix to InterParse and logger requiring traceback Fix to Update Manager Status Bar Fix to failed image and erroneous pop up Fix to Mini Lib node that was preventing use Fix to plugins that parce dice but did not call InterParse Fix to nodes for name changing by double click Fix to Game Tree, node ordering on drag and drop corrected Fix to Game Tree, corrupted error message was not showing Fix to Update Manager, checks for internet connection Fix to Update Manager, Auto Update corrections Fix to Server GUI's broadcast, room, player messaging
author sirebral
date Mon, 03 May 2010 03:30:11 -0500
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