Recent changes to Usage

Usage modified by Robert

Robert — Wed, 31 Jul 2013 00:42:28 -0000

--- v8
+++ v9
@@ -78,6 +78,14 @@
 Example input file:
 ------------

+> The regex option forces match-checking against all games - useful when a keyword based search might fail to find some results.  in the example below, we would have the keywords "dragons".  This will surely find matches with that keyword, but it will fail to find the user's intended matches: against "dragon" or "dragons".
+
+dragons? ---regex
+
+> The strict option is often necessary to limit otherwise vague match regexes.  "super c" would normally match games like "Super Commando".  Strict forces "C" to be the final character in the match (keep in mind anything in parentheses such as region or version is stripped from the match description).
+
+super c ---strict
+
 > Creates a "Sega Only" genre with all games that have "Sega" in the manufacturer tag

    +++Sega Only+++ ---manufacturer .*Sega.*

Usage modified by Robert

Robert — Wed, 31 Jul 2013 00:33:08 -0000

--- v7
+++ v8
@@ -58,13 +58,21 @@

 Match File Usage:
 ----------------
-Genres are designated by "++++++".  Ex. +++Sports Games+++.
+Genres are designated by "+++genre name+++".  Ex. +++Sports Games+++.

 Match Lines contain a case insensitive regular expression.  Ex. mario bro

-Genres can contain any of the above Genre-Level or Match-Line-Level options.  Match Lines can contain any of the above Match-Line-Level Options.  The only difference is that in the match file, options must be designated by a preceding "---" rather than "-".  Ex. ---manufacturer Sega
+Genres can contain any of the above Genre-Level or Match-Line-Level options.  Match Lines can contain any of the above Match-Line-Level Options.  The only difference is that in the match file, options must be designated by a preceding "---" rather than "-".  Ex. ---manufacturer Sega.

+Multiple options can be listed per line.  The program currently will not detect multiple options of the same type - it will just use the last one.  Ex.
+mario bro ---manufacturer Nintendo ---year 1980-1995

+Match-Line-Level Options applied to a Genre are passed down to each MatchLine; however each Match Line can explicitly override these options.  Ex.
++++Example+++ ---year 1999
+overrides the example option ---year false
+also overrides the example option ---year 1990-2000
+
+See examples below.

 Example input file:

Usage modified by Robert

Robert — Wed, 31 Jul 2013 00:25:08 -0000

--- v6
+++ v7
@@ -56,51 +56,65 @@
   -year year_to_match|min_year-max_year|false  
 Year tag must be = or in range

+Match File Usage:
+----------------
+Genres are designated by "++++++".  Ex. +++Sports Games+++.
+
+Match Lines contain a case insensitive regular expression.  Ex. mario bro
+
+Genres can contain any of the above Genre-Level or Match-Line-Level options.  Match Lines can contain any of the above Match-Line-Level Options.  The only difference is that in the match file, options must be designated by a preceding "---" rather than "-".  Ex. ---manufacturer Sega
+
+
+

 Example input file:
 ------------

+> Creates a "Sega Only" genre with all games that have "Sega" in the manufacturer tag
+
    +++Sega Only+++ ---manufacturer .*Sega.*
    .* ---regex

-> Creates a "Sega Only" genre with all games that have "Sega" in the manufacturer tag
+> Creates an "Arcade" genre that matches pretty much any Pac-Man variation: PacMan, Pac Man, Pac-Man, or Pac_Man...or Ms. Pac-Man

    +++Arcade+++
    pac\[ -_\]?man

-> Creates an "Arcade" genre that matches pretty much any Pac-Man variation: PacMan, Pac Man, Pac-Man, or Pac_Man...or Ms. Pac-Man
+
+> Create a "Retro" genre that matches all games whose year falls between 1960 and 1982

    +++Retro+++ ---year 1960-1982
    .* ---regex

-> Create a "Retro" genre that matches all games whose year falls between 1960 and 1982
+> Create a "Bullet Hell" genre that matches all games by Cave in the Shooter or Shoot-em-up genres

    +++Bullet Hell+++ ---genre Shoot.*
    .* ---regex ---manufacturer .*Cave.*

-> Create a "Bullet Hell" genre that matches all games by Cave in the Shooter or Shoot-em-up genres
+
+> Genre "Ambiguous Shooters" only matches games with genre "Shooter" that have star, pilot, or battle in the title

    +++Ambiguous Shooters+++ ---genre Shooter
    star
    pilot
    battle

