bdo-toolkit
Passive, read-only Python tooling that turns live or recorded Black Desert traffic into structured, application-ready data.
Documentation · Quickstart · Examples · API index · Report an issue
Passive, read-only boundary. bdo-toolkit observes local traffic or saved captures. It does not send or modify packets, replay traffic to the game, automate gameplay, inspect process memory, or bypass anti-cheat software.
Capabilities
bdo-toolkit exposes three passive workflows. Each can observe live traffic or replay a saved PCAP or PCAPNG file.
| Capability | What it provides | Guide | Status |
|---|---|---|---|
| Item activity | A continuing stream of typed BDOEvent objects for supported loot, gathering, inventory, and storage changes |
Item events | Stable |
| Inventory and town storage | A finite ItemStateSnapshot assembled from character-load traffic, with inventory, known balances, and observed town storage |
Inventory & town storage | Beta |
| Arena of Solare leaderboards | A finite SolareCaptureResult containing overall rankings, class tables, and player statistics when the capture is complete |
Arena of Solare | Beta |
These workflows include synchronous and asyncio sessions, capture and decoder health diagnostics, console and JSONL event writers, and a command-line interface. Exact signatures, fields, lifecycle behavior, and failure contracts are in the API index.
Testing and validation cover NA/EU only. Compatibility with other regional services is unknown.
Installation
python -m pip install bdo-toolkit
Python 3.14 or newer is required. Before live capture, complete Installation & setup, including Npcap on Windows and permission to capture on the selected interface. Offline PCAP and PCAPNG replay does not require Npcap.
Get started
- Complete Installation & setup.
- For item events or item state, prepare a current local profile through Opcode profile setup.
- Run the Quickstart or choose a task from the Examples index.
Local calibration is the dependable patch-day path because maintained profiles require manual verification and may lag a weekly update. The Calibration guide walks through rebuilding one. Arena of Solare uses structural classification and does not require an item opcode profile.
Runnable examples
The source checkout includes maintained, run-ready lessons. They are not installed with the Python wheel.
| Workflow | Representative script |
|---|---|
| Observe live item activity | examples/live_transfer_log.py |
| Capture inventory and town storage on character load | examples/live_character_load_snapshot.py |
| Rebuild an item profile after a patch | examples/live_calibrate_profile.py |
| Observe calibration progress and stop on completion | examples/live_calibration_progress.py · async |
| Capture an Arena of Solare leaderboard load | examples/solare_live_snapshot.py |
See the Examples index for every script, its prerequisites, and the guide that explains it.
Support
For questions, contact me on Discord: ._.__.__._._.__._____.__._.___.
For bugs and feature requests, open a GitHub issue.
License
bdo-toolkit is available under the MIT License.
1 maintainer
Metadata
1 maintainer
Release files for bdo-toolkit 1.0.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| bdo_toolkit-1.0.4.tar.gz | 381.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| bdo_toolkit-1.0.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 632.5 kB
Release files / bdo_toolkit-1.0.4.tar.gz
| Download URL | bdo_toolkit-1.0.4.tar.gz |
|---|---|
| Size | 381.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e3445e3bea14b507164030f0a04aa8a95dd3274fb0a428a3a952d1010ac9e262
|
|
BLAKE2b-256 checksum How to use checksums |
4203242a2d8dcd1263486c64f4ac0a191cd91dfcf3d3d41cb1471b1a290bf91a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 11, 2026.
Transparency logRelease files / bdo_toolkit-1.0.4-py3-none-any.whl
| Download URL | bdo_toolkit-1.0.4-py3-none-any.whl |
|---|---|
| Size | 251.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0d7e70bd385888a83805e2d9aaba06c43a5ac65685fe1ee2dee1812a995ad18c
|
|
BLAKE2b-256 checksum How to use checksums |
fb29250e0267cf15f82d8b495b87d5cee71d21608b575d418daf020a4591fbd9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 11, 2026.
Transparency log
