KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #developer-tools #ai-agent #codex #typescript #cli #deepseek-harness #claude-code #ai-agents #mcp #rust

UnrealExporter

★ 45 Open GitHub ↗

Batch file exporter for Unreal Engine games.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# UnrealExporter
A CLI for extracting and datamining Unreal Engine game assets, powered by [CUE4Parse](https://github.com/FabianFG/CUE4Parse).

## Features
- [x] Regex paths for bulk extracting
- [x] Path exclusions to avoid crashing
- [x] [Checkpoint system](#checkpoints) (only extract new/changed files)
- [x] Parallel-processing files
- [x] Apply mapping files
- [x] Supports [40+ file types](/UnrealExporter/Export/ExportService.cs#L255) seen in UE games

All games supported by FModel are supported, as both use CUE4Parse.

## Setup
### Download and run
After using [FModel](https://github.com/4sval/FModel) to determine which paths you wish you extract, download the latest [release](https://github.com/whotookzakum/UnrealExporter/releases) and run `UnrealExporter.exe`.

### Manual setup (recommended)
1. Download and install .NET SDK 9.0
2. Clone the repo, including all submodules, with `git clone https://github.com/whotookzakum/UnrealExporter --recursive`
3. In your terminal, run `dotnet run --project UnrealExporter --`

Example command:
```
dotnet run --project UnrealExporter -- pal.json -m MappingOverride.usmap --create-checkpoint --checkpoint latest
```

If you wish to build the project as a executable binary, use the following command:

```sh
dotnet publish UnrealExporter -c Release --self-contained true -p:PublishSingleFile=true -p:DebugType=None -p:DebugSymbols=false
```

## Usage
UnrealExporter uses reusable config files stored in the `configs` folder (see [example config](/UnrealExporter/examples/palworld-config.json)). Run the program without any arguments to launch the interactive config builder.

For advanced usage, UnrealExporter also accepts command-line arguments — run with `--help` or see [available options](/UnrealExporter/Cli/CliSettings.cs). Command-line arguments override config values when both are provided.

## Checkpoints
Checkpoints allow you to extract only new/modified files and skip unchanged files by keeping track of file sizes (see [example checkpoint](/UnrealExporter/examples/palworld-checkpoint.json)), greatly increasing extraction speed. **Checkpoints will always track all game files, regardless of what you extract/exclude.** Thus it is safe to use an existing checkpoint *and* create a new checkpoint at the same time to repeatedly only extract changed files every time a game updates.

> [!TIP]
> You can quickly create a checkpoint without extracting anything by using the flags `--create-checkpoint --exclude "*"`

> [!TIP]
> `CreateNewCheckpoint` (bool) and `CheckpointFileName` (filename.json) can optionally be added to your config files (see the [example config](/UnrealExporter/examples/palworld-config.json)).

> [!NOTE]
> When adding new ExportPaths to your config, make sure to run UnrealExporter without a checkpoint so the paths you just added will be exported. Otherwise, those paths will not be exported until their contents change.

## Helpful resources
AES Keys:
- [cs.rin.ru UE4/5 Key Collection](https://cs.rin.ru/forum/viewtopic.php?f=10&t=100672)
- [UE4 AES Key Extracting Guide](https://github.com/Cracko298/UE4-AES-Key-Extracting-Guide)
- [AES Finder](https://github.com/mmozeiko/aes-finder)
- Check the `#game-compatibility` channel in the [Fmodel Discord](https://discord.com/invite/fmodel)

Mapping files:
- [Unreal-Mappings-Archive](https://github.com/TheNaeem/Unreal-Mappings-Archive)
- [UnrealMappingsDumper](https://github.com/TheNaeem/UnrealMappingsDumper)
- Check the `#game-compatibility` channel in the [Fmodel Discord](https://discord.com/invite/fmodel)

### Get your own mapping file with UE4SS
1. Download the latest release of [UE4SS](https://github.com/UE4SS-RE/RE-UE4SS) and extract the files to the same location as your game's `-Win64-Shipping.exe` file.
2. Modify the following sections in `UE4SS-settings.ini` 
```diff
[Debug]
+ GuiConsoleEnabled = 1
+ GuiConsoleVisible = 1
...
+ GraphicsAPI = dx11
```
3. Launch the game.
4. In the UE4SS GUI, click on the Dumper tab and output the usmap file. It'll be in the same location (`.../Binaries/Win64/Mappings.usmap`).
5. Copy or move the `.usmap` file to UnrealExporter's `mappings` folder
6. Update your config to match the file name of your mappings file, i.e. `Palworld.usmap`

The exporter should now be able to detect the game files.

UnrealExporter

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README