atenfyr / UAssetGUI

A tool designed for low-level examination and modification of Unreal Engine game assets by hand.
MIT License
525 stars 75 forks source link
c-sharp gui json modding modding-tools unreal-engine

UAssetGUI

Release Downloads Issues CI Status License

UAssetGUI is a tool designed for low-level examination and modification of Unreal Engine game assets by hand.

Installation

You can find pre-built binaries of UAssetGUI in the Releases tab of this repository.

Command line arguments

You can run the program with command line arguments to export to and import from JSON, without opening the GUI.

Export to JSON

UAssetGUI tojson <source> <destination> <engine version> [mappings name]

Example: UAssetGUI tojson A.uasset B.json VER_UE4_25

Import from JSON

UAssetGUI fromjson <source> <destination> [mappings name]

Example: UAssetGUI fromjson B.json A.umap Outriders

Compilation

If you'd like to compile UAssetGUI for yourself, read on:

Prerequisites

Initial Setup

  1. Clone the UAssetGUI repository:
git clone https://github.com/atenfyr/UAssetGUI.git
  1. Switch to the new UAssetGUI directory:
cd UAssetGUI
  1. Pull the required submodules:
git submodule update --init
  1. Open the UAssetGUI.sln solution file in Visual Studio, right-click on the UAssetGUI project in the Solution Explorer, and click "Set as Startup Project."

  2. Right-click on the solution name in the Solution Explorer, and press "Restore Nuget Packages."

  3. Press the "Start" button or press F5 to compile and open UAssetGUI.

Contributing

Any contributions, whether through pull requests or issues, that you make are greatly appreciated.

If you have an Unreal Engine .uasset file that displays "failed to maintain binary equality," feel free to submit an issue on the UAssetAPI issues page with a copy of the asset in question along with the name of the game, the Unreal version that it was cooked with, and a mappings file for the game, if needed.

License

UAssetAPI and UAssetGUI are distributed under the MIT license, which you can view in detail in the LICENSE file.