Home

Overview

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

Data Structure

Class Map

• entities: List of Entity objects.

Class Entity

• properties: Dictionary containing properties of the entity.
• brushes: List of Brush objects.

Class Brush

• faces: List of Face objects.

Class Face

• plane: Plane object.
• texture: Texture object.

Class Plane

• plane: Representation of the geometric plane.
• texture: Texture object.

Class Texture

• 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.

Class Point

• Represents a point in the 3D space.

Class Vector3

• Represents a 3D vector.

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