------------------------------------------------------------------------------
 Heroine Anthem II Toolkit                                        version 1.0
 Written by Derrick Sobodash                                   Copyright 2007
 Released on June 5, 2007                      http://www.cinnamonpirate.com/
------------------------------------------------------------------------------

 INFORMATION

 I began the Heroine Anthem II translation project in 2004 when I purchased
 the game from YesAsia, who was selling the game at the time. Unfortunately,
 in 2005, I got a new computer and the game became unplayable.

 Heroine Anthem II: The Angel of Sarem, is one of several games protected by
 StarForce 3. For those unfamiliar with the protection industry, StarForce 3
 is a rootkit which hooks into your machine at kernel load and intercepts
 all activity with your ATAPI CD-ROM device. Unfortunately, it breaks on
 many "odd" setups, and often takes Windows with it. My Gateway laptop which
 I purchased in 2005 is one of these "odd" setups.

 I was never able to run the game again, and honestly, even if I could
 suddenly run it again, I no longer have the stamina to beat my way through
 another translation.

 This archive is a release of my complete toolkit, along with the script
 dumps for this game. The archive is considered public domain. I am unsure
 what license my bitmap dump of the Solaris console font falls under, so
 you should be careful with how you treat that.

 If you translate Heroine Anthem II, I would appreciate being credited for
 these tools. It is not necessary, but it would be a nice gesture.

------------------------------------------------------------------------------

 INSTALLATION

 You will need an installed copy of Heroine Anthem II: The Angel of Sarem,
 as well as a local install of PHP. If you are using Ubuntu, you can get PHP
 by running:

 # apt-get install php php-cli

 For Windows users, please download the win32 PHP binaries from
 http://www.php.net/ (not the installer), extract them somewhere friendly
 like C:/PHP/, then add C:/PHP/ to your Windows $PATH$ variable. I have
 written a complete guide for doing this on XP at
 http://www.cinnamonpirate.com/blog/192/.

 Unzip the contents of this archive anywhere on your computer. Be advised
 that some PHP versions do not like Chinese characters in a path name.

------------------------------------------------------------------------------

 USAGE

 Copy all the files in the /WindThunder/Heroine Anthem/script/ folder to the
 script folder created by this archive. These files will all end in *.scX,
 where X is an integer.

 You can edit the scripts in the /txt/ folder directly. The scripts are
 Traditional Chinese stored in Big5 character encoding. If you are qualified
 to translate Chinese, you should know what this means, so I will not explain
 further what character encodings are.

 When you wish to build a new series of scripts, open a terminal
 (command line) and change to the directory you extracted this archive. Enter
 the following command:

 Linux
 $ ./hainsert txt sc0 out

 Windows
 > php hainsert txt sc0 out

 This will begin processing all the files in TXT. The text will be combined
 the data in the *.scX files, and the new files will be dropped into the
 /out/ folder. You can copy these files to your Heroine Anthem scripts folder
 to test them out in the game.
 
------------------------------------------------------------------------------

 WHAT'S MISSING?

 I did not write a tool to recombine extracted images into a new AMP file. I
 never had the need. If you translate the game and canot manage this tool on
 your own, please contact me. I will gladly fill it in. However, I will not
 write it just to complete a toolkit no one will likely ever use.

 Also, I left out my graphics tool. It is, at best, extremely flaky. If you
 need one, steal it from my Heroine Anthem toolkit and comment out the line
 where it calls the tagger() function. I don't believe you will need to edit
 any graphics except for a few AMP files, and these are very
 poorly-supported under my currently released tool kit. If you feel brave
 enough to write your own, check out the reference section.

------------------------------------------------------------------------------

 REFERENCE

 WindThunder Package File Format
 This is the format used to store the IMG and ANI files. It is a large
 resource-file format:  http://www.cinnamonpirate.com/hobby/docs/wtpack/

 WindThunder AMP_FILE V1.0 Format
 This is the format the game created for doing transparent Bitmaps and PCX
 files. It consists of one full-color graphic, and one "mask" graphic which
 is black and white. Any black areas will be "cut out" of the source graphic:
 http://www.cinnamonpirate.com/hobby/docs/wtamp/

 WindThunder ANI_FILE V1.0 Format
 This is the format used for game animations. You will not need to edit
 these to produce a complete Heroine Anthem translation:
 http://www.cinnamonpirate.com/hobby/docs/wtani/

 WindThunder Script Format
 This is the format of the *.scX files which control the scripted events for
 every screen in the game. These are already fully supported by this
 toolkit release: http://www.cinnamonpirate.com/hobby/docs/wtscript/

------------------------------------------------------------------------------

