From 0cd4b38bd1803dbfdb8c33e2ca3573eda904c0cd Mon Sep 17 00:00:00 2001 From: Jordan Cristiano Date: Sat, 5 Sep 2015 22:26:24 -0400 Subject: [PATCH] Updated readme with usage instructions --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index 9b79265..c068d26 100644 --- a/README.md +++ b/README.md @@ -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