mirror of
https://github.com/demostf/demo.js
synced 2026-06-04 00:54:14 +02:00
readme and main
This commit is contained in:
parent
869cec2c88
commit
4e002c4ebf
2 changed files with 30 additions and 1 deletions
28
README.md
Normal file
28
README.md
Normal file
|
|
@ -0,0 +1,28 @@
|
||||||
|
# demo.js
|
||||||
|
|
||||||
|
Parsing of TF2 demo files in node.js and the browser
|
||||||
|
|
||||||
|
## usage
|
||||||
|
|
||||||
|
###cli
|
||||||
|
|
||||||
|
```
|
||||||
|
node bin/analyse demo.dem
|
||||||
|
```
|
||||||
|
|
||||||
|
### api
|
||||||
|
|
||||||
|
```js
|
||||||
|
var Demo = require('tf2-demo');
|
||||||
|
var fs = require('fs');
|
||||||
|
|
||||||
|
fs.readFile("example.dem", function (err, data) {
|
||||||
|
if (err) throw err;
|
||||||
|
var demo = Demo.fromNodeBuffer(data);
|
||||||
|
var parser = demo.getParser();
|
||||||
|
var head = parser.readHeader();
|
||||||
|
console.log(head);
|
||||||
|
var body = parser.parseBody();
|
||||||
|
console.log(body);
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
@ -1,10 +1,11 @@
|
||||||
{
|
{
|
||||||
"name": "demos.js",
|
"name": "tf2-demo",
|
||||||
"description": "A parser for TF2 demo files",
|
"description": "A parser for TF2 demo files",
|
||||||
"version": "0.1.0",
|
"version": "0.1.0",
|
||||||
"bin": {
|
"bin": {
|
||||||
"demo-analyse": "./bin/analyse.js"
|
"demo-analyse": "./bin/analyse.js"
|
||||||
},
|
},
|
||||||
|
"main": "demo.js",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"bit-buffer": "icewind1991/bit-buffer",
|
"bit-buffer": "icewind1991/bit-buffer",
|
||||||
"minimist": "1.1.x"
|
"minimist": "1.1.x"
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue