/phoenix-studio

A set of tools for inspecting and converting Gothic and Gothic II game files

Primary LanguageC++MIT LicenseMIT

phoenix studio logo

phoenix studio

Build License C++ Platforms

Here be dragons! phoenix studio is currently in very early development. Bugs are expected and might be very common.

phoenix studio aims to implement a fully featured development environment for ZenGin applications. The ZenGin was a game engine created by Piranha Bytes for their early-2000s games Gothic and Gothic II. Currently, it contains simple command-line utilities for reading and converting data files used for Gothic and Gothic II.

If you have any questions you can open a discussion on this repo or contact me on Discord, ideally by pinging me (lmichaelis#6242) in the GMC Discord in the tools channel.

contributing

If you'd like to contribute, please read contributing first.

currently available tools

phoenix studio comes with some tools to inspect and convert the ZenGin's file formats. The following is a list of all tools currently available:

Name Description
zdump Dump information about various files.
zmodel Convert MRM, MSH, MMB, MDL and MDM files as well as world meshes into the Wavefront model
zscript Display, disassemble and decompile compiled Daedalus scripts (similar to objdump).
ztex Convert TEX files to TGA
zvdfs Extract and list contents of VDF files.

building

phoenix studio is currently only tested on Linux and while Windows should be supported you might run into issues. If so, feel free to create an issue or open a merge request. You will need

  • A working compiler which supports C++17, like GCC 9
  • CMake 3.10 or above
  • Git

To build phoenix studio from scratch, just open a terminal in a directory of your choice and run

git clone --recursive https://github.com/lmichaelis/phoenix-studio
cd phoenix
cmake -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build

You will find the tool binaries in build/bin and the library in build/lib.

licensing

While the source code of phoenix studio is licensed under the MIT license, the phoenix studio logo is licensed under CC BY-NC 4.0.