|
4 | 4 |
|
5 | 5 | # UELib
|
6 | 6 |
|
7 |
| -The Unreal library (UELib) provides you an API to read (parse/deserialize) the contents of Unreal Engine game package files such as .UDK, .UPK. |
8 |
| -Its main purpose is to decompile the UnrealScript byte-code to its original source-code. |
| 7 | +The Unreal library (UELib) provides you an API to read (parse/deserialize) contents of Unreal Engine game package files, such as .UDK and .UPK files. |
9 | 8 |
|
10 |
| -It accomplishes this by reading the necessary Unreal data classes such as: |
| 9 | +The main goal of UELib is to decompile the UnrealScript byte-code, which is achieved by reconstructing the original UnrealScript source from Unreal data classes: |
11 | 10 |
|
12 | 11 | UObject, UField, UConst, UEnum, UProperty, UStruct, UFunction, UState, UClass,
|
13 | 12 | UTextBuffer, UMetaData, UPackage
|
14 | 13 |
|
15 |
| -Classes such as UStruct, UState, UClass, and UFunction contain the UnrealScript byte-code which we can deserialize in order to re-construct the byte-codes to its original UnrealScript source. |
16 |
| - |
17 |
| -Additionally UELib is also capable of deserializing of many more data classes such as: |
| 14 | +UELib is also capable of deserializing other Unreal data classes: |
18 | 15 |
|
19 | 16 | UFont, USound, UPalette, UTexture,
|
20 | 17 | UTexture2D, UTexture2DDynamic, UTexture2DComposite, UTexture3D,
|
21 | 18 | UTextureCube, UTextureFlipBook, UTextureMovie
|
22 |
| - UPrimitive, UPolys |
| 19 | + UPrimitive, UPolys, |
| 20 | + UComponent |
23 | 21 |
|
24 | 22 | ## Install
|
25 | 23 |
|
@@ -67,11 +65,12 @@ Additionally UELib is also capable of deserializing of many more data classes su
|
67 | 65 | }
|
68 | 66 | ```
|
69 | 67 |
|
70 |
| -If you're looking to modify the library for the sole purpose of modding [UE Explorer](https://github.com/UE-Explorer/UE-Explorer), I recommend you to clone or fork this repository and install UE Explorer within your ```UELib/src/bin/Debug/``` folder, or change the project's configuration to build inside of the UE Explorer's folder. |
| 68 | +If you're looking to modify the library for the sole purpose of modding [UE Explorer](https://github.com/UE-Explorer/UE-Explorer) consider forking UE Explorer instead (UELib is linked as a sub-module) |
71 | 69 |
|
72 | 70 | ## Compatible Games
|
73 | 71 |
|
74 | 72 | This is a table of games that are confirmed to be compatible with the current state of UELib, the table is sorted by Package-Version.
|
| 73 | +Do you know a game that is compatible but is not listed here? Feel free to send a pull-request. |
75 | 74 |
|
76 | 75 | | Name | Engine:Branch | Package/Licensee | Support State |
|
77 | 76 | | --------------------- | ---------------- | ------------------- | ----------------- |
|
@@ -252,14 +251,19 @@ saved everything before opening any file!**
|
252 | 251 |
|
253 | 252 | **Note** UE3 production-ready packages are often **compressed** and must first be decompressed, [Unreal Package Decompressor](https://www.gildor.org/downloads) by **Gildor** is a tool that can decompress most packages for you; for some games you need a specialized decompressor, see for example [RLUPKTool](https://github.com/AltimorTASDK/RLUPKTool).
|
254 | 253 |
|
255 |
| -Want to add support for a game? See [adding support for new Unreal classes](https://github.com/EliotVU/Unreal-Library/wiki/Adding-support-for-new-Unreal-classes) |
256 |
| - |
257 |
| -Do you know a game that is compatible but is not listed here? Click on the top right to edit this file! |
258 |
| - |
259 | 254 | ## How to contribute
|
260 | 255 |
|
261 | 256 | * Open an issue
|
262 | 257 | * Or make a pull-request by creating a [fork](https://help.github.com/articles/fork-a-repo/) of this repository, create a new branch and commit your changes to that particular branch, so that I can easily merge your changes.
|
| 258 | + |
| 259 | +Want to add support for a game? See [adding support for new Unreal classes](https://github.com/EliotVU/Unreal-Library/wiki/Adding-support-for-new-Unreal-classes) |
| 260 | + |
| 261 | +## Made with the help of UELib |
| 262 | + |
| 263 | +* [UnrealScript to C# Conversion](https://github.com/Eideren/Unreal-Library) and [Mirror's Edge Decompiled](https://eideren.com/posts/mirrors-edge-decompiled.html?i=1) |
| 264 | +* [Duke Nukem Forever: Enhanced](https://www.moddb.com/mods/duke-nukem-forever-enhanced) |
| 265 | +* [UE3 Shader Cache Patcher](https://github.com/tuokri/UE3ShaderCachePatcher) |
| 266 | +* [UnrealFlagEditor](https://github.com/Un-Drew/UnrealFlagEditor) |
263 | 267 |
|
264 | 268 | ## Special thanks to
|
265 | 269 |
|
|
0 commit comments