# kirill1586/py-mcpe-query architecture

> Architecture diagram of the GitHub repository kirill1586/py-mcpe-query, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-04). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/kirill1586/py-mcpe-query
- Repository: https://github.com/kirill1586/py-mcpe-query

## Overview

mcquery is a small Python client for retrieving Minecraft: Bedrock server status through the Query protocol. Users start a query through either the documented Python API or CLI; the client optionally wakes a cold server with a RakNet ping, performs the Query exchange, parses the response into server data, and returns or displays it. The sampled source supports the protocol and parsing stages; invocation details are partly omitted, so those entry-point links rely on README documentation.

Main entry points: [`src/mcquery/query.py`](https://github.com/kirill1586/py-mcpe-query/blob/master/src/mcquery/query.py) (Query session)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["User entry points"]
  node_api(("Python API"))
  node_cli["Command-line query<br/>[query.py]"]
end

subgraph group_client["Query client"]
  node_client["Query session<br/>[query.py]"]
  node_warmup["RakNet warm-up<br/>[query.py]"]
  node_protocol["Query exchange<br/>[query.py]"]
  node_parser["Response parser<br/>[query.py]"]
  node_result["Server data<br/>[query.py]"]
end

node_server(("Bedrock server"))

node_api -->|"queries"| node_client
node_cli -->|"queries"| node_client
node_client -->|"optionally pings"| node_warmup
node_client -->|"attempts query"| node_protocol
node_warmup -->|"wakes server"| node_server
node_protocol -->|"exchanges packets"| node_server
node_protocol -->|"passes response"| node_parser
node_parser -->|"builds data"| node_result
node_client -->|"yields data"| node_result

click node_cli "https://github.com/kirill1586/py-mcpe-query/blob/master/src/mcquery/query.py"
click node_client "https://github.com/kirill1586/py-mcpe-query/blob/master/src/mcquery/query.py"
click node_warmup "https://github.com/kirill1586/py-mcpe-query/blob/master/src/mcquery/query.py"
click node_protocol "https://github.com/kirill1586/py-mcpe-query/blob/master/src/mcquery/query.py"
click node_parser "https://github.com/kirill1586/py-mcpe-query/blob/master/src/mcquery/query.py"
click node_result "https://github.com/kirill1586/py-mcpe-query/blob/master/src/mcquery/query.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_api,node_cli toneBlue
class node_client,node_warmup,node_protocol,node_parser,node_result toneAmber
class node_server toneMint
```

## Components

### User entry points

- **Python API**
- [Command-line query](https://github.com/kirill1586/py-mcpe-query/blob/master/src/mcquery/query.py): `src/mcquery/query.py`

### Query client

- [Query session](https://github.com/kirill1586/py-mcpe-query/blob/master/src/mcquery/query.py): `src/mcquery/query.py`
- [RakNet warm-up](https://github.com/kirill1586/py-mcpe-query/blob/master/src/mcquery/query.py): `src/mcquery/query.py`
- [Query exchange](https://github.com/kirill1586/py-mcpe-query/blob/master/src/mcquery/query.py): `src/mcquery/query.py`
- [Response parser](https://github.com/kirill1586/py-mcpe-query/blob/master/src/mcquery/query.py): `src/mcquery/query.py`
- [Server data](https://github.com/kirill1586/py-mcpe-query/blob/master/src/mcquery/query.py): `src/mcquery/query.py`

### Other components

- **Bedrock server**

## Connections

- Python API → Query session: queries (evidence: `README.md`)
- Command-line query → Query session: queries (evidence: `README.md`)
- Query session → RakNet warm-up: optionally pings (evidence: `src/mcquery/query.py`)
- Query session → Query exchange: attempts query (evidence: `src/mcquery/query.py`)
- RakNet warm-up → Bedrock server: wakes server (evidence: `src/mcquery/query.py`)
- Query exchange → Bedrock server: exchanges packets (evidence: `src/mcquery/query.py`)
- Query exchange → Response parser: passes response (evidence: `src/mcquery/query.py`)
- Response parser → Server data: builds data (evidence: `src/mcquery/query.py`)
- Query session → Server data: yields data (evidence: `README.md`)
