annotate orpg/dieroller/HOWTO.txt @ 161:a766e1cbcb7c alpha

Traipse Alpha 'OpenRPG' {091128-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 (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 Gametree Recursion method, mapping, context sensitivity, and effeciency.. New Features node with bonus nodes and Node Referencing help added 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 Fixed Whiteboard ID to prevent random line or text deleting. Modified ID's to prevent non updated clients from ruining the fix. *Whiteboard from Core not showing* default_manifest.xml renamed to default_upmana.xml Fix to Update Manager; cleaner clode for saved repositories
author sirebral
date Sat, 28 Nov 2009 01:25:20 -0600
parents bf799efe7a8a
children
rev   line source
155
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
1 HOW TO CREATE A NEW DIE ROLLER
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
2
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
3 So you want a make a new roller or add a new option? here's a short guide.
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
4
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
5
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
6 Step 1: Create a new die roller sub class.
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
7
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
8 You need to derive a new die roller class from an existing die roller class.
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
9 Most likely, this will be the std die roller class.
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
10
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
11 The basics would look like this:
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
12
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
13 class new_roller(std):
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
14 def __init__(self,source=[]):
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
15 std.__init__(self,source)
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
16 .....
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
17
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
18 ....
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
19
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
20 Step 2: Implement new methods and/or override existing ones.
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
21
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
22 Now, you just need to implement any new die options and override any
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
23 existing ones that you want to act differently. The most common options
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
24 to override are the sum and __str__ functions. Sum is used to determine
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
25 the result of the rolls and __str__ is used to display the results in
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
26 a user friendly string.
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
27
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
28 For example:
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
29
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
30 class new_roller(std):
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
31 def __init__(self,source=[]):
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
32 std.__init__(self,source)
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
33 .....
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
34
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
35 def myoption(self,param):
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
36 ....
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
37
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
38 def sum(self):
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
39 ....
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
40
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
41 def __str__(self):
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
42 ....
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
43
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
44 REMEMBER!
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
45 Always return an instance of your die roller for each option expect str and sum.
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
46
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
47
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
48 Step 3:
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
49
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
50 Modify Utils.py
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
51
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
52 You need to make some minor modifications to utils.py to facilitate
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
53 your new roller. You need to a) add an import call for your roller,
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
54 and b) add your roller to the list of available rollers.
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
55
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
56 For example:
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
57
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
58 from die import *
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
59 # add addtional rollers here
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
60 from myroller import *
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
61 ....
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
62
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
63 rollers = ['std','wod','d20','myroller']
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
64
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
65 Step 4: You're done!
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
66
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
67 Test it and make sure it works. When you think its done, send it to
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
68 the openrpg developers and they might include it in future releases.
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
69
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
70 -Chris Davis
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
71
bf799efe7a8a Traipse Alpha 'OpenRPG' {091125-02}
sirebral
parents: 0
diff changeset
72