Files
horizon-airdef/packaging/PLAY.txt
T
Ludovic Marie 8cdec2c8d9 Tidy the repository now that parity is reached: launcher-first README, docs index, research leftovers removed
Removed (each unreferenced by code, workflows, tests or living docs; no harness
dependency record names any of them, and parity.py --list still finds all 281):
- 22 one-off write-ups of the Java-pack experiments in docs/: adaptive-terrain,
  client-graphics-smoke, compact-headers, core-performance, culling-empty,
  culling-rays, debounce-queue, dispatch-retry, foreground-first,
  graphics-api-comparison, heap-budget, mac-first-test, optimization-plan,
  playable-validation, quad-reuse, server-graphics-context, shader-world-smoke,
  terrain-measurements, terrain-position, terrain-read-wait, tick-membership,
  worker-pacing. Their findings are folded into one paragraph of java-packs.md.
- 24 benchmarks/ observation dumps only those write-ups linked (client graphics,
  culling, queues, heap, Mac Vulkan, shader worlds, software identity, and the
  unlinked rust-core, rust-worldgen-2026-10-05, rust-native-client and
  rust-cuboid-model-decoding runs), plus 12 unlinked files inside kept
  report folders. The scoped-parity reports the living docs cite stay.
- debug/: one server log from a chunk investigation.
- The manual macos-shader-research and macos-vulkan-research workflows.
- tools/logs/latest.log, an empty log committed by accident (now ignored).

Kept: research-lock.json (parity.py, packaging, the launcher and datafix read
it), the Java-pack how-tos (vulkan, collectors, profiling, process-memory,
tick-state) and tools/test_client_graphics.py (ci.yml runs it).

README: leads with what Horizon is and "Download the launcher" (the
launcher-v* releases; the launcher updates itself), then build from source
for developers. Direct game downloads and PLAY.txt steps for players are gone;
the launcher has its own section with two screenshots. The roadmap merges the
known differences, the final checks and the plans after parity, under the
"Roadmap" heading the launcher's What's next page reads. The parity table and
its 100%-of-what-the-harnesses-compare note are unchanged.

docs/README.md indexes what remains: build and run, parity (status and
workflow), world generation, world data and simulation, the old Java track.
Links to the removed pages and README anchors are fixed.

packaging/PLAY.txt now speaks to players who came through the launcher and
points anyone with a bare archive to it, keeping the manual steps short.

The launcher's README link points at main instead of the launcher branch.
.gitignore: tools/logs/ and .DS_Store. No code behaviour changes; the compiler
and clippy flag no unused code and the tree has no stale TODOs.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-13 14:16:55 +02:00

32 lines
1.7 KiB
Plaintext

Horizon: Minecraft Java Edition 26.3, rewritten in Rust
=========================================================
Horizon is an unofficial fan project, not affiliated with, endorsed by or
connected to Mojang Studios or Microsoft. Minecraft is a trademark of Mojang
and Microsoft. This folder contains none of Minecraft's code, textures or
sounds: Horizon prepares them from your own copy of Minecraft Java Edition.
Playing through the Horizon launcher
Nothing to do here: the launcher installed this folder, prepares the
resources the first time you press Play, and starts the game. Use the
launcher to update, play or run a server.
Downloaded this archive directly?
Get the launcher instead; it installs, prepares and updates Horizon for you:
https://github.com/ludovic111/horizon/releases?q=launcher-v&expanded=true
To prepare this folder by hand you need Minecraft Java Edition 26.3, played
once from the official launcher, Python 3.10+ and Java 25 (a JDK). Then,
in this folder:
python3 tools/prepare_native_client.py --prepare --server-jar PATH/TO/server.jar
python3 tools/fetch_sounds.py (optional, for sound)
(Windows: py instead of python3.) The 26.3 server jar is the
downloads.server.url in your launcher's versions/26.3/26.3.json. Add
--minecraft-dir PATH if your launcher keeps the game elsewhere. Then run
./horizon-client (horizon-client.exe on Windows; on macOS the first time:
right-click > Open). horizon-client --help lists the options.
Controls: mouse look, WASD move, Space jump, Left Shift sneak, Left Ctrl
sprint, left click break, right click place/use, 1-9 or scroll for the hotbar,
E inventory, Q drop, F1 hide the HUD, F3 debug, Esc pause.