CSSZombieEscape
/
demboyz
7
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Updated readme with usage instructions

This commit is contained in:
Jordan Cristiano 2015-09-05 22:26:24 -04:00
parent f73338fef8
commit 0cd4b38bd1
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -3,6 +3,28 @@ demboyz
we dem boyz
### What is it?
Demboyz is a command line tool to convert TF2 STV demos into a human readable json format.
It supports the following conversions:
.dem/.json <-> .dem/.json
.dem/.json -> .con
The .dem format is the TF2 STV demo format.
The .json format is the demboyz streaming json demo format.
The .con format is a log equal to what would be produced by TF2
with netmessage/demmessage logs enabled.
### Usage
./demboyz mystvdemo.dem mystvdemo.json
./demboyz mystvdemo.dem mystvdemo.con
./demboyz mystvdemo.json mystvdemo.dem
./demboyz mystvdemo.json mystvdemo.con
In the first example, mystvdemo.dem will be read from the current working directory, while mystvdemo.json will be written to the current working directory.
### Using Vagrant