Skip to content

Python script for decoding and encoding RPG Maker MV/MZ game assets

License

Notifications You must be signed in to change notification settings

kins-dev/rpgmaker_mv_decoder

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

RPGMaker MV Decoder v1.4.0

v1.4.0 CodeQL Status v1.4.0 Python Application Status v1.4.0 Pylint Status Documentation status Latest pypi release

This is a set of python scripts for decoding and encoding RPGMaker MV/MZ game assets.

Decoding has a handy feature, it will figure out (if possible) the key automatically. It will also can use the file data for creating the extension. If you know the key, you can pass it in.

If you want you can use the API instead

Features

  • GUI for those who need that
  • Fast
  • No key needed if there's any encoded png images
  • Can put proper file extensions on the decoded files

Example usage

./decoder.py "<source path>" "<destination path>" ["<optional key>"]
./encoder.py "<source path>" "<destination path>" "<key>"
./gui.py

The GUI has a fairly simple main window:

Main Window

Progress will be shown while finding the key, decoding the files or encoding the files:

Progress Dialog

Hitting the question mark will bring up the about box, which gives some handy links:

About Dialog

Help

You can use the standard --help option for full documentation:

Decoding

Usage: decode.py [OPTIONS] <Source> <Destination> [<Key>]

  Decodes RPGMaker files under <Source> directory to <Destination> directory.

Arguments:
  <Source>       The source directory. For best results this should be the
                 parent of the 'www' or 'img' directory.
  <Destination>  The parent destination directory. This script will create a
                 project directory under this path if it doesn't already
                 exist.
  <Key>          The decoding key to use. This argument is optional. If the
                 key is omitted it will be inferred (if possible) based on the
                 file contents.

Options:
  --detect_type  Detect the file type and use the associated file extension.
                 By default .rpgmvp becomes .png and .rpgmvo becomes .ogg
                 regardless of the file contents.
  --version      Prints the version number
  --overwrite    Overwrite files without prompting
  --help         Show this message and exit.

Encoding

Usage: encode.py [OPTIONS] <Source> <Destination> <Key>

  Encodes image and audio files under <Source> directory.

Arguments:
  <Source>       The source directory. For best results this should be the
                 parent of the 'www' or 'img' directory.
  <Destination>  The parent destination directory. This script will create a
                 project directory under this path if it doesn't already
                 exist.
  <Key>          The encoding key to use.

Options:
  --version    Prints the version number
  --overwrite  Overwrite files without prompting
  --help       Show this message and exit.

About

Python script for decoding and encoding RPG Maker MV/MZ game assets

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published