Skip to content

Commit

Permalink
feat: introduced new parser output schema (#8)
Browse files Browse the repository at this point in the history
  • Loading branch information
PBug90 authored Dec 30, 2018
1 parent 06722a8 commit 80d6b28
Show file tree
Hide file tree
Showing 8 changed files with 2,408 additions and 86 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,24 +10,27 @@ This parser is aimed to be more modular than other parsers.
You can easily add your custom action parsing logic by overriding the processTimeSlot() function
of a W3GReplay instance.

** It does not fully support replays of game version <= 1.14. **
**It does not fully support replays of game version <= 1.14.**

## Usage
```javascript
//assuming that you cloned this repo into your project
//sorry, no npm yet ;)
const W3GReplay = require('./w3gjs')
const Parser = new W3GReplay()
const replay = Parser.parse('./replays/sample1.w3g')
```

### example output of the observers.w3g example replay:
```javascript
To be updated.
```
### Example output of the observers.w3g example replay
Check the example_output.json file in the root of this repository.

### Example demo app
You can see the parser in action here and parse your own replays aswell:
https://enigmatic-springs-58797.herokuapp.com/

## Contributing
There is no point in hiding the implementation of tools that the community can use. So please feel free to discuss in the issues section or provide a pull request if you think you can improve this parser.

## Issues
If you have an issue using this library please use the issue section and provide an example replay file.

## License

Expand Down
Loading

0 comments on commit 80d6b28

Please sign in to comment.