valvevmf


Namevalvevmf JSON
Version 0.1.2 PyPI version JSON
download
home_pagehttps://pysourcesdk.github.io/ValveVMF/
SummaryA library to parse .VMF files (level editor files for the Source engine).
upload_time2023-08-05 03:41:20
maintainer
docs_urlNone
authorMaxime Dupuis
requires_python
licensegpl-3.0
keywords vmf source sourcesdk hammer valve
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            [![GPLv3 license](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://github.com/pySourceSDK/ValveVMF/blob/master/LICENSE.txt)
[![PyPI pyversions](https://img.shields.io/pypi/pyversions/valvevmf.svg)](https://pypi.python.org/pypi/valvevmf/)
[![Platforms](https://img.shields.io/badge/platform-Linux,_MacOS,_Windows-blue)]()
[![PyPI version fury.io](https://badge.fury.io/py/valvevmf.svg)](https://pypi.python.org/pypi/valvevmf/)
[![GitHub Workflow Status (with event)](https://github.com/pySourceSDK/ValveVMF/actions/workflows/CI.yml/badge.svg)]()
[![Test coverage](https://github.com/pySourceSDK/ValveVMF/blob/master/docs/source/coverage.svg "coverage")]()

# ValveVMF

ValveVMF is a Python library designed to parse and edit .VMF files, which store game level data for Valve's level editor, Hammer.

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

## Installation

### PyPI

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

```bash
pip3 install valvevmf
```

### 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/ValveVMF.git
```

and install it with:

```bash
python3 setup.py install
```

## Usage

Here's a few example usage of ValveVMF

### Parsing

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

```python
>>> from valvevmf import Vmf

>>> vmf = Vmf('C:/mapsrc/yourmap.vmf')
>>> print(vmf.nodes)
>>> vmf.save()
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://pysourcesdk.github.io/ValveVMF/",
    "name": "valvevmf",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "vmf,source,sourcesdk,hammer,valve",
    "author": "Maxime Dupuis",
    "author_email": "mdupuis@hotmail.ca",
    "download_url": "https://files.pythonhosted.org/packages/f1/ec/20b31783cb38b1c9cdab33b7ae40869312ebccf78890286b0e53e4376cdc/valvevmf-0.1.2.tar.gz",
    "platform": null,
    "description": "[![GPLv3 license](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://github.com/pySourceSDK/ValveVMF/blob/master/LICENSE.txt)\n[![PyPI pyversions](https://img.shields.io/pypi/pyversions/valvevmf.svg)](https://pypi.python.org/pypi/valvevmf/)\n[![Platforms](https://img.shields.io/badge/platform-Linux,_MacOS,_Windows-blue)]()\n[![PyPI version fury.io](https://badge.fury.io/py/valvevmf.svg)](https://pypi.python.org/pypi/valvevmf/)\n[![GitHub Workflow Status (with event)](https://github.com/pySourceSDK/ValveVMF/actions/workflows/CI.yml/badge.svg)]()\n[![Test coverage](https://github.com/pySourceSDK/ValveVMF/blob/master/docs/source/coverage.svg \"coverage\")]()\n\n# ValveVMF\n\nValveVMF is a Python library designed to parse and edit .VMF files, which store game level data for Valve's level editor, Hammer.\n\nFull documentation: https://pysourcesdk.github.io/ValveVMF/\n\n## Installation\n\n### PyPI\n\nValveVMF is available on the Python Package Index. This makes installing it with pip as easy as:\n\n```bash\npip3 install valvevmf\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/ValveVMF.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 ValveVMF\n\n### Parsing\n\nParsing can be done by creating an instance of Vmf with a path.\n\n```python\n>>> from valvevmf import Vmf\n\n>>> vmf = Vmf('C:/mapsrc/yourmap.vmf')\n>>> print(vmf.nodes)\n>>> vmf.save()\n```\n",
    "bugtrack_url": null,
    "license": "gpl-3.0",
    "summary": "A library to parse .VMF files (level editor files for the Source engine).",
    "version": "0.1.2",
    "project_urls": {
        "Documentation": "https://pysourcesdk.github.io/ValveVMF/",
        "Github": "https://github.com/pySourceSDK/ValveVMF",
        "Homepage": "https://pysourcesdk.github.io/ValveVMF/"
    },
    "split_keywords": [
        "vmf",
        "source",
        "sourcesdk",
        "hammer",
        "valve"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e56a9523330a9ab41c0167af1caa1bc4051c0b7b673b08edb470fa21b3112ba2",
                "md5": "314b75e9cc3879183f560afa66ae810d",
                "sha256": "f145579f54f8f5184010de473832d2eea845ea98ba4568aa4ae49fc95790ddae"
            },
            "downloads": -1,
            "filename": "valvevmf-0.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "314b75e9cc3879183f560afa66ae810d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 20157,
            "upload_time": "2023-08-05T03:41:18",
            "upload_time_iso_8601": "2023-08-05T03:41:18.452811Z",
            "url": "https://files.pythonhosted.org/packages/e5/6a/9523330a9ab41c0167af1caa1bc4051c0b7b673b08edb470fa21b3112ba2/valvevmf-0.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f1ec20b31783cb38b1c9cdab33b7ae40869312ebccf78890286b0e53e4376cdc",
                "md5": "6df81279f292d1b4b7d6bb1e56df9461",
                "sha256": "3abbd9c505386aca4c8a47d38846d257e6f1b46fa1b60bf4ad3f3d3ce4f5dfcd"
            },
            "downloads": -1,
            "filename": "valvevmf-0.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "6df81279f292d1b4b7d6bb1e56df9461",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 19513,
            "upload_time": "2023-08-05T03:41:20",
            "upload_time_iso_8601": "2023-08-05T03:41:20.102019Z",
            "url": "https://files.pythonhosted.org/packages/f1/ec/20b31783cb38b1c9cdab33b7ae40869312ebccf78890286b0e53e4376cdc/valvevmf-0.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-05 03:41:20",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "pySourceSDK",
    "github_project": "ValveVMF",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "requirements": [],
    "tox": true,
    "lcname": "valvevmf"
}
        
Elapsed time: 1.48501s