search

tornado-ii / ShinyRipper

A two-input command line program that rips graphics from Shiny graphics archives.
GNU General Public License v3.0
8 stars 1 forks source link
cli command-line-tool csharp dotnet ripper sprites

readme

ShinyRipper

A two-input command line program that rips graphics from:

This program is a Windows command line program that utilises a GZip library to unpack and read data from Shiny game engine graphics archives. The required libraries are packaged in the executable and do not require extra downloads. This functionality is made possible thanks to adriancs. This program was created with the assistance of shrubbyfrog and is dedicated to Su "Moth" Tolias.

How to use ShinyRipper

  1. After downloading or building the application, open the game folder.
  2. Navigate to the folder containing the sprites you want to rip.
    • (e.g. If you want to rip character sprites or tile sprites, head to Eversion/chrs/.)
  3. Either...
    1. Drag the archive (.cha or .zrs) to ShinyRipper.exe
    2. Open ShinyRipper.exe and drag the archive (.cha or .zrs) to the console window when asking for a path
    3. Open ShinyRipper.exe and manually type in the path to the archive (.cha or .zrs)
    4. Press enter/return to submit the path to the program.
  4. The program will now ask if you would like to "convert transparent pixels". Shiny sprites use a default colour (specified in the header of the uncompressed archive) to represent transparency. Selecting 'yes' will make these transparent instead of the solid colour. Selecting 'no' will output the sprite with this background colour. The program will only accept four inputs at this point:
    1. Y (yes, convert background colour to transparent pixels)
    2. N (no, don't convert background colour to transparent pixels)
    3. X or Escape (quit application)
  5. The program will go through the extracted archive and render all the sprites to .png format in a folder in the same directory as the original archive. (e.g. Eversion/chrs/player/).
    • If a folder or file without extension with the same name already exists, the application will refuse to render the sprites due to naming conflicts (I don't want to overwrite your files). You will need to remove the conflicting file or folder and try again.
  6. The program will exit automatically with the message OK! indicating it has gone through the entirety of the ripping function. Your sprites should now be located in a folder in the same directory as the archive was in. The sprites will be named after the archive with an appended digit indicating its index in the archive.