Difference between revisions of "Recordmatch"

From BZFlagWiki
Jump to: navigation, search
(This was shipped, it's not a dev thing anymore)
 
(10 intermediate revisions by 6 users not shown)
Line 1: Line 1:
If you run a match server or a server with countdown you have to use all the time '''/record'''... It you load the plugin, you dont need that. The plugin is recording automatically the match.
+
Recordmatch is a standard [[Plug-ins|plug-in]] that is shipped with the [[BZFlag Source|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 [[BZFlag 2.0.6|v2.0.6]] and later releases.
  
'''1.'''
+
==Usage==
'''Add''' in your '''config''' option '''-loadplugin patch/to/recordmatch.dll'''    '''or''' use   '''/loadplugin patch/to/recordmatch.dll'''.
+
Before trying to use this plug-in, [[Replay_Server#Recording_Setup|configure]] bzfs to support recording.
  
'''2.'''
+
When the recordmatch plug-in 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 plug-in is loaded in the same way as any other and takes no parameters:
Start the match (Use /countdown)
+
  
'''3.'''
+
-loadplugin "/path/to/the/plugin/recordmatch"
Just '''play''' the '''match'''. '''The plugin''' is '''recording''' the '''match'''.
+
  
 +
or with the in game commands if the server is already running:
  
The records are '''saved under'''
+
/loadplugin "/path/to/the/plugin/recordmatch"
e.g.: '''match-20080824-211216'''                                                          The Match was '''saved at 24.08.2008 at 21:12:16'''
+
  
 +
The "-loadplugin" syntax is used in the [[sample conf|server configuration]] file or at the command line when invoking a game [[BZFS|server]].
  
 +
Be sure that you have in the configuration file:
 +
* -time X (Where X is the number of seconds of a match)
 +
* -timemanual
  
 +
==Commands==
 +
For most match servers for leagues the players will have the following commands:
  
 +
* /countdown "Will start the match"
 +
* /gameover    "Will end the match immediately.
 +
* /timelimit X  "Allows player to change the time limit to X, where X is the number of seconds"
  
If you '''want to see the match''' use at your replay server '''command /replay'''
+
==History==
 +
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 plug-in to use the newly-added capability.
 +
 
 +
 
 +
[[Category:Plug-Ins]]

Latest revision as of 08:27, 10 February 2013

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[edit]

Before trying to use this plug-in, configure bzfs to support recording.

When the recordmatch plug-in 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 plug-in is loaded in the same way as any other and takes no parameters:

-loadplugin "/path/to/the/plugin/recordmatch"

or with the in game commands if the server is already running:

/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.

Be sure that you have in the configuration file:

  • -time X (Where X is the number of seconds of a match)
  • -timemanual

Commands[edit]

For most match servers for leagues the players will have the following commands:

  • /countdown "Will start the match"
  • /gameover "Will end the match immediately.
  • /timelimit X "Allows player to change the time limit to X, where X is the number of seconds"

History[edit]

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