Age of Empires II recorded game parsing and summarization in Python 3.
- Age of Kings (
- The Conquerors (
- Userpatch 1.4 (
- Userpatch 1.5 (
- Definitive Edition (
The core functionality of
mgz is a parser that produces a Python data structure based on a recorded game file. It also offers abstracted representations that make it easier to use the data.
mgz offers two parsers,
fast parser skips data that is rarely needed, while the
full parser tries to parse as much as possible. Naturally, the
fast parser is faster than the
Abstractions take parser output as input and return an object with normalized data that is easier to use for most cases. There are two abstractions available,
summary abstraction attempts to expose the maximum amount of usable data. The
model abstraction is more limited but automatically performs more lookups.
|Version||model||summary||fast (header)||fast (body)||full (header)||full (body)|
|Age of Kings (.mgl)||✓||✓||✓|
|The Conquerors (.mgx)||✓||✓||✓|
|Userpatch <= 1.4 (.mgz)||✓||✓||✓||✓|
|Userpatch 1.5 (.mgz)||✓||✓||✓||✓||✓||✓|
|Definitive Edition <= 13.34 (.aoe2record)||✓||✓||✓||✓|
|Definitive Edition > 13.34 (.aoe2record)||✓||✓||✓||✓||✓||✓|
import os from mgz import header, body with open('/path/to/file', 'rb') as data: eof = os.fstat(data.fileno()).st_size header.parse_stream(data) body.meta.parse_stream(data) while data.tell() < eof: body.operation.parse_stream(data)
Full Parser (header) + Fast Parser (body)
import os from mgz import header, fast with open('/path/to/file', 'rb') as data: eof = os.fstat(data.fileno()).st_size header.parse_stream(data) fast.meta(data) while data.tell() < eof: fast.operation(data)
from mgz.summary import Summary with open('/path/to/file', 'rb') as data: s = Summary(data) s.get_map() s.get_platform() # ... etc
from mgz.model import parse_match with open('/path/to/file', 'rb') as data: match = parse_match(data) match.map.name match.file.perspective.number # ... etc
Frequently Asked Questions
Q: Where are the end-of-game achievements/statistics?
A: In the
postgame action, available only from Userpatch version.
Q: How can I tell the number of resources/kills/etc at a certain point?
A: You can't, without replaying the match in-game.
Q: How does a recorded game file work?
A: The first portion (the
header) is a snapshot of the initial game state. The second portion (the
body) is a list of moves made by players. The game loads the header, then applies each move to mutate the state according to the game rules.
Q: How can I install this package?
pip install mgz