vgio icon indicating copy to clipboard operation
vgio copied to clipboard

File I/O for video games

vgio

vgio

Python 3.6 PyPI version Build Status Documentation Status Discord

vgio is a Python package for video game file I/O

Mission

  • Pythonic: Clean and well written Python.
  • Domain-specific: The APIs and objects reflect the source code and community knowledge.
  • Complete: Support as many file types as possible.
  • Robust: The APIs and objects are thoroughly unit tested.

Supported Games

  • Devil Daggers
  • Duke Nukem 3D
  • Hexen II
  • HROT
  • Quake
  • Quake II

Installation

$ pip install vgio

Usage

from vgio.quake.bsp import Bsp

with Bsp.open('./maps/start.bsp') as bsp_file:
   """Do rad stuff with the BSP data structure!"""

Documentation

API documentation is available on readthedocs.

Tests

$ python -m unittest discover

License

MIT

See the license document for the full text.