annotate orpg/dieroller/HOWTO.txt @ 179:5609ac142298 alpha

Traipse Alpha 'OpenRPG' {100114-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 (Keeping up with Beta) New Features: Added Bookmarks Added 'boot' command to remote admin Added confirmation window for sent nodes Minor changes to allow for portability to an OpenSUSE linux OS Miniatures Layer pop up box allows users to turn off Mini labels, from FlexiRPG Zoom Mouse plugin added Images added to Plugin UI Switching to Element Tree Map efficiency, from FlexiRPG Added Status Bar to Update Manager New TrueDebug Class in orpg_log (See documentation for usage) Portable Mercurial Tip of the Day added, from Core and community New Reference Syntax added for custom PC sheets New Child Reference for gametree New Parent Reference for gametree New Gametree Recursion method, mapping, context sensitivity, and effeciency.. New Features node with bonus nodes and Node Referencing help added Dieroller structure from Core New DieRoller portability for odd Dice Added 7th Sea die roller; ie [7k3] = [7d10.takeHighest(3).open(10)] New 'Mythos' System die roller added Added new vs. die roller method for WoD; ie [3v3] = [3d10.vs(3)]. Included for Mythos roller also New Warhammer FRPG Die Roller (Special thanks to Puu-san for the support) New EZ_Tree Reference system. Push a button, Traipse the tree, get a reference (Beta!) Fixes: Fix to Text based Server Fix to Remote Admin Commands Fix to Pretty Print, from Core Fix to Splitter Nodes not being created Fix to massive amounts of images loading, from Core Fix to Map from gametree not showing to all clients Fix to gametree about menus Fix to Password Manager check on startup Fix to PC Sheets from tool nodes. They now use the tabber_panel Fix to Whiteboard ID to prevent random line or text deleting. Fixes to Server, Remote Server, and Server GUI Fix to Update Manager; cleaner clode for saved repositories Fixes made to Settings Panel and now reactive settings when Ok is pressed Fixes to Alternity roller's attack roll. Uses a simple Tuple instead of a Splice Fix to Use panel of Forms and Tabbers. Now longer enters design mode Fix made Image Fetching. New fetching image and new failed image Modified ID's to prevent non updated clients from ruining the fix. default_manifest.xml renamed to default_upmana.xml
author sirebral
date Thu, 14 Jan 2010 21:22:21 -0600
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