-> Genre "Ambiguous Shooters" only matches games with genre "Shooter" that have star, pilot, or battle in the title
+
+> "Originals Only will not match Street Fighter II or Gradius II, etc. - only the original Gradius and Street Fighter

    +++Originals Only+++ ---noseq
    gradius
    street fighter

-> "Originals Only will not match Street Fighter II or Gradius II, etc. - only the original Gradius and Street Fighter
+
+> All games with Street Fighter in the title, sorted by year

    +++Sort by Year+++ ---sort year
    street fighter

-> All games with Street Fighter in the title, sorted by year
+> Good Options for Top ___ lists - output appears in order listed, and output is numbered.  Also, the unique option scores each match for each match line and only uses the "best" match.

    +++Top 3+++ ---numbered ---sort false ---unique
    ms.*pac\[ -_\]?man
    asteroids
    missile command
-
-> Good Options for Top ___ lists - output appears in order listed, and output is numbered.  Also, the unique option scores each match for each match line and only uses the "best" match.

Usage modified by Robert

Robert — Wed, 31 Jul 2013 00:18:21 -0000

--- v5
+++ v6
@@ -62,29 +62,45 @@

    +++Sega Only+++ ---manufacturer .*Sega.*
    .* ---regex
+
+> Creates a "Sega Only" genre with all games that have "Sega" in the manufacturer tag

    +++Arcade+++
-   pac[ -_]?man
+   pac\[ -_\]?man
+
+> Creates an "Arcade" genre that matches pretty much any Pac-Man variation: PacMan, Pac Man, Pac-Man, or Pac_Man...or Ms. Pac-Man

    +++Retro+++ ---year 1960-1982
    .* ---regex
+
+> Create a "Retro" genre that matches all games whose year falls between 1960 and 1982

    +++Bullet Hell+++ ---genre Shoot.*
    .* ---regex ---manufacturer .*Cave.*
+
+> Create a "Bullet Hell" genre that matches all games by Cave in the Shooter or Shoot-em-up genres

    +++Ambiguous Shooters+++ ---genre Shooter
    star
    pilot
    battle
+
+> Genre "Ambiguous Shooters" only matches games with genre "Shooter" that have star, pilot, or battle in the title

    +++Originals Only+++ ---noseq
    gradius
    street fighter
+
+> "Originals Only will not match Street Fighter II or Gradius II, etc. - only the original Gradius and Street Fighter

    +++Sort by Year+++ ---sort year
    street fighter

+> All games with Street Fighter in the title, sorted by year
+
    +++Top 3+++ ---numbered ---sort false ---unique
-   ms.*pac[ -_]?man
+   ms.*pac\[ -_\]?man
    asteroids
    missile command
+
+> Good Options for Top ___ lists - output appears in order listed, and output is numbered.  Also, the unique option scores each match for each match line and only uses the "best" match.

Usage modified by Robert

Robert — Wed, 31 Jul 2013 00:10:54 -0000

--- v4
+++ v5
@@ -1,6 +1,6 @@
 usage: 
 ----------------
-java -jar HSxmlMaker.jar path regexFilename xmlFilename
+java -jar HSxmlMaker.jar path matchFileName xmlFileName

 Run-level Options:
 ----------------------------------

Usage modified by Robert

Robert — Wed, 31 Jul 2013 00:10:17 -0000

--- v3
+++ v4
@@ -1,4 +1,5 @@
 usage: 
+----------------
 java -jar HSxmlMaker.jar path regexFilename xmlFilename

 Run-level Options:

Usage modified by Robert

Robert — Wed, 31 Jul 2013 00:09:55 -0000

--- v2
+++ v3
@@ -1,27 +1,63 @@
 usage: 
-HSxmlMaker.exe path regexFilename xmlFilename
+java -jar HSxmlMaker.jar path regexFilename xmlFilename
+
 Run-level Options:
-  -noFullList            Only create genre XML files
-  -noGenres              Only create one XML file with all roms
+----------------------------------
+  -noFullList            
+Only create genre XML files
+
+  -noGenres              
+Only create one XML file with all roms
+
 Genre-level Options - passed to each genre unless overridden
