-
Notifications
You must be signed in to change notification settings - Fork 13
/
Copy pathdocumentation_roadmap.html
509 lines (477 loc) · 46.6 KB
/
documentation_roadmap.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>BigWorld Documentation Roadmap</title>
<link rel="stylesheet" href="bigworld.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<div id="bigworld-header">
<img src="http://try.bigworldtech.com/bigworld/image.php?img=bigworld_logo.gif&svn=$HeadURL: https://svn01.bigworldtech.com/svn/customers/Xingyulongying/2.0/current/bigworld/doc/documentation_roadmap.html $" alt="bw logo"/>
</div>
<div class="book" lang="en">
<div class="titlepage"><h1 class="title">BigWorld Documentation Roadmap</h1></div>
</div>
<div class="titlepage">
<p>This document outlines a roadmap to the other documents found in this directory.
If you are new to BigWorld Technology, it should guide you in learning about and
becoming proficient with its concepts, installation, customisation, use and operation.</p>
<p><b>Note: depending on the BigWorld Technology license you have purchased, not
all files mentioned below may have been included.</b></p>
<h2>Table of Contents</h2>
<p></p>
<div class="itemizedlist">
<ul>
<li><p><a href="#reading_order">Recommended Reading Order</a>
<li><p><a href="#release_notes">Release Notes</a>
<li><p><a href="#licensing_information">Licensing Information</a>
<li><p><a href="#full_list">Full List of Documentation</a>
<li><p><a href="#directory_structure">BigWorld Technology Directory Structure</a>
</ul>
</div>
<hr>
<a name="reading_order"><h2>Recommended Reading Order</h2></a>
<p></p>
<table width="100%">
<tr>
<td colspan=3>
<table align=center><tr><td style='border:solid gray 1pt; background:#E8F2FF; width:300px; height:100%;'>
<p align=center><b>Overview</b><br>
Getting Started <span style='font-size:8pt'>[<a href="generated_html/getting_started/index.html">HTML</a>] [<a href="getting_started.pdf">PDF</a>]</span><br>
BigWorld Tutorial <span style='font-size:8pt'>[<a href="generated_html/bigworld_tutorial/index.html">HTML</a>] [<a href="bigworld_tutorial.pdf">PDF</a>]</span><br>
Server Overview <span style='font-size:8pt'>[<a href="generated_html/server_overview/index.html" >HTML</a>] [<a href="server_overview.pdf" >PDF</a>]</span></p>
</td></tr></table>
</td>
</tr>
<tr><td colspan=3 style='border-bottom:solid gray 1pt;'> </td></tr>
<tr colspan=1>
<td>
</td>
<td align=center>
<p align=center><b>Server</b></p>
</td>
</tr>
<tr valign=top>
<td>
<p align=center><b>Operations</b><br>(High Level)</p>
<table align=center><tr><td style='border:solid gray 1pt; background:#E8F2FF; width:300px; height:100%;'>
<p align=center><b>Installation</b><br>
Server Installation Guide <span style='font-size:8pt'>[<a href="generated_html/server_installation_guide/index.html" >HTML</a>][<a href="server_installation_guide.pdf" >PDF</a>]</span><br>
Server Tools Installation Guide <span style='font-size:8pt'>[<a href="generated_html/server_tools_installation_guide/index.html" >HTML</a>][<a href="server_tools_installation_guide.pdf" >PDF</a>]</span><br>
</td></tr></table>
<br>
<table align=center><tr><td style='border:solid gray 1pt; background:#E8F2FF; width:300px; height:100%;'>
<p align=center><b>Operation</b><br>
Server Operations Guide <span style='font-size:8pt'>[<a href="generated_html/server_operations_guide/index.html">HTML</a>] [<a href="server_operations_guide.pdf">PDF</a>]</span>
<br>
Release Planning <span style='font-size:8pt'>[<a href="generated_html/release_planning/index.html">HTML</a>] [<a href="release_planning.pdf">PDF</a>]</span>
</td></tr></table>
</td>
<td>
<p align=center><b>Scripting</b><br>(Medium Level)</p>
<table align=center><tr><td style='border:solid gray 1pt; background:#E8F2FF; width:300px; height:100%;'>
<p align=center><b>Manual</b><br>
Server Programming Guide <span style='font-size:8pt'>[<a href="generated_html/server_programming_guide/index.html">HTML</a>] [<a href="server_programming_guide.pdf">PDF</a>]</span>
</td></tr></table>
<br>
<table align=center><tr><td style='border:solid gray 1pt; background:#E8F2FF; width:300px; height:100%;'>
<p align=center><b>Reference</b><br>
File Grammar Guide <span style='font-size:8pt'>[<a href="generated_html/file_grammar_guide/index.html">HTML</a>] [<a href="file_grammar_guide.pdf">PDF</a>]</span><br>
Web Integration Reference <span style='font-size:8pt'>[<a href="generated_html/web_integration/index.html" >HTML</a>] [<a href="web_integration.pdf" >PDF</a>]</span><br>
<b>Python API Reference Guides:</b><br>
<table align=center style='margin-top:3pt;'>
<tr><td style='background:#E8F2FF; border-left:solid gray 1pt; border-top:solid gray 1pt; border-right:none; border-bottom:none; padding:1px;'><p align=left style='margin:0'>BaseApp </td><td style='border-left: none; border-top:solid gray 1pt; border-right:solid gray 1pt; border-bottom:none; background:#E8F2FF; padding:0;'><span style='font-size:8pt'>[<a href="api_python/python_baseapp.chm" >CHM</a>] [<a href="api_python/baseapp_html.tgz" >TGZ</a><i>-compressed HTML</i>]</span><br></td></tr>
<tr><td style='background:#E8F2FF; border-left:solid gray 1pt; border-top:none; border-right:none; border-bottom:none; padding:1px;'><p align=left style='margin:0'>CellApp </td><td style='border-left: none; border-top:none; border-right:solid gray 1pt; border-bottom:none; background:#E8F2FF; padding:0;'><span style='font-size:8pt'>[<a href="api_python/python_cellapp.chm" >CHM</a>] [<a href="api_python/cellapp_html.tgz" >TGZ</a><i>-compressed HTML</i>]</span><br></td></tr>
<tr><td style='background:#E8F2FF; border-left:solid gray 1pt; border-top:none; border-right:none; border-bottom:none; padding:1px;'><p align=left style='margin:0'>Client </td><td style='border-left: none; border-top:none; border-right:solid gray 1pt; border-bottom:none; background:#E8F2FF; padding:0;'><span style='font-size:8pt'>[<a href="api_python/python_client.chm" >CHM</a>] [<a href="api_python/client_html.tgz" >TGZ</a><i>-compressed HTML</i>]</span><br></td></tr>
</table>
</td></tr></table>
</td>
<td>
<p align=center><b>Extensions</b><br>(Low Level)</p>
<table align=center><tr><td style='border:solid gray 1pt; background:#E8F2FF; width:300px; height:100%;'>
<p align=center><b>Manual</b><br>
Server Programming Guide <span style='font-size:8pt'>[<a href="generated_html/server_programming_guide/index.html">HTML</a>] [<a href="server_programming_guide.pdf">PDF</a>]</span>
</td></tr></table>
<br>
<table align=center><tr><td style='border:solid gray 1pt; background:#E8F2FF; width:300px; height:100%;'>
<p align=center><b>Reference</b><br>
File Grammar Guide <span style='font-size:8pt'>[<a href="generated_html/file_grammar_guide/index.html">HTML</a>] [<a href="file_grammar_guide.pdf">PDF</a>]</span><br>
<b>C++ API Reference Guides:</b><br>
<table align=center style='margin-top:3pt'>
<tr><td style='background:#E8F2FF; border-left:solid gray 1pt; border-top:solid gray 1pt; border-right:none; border-bottom:none; padding:1px;'><p align=left style='margin:0'>BaseApp </td><td style='border-left: none; border-top:solid gray 1pt; border-right:solid gray 1pt; border-bottom:none; background:#E8F2FF; padding:0;'><span style='font-size:8pt'>[<a href="api_cpp/baseapp.chm" >CHM</a>] [<a href="api_cpp/baseapp_html.tgz" >TGZ</a><i>-compressed HTML</i>]</span><br></td></tr>
<tr><td style='background:#E8F2FF; border-left:solid gray 1pt; border-top:none; border-right:none; border-bottom:none; padding:1px;'><p align=left style='margin:0'>BaseAppMgr </td><td style='border-left: none; border-top:none; border-right:solid gray 1pt; border-bottom:none; background:#E8F2FF; padding:0;'><span style='font-size:8pt'>[<a href="api_cpp/baseappmgr.chm">CHM</a>] [<a href="api_cpp/baseappmgr_html.tgz">TGZ</a><i>-compressed HTML</i>]</span><br></td></tr>
<tr><td style='background:#E8F2FF; border-left:solid gray 1pt; border-top:none; border-right:none; border-bottom:none; padding:1px;'><p align=left style='margin:0'>CellApp </td><td style='border-left: none; border-top:none; border-right:solid gray 1pt; border-bottom:none; background:#E8F2FF; padding:0;'><span style='font-size:8pt'>[<a href="api_cpp/cellapp.chm" >CHM</a>] [<a href="api_cpp/cellapp_html.tgz" >TGZ</a><i>-compressed HTML</i>]</span><br></td></tr>
<tr><td style='background:#E8F2FF; border-left:solid gray 1pt; border-top:none; border-right:none; border-bottom:none; padding:1px;'><p align=left style='margin:0'>Client </td><td style='border-left: none; border-top:none; border-right:solid gray 1pt; border-bottom:none; background:#E8F2FF; padding:0;'><span style='font-size:8pt'>[<a href="api_cpp/client.chm" >CHM</a>] [<a href="api_cpp/client_html.tgz" >TGZ</a><i>-compressed HTML</i>]</span><br></td></tr>
<tr><td style='background:#E8F2FF; border-left:solid gray 1pt; border-top:none; border-right:none; border-bottom:none; padding:1px;'><p align=left style='margin:0'>DBMgr </td><td style='border-left: none; border-top:none; border-right:solid gray 1pt; border-bottom:none; background:#E8F2FF; padding:0;'><span style='font-size:8pt'>[<a href="api_cpp/dbmgr.chm" >CHM</a>] [<a href="api_cpp/dbmgr_html.tgz" >TGZ</a><i>-compressed HTML</i>]</span><br></td></tr>
<tr><td style='background:#E8F2FF; border-left:solid gray 1pt; border-top:none; border-right:none; border-bottom:none; padding:1px;'><p align=left style='margin:0'>LoginApp </td><td style='border-left: none; border-top:none; border-right:solid gray 1pt; border-bottom:none; background:#E8F2FF; padding:0;'><span style='font-size:8pt'>[<a href="api_cpp/loginapp.chm" >CHM</a>] [<a href="api_cpp/loginapp_html.tgz" >TGZ</a><i>-compressed HTML</i>]</span><br></td></tr>
<tr><td style='background:#E8F2FF; border-left:solid gray 1pt; border-top:none; border-right:none; border-bottom:none; padding:1px;'><p align=left style='margin:0'>Reviver </td><td style='border-left: none; border-top:none; border-right:solid gray 1pt; border-bottom:none; background:#E8F2FF; padding:0;'><span style='font-size:8pt'>[<a href="api_cpp/reviver.chm" >CHM</a>] [<a href="api_cpp/reviver_html.tgz" >TGZ</a><i>-compressed HTML</i>]</span><br></td></tr>
</table>
</td></tr></table>
</td>
</tr>
</table>
<table width="100%">
<tr valign=top>
<td>
<p align=center><b>Client</b></p>
<table align=center><tr><td style='border:solid gray 1pt; background:#E8F2FF; width:300px; height:100%;'>
<p align=center><b>Programming Overview</b><br>
Client Programming Guide <span style='font-size:8pt'>[<a href="generated_html/client_programming_guide/index.html">HTML</a>] [<a href="client_programming_guide.pdf">PDF</a>]</span>
</td></tr></table>
<br>
<table align=center><tr><td style='border:solid gray 1pt; background:#E8F2FF; width:300px; height:100%;'>
<p align=center><b>Programming Reference</b><br>
Python Client API Reference Guide <span style='font-size:8pt'>[<a href="api_python/python_client.chm">CHM</a>] [<a href="api_python/client_html.tgz">TGZ</a><i>-compressed HTML</i>]</span><br>
C++ Client API Reference Guide <span style='font-size:8pt'>[<a href="api_cpp/client.chm" >CHM</a>] [<a href="api_cpp/client_html.tgz" >TGZ</a><i>-compressed HTML</i>]</span>
</td></tr></table>
</td>
<td width=20></td>
<td>
<p align=center><b>Tools</b></p>
<table align=center><tr><td style='border:solid gray 1pt; background:#E8F2FF; width:300px; height:100%;'>
<p align=center><b>User Manual</b><br>
Content Creation Manual <span style='font-size:8pt'>[<a href="content_creation.chm">CHM</a>]</span>
</td></tr></table>
<br>
<table align=center><tr><td style='border:solid gray 1pt; background:#E8F2FF; width:300px; height:100%;'>
<p align=center><b>Reference</b><br>
Content Tools Reference Guide <span style='font-size:8pt'>[<a href="generated_html/content_tools_reference_guide/index.html">HTML</a>] [<a href="content_tools_reference_guide.pdf">PDF</a>]</span>
</td></tr></table>
</td>
<td>
<p align=center><b>Third Party Integrations</b></p>
<table align=center><tr><td style='border:solid gray 1pt; background:#E8F2FF; width:300px; height:100%;'>
<p align=center><b>Intergration Manual</b><br>
Third Party Integrations <span style='font-size:8pt'>[<a href="generated_html/thirdparty_integrations/index.html">HTML</a>] [<a href="thirdparty_integrations.pdf">PDF</a>]</span>
</td></tr></table>
<br>
</td>
</tr>
</table>
<h3>For Server Operators:</h3>
<p style='margin-bottom:0'>The recommended reading is:
<div class="itemizedlist">
<ul>
<li><p>Server Overview <span style='font-size:8pt'>[<a href="generated_html/server_overview/index.html" >HTML</a>] [<a href="server_overview.pdf" >PDF</a>]</span>
<li><p>Server Operations Guide <span style='font-size:8pt'>[<a href="generated_html/server_operations_guide/index.html">HTML</a>] [<a href="server_operations_guide.pdf">PDF</a>]</span>
<li><p>Web Integration Reference <span style='font-size:8pt'>[<a href="generated_html/web_integration/index.html" >HTML</a>] [<a href="web_integration.pdf" >PDF</a>]</span>
<li><p>Server Installation Guide <span style='font-size:8pt'>[<a href="generated_html/server_installation_guide/index.html" >HTML</a>][<a href="server_installation_guide.pdf" >PDF</a>]</span>
<li><p>Server Tools Installation Guide <span style='font-size:8pt'>[<a href="generated_html/server_tools_installation_guide/index.html" >HTML</a>][<a href="server_tools_installation_guide.pdf" >PDF</a>]</span>
<li><p>Release Planning <span style='font-size:8pt'>[<a href="generated_html/release_planning/index.html" >HTML</a>] [<a href="release_planning.pdf" >PDF</a>]</span>
</ul>
</div>
<h3>For Game Code Scripters (AI, object behaviour, combat systems, etc...):</h3>
<p style='margin-bottom:0'>The recommended reading is:
<div class="itemizedlist">
<ul>
<li><p>BigWorld Tutorial <span style='font-size:8pt'>[<a href="generated_html/bigworld_tutorial/index.html" >HTML</a>] [<a href="bigworld_tutorial.pdf" >PDF</a>]</span>
<li><p>Server Overview <span style='font-size:8pt'>[<a href="generated_html/server_overview/index.html" >HTML</a>] [<a href="server_overview.pdf" >PDF</a>]</span>
<li><p>Server Operations Guide <span style='font-size:8pt'>[<a href="generated_html/server_operations_guide/index.html" >HTML</a>] [<a href="server_operations_guide.pdf" >PDF</a>]</span>
<li><p>Server Programming Guide <span style='font-size:8pt'>[<a href="generated_html/server_programming_guide/index.html">HTML</a>] [<a href="server_programming_guide.pdf">PDF</a>]</span>
<li><p>Web Integration Reference <span style='font-size:8pt'>[<a href="generated_html/web_integration/index.html" >HTML</a>] [<a href="web_integration.pdf" >PDF</a>]</span>
<li><p>File Grammar Guide <span style='font-size:8pt'>[<a href="generated_html/file_grammar_guide/index.html" >HTML</a>] [<a href="file_grammar_guide.pdf" >PDF</a>]</span>
<li><p>Python API Reference Guides
<ul>
<li><p>BaseApp <span style='font-size:8pt'>[<a href="api_python/python_baseapp.chm" >CHM</a>] [<a href="api_python/baseapp_html.tgz" >TGZ</a><i>-compressed HTML</i>]</span>
<li><p>CellApp <span style='font-size:8pt'>[<a href="api_python/python_cellapp.chm" >CHM</a>] [<a href="api_python/cellapp_html.tgz" >TGZ</a><i>-compressed HTML</i>]</span>
<li><p>Client <span style='font-size:8pt'>[<a href="api_python/python_client.chm" >CHM</a>] [<a href="api_python/client_html.tgz" >TGZ</a><i>-compressed HTML</i>]</span>
</ul>
<li><p>Release Planning <span style='font-size:8pt'>[<a href="generated_html/release_planning/index.html" >HTML</a>] [<a href="release_planning.pdf" >PDF</a>]</span>
</ul>
</div>
<h3>For Low-Level Server Programmers (server extensions):</h3>
<p style='margin-bottom:0'>The recommended reading is:
<div class="itemizedlist">
<ul>
<li><p>BigWorld Tutorial <span style='font-size:8pt'>[<a href="generated_html/bigworld_tutorial/index.html" >HTML</a>] [<a href="bigworld_tutorial.pdf" >PDF</a>]</span>
<li><p>Server Overview <span style='font-size:8pt'>[<a href="generated_html/server_overview/index.html" >HTML</a>] [<a href="server_overview.pdf" >PDF</a>]</span>
<li><p>Server Operations Guide <span style='font-size:8pt'>[<a href="generated_html/server_operations_guide/index.html" >HTML</a>] [<a href="server_operations_guide.pdf" >PDF</a>]</span>
<li><p>Server Programming Guide <span style='font-size:8pt'>[<a href="generated_html/server_programming_guide/index.html">HTML</a>] [<a href="server_programming_guide.pdf">PDF</a>]</span>
<li><p>Web Integration Reference <span style='font-size:8pt'>[<a href="generated_html/web_integration/index.html" >HTML</a>] [<a href="web_integration.pdf" >PDF</a>]</span>
<li><p>File Grammar Guide <span style='font-size:8pt'>[<a href="generated_html/file_grammar_guide/index.html" >HTML</a>] [<a href="file_grammar_guide.pdf" >PDF</a>]</span>
<li><p>Python API Reference Guides
<ul>
<li><p>BaseApp <span style='font-size:8pt'>[<a href="api_python/python_baseapp.chm" >CHM</a>] [<a href="api_python/baseapp_html.tgz" >TGZ</a><i>-compressed HTML</i>]</span>
<li><p>CellApp <span style='font-size:8pt'>[<a href="api_python/python_cellapp.chm" >CHM</a>] [<a href="api_python/cellapp_html.tgz" >TGZ</a><i>-compressed HTML</i>]</span>
<li><p>Client <span style='font-size:8pt'>[<a href="api_python/python_client.chm" >CHM</a>] [<a href="api_python/client_html.tgz" >TGZ</a><i>-compressed HTML</i>]</span>
</ul>
<li><p>C++ API Reference Guides
<ul>
<li><p>BaseApp <span style='font-size:8pt'>[<a href="api_cpp/baseapp.chm" >CHM</a>] [<a href="api_cpp/baseapp_html.tgz" >TGZ</a><i>-compressed HTML</i>]</span>
<li><p>BaseAppMgr <span style='font-size:8pt'>[<a href="api_cpp/baseappmgr.chm">CHM</a>] [<a href="api_cpp/baseappmgr_html.tgz">TGZ</a><i>-compressed HTML</i>]</span>
<li><p>CellApp <span style='font-size:8pt'>[<a href="api_cpp/cellapp.chm" >CHM</a>] [<a href="api_cpp/cellapp_html.tgz" >TGZ</a><i>-compressed HTML</i>]</span>
<li><p>Client <span style='font-size:8pt'>[<a href="api_cpp/client.chm" >CHM</a>] [<a href="api_cpp/client_html.tgz" >TGZ</a><i>-compressed HTML</i>]</span>
<li><p>DBMgr <span style='font-size:8pt'>[<a href="api_cpp/dbmgr.chm" >CHM</a>] [<a href="api_cpp/dbmgr_html.tgz" >TGZ</a><i>-compressed HTML</i>]</span>
<li><p>LoginApp <span style='font-size:8pt'>[<a href="api_cpp/loginapp.chm" >CHM</a>] [<a href="api_cpp/loginapp_html.tgz" >TGZ</a><i>-compressed HTML</i>]</span>
<li><p>Reviver <span style='font-size:8pt'>[<a href="api_cpp/reviver.chm" >CHM</a>] [<a href="api_cpp/reviver_html.tgz" >TGZ</a><i>-compressed HTML</i>]</span>
</ul>
<li><p>Release Planning <span style='font-size:8pt'>[<a href="generated_html/release_planning/index.html" >HTML</a>] [<a href="release_planning.pdf" >PDF</a>]</span>
</ul>
</div>
<p><b>Note that a full massively multiplayer game may be produced using BigWorld
Technology solely at the scripting level, so these documents <i>need not</i> be read.</b></p>
<hr>
<h3>For Tools Programmers:</h3>
<p style='margin-bottom:0'>The recommended reading is:
<div class="itemizedlist">
<ul>
<li><p>Client Programming Guide <span style='font-size:8pt'>[<a href="generated_html/client_programming_guide/index.html" >HTML</a>] [<a href="client_programming_guide.pdf" >PDF</a>]</span>
<li><p>Content Tools Reference Guide <span style='font-size:8pt'>[<a href="generated_html/content_tools_reference_guide/index.html">HTML</a>] [<a href="content_tools_reference_guide.pdf">PDF</a>]</span>
</ul>
</div>
<h3>For Tools Users (artists/level builders):</h3>
<p style='margin-bottom:0'>The recommended reading is:
<div class="itemizedlist">
<ul>
<li><p>Content Tools Reference Guide <span style='font-size:8pt'>[<a href="generated_html/content_tools_reference_guide/index.html">HTML</a>] [<a href="content_tools_reference_guide.pdf">PDF</a>]</span>
<li><p>Content Creation Manual <span style='font-size:8pt'>[<a href="content_creation.chm" >CHM</a>]</span>
</ul>
</div>
<a name="release_notes"><h2>Release Notes</h2></a>
<p>Changes in BigWorld Technology are described per-version in the following documents:
described in the corresponding
<div class="itemizedlist">
<ul>
<li><p>Client Release Notes <span style='font-size:8pt'>[<a href="release_notes_client.html">HTML</a>]</span>
<li><p>Server Release Notes <span style='font-size:8pt'>[<a href="release_notes_server.html">HTML</a>]</span>
<li><p>Tools Release Notes <span style='font-size:8pt'>[<a href="release_notes_tools.html" >HTML</a>]</span>
</ul>
</div>
<p>These notes are quite detailed, and it is recommended that you read them
for each new release of BigWorld you receive.</p>
<a name="licensing_information"><h2>Licensing Information</h2></a>
<p> The following document contains important information about third party libraries included in the BigWorld
Technology and the licensing requirements of these libraries.
[<a href="licensing_information.html">HTML</a>]
<p> The directory bigworld/doc/logos contains the logos as required by licensing requirements. [<a href="logos/black_powered_by_7cm_rgb.psd">black logo</a>] [<a href="logos/white_powered_by_7cm_rgb.psd">white logo</a>]</p>
<h3>Small Feature Documents</h3>
<p>Some releases may contain ancillary documents that break out a
description of some particular feature in BigWorld, usually one that
has only appeared in the latest version – for example, they may include
instructions on how to migrate from an older format to a new format.
<p>The titles of such documents will make clear their purpose and intended audience.
In future releases their content is likely to be integrated into the main
Manual documents.</p>
<a name="full_list"><h2>Full List of Documentation</h2></a>
<div class="itemizedlist">
<ul>
<li><p><b><code>api_cpp</code></b> – C++ API docs
<ul>
<li><p><b><a href="api_cpp/baseapp.chm" ><code>baseapp.chm</code></a></b> – (CHM) BaseApp C++ API Reference Guide
<li><p><b><a href="api_cpp/baseapp_html.tgz" ><code>baseapp_html.tgz</code></a></b> – (TGZ<i>-compressed HTML</i>) BaseApp C++ API Reference Guide
<li><p><b><a href="api_cpp/baseappmgr.chm" ><code>baseappmgr.chm</code></a></b> – (CHM) BaseAppMgr C++ API Reference Guide
<li><p><b><a href="api_cpp/baseappmgr_html.tgz"><code>baseappmgr_html.tgz</code></a></b> – (TGZ<i>-compressed HTML</i>) BaseAppMgr C++ API Reference Guide
<li><p><b><a href="api_cpp/cellapp.chm" ><code>cellapp.chm</code></a></b> – (CHM) CellApp C++ API Reference Guide
<li><p><b><a href="api_cpp/cellapp_html.tgz" ><code>cellapp_html.tgz</code></a></b> – (TGZ<i>-compressed HTML</i>) CellApp C++ API Reference Guide
<li><p><b><a href="api_cpp/client.chm" ><code>client.chm</code></a></b> – (CHM) Client C++ API Reference Guide
<li><p><b><a href="api_cpp/client_html.tgz" ><code>client_html.tgz</code></a></b> – (TGZ<i>-compressed HTML</i>) Client C++ API Reference Guide
<li><p><b><a href="api_cpp/dbmgr.chm" ><code>dbmgr.chm</code></a></b> – (CHM) DBMgr C++ API Reference Guide
<li><p><b><a href="api_cpp/dbmgr_html.tgz" ><code>dbmgr_html.tgz</code></a></b> – (TGZ<i>-compressed HTML</i>) DBMgr C++ API Reference Guide
<li><p><b><a href="api_cpp/loginapp.chm" ><code>loginapp.chm</code></a></b> – (CHM) LoginApp C++ API Reference Guide
<li><p><b><a href="api_cpp/loginapp_html.tgz" ><code>loginapp_html.tgz</code></a></b> – (TGZ<i>-compressed HTML</i>) LoginApp C++ API Reference Guide
<li><p><b><a href="api_cpp/reviver.chm" ><code>reviver.chm</code></a></b> – (CHM) Reviver C++ API Reference Guide
<li><p><b><a href="api_cpp/reviver_html.tgz" ><code>reviver_html.tgz</code></a></b> – (TGZ<i>-compressed HTML</i>) Reviver C++ API Reference Guide
</ul>
<li><p><b><code>api_python</code></b> – Python API docs
<ul>
<li><p><b><a href="api_python/baseapp_html.tgz" ><code>baseapp_html.tgz</code></a></b> – (TGZ<i>-compressed HTML</i>) BaseApp C++ API Reference Guide
<li><p><b><a href="api_python/cellapp_html.tgz" ><code>cellapp_html.tgz</code></a></b> – (TGZ<i>-compressed HTML</i>) CellApp C++ API Reference Guide
<li><p><b><a href="api_python/client_html.tgz" ><code>client_html.tgz</code></a></b> – (TGZ<i>-compressed HTML</i>) Client C++ API Reference Guide
<li><p><b><a href="api_python/python_baseapp.chm" ><code>python_baseapp.chm</code></a></b> – (CHM) BaseApp C++ API Reference Guide
<li><p><b><a href="api_python/python_cellapp.chm" ><code>python_cellapp.chm</code></a></b> – (CHM) CellApp C++ API Reference Guide
<li><p><b><a href="api_python/python_client.chm" ><code>python_client.chm</code></a></b> – (CHM) Client C++ API Reference Guide
</ul>
<li><p><b><code>generated_html</code></b> – HTML version of the documentation
<ul>
<li><p><b><code><a href="generated_html/bigworld_tutorial/index.html" >bigworld_tutorial/index.html</a></code></b> – (HTML) How to create a client-only game, a client-server game, and a chat system
<li><p><b><code><a href="generated_html/client_programming_guide/index.html" >client_programming_guide/index.html</a></code></b> – (HTML) High-level overview of the client
<li><p><b><code><a href="generated_html/content_tools_reference_guide/index.html">content_tools_reference_guide/index.html</a></code></b> – (HTML) Reference guide of the BigWorld tools
<li><p><b><code><a href="generated_html/file_grammar_guide/index.html" >file_grammar_guide/index.html</a></code></b> – (HTML) Documentation of BigWorld configuration files
<li><p><b><code><a href="generated_html/howto_accurately_target_entities/index.html">howto_accurately_target_entities/index.html</a></code></b> – (HTML) How-To
<li><p><b><code><a href="generated_html/howto_avoid_file_in_main_thread/index.html">howto_avoid_file_in_main_thread/index.html</a></code></b> – (HTML) How-To
<li><p><b><code><a href="generated_html/howto_build_friends_list/index.html" >howto_build_friends_list/index.html</a></code></b> – (HTML) How-To
<li><p><b><code><a href="generated_html/howto_build_moving_platform/index.html" >howto_build_moving_platform/index.html</a></code></b> – (HTML) How-To
<li><p><b><code><a href="generated_html/howto_build_vehicle/index.html" >howto_build_vehicle/index.html</a></code></b> – (HTML) How-To
<li><p><b><code><a href="generated_html/howto_upgrade_bigworld_version/index.html" >howto_upgrade_bigworld_version/index.html</a></code></b>– (HTML) How-To
<li><p><b><code><a href="generated_html/howto_control_bot_movement/index.html" >howto_control_bot_movement/index.html</a></code></b> – (HTML) How-To
<li><p><b><code><a href="generated_html/howto_find_memory_leaks/index.html" >howto_find_memory_leaks/index.html</a></code></b> – (HTML) How-To
<li><p><b><code><a href="generated_html/howto_implement_progress_bar/index.html" >howto_implement_progress_bar/index.html</a></code></b> – (HTML) How-To
<li><p><b><code><a href="generated_html/howto_items/index.html" >howto_items/index.html</a></code></b> – (HTML) How-To
<li><p><b><code><a href="generated_html/howto_move_entities/index.html" >howto_move_entities/index.html</a></code></b> – (HTML) How-To
<li><p><b><code><a href="generated_html/howto_web_integration/index.html" >howto_web_integration/index.html</a></code></b> – (HTML) How-To
<li><p><b><code><a href="generated_html/offline_patcher/index.html" >offline_patcher/index.html</a></code></b> – (HTML) Overview of offline patching of resources and game binaries
<li><p><b><code><a href="generated_html/server_operations_guide/index.html" >server_operations_guide/index.html</a></code></b> – (HTML) Overview of operations for running a server
<li><p><b><code><a href="generated_html/server_overview/index.html" >server_overview/index.html</a></code></b> – (HTML) Overview of server components
<li><p><b><code><a href="generated_html/server_programming_guide/index.html" >server_programming_guide/index.html</a></code></b> – (HTML) Manual for extending the server with C++, and scripting on the server
<li><p><b><code><a href="generated_html/web_integration/index.html" >web_integration/index.html</a></code></b> – (HTML) Manual for extending the server with PHP and Python
</ul>
<li><p><b><a href="bigworld_tutorial.pdf" ><code>bigworld_tutorial.pdf</code></a></b> – (PDF) How to create a client-only game, a client-server game, and a chat system
<li><p><b><a href="client_and_tools_build_instructions.html"><code>client_and_tools_build_instructions.html</code></a></b> – Instructions for programmers on recompiling code
<li><p><b><a href="client_installation_guide.html" ><code>client_installation_guide.html</code></a></b> – Instructions for programmers on installing the client and setting up the environment
<li><p><b><a href="client_programming_guide.pdf" ><code>client_programming_guide.pdf</code></a></b> – (PDF) High-level overview of the client
<li><p><b><a href="content_creation.chm" ><code>content_creation.chm</code></a></b> – Complete high-level documentation for using the content creation tools
<li><p><b><a href="content_tools_reference_guide.pdf" ><code>content_tools_reference_guide.pdf</code></a></b> – (PDF) Reference guide of the BigWorld tools
<li><p><b><a href="documentation_roadmap.html" ><code>documentation_roadmap.html</code></a></b> – This document
<li><p><b><a href="file_grammar_guide.pdf" ><code>file_grammar_guide.pdf</code></a></b> – Documentation of BigWorld configuration files
<li><p><b><a href="howto_accurately_target_entities.pdf" ><code>howto_accurately_target_entities.pdf</code></a></b> – (PDF) How-To
<li><p><b><a href="howto_avoid_file_in_main_thread.pdf" ><code>howto_avoid_file_in_main_thread.pdf</code></a></b> – (PDF) How-To
<li><p><b><a href="howto_build_friends_list.pdf" ><code>howto_build_friends_list.pdf</code></a></b> – (PDF) How-To
<li><p><b><a href="howto_build_moving_platform.pdf" ><code>howto_build_moving_platform.pdf</code></a></b> – (PDF) How-To
<li><p><b><a href="howto_build_vehicle.pdf" ><code>howto_build_vehicle.pdf</code></a></b> – (PDF) How-To
<li><p><b><a href="howto_upgrade_bigworld_version.pdf" ><code>howto_upgrade_bigworld_version.pdf</code></a></b> – (PDF) How-To
<li><p><b><a href="howto_control_bot_movement.pdf" ><code>howto_control_bot_movement.pdf</code></a></b> – (PDF) How-To
<li><p><b><a href="howto_find_memory_leaks.pdf" ><code>howto_find_memory_leaks.pdf</code></a></b> – (PDF) How-To
<li><p><b><a href="howto_implement_progress_bar.pdf" ><code>howto_implement_progress_bar.pdf</code></a></b> – (PDF) How-To
<li><p><b><a href="howto_items.pdf" ><code>howto_items.pdf</code></a></b> – (PDF) How-To
<li><p><b><a href="howto_move_entities.pdf" ><code>howto_move_entities.pdf</code></a></b> – (PDF) How-To
<li><p><b><a href="howto_web_integration.pdf" ><code>howto_web_integration.pdf</code></a></b> – (PDF) How-To
<li><p><b><a href="release_notes_client.html" ><code>release_notes_client.html</code></a></b> – Client release notes
<li><p><b><a href="release_notes_server.html" ><code>release_notes_server.html</code></a></b> – Server release notes
<li><p><b><a href="release_notes_tools.html" ><code>release_notes_tools.html</code></a></b> – Tools release notes
<li><p><b><a href="generated_html/server_installation_guide/index.html" ><code>server_installation_guide.html</code></a></b> – Guide to installing the server
<li><p><b><a href="generated_html/server_tools_installation_guide/index.html" ><code>server_tools_installation_guide.html</code></a></b> – Guide to installing the server tools
<li><p><b><a href="server_operations_guide.pdf" ><code>server_operations_guide.pdf</code></a></b> – (PDF) Overview of operations for running a server
<li><p><b><a href="server_overview.pdf" ><code>server_overview.pdf</code></a></b> – (PDF) Overview of server components
<li><p><b><a href="server_programming_guide.pdf" ><code>server_programming_guide.pdf</code></a></b> – (PDF) Manual for extending the server with C++, and scripting on the server
<li><p><b><a href="tools_tutorial_examples.zip" ><code>tools_tutorial_examples.zip</code></a></b> – Files used in the examples for the Content Creation manual.
<li><p><b><a href="web_integration.pdf" ><code>web_integration.pdf</code></a></b> – (PDF) Manual for extending the server with PHP and Python
</ul>
<a name="directory_structure"><h2>BigWorld Technology Directory Structure</h2></a>
<p>The root directory is called <code>mf</code> by default. It can be renamed,
as long as the appropriate environment variables are updated to reflect
the change. Under the root directory, we have the following files/folders:</p>
<ul>
<li><p><b><code>bigworld</code></b> – Source for all bigworld client and server applications, and executables for tools.
<ul>
<li><p><b><code>bin</code></b> – Server-side binaries.
<ul>
<li><p><b><code>Hybrid64</code></b> – 64-bit binaries.</p></li>
<ul>
<li><p><b><code><commands</code></b> – helper commands.</p></li>
</ul>
</ul>
<li><p><b><code>doc</code></b> – Documentation.
<li><p><b><code>res</code></b> – Shared resources used by tools and game application.
<li><p><b><code>src</code></b> – Client and server source (Not available for Indie customers).
<ul>
<li><p><b><code>build</code></b> – Files used to build the source code on Linux systems.
<li><p><b><code>client</code></b> – Source for the bwclient library and Visual Studio solution file to build the game executable.
<li><p><b><code>common</code></b> – Miscellaneous source code common to client and server.
<li><p><b><code>examples</code></b> – Source for all BigWorld example programs.
<ul>
<li><p><b><code>client1</code></b> – Source for example minimal clients (for server-only licensees).
<li><p><b><code>client2</code></b> – Source for example minimal clients (for server-only licensees).
<li><p><b><code>client3</code></b> – Source for example minimal clients (for server-only licensees).
<li><p><b><code>client4</code></b> – Source for example minimal clients (for server-only licensees).
</ul>
<li><p><b><code>lib</code></b> – Source for all BigWorld libraries.
<ul>
<li><p><b><code>appmgr</code></b> – Application manager library used only by the tools.
<li><p><b><code>ashes</code></b> – Graphical user interface library, used by client and tools.
<li><p><b><code>camera</code></b> – Library for various camera types, used by the client and tools.
<li><p><b><code>chunk</code></b> – Library that manages world chunks, used on client, tools, and server.
<li><p><b><code>connection</code></b> – Library that is used for high level client-server communication management.
<li><p><b><code>controls</code></b> – Library that manages panel buttons and sliders, used by tools.
<li><p><b><code>cstdmf</code></b> – General purpose classes and functions used by everything.
<li><p><b><code>dbmgr_lib</code></b> – Common DBMgr library used to integrate specific database implementations and DBMgr.
<li><p><b><code>dbmgr_mysql</code></b> – MySQL implementation for DBMgr.
<li><p><b><code>dbmgr_xml</code></b> – XML implementation for DBMgr.
<li><p><b><code>duplo</code></b> – Connectable model pieces for the client, such as action_queue, motor, and attachments.
<li><p><b><code>entitydef</code></b> – Classes to manage entity definitions, methods and properties (server and client).
<li><p><b><code>fmod</code></b> – Interface to FMOD sound library.
<li><p><b><code>fmodsound</code></b> – The FMOD sound library.
<li><p><b><code>gizmo</code></b> – Library of graphic gizmos for manipulating objects in the tools.
<li><p><b><code>guimanager</code></b> – Library that manages GUI components and toolbars, used in tools.
<li><p><b><code>guitabs</code></b> – Library that manages GUI panels, used in tools.
<li><p><b><code>input</code></b> – Library for user input from mouse, keyboard and joystick.
<li><p><b><code>job_system</code></b> – Multi-threaded job system library for the Client.
<li><p><b><code>math</code></b> – A maths library, used by everything.
<li><p><b><code>model</code></b> – The model library, used by client and tools.
<li><p><b><code>moo</code></b> – The rendering library, used by client and tools.
<li><p><b><code>network</code></b> – The network library, used by everything.
<li><p><b><code>particle</code></b> – The particle systems library, used by client and tools.
<li><p><b><code>physics2</code></b> – Library for sorting, colliding, and manipulating objects in 3D space (client and server).
<li><p><b><code>post_processing</code></b> – The client post processing effects library.
<li><p><b><code>pyscript</code></b> – Library for integration of Python into the engine's C++ classes, used by everything.
<li><p><b><code>python</code></b> – The Python library, used by everything.
<li><p><b><code>png</code></b> – The PNG image format library, used by the tools and client.
<li><p><b><code>resmgr</code></b> – The resource manager, used by everything for loading resources.
<li><p><b><code>romp</code></b> – Miscellaneous classes for managing various types of effects on the client.
<li><p><b><code>server</code></b> – Common server classes.
<li><p><b><code>speedtree</code></b> – Interface to the SpeedTreeRT library.
<li><p><b><code>speedtreert</code></b> – The SpeedTreeRT library.
<li><p><b><code>sqlite</code></b> – Wrapper library to interface with the third-party SQLite database.
<li><p><b><code>terrain</code></b> – The terrain library, use by everything.
<li><p><b><code>third_party</code></b> – Third-party libraries such as CppUnitLite2, OpenSSL and Stack Walker.
<li><p><b><code>ual</code></b> – The Asset Browser library, used by the tools.
<li><p><b><code>umbra</code></b> – The UMBRA library.
<li><p><b><code>unit_test_lib</code></b> – The Unit Test library.
<li><p><b><code>waypoint</code></b> – Server library for AI waypoint navigation.
<li><p><b><code>web_render</code></b> – Client library used for integrating the Mozilla Gecko rendering engine.
<li><p><b><code>zip</code></b> – The zlib compression library.
</ul>
<li><p><b><code>server</code></b> – Server application source.
<ul>
<li><p><b><code>baseapp</code></b> – Process that manages a group of base entities (incl. client proxies)
<li><p><b><code>baseappmgr</code></b> – Process that manages a group of BaseApps.
<li><p><b><code>cellapp</code></b> – Process that manages a group of cell entities.
<li><p><b><code>cellappmgr</code></b> – Process that manages a group of CellApps.
<li><p><b><code>dbmgr</code></b> – Database process.
<li><p><b><code>egextra</code></b> – Example CellApp C++ Controller and EntityExtra extensions.
<li><p><b><code>loginapp</code></b> – Login process.
<li><p><b><code>reviver</code></b> – Process that monitors and revives other processes.
<li><p><b><code>tools</code></b> – Source to various server tools.
</ul>
</ul>
<li><p><b><code>tools</code></b> – Executables for the BigWorld content creation and server tools.
<ul>
<li><p><b><code>server</code></b> – Server tools.
<ul>
<li><p><b><code>bin</code></b> – Executables for the server tools.
<li><p><b><code>cluster_commands</code></b> – Python scripts used to implement the functionality of Control Cluster.
<li><p><b><code>message_logger</code></b> – Scripts used to support interacting with the logs generated by Message Logger.
<li><p><b><code>misc</code></b> – General operation scripts used by server software.
<li><p><b><code>pycommon</code></b> – Python module used by most server tools to communicate with a BigWorld server and processes.
<li><p><b><code>rpm</code></b> – Scripts and spec files used to generate RPMs for the server components.
<li><p><b><code>snapshot</code></b> – Script to perform LVM snapshots of the DBMgr database and consolidate the secondary databases.
<li><p><b><code>space_viewer</code></b> – A tool for viewing and managing servers, spaces and cells.
<li><p><b><code>stat_logger</code></b> – A tool for logging server cluster performance data to MySQL.
<li><p><b><code>web_console</code></b> – Suite of web-based server tools.
</ul>
<li><p><b><code>exporter</code></b> – Visual and animation exporters.
<li><p><b><code>misc</code></b> – Miscellaneous client-side tools, including NavGen.
<li><p><b><code>modeleditor</code></b> – ModelEditor, the model-editing tool.
<li><p><b><code>particle_editor</code></b> – ParticleEditor, the particle system-editing tool.
<li><p><b><code>res</code></b> – Resources for the tools.
<li><p><b><code>worldeditor</code></b> – WorldEditor, the world-builder tool.
</ul>
</ul>
<li><p><b><code>fantasydemo</code></b> – All fantasydemo resources (script, config, graphics) and the client runtime.
<ul>
<li><p><b><code>res</code></b> – Resources for the fantasydemo.
<ul>
<li><p><b><code>audio</code></b> – FMOD sound banks.
<li><p><b><code>characters</code></b> – Visuals and animations for avatars and NPC's.
<li><p><b><code>environments</code></b> – Flora and sky definition files.
<li><p><b><code>flora</code></b> – Flora models and textures.
<li><p><b><code>gui</code></b> – Graphical user interface definition files.
<li><p><b><code>maps</code></b> – Textures for the game models, and user interface.
<li><p><b><code>materials</code></b> – Definitions for types of materials.
<li><p><b><code>objects</code></b> – Objects you can place in the maps such as models, shells, lights, water, etc.
<ul>
<li><p><b><code>lights</code></b> – Light definition files.
</ul>
<li><p><b><code>particles</code></b> – Particle definition files.
<li><p><b><code>scaleform</code></b> – Demonstration data files used by the Scaleform integration.
<li><p><b><code>scripts</code></b> – Entity definition, entity Python scripts, script data.
<li><p><b><code>server</code></b> – Server-side information.
<li><p><b><code>sets</code></b> – Assorted models, animations and textures used by FantasyDemo.
<li><p><b><code>sfx</code></b> – Particle system effects.
<li><p><b><code>spaces</code></b> – Each sub-directory is the name of a space.
<li><p><b><code>speedtree</code></b> – Models and textures of SpeedTree flora.
</ul>
</div>
</div>
</body>
</html>