Rix
aa5b71ace5
Two modes, mutually exclusive at config time. pcsx.authoring.config imports a checked-in JSON as-is; pcsx.authoring.files generates one from a glob, the way nugget.bin2c already does. generic_conversion cannot cover this: it hardcodes a single input file and forces the output basename to the linked binary's, while a disc image takes a whole tree and may want several images off one executable. So the binary dependency is mandatory in generate mode and optional in import mode, where the config names its own executable, and the basename is the target name. Incremental rebuild tracks every payload plus the config, so touching an asset re-runs only the images that reference it. Five config-time negative controls, including both-modes-set and generate-mode with no binary dependency. This renames pcsx.authoring.iso, which has no consumers in the tree.
CD Authoring
This tool can be used to create a bootable CD image for the PlayStation, using a single input binary file, and a set of files to be archived into the CD image at a fixed location. See the archive-manager.h file for more information about the archive format and API.
The generated CD image will have its archive file stored at the sector 23, and as such, the archive manager may be initialized using this LBA. The filenames will be hashed using DJB2. Each entry may be compressed using the UCL-NRV2E algorithm. The LZ4 algorithm will not be used. This means the archive manager only requires to have the UCL-NRV2E decompressor registered.
The tool takes a json file as input, which can have the following structure:
{
"executable": "executable.ps-exe",
"files": [
{
"path": "path/to/file1.bin"
},
{
"path": "path/to/file2.bin",
"name": "custom_name.bin"
}
],
"pvd": {
"system_id": "PLAYSTATION",
"volume_id": "MY_CD",
"volume_set_id": "MY_CD_SET",
"publisher": "MY_PUBLISHER",
"preparer": "MY_PREPARER",
"application_id": "MY_APP_ID",
"copyright": "MY_COPYRIGHT",
"abstract": "MY_ABSTRACT",
"bibliographic": "MY_BIBLIOGRAPHIC"
}
}
Comments are allowed in the json file, and will be ignored.
All the file lookups will be relative to base directory, which is the same as the json file if the option -basedir isn't specified. The files will be stored into the archive in their order of appearance. The executable field is mandatory, and it should point to a valid PSX executable file. The files field is an array of objects, each containing a path field that points to a file to be included in the CD image. The attached name field for each object is optional, and will default to the path field. It represents the final string which will be hashed into the archive index, and can be virtually any string. The pvd field is an optional object that contains the PVD (Primary Volume Descriptor) information for the CD image. All fields in the pvd object are optional. The system_id field defaults to "PLAYSTATION", and all other fields default to empty strings. The volume_id field is often used by emulators to identify the CD image, and it is recommended to set it to a unique value.
The tool accepts the following command line arguments:
-o: The output file name for the CD image. Mandatory.-license: The license file to be used. Optional. Point to an existing valid PlayStation 1 disc, or an official license file. The tool will use the license file to generate the CD image. If not provided, the tool will generate an empty license on the CD image.-basedir: The base directory for the files. Optional. Default is the directory where the json file is located.-threads: The number of threads to use for compression. Optional. Default is the number of available CPU cores.