Skip to content

Commit 389c765

Browse files
authored
Update README.md
1 parent dafb545 commit 389c765

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

README.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,20 @@
44

55
# UELib
66

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.
98

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:
1110

1211
UObject, UField, UConst, UEnum, UProperty, UStruct, UFunction, UState, UClass,
1312
UTextBuffer, UMetaData, UPackage
1413

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:
1815

1916
UFont, USound, UPalette, UTexture,
2017
UTexture2D, UTexture2DDynamic, UTexture2DComposite, UTexture3D,
2118
UTextureCube, UTextureFlipBook, UTextureMovie
22-
UPrimitive, UPolys
19+
UPrimitive, UPolys,
20+
UComponent
2321

2422
## Install
2523

@@ -67,11 +65,12 @@ Additionally UELib is also capable of deserializing of many more data classes su
6765
}
6866
```
6967

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)
7169

7270
## Compatible Games
7371

7472
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.
7574

7675
| Name | Engine:Branch | Package/Licensee | Support State |
7776
| --------------------- | ---------------- | ------------------- | ----------------- |
@@ -252,14 +251,19 @@ saved everything before opening any file!**
252251

253252
**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).
254253

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-
259254
## How to contribute
260255

261256
* Open an issue
262257
* 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)
263267

264268
## Special thanks to
265269

0 commit comments

Comments
 (0)