example.js

/* eslint no-console: [0] */

const fs = require('fs')
const ReplayParser = require('./index.js')

const reppi = fs.createReadStream(process.argv[2])
  .pipe(new ReplayParser())

reppi.pipeChk(fs.createWriteStream('scenario.chk'))

reppi.on('replayHeader', header => {
  const {
    gameName,
    mapName,
    gameType,
    gameSubtype,
    players,
    durationFrames,
    seed,
  } = header
  console.log(`${gameName} on ${mapName} (Game type ${gameType}, ${gameSubtype})`)

  // Seed is just generated with C stdlib `time()`, so it can be used to figure out timestamp.
  const date = new Date(seed * 1000)
  console.log(`Played on ${date.toLocaleString()}`)

  const minutes = Math.floor(durationFrames / 24 / 60)
  const seconds = Math.floor(durationFrames / 24) % 60
  console.log(`Duration: ${minutes}:${seconds}`)
  for (const { name, id, race, team, isComputer } of players) {
    if (isComputer) {
      console.log(`Computer ${name} (${id}): Race ${race}, team ${team}`)
    } else {
      console.log(`Player ${name} (${id}): Race ${race}, team ${team}`)
    }
  }
})

// `ReplayParser` is a `Transform` stream, which transforms binary data to replay actions.
// But if we arent't interested in actions, we'll need to call `reppi.resume()`, explicity.
reppi.on('data', ({ id, frame, player }) => {
  const name = ReplayParser.commands()[id].name
  console.log(`Command ${name} @ frame ${frame} for player ${player}`)
})

reppi.on('error', err => {
  console.log(`An error occured: ${err} ${err.stack}`)
})
reppi.on('end', () => {
  console.log('Done')
})

reppi.scrSection('SKIN', 0xaf * 2 * 16, skinData => {
  console.log(`0x${skinData.length.toString(16)} bytes of skin data`)
})
reppi.scrSection('LMTS', 0x1c, limits => {
  console.log('Limits:')
  console.log(`  Images: ${limits.readUInt32LE(0)}`)
  console.log(`  Sprites: ${limits.readUInt32LE(4)}`)
  console.log(`  Thingies(?): ${limits.readUInt32LE(8)}`)
  console.log(`  Units: ${limits.readUInt32LE(0xc)}`)
  console.log(`  Bullets: ${limits.readUInt32LE(0x10)}`)
  console.log(`  Orders: ${limits.readUInt32LE(0x14)}`)
  console.log(`  Fog sprites(?): ${limits.readUInt32LE(0x18)}`)
})
reppi.scrSection('BFIX', 0x8, bfix => {
  console.log(`BFIX: ${bfix.toString('hex')}`)
})
reppi.scrSection('CCLR', 0xc0, colors => {
  console.log(`Custom color: ${colors.length} bytes`)
})