Difference between revisions of "Recordmatch"

From BZFlagWiki
Jump to: navigation, search
(Cleaning up this mess... let's use correct information and formatting, shall we?)
m (Alright, for real, I'm fixing things. This should look pretty good now.)
Line 2: Line 2:
  
 
==Usage==
 
==Usage==
When the airspawn is loaded it can take an [[Plug-ins#Parameters|optional parameter]] that represents the maximum height variance that will be applied to a spawn position. The default value is 10 [[world units]].  With the plugin loaded, the height above ground of tank spawns will be a random value between 0 and the maximum value. The usage is (for Windows and *Nix, respectively):
+
When the recordmatch plugin is loaded, it waits for a match game to be started. When a game is started, it will create a new file to store the recording, named with the current date and time. When the game is ended, it will stop recording and close the file. The usage is (for Windows and Unix-based systems, respectively):
  
 
  -loadplugin "X:\path\to\the\plugin\recordmatch.dll"
 
  -loadplugin "X:\path\to\the\plugin\recordmatch.dll"
  -loadplugin "/path/to/the/plugin/recordmatch.so"
+
  -loadplugin "/path/to/the/plugin/recordmatch"
  
or in an already running game (for Windows and *Nix, respectively):
+
or in an already running game (for Windows and Unix-based systems, respectively):
  
 
  /loadplugin "X:\path\to\the\plugin\record.dll"
 
  /loadplugin "X:\path\to\the\plugin\record.dll"
  /loadplugin "/path/to/the/plugin/recordmatch.so"
+
  /loadplugin "/path/to/the/plugin/recordmatch"
 
+
Examples:
+
 
+
-loadplugin "C:\Program Files\BZFlag2.0.8\recordmatch.dll"
+
-loadplugin "/usr/local/bzflag2.0.8/plugins/recordmatch.so"
+
  
 
The "-loadplugin" syntax is used in the [[sample conf|server configuration]] file or at the command line when invoking a game [[BZFS|server]].
 
The "-loadplugin" syntax is used in the [[sample conf|server configuration]] file or at the command line when invoking a game [[BZFS|server]].
  
 
==History==
 
==History==
The BZFS API was changed in the development of 2.0.6 to allow for recordings to be started. Recordmatch is the first plugin to use the newly-added capability.
+
The BZFS API was changed in the development of [[BZFlag 2.0.6|v2.0.6]] to allow for recordings to be started. Recordmatch is the first plugin to use the newly-added capability.
  
 
[[Category:Development]]
 
[[Category:Development]]
 
[[Category:Plug-Ins]]
 
[[Category:Plug-Ins]]

Revision as of 04:01, 25 May 2009

Recordmatch is a standard plug-in that is shipped with the source code. It allows for match games, such as league matches, to be recorded onto the server to be replayed later. It will automatically record when a game (match) is started, and it will record with a filename given by the current date and time. Recordmatch is included in v2.0.6 and later releases.

Usage

When the recordmatch plugin is loaded, it waits for a match game to be started. When a game is started, it will create a new file to store the recording, named with the current date and time. When the game is ended, it will stop recording and close the file. The usage is (for Windows and Unix-based systems, respectively):

-loadplugin "X:\path\to\the\plugin\recordmatch.dll"
-loadplugin "/path/to/the/plugin/recordmatch"

or in an already running game (for Windows and Unix-based systems, respectively):

/loadplugin "X:\path\to\the\plugin\record.dll"
/loadplugin "/path/to/the/plugin/recordmatch"

The "-loadplugin" syntax is used in the server configuration file or at the command line when invoking a game server.

History

The BZFS API was changed in the development of v2.0.6 to allow for recordings to be started. Recordmatch is the first plugin to use the newly-added capability.