From 00043b5260ae111984be1a56e17a008f350b9795 Mon Sep 17 00:00:00 2001
From: Waddlesworth <github@genj.io>
Date: Fri, 13 Nov 2020 13:34:21 +1100
Subject: [PATCH] updated readme

---
 README.md | 45 ++++++++++++++++++++++++++++++++++-----------
 1 file changed, 34 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index c9ac9ab..42b6f29 100644
--- a/README.md
+++ b/README.md
@@ -4,26 +4,50 @@ NodeJS Bindings for the JohnWickParse library
 
 ## Extracting
 
-The `PakExtractor` class is used to extract files from a .pak, and it's use is pretty basic.
+The `Extractor` class is used to extract files from a .utoc/ucas.
+
+The AES key is ignored in the case of non-encrypted .utoc/ucas files, so an empty string is acceptable in these cases, although null or undefined may produce an error.
+
+### Requirements
+
+Extracting from utoc/ucas archives requires that `oo2core_8_win64.dll` is in the working directory on Windows, and `oo2core_8_win64.so` is present on Linux.
+
+[Linoodle](https://github.com/McSimp/linoodle) is an acceptable substitute for `oo2core_8_win64.so` on Linux systems.
 
 ```javascript
 const fs = require('fs');
-const { PakExtractor } = require('node-wick');
+const { Extractor } = require('node-wick');
 
-// Make a new PakExtractor by specifying the file path, and the AES encryption key as a hexadecimal string.
-let extractor = new PakExtractor("pakchunk.pak", "0000000000000000000000000000000000000000000000000000000000000000");
+// Make a new Extractor by specifying the file path (minus the extension), and the AES encryption key as a hexadecimal string.
+let extractor = new Extractor("pakchunk", "");
 
-// Iterate over all the files in the pak, and extract them.
-// get_file_list returns an array of file paths within the pak. You will need the index in the array to extract the files.
+// Iterate over all the files in the ucas, and extract them.
+// get_file_list returns an array of file paths within the ucas. You will need the index in the array to extract the files.
 extractor.get_file_list().forEach((v, idx) => {
-    // get_file(index) returns a NodeJS Buffer with the decrypted file contents.
-    fs.writeFileSync(v, extractor.get_file(idx));
+    // get_file(path) returns a NodeJS Buffer with the decrypted file contents.
+    fs.writeFileSync(idx + ".uasset", extractor.get_file(v));
 });
 ```
 
 ## Parsing
 
-The `Package` class lets you parse files uasset/uexp files. It has two constructors:
+### New Asset Format Requirements
+
+As of Fortnite 14.40, asset files now use a format known as 'Unversioned Properties'. This format is no longer self-describing, and parsing them is significantly more complex. This library attempts to simplify this using 'mapping' files, which contain the description of each class that is necessary to parse that class of asset file.
+
+The official mapping files for `node-wick` are hosted on the [JohnWickParse repository](https://github.com/SirWaddles/JohnWickParse/tree/master/mappings). However, these are incomplete, and are at best, the bare minimum required to parse the item descriptions for the Fortnite shop.
+
+[Lucas7Yoshi](https://twitter.com/Lucas7yoshi) also maintains a repository of asset class mappings, which you can find on his [GitHub repository](https://github.com/Lucas7yoshi/FNMappingsJWP).
+
+[FunGames](https://twitter.com/FunGamesLeaks) and [Officer](https://twitter.com/Not0fficer) also maintain a [repository of mapping files](https://github.com/FabianFG/FortniteTypeMappings), however these are in a different format to that used by `node-wick`, but a converter can be used to translate these mappings.
+
+The mapping files **must** be present in the `mappings` inside the working directory. Any parsing **will fail** if they are not present. There are two types of mapping file, contained in the `mappings/classes` directory and the `mappings/enums` directory.
+
+Parsing assets also requires that the `global.utoc` and `global.ucas` files are present in the `paks/` directory, again in the working directory. You can use `wick-downloader` to download these files if necessary. The global files must match the version of Fortnite that the assets were obtained from.
+
+### Parsing Files
+
+The `Package` class lets you parse files uasset files. It has two constructors:
 ```javascript
 const { Package } = require('node-wick');
 
@@ -33,9 +57,8 @@ let asset = new Package("./assets/test");
 // Construct a package from several buffers
 // Note that the ubulk buffer is optional, but the parser will error if you try to parse an asset that requires it.
 let uassset_buf = fs.readFileSync("./assets/test.uasset");
-let uexp_buf = fs.readFileSync("./assets/test.uexp");
 let ubulk_buf = fs.readFileSync("./assets/test.ubulk");
-let asset = new Package(uasset_buf, uexp_buf, ubulk_buf);
+let asset = new Package(uasset_buf, ubulk_buf);
 ```
 
 You can get a JSON object of the internal parameters of the objects, using the `get_data` method: