OpenGSQ Python Library

The OpenGSQ Python library provides a convenient way to query servers from applications written in the Python language.

Supported Protocols

The library supports a wide range of protocols. Here are some examples:

from opengsq.protocols import (
    AoE1,
    AoE2,
    ASE,
    AVP2,
    Battlefield,
    Battlefield2,
    CoD1,
    CoD4,
    CoD5,
    DirectPlay,
    Doom3,
    ElDewrito,
    EOS,
    FiveM,
    Flatout2,
    GameSpy1,
    GameSpy2,
    GameSpy3,
    GameSpy4,
    Halo1,
    JediKnight,
    Kaillera,
    KillingFloor,
    Minecraft,
    Nadeo,
    Palworld,
    Quake1,
    Quake2,
    Quake3,
    RakNet,
    RenegadeX,
    Samp,
    Satisfactory,
    Scum,
    Source,
    SSC,
    SupCom,
    StrongholdCE,
    StrongholdCrusader,
    TeamSpeak3,
    TrackmaniaNations,
    TrackmaniaSunrise,
    Toxikk,
    UDK,
    Unreal2,
    UT3,
    Vcmp,
    W40kDow,
    Warcraft3,
    WON,
)

Requirements

Python 3.9 or higher

Installation

The recommended installation method is using pip:

pip install --upgrade opengsq

Usage

Here’s an example of how to query a server using the Source protocol:

import asyncio
from opengsq.protocols import Source

async def main():
    source = Source(host='45.147.5.5', port=27015)
    info = await source.get_info()
    print(info)

asyncio.run(main())

You can also use the Source Remote Console:

import asyncio
from opengsq.exceptions import AuthenticationException
from opengsq.rcon_protocols.source_rcon import SourceRcon

async def main():
    with SourceRcon("123.123.123.123", 27015) as source_rcon:
        try:
            await source_rcon.authenticate("serverRconPassword")
        except AuthenticationException:
            print('Failed to authenticate')

        response = await source_rcon.send_command("cvarlist")
        print(response)

asyncio.run(main())

Command-line interface

This library additionally provides an opengsq command-line utility which makes it easy to query game servers from your terminal. Run opengsq -h for usage.

# query server using source protocol
opengsq source --host 123.123.123.123 --port 27015 --function get_info

Tests and Results

You can find information about tests and results at https://python.opengsq.com/tests/protocols

Contributing

Contributions are welcome! Please feel free to submit pull requests or open issues.

Stargazers over time

Metadata

Release files for opengsq 3.7.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for opengsq 3.7.0
File	Size	Uploaded
opengsq-3.7.0.tar.gz	107.3 kB	Oct 8, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for opengsq 3.7.0
File	Interpreter	ABI	Platform	Reset
opengsq-3.7.0-py3-none-any.whl 174.2 kB Oct 8, 2026	Python 3	none	any	Details

Total release size: 281.5 kB

Release files / opengsq-3.7.0.tar.gz

Download URL	opengsq-3.7.0.tar.gz
Size	107.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`d0a7f1d2b97e8710ea4d507231f13ab008b246d1f380bbdb6b816e30f9a0eb38`
BLAKE2b-256 checksum How to use checksums	`c2560f3973b73cecdaa8b5995b406f62a6a34798e61082642b8586b03086845e`
Upload date	Oct 8, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/opengsq/opengsq-python
Publishing commit: github.com/opengsq/opengsq-python/tree/a426188c9c6b8737dd1a8db06310ea98ab19da4e

Workflow

Publishing configuration: github.com/opengsq/opengsq-python/blob/a426188c9c6b8737dd1a8db06310ea98ab19da4e/.github/workflows/python-publish.yml
Publishing logs: github.com/opengsq/opengsq-python/actions/runs/37722539960/attempts/1

Artifact

Subject: opengsq-3.7.0.tar.gz
SHA-256 checksum: d0a7f1d2b97e8710ea4d507231f13ab008b246d1f380bbdb6b816e30f9a0eb38 Verifying attestations

Release files / opengsq-3.7.0-py3-none-any.whl

Download URL	opengsq-3.7.0-py3-none-any.whl
Size	174.2 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`619e9c0bc4765e1394e5d5809b69108104bcafd487b64d032e55a68186a022ea`
BLAKE2b-256 checksum How to use checksums	`d6bfcdbeb6d283640506356511c682619add5bab7a4b9a49e1ab7a09baaef605`
Upload date	Oct 8, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/opengsq/opengsq-python
Publishing commit: github.com/opengsq/opengsq-python/tree/a426188c9c6b8737dd1a8db06310ea98ab19da4e

Workflow

Publishing configuration: github.com/opengsq/opengsq-python/blob/a426188c9c6b8737dd1a8db06310ea98ab19da4e/.github/workflows/python-publish.yml
Publishing logs: github.com/opengsq/opengsq-python/actions/runs/37722539960/attempts/1

Artifact

Subject: opengsq-3.7.0-py3-none-any.whl
SHA-256 checksum: 619e9c0bc4765e1394e5d5809b69108104bcafd487b64d032e55a68186a022ea Verifying attestations