-  -createMissing \[false\] If no XML line matches regex, new xml line is created
-  -noClones [false]      Exclude Clones from output XML Files
-  -sort [name|descr|genre|manufacturer|year|rating|false] Output according to key (false for input file order)
-  -numbered [false|desc] Add ascending [or descending] nbr to game descr; ex. top 10
+----------------
+  -createMissing \[false\] 
+If no XML line matches regex, new xml line is created
+
+  -noClones \[false\]      
+Exclude Clones from output XML Files
+
+  -sort \[name|descr|genre|manufacturer|year|rating|false\] 
+Output according to key (false for input file order)
+
+  -numbered \[false|desc\] 
+Add ascending [or descending] nbr to game descr; ex. top 10
+
 Match Line-level options - passed to each match line unless overridden
-  -noseq [false]         Do not match sequels (has 0-9, incl roman numerals, in title)
-  -nomatchclone [false]  Do not match clones
-  -loose [false]         Replace all spaces with wildcard \".*\"
-  -strict [false]        Do not add leading and trailing wildcards \".*\"
-  -any [false]           Match if any of given keywords match
-  -unique [false]        Find best match only
-  -regex [false]         Process as regex against all Game Descriptions
-  -genre genre_regex|false                     Genre tag must match regex
-  -manufacturer manufacturer_regex|false       Manufacturer tag must match regex
-  -year year_to_match|min_year-max_year|false  Year tag must be = or in range
+-----------------------------
+  -noseq \[false\]         
+Do not match sequels (has 0-9, incl roman numerals, in title)
+
+  -nomatchclone \[false\]  
+Do not match clones
+
+  -loose \[false\]     
+Replace all spaces with wildcard \".*\"
+
+  -strict \[false\]        
+Do not add leading and trailing wildcards \".*\"
+
+  -any \[false\]           
+Match if any of given keywords match
+
+  -unique \[false\]        
+Find best match only
+
+  -regex \[false\]         
+Process as regex against all Game Descriptions
+
+  -genre genre_regex|false                     
+Genre tag must match regex
+
+  -manufacturer manufacturer_regex|false       
+Manufacturer tag must match regex
+
+  -year year_to_match|min_year-max_year|false  
+Year tag must be = or in range

 Example input file:
+------------

    +++Sega Only+++ ---manufacturer .*Sega.*
    .* ---regex

Usage modified by Robert

Robert — Wed, 31 Jul 2013 00:05:37 -0000

--- v1
+++ v2
@@ -4,7 +4,7 @@
   -noFullList            Only create genre XML files
   -noGenres              Only create one XML file with all roms
 Genre-level Options - passed to each genre unless overridden
-  -createMissing [false] If no XML line matches regex, new xml line is created
+  -createMissing \[false\] If no XML line matches regex, new xml line is created
   -noClones [false]      Exclude Clones from output XML Files
   -sort [name|descr|genre|manufacturer|year|rating|false] Output according to key (false for input file order)
   -numbered [false|desc] Add ascending [or descending] nbr to game descr; ex. top 10

Usage modified by Robert

Robert — Wed, 31 Jul 2013 00:05:12 -0000

usage:
HSxmlMaker.exe path regexFilename xmlFilename
Run-level Options:
-noFullList Only create genre XML files
-noGenres Only create one XML file with all roms
Genre-level Options - passed to each genre unless overridden
-createMissing [false] If no XML line matches regex, new xml line is created
-noClones [false] Exclude Clones from output XML Files
-sort [name|descr|genre|manufacturer|year|rating|false] Output according to key (false for input file order)
-numbered [false|desc] Add ascending [or descending] nbr to game descr; ex. top 10
Match Line-level options - passed to each match line unless overridden
-noseq [false] Do not match sequels (has 0-9, incl roman numerals, in title)
-nomatchclone [false] Do not match clones
-loose [false] Replace all spaces with wildcard \".\"
-strict [false] Do not add leading and trailing wildcards \".\"
-any [false] Match if any of given keywords match
-unique [false] Find best match only
-regex [false] Process as regex against all Game Descriptions
-genre genre_regex|false Genre tag must match regex
-manufacturer manufacturer_regex|false Manufacturer tag must match regex
-year year_to_match|min_year-max_year|false Year tag must be = or in range

Example input file:

+++Sega Only+++ ---manufacturer .Sega.
.* ---regex

+++Arcade+++
pac[ -_]?man

+++Retro+++ ---year 1960-1982
.* ---regex

+++Bullet Hell+++ ---genre Shoot.
. ---regex ---manufacturer .Cave.

+++Ambiguous Shooters+++ ---genre Shooter
star
pilot
battle

+++Originals Only+++ ---noseq
gradius
street fighter

+++Sort by Year+++ ---sort year
street fighter

+++Top 3+++ ---numbered ---sort false ---unique
ms.*pac[ -_]?man
asteroids
missile command