This wiki is archived and useful information is being migrated to the main bzflag.org website

Difference between revisions of "Recordmatch"

From BZFlagWiki
Jump to: navigation, search
(This was shipped, it's not a dev thing anymore)
 
(2 intermediate revisions by 2 users not shown)
Line 2: Line 2:
  
 
==Usage==
 
==Usage==
 +
Before trying to use this plug-in, [[Replay_Server#Recording_Setup|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:
 
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:
  
Line 20: Line 22:
  
 
* /countdown "Will start the match"
 
* /countdown "Will start the match"
* /gameover   "Will end the match immediately.  
+
* /gameover   "Will end the match immediately.  
 
* /timelimit X  "Allows player to change the time limit to X, where X is the number of seconds"
 
* /timelimit X  "Allows player to change the time limit to X, where X is the number of seconds"
  
Line 26: Line 28:
 
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.
 
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:Development]]
+
 
 
[[Category:Plug-Ins]]
 
[[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.