[![GPLv3 license](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://github.com/pySourceSDK/ValveSMD/blob/master/LICENSE.txt)
[![PyPI pyversions](https://img.shields.io/pypi/pyversions/valvesmd.svg)](https://pypi.python.org/pypi/valvesmd/)
[![Platforms](https://img.shields.io/badge/platform-Linux,_MacOS,_Windows-blue)]()
[![PyPI version fury.io](https://badge.fury.io/py/valvesmd.svg)](https://pypi.python.org/pypi/valvesmd/)
[![GitHub Workflow Status (with event)](https://github.com/pySourceSDK/ValveSMD/actions/workflows/CI.yml/badge.svg)]()
[![Test coverage](https://github.com/pySourceSDK/ValveSMD/blob/master/docs/source/coverage.svg "coverage")]()
# ValveSMD
ValveSMD is a Python library designed to parse and edit .SMD files, which stores 3D mesh data to be compiled for use in Valve's Source engine.
Full documentation: https://pysourcesdk.github.io/ValveSMD/
## Installation
### PyPI
ValveSMD is available on the Python Package Index. This makes installing it with pip as easy as:
```bash
pip3 install valvesmd
```
### 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/ValveSMD.git
```
and install it with:
```bash
python3 setup.py install
```
## Usage
Here's a few example usage of ValveSMD
### Parsing
Parsing can be done by creating an instance of Smd with a path.
```python
>>> from valvesmd import Smd
>>> smd = Smd('C:/modelsrc/tf/props_mining/rock005.smd')
```
### Utility functions
A few functions are provided to perform basic transformations.
```python
>>> from valvesmd import *
>>> SmdScale(smd, 2) # 2x scale
>>> SmdMirror(smd, 'x') # Mirroring on 'x', 'y' or 'z' axis
>>> SmdMatReplace(smd, 'wood', 'metal') # replace a material name (without $cdmaterial and extension)
```
Raw data
{
"_id": null,
"home_page": "https://pysourcesdk.github.io/ValveSMD/",
"name": "valvesmd",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "smd,source,sourcesdk,hammer,valve",
"author": "Maxime Dupuis",
"author_email": "mdupuis@hotmail.ca",
"download_url": "https://files.pythonhosted.org/packages/89/26/7a915cf66a9360a95fc41e07949a720fe5801639232a980d3363ab64a106/valvesmd-1.0.2.tar.gz",
"platform": null,
"description": "[![GPLv3 license](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://github.com/pySourceSDK/ValveSMD/blob/master/LICENSE.txt)\n[![PyPI pyversions](https://img.shields.io/pypi/pyversions/valvesmd.svg)](https://pypi.python.org/pypi/valvesmd/)\n[![Platforms](https://img.shields.io/badge/platform-Linux,_MacOS,_Windows-blue)]()\n[![PyPI version fury.io](https://badge.fury.io/py/valvesmd.svg)](https://pypi.python.org/pypi/valvesmd/)\n[![GitHub Workflow Status (with event)](https://github.com/pySourceSDK/ValveSMD/actions/workflows/CI.yml/badge.svg)]()\n[![Test coverage](https://github.com/pySourceSDK/ValveSMD/blob/master/docs/source/coverage.svg \"coverage\")]()\n\n# ValveSMD\n\nValveSMD is a Python library designed to parse and edit .SMD files, which stores 3D mesh data to be compiled for use in Valve's Source engine.\n\nFull documentation: https://pysourcesdk.github.io/ValveSMD/\n\n## Installation\n\n### PyPI\n\nValveSMD is available on the Python Package Index. This makes installing it with pip as easy as:\n\n```bash\npip3 install valvesmd\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/ValveSMD.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 ValveSMD\n\n### Parsing\n\nParsing can be done by creating an instance of Smd with a path.\n\n```python\n>>> from valvesmd import Smd\n>>> smd = Smd('C:/modelsrc/tf/props_mining/rock005.smd')\n```\n\n### Utility functions\n\nA few functions are provided to perform basic transformations.\n\n```python\n>>> from valvesmd import *\n>>> SmdScale(smd, 2) # 2x scale\n>>> SmdMirror(smd, 'x') # Mirroring on 'x', 'y' or 'z' axis\n>>> SmdMatReplace(smd, 'wood', 'metal') # replace a material name (without $cdmaterial and extension)\n```\n",
"bugtrack_url": null,
"license": "gpl-3.0",
"summary": "A library to parse .SMD files (uncompiled 3D asset files for the Source engine).",
"version": "1.0.2",
"project_urls": {
"Documentation": "https://pysourcesdk.github.io/ValveSMD/",
"Github": "https://github.com/pySourceSDK/ValveSMD",
"Homepage": "https://pysourcesdk.github.io/ValveSMD/"
},
"split_keywords": [
"smd",
"source",
"sourcesdk",
"hammer",
"valve"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "81fbdd33fd7dfba574cf8372e771524143c29b27298e012ff1209131d8b4cbb9",
"md5": "c32fe2c38dc9e5d07bd6e8a3bbe2df5b",
"sha256": "3f93eb45a4bad8a803b5192b5e8b05a21e577cc9f2ff4e4bc0122e43334ea892"
},
"downloads": -1,
"filename": "valvesmd-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c32fe2c38dc9e5d07bd6e8a3bbe2df5b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 19443,
"upload_time": "2023-08-05T03:39:45",
"upload_time_iso_8601": "2023-08-05T03:39:45.563092Z",
"url": "https://files.pythonhosted.org/packages/81/fb/dd33fd7dfba574cf8372e771524143c29b27298e012ff1209131d8b4cbb9/valvesmd-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "89267a915cf66a9360a95fc41e07949a720fe5801639232a980d3363ab64a106",
"md5": "8fd8b39d950c98836b4e4ff0d1426179",
"sha256": "5be8b6f24642f83f783fe1b8197744daa084436104e4852e4ec67d1268a1c889"
},
"downloads": -1,
"filename": "valvesmd-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "8fd8b39d950c98836b4e4ff0d1426179",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 19088,
"upload_time": "2023-08-05T03:39:47",
"upload_time_iso_8601": "2023-08-05T03:39:47.005940Z",
"url": "https://files.pythonhosted.org/packages/89/26/7a915cf66a9360a95fc41e07949a720fe5801639232a980d3363ab64a106/valvesmd-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-05 03:39:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pySourceSDK",
"github_project": "ValveSMD",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "valvesmd"
}