RSDK Export CLI

A CLI tool for exporting Retro Engine file data to common formats.

Usage

usage: RSDKExportCLI [options] <source> <version> <destination>

Options:
  -?, -h, --help           Displays help on commandline options.
  --help-all               Displays help including Qt specific options.
  -s, --scene, --scn       Export scene files as XML (v1-v4, v5r1, v5)
  -a, --animation, --anim  Export animation files as JSON (v1-v5)
  -g, --gameconfig, --gc   Export gameconfig as XML (v1-v5)
  -m, --model, --mdl       Export model files as PLY (v4, v5)
  -p, --palette, --pal     Export palette as ACT (v1-v5, gcv4, gcv5r1, gcv5)

Arguments:
  source                   Source folder/file
  version                  Intended engine version of the files
  destination              Destination folder

How to Build

If you prefer to use a prebuilt executable, there are Windows and Linux builds available in the Releases section.

Get the source code

In order to clone the repository, you need to install Git, which you can get here.

Clone the repo, using: git clone https://github.com/RSDKModding/RSDK-Export-CLI

If you've already cloned the repo, run this command inside of the repository: git submodule update --init --recursive

Windows

Pre-requisites

• Get and run the Qt Online Installer from here.
• When you reach the Installation Folder step of the installer, choose Custom Installation.
• In the Select Components step, enable the Archive filter and click Filter to refresh the component list.
• From here, you can choose to enable either of the following:
  • Qt > Qt 5.15.2 > MSVC 2019 64-bit. (Requires Visual Studio installed with Build Tools and CMake)
  • Qt > Qt 5.15.2 > MinGW 8.1.0 64-bit and Qt > Developer and Designer Tools > MinGW 8.1.0 64-bit
• Proceed with the rest of the installation.
  • If Qt Online Installer has a very slow download speed, cancel the install and open the exe through a command line with the argument --mirror [mirror url]. A list of the available mirrors can be found here; copy the one closest to your location.
• Follow the Qt Creator building steps.

Linux

Pre-requisites

• Install the following dependencies:
  • apt (Debian/Ubuntu): sudo apt install build-essential qtbase5-dev qtchooser qt5-qmake qtbase5-dev-tools
  • Your favorite package manager here, make a pull request
    • Qt Creator can also be installed by adding qtcreator to the command above, allowing you to use the same building process as the other platforms.
• Follow the Qt Creator building steps (or build from the command line).

Building from the command line

• In the RSDKExportCLI project folder, run the following commands:

mkdir build
qmake -o build RSDKExportCLI.pro
cd build
make -j$(nproc)

The -j switch is optional, but will make building faster by running it parallel on multiple cores (nproc will use all available cores).

MacOS

Pre-requisites

• Download and install Xcode from the App Store.
• Get and run the Qt Online Installer from here.
• When you reach the Installation Folder step of the installer, choose Custom Installation.
• In the Select Components step, enable the Archive filter and click Filter to refresh the component list, then enable the component Qt > Qt 5.15.2 > macOS.
• Proceed with the rest of the installation.
  • If Qt Online Installer has a very slow download speed, cancel the install and open the installer through a command line with the argument --mirror [mirror url]. A list of the available mirrors can be found here; copy the one closest to your location.
• Follow the Qt Creator building steps.

Building using Qt Creator

• Open RSDKExportCLI.pro in Qt Creator, then in the Projects tab, make sure Release builds are enabled and press Configure Project.
• Press the RSDKExportCLI monitor icon, then ensure the Build is set to Release.
• Press the Build Project "RSDKExportCLI" button. The built executable should be located in build/[used kit name]/release.

Contact:

Join the Retro Engine Modding Discord Server for any questions you may have about the tool or how to use it.