KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

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

REE-Content-Editor

★ 96 Open GitHub ↗

Mod development 3D editor tool and file patcher for RE Engine games

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# REE Content Editor
Desktop tool for editing and partial patching the files of all RE ENGINE titles. The project is based on [REE-Lib](https://github.com/kagenocookie/RE-Engine-Lib) for file editing and a [Hexa.NET.ImGui](https://github.com/HexaEngine/Hexa.NET.ImGui)-based UI with full 2D and 3D graphics capabilities. It can provide most functionality needed for mod development.

Besides basic file editing, the tool is able to merge multiple changes to the same file with autogenerated JSON + file "bundles", allowing easy modification of content even when shared catalog files need to be modified by multiple mods. This can also make upgrading data easier after game updates break files with no major structural differences (which is most of the time). The patcher can emit the patched files either directly into the natives folder or into a patch PAK file.

![UI overview](https://raw.githubusercontent.com/kagenocookie/REE-Content-Editor/master/.github/overview.png)

## Supported games
- All mainline Resident Evil games
- Dragon's Dogma 2
- Devil May Cry 5
- Pragmata

Some files may not fully work for other RE ENGINE games. Due to their complexity and frequent changes, .efx files may take longer to add support for new games compared to other file types.

## Setup - Windows
- Install the .NET Desktop Runtime 10 or newer (https://dotnet.microsoft.com/en-us/download/dotnet/10.0)
- Download the latest [release](https://github.com/kagenocookie/REE-Content-Editor/releases) or [debug](https://github.com/kagenocookie/REE-Content-Editor/actions) build `ContentEditor-win64.zip` (a GitHub account is required to download the debug builds)
- Launch `ContentEditor.App.exe`
- Usage guides are available on [the wiki](https://github.com/kagenocookie/REE-Content-Editor/wiki), these will be updated as new features are added and improved

## Setup - Linux
There's 2 ways of running Content Editor from linux, either through wine or as a native app. The native app has the drawback of not supporting GPU accelerated tex compression for BC7 due to lack of directX (and the CPU compression takes literally forever), but should otherwise work fine. On the other hand, the wine version has the drawback of a terrible file picker, so choose your poison.

### Linux - Native
- Install the .NET Runtime 10 or newer (https://dotnet.microsoft.com/en-us/download/dotnet/10.0)
- Download the latest [release](https://github.com/kagenocookie/REE-Content-Editor/releases) or [debug](https://github.com/kagenocookie/REE-Content-Editor/actions) build `ContentEditor-linux.zip` (a GitHub account is required to download the debug builds)
- Launch `ContentEditor.App`
- Usage guides are available on [the wiki](https://github.com/kagenocookie/REE-Content-Editor/wiki), these will be updated as new features are added and improved

### Linux - Wine
You can't launch the windows exe directly even with wine due to the .NET dependency, so we need to install that first

- It should be doable with any wine helper app, but here's a Lutris example:
- Add game => Runner = Wine, Executable = path to the .NET 10 installer
- Consider giving it a custom wine prefix path if you want to be able to more easily uninstall it all later
- Launch the installer
- After it's done, swap the executable path to the extracted `ContentEditor.App.exe` (either [release](https://github.com/kagenocookie/REE-Content-Editor/releases) or [debug](https://github.com/kagenocookie/REE-Content-Editor/actions) build)
- After that you should be able to launch it normally and it should open
- Note that all disk file path settings need to be `Z:/var/path/...` and not the normal linux root equivalent
- You can make the app shortcut prettier inside Lutris by pointing it to the app logo .png from [here](https://github.com/kagenocookie/REE-Content-Editor/blob/master/docs/REECE_Logo_Raster_Light.png)

## Development setup
- Requirements: .NET 10.0 SDK, git
- Clone the repository
- `git submodule init`
- `git submodule update`
- Use the `net10.0-windows` target to enable windows specific APIs (better drag & drop and GPU tex compression)
- Build with `dotnet build` or whichever C#-capable IDE's build features (vscode, VS)

## Features
- Most of the important files are supported for both viewing and editing
- 3D view for all supported meshes, scene and prefab files (via the "Scenes" menu)
- Full 3D animation preview and import/export support
- Interactive 3D collider shape editor for scenes and collider resource files
- Load files directly from the PAK files, access what you need directly without having to extract anything
- File search tool for easily finding things across all game files: field values, object classes, localization strings
- Partial patching of files in case multiple mods would need to modify the same shared file (e.g. content catalog files)
- Streamlined editors for game-specific content (these need to be researched and set up per game so the feature may not be available for all games - mostly configurable through yaml files. See [Entities](#entities))
- Full undo/redo system

### File support table
<div align="center">

| File type | Basic support | Additional features |
| --------- | ------- | ---------------- |
| .pak      | ☑️ read/create | Direct file access, file extraction
| .user     | ☑️ read/write | Partial patching individual fields
| .pfb      | ☑️ read/write | Partial patching individual fields, 3D preview
| .scn      | ☑️ read/write | Partial patching individual fields, 3D preview
| .msg      | ☑️ read/write | Partial patching individual translations
| .uvs      | ☑️ read/write | Animation preview
| .uvar     | ☑️ read/write
| .mdf2     | ☑️ read/write
| .efx      | ☑️ read/write
| .tex, .dds  | ☑️ view, convert  | Convert between TGA/PNG/DDS/TEX<br>Format conversion across games<br>Batch conversion
| .mesh     | ☑️ 3D & data display | FBX & GLTF export/import<br>Format conversion across games ([wiki](https://github.com/kagenocookie/REE-Content-Editor/wiki/Mesh-editing))
| .motlist  | ☑️ read/write | Animation preview<br>GLTF import/export<br>Mot copy/paste/retargeting ([wiki](https://github.com/kagenocookie/REE-Content-Editor/wiki/Animation-tools))
| .rcol     | ☑️ read/write | 3D shape preview and editing ([wiki](https://github.com/kagenocookie/REE-Content-Editor/wiki/RCOL-Request-set-colliders))
| .chain, .chain2 | ☑️ read/write | Collision shape and limit 3D display
| .motbank  | read/write
| .motfsm2, .fsmv2, .bhvt, .tmlfsm2  | read/write
| .mcol     | ☑️ read/write | .glb/.fbx import/export for collision mesh
| .tml, .clip | read/write
| .gui      | read/write
| .aimap, .ainvm, .aiwayp | read/write | 3D preview<br>Navmesh generation ([wiki](https://github.com/kagenocookie/REE-Content-Editor/wiki/AI-Navigation))
| .cdef, .def | ☑️ read/write
| common image formats | ☑️ view, convert
| common mesh formats | ☑️ 3D display | Convert to RE mesh
| many other misc files | raw data read/write

</div>

*File types marked with ☑️ are effectively feature complete for most usecases.*

<a id="entities"></a>
## Custom entity support

Accessible under the Windows > Entities menu option for supported games, these are streamlined editors for game-specific data. They can be used to more easily modify or add custom items and other game content related objects. YAML configuration file example [here](https://github.com/kagenocookie/REE-Content-Editor/blob/master/configs/dd2/definitions/items.yaml).

## Game-specific additional support

### Dragon's Dogma 2

Field scene streaming is supported through the `natives/stm/appdata/maincontents.scn.20` file while the `Field` folder is active. The open world scenes should load and unload based on the camera position.

For any spawn related data editing, my [anatomically accurate map](https://kagenocookie.github.io/dd2map/) can be used as a reference for grid cells and positions

#### Custom entities:
- Shop modifications
- Custom basic items and weapons (TODO: armors)
- Weather parameters
- NPC appearance and costume parameters
- Events
- Quest data (partial)
- Job and skill metadata

### Resident Evil 2 (RT), 3 (RT), 4, 8
- Basic weapon data entities

### Pragmata
- Costume prefab catalog entities

## Structure
The project consists of several individual modules.

#### Content Editor Core
The core content editor features for bundle management are in here. This could eventually serve as a base for a .NET port for an ingame editor once the REFramework C# API stabilizes.

#### Content Editor App
Serves as both a general resource editing tool, while also providing specialized and streamlined YAML-configurable functionality for some objects.

#### Content Patcher
Contains tools for evaluating, generating, and applying resource file patches. Can be used as a CLI tool for only updating patches without any of the UI overhead.

The patcher also outputs separate .txt files into the `reframework/data/injected_enums` folder containing any custom enum entries needed by entities, intended for usage with [REE-Enum-Injector](https://github.com/kagenocookie/REE-Enum-Injector).

## Patching architecture
All the patching logic is based on 3 layers of modifications: files, resource objects and entities, each built on top of the previous layers.

- Files represent the individual .user, .msg, .pfb, etc files, identified by their filepath. Every editable file goes under this layer.
- Resource objects are individual unique objects within one or multiple files. These always support partial patching.
- Entities group together multiple resources into one logical and more easily digestable unit. These allow "Content Editor" style centralized editing of data.

Patchable resources and entities are defined in `configs/<game>/definitions/*.yaml` files, intended to be easily extendable without modifying the code based on predefined patcher methods.

There are some cases where doing a full overwrite of files may be required because the patch generation can't reliably detect some types of changes. You can mark a file as `"replace": true` in the bundle json file for those cases, which will fully replace the files instead of doing partial patching.
- Removal of objects may not always get detected correctly or just not handled at all
- Inserting new elements in the middle of an array or reordering them may not always interact correctly with multiple mods. Adding elements at the end is perfectly fine, and the app generally only lets you do that.
- Renaming existing GameObjects or folders may not work as expected because the pfb/scn patching relies on consistent names

***Resource object***

Represents a single uniquely identifiable "object". This can be anything from an individual translation message entry, an item's base data / icon / name / description field, or a quest name / summary / log entry / condition set / etc...

A resource needs to be individually editable, it can be either a whole file, or a single object within the file, or possibly an object that doesn't have a specific file (multiple potential files) but is still stored in exactly one place.

***Entity***

An entity is, effectively, a group of resources. In the case of an item, it would contain all the individual resources needed for an item to work - name and description message, icon, base data, enhance requirements, crafting combinations, ...

Each entity needs to have a unique integer (int64) ID. Where possible, this is directly equivalent to the game IDs, but where those aren't available, can be a hashed combination of fields (e.g. a GUID or multiple fields hashed together into an integer).

***Bundle***

A bundle can contain any number of data modifications, effectively describes a single "mod" or "patch". There is always the bundle.json file containing all information on what it changes and how. Can also contain any number of raw modified files, linked to by the resource_listing field of the bundle json, to tell the patcher where to place the file and if it should be a full replacement or a partial patch.

One bundle modifying the same file as a direct file and through entities at the same time is "undefined" and may or may not work as expected. During the patching process, direct file modifications are processed before entities within the individual bundle.

## Contributing
Pull requests are welcome. There are several open issues for bigger features for anyone interested in helping, but if you feel like anything else could be improved upon, feel free to make a feature request or contribute yourself. I'm willing to assist with pointers regarding implementation details.

## Credits
- Everyone who contributed to or was acknowledged in [RE-Engine-Lib](https://github.com/kagenocookie/RE-Engine-Lib)
- alphaZomega: mot bone remapping configs for re2 and re3

## Disclaimer
This project is in no way affiliated with, endorsed by, or connected to RE ENGINE, Capcom, or any of their affiliates. All trademarks are the property of their respective owners.

REE-Content-Editor

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README