Home

Overview

goldsrcmap is a Python library designed for parsing, manipulating, and generating GoldSrc Engine map files (.map).

---

Data Structure

Class Map

Attribute	Description
entities	List of Entity objects.

More info: https://github.com/G2Pavon/goldsrcmap/wiki/Map

---

Class Entity

Attribute	Description
properties	Dictionary containing properties of the entity.
brushes	List of Brush objects.

More info: https://github.com/G2Pavon/goldsrcmap/wiki/Entity

---

Class Brush

Attribute	Description
faces	List of Face objects.

More info: https://github.com/G2Pavon/goldsrcmap/wiki/Brush

---

Class Face

Attribute	Description
plane	Plane object.
texture	Texture object.

More info: https://github.com/G2Pavon/goldsrcmap/wiki/Face

---

Class Texture

Attribute	Description
name	String representing the texture name.
u_axis	Vector3 object representing the texture axis.
u_offset	Float values for texture offset.
v_axis	Vector3 object representing the texture axis.
v_offset	Float values for texture offset.
rotation	Float value indicating texture rotation.
u_scale	Float values for texture scaling.
v_scale	Float values for texture scaling.

More info: https://github.com/G2Pavon/goldsrcmap/wiki/Face

---

Class Plane

Attribute	Description
p1	Point object representing first point of the plane
p2	Point object representing second point of the plane
p3	Point object representing third point of the plane

---

Class Point

Attribute	Description
x	Float representing the x coordinate
y	Float representing the y coordinate
z	Float representing the z coordinate

---

Class Vector3

Attribute	Description
x	Float representing the x coordinate
y	Float representing the y coordinate
z	Float representing the z coordinate

---

Installation

Currently, goldsrcmap is not available via pip. To use the library, download the required files from src directory from the repository. Place them in your working directory, following this structure:

/Your/Directory/
/Your/Directory/format/
/Your/Directory/utils/
/Your/Directory/__init__.py
/Your/Directory/goldsrcmap.py

Usage

1. Ensure that you have the required files in your working directory /Your/Directory/.
2. Create the python file in /Your/Directory/

/Your/Directory/your_script.py

3. Import goldsrcmap.py helper module:

# your_script.py
import goldsrcmap as gsm

# your code