Skip to contents

Reads WTF files with the 66 54 77 02 signature and the equivalent HGM extension. Each frame stores up to eight Windows virtual-key codes; the first zero ends its list of held keys.

Usage

read_wtf(
  path,
  analog = "raw",
  deadzone = NULL,
  triggers = "raw",
  aliases = TRUE,
  ...
)

Arguments

path

Recording file path.

analog

Stick representation: "raw" (default), "cardinal4", "cardinal8", "angle", or "angle+magnitude". A scalar applies to both sticks; c(left = "cardinal8", right = "angle") selects them independently. Cardinal modes add separate left/right logical direction columns. Continuous modes return numeric fields through stick_channels(). Original X/Y values remain in analog_channels() in every mode. Absent sticks add no columns.

deadzone

Radial threshold in centred axis half-range units, from zero to one. One value applies to both sticks; named left/right values are allowed. NULL uses the default of the controller, whichever emulator recorded it: 0.125 for the sticks of Nintendo's consoles (Nintendo 64, GameCube, Wii extensions, 3DS) and 0.25 for all other sticks. The first is close to the 15 of 128 units that the GameCube's controller library discards on each axis (PAD_Clamp in libogc). The second covers the resting position of a released PlayStation stick, up to about 32 of 128 units from the centre (psx-spx), and is close to the 7849 and 8689 of 32767 that Microsoft gives for the thumbsticks of PC gamepads (XInput). A game applies a threshold of its own, which the recording does not store; give that value to study one game. Neutral observations have no direction and an NA angle. Magnitude is kept.

triggers

"raw" (default) or "digital". For DTM, digital additionally projects each analogue trigger at 128/255 into separate L2/R2 columns. Hardware L/R click bits remain distinct from thresholded analogue triggers.

aliases

TRUE (default) places the controls of a recording under the shared IDs that button_layout() describes. With FALSE, a control that would be placed under another control's ID keeps the key of its source, so every control of the recording has a column of its own and no two are combined.

...

Reader-specific arguments, such as controller_order for M64 or DTM, or member for a recording inside a ZIP archive (see movie_members()).

Value

A replayr_movie with keyboard states and source metadata.

Details

Each row is a recorded frame. movie$header$fps contains the recorded nominal frame rate; initial_time and clock_checks retain the emulator's clock metadata. The header also includes the keyboard layout, executable name, and Hourglass revision.

button_layout() identifies keys by their hexadecimal virtual-key code: for example, windows_vk_25 is Left and windows_vk_41 is A. movie$source_keycodes retains all eight source bytes for every frame, and movie$source_header retains the original 1024-byte header.

Examples

movie <- read_wtf(system.file("extdata", "computers", "keyboard-jump.wtf", package = "replayr"))
# Keyboard keys keep the codes of the recording.
button_layout(movie)[, c("id", "name")]
#>                      id           name
#> 1 control:windows_vk_20 Keyboard Space
#> 2 control:windows_vk_27 Keyboard Right
as.data.frame(movie)
#>   observation windows_vk_20 windows_vk_27 commands
#> 1           1         FALSE          TRUE        0
#> 2           2          TRUE          TRUE        0
#> 3           3          TRUE          TRUE        0
#> 4           4         FALSE          TRUE        0
#> 5           5         FALSE         FALSE        0