]> git.xonotic.org Git - xonotic/xonotic.git/blob - misc/tools/NexuizDemoRecorder/main/src/main/resources/help/html/compat-limitations.html
Merge branch 'master' of ssh://git.xonotic.org/xonotic
[xonotic/xonotic.git] / misc / tools / NexuizDemoRecorder / main / src / main / resources / help / html / compat-limitations.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN">
2
3 <html>
4   <head>
5     <meta name="generator" content="HTML Tidy, see www.w3.org">
6
7     <title></title>
8   </head>
9
10   <body>
11    <H1>Compatibility and limitations</H1>
12 <P><BR><BR>
13 </P>
14 <H1>Compatibility</H1>
15 <H2>Operating system</H2>
16 <P>Since this tool is written in Java
17 you can use it on Windows, Linux and Mac OS. This means that it can
18 be used on all platforms supported by Nexuiz. You do need Java 6.</P>
19 <H2>Nexuiz engine version</H2>
20 <P>In order to use this tool you will
21 need to use a Nexuiz engine of version 2.5 or newer. The reason is
22 that the engine needs to have the variables
23 cl_capturevideo_nameformat and cl_capturevideo_number. If you use
24 older engines, such as the 2.3 engine, recording will work, but the
25 tool will be unable to move the avi clip rendered by the engine to
26 your desired location. However, you can manually move it and simply
27 ignore the fact that the job finished with an &ldquo;error&rdquo;.</P>
28 <H2>Demo file version</H2>
29 <P>There is not really any limitation
30 about the Nexuiz version that was used when recording the demo. That
31 means that you should be able to use the Nexuiz demo recorder with
32 demos from previous Nexuiz versions (they can be older than 2.5). You
33 just have to make sure that the engine binary you use for recording
34 them is v2.5 and newer. Keep in mind that using a newer-generation
35 engine such as the 2.5 one for older demos should usually work
36 without problems. You might have to move the dataXXXXXX.pk3 files
37 from the Nexuiz version that corresponds to the demo version into the
38 data directory.</P>
39 <H2>Nexuiz Demo Recorder job queues</H2>
40 <P>Table preferences, job queues and template lists are not compatible
41 between v0.1 and newer versions! Make sure you install this in a different
42 direcory than v0.1!</P>
43 <H1>Limitations</H1>
44 <P>This tool only works with 1-map demos
45 (such as the one being automatically recorded by Nexuiz when using
46 the cl_autodemo feature). If you manually recorded a demo that
47 contains several maps, you can only specify a start- and endtime for
48 the first map. However, you can try to use the demosplit.pl script
49 from svn (trunk/misc/tools/demosplit.pl) to split demos having
50 several maps into several 1-map demos. However, note that this tool
51 will probably only work properly for older demos (up to Nexuiz v2.4.2
52 demos).</P>
53   </body>
54 </html>
55