Godot RE Tools Documentation

When using --include or --exclude, follow these rules:

• Recursive patterns: Use ** (e.g., res://**/*.gdc matches all .gdc files in all subdirectories).
• Rooting: Globs should be rooted to res:// or user://. If not rooted, they default to res://.
• Wildcard shorthand: If a glob has a wildcard but no directory, it is treated as recursive (e.g., *.gdc is equivalent to res://**/*.gdc).
• Matching: Globs only match files actually present in the project PCK/directory. For example, if res://main.gdc exists in the PCK, using the glob res://main.gd will not match anything, but res://main.gdc will match and allow recovery of the source res://main.gd.

You can install VTracer using one of the following methods:

• Pre-built Binaries: Download from the GitHub Releases page.
• Rust (Cargo): Install from crates.io using cargo.
• Python (pip): Install as a native extension via pip.
• Rust Library: Add as a dependency to your Rust project.

Once your GDScript is written, you can provide it to GDRE Tools using one of two methods:

1. Command Line: Use the --custom-decryption-script argument.
2. GUI: Navigate to the "Set Encryption Key" menu option and select your script.

To build the C++ test program used to verify the AOT (Ahead-of-Time) build of the Godot Mono Decompiler with dynamic linking, follow these steps:

Prerequisites

• CMake: version 3.16 or higher.
• Compiler: C++17 compatible compiler (GCC, Clang, or MSVC).
• AOT Library: The library must be built and located at ../GodotMonoDecompNativeAOT/bin/Release/net9.0/osx-arm64/publish/GodotMonoDecompNativeAOT.{dylib,dll,so}.

Build Steps

1. Create and enter a build directory:

   mkdir build
   cd build

2. Configure the project with CMake:

   cmake ..

3. Build the program:

   make

To use the Python bindings for VTracer, install the package using pip:

pip install vtracer

You can install Godot RE Tools by downloading the latest release from the GitHub releases page or by using Scoop on Windows.

Windows (via Scoop):

scoop bucket add games
scoop install gdsdecomp

If a game uses a custom encryption scheme instead of the standard Godot AES-256-CFB, you must write a custom decryptor script using Godot 4.5+ GDScript.

Your script must:

1. Extend the CustomDecryptor class.
2. Implement the _parse_and_decrypt() method.

Warning: Do not include secrets (encryption keys, XOR keys, etc.) directly in the script if you intend to distribute it, as this may violate legal restrictions like the DMCA.

To recover a full Godot project (including decompiling GDScript, recovering original project files, and converting resources) using the graphical interface:

1. Open the application.
2. Select "Recover project..." from the "RE Tools" menu.
3. Alternatively, drag and drop the PCK, APK, or EXE file directly onto the application window.

If you encounter issues while running or building the AOT test, check the following:

• Linker errors: Verify that the AOT library is built and that the path specified in CMakeLists.txt is correct.
• Missing symbols: Ensure the GodotMonoDecomp_DecompileProject function is properly exported from the AOT library.
• Runtime errors: Ensure all dependencies are available in the RPATH.

The VTracer command-line application converts raster images (like JPG or PNG) into vector graphics (SVG).

Basic Usage:

./vtracer --input input.jpg --output output.svg

The aot-test program verifies the decompilation process by calling the GodotMonoDecomp_DecompileProject function directly via dynamic linking. It requires a path to a .NET assembly and an output directory.

Arguments

1. Assembly Path: Path to the .dll file to decompile.
2. Output Directory: Directory where the decompiled project will be saved.
3. Reference Paths (Optional): Additional paths used for assembly resolution.

Usage Examples

Basic usage:

./aot-test /path/to/your/assembly.dll ./output

Usage with reference paths:

./aot-test /path/to/your/assembly.dll ./output ./reference1 ./reference2