xnocken/replay-reader

The only libary that can parse 99% (or more) of fortnite replays.

Fortnite Replay Parser

The only libary that can parse 100% of fortnite replays.

Documentation

• Settings
• Add own Exports
• Streaming
• Example project

Prerequisites

• Node 14+

Installation

npm i fortnite-replay-parser  

or

yarn add fortnite-replay-parser

Code Example

Writing code with this library is pretty straight-forward as there is only one function.

The function takes two arguments:

1. The buffer of the replay file, which can easily be obtained by using fs.
2. (optional) A config that allows you to customize some things (e.g. parseLevel).

const fs = require('fs');
const parseReplay = require('fortnite-replay-parser');
const replayBuffer = fs.readFileSync('your.replay');

const config = {
  parseLevel: 10,
  debug: true,
}

parseReplay(replayBuffer, config).then((parsedReplay) => {
  fs.writeFileSync('replayData.json', JSON.stringify(parsedReplay));
}).catch((err) => {
  console.error('An error occured while parsing the replay!', err);
});

Optimizing Runtime

You (very) often don't need all of the data that is parsed, which is why there is an option that lets you specify which data you want to parse. It will also greatly improve the parser's speed. The tutorial on how to do that is here.

Tip

If you're using Node v14 or v15 you have to start process with --experimental-wasm-simd

replay-reader's Issues

Also not an issue, but a question

Would you happen to know how to get these files from a console? Or do you have any suggestions on where to look to figure that out myself? I'm not sure if I am using the wrong search terms or what but I can't seem to find anything.

Some map objects don't match the regex

E.g.

Tiered_Ammo_Athena111_5
Tiered_Ammo_Athena112

This does not always match the regex: "mapObjectName": "Tiered_Ammo_Athena\\d+_\\d+",

Inconsistent check regarding static actors

Had a read through to help teach myself a bit more about static actors and bumped into this check which seems to not be a valid check for isNumber since the || will allow many many many conditions.

replay-reader/src/utils/clean-static-id-suffix.ts

Line 3 in d1622a2

const isNumber = id[i] >= '0' || id[i] <= '9';

Not an issue, just my own incompetence!

I get this error about ooz-wasm...

Uncaught Error Error: Cannot find module 'ooz-wasm'

I'm more of a python coder, so I honestly cannot figure out how to add the ooz-wasm module so replay-reader can find it.

Sorry if I'm asking something very basic...

Can't get `UniqueId`

Starting from C4S4, I can't get UniqueId from the replay files.
Could you please address this issue so I can get the UniqueId again?

Not issue but question

Hello, how can i get player placement from json ? i cant find it. Thank you so much

v2 changes

Features

• Add onActorCreate event
• Allow multiple states objects per nfe
• Allow multiple export objects per nfe
• Allow states to be an array
• Only create state entry if exportGroup is empty
• Add handleAsName max depth setting to nfe
• Make path array or string in nfe
• Add an option to disable chunks export
• Add Missing Events
• Restructure events for easier access
• Use customExportName for references withon nfes
• Add version validation
• Extra thread for downloading
• Add setting overrides for different version types

Bugs

• VehicleSeatComponent has a lower parse level than vehicle
• Look into receiveNetFieldExportsCompat
• Partial path does not work with static objects
• Check checkpoints
• Check older versions
• storeAsHandleMaxDepth gets overwritten by undefined if its set to 0
• logger is undfined while parse level check

Other

• Documentation
• Change handleExports settings name
• Remove useless properties from NFEs
• Rename files
• Remove unused files and variables
• Adjust NFE Validation
• Typescript rewrite
• Improve nfe
• Add classes and enums to cache so it can be easily accessed and overwritten
• Store export name in nfe
• Improve typings that they show only valid options in nfes

If player is a bot, BotUniqueId is empty

Thanks for your awesome work on this project.

I am having an issue getting Bot player IDs.

If a player is a bot, they do not have a "UniqueId" property, instead it's "BotUniqueId".

I can't work out how to get "BotUniqueId" to pass. If I replace this line with BotUniqueId, the BotUniqueId's come through, but not the real PlayerIds.

Any suggestions @xNocken?

Thanks!