This software in an alpha stage. Please report any bugs on the github page.
This module includes following features:
- Full project recovery
- PCK archive extractor / creator.
- GDScript batch decompiler.
- Resource text <-> binary batch converter.
Full project recovery performs the following:
- Loads project resources from an APK, PCK, or embedded EXE file
- Decompiles all GDScript scripts
- Recovers the original project file
- Converts all imported resources back to their original import formats
- Converts any auto-converted binary resources back to their original text formats
- Recreates any plugin configuration files
This module has support for decompiling Godot 4.x, 3.x, and 2.x projects.
Grab the latest release version from here: https://github.com/GDRETools/gdsdecomp/releases
- To perform full project recovery from the GUI, select "Recover project..." from the "RE Tools" menu:
- Or, just drag and drop the PCK/EXE onto the application window.
gdre_tools --headless <main_command> [options]Main commands:
--recover=<GAME_PCK/EXE/APK/DIR> Perform full project recovery on the specified PCK, APK, EXE, or extracted project directory.
--extract=<GAME_PCK/EXE/APK> Extract the specified PCK, APK, or EXE.
--compile=<GD_FILE> Compile GDScript files to bytecode (can be repeated and use globs, requires --bytecode)
--decompile=<GDC_FILE> Decompile GDC files to text (can be repeated and use globs)
--pck-create=<PCK_DIR> Create a PCK file from the specified directory (requires --pck-version and --pck-engine-version)
--pck-patch=<GAME_PCK/EXE> Patch a PCK file with the specified files
--list-bytecode-versions List all available bytecode versions
--txt-to-bin=<FILE> Convert text-based scene or resource files to binary format (can be repeated)
--bin-to-txt=<FILE> Convert binary scene or resource files to text-based format (can be repeated)
Recover/Extract Options:
--key=<KEY> The Key to use if project is encrypted as a 64-character hex string,
e.g.: '000102030405060708090A0B0C0D0E0F101112131415161718191A1B1C1D1E1F'
--output=<DIR> Output directory, defaults to <NAME_extracted>, or the project directory if one of specified
--scripts-only Only extract/recover scripts
--include=<GLOB> Include files matching the glob pattern (can be repeated)
--exclude=<GLOB> Exclude files matching the glob pattern (can be repeated)
--ignore-checksum-errors Ignore MD5 checksum errors when extracting/recovering
Decompile/Compile Options:
--bytecode=<COMMIT_OR_VERSION> Either the commit hash of the bytecode revision (e.g. 'f3f05dc'), or the version of the engine (e.g. '4.3.0')
--output=<DIR> Directory where compiled files will be output to.
- If not specified, compiled files will be output to the same location
(e.g. '<PROJ_DIR>/main.gd' -> '<PROJ_DIR>/main.gdc')
Create PCK Options:
--output=<OUTPUT_PCK/EXE> The output PCK file to create
--pck-version=<VERSION> The format version of the PCK file to create (0, 1, 2)
--pck-engine-version=<ENGINE_VERSION> The version of the engine to create the PCK for (x.y.z)
--embed=<EXE_TO_EMBED> The executable to embed the PCK into
--key=<KEY> 64-character hex string to encrypt the PCK with
Patch PCK Options:
--output=<OUTPUT_PCK/EXE> The output PCK file to create
--patch-file=<SRC_FILE>=<DEST_FILE> The file to patch the PCK with (e.g. "/path/to/file.gd=res://file.gd") (can be repeated)
--include=<GLOB> Only include files from original PCK matching the glob pattern (can be repeated)
--exclude=<GLOB> Exclude files from original PCK matching the glob pattern (can be repeated)
--embed=<EXE_TO_EMBED> The executable to embed the patched PCK into
--key=<KEY> 64-character hex string to decrypt/encrypt the PCK with
- Recursive patterns can be specified with
**- Example:
res://**/*.gdcmatchesres://main.gdc,res://scripts/script.gdc, etc.
- Example:
- Globs should be rooted to
res://oruser://- Example:
res://*.gdcwill match all .gdc files in the root of the project, but not any of the subdirectories.
- Example:
- If not rooted, globs will be rooted to
res://- Example:
addons/plugin/main.gdcis equivalent tores://addons/plugin/main.gdc
- Example:
- As a special case, if the glob has a wildcard and does not contain a directory, it will be assumed to be a recursive pattern.
- Example:
*.gdcwould be equivalent tores://**/*.gdc
- Example:
- Include/Exclude globs will only match files that are actually in the project PCK/dir, not any non-present resource source files.
- Example:
- A project contains the file
res://main.gdc.res://main.gdis the source file ofres://main.gdc, but is not included in the project PCK.- Performing project recovery with the include glob
res://main.gdwould not recoverres://main.gd. - Performing project recovery with the include glob
res://main.gdcwould recoverres://main.gd
- Performing project recovery with the include glob
- A project contains the file
- Example:
Use the same Godot tools version that the original game was compiled in to edit the project; the recovery log will state what version was detected.
Support has yet to be implemented for converting the following resources:
- 3.x and 2.x models (
dae,fbx,glb, etc.) - OBJ meshes
- Bitmap and image fonts (recovering 4.x TTF/OTF fontfiles is supported)
- GDNative or GDExtension scripts (e.g. GDMono and CSharp)
There is no support for decompiling any GDNative/GDExtension or GDMono scripts. For Mono/CSharp, you can use Ilspy or dotPeek.
Clone this repository into Godot's modules subfolder as gdsdecomp.
Rebuild Godot engine as described in https://docs.godotengine.org/en/latest/development/compiling/index.html.
For ease of bootstrapping development, we have included launch, build, and settings templates for vscode in the .vscode directory. Once you have read the instructions for compiling Godot above and set up your build environment: put these in the .vscode folder in the Godot directory (not gdsdecomp), remove the ".template" from each, and launch vscode from the Godot directory.
Godot 4.0 (master branch) @ a8598cd8e261716fa3addb6f10bb57c03a061be9
- Support for building on 3.x has been dropped and no new features are being pushed
- Godot RE Tools still retains the ability to decompile 3.x and 2.x projects, however.
Assuming you compiled with scons platform=linuxbsd target=template_debug,
$ bin/godot.linuxbsd.template_debug.x86_64.llvm --headless --path=modules/gdsdecomp/standalone --recover=<pck/apk/exe>The source code of the module is licensed under MIT license.