Skip to content

pySourceSDK/ValvePCF

Repository files navigation

GPLv3 license PyPI pyversions Platforms PyPI version fury.io GitHub Workflow Status (with event) Test coverage

ValvePCF

ValvePCF is a Python library designed to parse and edit .PCF files, which are utilized for storing particle effects data in Valve's Source engine.

Full documentation: https://pysourcesdk.github.io/ValvePCF/

Installation

PyPI

ValvePCF is available on the Python Package Index. This makes installing it with pip as easy as:

pip3 install valvepcf

Git

If you want the latest code or even feel like contributing, the code is available on GitHub.

You can easily clone the code with git:

git clone git@github.com:pySourceSDK/ValvePCF.git

and install it with:

python3 setup.py install

Usage

Here's a few example usage of ValvePCF

Parsing

Parsing can be done by creating an instance of Pcf with a path.

>>> from valvepcf import Pcf
>>> pcf = Pcf('C:/Program Files (x86)/Steam/steamapps/common/Team Fortress 2/tf/particles/custom.pcf')

About

A Python library for parsing and editing .PCF files (particle effect files for the Source engine).

Resources

License

Stars

Watchers

Forks

Languages