Feature Request: Command line interface

[EM4Volts]

The idea here would be to have an CLI that allows for the user to load rpaks via cli report assets from thoos rpaks (preferably with some sort of filter so u can also just get individual asset types, export assets by giving RSX the asset guid in cli, or for stuff like materials return the json of the material in the cli.
Basically having rsx as a library that other programs could use in the commandline to interact with rpaks easier

[snake-biscuits]

This'd be perfect for io_import_rbsp

My expected use case would send the following:

• path to .rpak dir (to mount common.rpak & mapname.rpak)
• export settings (max texture res, formats etc.)
• list of material paths / GUIDs (can get GUIDs from .stbsp)

And from this I'd expect to get back:

• extracted materials
• a report.json detailing extracted assets

Here's an example snippet of .jsonc:

[
  {
    "Type": "Material",
    "Name": "models/foliage/tree_beacon_01_wld",
    "GUID": "2B6327410EE8F38B",
    "Misc": {"Subtype": "WLD"},
    "Refs": {
      "Shaderset": "uberVcoltCutSamp2222_wld",
      "Textures": {
        "Albedo": "tree_maple_peach_col",
        "Normal": "8C9647619E10E9A6",  // not loaded
        "Gloss": "C26AAAFF2B114147",  // not loaded
        "Specular": "556001E2EBAFD73E"  // not loaded
      }
    }
  }
]

[r-ex]

I have started to implement this as of 1.1.15, but it won't be feature complete for some time. In the meantime, I would very much appreciate feedback and suggestions about how it is currently implemented. I'll attach some documentation for it shortly.

[r-ex]

here are the current docs for the command-line interface. this is not complete by any means, but it should contain most of the arguments and information necessary.

ignore any links to other files - these will only be relevant once the full docs are uploaded as these are not currently finished.

let me know if you have any questions!

Command-Line Interface

RSX features a range of command-line arguments that can be passed to the application to perform actions automatically, without creating a GUI.

The most important of these arguments is -nogui, which prevents window creation and initialization of DirectX/Dear ImGui, as most of the others will not work without it.

Argument List

Flags

These arguments do not take a value. Including them in the arguments provided to RSX will set their value to true.

Flag	Description
-nogui	Prevents creation of a graphical user interface
-export	Enables exporting of assets from the specified asset container files
-matltextures	Enables exporting of textures that are referenced by material assets in RPak files, when the materials are exported
-exportfullpaths	Enables exporting of assets to the full path contained in their file name, instead of the usual asset type folders
-exportdependencies	Enables exporting of all assets that are dependencies of other exported assets1
-exportrigsequences	Exports animation sequences that are associated with exported animation rigs1
-nocachedb	Disables loading and usage of RSX's cache database
-truncatedmodelmats	Enables shortening of material paths that are used by models, when the models are exported
-useqci	When exporting models as SMD, splits the QC file into multiple QCI files

¹ This is only used when an export filter is specified, as by default all assets are exported.

Other

Argument	Values	Description
--nmlrecalc	none, directx, opengl	Sets the type of normal-map recalculation that should be used when exporting materials
--texturenames	guid, stored, text, semantic	Sets the format of the names of exported/previewed texture assets. See below2
--qcmajor	(16-bit integer)	When exporting models as SMD, sets the major version of the QC file
--qcminor	(16-bit integer)	When exporting models as SMD, sets the minor version of the QC file
--exportdir	(string, directory path)	Sets the directory that all assets are exported to
--exporttypes	(string, asset type)	If the -export flag is specified, Sets a list of types that should be exported
--exportthreads	(integer, min: 1, default: 1)	Sets the number of threads to use for exporting. Clamped to the number of threads supported by the processor
--parsethreads	(integer, min: 1, default: 0.5*maxThreads)	Sets the number of threads to use for loading files. Clamped to the number of threads supported by the processor
--list	(string, file path)	Sets the file path that the loaded asset list will be saved as
--listformat	csv, txt	Sets the format that the asset list will be exported as

List

If --list is specified on the command line with a file path (e.g., rsx --list "C:/asset_list.txt" common.rpak common_early.rpak ui.rpak), the specified files (in this case: common, common_early, ui) will have their contents saved to the provided path as either a TXT or CSV file, depending on the value of the --listformat argument.

TXT

If the TXT option is chosen, the list will be a simple newline-separated text file with the asset names of all loaded assets as they would appear in the RSX GUI asset list.

CSV

If the CSV option is chosen, the list will be a Comma-Separated Values (CSV) file, with the following header:

type,guid,file_name,asset_name

• type: the type of asset, indicated by a string of up to 4 characters (e.g., txtr, matl, mdl_, ui, shdr)
• guid: a unique identifier of the asset
• file_name: the name of the container file that holds the asset (e.g., common.rpak, ui.rpak)
• asset_name: the name of the asset, as displayed in RSX's GUI asset list