Skip to main content
Help us improve Python packaging – donate today!

Python library for parsing the most common Steam file formats.

Project Description

Latest version Travis-CI Coverage
Python library for parsing the most common Steam file formats.
The library has a familiar JSON-like interface: load() / loads() for loading the data,
and dump() / dumps() for saving the data back to the file.

Format support

  Read Write
acf + +
appinfo.vdf + +
Manifest + +

Quickstart

steamfiles requires Python 3.3+

Install the latest stable version:

pip install steamfiles

Import a module for your desired format:

# Use one of these, or all at once!
from steamfiles import acf
from steamfiles import appinfo
from steamfiles import manifest

Easily load data, modify it and dump back:

with open('appinfo.vdf', 'rb') as f:
    data = appinfo.load(f)

# Calculate the total size of all apps.
total_size = sum(app['size'] for app in data.values())
print(total_size)

# Downgrade a change number for all apps.
for app in data.values():
    app['change_number'] -= 1

with open('new_appinfo.vdf', 'wb') as f:
    appinfo.dump(data, f)

Caution: all formats are parsed into dict by default, so the order of data is very likely not the same. As I’m not sure how Steam and related tools deal with rearranged data, pass an OrderedDict class to the wrapper parameter if you plan to write data back and use it later:

from collection import OrderedDict
data = acf.load(f, wrapper=OrderedDict)
# works with other formats as well

Documentation

ACF format overview

More in progress…

TODO

  • [✓] ACF support
  • [✓] appinfo.vdf support (Binary VDF)
  • [✓] Manifest support
  • [?] packageinfo.vdf (Another binary VDF)
  • [?] UserGameStats (achievements)
  • [?] Text VDF files (are they actually ACF?)

License

steamfiles is distributed under the terms of the MIT license.

See the bundled LICENSE file for more details.

Release history Release notifications

This version
History Node

0.1.3

History Node

0.1.2

History Node

0.1.1

History Node

0.1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
steamfiles-0.1.3.tar.gz (10.7 kB) Copy SHA256 hash SHA256 Source None Jul 16, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page