About Releaser

　Releaser is a tool for organizing folders into archive files.
　You can also specify a Kirikiri project folder and create a single executable with that project folder inside.

How to use Releaser

ReleaserSelect.png

　When you run Releaser (krkrrel.exe in the tools folder), you will first be asked to specify a folder. Specify a folder.
　Targets files in the folder specified here.


Note
　Releaser has a feature that when files with exactly the same contents are found in the process of creating the final archive, they are combined into one even if the file name is different, and only one file's capacity is used .


Note
　Releaser automatically ignores the CVS meta-information directory (the directory named "CVS", which contains a file named "Repository"). It also ignores files and directories whose names begin with a . (dot), such as hidden UNIX-like files and the Subversion meta-information directory.


Note
　When Releaser creates an archive, it creates a file called default.rpf in the directory where the archive was created. It describes the options for creating an archive, so you can easily create the next time you create an archive with the same settings.

Releaser setting screen

　After selecting the folder, the setting screen appears.
"Return to folder selection" button
　You can redo the folder selection.
"Profile: Save" button
　Save the current settings to a file.
"Profile: Import" button
　Read settings from a file.
"Create" button
　Outputs an archive file or EXE executable file based on the current settings.
"Cancel" (or exit) button
　Exit Releaser.
"Output" tab
ReleaserOutput.png

"Output format"
　If you select ".XP3 Archive", a file in xp3 format (Kirikiri standard archive format) will be output. Select ".EXE executable" to output an executable file. If ".EXE executable" is selected, krkr.eXe in the same folder as the releaser (krkrrel.exe) or its parent folder will be used.
"Output File"
　Specify the file to output. Click the "Browse" button to specify the file in the dialog box.
"File" tab
ReleaserFiles.png

　For each extension, you can select "compressed", "included in archive but not compressed", and "not included in archive". In general, you can leave the default classification.
　When files are classified as "compressible", compression is performed and the file size is reduced. Also, if you look inside with a text editor or binary editor, you will not be able to easily decode it. However, compression has the disadvantage that it takes time to decompress. PNG, JPEG, ERI, etc. are already compressed, so compressing them is not recommended, because classifying them as "compress" will have little effect and will take extra time to decompress.
Options tab
ReleaserSettings.png

"Do not compress large files"
　Even if the corresponding file is classified as "compressed", the setting is to not compress the file if it is larger than the specified size. Due to the structure of Kirikiri, compressed files must be expanded in memory, so compressing large files is expensive to run.
"Deployment protection"
　When this is checked, the "expansion protection" attribute is added to the index (list of stored files) inside the archive. This allows the archive extraction tool to indicate that the author does not want the file to be extracted.
"Ogg Vorbis codebook sharing"
　If this is checked, the codebook for vector quantization of OggVorbis files (.ogg files) will be shared. OggVorbis files often have a common codebook for multiple files, so you can save them together to save size.
"Compress Index"
　If checked, the index (list of stored files) inside the archive can be compressed to save size.

Note
Checking "Deployment Protect" on the "Options" tab does not encrypt or prevent the actual deployment. You can only make a statement. Also, if you are writing an archive unpacking tool, consider the presence of this unpacking protection flag (if any) (such as refusing to unpack or warning you before unpacking).

Executable file settings tab
　This is displayed only when an executable file is specified as the output format.
　The setting screen here is the same as Kirikiri setting.

ReleaserExeSettings.png

"option"
　You can set default options for the executable.
"icon"
　You can specify an icon for the executable file.

Command line options

Releaser accepts the following command line options:
Folder name
Specify the target folder.
-go
Create the archive immediately and exit. Please use it for batch processing. Save the options etc. in advance in the target folder with the name default.rpf (It is possible to create an archive in combination with the -nowriterpf -out option without this).
-nowriterpf
Do not write default.rpf on exit.
-out filename
Specify the output file name.
-rpf filename
Specify the profile to load.

For example, specify:

krkrrel project -out ..\release\data.xp3 -nowriterpf -go