redstrate/libxiv
Archived
1
Fork 0
Code Activity

Update README

Browse source
This commit is contained in:
Joshua Goins 2022-04-11 12:33:10 -04:00
parent fbe386c958
commit da7e84c53d
1 changed files with 24 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
README.md
View file

@ -8,16 +8,30 @@ mirror](https://img.shields.io/badge/mirror-ryne.moe-red.svg?logo=git)](https://
A modding framework for FFXIV written in C++. This is intended for use [Novus](https://git.sr.ht/~redstrate/novus), my custom modding tool - but it's eventually
going to be integrated into [Astra](https://git.sr.ht/~redstrate/astra) as well.
## Goals
* Be integratable into launchers for updating support.
* Can export penumbra mods, I have no interest in exporting in TexTools's format.
* Can export/edit some formats such as models, and metadata/exl.
**Note:** This is still an experimental and in-development library. Thus, I have not tagged any stable releases. It's recommended just to checkout from main.
## Dependencies
* fmt for formatting
* z for zlib support, needed for dat files
* unshield for extracting cab files for bootstrapping
## Goals
* Easily integratable into other FFXIV launchers so they can have update/install support without having to write it themselves.
* Can export Penumbra/Lumina format mods, I have no interest in exporting in TexTools's format.
* Can export/edit some formats such as models, and metadata/exl files.
* Can be used on Windows/Linux/macOS and doesn't pull in a huge runtime (C#) or run in Wine.
## Features
* Can read index/index2/dat/exh/exl files (see Xparser.h)
* Can extract bootstrap files required to start FFXIV for the first time (see installextract.h)
* Easily extract game files and view excel sheets by name. See [gamedata.h](include/gamedata.h) for usage.
* Install patches (right now it's limited to boot patches). See [patch.h](include/patch.h) for usage.
* Install FFXIV by emulating the official installer, bypassing Wine and InstallShield. You can see how to use this in [installextract.h](include/installextract.h).
* Parse some game data:
* [EXD](include/exdparser.h)
* [EXH](include/exhparser.h)
* [EXL](include/exlparser.h)
* [FIIN](include/fiinparser.h)
* [INDEX/INDEX2](include/indexparser.h)
## Dependencies
**Note:** Some of these dependencies will automatically be downloaded from the Internet if not found
on your system.
* [fmt](https://fmt.dev/latest/index.html) for formatting strings and logs.
* [zlib](https://www.zlib.net) for extracting data.
* [unshield](https://github.com/twogood/unshield) for extracting cab files from the FFXIV installer. This dependency is automatically skipped on Windows builds
because unshield lacks a port for it.