Query Source and GoldSource servers for name, map, players and more.
Project description
Python A2S
Library to query Source and GoldSource servers. Rewrite of the python-valve module.
Official demo application: Sourcequery
Requirements
Python >=3.6, no external dependencies
Install
pip3 install python-a2s
or python3 setup.py install
API
Functions
a2s.info(address, timeout=DEFAULT_TIMEOUT, encoding=DEFAULT_ENCODING)
a2s.players(address, timeout=DEFAULT_TIMEOUT, encoding=DEFAULT_ENCODING)
a2s.rules(address, timeout=DEFAULT_TIMEOUT, encoding=DEFAULT_ENCODING)
Parameters
- address:
Tuple[str, int]
- Address of the server. - timeout:
float
- Timeout in seconds. Default: 3.0 - encoding:
str
orNone
- String encoding, None disables string decoding. Default: utf-8
Return Values
- info: SourceInfo or GoldSrcInfo. They are documented in the source file.
- players: List of Player items. Also documented in the corresponding source file
- rules: Dictionary of key - value pairs.
Exceptions
a2s.BrokenMessageError(Exception)
- General decoding errora2s.BufferExhaustedError(BrokenMessageError)
- Response too shortsocket.timeout
- No responsesocket.gaierror
- Address resolution error
Examples
Example output shown may be shortened.
>>> import a2s >>> address = ("stomping.kinofnemu.net", 27015) >>> a2s.info(address) SourceInfo(protocol=17, server_name=" 24/7 Dustbowl :: Nemu's Stomping Ground", map_name='cp_dustbowl', folder='tf', game='Team Fortress', app_id=440, player_count=31, max_players=33, bot_count=21, server_type='d', platform='l', password_protected=True, vac_enabled=True, version='5579073', edf=177, port=27015, steam_id=85568392920040090, stv_port=None, stv_name=None, keywords='brutus,celt,couch,cp,dustbowl,increased_maxplayers,nemu,nocrits,nodmgspread,pony,replays,vanilla', game_id=440, ping=0.253798684978392) >>> a2s.players(address) [Player(index=0, name='Brutus', score=34, duration=836.4749145507812), Player(index=0, name='RageQuit', score=6, duration=1080.8099365234375), Player(index=0, name="Screamin' Eagles", score=1, duration=439.8598327636719)] >>> a2s.rules(address) {'coop': '0', 'deathmatch': '1', 'decalfrequency': '10', 'metamod_version': '1.10.7-devV', 'mp_allowNPCs': '1', 'mp_autocrosshair': '1', 'mp_autoteambalance': '0', 'mp_disable_respawn_times': '0', 'mp_fadetoblack': '0'}
Tested Games
Half-Life 2, Half-Life, Team Fortress 2, Counter-Strike: Global Offensive, Counter-Strike 1.6, ARK: Survival Evolved, Rust
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size python_a2s-1.1.2-py3-none-any.whl (10.3 kB) | File type Wheel | Python version py3 | Upload date | Hashes View |
Filename, size python-a2s-1.1.2.tar.gz (7.6 kB) | File type Source | Python version None | Upload date | Hashes View |
Close
Hashes for python_a2s-1.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cab30903e1cc7f6a3f48dbdc5c0aee4b530cb93cd365a42a5cea1cb7148ca4bb |
|
MD5 | 1d20cfd2e0a7abe591c96b4f7c079637 |
|
BLAKE2-256 | 0e23cf8c8dfd6bb41f9290b675a5d22d8845882e755c0e2ffc23035c4cb6573a |