Welcome to PyFFI!¶
|Date:||August 10, 2019|
The Python File Format Interface, briefly PyFFI, is an open source Python library for processing block structured binary files:
- Simple: Reading, writing, and manipulating complex binary files in a Python environment is easy! Currently, PyFFI supports the NetImmerse/Gamebryo NIF and KFM formats, CryTek’s CGF format, the FaceGen EGM format, the DDS format, and the TGA format.
- Batteries included: Many tools for files used by 3D games, such as optimizers, stripifier, tangent space calculator, 2d/3d hull algorithms, inertia calculator, as well as a general purpose file editor QSkope (using PyQt4), are included.
- Modular: Its highly modular design makes it easy to add support for new formats, and also to extend existing functionality.
To get the latest (but possibly unstable) code, clone PyFFI from its Git repository:
git clone --recursive git://github.com/niftools/pyffi.git virtualenv -p python3 venv source venv/bin/activate pip install -r requirements-dev.txt
Be sure to use the –recursive flag to ensure that you also get all of the submodules.
We love tests, they help guarantee that things keep working they way they should. You can run them yourself with the following:
source venv/bin/activate nosetest -v test
source venv/bin/activate py.test -v tests
All our documentation is written in ReST and can be generated into HTML, LaTeX, PDF and more thanks to Sphinx. You can generate it yourself:
source venv/bin/activate cd docs make html -a
pyffi— Interfacing block structured files
- How to contribute
- Todo list