misc/tools/NexuizDemoRecorder/main/src/main/resources/help/html/basic_tutorial.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>Basic tutorial</H1>\r
  12 <P>The following images shows the main window:</P>\r
  13 <img src="images/main_window.gif" />\r
  14 <P>You will notice that the main window is separated into\r
  15 4 areas:</P>\r
  16 <UL>\r
  17         <LI><P>The menu bar (File, Help)</P>\r
  18         <LI><P>The &quot;Templates&quot; area which has a table\r
  19         and 4 buttons on the right</P>\r
  20         <LI><P>The &quot;Jobs&quot; area which also has a table\r
  21         and 4 buttons on the right</P>\r
  22         <LI><P>The Start/stop processing buttons</P>\r
  23 </UL>\r
  24 <H2>Step 1</H2>\r
  25 <P>Minimize this demo recorder application for a moment\r
  26 and figure out which demo(s) you actually want to record. Once you\r
  27 know the names of the demo files, you have to figure out the start\r
  28 time and end time (when you want the recording process to start and\r
  29 end). You have to be aware that the Nexuiz demo recorder needs a\r
  30 value in seconds. The problem is that there are 2 different kinds of\r
  31 values.\r
  32 </P>\r
  33 <UL>\r
  34         <LI><P>The first one is the one you see in your HUD in\r
  35         the top right corner. This value is not useful for the Nexuiz demo\r
  36         recorder, because the time is shown in the &lt;minutes:seconds&gt;\r
  37         format. Also this value will be changed/reset to 0 in case the\r
  38         ready-restart feature was using in the game, which resets the time.</P>\r
  39         <LI><P>On the other hand there is the <B>absolute time\r
  40         value</B>. It represents the amount of time that passed on the\r
  41         server since the map was loaded. This value will always increase\r
  42         each second, and won't be reset to 0 after a ready-restart call\r
  43         either. This is the value you need for this tool. You can obtain it\r
  44         the following ways</P>\r
  45         <UL>\r
  46                 <LI><P>1: There is a sub-folder &quot;tools&quot; in\r
  47                 this package which contains a .patch file that allows you to patch\r
  48                 the source-code of the Nexuiz 2.5.2 engine. What this patch does is\r
  49                 to add a new variable &quot;showgametime&quot;. Once you patched\r
  50                 your source-code and compiled the engine, you can set this variable\r
  51                 to 1, and then in the lower right corner you will see the current\r
  52                 game time. Please note that I cannot help you with patching the\r
  53                 sources and compiling the engine. For Microsoft Windows users I put\r
  54                 the Nexuiz binary (darkplaces.exe) into the package as well, so you\r
  55                 can use this one (copy it into your Nexuiz directory)</P>\r
  56                 <LI><P>2: If the demo was recorded with Nexuiz 2.5 or\r
  57                 newer you can obtain the time values by opening the console and\r
  58                 entering this: prvm_global client time</P>\r
  59                 <LI><P>3: If the demo was recorded with a Nexuiz version\r
  60                 older than 2.5, just pause the demo at the desired moment, open the\r
  61                 scoreboard (by default: hold tabulator key). The scoreboard will\r
  62                 show you the current time in &lt;minutes&gt;:&lt;seconds&gt;.\r
  63                 Calculate the time using a calculator (time = minutes * 60 +\r
  64                 seconds)</P>\r
  65         </UL>\r
  66 </UL>\r
  67 <P>Make sure that you know the demo file name, start and\r
  68 end time, then open the Nexuiz demo recorder tool again</P>\r
  69 <H2>Step 2</H2>\r
  70 <P><a name="jobs_create">In the &quot;Jobs&quot; panel</a>, click on the +Create\r
  71 button. A new dialog will open which asks you for all different kinds\r
  72 of things:</P>\r
  73 <img src="images/create_job.gif" />\r
  74 <UL>\r
  75         <LI><P><b>Engine:</b> click on the ... button and specify the\r
  76         Nexuiz engine that should be used for recording</P>\r
  77         <LI><P><b>Engine parameters:</b> Only fill this out if you already know what it\r
  78         means. Examples include to execute a particular config (+exec\r
  79         someConfig.cfg), or set a special directory (-userdir option) so\r
  80         that your Engine will use a different set of configs</P>\r
  81         <LI><P><b>DPVideo directory:</b> here you have to specify the\r
  82         path where your Nexuiz usually creates new .avi or .ogv files. This\r
  83         is one of the items where you will see that it is required that you\r
  84         already have recorded demos previously. Usually the path will be\r
  85         Nexuiz/data/video (on Windows) or ~/.nexuiz/data/video</P>\r
  86         <LI><P><b>Relative demo path:</b> This is the path that is being\r
  87         used within the virtual file-system of Nexuiz in order to find your\r
  88         demo. Normally, when starting a demo by hand, you would enter\r
  89         something like &quot;playdemo demos/stormkeep_demo.dem&quot;,\r
  90         because usually demos are stored in the directory &quot;demos&quot;.\r
  91         In case you changed that (e.g. If the demo is in a sub-directory of\r
  92         the demos directory), make sure to put this into the field. But\r
  93         usually you <B>won't</B> have to change the value (demos) to\r
  94         anything else. Just leave it as it is.</P>\r
  95         <LI><P><b>Job name:</b> Here you can specify a name for this job. If\r
  96         you don't specify any name, a name will be automatically chosen, using\r
  97         the format "Job x", where <b>x</b> is a index number.</P>\r
  98         <LI><P><b>Demo file:</b> obviously you have to specify the demo\r
  99         file here</P>\r
 100         <LI><P><b>Start second</b> and <b>end second</b> are self-explanatory</P>\r
 101         <LI><P><b>Exec before capture:</b> Here you have the chance to\r
 102         enter console commands (that is, commands that you could otherwise\r
 103         also enter into the console of the game). One example could be to\r
 104         execute a config here that will make sure that the HUD is hidden. Or\r
 105         you might want to change the FPS for the rendered video by setting\r
 106         cl_capturevideo_fps to another value. If you want to put several\r
 107         commands in here you can either separate them by a new-line, or by ;\r
 108         (semi-colon)</P>\r
 109         <LI><P><b>Exec after capture:</b> works like the &quot;exec\r
 110         before capture&quot; field. Can be used for anything, e.g. Restoring\r
 111         settings that you altered in the exec before field.</P>\r
 112         <LI><P><b>Video destination:</b> Here you have to specify where\r
 113         you want the recorded video file to be moved once the recording\r
 114         process is done. Please note that you have to enter a name for the\r
 115         file, however you should not enter the extension (.avi or .ogv). You\r
 116         don't have to, because the Nexuiz demo recorder will automatically\r
 117         figure out whether the Nexuiz engine generated an avi or ogv file,\r
 118         and will keep its ending when moving the file to its destination.</P>\r
 119 </UL>\r
 120 <P>Once you filled out all fields, click on create. In\r
 121 case you did something wrong with one of the fields, you will\r
 122 hopefully get an error message immediately, which allows you to\r
 123 correct the mistake. If nothing was filled out incorrectly the dialog\r
 124 should close and you should now see a &quot;Job 1&quot; in the job\r
 125 queue.</P>\r
 126 <P>In order to edit a job, either double-click on it, or\r
 127 right-click it and click on Edit</P>\r
 128 <H2>Step 3</H2>\r
 129 <P>Now that you have setup your first job, click on the\r
 130 <B>Start processing</B> button. After a short moment you should see\r
 131 Nexuiz opening. Don't be surprised if the &quot;Loading&quot; image\r
 132 appears for a long time. What you don't see is that Nexuiz is\r
 133 fast-forwarding your demo to the start time you specified, which can\r
 134 take some time. After that, once Nexuiz started and finished\r
 135 recording the stuff you wanted it to record, it should close\r
 136 automatically. The demo recorder should show you a new message dialog\r
 137 that it finished recording all jobs. The &quot;Status&quot; column of\r
 138 your first job should now be showing &quot;done&quot;.</P>\r
 139 <H2>Trouble-shooting:</H2>\r
 140 <P>In case something went wrong, the status column of your job will\r
 141 show &quot;error&quot; (in the jobs table). In order to find out what the problem was,\r
 142 right-click on the job and click on &quot;Show error message&quot;.\r
 143 The message dialog that pops up will hopefully help you to figure out\r
 144 what went wrong. If it is something that you think you can fix, do so\r
 145 (by editing the job settings), then right-click the job again and click on\r
 146 &quot;Reset job status to waiting&quot;. This will set the status of the job to\r
 147 &quot;waiting&quot; again.</P>\r
 148 <H2>Job queue processing</H2>\r
 149 <P>You need to be aware that once you click on the <b>Start\r
 150 processing</b> button only the jobs with status &quot;waiting&quot; will be\r
 151 put into a queue and will be executed one after another. All other jobs\r
 152 (with status &quot;error&quot; or &quot;done&quot; will not be started.\r
 153 If an error occurs while processing one of the jobs this job will set its state to\r
 154 &quot;error&quot; and the next job in queue will be executed. That is, the behavior\r
 155 of the Nexuiz demo recorder is to continue working even if one or more individual\r
 156 jobs failed.</P>\r
 157 <P>In case you already have a job list with several\r
 158 jobs but you want to just record one particular job (even though all\r
 159 other jobs also have the state &quot;waiting&quot;), just right-click\r
 160 on the particular job and click on &quot;Start job&quot;. Note that this only\r
 161 works if the Nexuiz demo recorder is currently not working on any other jobs.</P>\r
 162 <H2>Further reading</H2>\r
 163 <P>Congratulations, you managed your\r
 164 first steps using this program. You should read the other help\r
 165 chapters as well in order to be able to fully utilize the\r
 166 functionality of the program.</P>\r
 167   </body>\r
 168 </html>\r
 169 \r