RPA Kit

RPA Kit is a small application for decompressing RenPy archives.

It takes as input a archive file or a directory, which is then searched for legit archives, and unpacks the content of them in a directory of choice. Its also possible to read-only listing of the content or testing if the given archives format type supported is.

Usage

Command line parameter overview

rpakit [-e|-l|-t] [-o OUTPUT] [--verbose] [-version] [-h, --help] Target

positional parameters:
  Target                Directory path to search OR path of a RPA file to work on.

tasks:
  -e, --expand          Unpacks all stored files.
  -l, --list            Gives a listing of all stored files.
  -t, --test            Tests if archive(s) are a known format.
  -s, --simulate        Simulates the expand process.

optional parameters:
  -o, --outdir OUTPUT   Extracts to the given path instead of standard.
  --verbose             Amount of info output. 0:none, 2:much, default:1

  --version             Shows version information
  -h, --help            Print this help

Example CLI usage

rpa_kit.py -e /home/{USERNAME}/otherdir/archive.rpa Will extract every file from archive into the default output directory, making subdirectories when necessary.

rpa_kit.py -e -o unpacked /home/{USERNAME}/somedir/search_here Searches RenPy archives in this directory and uncompresses them in the subdir 'unpacked'.

rpa_kit.py -t c:/Users/{username}/my_folder/A123.rpa This will test the given archive for his format and if valide prints it out.

rpa_kit.py -l -verbose 2 c:/Users/{username}/game_dir/blub8/ Searches for RenPy archives in this directory and lists their file content in the console. The verboseness was also set to highest level (tell everything).

API

The API is possible not final!

To provide the functionality of Rpa Kit in other projects, the programs classes can very easily included. Besides the code just for CLI use, the core functionality is organized in four classes in diamond inheritance. Overview of this classes:

class RkMain(RkPathWork, RkDepotWork):
    """Main class to process args and executing the related methods."""

    def __init__(self, inpath, outdir=None, verbose=None, **kwargs):

inpath: str or pathlike, required The archive file-path to open or a directory path with archives. Absolute paths preferred.
outdir: str or pathlike, optional Sets the name of the output directory. If None the standard is used.
verbose: int, optional Print info about what we are doing. Values: 0-2; Defaults to 1
**kwargs
- task: str, required Sets the wanted task. Possible arguments are exp (expand), lst (listing), tst(testing), sim(simulate)

class RkDepotWork(RkCommon):
    """
    This class is the apps core for analyzing, testing and unpacking/decoding RPA
    files. All needet inputs (depot, output path) are internaly providet.
    """

This class holds also two important dicts with the informations about the RPA formats. Here can be easily additional formats configured.

class RkPathwork(RkCommon):
    """
    Support class for RPA Kit's path related tasks. Needet inputs (file-/dir path)
    are internaly providet. If input is a dir it searches there for archives,
    checks and filters them and puts them in a list.
    A archiv as input skips the search part.
    """

If a advanced enough user does the path preparations in some other way/place and provides the archives itself to the other classes this one could even be spared.

class RkCommon:
    """
    "Rpa Kit Common" provides some shared methods and variables for the other
    classes.
    """

Motivation - Why another RPA unpacker?

This began in 2017 with a few lines of code and as another learning experience in Python coding and to understand some more about RenPy internals. Basicly i extended rpatool with some extras.

Over time i hit more walls with the codebase and the available apps for RPA work where of limited usability to me. Unmaintained state, cumbersome extensibility and not working functionality increasingly dissatisfied me. Some whishes where:

feeding it simply a directory with rpa files instead a single file
support for more rpa formats
easy extensibility for new rpa formats
additional info output

Fall 2019 i began to do serious changes and extensions on rpatools api. From there it got fast out of control and i ended up with a completly rewritten app. Hopefully also of use to other people.

Legal

License

RPA Kit is licensed under Apache-2.0. See the LICENSE file for more details.

Disclaimer

This program is intended for people who have the legal rights or the consent of the authors to access or decompress the target files. Any illegal or otherwise unindented usage of this software is highly discouraged and has here no support.

Credits

This software was developed with some orientation on RenPy's and rpatool's code for the work with RPA files. Credits for the development of the RenPy archive format belong to the contributors of the RenPy project.

madeddy / RpaKit