Event Recorder

Event recorder is a tool for regression testing of game engines. It is used to record gameplay and play it back after engine update, to find does new version of engine works as previous. Record and playback process may be started from command line or from GUI.

Command line parameters

--record-mode sets in what mode event recorder will be runned. Possible values is

    record: begin gameplay recording
    playback: playback gameplay from previously created file
    info: output to console information about previously created record file in machine readable format

--record-file-name name of file to record or playback from.

--disable-display disable creation of sdl window and outputing of sdl context to screen. In playback mode output information of playback in machine-readable format to console.

Recorder dialog

It is used to manage records files, start recording and playback. To open recorder dialog you need to press shift in launcher to show alternative menu. After this you need to press "Record..." button. There is a list of gameplay records in recorder dialog. After choosing one of them, info about record will apear in right window. It includes author's name and notes about the record (optionally). There are few buttons under that list. Their functions:

Edit - shows dialog to change information of selected record (diaplay name, author and record notes)

Delete - remove selected record from filesystem

Cancel - return to launcher

Record - start event recorder in recording mode

Playback - start event recorder in playback mode

Control window

It is used to control process of recording or playback and have different functions on this modes. It overlays the game screen and can be dragged.

Playback functions:

Stop: halt playback and return to launcher

Switch to game: halt recording and play in normal mode

Fast forward: remove all delays and playback as fast as possible

Remark: in playback mode events recorder block all user input. To use control window you should press Ctrl+P to set pause in game

Record functions:

Stop: halt recording and return to launcher

Edit notes: change info about record (display name, author and notes)