Skip to content

Commit

Permalink
Rollup StormLib to v9.21
Browse files Browse the repository at this point in the history
  • Loading branch information
jnovack committed Jun 11, 2020
1 parent fc4cdfa commit 63c9e86
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 7 deletions.
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,22 @@
storm-replay
============

![Works with Node 8](https://img.shields.io/badge/node%20v8-%20%E2%9C%94-brightgreen)
![Works with Node 10](https://img.shields.io/badge/node%20v10-%20%E2%9C%94-brightgreen)
![Does NOT work with Node 12](https://img.shields.io/badge/node%20v12-%20%E2%9D%8C-critical)
![Does NOT work with Node 14](https://img.shields.io/badge/node%20v14-%20%E2%9D%8C-critical)

***2018-12 Update** Since Blizzard has decided to effectively kill Heroes of the Storm by ending all competitive esports entirely, shifting developers off the game, and “changing the cadence” of updates, I have no longer cared about the game and have halted all development. Shame, as it was a beloved game for me, but seeing as they completely dropped by the ball by failing to bring the game to market in a timely manner to compete in the MOBA space, my updates to this project will be considered few and very far between.*

NodeJS wrapper for StormLib (https://github.com/ladislav-zezula/StormLib) for
parsing Heroes of the Storm replay files (`.StormReplay`).

This is a backend library designed for speedy extraction of files. In tests
against the javascript library, extraction times improved nearly 60%.

# API
## API

## .getHeader(Archive)
### .getHeader(Archive)

Retrieve the MPQ Header information for the `Archive`. This header includes
the all important build information for parsing.
Expand All @@ -32,7 +39,7 @@ other data provided, `.err` and `.content.size`, is there for validation.
};
```

## .extractFile(Archive, File)
### .extractFile(Archive, File)

Extract `File` from `Archive` as a buffer.

Expand All @@ -49,7 +56,7 @@ provided, `.err` and `.content.size`, is there for validation.
};
```

## .removeMessages(Archive)
### .removeMessages(Archive)

Remove `replay.message.events` from the archive.

Expand All @@ -64,11 +71,11 @@ issue.
return bool;
```

# TODO
## TODO

* Currently, the build is only working on OSX and Linux.

# References
## References

* http://www.zezula.net/en/mpq/stormlib.html
* http://sagivo.com/post/130207525903/nodejs-addons
Expand Down

0 comments on commit 63c9e86

Please sign in to comment.