Skip to content

Continuation of the ppmdu repository of tools for editing the NDS game Pokemon Mystery Dungeon Explorers of Sky.. Now updated to use modern build tools and a much more maintainable setup. Now also builds on g++ as well as msvc.

License

Notifications You must be signed in to change notification settings

PsyCommando/ppmdu_2

Repository files navigation

forthebadge forthebadge forthebadge forthebadge

Pokemon Mystery Dungeon Utilities

Updated repository for https://github.com/PsyCommando/ppmdu. Reworked everything to build using CMake and made the project structure less of a nightmare. It's still a bit clunky, since I'm kinda new to the whole CMake thing, but it's much easier to build. Combined code for several utilities used to export and import things to and from the "Pokemon Mystery Dungeon : Explorers of" games on the NDS.

Here's my development thread on Project Pokemon:
http://projectpokemon.org/forums/showthread.php?40199-Pokemon-Mystery-Dungeon-2-Psy_commando-s-Tools-and-research-notes

And here's the wiki for the file formats in PMD2:
http://projectpokemon.org/wiki/Pokemon_Mystery_Dungeon_Explorers_of_Sky

Utilities Info:

  • AudioUtil: WIP
    A tool for exporting and importing all the various audio formats used by Pokemon Mystery Dungeon. It will most likely work with any other games that uses the DSE sound driver, by Procyon Studios.

    Most of the conversion process happens in the files with the prefix "dse_", or with the names "smdl", "swdl", and "sedl".

  • DoPX:
    A utility to compress files into "PX" compressed containers such as "at4px" and "pkdpx". (The actual name of the compression format is unknown. But it looks like a variant of LZ.)

  • UnPX:
    A utility to decompress "at4px", "pkdpx", and their SIR0 wrapped form.

  • GFXCrunch: A utility meant to support import/export of every single graphic formats used in PMD2.

  • PackFileUtil:
    A tool meant mostly for research. It extracts a "pack file"'s content, or rebuild one. The functionality is automated in other tools, so its mostly unnecessary now!

  • StatsUtil: This tool exports/imports game statistics files. Things such as game text, pokemon and item names, pokemon stats, stats growth, item and move data, dungeon stats, etc.. It exports/imports all that data(besides game strings) to XML files as an intermediate format. XML files are easily editable by anyone, and 3rd party tools supporting XML. The game strings are extracted to a single simple .txt file, where each line is a C-String, and special characters are represented as escape sequences. The encoding is properly determined by using a XML configuration file that users can use to add the encoding string for a specific game version/language.

Grabbing the source code:

Check out the repository and the submodules:

git clone --recurse-submodules https://github.com/PsyCommando/ppmdu_2.git

Building the Source Code With Visual Studio 2022

You can open the project directory within VS2022 or some other IDE that supports CMake projects and the Ninja build system, and it should be properly setup for building out of the box! Everything is preconfigured in the vcpkg.json and the CMakePreset.json files.

Building the Source Code Via Console Commands

This is a bit more involved. First we need to make sure you got all you need installed.

Dependencies Linux

On linux you want to make sure you got all the tools you need first. For example on unbuntu 22.04:

sudo apt-get install build-essential cmake ninja-build zip pkg-config

This should install most of the things you'll need. If not you should get notified about it.

Just make sure your version of cmake is at least 3.19 and up. You can check by using this command:

cmake -version

Dependencies Windows

On windows, you'll want to setup a few things detailed below! If you're not using Visual Studio 2022, you'll have to download the cmake binary, and refer to cmake.exe via the full path in the commands below, or if you added the directory with the cmake.exe to your PATH environment variable, you don't have to do that. Here's the link to the cmake downloads: https://cmake.org/download/

Then make sure you got the ninja build system installed. On Windows, just grab it here: https://github.com/ninja-build/ninja/releases . Next, you either want to make sure the path to ninja.exe is in your PATH environment variable, or you can set the full path to it in the CMakePresets.json file under the "CMAKE_MAKE_PROGRAM" variable entry for the "windows-base" configuration preset.

Configuring and Building the Project

The next part should be relatively straightforward. Make sure you're in the ppmdu_2 directory first.

Windows

In theory, if you got cmake.exe and ninja.exe in your PATH environment variable you can just:

cmake --preset x64-windows-debug .

But I couldn't test that at the time of writing.

Alterinatively. You could format the configuration command this way:

cmake -G "Ninja" -DCMAKE_C_COMPILER:STRING="cl.exe" -DCMAKE_CXX_COMPILER:STRING="cl.exe" -DCMAKE_TOOLCHAIN_FILES="vcpkg/scripts/buildsystems/vcpkg.cmake" -DCMAKE_MAKE_PROGRAM=[PATH TO THE NINJA.EXE] -DCMAKE_BUILD_TYPE:STRING=[BUILD TYPE EITHER "Debug" or "Release"] -DCMAKE_INSTALL_PREFIX:PATH="out/install/["ARCH-BUILD_TYPE" FOR EXAMPLE: "x64-debug"]"

(Note that if you're using gcc or ming or another compiler on windows, you'll have to put in the proper compiler exe in the command-line.) Example:

cmake -G "Ninja" -DCMAKE_C_COMPILER:STRING="cl.exe" -DCMAKE_CXX_COMPILER:STRING="cl.exe" -DCMAKE_TOOLCHAIN_FILES="vcpkg/scripts/buildsystems/vcpkg.cmake" -DCMAKE_MAKE_PROGRAM="ninja.exe" -DCMAKE_BUILD_TYPE:STRING="Debug" -DCMAKE_INSTALL_PREFIX:PATH="out/install/x64-debug"

If all goes well, vcpkg will download all the missing dependencies and set them up automatically. It might take a bit, because it will compile POCO which is a pretty large library, but next times you'll build, it'll be much faster once its done once.

To build the project, just do it like this:

cmake --build --preset [CONFIGURATION PRESET]

Where [CONFIGURATION PRESET] should be replaced with one of the presets in the CMakePresets.json file. Since we went with a 64 bits debug build earlier, lets use "x64-debug" for example here.

Linux

If everything is installed correctly, you can just do this:

cmake --preset [CONFIGURATION PRESET]

Where [CONFIGURATION PRESET] should be replaced with one of the presets in the CMakePresets.json file. For example:

cmake --preset x64-linux-release

If all goes well, vspkg will automatically grab the needed dependencies and install them to the vspkg directory in the repository's root. Next you can build the project using the command:

cmake --build --preset [CONFIGURATION PRESET]

Since we went with a 64 bits debug build earlier, lets use "x64-linux-debug" for example here:

cmake --build --preset x64-linux-release

Now the build should start and create all the executables for the utilities under their respective subfolers's bin/ directory, and move over all the necessary files.

Portability:

Should be compatible with Windows 7+ 32/64, Linux 64bits. I have no ways of testing Apple support. All the libraries, either the submodules, or the ones I had to include in the code, should be multi-platform.

License:

Those tools and their source code, excluding the content of the /deps/ directory (present only for convenience, and because some of the libs need some slight tweaking), is Creative Common 0, AKA Public Domain. Do what you want with it. Use the code in your coding horror museum, copy-paste it in your pmd2 tools, anything! XD You don't have to credit me, but its always appreciated if you do ! And I'd love to see what people will do with this code.

About

Continuation of the ppmdu repository of tools for editing the NDS game Pokemon Mystery Dungeon Explorers of Sky.. Now updated to use modern build tools and a much more maintainable setup. Now also builds on g++ as well as msvc.

Resources

License

Stars

Watchers

Forks

Packages

No packages published