redstrate/physis
1
Fork 0
mirror of https://github.com/redstrate/Physis.git synced 2025-04-22 20:57:46 +00:00
Code Activity
Library for reading and writing FFXIV data
93 commits 3 branches 5 tags 1.3 MiB
Find a file
Joshua Goins 102c8901cf Add game patch integration tests 
Currently only the first two game patches are checked, eventually want
to check boot patching as well. Hopefully this should weed out the
remaining patching issues I encounter.
2022-10-13 15:46:21 -04:00
benches Reformat code 2022-08-16 11:52:07 -04:00
resources/tests Add initial files 2022-07-19 19:29:41 -04:00
src Make apply_patch public 2022-10-13 15:45:50 -04:00
tests Add game patch integration tests 2022-10-13 15:46:21 -04:00
.build.yml Automatically update crate docs on push 2022-08-09 23:55:05 -04:00
.gitignore Add initial files 2022-07-19 19:29:41 -04:00
Cargo.lock Add game patch integration tests 2022-10-13 15:46:21 -04:00
Cargo.toml Add game patch integration tests 2022-10-13 15:46:21 -04:00
deny.toml Update packages, switch to new criterion 0.4.0 2022-09-14 17:20:33 -04:00
LICENSE Add initial files 2022-07-19 19:29:41 -04:00
README.md Add game patch integration tests 2022-10-13 15:46:21 -04:00

README.md

Physis

Crates.io builds.sr.ht status

Framework for interacting with FFXIV data, and successor to libxiv. This intended for developers writing modding tools, launchers and other programs.

Goals

  • Make it extremely easy for people to tinker around with game data.
  • Parsing data should be safe, and unit tested vigorously.
  • Minimal dependencies ;-) All dependencies are also checked by cargo deny.

Features

  • Easily extract game data from SqPack files.
  • Apply game and boot updates, enabling custom launchers to patch the game easily.
  • Blockfish ciphers for encrypting and decrypting SqexArg.
  • Parse various game formats:
    • SqPack index and dat files
    • ZiPatch files
    • All three Excel data types (EXD, EXH, EXL)
    • Models
    • Havok Packfile/TexTool skeletons
    • Textures
    • Materials

Usage

Note: The API will not be stable until 1.0.

If you intend to use this in a Rust project, you can simply include this crate directly. You can view the documentation at docs.xiv.zone!

For other use in languages I maintain libphysis, which is a C wrapper around the same functionality. This isn't for show, I actually use these bindings in other projects.

Development

If you're interested to see how these formats work in more detail, see xiv.dev and docs.xiv.zone! They explain the file formats in more detail, but I also encourage reading the library code as well if you can.

Some tests and benchmarks require the environment variable FFXIV_GAME_DIR to be set. By default, these are disabled since they require a legitimate copy of the retail game data. These tests can be turned on via the retail_game_testing feature.

Game Patch Testing

Patching is an extremely sensitive operation since it is not easily reversible if done wrong. Repairing the game files is also an option, but it's time-consuming and not yet implemented in physis. To prevent regressions in patching the game, I have set up a testing bed for cross-checking our implementation with others. Currently, this is limited to XIVLauncher's implementation, but I will eventually adopt a way to test the retail patch installer as well.

  1. Enable the patch_testing feature.
  2. Set a couple of environment variables:
    • FFXIV_PATCH_DIR is the directory of patches to install. It should be structured as $FFXIV_PATCH_DIR/game/D2017.07.11.0000.0001.patch.
    • FFXIV_XIV_LAUNCHER_PATCHER should be the path to the patcher executable. If you're running on Linux, we will handle running Wine for you.
    • FFXIV_INSTALLER is the path to the installer executable. This will be installed using the usual InstallShield emulation physis already includes.

As you can see, you must have the previous patches downloaded first as well as the installer before running the tests. This is left up to the developer to figure out how to download them legally.

Contributing & Support

The best way you can help is by monetarily supporting me or by submitting patches to help fix bugs or add functionality!