From 35959f8b7dac34f361049be35b4abfeddc2d78e7 Mon Sep 17 00:00:00 2001 From: atom0s Date: Fri, 13 Jan 2017 23:34:54 -0800 Subject: [PATCH] Updated read me file. --- README.md | 40 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 39 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5f27f58..35bad4f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,41 @@ # DashCam -DashCam allows players to record in-game video with ease. \ No newline at end of file +DashCam allows players to record in-game video with ease. + +Videos will be saved to your Ashita folder within the /videos/ directory. + +Videos are named in the following format: + +``` +charname_year.day.month_hhmmss.avi +``` + +# Commands + +DashCam currently includes the following commands: + + * /dashcam start [codec] [fps] [quality] - *Starts a recording.* + * /dashcam stop - *Stops a recording.* + * /dashcam codec - *Lists the available codecs.* + * /dashcam codecs - *Lists the available codecs.* + +DashCam will respond to the following commands: + * /dashcam + * /record + * /video + +You can use any three of these with the commands above (ie. /record stop). + +# Codecs + +DashCam allows you to use the encoding codec of your choice that is installed on your system. +This allows users to customize the way they record things in the encoding type of their preference. + +Please note: + + * DashCam is not guaranteed to work with all codecs! + * DashCam may have adverse effects with some codecs! + * Some codecs may use more CPU than others. Please be mindful not to fry your hardware using an intensive codec! + +By default, DashCam will try to make use of XVid. You can download the official XVid codec here: +https://www.xvid.com/ \ No newline at end of file