QuakeLiveInterface is a Python library designed to provide a comprehensive, object-oriented interface to a Quake Live game server. It serves as a real-time Python interface for Quake Live, allowing you to extract game state and send commands.
This project includes a custom fork of minqlx with C-level entity introspection:
get_entity_info(entity_id)- Direct access to game entities from Python- Reliable item tracking - Query item spawn states, positions, and respawn timers
- Docker-based build system - Compiles minqlx from source with our custom patches
# 1. Clone and install
git clone https://github.com/cainky/QuakeLiveInterface.git
cd QuakeLiveInterface
poetry install
# 2. Start the server stack
docker-compose up -d
# 3. Connect to localhost:27960 in Quake Live
# 4. Verify game state is streaming
poetry run python tools/test_subscribe.py┌─────────────────┐ ┌─────────────┐ ┌──────────────────┐
│ Quake Live │────▶│ Redis │◀────│ Your Code │
│ Server │ │ Pub/Sub │ │ │
│ │◀────│ │────▶│ • RL Agents │
│ minqlx plugin │ │ ~60Hz │ │ • Analytics │
└─────────────────┘ └─────────────┘ │ • Bots │
▲ │ • Visualizers │
│ Game Commands │ • Anything! │
└───────────────────────────────────└──────────────────┘
A minqlx plugin extracts game state at ~60Hz and publishes to Redis. Subscribe to get real-time data, publish commands to control the game.
- Real-time Game State: Position, velocity, health, armor, weapons at ~60Hz
- Entity Introspection: C-level
get_entity_info()for reliable item/powerup tracking - Bidirectional: Read state AND send movement/attack commands
- Docker Stack: One command to run Quake Live server + Redis
- Gymnasium Compatible: Optional RL environment wrapper included
- 2D Visualizer: Real-time map viewer for debugging agents
- Multiple Game Modes: FFA, Duel, TDM, CTF
Subscribe to ql:game:state for real-time JSON:
{
"agent": {
"steam_id": 72561195012232678,
"name": "Snap",
"health": 100,
"armor": 50,
"position": {"x": -328.37, "y": 1615.47, "z": 1276.33},
"velocity": {"x": -419.45, "y": 65.81, "z": -133.0},
"view_angles": {"pitch": 0.0, "yaw": 90.0, "roll": 0.0},
"is_alive": true,
"team": "free"
},
"opponents": [
{
"steam_id": 72561195012232678,
"name": "Anarki",
"health": 125,
"armor": 100,
"position": {"x": 512.0, "y": -128.0, "z": 64.0},
"velocity": {"x": 0.0, "y": 0.0, "z": 0.0},
"view_angles": {"pitch": 0.0, "yaw": 180.0, "roll": 0.0},
"is_alive": true,
"team": "free"
}
],
"items": [
{"name": "item_armor_mega", "position": {"x": 0, "y": 0, "z": 0}, "is_available": true, "spawn_time": 0},
{"name": "item_health_mega", "position": {"x": -384, "y": 640, "z": 32}, "is_available": false, "spawn_time": 35000}
],
"game_in_progress": true,
"game_type": "duel",
"map_name": "toxicity"
}Publish to ql:agent:command:
import redis
import json
r = redis.Redis('localhost', 6379)
# Movement input (buttons held each frame)
r.publish('ql:agent:command', json.dumps({
'command': 'input',
'forward': 1, # 0 or 1
'back': 0,
'left': 0,
'right': 1, # Strafe right
'jump': 1, # Jump
'attack': 1, # Fire
'pitch_delta': 0, # Look up/down
'yaw_delta': 5 # Turn right
}))from stable_baselines3 import PPO
from QuakeLiveInterface.env import QuakeLiveEnv
env = QuakeLiveEnv(redis_host='localhost')
model = PPO("MlpPolicy", env, verbose=1)
model.learn(total_timesteps=100000)poetry run python visualizer.pyimport redis
import json
r = redis.Redis('localhost', 6379, decode_responses=True)
ps = r.pubsub()
ps.subscribe('ql:game:state')
for msg in ps.listen():
if msg['type'] == 'message':
state = json.loads(msg['data'])
# Your logic here
if state['agent']['health'] < 50:
# Run away!
r.publish('ql:agent:command', json.dumps({
'command': 'input',
'forward': 1,
'yaw_delta': 10
}))# Log all game events to a file
with open('game_log.jsonl', 'a') as f:
for msg in ps.listen():
if msg['type'] == 'message':
f.write(msg['data'] + '\n')| Variable | Description |
|---|---|
QLX_AGENTSTEAMID |
Steam ID of the controlled account |
QLX_REDISADDRESS |
Redis hostname (default: redis) |
MAP_POOL |
Map and game type (e.g., toxicity|duel) |
QuakeLiveInterface/
├── QuakeLiveInterface/ # Python package
│ ├── env.py # Gymnasium environment
│ ├── client.py # Redis client wrapper
│ ├── state.py # Game state parsing
│ └── rewards.py # Reward functions for RL
├── minqlx-fork/ # Custom minqlx with get_entity_info()
│ ├── dllmain.c # Entry point and hooks
│ ├── pyminqlx.c # Python bindings
│ └── python_embed.c # Custom C API extensions
├── minqlx-plugin/ # Server-side plugin
│ └── ql_agent_plugin.py # State extraction & Redis pub/sub
├── agents/ # Example agents
│ ├── random_agent.py
│ └── rules_based_agent.py
├── tools/
│ ├── test_subscribe.py # Test Redis connection
│ └── simulator.py # Offline game state simulator
├── tests/ # Pytest test suite
├── docker-compose.yml # Full stack deployment
├── Dockerfile.server # Multi-stage minqlx build
└── visualizer.py # 2D map viewer
| Channel | Direction | Description |
|---|---|---|
ql:game:state |
Server → Client | Game state at ~60Hz |
ql:agent:command |
Client → Server | Movement/action commands |
ql:admin:command |
Client → Server | Admin commands (restart, record) |
- QUICKSTART.md - Detailed setup guide
- minqlx-fork/README.md - Custom minqlx build instructions
"Connection refused to Redis"
- Ensure Docker containers are running:
docker ps - On Windows, use
127.0.0.1:6379:6379in docker-compose.yml
"Agent not detected"
- Verify
QLX_AGENTSTEAMIDmatches your Steam account - Check:
docker exec ql-redis redis-cli GET ql:agent:debug
"No game state"
- Connect to the server with the correct Steam account first
poetry run pytest- minqlx by MinoMino - The original minqlx project this fork is based on
- lucadamico/quakelive-server - Docker base image for Quake Live server
GPL v3 License - see LICENSE for details.