redstrate/physis
1
Fork 0
mirror of https://github.com/redstrate/Physis.git synced 2025-05-07 19:17:45 +00:00
Code Activity

Reduce fluff in README even more

Browse source
This commit is contained in:
Joshua Goins 2025-04-28 23:16:27 -04:00
parent 8f7a6cc546
commit 257f286990
2 changed files with 5 additions and 33 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
CONTRIBUTING.md
View file

@ -17,9 +17,11 @@ run automatically by the CI.
### Retail Testing ### Retail Testing
There are some tests and benchmarks require the environment variable `FFXIV_GAME_DIR` to be set. By default, these are disabled There are 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` since they require a legitimate copy of the retail game data. These tests can be turned on via the `retail_testing`
feature. feature.
I have a testing platform that tests Physis against multiple game versions. Currently it has to be manually run, and it's lacking a results web page.
### Patch Testing ### Patch Testing
Patching is an extremely sensitive operation since it is not easily reversible if done wrong. Repairing the game files Patching is an extremely sensitive operation since it is not easily reversible if done wrong. Repairing the game files

34
README.md
View file

@ -1,38 +1,8 @@
# Physis # Physis
[![Crates.io](https://img.shields.io/crates/v/physis)](https://crates.io/crates/physis) [![Crates.io](https://img.shields.io/crates/v/physis)](https://crates.io/crates/physis) [![Docs Badge](https://img.shields.io/badge/docs-latest-blue)](https://docs.xiv.zone/docs/physis)
Physis is a library for reading and writing FFXIV data. Physis is a library for reading and writing FFXIV data. It doesn't only know how to read many formats, but it can write some of them too.
## Features
Here is a list of supported formats and their status:
| File Format | Read | Write | Note |
| --- | --- |-------|----------------------------------------------------------------------------------------------------|
| [Configuration files](https://docs.xiv.zone/format/cfg/) | ✅ | ✅ | |
| [Saved character data](https://docs.xiv.zone/format/chardat/) | ✅ | ✅ | |
| [Chara make params](https://docs.xiv.zone/format/cmp/) | ✅ | ❌ | |
| Dictionaries | ✅ | ❌ | |
| [Excel data](https://docs.xiv.zone/format/exd/) | ✅ | ❌ | |
| [File infos](https://docs.xiv.zone/format/fiin/) | ✅ | ✅ | |
| Map layers | ✅ | ❌ | Layer support isn't well tested yet. |
| [Chat logs](https://docs.xiv.zone/format/log/) | ✅ | ❌ | Not all chat categories are discovered yet. |
| [Models](https://docs.xiv.zone/format/mdl/) | ✅ | ✅ | Adding custom shape keys aren't fully supported yet. |
| [Materials](https://docs.xiv.zone/format/mtrl/) | ✅ | ❌ | |
| Patch files | ✅ | ~ | ZiPatch writing support is currently being worked on, but many operations are not yet implemented. |
| Pre bone deformers | ✅ | ❌ | |
| [Shader packages](https://docs.xiv.zone/format/shpk/) | ✅ | ❌ | |
| [Skeletons](https://docs.xiv.zone/format/sklb/) | ✅ | ❌ | |
| Terrain | ✅ | ❌ | |
| [Textures](https://docs.xiv.zone/format/tex/) | ✅ | ❌ | Only some formats are supported. |
Physis also supports doing some other useful things other than reading and writing file formats:
* Extract game data from SqPack files, and list file hashes from index/index2.
* Apply game patches. Indexed ZiPatch is not yet supported, though.
* Blockfish ciphers for encrypting and decrypting [SqexArg](https://docs.xiv.zone/concept/sqexarg/).
* Construct paths to equipment, items, faces, and other useful models.
## Supported Game Versions ## Supported Game Versions