annotate orpg/templates/nodes/ironclaw-guide.xml @ 36:d02e9197c066 ornery-orc

Traipse 'OpenRPG' {101220-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 Sun, 19 Dec 2010 22:44:36 -0600
parents
children
rev   line source
36
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
1 <nodehandler class="tabber_handler" frame="730,490,139,134" icon="iron-claw" map="" module="containers" name="User Guide" version="1.0"><nodehandler class="textctrl_handler" frame="334,152,398,69" icon="note" map="User Guide" module="forms" name="Introduction" version="1.0"><text hide_title="1" multiline="1" raw_mode="0" send_button="0">Iron Claw Interactive PC Sheet / Die Roller
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
2
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
3 The Iron Claw PC Sheet comes with a user guide becuase it is a first of it's kind in Traipse OpenRPG. The PC sheet is designed to interact with the Iron Claw die roller. The die roller uses a set of text based commands to retrieve data from your PC sheet and uses that data to create die rolls and also to make modifications to the PC sheet when you tell it too.
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
4
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
5 The PC sheet also updates it's data every time you use a command, allowing you to manually edit it and not worry if your changes will take effect.
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
6
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
7 However, because of this design some restrictions are required to prevent breaking the die rollers interactivity. This small guide will help users get to know what the die roller / pc sheet combo can do, and what can break the roller.
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
8
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
9 Special thanks goes to Sanguine Productions Ltd for providing the Iron Claw logo image to be used for this sheet. That is awesome!
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
10
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
11 Ironclaw logo (tm) 1999, 2010 Sanguine Productions. Used with permission from Sanguine Productions Ltd to Knowledge Arcana Mad Mathematics Laboratories, all rights reserved.</text></nodehandler><nodehandler class="textctrl_handler" frame="334,152,398,69" icon="note" map="User Guide" module="forms" name="What NOT To Do" version="1.0"><text hide_title="1" multiline="1" raw_mode="1" send_button="0">Firstly we should go over what can cause the PC Sheet / Die Roller combo to malfunction.
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
12
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
13 The character sheet is open enough that users can make some modifications to it without fear of breaking it's interactivity with the die roller. Yet, there are certain changes that should not be made or the die roller will not work correctly.
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
14
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
15 Changing Node Names:
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
16 In general, users should not change the names of nodes because these are a reference point for the die roller.
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
17
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
18 Users are encouraged to change the name of their node from IronClaw to their PC's name. Users are also encouraged to change the name of the Weapon nodes inside the Combat node.
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
19
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
20 Note: To rename your sheet highlight it and press F2, or right click it and choose Design
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
21
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
22 Modifying the Skills Grid:
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
23 Generally this will not be a problem as long as the Race, Careers, and Skills columns remain in their position.
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
24
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
25 Nodes With the Same Name:
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
26 This can cause unpredictable problems. While the pc sheet remains open and users can add nodes, it is best to not add nodes with already assigned names.</text></nodehandler><nodehandler class="textctrl_handler" frame="334,152,398,69" icon="note" map="User Guide" module="forms" name="Commands" version="1.0"><text hide_title="1" multiline="1" raw_mode="0" send_button="0">Using the die roller is pretty simple. The die roller integrates NameSpace 2.0 making data retreival rather effeicient.
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
27
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
28 PC Sheet First:
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
29 Always place the PC sheet's node name first. The default is IronClaw, so that will be used for all examples. You can rename IronClaw.
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
30
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
31 Basics:
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
32 The roller syntax is fairly basic. [IronClaw.option]. You will replace 'option' with the various options available, and can even add more options or basic dice rolls. The roller than gathers all of the dice, creating a list of dice to roll, and then rolls those dice.
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
33
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
34 Example: [IronClaw.mind.2d4] Rolls IronClaw's Mind Dice and 2d4
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
35
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
36 You can also modify the entire die list with a modifier. [IronClaw.body+3] rolls IronClaw's Body Dice with a +3 Modifier
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
37
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
38 Basic Options
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
39 .rest+/-# ; Rests a PC for # hours [IronClaw.rest+3]
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
40 .wounds+/-# ; Adds or subtracts # wounds [IronClaw.wounds+3]
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
41 .fatigue ; Works the same as wounds
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
42 .denarii+/-# ; Adds or subtracts # Denarii [IronClaw.denarii+8]
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
43 .aureals ; Works like .denarii for Aureals
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
44 .magic+/-# ; Adds or subtracts # Current Magic [IronClaw.magic-2]
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
45 .magic.#d# Adds #d# to Current Magic [IronClaw.magic.2d4]
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
46 .passout ; Rolls an Unconsiousness Check
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
47 .meditate.#d# ; Rolls a meditate check vs #d# [IronClaw.meditate.2d4]
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
48 .damage.#d# ; Rolls #d# as Damage Dice [IronClaw.damage.2d4]
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
49
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
50 Advanced Commands
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
51 .weapona ; Initiates an Attack with 'WeaponA' (See: Weapons &amp; Skills)
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
52 .soak ; Rolls the Soak dice
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
53 .dodge ; Rolls your Dodge dice. Additionally you can add .guard or .retreat
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
54 .block ; Rolls your Block Dice. Additionally you can add .guard or .retreat
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
55 .nocover ; Block and Dodge automatically add Cover unless you add .nocover
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
56 .parry ; When rolled with a Weapon you use that weapon to parry [IronClaw.weapona.parry]</text></nodehandler><nodehandler class="textctrl_handler" frame="334,152,398,69" icon="note" map="User Guide" module="forms" name="Sheet Setup" version="1.0"><text hide_title="1" multiline="1" raw_mode="0" send_button="0">Some of the PC Sheet integration will work out of the box with the Iron Claw roller. Other portions require some setup or you will return nothing. Setup is straight forward for the most part.
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
57
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
58 The Basics:
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
59 If you want your die roller to have the ability to roll ability checks or skill checks, you need to add the dice to their positions in the sheet. You can add multiple dice to one entry using commas (Example: 1d4, 1d8 = 1d4+1d8).
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
60
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
61 PC Name:
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
62 Be sure to change the Name node in the General form.
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
63
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
64 Defense:
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
65 Block and Dodge are automatically filled in each time you use .block or .dodge. You can leave these alone. You will need to fill in Cover, Soak, and Resolve.
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
66
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
67 Auto Updating:
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
68 The die roller automatically updates some of the data in your node everytime you enter a command. Your Aureals and Denarii are automatically converted, Block and Dodge, and your Total node in Damage is automatically updated. You are free to manually modify your PC sheet and when you roll a die command again the sheet data will update.
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
69 </text></nodehandler><nodehandler class="textctrl_handler" frame="334,152,398,69" icon="note" map="User Guide" module="forms" name="Weapons &amp; Skills" version="1.0"><text hide_title="1" multiline="1" raw_mode="0" send_button="0">Weapons &amp; Skills are an extensible feature of the interactive Iron Claw PC sheet. There is no straight forward approach, only guidelines and some mandates that portions of the grids cannot be changed.
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
70
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
71 Skills:
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
72 With the Iron Claw die roller a user can roll any skill that is in the Skills grid. The default sheet shows only one empty row. Any number of rows can be added (through design mode). The name of the skill goes into the Skill Name column, and the different dice go into the Race, Careers, and Skill columns. Users should not move these columns around. The Favored, Total, Experience, and any columns added can change column positions though.
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
73
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
74 When rolling a skill the user just rolls with their skill name.
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
75 Example: [IronClaw.hunter] rolls IronClaw's hunter skill.
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
76
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
77 Weapons:
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
78 Weapons can be a bit confusing. The weapon attack is Speed + the skill used to weild the weapon. You need to make sure you have added a row to the Skills grid for the weapon's skill, then add that skill name to the Skill section of the weapon grid. Finally, be sure you have added the damage dice.
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
79
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
80 To use your weapon the command is the name of the weapon grid. The defaults are weapona, weaponb, and weaponc .. but you can rename them. Note: To rename your weapon grid highlight it and press F2, or right click it and choose Design</text></nodehandler><nodehandler class="textctrl_handler" frame="334,152,398,69" icon="note" map="User Guide" module="forms" name="NameSpace 2.0" version="1.0"><text hide_title="1" multiline="1" raw_mode="0" send_button="0">The IronClaw dieroller also makes use of NameSpace 2.0. This allows you to find your sheet using NameSpace and also to call internal nodes using NameSpace. The syntax for this is extremely easy. Just use the basic roller commands with the NameSpace 2.0 sperator (::)
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
81
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
82 Example Usage:
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
83 For an example to find your character sheet if it is in the PCSheets folder node, use [PCSheet::IronClaw.command]
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
84
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
85 You can find internal nodes in much the same way. To output the value of your Denarii node use [IronClaw.Purse::Denarii]
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
86
d02e9197c066 Traipse 'OpenRPG' {101220-00}
sirebral
parents:
diff changeset
87 NameSpace 2.0 is a really powerful advancement over it's predocessor in data is retrieved. If you want to know more about NameSpace 2.0 read the User Manual that comes with Traipse.</text></nodehandler></nodehandler>