-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN">\r
-\r
-<html>\r
- <head>\r
- <meta name="generator" content="HTML Tidy, see www.w3.org">\r
-\r
- <title></title>\r
- </head>\r
-\r
- <body>\r
- <H1>Basic tutorial</H1>\r
-<P>The following images shows the main window:</P>\r
-<img src="images/main_window.gif" />\r
-<P>You will notice that the main window is separated into\r
-4 areas:</P>\r
-<UL>\r
- <LI><P>The menu bar (File, Help)</P>\r
- <LI><P>The "Templates" area which has a table\r
- and 4 buttons on the right</P>\r
- <LI><P>The "Jobs" area which also has a table\r
- and 4 buttons on the right</P>\r
- <LI><P>The Start/stop processing buttons</P>\r
-</UL>\r
-<H2>Step 1</H2>\r
-<P>Minimize this demo recorder application for a moment\r
-and figure out which demo(s) you actually want to record. Once you\r
-know the names of the demo files, you have to figure out the start\r
-time and end time (when you want the recording process to start and\r
-end). You have to be aware that the Nexuiz demo recorder needs a\r
-value in seconds. The problem is that there are 2 different kinds of\r
-values.\r
-</P>\r
-<UL>\r
- <LI><P>The first one is the one you see in your HUD in\r
- the top right corner. This value is not useful for the Nexuiz demo\r
- recorder, because the time is shown in the <minutes:seconds>\r
- format. Also this value will be changed/reset to 0 in case the\r
- ready-restart feature was using in the game, which resets the time.</P>\r
- <LI><P>On the other hand there is the <B>absolute time\r
- value</B>. It represents the amount of time that passed on the\r
- server since the map was loaded. This value will always increase\r
- each second, and won't be reset to 0 after a ready-restart call\r
- either. This is the value you need for this tool. You can obtain it\r
- the following ways</P>\r
- <UL>\r
- <LI><P>1: There is a sub-folder "tools" in\r
- this package which contains a .patch file that allows you to patch\r
- the source-code of the Nexuiz 2.5.2 engine. What this patch does is\r
- to add a new variable "showgametime". Once you patched\r
- your source-code and compiled the engine, you can set this variable\r
- to 1, and then in the lower right corner you will see the current\r
- game time. Please note that I cannot help you with patching the\r
- sources and compiling the engine. For Microsoft Windows users I put\r
- the Nexuiz binary (darkplaces.exe) into the package as well, so you\r
- can use this one (copy it into your Nexuiz directory)</P>\r
- <LI><P>2: If the demo was recorded with Nexuiz 2.5 or\r
- newer you can obtain the time values by opening the console and\r
- entering this: prvm_global client time</P>\r
- <LI><P>3: If the demo was recorded with a Nexuiz version\r
- older than 2.5, just pause the demo at the desired moment, open the\r
- scoreboard (by default: hold tabulator key). The scoreboard will\r
- show you the current time in <minutes>:<seconds>.\r
- Calculate the time using a calculator (time = minutes * 60 +\r
- seconds)</P>\r
- </UL>\r
-</UL>\r
-<P>Make sure that you know the demo file name, start and\r
-end time, then open the Nexuiz demo recorder tool again</P>\r
-<H2>Step 2</H2>\r
-<P><a name="jobs_create">In the "Jobs" panel</a>, click on the +Create\r
-button. A new dialog will open which asks you for all different kinds\r
-of things:</P>\r
-<img src="images/create_job.gif" />\r
-<UL>\r
- <LI><P><b>Engine:</b> click on the ... button and specify the\r
- Nexuiz engine that should be used for recording</P>\r
- <LI><P><b>Engine parameters:</b> Only fill this out if you already know what it\r
- means. Examples include to execute a particular config (+exec\r
- someConfig.cfg), or set a special directory (-userdir option) so\r
- that your Engine will use a different set of configs</P>\r
- <LI><P><b>DPVideo directory:</b> here you have to specify the\r
- path where your Nexuiz usually creates new .avi or .ogv files. This\r
- is one of the items where you will see that it is required that you\r
- already have recorded demos previously. Usually the path will be\r
- Nexuiz/data/video (on Windows) or ~/.nexuiz/data/video</P>\r
- <LI><P><b>Relative demo path:</b> This is the path that is being\r
- used within the virtual file-system of Nexuiz in order to find your\r
- demo. Normally, when starting a demo by hand, you would enter\r
- something like "playdemo demos/stormkeep_demo.dem",\r
- because usually demos are stored in the directory "demos".\r
- In case you changed that (e.g. If the demo is in a sub-directory of\r
- the demos directory), make sure to put this into the field. But\r
- usually you <B>won't</B> have to change the value (demos) to\r
- anything else. Just leave it as it is.</P>\r
- <LI><P><b>Job name:</b> Here you can specify a name for this job. If\r
- you don't specify any name, a name will be automatically chosen, using\r
- the format "Job x", where <b>x</b> is a index number.</P>\r
- <LI><P><b>Demo file:</b> obviously you have to specify the demo\r
- file here</P>\r
- <LI><P><b>Start second</b> and <b>end second</b> are self-explanatory</P>\r
- <LI><P><b>Exec before capture:</b> Here you have the chance to\r
- enter console commands (that is, commands that you could otherwise\r
- also enter into the console of the game). One example could be to\r
- execute a config here that will make sure that the HUD is hidden. Or\r
- you might want to change the FPS for the rendered video by setting\r
- cl_capturevideo_fps to another value. If you want to put several\r
- commands in here you can either separate them by a new-line, or by ;\r
- (semi-colon)</P>\r
- <LI><P><b>Exec after capture:</b> works like the "exec\r
- before capture" field. Can be used for anything, e.g. Restoring\r
- settings that you altered in the exec before field.</P>\r
- <LI><P><b>Video destination:</b> Here you have to specify where\r
- you want the recorded video file to be moved once the recording\r
- process is done. Please note that you have to enter a name for the\r
- file, however you should not enter the extension (.avi or .ogv). You\r
- don't have to, because the Nexuiz demo recorder will automatically\r
- figure out whether the Nexuiz engine generated an avi or ogv file,\r
- and will keep its ending when moving the file to its destination.</P>\r
-</UL>\r
-<P>Once you filled out all fields, click on create. In\r
-case you did something wrong with one of the fields, you will\r
-hopefully get an error message immediately, which allows you to\r
-correct the mistake. If nothing was filled out incorrectly the dialog\r
-should close and you should now see a "Job 1" in the job\r
-queue.</P>\r
-<P>In order to edit a job, either double-click on it, or\r
-right-click it and click on Edit</P>\r
-<H2>Step 3</H2>\r
-<P>Now that you have setup your first job, click on the\r
-<B>Start processing</B> button. After a short moment you should see\r
-Nexuiz opening. Don't be surprised if the "Loading" image\r
-appears for a long time. What you don't see is that Nexuiz is\r
-fast-forwarding your demo to the start time you specified, which can\r
-take some time. After that, once Nexuiz started and finished\r
-recording the stuff you wanted it to record, it should close\r
-automatically. The demo recorder should show you a new message dialog\r
-that it finished recording all jobs. The "Status" column of\r
-your first job should now be showing "done".</P>\r
-<H2>Trouble-shooting:</H2>\r
-<P>In case something went wrong, the status column of your job will\r
-show "error" (in the jobs table). In order to find out what the problem was,\r
-right-click on the job and click on "Show error message".\r
-The message dialog that pops up will hopefully help you to figure out\r
-what went wrong. If it is something that you think you can fix, do so\r
-(by editing the job settings), then right-click the job again and click on\r
-"Reset job status to waiting". This will set the status of the job to\r
-"waiting" again.</P>\r
-<H2>Job queue processing</H2>\r
-<P>You need to be aware that once you click on the <b>Start\r
-processing</b> button only the jobs with status "waiting" will be\r
-put into a queue and will be executed one after another. All other jobs\r
-(with status "error" or "done" will not be started.\r
-If an error occurs while processing one of the jobs this job will set its state to\r
-"error" and the next job in queue will be executed. That is, the behavior\r
-of the Nexuiz demo recorder is to continue working even if one or more individual\r
-jobs failed.</P>\r
-<P>In case you already have a job list with several\r
-jobs but you want to just record one particular job (even though all\r
-other jobs also have the state "waiting"), just right-click\r
-on the particular job and click on "Start job". Note that this only\r
-works if the Nexuiz demo recorder is currently not working on any other jobs.</P>\r
-<H2>Further reading</H2>\r
-<P>Congratulations, you managed your\r
-first steps using this program. You should read the other help\r
-chapters as well in order to be able to fully utilize the\r
-functionality of the program.</P>\r
- </body>\r
-</html>\r
-\r
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN">
+
+<html>
+ <head>
+ <meta name="generator" content="HTML Tidy, see www.w3.org">
+
+ <title></title>
+ </head>
+
+ <body>
+ <H1>Basic tutorial</H1>
+<P>The following images shows the main window:</P>
+<img src="images/main_window.gif" />
+<P>You will notice that the main window is separated into
+4 areas:</P>
+<UL>
+ <LI><P>The menu bar (File, Help)</P>
+ <LI><P>The "Templates" area which has a table
+ and 4 buttons on the right</P>
+ <LI><P>The "Jobs" area which also has a table
+ and 4 buttons on the right</P>
+ <LI><P>The Start/stop processing buttons</P>
+</UL>
+<H2>Step 1</H2>
+<P>Minimize this demo recorder application for a moment
+and figure out which demo(s) you actually want to record. Once you
+know the names of the demo files, you have to figure out the start
+time and end time (when you want the recording process to start and
+end). You have to be aware that the Nexuiz demo recorder needs a
+value in seconds. The problem is that there are 2 different kinds of
+values.
+</P>
+<UL>
+ <LI><P>The first one is the one you see in your HUD in
+ the top right corner. This value is not useful for the Nexuiz demo
+ recorder, because the time is shown in the <minutes:seconds>
+ format. Also this value will be changed/reset to 0 in case the
+ ready-restart feature was using in the game, which resets the time.</P>
+ <LI><P>On the other hand there is the <B>absolute time
+ value</B>. It represents the amount of time that passed on the
+ server since the map was loaded. This value will always increase
+ each second, and won't be reset to 0 after a ready-restart call
+ either. This is the value you need for this tool. You can obtain it
+ the following ways</P>
+ <UL>
+ <LI><P>1: There is a sub-folder "tools" in
+ this package which contains a .patch file that allows you to patch
+ the source-code of the Nexuiz 2.5.2 engine. What this patch does is
+ to add a new variable "showgametime". Once you patched
+ your source-code and compiled the engine, you can set this variable
+ to 1, and then in the lower right corner you will see the current
+ game time. Please note that I cannot help you with patching the
+ sources and compiling the engine. For Microsoft Windows users I put
+ the Nexuiz binary (darkplaces.exe) into the package as well, so you
+ can use this one (copy it into your Nexuiz directory)</P>
+ <LI><P>2: If the demo was recorded with Nexuiz 2.5 or
+ newer you can obtain the time values by opening the console and
+ entering this: prvm_global client time</P>
+ <LI><P>3: If the demo was recorded with a Nexuiz version
+ older than 2.5, just pause the demo at the desired moment, open the
+ scoreboard (by default: hold tabulator key). The scoreboard will
+ show you the current time in <minutes>:<seconds>.
+ Calculate the time using a calculator (time = minutes * 60 +
+ seconds)</P>
+ </UL>
+</UL>
+<P>Make sure that you know the demo file name, start and
+end time, then open the Nexuiz demo recorder tool again</P>
+<H2>Step 2</H2>
+<P><a name="jobs_create">In the "Jobs" panel</a>, click on the +Create
+button. A new dialog will open which asks you for all different kinds
+of things:</P>
+<img src="images/create_job.gif" />
+<UL>
+ <LI><P><b>Engine:</b> click on the ... button and specify the
+ Nexuiz engine that should be used for recording</P>
+ <LI><P><b>Engine parameters:</b> Only fill this out if you already know what it
+ means. Examples include to execute a particular config (+exec
+ someConfig.cfg), or set a special directory (-userdir option) so
+ that your Engine will use a different set of configs</P>
+ <LI><P><b>DPVideo directory:</b> here you have to specify the
+ path where your Nexuiz usually creates new .avi or .ogv files. This
+ is one of the items where you will see that it is required that you
+ already have recorded demos previously. Usually the path will be
+ Nexuiz/data/video (on Windows) or ~/.nexuiz/data/video</P>
+ <LI><P><b>Relative demo path:</b> This is the path that is being
+ used within the virtual file-system of Nexuiz in order to find your
+ demo. Normally, when starting a demo by hand, you would enter
+ something like "playdemo demos/stormkeep_demo.dem",
+ because usually demos are stored in the directory "demos".
+ In case you changed that (e.g. If the demo is in a sub-directory of
+ the demos directory), make sure to put this into the field. But
+ usually you <B>won't</B> have to change the value (demos) to
+ anything else. Just leave it as it is.</P>
+ <LI><P><b>Job name:</b> Here you can specify a name for this job. If
+ you don't specify any name, a name will be automatically chosen, using
+ the format "Job x", where <b>x</b> is a index number.</P>
+ <LI><P><b>Demo file:</b> obviously you have to specify the demo
+ file here</P>
+ <LI><P><b>Start second</b> and <b>end second</b> are self-explanatory</P>
+ <LI><P><b>Exec before capture:</b> Here you have the chance to
+ enter console commands (that is, commands that you could otherwise
+ also enter into the console of the game). One example could be to
+ execute a config here that will make sure that the HUD is hidden. Or
+ you might want to change the FPS for the rendered video by setting
+ cl_capturevideo_fps to another value. If you want to put several
+ commands in here you can either separate them by a new-line, or by ;
+ (semi-colon)</P>
+ <LI><P><b>Exec after capture:</b> works like the "exec
+ before capture" field. Can be used for anything, e.g. Restoring
+ settings that you altered in the exec before field.</P>
+ <LI><P><b>Video destination:</b> Here you have to specify where
+ you want the recorded video file to be moved once the recording
+ process is done. Please note that you have to enter a name for the
+ file, however you should not enter the extension (.avi or .ogv). You
+ don't have to, because the Nexuiz demo recorder will automatically
+ figure out whether the Nexuiz engine generated an avi or ogv file,
+ and will keep its ending when moving the file to its destination.</P>
+</UL>
+<P>Once you filled out all fields, click on create. In
+case you did something wrong with one of the fields, you will
+hopefully get an error message immediately, which allows you to
+correct the mistake. If nothing was filled out incorrectly the dialog
+should close and you should now see a "Job 1" in the job
+queue.</P>
+<P>In order to edit a job, either double-click on it, or
+right-click it and click on Edit</P>
+<H2>Step 3</H2>
+<P>Now that you have setup your first job, click on the
+<B>Start processing</B> button. After a short moment you should see
+Nexuiz opening. Don't be surprised if the "Loading" image
+appears for a long time. What you don't see is that Nexuiz is
+fast-forwarding your demo to the start time you specified, which can
+take some time. After that, once Nexuiz started and finished
+recording the stuff you wanted it to record, it should close
+automatically. The demo recorder should show you a new message dialog
+that it finished recording all jobs. The "Status" column of
+your first job should now be showing "done".</P>
+<H2>Trouble-shooting:</H2>
+<P>In case something went wrong, the status column of your job will
+show "error" (in the jobs table). In order to find out what the problem was,
+right-click on the job and click on "Show error message".
+The message dialog that pops up will hopefully help you to figure out
+what went wrong. If it is something that you think you can fix, do so
+(by editing the job settings), then right-click the job again and click on
+"Reset job status to waiting". This will set the status of the job to
+"waiting" again.</P>
+<H2>Job queue processing</H2>
+<P>You need to be aware that once you click on the <b>Start
+processing</b> button only the jobs with status "waiting" will be
+put into a queue and will be executed one after another. All other jobs
+(with status "error" or "done" will not be started.
+If an error occurs while processing one of the jobs this job will set its state to
+"error" and the next job in queue will be executed. That is, the behavior
+of the Nexuiz demo recorder is to continue working even if one or more individual
+jobs failed.</P>
+<P>In case you already have a job list with several
+jobs but you want to just record one particular job (even though all
+other jobs also have the state "waiting"), just right-click
+on the particular job and click on "Start job". Note that this only
+works if the Nexuiz demo recorder is currently not working on any other jobs.</P>
+<H2>Further reading</H2>
+<P>Congratulations, you managed your
+first steps using this program. You should read the other help
+chapters as well in order to be able to fully utilize the
+functionality of the program.</P>
+ </body>
+</html>
+
projects / xonotic / xonotic.git / blobdiff