Added a folder remotely
[divverent/nexuiz.git] / navnodeedit / NavNodeEdit_readme.txt
1 Title           : NavNodeEdit\r
2 Filename        : ...\r
3 Version         : ?\r
4 Date            : ?\r
5 Author          : Marko "Urre" Permanto\r
6 Email           : imunreal A to the T gmail D to the O to the T com\r
7 Website         :\r
8 Credits         : LordHavoc for teaching me a lot about QuakeC\r
9                   Ender for scratch tutorials\r
10                   id Software for various good things\r
11                   Stribbs for inspiration to improve this editor\r
12 \r
13 Type of Mod\r
14 -----------\r
15 Quake C         : aye!\r
16 Sound           : no\r
17 MDL             : Yes\r
18 Level           : no\r
19 Gfx             : no\r
20 \r
21 Format of QuakeC (if a Quake C Mod)\r
22 -----------------------------------\r
23 unified diff  : no\r
24 context diff  : no\r
25 .qc files     : yes\r
26 progs.dat     : yes\r
27 \r
28 Description of the Modification\r
29 -------------------------------\r
30 Previously called WayBoxEdit, this mod has evolved into something I like to\r
31 call NavNodeEdit, this because it is no longer restricted to arbitrary boxes,\r
32 nor touching links. It now supports planes to shape the boxes into different\r
33 shapes, and supports remote links ala waypoints. Not as cool as building all\r
34 the info out of planes, like MrElusives navigation systems do (Omicron bot,\r
35 Gladiator bot, and Q3A bots). I might do that once I figure out BSP trees,\r
36 which is when it would be even remotely plausible, for performance reasons.\r
37 This system should still cover most needs.\r
38 \r
39 I recommend the DarkPlaces engine, FTE might be supported in the future.\r
40 \r
41 Controls and Impulses\r
42 --------\r
43 WARNING: These instructions are *not* pedagogical!\r
44 \r
45 +button3 and +button4 in combination with other buttons are used for various\r
46 types of control. For example, if you hold down +button3, aim at a wall and\r
47 press +button0, the current navnode will resize on the current axis to where\r
48 you aimed.\r
49 \r
50 +button3 = resizing navnodes.\r
51 +button4 = movement of navnodes and clip points.\r
52 +button3 and +button4 = plane control.\r
53 \r
54 The effect that +button0 and/or +button2 has depends on which of these\r
55 "help-buttons" are held down, if at all. Impulse 101 and impulse 102 are\r
56 special in the way that they also have different effects depending on this.\r
57 By default, +button0 is bound to mousebutton1, +button2 is bound to\r
58 mousebutton2, impulse 101 to scrollwheel-up, impulse 102 to scrollwheel-down,\r
59 +button3 to shift, +button4 is to ctrl.\r
60 \r
61 Here follows a list of actions, assuming the default binds (mb1 and mb2 are\r
62 mousebuttons):\r
63         (no help-button)\r
64 mb1 = No effect (feel free to suggest what this button could do)\r
65 mb2 = lock/unlock selection (unlocking will delete all clip points)\r
66 scroll-wheel = change gridsize\r
67         SHIFT\r
68 mb1 = resize to aimed geometry on current axis\r
69 mb2 = resize to self.origin on all axis\r
70 scroll-wheel = resize on current axis\r
71         CTRL\r
72 mb1 = move on all axis to aim\r
73 mb2 = move on all axis to self\r
74 scroll-wheel = move on current axis\r
75         SHIFT+CTRL\r
76 mb1 = spawn/delete plane (if no clip points are present, will make plane on\r
77       aimed geometry. deletion only happens if new plane matches with old)\r
78 mb2 = spawn clip point (requires selection lock, up to 3 allowed and required)\r
79 scroll-wheel = switch selected clip point if available, else switch selected\r
80                plane\r
81 \r
82 The say command is used for various things that require extra parameters. Here\r
83 follow the possible commands (say them without the quotation marks):\r
84 \r
85 "origin [vector]" = will move the navnode to the desired origin, unaffected by\r
86                     the grid.\r
87 "resize [worldspace on current axis]" = will resize a navnode's edge to the\r
88                                         issued worldspace parameter, unaffected\r
89                                         by the grid.\r
90 "save" = Saves the navnode list (future versions will provide possibility to\r
91          issue filename).\r
92 "load" = Loads navnode list (future versions will provide possibility to\r
93          issue filename).\r
94 "teleport" = gives the Special flag S_TELEPORT to the current navnode.\r
95 "door" = gives the Special flag S_DOOR to the current navnode.\r
96 "nolink [optional number]" = will give the Link flag FL_NOLINK to the current\r
97                              navnode. If no number is issued, it will look for\r
98                              your secondary-selected navnode, check if it is a\r
99                              valid link, and issue the number automaticly.\r
100 "nowalk [optional number]" = will give the Link flag FL_NOWALK to the current\r
101                              navnode. If no number is issued, it will look for\r
102                              your secondary-selected navnode, check if it is a\r
103                              valid link, and issue the number automaticly.\r
104 "bad [optional number]" = will give the Link flag FL_BAD to the current\r
105                           navnode. If no number is issued, it will look for your\r
106                           secondary-selected navnode, check if it is a valid\r
107                           link, and issue the number automaticly.\r
108 "bigdrop [optional number]" = will give the Link flag FL_BIGDROP to the current\r
109                               navnode. If no number is issued, it will look for\r
110                               your secondary-selected navnode, check if it is a\r
111                               valid link, and issue the number automaticly.\r
112 "remote" = will give the Link flag FL_REMOTE to the current navnode. Secondary-\r
113            selected navnode is required.\r
114 \r
115 There are a number of impulses as well, which are important. The default bind\r
116 is listed next to the impulse number:\r
117 \r
118 Impulse Bind            Effect\r
119 1-9     1-9             Menu selection\r
120 101     wheelup         Described above\r
121 102     wheeldown       Described above\r
122 110     N               Spawn new navnode (requires selection to be unlocked)\r
123 111     R               Delete current navnode\r
124 112     P               Delete current plane\r
125 120     O               Switches selected navnode when in overlap-selection-mode\r
126 121     M               Switches selection mode between closest, and overlap\r
127 122     TAB             Cycles current axis\r
128 123     X               Switches to X axis\r
129 124     Y               Switches to Y axis\r
130 125     Z               Switches to Z axis\r
131 \r
132 Good Luck!\r
133 \r
134 Known Bugs\r
135 ----------\r
136 1) Sometimes when doing something against aimed geometry, the aim goes through\r
137         the wall.\r
138         Cause: The DarkPlaces engine has collision issues in q3bsp, thus\r
139         nothing I can affect.\r
140         Solution: re-aim slightly and try again.\r
141 2) Resizing sometimes doesn't go all the way.\r
142         Cause: Unknown.\r
143         Solution: Re-resize with same parameters until it reaches the desired\r
144         size.\r
145 \r
146 Legal\r
147 -----\r
148 Authors MAY use this Quake modification as a basis for other publicly\r
149 available work, as long as I am credited. Please send me any modifications\r
150 you make.\r
151 \r
152 You may distribute this Quake modification in any electronic format as long\r
153 as this description file remains intact and unmodified and is retained along\r
154 with all of the files in the archive.\r
155 \r
156 You are not allowed to sell this Quake modification for money without my\r
157 permission.\r
158 \r
159 Quake is copyrighted and trademarked, owned by id Software.