Skip to contents

Imports the macros of gz, a practice version of the Nintendo 64 game The Legend of Zelda: Ocarina of Time, with one row per recorded game update. player() returns the N64 buttons. analog_channels() retains signed left_x and left_y; analog selects a derived stick representation.

Usage

read_gzm(
  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 compact digital columns and source metadata.

Details

frame_fields retains pad deltas and press/release masks. system_events retains random-seed changes and any ocarina-input, audio-synchronisation, or room-load records. The commands component marks reset events, and source_packets retains the six-byte input records. Game updates provide the observation order; elapsed time requires the game's update timing.

Examples

movie <- read_gzm(system.file("extdata", "legacy", "buttons.gzm", package = "replayr"))
observation_unit(movie)
#> [1] "game update"
head(analog_channels(movie), 3)
#>      left_x left_y
#> [1,]   -128      0
#> [2,]    -64      0
#> [3,]      0      0