Skip to main content

TCP client and bootstrap tooling for MineCombat-Evaluation (Minecraft combat benchmarks)

Project description

MineCombat-Evaluation

MineCombat-Evaluation banner

Paper plugin + TCP JSON protocol for combat-survival benchmarks on Minecraft 26.1 (Paper 26.1.2, plugin 0.1.0-SNAPSHOT, protocol 1).

White paper: MineCombat-Evaluation: A Reproducible Minecraft Combat Benchmark for Agent Evaluation

Quick start (PyPI, no repo needed)

The wheel bundles the prebuilt plugin, world, config, and benchmark suites, and server start auto-downloads a Java 25 runtime — so a plain pip install is enough:

pip install minecombat-eval
minecombat-eval bootstrap        # downloads Paper + installs bundled plugin/world/config
minecombat-eval server start     # auto-provisions a JRE, launches Paper
# join localhost:25565 in your Minecraft client (use --offline at bootstrap for any client), then:
minecombat-eval run-suite l1-v1 --policy my_agent.policy:MyPolicy -o results/l1-v1.jsonl

bootstrap --offline sets online-mode=false for frictionless local join. Paper itself is always downloaded on first bootstrap (it can't be redistributed).

From a repo checkout (maintainers / plugin dev)

cp .env.example .env          # JAVA_21 (build plugin), JAVA_25 (run Paper), SERVER
python3 -m venv .venv && source .venv/bin/activate
pip install -e .
minecombat-eval bootstrap
minecombat-eval server start

Docker: docker compose up --build → join :25565minecombat-eval run-suite l1-v1 --port 8765

Full path: planning/run-benchmark.md · World artifact: artifacts/README.md


System Overview

MineCombat-Evaluation system architecture

Benchmark Suites

MineCombat-Evaluation benchmark suites

Suite Tasks Purpose
l1-v1 36 Controlled mob × gear × day/night grid
l2-cave-v1 17 Enclosed cave combat environment
l2-beach-v1 17 Open beach combat environment

Releases (PyPI + GitHub)

Tagging v* now triggers .github/workflows/release.yml, which:

  • builds Python wheel + sdist
  • publishes minecombat-eval to PyPI
  • creates a GitHub Release with:
    • wheel + sdist
    • world artifact zip (mcbench_flat-v1.zip)
    • manifest.json
    • SHA256SUMS.txt

One-time repository setup

  1. Configure trusted publishing for PyPI project minecombat-eval (recommended), or set PYPI_API_TOKEN if you prefer token mode.
  2. Ensure the GitHub Actions environment named pypi exists and is allowed for release workflow.

Brand Assets

  • Prompt pack for polished banners/icon: assets/branding-prompts.md
  • Generated hero banner: assets/minecombat-banner-hero.png
  • Generated technical banner: assets/minecombat-banner-tech.png
  • Generated icon: assets/minecombat-icon.png

Scripts

From repo root (loads .env):

Script Purpose
./scripts/run-gradle.sh Build plugin (JDK 21)
./scripts/run-paper.sh Start Paper (JDK 25)
./scripts/sync-config.sh Copy repo config.yml → server (restart Paper after)
python3 scripts/summarize_results.py JSONL → tables / CSV

JAR output: paper-plugin/build/libs/minecombat-evaluation-0.1.0-SNAPSHOT.jar

.env example

JAVA_21=/path/to/temurin-21/Contents/Home
JAVA_25=/path/to/temurin-25/Contents/Home
SERVER=$HOME/minecraft-paper-mcbench

World: mcbench_flat (level-name in server.properties). L2 arenas are not generated from config — see planning/world-setup.md.

Python eval

Requires Paper + plugin + one player online. Stdlib only (Python 3.10+).

python3 run_eval.py --scenario ZombieRoom-v0 --episodes 3 --seed-base 0
python3 run_suite.py --suite benchmarks/l1-v1/suite.json -o results/l1-v1.jsonl

Flags and scenario ids: planning/commands-and-scenarios.md.

Bring Your Own Agent

Generate a starter policy package:

minecombat-eval init-policy my_agent --kind conditional
minecombat-eval run-suite l1-v1 --policy my_agent.policy:MyPolicy

Policy integration guide: docs/policy-porting.md. Runnable examples: examples/custom_policy/.

Official baseline: ReferenceCombatPolicy (minecombat_eval/reference_policy.py).

Porting your own policy

Full guide: docs/policy-porting.md. The fast path:

minecombat-eval init-policy my_agent --kind conditional        # scaffold an editable package
minecombat-eval test-policy my_agent.policy:MyAgentPolicy       # validate offline (no Minecraft)
minecombat-eval run-suite l1-v1 --policy my_agent.policy:MyAgentPolicy -o results/l1.jsonl

init-policy supports --kind scripted|conditional|torch. test-policy runs your act() on synthetic observations and checks every Action, catching import errors, exceptions, and bad outputs before you start a server. Helpers (nearest_mob, aim_at, …) and runnable examples live in minecombat_eval.helpers and examples/custom_policy/.

Eval logs (episodes.jsonl, results/) are gitignored.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

minecombat_eval-0.3.0.tar.gz (6.1 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

minecombat_eval-0.3.0-py3-none-any.whl (6.1 MB view details)

Uploaded Python 3

File details

Details for the file minecombat_eval-0.3.0.tar.gz.

File metadata

  • Download URL: minecombat_eval-0.3.0.tar.gz
  • Upload date:
  • Size: 6.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for minecombat_eval-0.3.0.tar.gz
Algorithm Hash digest
SHA256 b28ac6aeacdbe007814957f81326eddcb8beff82ecb0aa372367f4180a74f818
MD5 b6f2f62578723e830c9244200e79760b
BLAKE2b-256 2cc4813c13536ce92d8129481450703043c7e3c0ab41eb3a421e8f4fc9d3ccc3

See more details on using hashes here.

Provenance

The following attestation bundles were made for minecombat_eval-0.3.0.tar.gz:

Publisher: release.yml on SamC1249/MineCombat-Evaluation

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file minecombat_eval-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for minecombat_eval-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3e74009afff7a9696d7c1f2aa308be0fecf6da23b708709f7f75fd1edda8a7f1
MD5 819459fac536110bb47273a6db0297d9
BLAKE2b-256 59a3507b8995a468e092318a7465f97f6f255cd6d9516a45a88187d1d573fdbd

See more details on using hashes here.

Provenance

The following attestation bundles were made for minecombat_eval-0.3.0-py3-none-any.whl:

Publisher: release.yml on SamC1249/MineCombat-Evaluation

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page