=== HW2 .Arciv Pretty-Printer v1.12
=== Created: 01/09/06 by Mikail
=== Last updated: 04/17/06
=== Homepage: http://www.geocities.com/Area51/Quadrant/3864/homeworld.htm


================================================================


INTRODUCTION
This program reads .arciv files generated by ModPackager and 
then pretty-prints the files listed in them using HW2 Pretty 
Printer. 

DOWNLOAD
[url]http://www.geocities.com/Area51/Quadrant/3864/homeworld.htm[/url]

INSTALLATION
Extract the contents of this archive into a folder on your 
harddrive. This program requires that Windows Scripting Host 
v5.6 be installed. This program also requires that you have a 
copy of "HW2_PrettyPrinter.js" (also available from the above 
website).

Note: Windows Scripting Host v5.6 must be installed in order to 
use the Explorer and batch modes.

INSTRUCTIONS
1) Generate an .arciv file for the files you wish to compile 
   using ModPackager.
2) Run the program using the following command-line:

	cscript [script file] [p.p. path] [.arciv file] [[destination folder]] [[-s]]

   where:
	[script file] is the full path to "HW2_ArcivPretty.js".

	[p.p. path] is the full path to "HW2_PrettyPrinter.js".

	[.arciv file] is the full path to the .arciv file you 
	generated using ModPackager.

	[[destination folder]] (optional) is the path to the 
	folder where the reformatted files should be generated. 
	Any files in the destination folder will be 
	automatically overwritten. Use the "-a" switch, 
	instead, to if you want the files generated in the same 
	directory as the .arciv file. Or, use the "-o" switch, 
	instead, if you want to overwrite your source files. 
	If [[destination folder]] is ommitted entirely, a new 
	file will be created with the same name and in the same 
	directory as the original file, but with an additional 
	".pretty" extension.

	[[-s]] (optional) tells the pretty-printer to strip 
	comments from the source file.

	**IMPORTANT** if the process is interrupted before it 
	is complete, then there may be some garbage left over 
	in the source directory that will have to be deleted 
	manually. If overwriting source files, then the source 
	files may get overwritten with garbage.

Note: if HW2_PrettyPrinter encounters an error or gets stuck in 
an endless loop, it's OK to close the window. HW2 .Arciv Pretty-
Printer will simply continue on with the next file -- though 
you may have to remove a zero-byte file from the source 
directory if this happens.


================================================================


CHANGE LOG

v1.12
* Added support for the "-s" switch.

v1.11
* Fixed some of the message output.
* The program will now continue after printing an error if it 
  cannot find the file (due maybe to HW2_PrettyPrinter 
  encountering an error).
* The program now lists all the files that had errors.

v1.1
* Fixed a major bug related to variable scope that prevented 
  the program from iterating through the "Archive" table 
  properly.
* Slight restructuring of the code.
* Added verbose messages.
* Added debugging to file when the "MssgDebug" variable is set 
  to true.
* Minor changes to documentation.
* An error message is now printed if HW2_PrettyPrinter 
  encounters an error while processing the file.

v1.0
* Initial release.
