annotate orpg/dieroller/HOWTO.txt @ 210:5b1550e604d8 alpha

Traipse Alpha 'OpenRPG' {100428-03} 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) Getting Ready for Beta! 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 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 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
author sirebral
date Wed, 28 Apr 2010 07:27:15 -0500
parents 7f6e8f94394e
children
rev   line source
168
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
1 HOW TO CREATE A NEW DIE ROLLER
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
2
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
3 So you want a make a new roller or add a new option? here's a short guide.
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
4
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
5
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
6 Step 1: Create a new die roller sub class.
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
7
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
8 You need to derive a new die roller class from an existing die roller class.
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
9 Most likely, this will be the std die roller class.
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
10
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
11 The basics would look like this:
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
12
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
13 class new_roller(std):
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
14 def __init__(self,source=[]):
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
15 std.__init__(self,source)
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
16 .....
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
17
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
18 ....
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
19
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
20 Step 2: Implement new methods and/or override existing ones.
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
21
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
22 Now, you just need to implement any new die options and override any
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
23 existing ones that you want to act differently. The most common options
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
24 to override are the sum and __str__ functions. Sum is used to determine
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
25 the result of the rolls and __str__ is used to display the results in
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
26 a user friendly string.
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
27
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
28 For example:
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
29
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
30 class new_roller(std):
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
31 def __init__(self,source=[]):
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
32 std.__init__(self,source)
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
33 .....
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
34
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
35 def myoption(self,param):
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
36 ....
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
37
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
38 def sum(self):
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
39 ....
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
40
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
41 def __str__(self):
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
42 ....
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
43
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
44 REMEMBER!
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
45 Always return an instance of your die roller for each option expect str and sum.
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
46
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
47
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
48 Step 3:
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
49
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
50 Modify Utils.py
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
51
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
52 You need to make some minor modifications to utils.py to facilitate
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
53 your new roller. You need to a) add an import call for your roller,
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
54 and b) add your roller to the list of available rollers.
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
55
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
56 For example:
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
57
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
58 from die import *
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
59 # add addtional rollers here
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
60 from myroller import *
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
61 ....
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
62
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
63 rollers = ['std','wod','d20','myroller']
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
64
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
65 Step 4: You're done!
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
66
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
67 Test it and make sure it works. When you think its done, send it to
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
68 the openrpg developers and they might include it in future releases.
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
69
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
70 -Chris Davis
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
71
7f6e8f94394e Traipse Alpha 'OpenRPG' {091210-01}
sirebral
parents:
diff changeset
72