Skip to content
Browse files

Add configuration information to the README

  • Loading branch information...
1 parent 9b8c137 commit 70a41dd9ea62cf5ddd6c4716618302011bec048c Mike Kenyon committed Apr 16, 2012
Showing with 29 additions and 0 deletions.
  1. +29 −0 README.md
View
29 README.md
@@ -3,6 +3,11 @@ MapRotation
Builds a new map rotation file for hl2-based games
+Installation
+------------
+
+ gem install map-rotation
+
Usage
-----
@@ -13,8 +18,32 @@ The possible options are:
-v, --verbose print the maplist to STDOUT as well as to file
--dump-config print out current configuration and exit
+
+Configuration
+-------------
+
To start building a configuration fie, run `map-rotation --dump-config >
map-rotation.yaml` and edit it. The config file is a YAML file that specifies
the tiers of maps and how many maps to select from each tier. It also has a
few configuration options for map-rotation itself, but those are all specified
when you dump the config.
+
+A sample config:
+
+ ---
+ - tiers:
+ - choose: 2
+ maps:
+ - pl_goldrush
+ - cp_dustbowl
+ - pl_badwater
+ - choose: 1
+ maps:
+ - tc_hydro
+ - plr_hightower
+ - verbose: true
+ - targetFile: /path/to/desired/mapcycle.txt
+
+This will make a map list with three maps: two from the first tier and
+one from the second. The `verbose` key will make map-rotation print out
+the map list to STDOUT in addition to writing it to a file.

0 comments on commit 70a41dd

Please sign in to comment.
Something went wrong with that request. Please try again.