diff --git a/README.md b/README.md index d771d54..3b6781b 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ QuickTag is a tool that scans and analyzes Tiger engine structure files (also kn ## How does QuickTag work? -When first starting QuickTag (or after an update), QuickTag goes through every package file and scans the data for file references, string hashes and raw strings. +When first starting QuickTag (or after a game update), QuickTag goes through every package file and scans the data for file references, string hashes and raw strings. It does this by checking file references and string hashes against a set of valid values, which is generated from the information [destiny-pkg](https://github.com/v4nguard/destiny-pkg) provides. It then stores the scanned information to a cache file so the next time QuickTag is started, it doesn't have to scan every package file again. @@ -33,6 +33,8 @@ Upwards traversal is not supported yet. ### (Localized) Strings The strings tab shows any localized strings found in package files. These strings are referenced by a 32-bit FNV hash (note that this is not the hash of the string itself, but rather the hash of a localization key). Due to this, there will be multiple strings with the same hash, but different text. QuickTag will collapse these into a single entry, showing any strings that use this hash, as well as the tags that reference them. Note that due to the nature of FNV hashes, there will be a lot of false positives and overlapping strings in some cases. +These strings only include the English version of the string. Other languages can be dumped through Quicktag, but they can't be used for the built-in search. + ### Raw Strings Like the strings tab, the raw strings tab shows any strings that are found with the raw string table tag (0x80800065). These strings are usually used for debugging purposes, and can't be found in-game. Unlike localized strings, which are referenced by a hash, raw strings are referenced by other data in the file that the string is in. @@ -52,8 +54,8 @@ quicktag.exe -v ``` Where `` is the version of the game used by the given packages. These correspond to the ones used by `destiny-pkg`: -- `d1_ttk` PS3/X360 version of Destiny (The Taken King) -- ~~`d1_roi` The latest version of Destiny (Rise of Iron)~~ +- `d1_ttk` "Legacy" version of Destiny (The Taken King) +- `d1_roi` The latest version of Destiny (Rise of Iron) - `d2_beta` Destiny 2 Beta - `d2_sk` The last version of Destiny before Beyond Light (Shadowkeep/Season of Arrivals) - `d2_bl` Destiny 2 (Beyond Light/Season of the Lost) @@ -61,7 +63,7 @@ Where `` is the version of the game used by the given packages. These c - `d2_lf` Destiny 2 (Lightfall) > [!WARNING] -> `d1_ttk` support is WIP, and `d1_roi` still lacks support in `destiny-pkg`. +> `d1_ttk` and `d1_roi` support is WIP ## Building Alkahest needs Rust 1.70 or newer to build. You can install Rust from [rustup.rs](https://rustup.rs/).