[](https://github.com/pySourceSDK/ValvePCF/blob/master/LICENSE.txt)
[](https://pypi.python.org/pypi/valvepcf/)
[]()
[](https://pypi.python.org/pypi/valvepcf/)
[]()
[]()
# 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:
```bash
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:
```bash
git clone git@github.com:pySourceSDK/ValvePCF.git
```
and install it with:
```bash
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.
```python
>>> from valvepcf import Pcf
>>> pcf = Pcf('C:/Program Files (x86)/Steam/steamapps/common/Team Fortress 2/tf/particles/custom.pcf')
```
Raw data
{
"_id": null,
"home_page": "https://pysourcesdk.github.io/ValvePCF/",
"name": "valvepcf",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "pcf,source,sourcesdk,hammer,valve",
"author": "Maxime Dupuis",
"author_email": "mdupuis@hotmail.ca",
"download_url": "https://files.pythonhosted.org/packages/0a/5b/a29e93b097080a8cc354c726334a8f5c9e0e69b7692b20bce12e1ab14c3b/valvepcf-1.1.2.tar.gz",
"platform": null,
"description": "[](https://github.com/pySourceSDK/ValvePCF/blob/master/LICENSE.txt)\n[](https://pypi.python.org/pypi/valvepcf/)\n[]()\n[](https://pypi.python.org/pypi/valvepcf/)\n[]()\n[![Test coverage](https://github.com/pySourceSDK/ValvePCF/blob/master/docs/source/coverage.svg \"coverage\")]()\n\n# ValvePCF\n\nValvePCF is a Python library designed to parse and edit .PCF files, which are utilized for storing particle effects data in Valve's Source engine.\n\nFull documentation: https://pysourcesdk.github.io/ValvePCF/\n\n## Installation\n\n### PyPI\n\nValvePCF is available on the Python Package Index. This makes installing it with pip as easy as:\n\n```bash\npip3 install valvepcf\n```\n\n### Git\n\nIf you want the latest code or even feel like contributing, the code is available on GitHub.\n\nYou can easily clone the code with git:\n\n```bash\ngit clone git@github.com:pySourceSDK/ValvePCF.git\n```\n\nand install it with:\n\n```bash\npython3 setup.py install\n```\n\n## Usage\n\nHere's a few example usage of ValvePCF\n\n### Parsing\n\nParsing can be done by creating an instance of Pcf with a path.\n\n```python\n>>> from valvepcf import Pcf\n>>> pcf = Pcf('C:/Program Files (x86)/Steam/steamapps/common/Team Fortress 2/tf/particles/custom.pcf')\n```\n",
"bugtrack_url": null,
"license": "gpl-3.0",
"summary": "A library to parse .PCF files (particle effect files for the Source engine).",
"version": "1.1.2",
"project_urls": {
"Documentation": "https://pysourcesdk.github.io/ValvePCF/",
"Github": "https://github.com/pySourceSDK/ValvePCF",
"Homepage": "https://pysourcesdk.github.io/ValvePCF/"
},
"split_keywords": [
"pcf",
"source",
"sourcesdk",
"hammer",
"valve"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2acc938c9748c80d106ed668a90a6db8033cfefb9ece355082203fafbb883e1a",
"md5": "7ea245dfe78df5798436bed0d7a47666",
"sha256": "4a150a7dbc3e3393056faf5255231f059892626505e8a19af17d8bc0bd35378a"
},
"downloads": -1,
"filename": "valvepcf-1.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7ea245dfe78df5798436bed0d7a47666",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 22258,
"upload_time": "2023-08-05T03:37:38",
"upload_time_iso_8601": "2023-08-05T03:37:38.623912Z",
"url": "https://files.pythonhosted.org/packages/2a/cc/938c9748c80d106ed668a90a6db8033cfefb9ece355082203fafbb883e1a/valvepcf-1.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0a5ba29e93b097080a8cc354c726334a8f5c9e0e69b7692b20bce12e1ab14c3b",
"md5": "56f0b78216222fbc2c9055ee8eb98723",
"sha256": "4810e8c4e19479d4249c4d5b916a9233ac9dc1a8ef4081b98e99c21113e6e42f"
},
"downloads": -1,
"filename": "valvepcf-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "56f0b78216222fbc2c9055ee8eb98723",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 21502,
"upload_time": "2023-08-05T03:37:39",
"upload_time_iso_8601": "2023-08-05T03:37:39.641537Z",
"url": "https://files.pythonhosted.org/packages/0a/5b/a29e93b097080a8cc354c726334a8f5c9e0e69b7692b20bce12e1ab14c3b/valvepcf-1.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-05 03:37:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pySourceSDK",
"github_project": "ValvePCF",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "valvepcf"
}
JSON
