Mercurial > traipse_dev

comparison orpg/templates/nodes/Traipse_User_Guide.xml @ 195:b633f4c64aae alpha

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Traipse Alpha 'OpenRPG' {100219-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 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
author sirebral
date Sat, 24 Apr 2010 08:37:20 -0500
parents
children 24769389a7ba
comparison
equal deleted inserted replaced
182:4b2884f29a72 195:b633f4c64aae
1 <nodehandler class="tabber_handler" frame="636,449,368,80" icon="labtop" map="Traipse OpenRPG" module="containers" name="User Manual" version="1.0"><nodehandler class="textctrl_handler" frame="400,400,0,48" icon="note" map="Traipse OpenRPG::User Manual" module="forms" name="Introduction" version="1.0">
2 <text multiline="1" send_button="0">Welcome to Traipse OpenRPG.
3
4 This small user manual should help users learn about the details of OpenRPG that are often times obscure.
5
6 What is OpenRPG:
7 OpenRPG is a virtual game table software that allows users to connect via a network. The software includes a Map, Chat, and a Game Tree.
8
9 What is Traipse OpenRPG:
10 Traipse OpenRPG is a fork of the original software that is designed to be easy for users, extremely stable, and really powerful.
11
12 Traipse has features that set it apart from all other distributions of OpenRPG. The Traipse Suite includes a powerful Update Manager that makes it easy for new developers to create and share their own fork. The Suite also contains an in house Debug Console so users can see what errors, if any, occur.
13
14 The User Manual:
15 The user manual is divided into Chapters and Sections. Each Chapter will go over the various features of OpenRPG and attempt to explain them in an easy to understand format.
16
17 Adding to the Manual:
18 Do you see something that could be explained eaiser? Report the problem as a bug and it will be added to the manual.</text>
19 </nodehandler><nodehandler class="tabber_handler" icon="player" map="Traipse OpenRPG::User Manual" module="containers" name="Chat" version="1.0"><nodehandler class="textctrl_handler" icon="note" map="Traipse OpenRPG::User Manual::Chat" module="forms" name="Using Chat" version="1.0">
20 <text multiline="1" send_button="0">The Chat window is a basic HTML Parser. It understands all basic HTML tags including table, td, tr, span, font, to name a few.
21
22 The chat includes a set of commands. You can learn about the commands by entering /help
23
24 The chat also has Settings in the Chat menu that allow you see a Chat Time Index, Images, or strip the HTML and see raw text.</text>
25 </nodehandler></nodehandler><nodehandler class="tabber_handler" icon="ccmap" map="Traipse OpenRPG::User Manual" module="containers" name="Map" version="1.0"><nodehandler class="textctrl_handler" frame="400,400,310,82" icon="note" map="Traipse OpenRPG::User Manual::Map" module="forms" name="Using The Map" version="1.0">
26 <text multiline="1" raw_mode="0" send_button="0">The Tabs:
27 The Map is divided into 7 tabs. They are Background, Grid, Miniatures, Whiteboard, Fog, and General. There are 6 layers to the map, one tab for each layer except General.
28
29 When you select one of the tabs you may access that map layer and it's settings. You may only select tabs based on your role.
30
31 Lurker or in the Lobby:
32 You cannot access any map tab or changes it's settings.
33
34 Player:
35 You have access to the Miniatures tab and the Whiteboard tab.
36
37 GM:
38 You have access to all of the tabs.
39
40 The Layers:
41 A small description of each of the layers.
42
43 Background:
44 You can set an image as the background, an image as a tile, or you can set a color.
45
46 Grid:
47 You can change the grid size, lines, turn off the grid snap, and change the grid shape.
48
49 Miniatures:
50 You can add new or remove miniatures and change mini properties and labels.
51
52 Whiteboard:
53 With the whiteboard you can draw lines or add text to the map.
54
55 Fog:
56 The fog layer hides the entire map from the prying eyes of players.
57 </text>
58 </nodehandler></nodehandler><nodehandler class="tabber_handler" icon="gear" map="Traipse OpenRPG::User Manual" module="containers" name="Game Tree" version="1.0"><nodehandler class="tabber_handler" frame="410,490,334,45" icon="tabber" map="Traipse OpenRPG::User Manual::Game Tree" module="containers" name="Reference Examples" version="1.0"><nodehandler class="textctrl_handler" frame="400,400,484,144" icon="note" map="Traipse OpenRPG::User Manual::Game Tree::Reference Examples" module="forms" name="Quick Help" version="1.0">
59 <text multiline="1" raw_mode="1" send_button="1">Quick Help:
60
61 The referencing system is an update to the Core of how the Game Tree works. In it's current state I understand the syntax is difficult to pick up. Here are some tips to help you grasp the syntax further
62
63 A.
64 Think of the Game Tree has a folder on your hard drive. Each :: inside the reference syntax works just like a system separator (/ or \)
65
66 B.
67 Root References start at the tree itself. If the node being referenced changes location the reference will be invalid.
68
69 C.
70 Child References work at the location of the node containing the reference.
71
72 Example:
73 Game Tree
74 - Group
75 -- Text Node
76 --- Group_2
77 ---- Text Node_2
78 --- Group_3
79 ---- Text Node_3
80
81 In the above Tree example you can reference Text Node_2 with a root reference
82
83 !@Group::Group_2::Text Node_2@!
84
85 or you can use a Child Reference from within Text Node
86
87 !!Group_2::Text Node_2!!
88
89 D.
90 Parent References work with the Tree Map. Unlike Child references that look only at the current nodes location, Parent References are allowed to travel backwards in the gametree.
91
92 Using the above example, you could reference Text Node from Text Node_2 with the syntax: !#Group::Text Node#!
93
94 Parent References have a special power in that they need only a certain amount of data for the software to understand them. In the above example you could reference Text Node_3 from Text Node_2 with only this syntax !#Group_3::Text Node_3#!
95
96 The reference system is still a bit primitive in it's implementation. As I was saying it is an advancement to the Core technology of Traipse OpenRPG.
97
98 While it is confusing at first, the model is far superior to other tree referencing systems. Pre 1.8.0, no node could reference a Grid. The referencing system required the reference to be exact and started at the root. Also, the new model is designed to enable freedom of creation and greater control over the Game Tree.
99
100 With the Traipse Game Tree GMs are enabled to reference any data from the Game Tree, no matter where it stands. Players can create fewer nodes and use more of the data with fewer nodes.
101
102 EZ_Tree (One Touch Reference):
103 (ALPHA!)
104 The new EZ_Tree System will help benefit users who do not understand the syntax, nor care to learn.
105
106 The EZ_Tree System works from within Lists, Texts, and Grids. In the Design Panel you can push the Reference button and navigate the small gametree that pops up to the node you want. Double click that node and the software will create the most efficient node reference for you.
107
108 (ALPHA!) In it's Alpha state, Grids will not work completely. You can reference a grid, but you must add teh cell reference. That is not a design flaw, but a restriction of time constraints.
109
110 Developer Note:
111 The syntax is the hardest part to understand and I expect to change that in the future. The Core of a more expansive Game Tree model is designed. In Traipse you do not need to give access permissions to a node in order to reference it's entirety, which is what I see with Index and Namespace from OpenRPG Core.
112
113 In the OpenRPG Core model your Game Tree has a lot more freedom, but only if you grant it, which I always felt was a design flaw. Comparably, with Traipse you can access any data on the Game Tree, no matter where the location.
114
115 This freedom will help with future design and I feel it also frees up the hands of the GM who does not need to Index, un-Index, Namespace, un-Namspace the various creatures he or she may have in a Game Tree.</text>
116 </nodehandler><nodehandler class="textctrl_handler" frame="400,400,540,67" icon="note" map="Traipse OpenRPG::User Manual::Game Tree::Reference Examples" module="forms" name="Root Reference" version="1.0">
117 <text multiline="1" raw_mode="1" send_button="1">&lt;b&gt;Root Reference&lt;/b&gt;
118 Works at the tree level. Must be exact.
119
120 &lt;b&gt;Root Reference 1:&lt;/b&gt; !@Reference Examples::Group::Child@!
121 &lt;b&gt;Root Reference 2:&lt;/b&gt; !@Reference Examples::Grid::(2,1)@!</text>
122 </nodehandler><nodehandler class="textctrl_handler" frame="441,400,514,48" icon="note" map="Traipse OpenRPG::User Manual::Game Tree::Reference Examples" module="forms" name="Grid Reference" version="1.0">
123 <text multiline="1" raw_mode="1" send_button="1">&lt;b&gt;Grid Reference&lt;/b&gt;
124 Works by looking at the (Row, Column) of a Grid.
125
126 &lt;b&gt;Grid Reference 1:&lt;/b&gt; !@Reference Examples::Grid::(1,1)@!
127 &lt;b&gt;Grid Reference 2:&lt;/b&gt; !!Grid::(1,1)!!</text>
128 </nodehandler><nodehandler class="textctrl_handler" frame="400,400,517,63" icon="note" map="Traipse OpenRPG::User Manual::Game Tree::Reference Examples" module="forms" name="Child Reference" version="1.0">
129 <text hide_title="1" multiline="1" raw_mode="1" send_button="1">&lt;b&gt;Child Reference&lt;/b&gt;
130 Works at the current tree location.
131
132 &lt;b&gt;Child Reference 1:&lt;/b&gt; !!Group::Child!!
133 &lt;b&gt;Child Reference 2:&lt;/b&gt; !!Group::Group_2::Child_2!!
134 </text>
135 </nodehandler><nodehandler class="textctrl_handler" frame="400,400,484,144" icon="note" map="Traipse OpenRPG::User Manual::Game Tree::Reference Examples" module="forms" name="Parent Reference" version="1.0">
136 <text multiline="1" raw_mode="1" send_button="1">&lt;b&gt;Parent Reference&lt;/b&gt;
137 Works by indexing the tree map of the node with the Reference. Allows you to start from a 'Parent'.
138
139 &lt;b&gt;Parent Reference 1:&lt;/b&gt; !!Group::Group_2::Child_2!!
140 &lt;b&gt;Parent Reference 2:&lt;/b&gt; !#Bonus Nodes::Deck::Draw#!</text>
141 </nodehandler><nodehandler border="1" class="group_handler" cols="1" map="Traipse OpenRPG::User Manual::Game Tree::Reference Examples" module="containers" name="Group" version="1.0">
142 <nodehandler border="1" class="group_handler" cols="1" map="Traipse OpenRPG::User Manual::Game Tree::Reference Examples::Group" module="containers" name="Group_2" version="1.0">
143 <nodehandler class="textctrl_handler" frame="400,400,571,67" icon="note" map="Traipse OpenRPG::User Manual::Game Tree::Reference Examples::Group::Group_2" module="forms" name="Child_2" version="1.0">
144 <text multiline="1" raw_mode="1" send_button="0">!#Group::Child#!</text>
145 </nodehandler><nodehandler border="1" class="group_handler" cols="1" map="Traipse OpenRPG::User Manual::Game Tree::Reference Examples::Group::Group_2" module="containers" name="Group_3" version="1.0">
146 <nodehandler class="textctrl_handler" frame="400,400,571,67" icon="note" map="Traipse OpenRPG::User Manual::Game Tree::Reference Examples::Group::Group_2::Group_3" module="forms" name="Child_3" version="1.0">
147 <text multiline="1" raw_mode="1" send_button="0">!#Group::Child#!</text>
148 </nodehandler></nodehandler></nodehandler><nodehandler class="textctrl_handler" frame="400,400,0,48" icon="note" map="Traipse OpenRPG::User Manual::Game Tree::Reference Examples::Group" module="forms" name="Child" version="1.0">
149 <text multiline="0" raw_mode="1" send_button="0">Child Node Data</text>
150 </nodehandler></nodehandler><nodehandler class="rpg_grid_handler" frame="400,400,547,51" icon="grid" map="Traipse OpenRPG::User Manual::Game Tree::Reference Examples" module="rpg_grid" name="Grid" version="1.0">
151 <grid autosize="1" border="1">
152 <row version="1.0">
153 <cell size="147">0</cell>
154 <cell>0</cell>
155 </row>
156 <row version="1.0">
157 <cell>!!Group::Child!!</cell>
158 <cell>0</cell>
159 </row>
160 </grid>
161 <macros>
162 <macro name="" />
163 </macros>
164 </nodehandler></nodehandler><nodehandler class="textctrl_handler" frame="400,400,452,36" icon="note" map="Traipse OpenRPG::User Manual::Game Tree" module="forms" name="Additions &amp; Tips" version="1.0"><text hide_title="0" multiline="1" raw_mode="0" send_button="0"> With the new additions to the Game Tree using nodes has never been easier nor has it ever been more fluid. Included here is a list of the additions to the Game Tree referencing model as well as some tips on how to make the Game Tree work the way it was intended.
165
166 Grid Nodes:
167 Grid nodes are now reference-able with the coordinates of the grid. Example: !@Grid::(1,1)@!
168 The example will return the top left most cell data. The grid understands coordinates like this (Row, Column)
169
170 Grid nodes can reference node data just like any other node can. With a new added feature grids are even more useful. By using a new die rolling syntax you can draw just the number of the modified roll. While this will not pass during game play, you can use it with the grid node to create a random chart. The new die roll syntax is [#XdY]. # works just like q, yet it returns only the modified die result.
171
172 Here is an example with a 3 x 3 Grid
173 Example: !@Grid::([#1d3], [#1d3])@!
174
175 The result will be a random event from the grid.
176
177 Bonus Node Included: A 52 Card Deck with 4 columns and 13 rows. (4 * 13 = 52)
178
179 List Nodes:
180 List nodes now have a check box that allows users to send the content as a macro. List nodes are a prime reference holder because users can place a lot of references into one small node.
181
182 For the best results from a list node my tip to users would be to create a list node and place it next to the character sheet they are using, inside a the PC Sheet. The list will then use the Child Referencing syntax, but the PC Sheet can go anywhere in the tree and the player will have easy access to all the references.
183
184 (List Nodes inside a Tool created PC sheet vanish when moved, or I would recommend the list be placed inside these sheets also.)
185
186 Here is an example of a Fortitude save inside the recommended list node: !!Fort::Check!!
187
188 Text Nodes:
189 Text nodes remain little changed. I agree with all the 1.7.1 users who tell me, if it's not broke don't fix it. With that in mind I have some good tips for text nodes.
190
191 Text nodes can be used in conjunction with the new grid features to create random encounters. A GM could place a list of text nodes into a folder and the grid could reference the nodes.
192
193 Text nodes also work great when you need to have story text at hand that you don't want to type out during play. Create chapters with folder nodes and add the adventure text to different nodes. You can then use a List Node or a Grid Node to reference the different chapters.
194
195 Bonus Node Included: A small book node with 1 Chapter and 3 Parts.</text></nodehandler><nodehandler class="textctrl_handler" frame="400,400,393,95" icon="note" map="Traipse OpenRPG::User Manual::Game Tree" module="forms" name="Node Referencing" version="1.0"><text hide_title="0" multiline="1" raw_mode="0" send_button="0"> Traipse node referencing is unlike other distributions of OpenRPG. The Game Tree mapping is a fluid map that changes with the location of your nodes. This allows you to create a reference node that will stay with your character sheet, and if you change the location of your character sheet the reference will still work.
196
197 (Note: Renaming your node causes problems with the tree mapping until you restart the software. You can just move the node and the software will reset the Game Tree map)
198
199 Reference Types:
200 There are three ways of references node data. A Root Reference, a Child Reference, and a Parent Reference.
201
202 Root Reference:
203 A node reference that starts at the Game Tree. The location of the node must be exact or you will return an Invalid Reference!
204
205 A Root Reference uses this syntax:
206 !@Node::Child::Data@!
207
208 Child Reference:
209 A node reference syntax that starts by looking at within the current container node. As long as the Child Reference is in the same container as the node, the container can change location and the reference will not be damaged. Child References work from within a PC Sheet node as well.
210
211 A Child Reference uses this syntax:
212 !!Node::Child::Data!!
213
214 Parent Reference:
215 A node reference syntax that starts by looking at the tree map and the reference used, then makes an addendum to the node's map to create a reference. The Parent Node is used when you want to reference the data in a node that is within a different child container of the same parent node.
216
217 A Parent Reference uses this syntax:
218 !#Node::Child::Data#!
219
220 Syntax for Special PC Sheet Nodes:
221 The nodes for the specialized PC Sheets now have a new syntax.
222
223 Skills, Saves, and Abilities:
224 Skills, Saves, and Abilities all have a similar referencing syntax. You can return the base value of each by using the correct syntax.
225
226 Examples:
227 !@Jonethan::Skill::Jump@! (Returns Jump ranks)
228 !@Mikael::Strength@! (Returns Ability Score and Mod)
229 !@Draj::Will@! (Returns Will Save and Mod)
230
231 (Saves and Abilities have a short hand and a long hand. Abilities can use the three letter abbreviation, while saves short hand are Fort, Ref, and Will)
232
233 You can append Check to check each of these against a 1d20 roll, or you can append Mod to discover the Modifier. The Mod can be useful in other nodes
234
235 Combat:
236 You can now reference your attacks easily with the Game Tree. Using the Attack syntax you can select modifier type, and a weapon to attack with.
237 Example: !@Kammen-Pai::Attack::M::Dagger@!
238
239 Modifier Type:
240 There are two modifier types Melee (M) or Ranged (R) You will see I added can use the long word or the short hand.
241
242 Powers, Spells and Feats:
243 Power, Spells and Feats are hard to sometimes hard to remember, and even harder to code. The use of the Power, Spell or Feat syntax serves as an emote of what you are doing, as well as a reminder of what your Power, Spell, or Feat does.
244
245 Examples:
246 !@Kammen-Pai::Cast::Ray of Frost@!
247 !@Kammen-Pai::Feat::Ability Focus@!</text></nodehandler></nodehandler><nodehandler class="tabber_handler" icon="labtop" map="Traipse OpenRPG::User Manual" module="containers" name="The Server" version="1.0"><nodehandler class="textctrl_handler" frame="400,400,310,82" icon="note" map="Traipse OpenRPG::User Manual::The Server" module="forms" name="Setting up a Server" version="1.0">
248 <text multiline="1" send_button="0">In Traipse starting a server has never been easier. The setup is as easy as 1., 2., 3
249
250 1. You will need to first start the Server GUI or the basic text based Server at least once so your software creates the server_ini.xml files in your myfiles directory. You can start it once and quit.
251
252 2. Edit the server_ini.xml file. Here you can set the server's name, the boot password, and even set the servers port.
253
254 Traipse allows you to specify a server port instead of the software demanding port 6774.
255
256 3. This is the hardest step. You need to make sure your selected port is forwarded by your router and open to your firewall.
257
258 That's it! You can now start the server and register it to the meta for all users to enjoy!</text>
259 </nodehandler></nodehandler><nodehandler class="tabber_handler" frame="400,400,0,48" icon="browser" map="Traipse OpenRPG::User Manual" module="containers" name="Links" version="1.0"><nodehandler class="link_handler" icon="html" map="Traipse OpenRPG::User Manual::Links" module="forms" name="Release Notes" version="1.0">
260 <link href="http://www.assembla.com/wiki/show/traipse" />
261 </nodehandler>
262 <nodehandler class="link_handler" icon="html" map="Traipse OpenRPG::User Manual::Links" module="forms" name="Traipse User Guide" version="1.0">
263 <link href="http://www.assembla.com/wiki/show/traipse/User_Manual" />
264 </nodehandler>
265 </nodehandler></nodehandler>