Welcome to OpenGSQ Python’s documentation!

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

Get Started

• Home
• Installation
  • Requirements
• Usage

API

• opengsq
  • opengsq package
    • Subpackages
      • opengsq.exceptions package
      • opengsq.protocols package
      • opengsq.rcon_protocols package
      • opengsq.responses package
    • Submodules
    • opengsq.binary_reader module
      • BinaryReader
    • opengsq.cli module
      • CLI
      • main()
      • main_async()
    • opengsq.protocol_base module
      • ProtocolBase
    • opengsq.protocol_socket module
      • SocketKind
      • Socket
      • UdpClient
      • TcpClient
    • opengsq.version module
    • Module contents
      • OpenGSQ Python Library

Tests

• Protocols Tests
  • test_ase
    • test_get_status
  • test_battlefield
    • test_get_info
    • test_get_players
    • test_get_version
  • test_doom3
    • test_get_status
  • test_eos
    • test_get_info
    • test_get_info_palworld
    • test_get_matchmaking
  • test_fivem
    • test_get_dynamic
    • test_get_info
    • test_get_players
  • test_gamespy1
    • test_get_basic
    • test_get_info
    • test_get_players
    • test_get_rules
    • test_get_status
    • test_get_teams
  • test_gamespy2
    • test_get_status
  • test_gamespy3
    • test_get_status
  • test_gamespy4
    • test_get_status
  • test_kaillera
    • test_get_status
    • test_query_master_servers
  • test_killingfloor
    • test_get_details
    • test_get_players
    • test_get_rules
  • test_minecraft
    • test_get_status
    • test_get_status_pre17
  • test_quake1
    • test_get_status
  • test_quake2
    • test_get_status
  • test_quake3
    • test_get_info
    • test_get_status
  • test_raknet
    • test_get_status
  • test_samp
    • test_get_players
    • test_get_rules
    • test_get_status
  • test_satisfactory
    • test_get_status
  • test_scum
    • test_get_status
    • test_query_master_servers
  • test_source
    • test_get_info
    • test_get_players
    • test_get_rules
  • test_teamspeak3
    • test_get_channels
    • test_get_clients
    • test_get_info
  • test_unreal2
    • test_get_details
    • test_get_players
    • test_get_rules
  • test_vcmp
    • test_get_players
    • test_get_status
  • test_won
    • test_get_info
    • test_get_players
    • test_get_rules
• Rcon Protocols Tests
  • test_source_rcon
    • test_authenticate

Indices and tables

• Index

• Module Index

• Search Page