Giter Club home page Giter Club logo

cue4parse's Introduction

CUE4Parse

C# Parser for Unreal Engine packages & assets

Usage

FileProvider

DefaultFileProvider

This file provider lets you load packages locally from a given directory.

var provider = new DefaultFileProvider(gameDirectory, SearchOption.TopDirectoryOnly);
provider.Initialize();
StreamedFileProvider

This file provider lets you load packages from their stream and gives you more control over what one you want to load.

var provider = new StreamedFileProvider(gameName); // gameName is not useful for most cases
provider.Initialize(fileName, new []{fileStream}); // foreach file you wanna load
// the 'fileStream' array must contains both .utoc AND .ucas streams in case you're loading an IO Store Package

Mounting

The next step is mounting files you loaded, you can do so by using the SubmitKey method. You must provide a GUID of one of the packages and its working aes key.

Provider.SubmitKey(guid, aesKey);

Localization

Depending on the game, assets can be loaded using different languages (usually English by default). In order to load them in another language, use the following code. Keep in mind that languages hardcoded in CUE4Parse are a small amount of languages used by the most popular games, you might have to add your own language in the code to support the game you're loading.

Provider.LoadLocalization(language);

Extract

All Exports

To get a json string of all exports included in the asset

var exports = Provider.LoadObjectExports(fullPath);
var json = JsonConvert.SerializeObject(exports, Formatting.Indented);
One Export

To get a json string of one export included in the asset

var export = Provider.LoadObject(fullPathWithExportName); // FortniteGame/Content/Athena/Items/Cosmetics/Backpacks/BID_718_ProgressiveJonesy.FortCosmeticCharacterPartVariant_0
var json = JsonConvert.SerializeObject(export, Formatting.Indented);

Export

An asset usually has its data split between multiple other assets. In order to grab them all, use TrySavePackage which will out a IReadOnlyDictionary<string, byte[]> for you to loop through.

if (Provider.TrySavePackage(fullPath, out var assets))
{
    foreach (var kvp in assets)
    {
        File.WriteAllBytes(Path.Combine(directory, kvp.Key), kvp.Value);
    }
}

Contributing

Contributions are always welcome in order to maintain the project!

Authors

cue4parse's People

Contributors

4sval avatar amrsatrio avatar ezfndev avatar fabianfg avatar gmatrixgames avatar minshug avatar xtigerhyperx avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.