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