]> git.xonotic.org Git - xonotic/xonotic.git/blob - misc/tools/NexuizDemoRecorder/main/src/main/resources/help/html/advanced-how-it-works.html
Merge branch 'master' of ssh://git.xonotic.org/xonotic
[xonotic/xonotic.git] / misc / tools / NexuizDemoRecorder / main / src / main / resources / help / html / advanced-how-it-works.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>How it works</H1>
12 <P>The following is a description of how
13 the program processes a single job:</P>
14 <UL>
15         <LI><P>The program takes your original
16         demo, e.g. &ldquo;C:\Nexuiz\data\demos\test.dem&rdquo; and creates a
17         copy of it, the <I>cut demo</I>. This file has the name
18         &lt;original_demo_name&gt;<B>_autocut</B>.dem. The cut demo is
19         different to the original demo in a way that console commands have
20         been <I>injected</I>, so basically the engine thinks that you had
21         entered them yourself (e.g. cl_capturevideo 1 to start recording).</P>
22         <UL>
23                 <LI><P>Since it is possible to inject
24                 any possible console command, the first command that is injected is
25                 to disable rendering (r_render 0), save the value of your &ldquo;volume&rdquo;
26                 setting and then setting it to 0 (as long as you have sound and
27                 rendering disabled while fast-forwarding in the preferences of the
28                 Demo Recorder). Then a slowmo 100 command (first stage value from
29                 the Demo Recorder preferences) is injected in order to fast-forward
30                 the demo.</P>
31                 <LI><P>Then, when the game time in the
32                 demo is about 1 minute less than your specified start time of the
33                 job, slowmo is reduced to 10 (second stage value from the
34                 preferences)</P>
35                 <LI><P>Then, when the game time in the
36                 demo is about 5 seconds less than your specified start time, <B>slowmo</B>
37                 is set to <B>1</B>, rendering and sound is enabled again, and
38                 whatever your put into the <B>exec before capture</B> field is
39                 being injected, too. Then, the values of cl_capturevideo_nameformat
40                 and _number are being saved to a temporary variable and are
41                 overwritten with defined values (<B>autorec</B> and <B>1234567</B>),
42                 so that the Nexuiz Demo Recorder will know the exact name of the
43                 output file (which is necessary so that it can move that file to
44                 your desired video destination/location)</P>
45                 <LI><P>When the the start time is
46                 reached, cl_capturevideo 1 is injected, once the end time is
47                 reached, cl_capturevideo 0 is injected.</P>
48                 <LI><P>Shortly after, whatever you put
49                 into the exec after capture field is executed, and then the
50                 original values of cl_capturevideo_nameformat and _number are being
51                 restored.</P>
52                 <LI><P>Then a disconnect command is
53                 injected</P>
54         </UL>
55         <LI><P>Next, your specified Nexuiz
56         engine binary is launched. The parameters given to the binary are:</P>
57         <UL>
58                 <LI><P>The content of the <B>engine
59                 parameters</B> field of the job, and</P>
60                 <LI><P><B>-demo
61                 &lt;relative-demo-path&gt;/&lt;demo-file-name&gt;</B> (this will
62                 start Nexuiz, e.g. <B>-demo demos/test.dem</B>, launch the <B>test.dem</B>
63                 demo, and the engine will play the complete demo until a disconnect
64                 is issued (which we have injected above), and then Nexuiz will
65                 close automatically. This -demo parameter exists since Nexuiz 1.0</P>
66         </UL>
67         <LI><P>Once the Nexuiz Demo Recorder
68         notices that your Nexuiz engine binary closed, it will look for the
69         recorded video file in &lt;DPVideo-directory&gt;/autorec1234567.&lt;avi/ogv&gt;
70         and move it (rename it) to your desired &lt;video-destination&gt;,
71         keeping the original extension of the file. In case the preferences
72         are setup to not overwrite an existing video file, a file with
73         ending _copy1 (2, 3, &hellip;) will be created.</P>
74 </UL>
75   </body>
76 </html>
77