From 7efdbdb39a2e3b90ec8188cdaa0e9b4f1c31a9e2 Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Sat, 24 Oct 2026 15:42:44 +0200 Subject: [PATCH 001/169] docs: remove the surveys of other mods; mod code is never read Removes docs/performance/java-perf-mods.md (a survey of eight Java performance mods' techniques) and docs/research/java-mod-compat.md (notes on how Fabric, NeoForge and Mixin work, with a list of mods to port). Links to them now point at mods.md, which says in two lines why Java jars don't run in Horizon. docs/modpacks.md no longer lists a mod's decompiled code as an input of a port: a mod's code is never decompiled, read, quoted or paraphrased, and ports are written from the mod's observed behaviour (the oracle and the harness), its own data files and its public documentation only. Co-Authored-By: Claude Opus 5.5 --- docs/README.md | 2 +- docs/mod-browser.md | 2 +- docs/modpacks.md | 24 ++-- docs/mods.md | 7 +- docs/performance/java-perf-mods.md | 130 -------------------- docs/research/java-mod-compat.md | 183 ----------------------------- 6 files changed, 18 insertions(+), 330 deletions(-) delete mode 100644 docs/performance/java-perf-mods.md delete mode 100644 docs/research/java-mod-compat.md diff --git a/docs/README.md b/docs/README.md index 2e06b6e89..71e2a9ced 100644 --- a/docs/README.md +++ b/docs/README.md @@ -14,7 +14,7 @@ To play, use [the launcher](../launcher/README.md); the project site is [playhor - [Benchmark](benchmark.md): Horizon against vanilla 26.3 and vanilla with performance mods, on the same machine, world, path and settings: what is measured, how it is kept fair, how to reproduce it. - [Shader packs](shader-packs.md): how the renderer draws a frame, the Horizon WGSL shader pack format (stages, uniforms, `pack.toml`, hot reload), and the plan to translate OptiFine/Iris packs. - [Extras](extras.md): optional zoom, minimap, FPS and keystroke overlays and auto-reconnect, all off by default. -- [Mods](mods.md): Horizon's own mod system (Rust, sandboxed WebAssembly), how to make and install mods, and [what carries over from Java mods](research/java-mod-compat.md). +- [Mods](mods.md): Horizon's own mod system (Rust, sandboxed WebAssembly), how to make and install mods. - [Modpacks](modpacks.md): porting whole packs (ATM10 and smaller): import, inventory, carry-over, an agent per mod with a harness against the Java original, coverage, and how "10x" is measured. - [Launcher](../launcher/README.md): installs, updates and starts builds; its CLI and MCP server; releasing it. - [Versioning](versioning.md): how releases are numbered from 0.2 (`v0.2.x`, `launcher@0.2.x`), how installs from before 0.2 get there, and the steps for the day 0.2 ships. diff --git a/docs/mod-browser.md b/docs/mod-browser.md index 745f51d9b..3146fca67 100644 --- a/docs/mod-browser.md +++ b/docs/mod-browser.md @@ -6,7 +6,7 @@ packs, see how well each one runs before installing it, and install it with its ## What it offers -Horizon doesn't run Java code ([research/java-mod-compat.md](research/java-mod-compat.md)). It ports what a Java mod +Horizon doesn't run Java code ([mods.md](mods.md)). It ports what a Java mod carries as data (blocks, items, recipes, loot tables, tags, worldgen, textures, names) with `horizon-port-pack`, and says before install which of the mod's features that leaves out. Horizon `.hmod` mods aren't on Modrinth or CurseForge yet (Modrinth has no `horizon` loader). diff --git a/docs/modpacks.md b/docs/modpacks.md index c15d0767e..591c5a567 100644 --- a/docs/modpacks.md +++ b/docs/modpacks.md @@ -7,9 +7,8 @@ pipeline, not a list of hand ports. It takes a pack as players download it and p Horizon mods. The pipeline is AI agents in dependency order, each port checked against the original mod running in a dev-only Java instance. -This page is the design. It builds on [mods.md](mods.md) (the mod API, WASM in wasmtime) and -[research/java-mod-compat.md](research/java-mod-compat.md) (why Java jars and Mixins cannot -run in Horizon, so we port instead). The ATM10 inventory behind the numbers below is +This page is the design. It builds on [mods.md](mods.md) (the mod API, WASM in wasmtime, and +why Java jars cannot run in Horizon, so we port instead). The ATM10 inventory behind the numbers below is [modpacks/atm10-mods.csv](modpacks/atm10-mods.csv). ## In one picture @@ -141,12 +140,13 @@ derivative work. These rules are part of the pipeline, not advice to users: has given written permission, recorded in the index entry. The tooling refuses to package anything else. No-derivatives and non-commercial licences (14 in ATM10) are never published. For them, even a local port gets a warning that the licence may not allow it. -4. **Mod code never enters this repository.** Mod jars, decompiled sources, Java oracle builds +4. **Mod code never enters this repository, and nobody reads it.** Mod jars, Java oracle builds with mod code, and ports of mods we have no permission to publish all live outside the repo: in the user's pipeline work directory, or for our own development in - `~/code/horizon-parity/modports/` (dev-only, never pushed). Ports are written from - observed behaviour and the harness, with decompiled code as a local reference only. The - repository holds the pipeline, the API, metadata (ids, names, versions, licences, counts) + `~/code/horizon-parity/modports/` (dev-only, never pushed). A mod's code is never + decompiled, read, quoted or paraphrased, by people or agents. Ports are written only from + the mod's observed behaviour (the oracle and the harness), its own data files and its + public documentation. The repository holds the pipeline, the API, metadata (ids, names, versions, licences, counts) and test fixtures we write ourselves. 5. **Contacting authors or publishing any port is Ludovic's call.** Agents ask first. @@ -177,7 +177,7 @@ frame, chat and command hooks. Server mods do not run yet. What a content pack n | Entities: types, attributes, AI goals and brains, spawning | — | deep (87) | 0.5 | `entity` interface, AI in the mod with vanilla goals reusable | | Custom renderers and animated models (block-entity, entity, item; GeckoLib's format) | — | deep | 0.5 | data models (Bedrock geometry + animations), plus a budgeted draw-list interface for the rest | | Dimensions: dimension types, levels, chunk generators | — | about 10 (Twilight Forest, Aether, Ad Astra, Undergarden, ...) | 0.5 | JSON part with worldgen; custom generators as mod code | -| New hooks into vanilla behaviour (what Mixins do) | — | deep | as asked | each becomes a named hook, added for everyone ([java-mod-compat.md](research/java-mod-compat.md#3-a-porting-guide-outline)) | +| New hooks into vanilla behaviour (what Mixins do) | — | deep | as asked | each becomes a named hook, added for everyone | | Client interfaces: `keys`, `target`, `inventory-read`, `ui`, `render`, `world-read` | planned | client tier (38) | 0.2–0.4 | as in [mods.md](mods.md#planned-interfaces) | Two rules from mods.md stay: **the sandbox** (no files, sockets or processes; memory cap; fuel @@ -711,16 +711,16 @@ For tiers logic, machines and deep, in dependency order, as many agents at once budget allows: - **Input:** the inventory record, the carried-over data, the oracle's exports and traces, the - harness, the Horizon mod API docs, the ports of its dependencies, and the mod's decompiled - code as a local reference (dev-only, in the work directory). + harness, the Horizon mod API docs, the ports of its dependencies, and the mod's public + documentation. Never its code: the agent doesn't decompile, read or quote it. - **Output:** a Rust crate in `mods//port/` built with `cargo horizon-mod build`, and its `.hmod`. - **Loop:** write → build → run the harness → read the differences → fix, until the harness passes or the agent reports what blocks it. Usually that is an API gap, which becomes an issue against the mod API ("needs a scheduled-tick hook"), the way version ports turn differences into work items. -- **Rules:** the agent writes the port from observed behaviour and the harness, not by - transliterating decompiled Java; ports follow the mod's licence ([Licences](#licences)). +- **Rules:** the agent writes the port from observed behaviour, the harness and the mod's + own data files only; ports follow the mod's licence ([Licences](#licences)). Players without an AI agent get the carry-over tiers. A port the licence lets us publish can be downloaded instead of regenerated. diff --git a/docs/mods.md b/docs/mods.md index 4521d312d..bc91c043a 100644 --- a/docs/mods.md +++ b/docs/mods.md @@ -3,8 +3,9 @@ Horizon gets its own mod system, written in Rust and run in a sandbox, plus two ways to bring over what Java players use: native Horizon ports of popular mods and the data-driven parts of packs and mods. Fabric and NeoForge jars do -**not** run as they are: [research/java-mod-compat.md](research/java-mod-compat.md) -explains why and what we do instead. +**not** run as they are: their code calls and patches Minecraft's Java classes, and +Horizon has none. What carries over is the data and assets inside a jar +([modpacks.md](modpacks.md)). Mods are **off and absent by default**. A fresh install has no `horizon-mods` folder, loads no runtime and plays exactly like vanilla 26.3. @@ -102,7 +103,7 @@ name (the mod reads it as `args`; API 0.1 has no way to declare argument types). ### Planned interfaces Each is a new capability, added in a 0.x minor version so older mods keep -loading. Ordered by what the first native ports need ([research](research/java-mod-compat.md#port-first)): +loading. Ordered by what the first native ports need: | Interface | For | Notes | |---|---|---| diff --git a/docs/performance/java-perf-mods.md b/docs/performance/java-perf-mods.md deleted file mode 100644 index 62aab88a1..000000000 --- a/docs/performance/java-perf-mods.md +++ /dev/null @@ -1,130 +0,0 @@ -# Java performance mods: which of their techniques apply to Horizon - -A survey of the techniques used by eight Java Edition performance mods. Asked for in #991, from famescare on Discord. For each technique it gives the vanilla cost it targets, whether Horizon already avoids that cost, and whether it is worth measuring here. - -**Rules.** Techniques only, taken from each mod's public description, documentation and changelogs (linked below). No mod code was read or copied. Several of these mods are LGPL-3.0, and Horizon's code stays its own. Anything Horizon adopts is reimplemented against vanilla 26.3's behaviour. It keeps parity, so the harnesses stay unchanged, and it needs before/after numbers like any other perf PR (`docs/benchmark.md`, `docs/profiling.md`). - -**Why many don't apply.** A large share of these techniques work around costs of the JVM, OpenGL or GLFW rather than costs of the game's rules. Examples are object headers and duplicate objects, boxing, lambdas and Streams, garbage collection, JNI upcalls, immediate-mode GL draws and GL error checks. Horizon is Rust on wgpu and winit, so it never pays those costs. The techniques that do carry over remove work the game's rules don't need: sleeping block entities, skipped searches, and cheaper geometry tests. - -Verdicts: -- **has**: Horizon already avoids the cost, by its design or with a merged change. -- **n/a**: the cost comes from the JVM, OpenGL or GLFW, and Horizon doesn't have it. -- **later**: missing, and worth measuring. These are listed in "Worth measuring" below and in the LATER list. -- **no**: missing, but it would change vanilla's behaviour or look, or the gain here is too small to pay for itself. - -## Lithium (server and shared game logic) - -Source: [Lithium's mixin configuration](https://github.com/CaffeineMC/lithium/blob/develop/lithium-fabric-mixin-config.md). Lithium keeps vanilla's behaviour, which is the same rule Horizon follows. - -| Technique | Vanilla cost | Horizon | Verdict | -| --- | --- | --- | --- | -| Hopper caching, inventory change listeners and hopper sleeping | Every hopper looks up its source and target containers and tries a transfer every tick, even when nothing can move | `game/machines.rs` ticks every hopper on each tick. It checks the block's name and cooldown, then runs the transfer attempt. Nothing is cached or put to sleep | **later** | -| Block entity sleeping (furnaces, brewing stands, campfires, crafters, shulker boxes, sculk) | Idle block entities still tick | `game/block_entity_ticks.rs` ticks every ticker each tick, as vanilla does | **later** | -| Entity collisions: faster block access, chunk caching, the supporting block first | Collision scans read blocks through generic level lookups | Collision scans already run over Horizon's own section arrays (`horizon-world` `block_collision_scan`). A counting cursor that does fewer lookups is open as #659 | **has** (more in #659) | -| Specialised cuboid and empty `VoxelShape`s, precomputed shape arrays | Generic voxel shape intersection and merging | `horizon-core::geometry` has its own immutable shapes and box lists (`docs/collision-geometry.md`) | **has** | -| POI search and portal search | POI lookups go through vanilla's stream-heavy search | Section-indexed POIs (`poi_sections.rs`), searched in vanilla's order | **has** | -| Pathfinding: cached node types per block | Node evaluation reads the same blocks over and over | Not measured. Mob pathfinding costs haven't been profiled against vanilla yet | **later** (profile first) | -| Explosions: one access per block on a ray, skip air, skip exposure work | Each ray step reads the block and the fluid again | `game/explosion.rs` follows vanilla's loop. It hasn't been profiled, and TNT chains are the case to measure | **later** (profile first) | -| Random ticks: roll the chance early, fast block search | Sections with nothing that ticks randomly are still walked | Sections with nothing random-tickable are skipped (`docs/random-tick-eligibility-benchmark.md`) | **has** | -| Tick scheduler: faster collections, packed scheduled ticks | Boxed `ScheduledTick` objects in hash sets | Horizon's own tick heap and index (`horizon-core::ticks`, `docs/scheduled-ticks.md`) | **has** | -| Collections and allocation (fastutil maps, cached `values()`, fewer `BlockPos`, no Streams) | JVM allocation, boxing, GC | Rust value types, no GC | **n/a** | -| Math inlining, a smaller sine table | JIT inlining limits | Compiled and inlined by rustc. Horizon keeps vanilla's `Mth.sin` table where results depend on it | **n/a** | -| Chunk access without debug locks or bounds validation | `PalettedContainer`'s thread-check lock | Horizon doesn't have that lock (`docs/performance/paletted-container-access-results.md`) | **n/a** | -| Palette replacement and compaction | Hash palette resizing on the JVM | Horizon's own paletted containers (`horizon-core::paletted`) | **has** | -| Game event dispatchers made only for sections with a listener | Every section holds a dispatcher | Not checked. This is small next to the items above | **no** (until a profile shows it) | -| Item entity merging grouped by item type (experimental) | Each item entity checks every nearby item to merge with | Not present. It matters only with thousands of dropped items (see #996: fresh worlds drop about twice as many items as vanilla) | **later**, after #996 | -| World border cache, redstone wire double reads, fluid flow reads, framed-map scans | Small repeated reads | Each is minor. Fix them where a profile points at them | **no** | - -## FerriteCore (memory) - -Source: [FerriteCore's summary of its changes](https://github.com/malte0811/FerriteCore/blob/main/summary.md). - -| Technique | Vanilla cost | Horizon | Verdict | -| --- | --- | --- | --- | -| One `FastMap` of neighbour states per block instead of a table per state | About 600 MB of per-state neighbour tables in large packs | Block states are numeric ids with flat tables, with no object per state | **n/a** | -| Compact property storage per state | A per-state `ImmutableMap` | Same as above | **n/a** | -| Cached multipart predicates, shared multipart models | Hundreds of thousands of model and predicate objects | Models are baked once into a shared library (`docs/shared-model-library-benchmark.md`) | **has** | -| Deduplicated baked-quad vertex arrays | Identical `int[]` per quad | Section meshes are built per section from the shared baked models, and no per-quad arrays are kept | **has** | -| Deduplicated shape caches | Duplicate cached `VoxelShape`s per state | One table of distinct shapes, indexed per state (`horizon-world` `CachedCollisionRegistry`) | **has** | -| String deduplication in model locations | Duplicate `String`s from the constructor's round-trips | No `ModelResourceLocation` objects, so the round-trip doesn't exist | **n/a** | -| Partly loaded chunk NBT kept between loading steps | The whole tag is kept | Chunks are decoded into Horizon's own structures | **n/a** | - -Horizon's process memory is tracked against vanilla in `docs/process-memory.md`. - -## ImmediatelyFast (client draw submission) - -Source: [ImmediatelyFast on Modrinth](https://modrinth.com/mod/immediatelyfast). Its gains show only when the CPU is the bottleneck. - -| Technique | Vanilla cost | Horizon | Verdict | -| --- | --- | --- | --- | -| A batching buffer for immediate-mode draws (entities, block entities, particles, text, GUI) | Many small draw calls and uploads | The HUD is one atlas and one batch of quads (`hud.rs`). Entities are grouped by material (`gfx/entity_batch.rs`). Terrain uses indirect multi-draws (`gfx.rs`, `gfx/flat.rs`) | **has** | -| HUD batching, fewer GUI draw calls | One draw per GUI element | Same batch (`hud.rs`) | **has** | -| Fast text lookup, a bigger font atlas | Per-character lookups, atlas thrash with large fonts | Glyphs live in maps in `font.rs`, drawn into the same HUD atlas | **has** | -| One texture for all map item textures | One texture per visible map | Not measured. It matters only with walls of maps in item frames | **later** (with a map-wall scene) | -| Cached closed-chest geometry | Re-tessellating chests each frame | Merged in #728 (Online5277) | **has** | -| Buffered sign text instead of redrawing it each frame | Text redrawn every frame | Sign text is recorded as text calls in the batch. Not measured with sign-heavy scenes | **later** (with a sign-heavy scene) | -| Fewer framebuffer switches | GL state changes between render types | wgpu render passes are fixed by Horizon's pipeline | **n/a** | -| GL error checking off | `glGetError` overhead | No GL. Release builds run without wgpu's backend validation and, outside DirectX 12, without its indirect-draw validation (`gfx.rs` `instance_descriptor`) | **n/a** | - -## Gnetum (HUD rendering) - -Source: [Gnetum on Modrinth](https://modrinth.com/mod/gnetum). - -| Technique | Vanilla cost | Horizon | Verdict | -| --- | --- | --- | --- | -| Draw the HUD into an offscreen buffer in several passes, one pass per frame, and show the last complete buffer | The HUD is redrawn every frame | Horizon redraws its one HUD batch every frame | **no**. The HUD would then update at a lower rate than vanilla's, which changes what players see. Horizon's HUD is already one batch. | -| Adaptive distribution and a separate HUD FPS cap | Same | Same | **no**, for the same reason | - -## ScalableLux (lighting, from Starlight) - -Source: [ScalableLux on Modrinth](https://modrinth.com/mod/scalablelux). - -| Technique | Vanilla cost | Horizon | Verdict | -| --- | --- | --- | --- | -| Starlight's light engine: per-section light arrays and direct propagation queues | Vanilla's light engine is a bottleneck in fast chunk generation | Horizon has its own engine with vanilla's rules (`light.rs`). New chunks are lit on the streaming worker pool, and edits are relit incrementally (`relight_block`). See `docs/performance/lighting-worker-results.md` | **has** | -| Parallel light updates | One light thread | Chunk lighting already runs on several workers during streaming | **has**. Measure the light share of fresh-chunk generation before doing more. | - -## Structure Layout Optimizer (jigsaw structures) - -Source: [Structure Layout Optimizer on Modrinth](https://modrinth.com/mod/structure-layout-optimizer). - -| Technique | Vanilla cost | Horizon | Verdict | -| --- | --- | --- | --- | -| An octree of piece boxes instead of a `VoxelShape` for free space | Voxel shape boolean ops slow down as pieces add up | Free space is a container box minus a list of placed boxes (`worldgen/structure/jigsaw.rs` `Free`). That avoids the voxel shapes, but the scan is linear per test | **has**. An octree pays only for structures with hundreds of pieces. | -| Skip jigsaw blocks that face the structure boundary or another piece | Every parent jigsaw is matched against every child | Not present | **later** (time trial chambers and ancient cities first) | -| Skip pool elements already found not to fit at this spot | Weighted pools repeat an element once per weight point, and it is re-tested each time | Not present. Only the variant that keeps the result identical applies (no deduplication of the list, which changes layouts) | **later** | -| Cull positions outside the chunk before processors run | Whole templates are processed and then mostly discarded | Not checked | **later** (same measurement) | -| Palette-based template storage | Templates keep every block and NBT object | Templates are Horizon's own structures. Memory isn't measured | **no** (until memory shows it) | - -## AsyncParticles (particles) - -Source: [AsyncParticles on Modrinth](https://modrinth.com/mod/asyncparticles). - -| Technique | Vanilla cost | Horizon | Verdict | -| --- | --- | --- | --- | -| Particle culling | Off-screen particles are built anyway | Vanilla already skips quad particles whose position is outside the frustum (`QuadParticleGroup.extractRenderState`, `Frustum.pointInFrustum`). Horizon builds every particle's quad (`particles.rs` `render`). This is a parity gap as well as a cost | **later** (vanilla's frustum point test) | -| Vertex transformation on the GPU | Every particle's quad is built on the CPU and uploaded every frame | Same in Horizon (`particles.rs` `render`). Instancing would upload one record per particle | **later** (measure with 10k+ particles) | -| Particle ticks on another thread | Particle ticks on the client thread | Horizon ticks particles on the game thread | **no**. Vanilla's particle ticks read the level, and racing them against block changes risks parity. Revisit only if a profile shows particle ticks are big. | -| Asynchronous light cache for particles | A light lookup per particle per frame | `particles.rs` looks light up per particle | **later**, with the item above | -| Texture animation one frame late | Animated textures tick on the client tick | Not adopted | **no**, because it changes timing | - -## Ixeris (input and the render thread) - -Source: [Ixeris on Modrinth](https://modrinth.com/project/p8RJPJIC). - -| Technique | Vanilla cost | Horizon | Verdict | -| --- | --- | --- | --- | -| Event polling on the main thread, rendering on its own thread | GLFW event polling and JNI upcalls take time from rendering | winit, without JNI. Input and rendering share the event loop (`game.rs`, `ApplicationHandler`) | **n/a** for the JNI part | -| Buffered raw input (`GetRawInputBuffer`) | One `GetRawInputData` call per event. An 8000 Hz mouse costs a lot on Windows | winit reads `WM_INPUT` one message at a time | **later**. Measure on Windows with a high-polling-rate mouse before changing it. | -| Cached GLFW state | Round trips to the main thread | No GLFW | **n/a** | -| A frame limiter that sleeps, then spins | Imprecise sleeps | Horizon has its own limiter | **no** (no reported problem) | - -## Worth measuring - -Each of these needs a profile or a benchmark first. They are ordered by the expected gain. They are in the LATER list in `~/code/horizon-parity/FEATURES.md`, not filed as issues: - -1. Hopper and block-entity sleeping, with vanilla-identical results (Lithium). Benchmark: a hopper and furnace array. -2. Particles: vanilla's frustum point test (a parity fix too), then GPU-built quads (AsyncParticles). Benchmark: 1,000+ campfires. -3. Jigsaw placement: skip blocked connectors and already-failed elements without changing the layout (Structure Layout Optimizer). Benchmark: trial chambers and ancient cities in fresh worlds, `docs/generation-scan-benchmark.md`. -4. Windows raw input in batches for high-polling-rate mice (Ixeris). Benchmark: an 8000 Hz mouse on Windows. -5. Profile before choosing a technique: mob pathfinding, TNT explosions, item merging after #996, map walls and sign-heavy scenes. diff --git a/docs/research/java-mod-compat.md b/docs/research/java-mod-compat.md deleted file mode 100644 index 8a36b7c48..000000000 --- a/docs/research/java-mod-compat.md +++ /dev/null @@ -1,183 +0,0 @@ -# Java mods and Horizon: what can carry over - -Players ask "will my mods work?". Short answer: **Fabric and NeoForge jars -will not run in Horizon as they are**, and no bridge we could build would -change that for more than a handful of mods. What carries over is the -*content* (data packs, resource packs, the data and assets inside mod jars) -and the *ideas* (native Horizon ports of the mods people use most, written -with [Horizon's own mod system](../mods.md)). This page is the reasoning. - -## How Java mods work - -### Fabric - -- **Fabric Loader** finds jars in `mods/`, reads `fabric.mod.json` - (entrypoints, dependencies, mixin configs, access wideners), and starts the - game through a class loader that can rewrite classes as they load. -- **Mixin** (SpongePowered) is how nearly every mod changes the game: a mixin - class names a Minecraft class (`net.minecraft.client.gui.hud.InGameHud`) and - injects code at points inside its methods (`@Inject(method = "render", at = - @At("TAIL"))`, `@Redirect`, `@ModifyVariable`, `@Overwrite`...). The bytecode - of the vanilla class is rewritten at load time. Access wideners make private - fields and methods public for the same purpose. -- **Fabric API** is a set of modules that give mods events and registries - instead of raw mixins: `fabric-lifecycle-events` (`ClientTickEvents`, - `ServerTickEvents`), `fabric-rendering` (`HudRenderCallback`, - `WorldRenderEvents`), `fabric-command-api`, `fabric-key-binding-api`, - `fabric-networking-api` (custom payloads), `fabric-registry-sync`, - `fabric-resource-loader`, `fabric-screen-api`, `fabric-item-group`, - `fabric-events-interaction` and about forty more. **Fabric API itself is - implemented with mixins** into the same vanilla classes. -- Mods mix the two freely: a mod using Fabric API events still calls - `MinecraftClient.getInstance().player.getBlockPos()`, - `world.getBlockState(pos)`, `DrawContext.drawText(...)`: direct calls into - vanilla's classes, by their mapped names. - -### NeoForge (and Forge) - -- An event bus (`NeoForge.EVENT_BUS`, mod buses) with hundreds of events, - `DeferredRegister` for registries, data attachments and capabilities, - networking payloads, config specs. NeoForge patches vanilla's source - directly (binary patches) to fire its events. -- Mods also use mixins and access transformers, and call vanilla classes - directly, as on Fabric. - -### Data and assets in a jar - -Besides code, a mod jar carries the same folders as packs: -`assets//` (models, blockstates, textures, sounds, language files, -shaders) and `data//` (recipes, loot tables, tags, advancements, -predicates, functions, worldgen: biomes, features, structures). These are -**vanilla formats**, read by vanilla's own code. - -## Why a Java bridge cannot run them - -Horizon is a reimplementation in Rust: there are no `net.minecraft` classes -at runtime, no `InGameHud`, no `ClientPlayerEntity`, no bytecode to rewrite. - -1. **Mixins have nothing to bind to.** A mixin is a patch against a specific - method's bytecode. Without vanilla's classes there is no method, no - injection point and no local variable to modify. This is not a missing - feature we could add: it is the mechanism itself. -2. **Fabric API is mixins too.** A shim Fabric API would have to be - re-implemented from scratch as Java classes calling into Horizon. That part - alone is possible for the event modules. -3. **Mods call vanilla directly.** Even "pure Fabric API" mods use vanilla's - classes for everything else: the player, the world, the block states, the - renderer, the text drawing. Running them means providing Java classes with - vanilla's names and behaviour, backed by Horizon's state: in effect a - second Minecraft, in Java, on top of Horizon. Thousands of classes, in the - mapped names of every mapping set (Yarn, Mojang, intermediary), version by - version. -4. **The JVM itself** would ship with every install (a trimmed JRE is still - 40-60 MB, the full one 150+ MB), start in a second or more, hold a few - hundred MB of heap before any mod loads, and bring garbage-collector pauses - back into the frame: the costs Horizon exists to remove. JNI calls cost - tens to hundreds of nanoseconds each and every one crosses with copies. -5. **No sandbox.** Java mods are fully trusted native-speed code with file - and network access. Horizon's mods are sandboxed and their permissions are - shown; a Java bridge would be the one hole in that. - -**What a bridge could support**, if we ever built one: a stable subset of -Fabric API events (client and server tick, HUD render callback, client -commands, key bindings, custom payloads), with a tiny "vanilla view" API -(player position, held item, chat), for mods written only against that -subset. Surveying the most-downloaded Fabric mods, nearly none qualify: the -popular ones are popular precisely because they reach into rendering, the -world or the UI. The cost (a JVM in the game, a second API surface to keep -stable) is far above the benefit. **We do not build it.** If that changes, -the bridge would sit on top of the WIT API like any other mod runtime, so the -sandbox would still hold. - -## What we do instead - -### 1. Data-driven content (packs and the data in mod jars) - -Horizon already reads vanilla resource packs and data packs (functions, -function tags, predicates today). Extending data-pack coverage to recipes, -loot tables, tags, advancements and worldgen JSON brings most "content" -packs over with no mod code at all, and it is vanilla behaviour, so the parity -harnesses check it. - -For **Fabric/NeoForge jars**, the launcher can offer "import the data": read -`data/` and `assets/` from the jar and load them as a data pack plus a -resource pack. What works: new recipes, loot changes, tags, advancements, -functions, worldgen tweaks that only use vanilla blocks, retextures, language -files. What does not: anything referring to a block, item or entity the jar -registers in Java code (the ids do not exist); the import skips those files and -lists them. With Horizon's planned `registries` interface, a native port can -register those ids and reuse the jar's JSON models, textures, recipes and loot -as they are. - -### 2. Native Horizon ports of popular mods - -Horizon itself covers the performance mods: Sodium, Lithium, FerriteCore, -ModernFix, EntityCulling and ImmediatelyFast exist because vanilla Java is -slow, and Horizon's renderer and simulation are the replacement (see -[benchmark](../benchmark.md)). Zoom (OK Zoomer, Zoomify), FPS and keystroke -overlays, a minimap and auto-reconnect are already built in as -[extras](../extras.md). - -#### Port first - -Ranked by players reached per unit of API work. Each needs the planned -interfaces listed in [mods.md](../mods.md#planned-interfaces). - -| Mod (Java) | What it does | Horizon port | Needs | -|---|---|---|---| -| **Mod Menu** | list mods, open their settings | built in: Options > Mods (done), settings pages next | `ui` | -| **AppleSkin** | food saturation and exhaustion on the HUD and tooltips | SDK mod | `inventory-read`, `ui` | -| **Jade / WTHIT** | what the crosshair points at: block, entity, harvest tool, container contents | SDK mod | `target`, `ui` | -| **JEI / EMI / REI** | browse items, recipes and uses | SDK mod (or built in: Horizon already has the recipe book's data) | `recipes`, `inventory-read`, `ui` | -| **Xaero's Minimap / JourneyMap** | minimap, world map, waypoints | the minimap is an extra; a world map and waypoints as an SDK mod | `world-read`, `render`, `storage` | -| **Litematica** | schematic overlay to build from | SDK mod | `world-read`, `render`, `storage`, `ui` | -| **Mouse Tweaks / Inventory Profiles Next** | drag and sort inventory | built in or SDK mod | `inventory-read` + a sanctioned click API | -| **Continuity / CIT** | connected and custom item textures | built into the renderer (pack formats) | none: resource-pack features | -| **Distant Horizons** | low-detail far terrain | a Horizon renderer feature, not a mod | none | -| **Iris + shader packs** | shaders | a Horizon renderer feature (wgpu shader pipeline), later | none | -| **Simple Voice Chat** | proximity voice | server + client mod | `server`, `net`, audio (later) | - -### 3. A porting guide (outline) - -To be written as `docs/porting-from-fabric.md` once API 0.2 lands: - -1. **Separate logic from glue.** Most of a mod is plain logic (maths, - formatting, data structures): port it to Rust once, unit-test it on the - host. -2. **Map events.** - - | Fabric | Horizon | - |---|---| - | `ClientModInitializer.onInitializeClient` | `Mod::init`, returning a `Registration` | - | `ClientTickEvents.END_CLIENT_TICK` | `Registration::on_tick`, `Mod::tick` | - | `HudRenderCallback` | `hud::set_panel` when the content changes (retained), or `on_frame` | - | `ClientCommandRegistrationCallback` | `Registration::command`, `Mod::command` | - | `ClientReceiveMessageEvents` | `Registration::on_chat`, `Mod::chat` | - | `KeyBindingHelper.registerKeyBinding` | `keys` (planned) | - | `Registry.register(Registries.ITEM, ...)` | `registries` (planned) with JSON in `data/` | - | `ServerPlayNetworking` payloads | `net` (planned) | - | config libraries (Cloth Config, YACL) | `storage` + a `ui` settings page (planned) | - -3. **Replace mixins with hooks.** For each mixin, write down what it observes - or changes. If a WIT hook covers it, use the hook. If not, open an issue - asking for the hook ("I need X before/after Y"): hooks are added to the API - for everyone instead of each mod patching the game. -4. **Declare capabilities** in `horizon-mod.toml`, the least the mod needs. -5. **Reuse assets**: textures, models, language files and recipes move as - they are into the `.hmod`'s `assets/` and `data/` (with `registries`). -6. **Test** with `cargo horizon-mod run` and hot reload; add unit tests for the - logic; publish with a signed `.hmod`. - -## Sources - -- Fabric documentation (`docs.fabricmc.net`): mod structure, Mixin - introduction, Fabric API modules and events. -- SpongePowered Mixin wiki: injection points and how class transformation - works. -- NeoForge documentation (`docs.neoforged.net`): events, registries, - networking. -- Modrinth's most-downloaded Fabric mods, for the porting list. -- Horizon's own Java test mod (`mods/horizon`, built by `tools/build_mod.py` - and the CI `portable-mod` job) is a Fabric mod used by the benchmarks and - parity oracles: it shows the Mixin pattern (`FrameHookMixin`) this page - describes, and stays a developer tool, not a player-facing mod. From 717acb07af64e18299b1c20dfc3e236cba263c04 Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Sat, 24 Oct 2026 15:55:06 +0200 Subject: [PATCH 002/169] Graphics: remove Cull Leaves, which was adapted from the CullLeaves mod The opt-in Cull Leaves setting (#420, from #387) was adapted from the CullLeaves mod's code (MIT, credited in THIRD_PARTY_NOTICES.md). Horizon doesn't build on another mod's code, so it goes, with its notice. Leaves now follow vanilla only: with opaque leaves (cutoutLeaves off) the faces between two leaf blocks are skipped (LeavesBlock.skipRendering), as before #420 and as the setting's Off did. Mangrove roots keep every face. An old options file's cullLeaves line is ignored. Co-Authored-By: Claude Opus 5.5 --- THIRD_PARTY_NOTICES.md | 30 ----- .../examples/probe/section_mesh_fixture.rs | 1 - crates/horizon-client/src/game.rs | 14 +- .../horizon-client/src/game/world_loading.rs | 1 - crates/horizon-client/src/graphics.rs | 10 +- crates/horizon-client/src/graphics_ui.rs | 51 ------- crates/horizon-client/src/mesher.rs | 15 +-- .../src/mesher/leaf_culling_tests.rs | 126 ------------------ .../src/mesher/visibility_tests.rs | 1 - crates/horizon-client/src/streaming.rs | 5 - .../horizon-client/tests/streaming_meshes.rs | 1 - 11 files changed, 7 insertions(+), 248 deletions(-) delete mode 100644 crates/horizon-client/src/mesher/leaf_culling_tests.rs diff --git a/THIRD_PARTY_NOTICES.md b/THIRD_PARTY_NOTICES.md index 88d3197af..63a1f7da3 100644 --- a/THIRD_PARTY_NOTICES.md +++ b/THIRD_PARTY_NOTICES.md @@ -1,35 +1,5 @@ # Third-party notices -## CullLeaves - -The optional leaf and mangrove-root face-culling behavior is adapted from -[CullLeaves](https://github.com/TeamMidnightDust/CullLeaves) by MidnightDust. -Its MIT license is reproduced below. - -```text -MIT License - -Copyright (c) 2020 MidnightDust - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. -``` - ## wgpu-hal `third_party/wgpu-hal` is [wgpu-hal](https://github.com/gfx-rs/wgpu) 30.0.1 by the gfx-rs diff --git a/crates/horizon-client/examples/probe/section_mesh_fixture.rs b/crates/horizon-client/examples/probe/section_mesh_fixture.rs index 98a4fdc34..e212a5268 100644 --- a/crates/horizon-client/examples/probe/section_mesh_fixture.rs +++ b/crates/horizon-client/examples/probe/section_mesh_fixture.rs @@ -136,7 +136,6 @@ fn scene( blend_radius, smooth_lighting, cutout_leaves, - cull_leaves: false, }; let section_y = int(&row["section_y"])?; let started = Instant::now(); diff --git a/crates/horizon-client/src/game.rs b/crates/horizon-client/src/game.rs index 7ac3d0829..39c921187 100644 --- a/crates/horizon-client/src/game.rs +++ b/crates/horizon-client/src/game.rs @@ -9100,21 +9100,11 @@ impl Game<'_> { // Options.biomeBlendRadius, ambientOcclusion and cutoutLeaves: // LevelExtractor.allChanged when they change. let (s, st) = (&self.settings, &self.streaming); - let remesh = ( - s.biome_blend, - s.smooth_lighting, - s.cutout_leaves, - s.horizon.cull_leaves, - ) != ( - st.biome_blend, - st.smooth_lighting, - st.cutout_leaves, - st.cull_leaves, - ); + let remesh = (s.biome_blend, s.smooth_lighting, s.cutout_leaves) + != (st.biome_blend, st.smooth_lighting, st.cutout_leaves); self.streaming.biome_blend = self.settings.biome_blend; self.streaming.smooth_lighting = self.settings.smooth_lighting; self.streaming.cutout_leaves = self.settings.cutout_leaves; - self.streaming.cull_leaves = self.settings.horizon.cull_leaves; if remesh { self.all_sections_changed(); } diff --git a/crates/horizon-client/src/game/world_loading.rs b/crates/horizon-client/src/game/world_loading.rs index ecbee08a8..bd9ae7caa 100644 --- a/crates/horizon-client/src/game/world_loading.rs +++ b/crates/horizon-client/src/game/world_loading.rs @@ -245,7 +245,6 @@ pub(super) fn make_streaming( streaming.biome_blend = settings.biome_blend; streaming.smooth_lighting = settings.smooth_lighting; streaming.cutout_leaves = settings.cutout_leaves; - streaming.cull_leaves = settings.horizon.cull_leaves; streaming.biome_zoom = BiomeZoom::new(obfuscate_seed(seed)); streaming.sky_light = dim != Dim::Nether; streaming.nether_shading = dim == Dim::Nether; diff --git a/crates/horizon-client/src/graphics.rs b/crates/horizon-client/src/graphics.rs index ba492ece8..ce143051a 100644 --- a/crates/horizon-client/src/graphics.rs +++ b/crates/horizon-client/src/graphics.rs @@ -227,8 +227,6 @@ pub struct Graphics { pub far_detail: FarDetail, /// Skip sections hidden behind closed ones (vanilla's occlusion graph). pub cave_culling: bool, - /// Hide shared leaf and mangrove-root faces, reducing foliage density. - pub cull_leaves: bool, /// Skip drawing entities hidden behind opaque terrain. pub entity_culling: bool, /// Meshed sections uploaded per frame; 0 uploads all that are ready. @@ -265,7 +263,6 @@ impl Default for Graphics { lod_distance: 0, far_detail: FarDetail::Full, cave_culling: true, - cull_leaves: false, entity_culling: false, chunk_updates: 0, upload_budget_kib: 0, @@ -312,7 +309,6 @@ impl Graphics { "lodDistance" => g.lod_distance = number(g.lod_distance).min(1024), "farDetail" => g.far_detail = FarDetail::parse(value), "caveCulling" => g.cave_culling = flag(g.cave_culling), - "cullLeaves" => g.cull_leaves = flag(g.cull_leaves), "entityCulling" => g.entity_culling = flag(g.entity_culling), "chunkUpdates" => g.chunk_updates = number(g.chunk_updates).min(512), "uploadBudgetKiB" => g.upload_budget_kib = number(g.upload_budget_kib).min(65536), @@ -348,12 +344,11 @@ impl Graphics { } pub fn serialize(&self) -> String { format!( - "preset:{}\nlodDistance:{}\nfarDetail:{}\ncaveCulling:{}\ncullLeaves:{}\nentityCulling:{}\nchunkUpdates:{}\nuploadBudgetKiB:{}\nsky:{}\nfog:{}\nweather:{}\nanimatedTextures:{}\npresentMode:{}\nframePacing:{}\nworkers:{}\noverlay:{}\nresolutionScale:{}\nfxaa:{}\nbatteryMode:{}\nshaderPack:{}\ngraphicsApi:{}\n", + "preset:{}\nlodDistance:{}\nfarDetail:{}\ncaveCulling:{}\nentityCulling:{}\nchunkUpdates:{}\nuploadBudgetKiB:{}\nsky:{}\nfog:{}\nweather:{}\nanimatedTextures:{}\npresentMode:{}\nframePacing:{}\nworkers:{}\noverlay:{}\nresolutionScale:{}\nfxaa:{}\nbatteryMode:{}\nshaderPack:{}\ngraphicsApi:{}\n", self.preset.name(), self.lod_distance, self.far_detail.name(), bool_text(self.cave_culling), - bool_text(self.cull_leaves), bool_text(self.entity_culling), self.chunk_updates, self.upload_budget_kib, @@ -454,7 +449,6 @@ mod tests { lod_distance: 256, far_detail: FarDetail::Reduced, cave_culling: false, - cull_leaves: true, entity_culling: true, chunk_updates: 12, upload_budget_kib: 4096, @@ -477,7 +471,7 @@ mod tests { // The old menus' Simple / Advanced choice is ignored. assert_eq!(Graphics::parse("level:advanced\n"), Graphics::default()); assert_eq!( - Graphics::parse("workers:abc\nsky:maybe\ncullLeaves:maybe\nentityCulling:maybe\n"), + Graphics::parse("workers:abc\nsky:maybe\ncullLeaves:true\nentityCulling:maybe\n"), Graphics::default() ); } diff --git a/crates/horizon-client/src/graphics_ui.rs b/crates/horizon-client/src/graphics_ui.rs index 6617ef009..b5687ae1c 100644 --- a/crates/horizon-client/src/graphics_ui.rs +++ b/crates/horizon-client/src/graphics_ui.rs @@ -24,7 +24,6 @@ pub enum H { LodDistance, FarDetail, CaveCulling, - CullLeaves, EntityCulling, ChunkUpdates, UploadBudget, @@ -144,11 +143,6 @@ pub fn rows(level: Level) -> Vec { Saves, "Skips terrain hidden behind closed sections. Off costs a lot.", ), - h( - H::CullLeaves, - None, - "Hides shared leaf and mangrove root faces; foliage can look less dense.", - ), h( H::EntityCulling, None, @@ -350,7 +344,6 @@ impl H { }, H::FarDetail => labelled("Far Detail", g.far_detail.label()), H::CaveCulling => labelled("Cave Culling", on_off(g.cave_culling)), - H::CullLeaves => labelled("Cull Leaves", on_off(g.cull_leaves)), H::EntityCulling => labelled("Entity Culling", on_off(g.entity_culling)), H::ChunkUpdates => match g.chunk_updates { 0 => labelled("Chunk Updates", "Unlimited"), @@ -429,7 +422,6 @@ impl H { g.far_detail = step(&[FarDetail::Full, FarDetail::Reduced], g.far_detail, back) } H::CaveCulling => g.cave_culling = !g.cave_culling, - H::CullLeaves => g.cull_leaves = !g.cull_leaves, H::EntityCulling => g.entity_culling = !g.entity_culling, H::Sky => g.sky = !g.sky, H::Fog => g.fog = !g.fog, @@ -466,7 +458,6 @@ impl Item { let g = &s.horizon; Some(match self { Item::Horizon(H::CaveCulling) => g.cave_culling, - Item::Horizon(H::CullLeaves) => g.cull_leaves, Item::Horizon(H::EntityCulling) => g.entity_culling, Item::Horizon(H::Sky) => g.sky, Item::Horizon(H::Fog) => g.fog, @@ -1058,48 +1049,6 @@ mod tests { assert_eq!(s.horizon.upload_budget_kib, 0); } - #[test] - fn cull_leaves_is_opt_in_and_toggles_from_advanced_graphics() { - let mut s = Settings::default(); - let item = Item::Horizon(H::CullLeaves); - assert_eq!(item.switch(&s), Some(false)); - assert_eq!(item.label(&s).plain(), "Cull Leaves: Off"); - for enabled in [false, true] { - s.horizon.cull_leaves = enabled; - for preset in Preset::ALL { - crate::graphics::apply_preset(preset, &mut s); - assert_eq!(s.horizon.cull_leaves, enabled); - } - } - - let mut ui = GraphicsUi::default(); - let size = (480.0, 4000.0); - let (widgets, _, _) = ui.layout(Level::Advanced, size.0, size.1); - let switch = widgets - .iter() - .find(|w| matches!(w.target, Target::Item(i) if i == item)) - .unwrap(); - let point = (switch.x + 1.0, switch.y + 1.0); - for enabled in [false, true] { - s.horizon.preset = Preset::Balanced; - assert_eq!( - ui.click( - Level::Advanced, - &mut s, - point, - size, - [854, 480], - false, - false - ), - vec![Action::ButtonClick, Action::Changed] - ); - assert_eq!(item.switch(&s), Some(enabled)); - assert_eq!(s.horizon.preset, Preset::Custom); - } - assert_eq!(item.label(&s).plain(), "Cull Leaves: On"); - } - #[test] fn entity_culling_is_opt_in_and_toggles_from_advanced_graphics() { let mut s = Settings::default(); diff --git a/crates/horizon-client/src/mesher.rs b/crates/horizon-client/src/mesher.rs index a9e9f6823..59140866a 100644 --- a/crates/horizon-client/src/mesher.rs +++ b/crates/horizon-client/src/mesher.rs @@ -230,8 +230,6 @@ fn visibility(pad: &Padded, info: &[Info]) -> u64 { result } #[cfg(test)] -mod leaf_culling_tests; -#[cfg(test)] mod particle_tests; #[cfg(test)] mod visibility_tests; @@ -277,7 +275,6 @@ struct Info { overlay: bool, /// `LeavesBlock`: with opaque leaves the faces between two leaf blocks are skipped. leaves: bool, - mangrove_roots: bool, blocks_flow: bool, ice: bool, sturdy: u8, @@ -440,7 +437,6 @@ impl MeshTables { legacy_solid: s.legacy_solid, overlay: s.has_class("HalfTransparentBlock") || s.has_class("LeavesBlock"), leaves: s.has_class("LeavesBlock"), - mangrove_roots: s.has_class("MangroveRootsBlock"), blocks_flow: assets.blocks_fluid_flow.contains(&*s.name), ice: s.has_class("IceBlock"), sturdy: s.sturdy_full, @@ -692,8 +688,6 @@ pub struct Mesher<'a> { pub smooth_lighting: bool, /// The `cutoutLeaves` option (fancy graphics); off makes leaves opaque. pub cutout_leaves: bool, - /// Cull shared leaf and mangrove-root faces, including transparent leaves. - pub cull_leaves: bool, } impl Mesher<'_> { /// `region[dz][dx]` are the chunks around the meshed column (centre 1,1). @@ -773,12 +767,9 @@ impl Mesher<'_> { let [dx, dy, dz] = d.normal(); let neighbor = pad.blocks[pi(x + dx, y + dy, z + dz)]; let other = &info[neighbor as usize]; - // Adapted from CullLeaves (MIT); see THIRD_PARTY_NOTICES.md. - let shared_foliage = (state.leaves - && other.leaves - && (!self.cutout_leaves || self.cull_leaves)) - || (self.cull_leaves && state.mangrove_roots && other.mangrove_roots); - visible[d as usize] = !shared_foliage + // LeavesBlock.skipRendering with opaque leaves. + let opaque_leaves = !self.cutout_leaves && state.leaves && other.leaves; + visible[d as usize] = !opaque_leaves && self .visibility .should_render_face( diff --git a/crates/horizon-client/src/mesher/leaf_culling_tests.rs b/crates/horizon-client/src/mesher/leaf_culling_tests.rs deleted file mode 100644 index 679b19090..000000000 --- a/crates/horizon-client/src/mesher/leaf_culling_tests.rs +++ /dev/null @@ -1,126 +0,0 @@ -use super::*; -use horizon_assets::model::Direction as ModelDirection; - -#[test] -fn leaf_culling_removes_only_internal_leaf_and_root_faces() { - let root = - std::path::Path::new(env!("CARGO_MANIFEST_DIR")).join("../../.local/horizon-client/26.3"); - if !root.join("horizon-resources.json").exists() { - return; - } - let assets = Assets::load(&root).unwrap(); - let render = assets.reload(&root).unwrap(); - let facts = BlockFacts::load(&root, assets.registry).unwrap(); - let visibility = crate::models::load_visibility(&root, assets.registry).unwrap(); - let tables = MeshTables::new(&assets, &render, &facts, visibility.clone()).unwrap(); - let biomes = Biomes::load(&root).unwrap(); - let state = |name| assets.registry.default_state(name).unwrap().0; - let oak = state("minecraft:oak_leaves"); - let birch = state("minecraft:birch_leaves"); - let roots = state("minecraft:mangrove_roots"); - let stone = state("minecraft:stone"); - let mesh = |blocks: &[([i32; 3], u32)], cull_leaves, cutout_leaves| { - let mut center = Chunk::empty(0, 0); - let mut east = Chunk::empty(1, 0); - for &([x, y, z], state) in blocks { - let chunk = if x < 16 { &mut center } else { &mut east }; - chunk.set(x, y, z, state); - } - let mut region = [[None; 3]; 3]; - region[1][1] = Some(¢er); - region[1][2] = Some(&east); - Mesher { - nether_shading: false, - assets: &assets, - render: &render, - tables: &tables, - biomes: &biomes, - visibility: visibility.clone(), - zoom: BiomeZoom::new(0), - blend_radius: 0, - smooth_lighting: false, - cutout_leaves, - cull_leaves, - } - .tesselate(®ion, (0 - MIN_Y) / 16) - .solid - }; - - // Native leaves can contain unculled interior geometry as well as their - // outer faces. Select the touching cull group from the actual baked model, - // preserving every other quad and its full vertex attributes. - let without_face = |at: [i32; 3], id, direction| { - let vertices = mesh(&[(at, id)], false, true); - let models = render - .model_catalog - .collect(BlockStateId(id), BlockPos::new(at[0], at[1], at[2])) - .unwrap(); - let faces: Vec<_> = models.iter().flat_map(|(_, model)| &model.faces).collect(); - assert_eq!(vertices.len(), faces.len() * 4); - let retained: Vec<_> = vertices - .as_chunks::<4>() - .0 - .iter() - .zip(faces) - .filter(|(_, face)| face.quad.cull != Some(direction)) - .flat_map(|(quad, _)| quad.iter().copied()) - .collect(); - assert!(retained.len() < vertices.len(), "fixture has a cull group"); - retained - }; - - // Same-species leaves, mixed leaves and roots hide only their touching - // model groups. Disabling the option restores the isolated models. - for (a, b) in [(oak, oak), (oak, birch), (roots, roots)] { - let blocks = [([7, 7, 7], a), ([8, 7, 7], b)]; - let off = mesh(&blocks, false, true); - let on = mesh(&blocks, true, true); - assert_eq!( - off.len(), - mesh(&[blocks[0]], false, true).len() + mesh(&[blocks[1]], false, true).len() - ); - let mut retained = without_face(blocks[0].0, a, ModelDirection::East); - retained.extend(without_face(blocks[1].0, b, ModelDirection::West)); - assert_eq!( - bytemuck::cast_slice::<_, u8>(&on), - bytemuck::cast_slice::<_, u8>(&retained) - ); - } - - // Roots do not join leaves into a single culling group. Ordinary opaque - // neighbors also keep their existing occlusion behavior. - for (a, b) in [(oak, roots), (roots, oak), (oak, stone)] { - let blocks = [([7, 7, 7], a), ([8, 7, 7], b)]; - let off = mesh(&blocks, false, true); - let on = mesh(&blocks, true, true); - assert_eq!( - bytemuck::cast_slice::<_, u8>(&on), - bytemuck::cast_slice::<_, u8>(&off) - ); - } - - // Opaque leaves already hide internal leaf faces independently of this - // option, and a leaf beside air retains its complete baked model. - let pair = [([7, 7, 7], oak), ([8, 7, 7], birch)]; - assert_eq!( - mesh(&pair, false, false).len(), - mesh(&pair, true, false).len() - ); - let isolated = [([7, 7, 7], oak)]; - assert_eq!( - bytemuck::cast_slice::<_, u8>(&mesh(&isolated, false, true)), - bytemuck::cast_slice::<_, u8>(&mesh(&isolated, true, true)) - ); - - // The padding read must also remove the center chunk's internal face - // against a different leaf species in the neighboring chunk. - let boundary = [([15, 7, 7], oak), ([16, 7, 7], birch)]; - assert_eq!( - mesh(&boundary, false, true).len(), - mesh(&[boundary[0]], false, true).len() - ); - assert_eq!( - bytemuck::cast_slice::<_, u8>(&mesh(&boundary, true, true)), - bytemuck::cast_slice::<_, u8>(&without_face(boundary[0].0, oak, ModelDirection::East)) - ); -} diff --git a/crates/horizon-client/src/mesher/visibility_tests.rs b/crates/horizon-client/src/mesher/visibility_tests.rs index 32eb4800c..ad76d48f9 100644 --- a/crates/horizon-client/src/mesher/visibility_tests.rs +++ b/crates/horizon-client/src/mesher/visibility_tests.rs @@ -87,7 +87,6 @@ fn info(solid: bool) -> Info { legacy_solid: false, overlay: false, leaves: false, - mangrove_roots: false, blocks_flow: false, ice: false, sturdy: 0, diff --git a/crates/horizon-client/src/streaming.rs b/crates/horizon-client/src/streaming.rs index 15ed1674e..4cad224fd 100644 --- a/crates/horizon-client/src/streaming.rs +++ b/crates/horizon-client/src/streaming.rs @@ -153,7 +153,6 @@ struct MeshSettings { blend_radius: i32, smooth_lighting: bool, cutout_leaves: bool, - cull_leaves: bool, } enum Job { Generate(i32, i32), @@ -258,7 +257,6 @@ pub struct Streaming { /// The `ao` and `cutoutLeaves` options. pub smooth_lighting: bool, pub cutout_leaves: bool, - pub cull_leaves: bool, /// Incremental relighting of block edits on lit chunks (see `light::relight`). light_tables: Arc, /// Applied edits by sequence, replayed onto light jobs snapshotted before them. @@ -500,7 +498,6 @@ impl Streaming { blend_radius: settings.blend_radius, smooth_lighting: settings.smooth_lighting, cutout_leaves: settings.cutout_leaves, - cull_leaves: settings.cull_leaves, assets: &context.assets, render: &context.render, tables: &context.tables, @@ -556,7 +553,6 @@ impl Streaming { biome_blend: 2, smooth_lighting: true, cutout_leaves: true, - cull_leaves: false, light_tables, light_log: Vec::new(), light_edit_sequence: 0, @@ -1177,7 +1173,6 @@ impl Streaming { blend_radius: self.biome_blend, smooth_lighting: self.smooth_lighting, cutout_leaves: self.cutout_leaves, - cull_leaves: self.cull_leaves, }, ), ); diff --git a/crates/horizon-client/tests/streaming_meshes.rs b/crates/horizon-client/tests/streaming_meshes.rs index f0b6fb038..00c233277 100644 --- a/crates/horizon-client/tests/streaming_meshes.rs +++ b/crates/horizon-client/tests/streaming_meshes.rs @@ -215,7 +215,6 @@ fn relit_columns_keep_every_mesh_current() { blend_radius: 2, smooth_lighting: true, cutout_leaves: true, - cull_leaves: false, assets: &context.assets, render: &context.render, tables: &context.tables, From ba9b876e3e53f11e3a6cacd26d17a4f8df3bba77 Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Sat, 24 Oct 2026 16:12:39 +0200 Subject: [PATCH 003/169] website: the mods page no longer links the removed Java mod notes Co-Authored-By: Claude Opus 5.5 --- website/docs/mods.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/mods.md b/website/docs/mods.md index 4d6a21189..b2dd3eb96 100644 --- a/website/docs/mods.md +++ b/website/docs/mods.md @@ -30,7 +30,7 @@ cd my-mod cargo horizon-mod run ``` -`run` builds the mod and starts the game with it. After an edit, `cargo horizon-mod build` rebuilds it and the running game reloads it. The full guide, with the API, the manifest and the roadmap, is [docs/mods.md](https://github.com/ludovic111/horizon/blob/main/docs/mods.md). What carries over from Java mods, and why jars cannot run, is in [the Java mod notes](https://github.com/ludovic111/horizon/blob/main/docs/research/java-mod-compat.md). +`run` builds the mod and starts the game with it. After an edit, `cargo horizon-mod build` rebuilds it and the running game reloads it. The full guide, with the API, the manifest and the roadmap, is [docs/mods.md](https://github.com/ludovic111/horizon/blob/main/docs/mods.md). Java mod jars don't run in Horizon: their code calls and patches Minecraft's Java classes, and Horizon has none. What carries over is the data and assets inside a jar ([modpacks](https://github.com/ludovic111/horizon/blob/main/docs/modpacks.md)). ## Finding resource packs, shader packs and modpacks From 7a1638a1908f5183102b7f649a79c4d95db8fe7c Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Sat, 24 Oct 2026 16:12:55 +0200 Subject: [PATCH 004/169] Renderer: remove the section face groups modelled on another renderer #503 grouped each section's solid quads by the axis side they face and skipped the groups facing away from the eye. Its code and PR named an internal class of another project as the model. Horizon doesn't build on another project's code, so the grouping goes and every section draws its solid quads in one draw, as vanilla does; the GPU's back-face culling discards the back faces, so the picture is unchanged. This costs frame time, measured on the Mac mini in the PR. A clean-room version can come back later, designed from vanilla and from first principles only. Co-Authored-By: Claude Opus 5.5 --- crates/horizon-client/src/gfx.rs | 32 +-- crates/horizon-client/src/lod.rs | 4 - crates/horizon-client/src/lod/mesh.rs | 4 +- crates/horizon-client/src/mesher.rs | 11 - crates/horizon-client/src/mesher/facing.rs | 267 ------------------ .../src/mesher/leaf_culling_tests.rs | 2 +- 6 files changed, 15 insertions(+), 305 deletions(-) delete mode 100644 crates/horizon-client/src/mesher/facing.rs diff --git a/crates/horizon-client/src/gfx.rs b/crates/horizon-client/src/gfx.rs index 59a3b5d03..b1143be6c 100644 --- a/crates/horizon-client/src/gfx.rs +++ b/crates/horizon-client/src/gfx.rs @@ -177,8 +177,6 @@ struct SectionGpu { start: u64, solid: u32, translucent: u32, - /// The solid quads by facing: back-facing groups are skipped. - faces: crate::mesher::FaceGroups, sort: translucency::SortState, sorted_indices: Option<(u32, u64)>, /// Its id for flat draws (`flat::Flat::add`), when they are on. @@ -2751,7 +2749,6 @@ impl Renderer { start, solid, translucent, - faces: mesh.faces, sort: translucency::SortState::new( mesh.translucent .as_chunks::<4>() @@ -3621,10 +3618,6 @@ impl Renderer { // as one list of indirect draws over the section arena. self.draws.clear(); self.draw_pages.clear(); - // The eye, camera-relative: view bobbing moves it off the camera. - let eye = (frame.bob * crate::camera::view_matrix(frame.yaw, frame.pitch)) - .inverse() - .transform_point3(Vec3::ZERO); // A Java pack that draws the terrain (`gfx/java_terrain.rs`): the // world pass leaves it out, and occlusion culling tests against the // pack's depth (`Cull::test_gl`). @@ -3655,14 +3648,11 @@ impl Renderer { }; let start = draws.len(); let instances = u32::from(first_phase); - let mut indices = 0; - // Only the solid groups that can face the eye. - s.faces.ranges(eye - Vec3::from(v.origin), |first, quads| { - let first = s.start + u64::from(first) * 4; - draws.push([quads * 6, instances, 0, first as u32, i as u32]); + let indices = s.solid * 6; + if indices > 0 { + draws.push([indices, instances, 0, s.start as u32, i as u32]); pages.push((s.page, None)); - indices += quads * 6; - }); + } let runs = if first_phase { &mut self.solid_runs } else { @@ -3699,12 +3689,16 @@ impl Renderer { for (i, v) in visible_lods.iter().enumerate() { let s = &self.lods[&v.key].mesh; let start = self.draws.len(); - s.faces.ranges(eye - Vec3::from(v.origin), |first, quads| { - let first = s.start + u64::from(first) * 4; - self.draws - .push([quads * 6, 1, 0, first as u32, (visible.len() + i) as u32]); + if s.solid > 0 { + self.draws.push([ + s.solid * 6, + 1, + 0, + s.start as u32, + (visible.len() + i) as u32, + ]); self.draw_pages.push((s.page, None)); - }); + } self.solid_runs .push(v.distance, s.page, start, self.draws.len() - start, [0; 3]); } diff --git a/crates/horizon-client/src/lod.rs b/crates/horizon-client/src/lod.rs index f8adb1f16..ee17acee1 100644 --- a/crates/horizon-client/src/lod.rs +++ b/crates/horizon-client/src/lod.rs @@ -1727,10 +1727,6 @@ mod tests { let expected = (key.size() * key.size() - 16 * 16) as f32; assert_eq!(top_area(&mesh.solid, 70.0), expected); assert_eq!(top_area(&mesh.translucent, 80.0 - 1.0 / 9.0), expected); - assert_eq!( - mesh.faces.quads.iter().sum::() as usize, - mesh.solid.len() / 4 - ); assert!(mesh.translucent.iter().all(|v| v.light == 240)); let side = |axis: usize, plane: f32, low: f32, high: f32| { let other = if axis == 0 { 2 } else { 0 }; diff --git a/crates/horizon-client/src/lod/mesh.rs b/crates/horizon-client/src/lod/mesh.rs index 73287af50..852f45e5b 100644 --- a/crates/horizon-client/src/lod/mesh.rs +++ b/crates/horizon-client/src/lod/mesh.rs @@ -2,7 +2,7 @@ use super::{Column, Span, TileKey}; use crate::{ fast_hash::{FxHashMap, FxHashSet}, - mesher::{FaceGroups, OPAQUE_LAYER, SectionMesh, TerrainVertex}, + mesher::{OPAQUE_LAYER, SectionMesh, TerrainVertex}, streaming::WorkerContext, }; use horizon_assets::model::Direction; @@ -558,7 +558,6 @@ fn mesh_columns_with_edges( emit(&mut mesh, key, rect) } } - mesh.faces = FaceGroups::group(&mut mesh.solid); mesh } @@ -1003,7 +1002,6 @@ mod tests { } let mesh = mesh(&columns); assert_eq!(mesh.solid.len(), 6 * 4); - assert_eq!(mesh.faces.quads.iter().sum::(), 6); assert!(mesh.translucent.is_empty()); for q in mesh.solid.as_chunks::<4>().0.iter() { let center = q diff --git a/crates/horizon-client/src/mesher.rs b/crates/horizon-client/src/mesher.rs index a9e9f6823..ec6f2ae73 100644 --- a/crates/horizon-client/src/mesher.rs +++ b/crates/horizon-client/src/mesher.rs @@ -3,7 +3,6 @@ //! `ModelBlockRenderer`/`BlockModelLighter` (smooth light, ambient occlusion, //! cardinal shading, tint sources, block offsets; see `lighting`). Fluids //! follow `FluidRenderer` (see `fluid`). -mod facing; mod fluid; mod lighting; use crate::{ @@ -13,7 +12,6 @@ use crate::{ chunk::{Chunk, MIN_Y}, models::catalog::BakedFace, }; -pub use facing::{FaceGroups, GROUPS as FACE_GROUPS}; use horizon_core::{ biome::BiomeZoom, geometry::Direction, position::BlockPos, random::position_seed, }; @@ -116,8 +114,6 @@ mod vertex_tests { } pub struct SectionMesh { pub solid: Vec, - /// `solid`'s quads by the side they face (`facing`). - pub faces: FaceGroups, pub translucent: Vec, /// VisGraph: bit `a * 6 + b` is set when faces `a` and `b` (Direction /// order) are connected through non-opaque blocks. @@ -131,7 +127,6 @@ impl Default for SectionMesh { fn default() -> Self { Self { solid: Vec::new(), - faces: FaceGroups::default(), translucent: Vec::new(), visibility: ALL_VISIBLE, block_entities: Vec::new(), @@ -698,12 +693,6 @@ pub struct Mesher<'a> { impl Mesher<'_> { /// `region[dz][dx]` are the chunks around the meshed column (centre 1,1). pub fn mesh(&mut self, region: &[[Option<&Chunk>; 3]; 3], sy: i32) -> SectionMesh { - let mut out = self.tesselate(region, sy); - out.faces = facing::group(&mut out.solid); - out - } - /// The section's quads in model order, before `facing::group`. - pub(crate) fn tesselate(&mut self, region: &[[Option<&Chunk>; 3]; 3], sy: i32) -> SectionMesh { let mut out = SectionMesh::default(); let center = region[1][1].expect("centre chunk"); let section = ¢er.sections[sy as usize]; diff --git a/crates/horizon-client/src/mesher/facing.rs b/crates/horizon-client/src/mesher/facing.rs deleted file mode 100644 index 7bafe9e82..000000000 --- a/crates/horizon-client/src/mesher/facing.rs +++ /dev/null @@ -1,267 +0,0 @@ -//! Solid quads grouped by the side they face, as Sodium's `ModelQuadFacing` -//! does. A quad in the plane `x = p` facing +X is front-facing only while the -//! eye is at `x > p`, and terrain culls back faces, so when the eye is on the -//! back side of every quad of a group the renderer skips the group's draw: -//! the GPU would have discarded all of it after shading its vertices. The -//! picture is unchanged; the vertex work for those quads is gone. -use super::TerrainVertex; -use glam::Vec3; - -/// Groups in buffer order: the negative sides, quads not in an axis plane -/// (rotated model elements, sloped fluid tops), then the positive sides. -/// With the eye outside a section on every axis, one side per axis is -/// visible, so the drawn groups form one to three runs. -pub const GROUPS: usize = 7; -const UNALIGNED: usize = 3; -/// The group of a quad facing `-axis` (0 x, 1 y, 2 z) is `NEGATIVE[axis]`, of -/// one facing `+axis` `GROUPS - 1 - NEGATIVE[axis]`. -const NEGATIVE: [usize; 3] = [0, 2, 1]; -/// How far (blocks) the eye must be behind every plane of a group before -/// the group is skipped: rounding on the GPU never makes such a quad -/// front-facing. -const MARGIN: f32 = 1.0 / 16.0; - -/// The solid quads' groups, filled by `group`. -#[derive(Clone, Copy, Debug, PartialEq)] -pub struct FaceGroups { - /// Quads per group, in buffer order. - pub quads: [u32; GROUPS], - /// Per axis group, the plane nearest the side the group faces: the - /// lowest plane of a positive group and the highest of a negative one. - planes: [f32; GROUPS], -} - -impl Default for FaceGroups { - /// Everything unaligned: always drawn. - fn default() -> Self { - Self { - quads: [0; GROUPS], - planes: [0.0; GROUPS], - } - } -} - -impl FaceGroups { - /// Group arbitrary-sized terrain quads, including distant LOD tiles. - pub fn group(solid: &mut Vec) -> Self { - group(solid) - } - - /// Whether group `g` can hold a front-facing quad for an eye at `eye`, - /// relative to the section's minimum corner. - pub fn visible(&self, g: usize, eye: Vec3) -> bool { - if g == UNALIGNED { - return true; - } - let (axis, positive) = axis(g); - if positive { - eye[axis] > self.planes[g] - MARGIN - } else { - eye[axis] < self.planes[g] + MARGIN - } - } - /// The quad ranges (first quad, quad count) to draw for an eye at `eye` - /// relative to the section's minimum corner, adjacent groups merged. - pub fn ranges(&self, eye: Vec3, mut out: impl FnMut(u32, u32)) { - let mut first = 0; - let mut run: Option<(u32, u32)> = None; - for g in 0..GROUPS { - let quads = self.quads[g]; - if quads > 0 { - if self.visible(g, eye) { - run = Some(match run { - Some((start, len)) => (start, len + quads), - None => (first, quads), - }); - } else if let Some((start, len)) = run.take() { - out(start, len); - } - } - first += quads; - } - if let Some((start, len)) = run { - out(start, len); - } - } -} - -/// The axis and sign of each axis group (`UNALIGNED`'s entry is unused). -const AXES: [(usize, bool); GROUPS] = { - let mut axes = [(0, false); GROUPS]; - let mut axis = 0; - while axis < 3 { - axes[NEGATIVE[axis]] = (axis, false); - axes[GROUPS - 1 - NEGATIVE[axis]] = (axis, true); - axis += 1; - } - axes -}; - -/// The axis and sign of axis group `g`. -fn axis(g: usize) -> (usize, bool) { - debug_assert_ne!(g, UNALIGNED); - AXES[g] -} - -/// The group of one quad, and its plane: an axis group only when all four -/// corners lie exactly in one axis plane. -fn facing(quad: &[TerrainVertex]) -> (usize, f32) { - let p = |i: usize| Vec3::from(quad[i].pos); - let normal = (p(1) - p(0)).cross(p(2) - p(0)); - for axis in 0..3 { - let [a, b] = [(axis + 1) % 3, (axis + 2) % 3]; - let plane = quad[0].pos[axis]; - if normal[axis] != 0.0 - && normal[a] == 0.0 - && normal[b] == 0.0 - && quad.iter().all(|v| v.pos[axis] == plane) - { - let negative = NEGATIVE[axis]; - let g = if normal[axis] > 0.0 { - GROUPS - 1 - negative - } else { - negative - }; - return (g, plane); - } - } - (UNALIGNED, 0.0) -} - -/// Reorder `solid` by group, keeping the order of quads within a group (so -/// coplanar quads such as a grass block's overlay still draw after their -/// base), and return the groups. -pub fn group(solid: &mut Vec) -> FaceGroups { - let mut groups = FaceGroups::default(); - for (g, plane) in groups.planes.iter_mut().enumerate() { - if g != UNALIGNED { - *plane = if axis(g).1 { f32::MAX } else { f32::MIN }; - } - } - let faces: Vec = solid - .as_chunks::<4>() - .0 - .iter() - .map(|quad| { - let (g, plane) = facing(quad); - groups.quads[g] += 1; - if g != UNALIGNED { - let nearest = &mut groups.planes[g]; - *nearest = if axis(g).1 { - nearest.min(plane) - } else { - nearest.max(plane) - }; - } - g as u8 - }) - .collect(); - if faces.windows(2).all(|w| w[0] <= w[1]) { - return groups; - } - let mut next = [0usize; GROUPS]; - let mut start = 0; - for g in 0..GROUPS { - next[g] = start; - start += groups.quads[g] as usize; - } - let mut sorted = vec![solid[0]; solid.len()]; - for (quad, &g) in solid.as_chunks::<4>().0.iter().zip(&faces) { - let at = next[g as usize] * 4; - sorted[at..at + 4].copy_from_slice(quad); - next[g as usize] += 1; - } - *solid = sorted; - groups -} - -#[cfg(test)] -mod tests { - use super::*; - - fn vertex(pos: [f32; 3], layer: u16) -> TerrainVertex { - TerrainVertex::new(pos, [0.0; 2], layer, 0, 0) - } - /// A unit quad in the plane `axis = plane`, wound to face `sign`, tagged - /// with `layer` so tests can follow it. - fn quad(axis: usize, plane: f32, sign: f32, layer: u16) -> Vec { - let corner = |u: f32, v: f32| { - let mut p = [0.0; 3]; - p[axis] = plane; - p[(axis + 1) % 3] = u; - p[(axis + 2) % 3] = v; - vertex(p, layer) - }; - let mut q = vec![ - corner(0.0, 0.0), - corner(1.0, 0.0), - corner(1.0, 1.0), - corner(0.0, 1.0), - ]; - if sign < 0.0 { - q.reverse(); - } - q - } - - #[test] - fn quads_group_by_the_side_their_winding_faces() { - for a in 0..3 { - for sign in [-1.0, 1.0] { - let q = quad(a, 4.0, sign, 0); - let (g, plane) = facing(&q); - assert_eq!(axis(g), (a, sign > 0.0), "axis {a} sign {sign}"); - assert_eq!(plane, 4.0); - let normal = (Vec3::from(q[1].pos) - Vec3::from(q[0].pos)) - .cross(Vec3::from(q[2].pos) - Vec3::from(q[0].pos)); - assert_eq!(normal[a].signum(), sign); - } - } - // A cross plant's diagonal quad faces no axis. - let diagonal = [ - [0.0, 0.0, 0.0], - [1.0, 0.0, 1.0], - [1.0, 1.0, 1.0], - [0.0, 1.0, 0.0], - ] - .map(|p| vertex(p, 0)); - assert_eq!(facing(&diagonal).0, UNALIGNED); - } - - #[test] - fn grouping_is_stable_and_skips_only_back_facing_groups() { - // +X at x = 3 and x = 7 (layers 1, 2), -X at x = 5 (3), an unaligned - // quad (4), a coplanar overlay on the x = 3 quad (5). - let diagonal = [ - [0.0, 0.0, 0.0], - [1.0, 0.0, 1.0], - [1.0, 1.0, 1.0], - [0.0, 1.0, 0.0], - ] - .map(|p| vertex(p, 4)); - let mut solid = [ - quad(0, 3.0, 1.0, 1), - quad(0, 5.0, -1.0, 3), - diagonal.to_vec(), - quad(0, 7.0, 1.0, 2), - quad(0, 3.0, 1.0, 5), - ] - .concat(); - let groups = group(&mut solid); - let layers: Vec = solid.chunks(4).map(|q| q[0].layer).collect(); - assert_eq!(layers, [3, 4, 1, 2, 5]); - let ranges = |eye: Vec3| { - let mut out = Vec::new(); - groups.ranges(eye, |first, count| out.push((first, count))); - out - }; - // Between the planes: every group can face the eye. - assert_eq!(ranges(Vec3::new(4.0, 8.0, 8.0)), [(0, 5)]); - // Beyond x = 7: the -X quad at x = 5 faces away. - assert_eq!(ranges(Vec3::new(20.0, 8.0, 8.0)), [(1, 4)]); - // Before x = 3: every +X quad faces away. - assert_eq!(ranges(Vec3::new(-10.0, 8.0, 8.0)), [(0, 2)]); - // Within the margin of the nearest plane: still drawn. - assert_eq!(ranges(Vec3::new(3.0, 8.0, 8.0)), [(0, 5)]); - } -} diff --git a/crates/horizon-client/src/mesher/leaf_culling_tests.rs b/crates/horizon-client/src/mesher/leaf_culling_tests.rs index 679b19090..1273c806d 100644 --- a/crates/horizon-client/src/mesher/leaf_culling_tests.rs +++ b/crates/horizon-client/src/mesher/leaf_culling_tests.rs @@ -42,7 +42,7 @@ fn leaf_culling_removes_only_internal_leaf_and_root_faces() { cutout_leaves, cull_leaves, } - .tesselate(®ion, (0 - MIN_Y) / 16) + .mesh(®ion, (0 - MIN_Y) / 16) .solid }; From d271176f2342e1c2033f4ca38005892c60801f3e Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Sat, 24 Oct 2026 18:31:02 +0200 Subject: [PATCH 005/169] Tools and harnesses start the game in scratch folders, not a player's The game logs into HORIZON_HOME and falls back to the player's own game folder when it is unset. Harnesses that set only HORIZON_NO_AUDIO (and test_native_client, which set nothing) wrote logs, and on a world run advancements, into ~/Library/Application Support/horizon. lab.game_env gives every game a fresh HORIZON_HOME, HORIZON_LAUNCHER_HOME, XDG_DATA_HOME and XDG_CONFIG_HOME, no audio and no launcher self-update; a folder the caller passes is kept. Every launcher of the game uses it, parity.py gives each harness its own HORIZON_HOME, and tests/test_game_home.py fails for a script in tools/ that starts the game without it. Co-Authored-By: Claude Sonnet 5.5 --- docs/parity-workflow.md | 4 + tests/test_game_home.py | 102 ++++++++++++++++++++++++++ tools/agent_control_e2e.py | 15 ++-- tools/graphics_bench.py | 7 +- tools/lab.py | 33 +++++++++ tools/lan_e2e.py | 3 +- tools/launcher_mcp_e2e.py | 3 +- tools/mod_browser_harness.py | 8 +- tools/parity.py | 7 ++ tools/perf_bench.py | 2 +- tools/server_bench.py | 2 +- tools/test_block_removal_parity.py | 2 +- tools/test_command_exec_parity.py | 2 +- tools/test_composter_parity.py | 2 +- tools/test_crafter_parity.py | 2 +- tools/test_dedicated_server_parity.py | 4 +- tools/test_dispenser_parity.py | 2 +- tools/test_friends.py | 2 +- tools/test_mace_parity.py | 2 +- tools/test_native_client.py | 2 +- tools/test_online_mode_parity.py | 4 +- tools/test_save_roundtrip_parity.py | 4 +- tools/test_sculk_parity.py | 2 +- tools/test_secure_chat_parity.py | 2 +- tools/test_use_item_on_parity.py | 2 +- tools/test_world_reopen_parity.py | 5 +- tools/test_world_spawn_parity.py | 2 +- 27 files changed, 190 insertions(+), 37 deletions(-) create mode 100644 tests/test_game_home.py diff --git a/docs/parity-workflow.md b/docs/parity-workflow.md index 1b00080e7..f9f222071 100644 --- a/docs/parity-workflow.md +++ b/docs/parity-workflow.md @@ -32,6 +32,10 @@ Passes are shared between worktrees. A harness's key depends only on the content Every runner on the machine shares `PARITY_MACHINE_JOBS` slots (default: half the CPU threads), so several agents' runs together can't overload it. Parallel harnesses are also admitted by memory: each harness's recorded peak is reserved, within three quarters of the memory available at the start, and a harness starts only if the memory free at that moment still leaves 2 GB. `-j` caps the count here (default: `PARITY_LOCAL_JOBS`, else 3 while other machines help or a third of the CPU threads alone, within `$FLEET_LOAD_JOBS`). +### Harnesses that start the game + +The game logs into `HORIZON_HOME` and falls back to the player's own game folder when it is unset, so a harness that starts the game, `horizon-ctl`, the launcher or the dedicated server builds the environment with `lab.game_env(**extra)`: no audio, and fresh scratch folders for `HORIZON_HOME`, `HORIZON_LAUNCHER_HOME`, `XDG_DATA_HOME` and `XDG_CONFIG_HOME`, removed when the harness exits (a folder you pass, or that the environment already has, is kept). The runner also gives each harness its own `HORIZON_HOME` under `.local/parity-runner/game-home/`. `tests/test_game_home.py` fails for a script in `tools/` that starts the game without it. + ### Other machines Harnesses can also run on the Mac mini and the ThinkPad (`tools/parity_hosts.json` describes them; its `default` list is empty, so pass `--hosts macmini,thinkpad` or set `PARITY_HOSTS`, after copying `shared-local/` to `~/code/horizon-parity/shared-local` on each host). The runner mirrors the worktree there with rsync (not `.git`, `.local`, `target` or ignored files) into `~/code/horizon-parity/remote/`, whose `.local` links to the vanilla data in `~/code/horizon-parity/shared-local`, and starts `tools/parity.py --worker` over ssh. The worker builds the probes (about 80 s the first time) and runs what it is sent under the same tracer, admitting harnesses against its own free memory. One queue, longest first, feeds every machine, remote ones first: the Mac takes up to 14 harnesses, the desktop 3 and only those under 800 MB. Each pass comes back with the content hash of every file it depended on, so it is keyed on exactly what ran, and logs come back to `.local/parity-runner/logs/`; state, sharing and `gate.py` work as before. If a host can't be reached, or drops out, its harnesses run here. diff --git a/tests/test_game_home.py b/tests/test_game_home.py new file mode 100644 index 000000000..b4d9e017f --- /dev/null +++ b/tests/test_game_home.py @@ -0,0 +1,102 @@ +"""A tool or harness that starts the game must not write into a real player's folders. + +The game logs into HORIZON_HOME and falls back to the player's own game folder when it is unset, so every +spawn goes through lab.game_env, which sets fresh scratch folders. This test fails for a script in tools/ +that starts the game (or horizon-ctl, the launcher or the dedicated server) without it.""" + +import ast +import os +from pathlib import Path +import tempfile +import unittest +from unittest import mock + +from tools import lab + +TOOLS = Path(lab.ROOT) / "tools" + +# Strings that mean "this script starts the game": a binary a harness runs, or the audio switch every game run sets. +SPAWN_MARKERS = { + "HORIZON_NO_AUDIO", "horizon-ctl", "horizon-ctl.exe", "horizon-server", "horizon-server.exe", + "horizon-client.exe", "release/horizon-client", "fast/horizon-client", "debug/horizon-client", +} + +# Scripts that mention those strings without starting a game themselves, and why. +EXEMPT = { + "lab.py": "defines game_env", + "parity.py": "runs the harnesses and gives each its own HORIZON_HOME", + "package_native_client.py": "packs the binaries into an archive", + "build_release.py": "builds and packs the release", + "release_train.py": "release bookkeeping", + "pr_ready.py": "runs cargo checks and parity.py", + "port_harness.py": "ports Java code, starts no game", +} + + +def constants(tree): + """Every string in a script that is a whole literal or a keyword name (docstrings are longer text).""" + for node in ast.walk(tree): + if isinstance(node, ast.Constant) and isinstance(node.value, str): + yield node.value + elif isinstance(node, ast.keyword) and node.arg: + yield node.arg + + +def uses_game_env(tree): + """The script calls lab.game_env, or starts its servers through test_dedicated_server_parity.Server, which does.""" + return any(isinstance(node, ast.Attribute) and node.attr == "game_env" + or isinstance(node, ast.Name) and node.id == "game_env" + or isinstance(node, ast.ImportFrom) and (node.module or "").endswith("test_dedicated_server_parity") + for node in ast.walk(tree)) + + +def sets_audio_by_hand(tree): + return "HORIZON_NO_AUDIO" in set(constants(tree)) + + +class GameEnvTests(unittest.TestCase): + def test_gives_every_game_scratch_folders(self): + with mock.patch.dict(os.environ, {}, clear=False): + for key in ("HORIZON_HOME", "HORIZON_LAUNCHER_HOME", "XDG_DATA_HOME", "XDG_CONFIG_HOME"): + os.environ.pop(key, None) + first, second = lab.game_env(), lab.game_env() + self.assertEqual(first["HORIZON_NO_AUDIO"], "1") + self.assertEqual(first["HORIZON_LAUNCHER_NO_SELF_UPDATE"], "1") + for key in ("HORIZON_HOME", "HORIZON_LAUNCHER_HOME", "XDG_DATA_HOME", "XDG_CONFIG_HOME"): + self.assertTrue(Path(first[key]).is_dir(), key) + self.assertNotEqual(first[key], second[key], key) + + def test_keeps_the_callers_folders(self): + with tempfile.TemporaryDirectory() as temp: + env = lab.game_env({"PATH": "x", "HORIZON_HOME": "/from/base"}, HORIZON_LAUNCHER_HOME=Path(temp), A=1) + self.assertEqual(env["HORIZON_HOME"], "/from/base") + self.assertEqual(env["HORIZON_LAUNCHER_HOME"], temp) + self.assertEqual((env["PATH"], env["A"]), ("x", "1")) + + def test_does_not_touch_the_process_environment(self): + before = dict(os.environ) + lab.game_env() + self.assertEqual(dict(os.environ), before) + + +class SpawnerTests(unittest.TestCase): + def test_every_script_that_starts_the_game_uses_game_env(self): + offenders = [] + for path in sorted(TOOLS.rglob("*.py")): + if path.name in EXEMPT: + continue + tree = ast.parse(path.read_text(encoding="utf-8"), filename=str(path)) + if SPAWN_MARKERS & set(constants(tree)) and not uses_game_env(tree): + offenders.append(str(path.relative_to(lab.ROOT))) + self.assertEqual(offenders, [], "these start the game without lab.game_env (HORIZON_HOME falls back to a " + "real player's folder); use it, or list the script in EXEMPT") + + def test_nobody_sets_the_audio_switch_by_hand(self): + offenders = [str(path.relative_to(lab.ROOT)) for path in sorted(TOOLS.rglob("*.py")) + if path.name not in EXEMPT + and sets_audio_by_hand(ast.parse(path.read_text(encoding="utf-8"), filename=str(path)))] + self.assertEqual(offenders, [], "set it through lab.game_env, which also gives the game scratch folders") + + +if __name__ == "__main__": + unittest.main() diff --git a/tools/agent_control_e2e.py b/tools/agent_control_e2e.py index 3fcf39553..7f0c52bce 100644 --- a/tools/agent_control_e2e.py +++ b/tools/agent_control_e2e.py @@ -67,17 +67,20 @@ class Failed(Exception): pass -def game_env(screen): +def game_env(screen, home=None): + """The environment of a game: lab.game_env with HORIZON_HOME `home` (a scratch folder when None), no live-count + ping, and on Linux the virtual screen `screen`.""" + extra = {'HORIZON_TELEMETRY_URL': 'off'} # no live-count ping from test games + if home is not None: + extra['HORIZON_HOME'] = home if sys.platform == 'darwin': - return dict(os.environ, HORIZON_NO_AUDIO='1', HORIZON_TELEMETRY_URL='off') - env = dict(os.environ, VSCREEN=screen) + return lab.game_env(**extra) + env = lab.game_env(VSCREEN=screen, **extra) subprocess.run(['vscreen', 'up'], env=env, check=False, capture_output=True) text = subprocess.run(['vscreen', 'env'], env=env, capture_output=True, text=True, check=True).stdout env.pop('DISPLAY', None) for match in re.finditer(r'(\w+)=(\S+)', text.split('unset')[0]): env[match.group(1)] = match.group(2) - env['HORIZON_NO_AUDIO'] = '1' - env['HORIZON_TELEMETRY_URL'] = 'off' # no live-count ping from test games if LAVAPIPE.exists(): env['VK_ICD_FILENAMES'] = str(LAVAPIPE) return env @@ -632,7 +635,7 @@ def scratch(mode, resources): (work / '.local/horizon-client').mkdir() os.symlink(resources, work / '.local/horizon-client' / lab.VERSION) # horizon-ctl reads No AI in the game home: this one, not the player's. - env = dict(game_env(os.environ.get('VSCREEN', 'agent-control')), HORIZON_HOME=str(work)) + env = game_env(os.environ.get('VSCREEN', 'agent-control'), home=work) return work, env diff --git a/tools/graphics_bench.py b/tools/graphics_bench.py index 0e42e94d5..f19165f62 100644 --- a/tools/graphics_bench.py +++ b/tools/graphics_bench.py @@ -53,15 +53,14 @@ guiScale:0 def vscreen_env(): out = subprocess.run(["vscreen", "env"], cwd=ROOT, capture_output=True, text=True, check=True) - env = dict(os.environ) + env = lab.game_env() for part in out.stdout.replace(";", " ").split(): if "=" in part and not part.startswith("export"): k, v = part.split("=", 1) env[k] = v env.pop("DISPLAY", None) - # Benchmark games never play sound on the machine's speakers. - env["HORIZON_NO_AUDIO"] = "1" - # Nor reach the telemetry server (docs/telemetry.md). + # lab.game_env: no sound on the machine's speakers, and scratch folders instead of the player's. + # Benchmark games do not reach the telemetry server (docs/telemetry.md). env["HORIZON_TELEMETRY_URL"] = "off" return env diff --git a/tools/lab.py b/tools/lab.py index a62a38f59..b7cc2f795 100644 --- a/tools/lab.py +++ b/tools/lab.py @@ -5,6 +5,7 @@ generated files stay in .local/. Also the small helpers the harnesses share (free ports, offline UUIDs, VarInts, float bits).""" import argparse +import atexit from collections import Counter import hashlib import json @@ -54,6 +55,38 @@ def cargo_target(): return ROOT / os.environ.get("CARGO_TARGET_DIR", "target") +_SCRATCH_DIRS = [] + + +def _scratch_dir(prefix): + path = tempfile.mkdtemp(prefix=prefix) + _SCRATCH_DIRS.append(path) + return path + + +@atexit.register +def _remove_scratch_dirs(): + for path in _SCRATCH_DIRS: + shutil.rmtree(path, ignore_errors=True) + + +def game_env(base=None, **extra): + """The environment for every run of the game, the launcher or horizon-ctl from a tool or a harness: no audio, + and fresh scratch folders for the game's home (logs, saves, options), the launcher's home and the XDG folders, + so a run never writes into a real player's folders (the game falls back to them when HORIZON_HOME is unset). + A folder the caller already has in `base` (default os.environ) or passes in `extra` is kept. The scratch folders + are removed when this process exits.""" + env = dict(os.environ if base is None else base) + env.update({key: str(value) for key, value in extra.items()}) + env["HORIZON_NO_AUDIO"] = "1" + env["HORIZON_LAUNCHER_NO_SELF_UPDATE"] = "1" + for key, prefix in (("HORIZON_HOME", "horizon-home-"), ("HORIZON_LAUNCHER_HOME", "horizon-launcher-home-"), + ("XDG_DATA_HOME", "horizon-xdg-data-"), ("XDG_CONFIG_HOME", "horizon-xdg-config-")): + if not env.get(key): + env[key] = _scratch_dir(prefix) + return env + + def write_json(path, data): path.parent.mkdir(parents=True, exist_ok=True) path.write_text(json.dumps(data, indent=2) + "\n", encoding="utf-8") diff --git a/tools/lan_e2e.py b/tools/lan_e2e.py index 3ece4b448..9d0586a2c 100755 --- a/tools/lan_e2e.py +++ b/tools/lan_e2e.py @@ -275,8 +275,7 @@ class Game: (self.work / '.local/horizon-client').mkdir(parents=True) os.symlink(resources, self.work / '.local/horizon-client' / lab.VERSION) self.socket = self.work / 'c.sock' - env = game_env(os.environ.get('VSCREEN', 'lan-e2e')) - env['HORIZON_HOME'] = str(self.work / 'home') + env = game_env(os.environ.get('VSCREEN', 'lan-e2e'), home=self.work / 'home') self.d = Cli(ctl, self.socket, self.work, env) self.d.name = name diff --git a/tools/launcher_mcp_e2e.py b/tools/launcher_mcp_e2e.py index 0b827d288..748acafc2 100644 --- a/tools/launcher_mcp_e2e.py +++ b/tools/launcher_mcp_e2e.py @@ -167,8 +167,7 @@ def main(): os.symlink(bins / name, version / name) os.symlink(resources, version / '.local/horizon-client' / lab.VERSION) (version / '.installed').write_text('') - env = dict(os.environ, HORIZON_LAUNCHER_HOME=str(work / 'launcher'), HORIZON_HOME=str(work / 'home'), - HORIZON_NO_AUDIO='1', HORIZON_TELEMETRY_URL='off') + env = lab.game_env(HORIZON_LAUNCHER_HOME=work / 'launcher', HORIZON_HOME=work / 'home', HORIZON_TELEMETRY_URL='off') m = Mcp(Path(args.launcher).resolve(), env) try: summary = scenario(m, out) diff --git a/tools/mod_browser_harness.py b/tools/mod_browser_harness.py index 4531570bc..cf33d85de 100755 --- a/tools/mod_browser_harness.py +++ b/tools/mod_browser_harness.py @@ -33,6 +33,11 @@ import tempfile import time from pathlib import Path +try: + from . import lab +except ImportError: + import lab + ROOT = Path(__file__).resolve().parents[1] @@ -154,8 +159,7 @@ def main(): args = ap.parse_args() home = Path(tempfile.mkdtemp(prefix="horizon-mod-browser-")) - env = dict(os.environ, HORIZON_HOME=str(home), HORIZON_NO_AUDIO="1", HORIZON_NO_HEARTBEAT="1", - HORIZON_CONTROL=str(home / "ctl.sock")) + env = lab.game_env(HORIZON_HOME=home, HORIZON_NO_HEARTBEAT="1", HORIZON_CONTROL=home / "ctl.sock") launcher = [args.launcher] game = Game(str(Path(args.bin) / "horizon-ctl"), str(Path(args.bin) / "horizon-client"), args.resources, home, env) diff --git a/tools/parity.py b/tools/parity.py index 4ed75f5ef..38a2fcde6 100644 --- a/tools/parity.py +++ b/tools/parity.py @@ -39,6 +39,7 @@ import json import os from pathlib import Path, PurePosixPath import re +import shutil import socket import subprocess import sys @@ -809,6 +810,12 @@ class LocalExecutor: trace.unlink(missing_ok=True) log = (STATE_DIR / "logs" / f"{name}.log").open("w") environment = run_environment(reuse) + # A game the harness starts logs into HORIZON_HOME, which is a real player's folder when it is unset + # (lab.game_env keeps this one). + game_home = STATE_DIR / "game-home" / name + shutil.rmtree(game_home, ignore_errors=True) + game_home.mkdir(parents=True) + environment.setdefault("HORIZON_HOME", str(game_home)) environment["PARITY_SHIM_OUTPUTS"] = str(outputs_listing(name, fresh=True)) environment.pop("PARITY_SHARD", None) if shard: diff --git a/tools/perf_bench.py b/tools/perf_bench.py index 31024737c..5f5f57305 100644 --- a/tools/perf_bench.py +++ b/tools/perf_bench.py @@ -400,7 +400,7 @@ def run_horizon(args, distance): for carry in dev_mods(args): command += ["--dev-mod", str(carry)] # Benchmark runs stay out of the live count and send nothing (docs/telemetry.md). - env = dict(os.environ, HORIZON_NO_AUDIO="1", HORIZON_TELEMETRY_URL="off") + env = lab.game_env(HORIZON_TELEMETRY_URL="off") if args.warm: # A first start to the title screen builds what later starts reuse (the content-mod # root, the block behaviour snapshot). It is not measured: players see it once. diff --git a/tools/server_bench.py b/tools/server_bench.py index a9a494efd..bf1cdabeb 100755 --- a/tools/server_bench.py +++ b/tools/server_bench.py @@ -120,7 +120,7 @@ class Server: self.process = subprocess.Popen([str(c) for c in command], cwd=directory, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, text=True, encoding='utf-8', errors='replace', - env=dict(os.environ, HORIZON_NO_AUDIO='1')) + env=lab.game_env()) threading.Thread(target=self._read, daemon=True).start() def _read(self): diff --git a/tools/test_block_removal_parity.py b/tools/test_block_removal_parity.py index 6ebbbf1d3..3185bd4bb 100755 --- a/tools/test_block_removal_parity.py +++ b/tools/test_block_removal_parity.py @@ -183,7 +183,7 @@ def main(): d.run(['cargo', 'build', '-q', '--release', '-p', 'horizon-client', '--bin', 'horizon-client'], cwd=lab.ROOT, env={**os.environ, 'CARGO_BUILD_JOBS': os.environ.get('CARGO_BUILD_JOBS', '3')}) d.run([str(lab.cargo_target() / 'release/horizon-client'), '--resources', str(resources)], cwd=work, - env={**os.environ, 'HORIZON_DISPENSE_FIXTURE': f'{work / "cases.jsonl"},{work / "rust.txt"}', 'HORIZON_NO_AUDIO': '1'}) + env=lab.game_env(HORIZON_DISPENSE_FIXTURE=f'{work / "cases.jsonl"},{work / "rust.txt"}')) # Loot table names (D) are vanilla's bookkeeping; the drops themselves are compared. ignore = tuple(prefix + ' ' for prefix in args.ignore.split(',') if prefix) + ('D ',) native = h.split_cases((work / 'native.txt').read_text(), ignore) diff --git a/tools/test_command_exec_parity.py b/tools/test_command_exec_parity.py index 9d57d3f69..877bd0b38 100644 --- a/tools/test_command_exec_parity.py +++ b/tools/test_command_exec_parity.py @@ -82,7 +82,7 @@ def main(): rust_dir = build / 'rust' shutil.rmtree(rust_dir, ignore_errors=True) rust_dir.mkdir() - env = dict(os.environ, HORIZON_NO_AUDIO='1', HORIZON_COMMAND_SCRIPT=str(script_path), HORIZON_COMMAND_OUTPUT=str(build / 'rust.jsonl')) + env = lab.game_env(HORIZON_COMMAND_SCRIPT=script_path, HORIZON_COMMAND_OUTPUT=build / 'rust.jsonl') run([binary, '--resources', lab.RESOURCES, '--world', 'harness', '--seed', SEED, '--radius', 4], 'rust', cwd=rust_dir, env=env) vanilla = [json.loads(l) for l in (build / 'vanilla.jsonl').open(encoding='utf-8')] diff --git a/tools/test_composter_parity.py b/tools/test_composter_parity.py index e632527ce..074b227a8 100644 --- a/tools/test_composter_parity.py +++ b/tools/test_composter_parity.py @@ -125,7 +125,7 @@ def main(): d.run(['cargo', 'build', '-q', '--release', '-p', 'horizon-client', '--bin', 'horizon-client'], cwd=lab.ROOT, env={**os.environ, 'CARGO_BUILD_JOBS': os.environ.get('CARGO_BUILD_JOBS', '3')}) d.run([str(lab.cargo_target() / 'release/horizon-client'), '--resources', str(resources)], cwd=work, - env={**os.environ, 'HORIZON_DISPENSE_FIXTURE': f'{work / "cases.jsonl"},{work / "rust.txt"}', 'HORIZON_NO_AUDIO': '1'}) + env=lab.game_env(HORIZON_DISPENSE_FIXTURE=f'{work / "cases.jsonl"},{work / "rust.txt"}')) ignore = tuple(prefix + ' ' for prefix in args.ignore.split(',') if prefix) + ('D ',) native = h.split_cases((work / 'native.txt').read_text(), ignore) rust = h.split_cases((work / 'rust.txt').read_text(), ignore) diff --git a/tools/test_crafter_parity.py b/tools/test_crafter_parity.py index 1b9564f41..b9c343d4d 100644 --- a/tools/test_crafter_parity.py +++ b/tools/test_crafter_parity.py @@ -245,7 +245,7 @@ def main(): d.run(['cargo', 'build', '-q', '--release', '-p', 'horizon-client', '--bin', 'horizon-client'], cwd=lab.ROOT, env={**os.environ, 'CARGO_BUILD_JOBS': os.environ.get('CARGO_BUILD_JOBS', '3')}) d.run([str(lab.cargo_target() / 'release/horizon-client'), '--resources', str(resources)], cwd=work, - env={**os.environ, 'HORIZON_DISPENSE_FIXTURE': f'{work / "cases.jsonl"},{work / "rust.txt"}', 'HORIZON_NO_AUDIO': '1'}) + env=lab.game_env(HORIZON_DISPENSE_FIXTURE=f'{work / "cases.jsonl"},{work / "rust.txt"}')) ignore = tuple(prefix + ' ' for prefix in args.ignore.split(',') if prefix) + ('D ',) native = h.split_cases((work / 'native.txt').read_text(), ignore) rust = h.split_cases((work / 'rust.txt').read_text(), ignore) diff --git a/tools/test_dedicated_server_parity.py b/tools/test_dedicated_server_parity.py index f45df9822..6a6d258d4 100644 --- a/tools/test_dedicated_server_parity.py +++ b/tools/test_dedicated_server_parity.py @@ -126,7 +126,7 @@ class Server: self.lines = [] self.process = subprocess.Popen(list(map(str, command)), cwd=directory, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, text=True, - encoding='utf-8', errors='replace') + encoding='utf-8', errors='replace', env=lab.game_env()) self.reader = threading.Thread(target=self._read, daemon=True) self.reader.start() @@ -352,7 +352,7 @@ def horizon_client_joins(vanilla_server, binary, world, build, reference): server = Server(vanilla_server, directory, label) try: server.wait_for(r'Done \(') - env = dict(os.environ, HORIZON_NO_AUDIO='1', HORIZON_NET_REPORT=str(report)) + env = lab.game_env(HORIZON_NET_REPORT=report) with (build / 'horizon-client-run.log').open('w') as log: subprocess.run([str(c) for c in [binary, '--resources', lab.RESOURCES, '--render-distance', 2, '--server', f'127.0.0.1:{port}', '--name', PLAYER]], diff --git a/tools/test_dispenser_parity.py b/tools/test_dispenser_parity.py index 844322aeb..a6d1f429a 100644 --- a/tools/test_dispenser_parity.py +++ b/tools/test_dispenser_parity.py @@ -417,7 +417,7 @@ def main(): run(['cargo', 'build', '-q', '--release', '-p', 'horizon-client', '--bin', 'horizon-client'], cwd=lab.ROOT, env={**os.environ, 'CARGO_BUILD_JOBS': os.environ.get('CARGO_BUILD_JOBS', '3')}) run([str(lab.cargo_target() / 'release/horizon-client'), '--resources', str(resources)], cwd=work, - env={**os.environ, 'HORIZON_DISPENSE_FIXTURE': f'{work / "cases.jsonl"},{work / "rust.txt"}', 'HORIZON_NO_AUDIO': '1'}) + env=lab.game_env(HORIZON_DISPENSE_FIXTURE=f'{work / "cases.jsonl"},{work / "rust.txt"}')) # Loot table names (D) are vanilla's bookkeeping; the drops themselves are compared. ignore = tuple(prefix + ' ' for prefix in args.ignore.split(',') if prefix) + ('D ',) native = h.split_cases((work / 'native.txt').read_text(), ignore) diff --git a/tools/test_friends.py b/tools/test_friends.py index 8fa1a4fee..cc5d15b92 100644 --- a/tools/test_friends.py +++ b/tools/test_friends.py @@ -96,7 +96,7 @@ class Game: self.process = subprocess.Popen(Game.prefix + [ str(client), '--resources', str(resources), '--render-distance', '2', '--test-terrain', '--control-socket', str(self.endpoint), '--timeout-seconds', '600', - ] + Game.extra, cwd=self.home, env=dict(os.environ, HORIZON_HOME=str(self.home), HORIZON_NO_AUDIO='1', **env), + ] + Game.extra, cwd=self.home, env=lab.game_env(HORIZON_HOME=self.home, **env), stdout=self.log, stderr=subprocess.STDOUT) wait_for(self.endpoint, 'screen', lambda v: v['screen'] == 'title', 120, f'{name} title') diff --git a/tools/test_mace_parity.py b/tools/test_mace_parity.py index 123f19693..578e9e6ee 100644 --- a/tools/test_mace_parity.py +++ b/tools/test_mace_parity.py @@ -170,7 +170,7 @@ def main(): d.run(['cargo', 'build', '-q', '--release', '-p', 'horizon-client', '--bin', 'horizon-client'], cwd=lab.ROOT, env={**os.environ, 'CARGO_BUILD_JOBS': os.environ.get('CARGO_BUILD_JOBS', '3')}) d.run([str(lab.cargo_target() / 'release/horizon-client'), '--resources', str(resources)], cwd=work, - env={**os.environ, 'HORIZON_DISPENSE_FIXTURE': f'{work / "cases.jsonl"},{work / "rust.txt"}', 'HORIZON_NO_AUDIO': '1'}) + env=lab.game_env(HORIZON_DISPENSE_FIXTURE=f'{work / "cases.jsonl"},{work / "rust.txt"}')) ignore = tuple(prefix + ' ' for prefix in args.ignore.split(',') if prefix) + ('D ',) native = h.split_cases((work / 'native.txt').read_text(), ignore) rust = h.split_cases((work / 'rust.txt').read_text(), ignore) diff --git a/tools/test_native_client.py b/tools/test_native_client.py index 73e6f3223..552ea8c42 100644 --- a/tools/test_native_client.py +++ b/tools/test_native_client.py @@ -71,7 +71,7 @@ def main(): str(executable), '--radius', '1', '--frames', '30', '--smoke-report', str(report), '--timeout-seconds', '60'] with (root / 'startup-smoke.log').open('w') as log: - subprocess.run(command, cwd=lab.ROOT, env=environment, check=True, + subprocess.run(command, cwd=lab.ROOT, env=lab.game_env(environment), check=True, stdout=log, stderr=subprocess.STDOUT, timeout=120) result = json.loads(report.read_text()) if (result.get('error') is not None or result.get('presented_frames') != 30 diff --git a/tools/test_online_mode_parity.py b/tools/test_online_mode_parity.py index d430c2a68..d03838bf3 100644 --- a/tools/test_online_mode_parity.py +++ b/tools/test_online_mode_parity.py @@ -179,7 +179,7 @@ def run_client(binary, build, port, label, token, discovery): shutil.rmtree(directory, ignore_errors=True) directory.mkdir() report = directory / 'report.json' - env = dict(os.environ, HORIZON_NO_AUDIO='1', HORIZON_NET_REPORT=str(report), HORIZON_API_DISCOVERY=discovery) + env = lab.game_env(HORIZON_NET_REPORT=report, HORIZON_API_DISCOVERY=discovery) command = [binary, '--resources', lab.RESOURCES, '--render-distance', 2, '--server', f'127.0.0.1:{port}', '--name', PLAYER] if token: @@ -246,7 +246,7 @@ def run_side(label, command, binary, build, services, discovery): props = dict(PROPERTIES, **{'server-port': str(port)}) (directory / 'server.properties').write_text(''.join(f'{k}={v}\n' for k, v in props.items())) (directory / 'eula.txt').write_text('eula=true\n') - os.environ.update(HORIZON_NO_AUDIO='1', HORIZON_API_DISCOVERY=discovery) + os.environ.update(lab.game_env(HORIZON_API_DISCOVERY=discovery)) server = Server(command, directory, f'{label}-online') checks = [] starts = [] diff --git a/tools/test_save_roundtrip_parity.py b/tools/test_save_roundtrip_parity.py index bd8b07a29..732429881 100644 --- a/tools/test_save_roundtrip_parity.py +++ b/tools/test_save_roundtrip_parity.py @@ -330,7 +330,7 @@ def entity_uuid_text(i): def vscreen_env(): text = subprocess.run(['vscreen', 'env'], capture_output=True, text=True, check=True).stdout - env = dict(os.environ) + env = lab.game_env() env.pop('DISPLAY', None) for match in re.finditer(r'(\w+)=(\S+)', text.split('unset')[0]): env[match.group(1)] = match.group(2) @@ -346,7 +346,7 @@ def horizon_resave(source, destination, bin_dir): ctl = [str(bin_dir / 'horizon-ctl'), '--socket', str(socket)] extra = [] if sys.platform == 'darwin': - env = dict(os.environ, HORIZON_NO_AUDIO='1') + env = lab.game_env() extra = ['--offscreen'] else: alsa = destination / 'null-asound.conf' diff --git a/tools/test_sculk_parity.py b/tools/test_sculk_parity.py index b9c7417a5..ae2c1c6aa 100644 --- a/tools/test_sculk_parity.py +++ b/tools/test_sculk_parity.py @@ -339,7 +339,7 @@ def main(): oracle_harness.run_logged(['cargo', 'build', '--locked', '--release', '-p', 'horizon-client', '--bin', 'horizon-client'], build, 'compile-rust') oracle_harness.run_logged([lab.cargo_target() / 'release/horizon-client', '--resources', resources], build, 'horizon', - env={**os.environ, 'HORIZON_SCULK_FIXTURE': f'{inputs},{build / "horizon.txt"}', 'HORIZON_NO_AUDIO': '1'}) + env=lab.game_env(HORIZON_SCULK_FIXTURE=f'{inputs},{build / "horizon.txt"}')) if args.java_only: return names = {s[0] for _, s in chosen} diff --git a/tools/test_secure_chat_parity.py b/tools/test_secure_chat_parity.py index c6c76a892..b9062568a 100644 --- a/tools/test_secure_chat_parity.py +++ b/tools/test_secure_chat_parity.py @@ -264,7 +264,7 @@ def main(): oh.run_logged([*java, 'keys', build], build, 'keys') services = Services(json.loads((build / 'publickeys.json').read_text())) discovery = services.url + '/minecraft/client' - os.environ.update(HORIZON_NO_AUDIO='1', HORIZON_API_DISCOVERY=discovery) + os.environ.update(lab.game_env(HORIZON_API_DISCOVERY=discovery)) servers = { 'vanilla': ['java', '-Xmx2g', '-Duser.timezone=UTC', f'-Dminecraft.api.discovery.host={discovery}', '-cp', dependencies, 'net.minecraft.server.Main', 'nogui'], diff --git a/tools/test_use_item_on_parity.py b/tools/test_use_item_on_parity.py index d6e5f899f..89b463116 100644 --- a/tools/test_use_item_on_parity.py +++ b/tools/test_use_item_on_parity.py @@ -375,7 +375,7 @@ def main(): d.run(['cargo', 'build', '-q', '--release', '-p', 'horizon-client', '--bin', 'horizon-client'], cwd=lab.ROOT, env={**os.environ, 'CARGO_BUILD_JOBS': os.environ.get('CARGO_BUILD_JOBS', '3')}) d.run([str(lab.cargo_target() / 'release/horizon-client'), '--resources', str(resources)], cwd=work, - env={**os.environ, 'HORIZON_DISPENSE_FIXTURE': f'{work / "cases.jsonl"},{work / "rust.txt"}', 'HORIZON_NO_AUDIO': '1'}) + env=lab.game_env(HORIZON_DISPENSE_FIXTURE=f'{work / "cases.jsonl"},{work / "rust.txt"}')) ignore = tuple(prefix + ' ' for prefix in args.ignore.split(',') if prefix) + ('D ',) native = h.split_cases((work / 'native.txt').read_text(), ignore) rust = h.split_cases((work / 'rust.txt').read_text(), ignore) diff --git a/tools/test_world_reopen_parity.py b/tools/test_world_reopen_parity.py index 381927013..4ef9a5e87 100644 --- a/tools/test_world_reopen_parity.py +++ b/tools/test_world_reopen_parity.py @@ -24,6 +24,9 @@ import sys import tempfile from pathlib import Path +sys.path.insert(0, str(Path(__file__).resolve().parent)) +import lab # noqa: E402 + ROOT = Path(__file__).resolve().parent.parent RESOURCES = ROOT / '.local' / 'horizon-client' / '26.3' RUN = ROOT / '.local' / 'world-reopen' @@ -32,7 +35,7 @@ CYCLES = 3 def game_env(): """macOS renders offscreen; Linux uses the virtual screen (as test_save_roundtrip_parity).""" - env = dict(os.environ, HORIZON_NO_AUDIO='1') + env = lab.game_env() if sys.platform == 'darwin': return env, ['--offscreen'] subprocess.run(['vscreen', 'up'], check=False, capture_output=True) diff --git a/tools/test_world_spawn_parity.py b/tools/test_world_spawn_parity.py index 5daa38a45..00c390005 100644 --- a/tools/test_world_spawn_parity.py +++ b/tools/test_world_spawn_parity.py @@ -140,7 +140,7 @@ def main(): # One worker thread: the chunks decorated in a fixed order (see above). vanilla_server = ['java', '-Xmx2g', '-Dmax.bg.threads=1', '-cp', dependencies, 'net.minecraft.server.Main', 'nogui'] horizon_server = [binary, '--resources', RESOURCES, '--dedicated', '--nogui'] - os.environ['HORIZON_NO_AUDIO'] = '1' + os.environ.update(lab.game_env()) def one(seed): t0 = time.time() From 83657f3bbf60fdbe2a059b16139ab798ea442e78 Mon Sep 17 00:00:00 2001 From: Ryan B Date: Sat, 24 Oct 2026 14:04:46 -0400 Subject: [PATCH 006/169] fix: resolve Minecraft DNS SRV redirects for ping and login Co-Authored-By: OpenAI Codex gpt-6.1-sol --- Cargo.lock | 281 +++++++++++++++++++++- crates/horizon-client/src/net.rs | 11 +- crates/horizon-protocol/Cargo.toml | 3 + crates/horizon-protocol/src/connection.rs | 13 + crates/horizon-protocol/src/lib.rs | 1 + crates/horizon-protocol/src/resolver.rs | 166 +++++++++++++ 6 files changed, 467 insertions(+), 8 deletions(-) create mode 100644 crates/horizon-protocol/src/resolver.rs diff --git a/Cargo.lock b/Cargo.lock index 46b99b819..1f0958f95 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -155,7 +155,7 @@ dependencies = [ "objc2-foundation 0.3.2", "parking_lot", "percent-encoding", - "windows-sys 0.59.0", + "windows-sys 0.60.2", "wl-clipboard-rs", "x11rb", ] @@ -187,6 +187,17 @@ dependencies = [ "libloading", ] +[[package]] +name = "async-trait" +version = "0.1.92" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "82f6aeea286b8eb4dd3431a1be1b59d290ace00f5bfd8e2a159bc2a05e2c1667" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", +] + [[package]] name = "atomic-waker" version = "1.1.2" @@ -699,6 +710,30 @@ dependencies = [ "cfg-if", ] +[[package]] +name = "critical-section" +version = "1.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "790eea4361631c5e7d22598ecd5723ff611904e3344ce8720784c93e3d83d40b" + +[[package]] +name = "crossbeam-channel" +version = "0.5.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "98b0cc327b5bc766e7fda9c9260cc0fa81b43a8e240440422dff70788e3f9ef1" +dependencies = [ + "crossbeam-utils", +] + +[[package]] +name = "crossbeam-epoch" +version = "0.9.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dc74980687109a3b14c72fd458107bf0baa1da1a1a805e178d15501ba9b86d9d" +dependencies = [ + "crossbeam-utils", +] + [[package]] name = "crossbeam-utils" version = "0.8.23" @@ -718,7 +753,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "78c8292055d1c1df0cce5d180393dc8cce0abec0a7102adb6c7b1eef6016d60a" dependencies = [ "generic-array", - "rand_core", + "rand_core 0.6.4", "typenum", ] @@ -738,7 +773,7 @@ dependencies = [ "cpufeatures", "curve25519-dalek-derive", "fiat-crypto", - "rand_core", + "rand_core 0.6.4", "rustc_version", "subtle", ] @@ -760,6 +795,12 @@ version = "0.11.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "0c87e182de0887fd5361989c677c4e8f5000cd9491d6d563161a8f3a5519fc7f" +[[package]] +name = "data-encoding" +version = "2.11.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4583a4551df46e2792f82ceeac45e850d2e2d5debba0b91f102385cda5b11f06" + [[package]] name = "derive_arbitrary" version = "1.5.0" @@ -871,6 +912,18 @@ dependencies = [ "simdutf8", ] +[[package]] +name = "enum-as-inner" +version = "0.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a1e6a265c649f3f5979b601d26f1d05ada116434c87741c9493cb56218f76cbc" +dependencies = [ + "heck", + "proc-macro2", + "quote", + "syn 2.0.119", +] + [[package]] name = "equivalent" version = "1.0.2" @@ -991,12 +1044,27 @@ dependencies = [ "percent-encoding", ] +[[package]] +name = "futures-channel" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b1f9e3d69d39e4862ffed03ed071a76f9a13ba1d9109d355b0f0aa6b15e393c4" +dependencies = [ + "futures-core", +] + [[package]] name = "futures-core" version = "0.3.34" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "92d699e522242e69e3003b94ecc1f960f3a5e015aa7c5d7486e65ad01dd94f5e" +[[package]] +name = "futures-io" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "53c0fa8157de1303bfffdaa1cc2a673bfffb60102f76b0ef4441659124373fed" + [[package]] name = "futures-task" version = "0.3.34" @@ -1188,6 +1256,52 @@ version = "0.5.3" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "e17592d60ebacc7d5e169f4663c5f84f9161cc90328abcfe8456f41e4dfcb284" +[[package]] +name = "hickory-proto" +version = "0.25.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f8a6fe56c0038198998a6f217ca4e7ef3a5e51f46163bd6dd60b5c71ca6c6502" +dependencies = [ + "async-trait", + "cfg-if", + "data-encoding", + "enum-as-inner", + "futures-channel", + "futures-io", + "futures-util", + "idna", + "ipnet", + "once_cell", + "rand", + "ring", + "thiserror 2.0.21", + "tinyvec", + "tokio", + "tracing", + "url", +] + +[[package]] +name = "hickory-resolver" +version = "0.25.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dc62a9a99b0bfb44d2ab95a7208ac952d31060efc16241c87eaf36406fecf87a" +dependencies = [ + "cfg-if", + "futures-util", + "hickory-proto", + "ipconfig", + "moka", + "once_cell", + "parking_lot", + "rand", + "resolv-conf", + "smallvec", + "thiserror 2.0.21", + "tokio", + "tracing", +] + [[package]] name = "hidapi" version = "2.6.7" @@ -1314,7 +1428,7 @@ dependencies = [ "serde", "serde_json", "sha2", - "socket2", + "socket2 0.5.10", "spake2", ] @@ -1375,11 +1489,13 @@ version = "0.1.0" dependencies = [ "flate2", "getrandom 0.3.4", + "hickory-resolver", "horizon-core", "horizon-world", "serde_json", "sha1", "sha2", + "tokio", ] [[package]] @@ -1653,6 +1769,25 @@ dependencies = [ "generic-array", ] +[[package]] +name = "ipconfig" +version = "0.3.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4d40460c0ce33d6ce4b0630ad68ff63d6661961c48b6dba35e5a4d81cfb48222" +dependencies = [ + "socket2 0.6.5", + "widestring", + "windows-registry", + "windows-result 0.4.1", + "windows-sys 0.61.2", +] + +[[package]] +name = "ipnet" +version = "2.12.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "791930b43c0d5973160d90a8f3894509f2b273430f5c5c73b668636d0287c5c0" + [[package]] name = "itertools" version = "0.14.0" @@ -1917,6 +2052,34 @@ dependencies = [ "simd-adler32", ] +[[package]] +name = "mio" +version = "1.2.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1788edb87fdc09c7e26304471e2f5be8cdefb1b6930d6e3985fc02ff53bf86ee" +dependencies = [ + "libc", + "wasi", + "windows-sys 0.61.2", +] + +[[package]] +name = "moka" +version = "0.12.16" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4293f18e7567a1caf3c584855554377025c65e0aa445344d04171f5ad63d19b9" +dependencies = [ + "crossbeam-channel", + "crossbeam-epoch", + "crossbeam-utils", + "equivalent", + "parking_lot", + "portable-atomic", + "smallvec", + "tagptr", + "uuid", +] + [[package]] name = "multiversion_no_op" version = "1.0.0" @@ -2416,6 +2579,10 @@ name = "once_cell" version = "1.21.4" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50" +dependencies = [ + "critical-section", + "portable-atomic", +] [[package]] name = "opaque-debug" @@ -2619,6 +2786,15 @@ dependencies = [ "zerovec", ] +[[package]] +name = "ppv-lite86" +version = "0.2.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "85eae3c4ed2f50dcfe72643da4befc30deadb458a9b590d720cde2f2b1e97da9" +dependencies = [ + "zerocopy", +] + [[package]] name = "presser" version = "0.3.1" @@ -2712,6 +2888,26 @@ version = "6.0.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "f8dcc9c7d52a811697d2151c701e0d08956f92b0e24136cf4cf27b57a6a0d9bf" +[[package]] +name = "rand" +version = "0.9.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b9ef1d0d795eb7d84685bca4f72f3649f064e6641543d3a8c415898726a57b41" +dependencies = [ + "rand_chacha", + "rand_core 0.9.5", +] + +[[package]] +name = "rand_chacha" +version = "0.9.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d3022b5f1df60f26e1ffddd6c66e8aa15de382ae63b3a0c1bfc0e4d3e3f325cb" +dependencies = [ + "ppv-lite86", + "rand_core 0.9.5", +] + [[package]] name = "rand_core" version = "0.6.4" @@ -2721,6 +2917,15 @@ dependencies = [ "getrandom 0.2.17", ] +[[package]] +name = "rand_core" +version = "0.9.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "76afc826de14238e6e8c374ddcc1fa19e374fd8dd986b0d2af0d02377261d83c" +dependencies = [ + "getrandom 0.3.4", +] + [[package]] name = "range-alloc" version = "0.1.5" @@ -2821,6 +3026,12 @@ version = "1.1.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "19b30a45b0cd0bcca8037f3d0dc3421eaf95327a17cad11964fb8179b4fc4832" +[[package]] +name = "resolv-conf" +version = "0.7.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1e061d1b48cb8d38042de4ae0a7a6401009d6143dc80d2e2d6f31f0bdd6470c7" + [[package]] name = "ring" version = "0.17.14" @@ -3137,6 +3348,16 @@ dependencies = [ "windows-sys 0.52.0", ] +[[package]] +name = "socket2" +version = "0.6.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c3d1e2c7f27f8d4cb10542a02c49005dbd6e93095799d6f3be745fae9f8fedd4" +dependencies = [ + "libc", + "windows-sys 0.61.2", +] + [[package]] name = "spake2" version = "0.4.0" @@ -3145,7 +3366,7 @@ checksum = "c5482afe85a0b6ce956c945401598dbc527593c77ba51d0a87a586938b1b893a" dependencies = [ "curve25519-dalek", "hkdf", - "rand_core", + "rand_core 0.6.4", "sha2", ] @@ -3286,6 +3507,12 @@ dependencies = [ "syn 3.0.6", ] +[[package]] +name = "tagptr" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7b2093cf4c8eb1e67749a6762251bc9cd836b6fc171623bd0a9d324d37af2417" + [[package]] name = "target-lexicon" version = "0.13.5" @@ -3376,13 +3603,36 @@ dependencies = [ "zerovec", ] +[[package]] +name = "tinyvec" +version = "1.13.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fd3ca314f692efd6c868f8408f53fe444634a845f96c028b97d35f6a1f79f0ee" + [[package]] name = "tokio" version = "1.53.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "e95f91fcc7a621e8b030f6aa23c71fe9838ae2fb4d8118b75602a328f5144044" dependencies = [ + "bytes", + "libc", + "mio", "pin-project-lite", + "socket2 0.6.5", + "tokio-macros", + "windows-sys 0.61.2", +] + +[[package]] +name = "tokio-macros" +version = "2.7.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "78773a2a397f451582ce068015985c33193cf6dea8b74d2a639fe457b2f07b0e" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.6", ] [[package]] @@ -3452,6 +3702,9 @@ name = "tracing-core" version = "0.1.36" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "db97caf9d906fbde555dd62fa95ddba9eecfd14cb388e4f491a66d74cd5fb79a" +dependencies = [ + "once_cell", +] [[package]] name = "tree_magic_mini" @@ -3561,6 +3814,7 @@ version = "1.28.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "7cc1186384beb7dd8eedea376413fd654937285ea6c9cfbb928dc3043ea4b606" dependencies = [ + "getrandom 0.4.3", "js-sys", "wasm-bindgen", ] @@ -4297,6 +4551,12 @@ dependencies = [ "web-sys", ] +[[package]] +name = "widestring" +version = "1.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "72069c3113ab32ab29e5584db3c6ec55d416895e60715417b5b883a357c3e471" + [[package]] name = "winapi-util" version = "0.1.11" @@ -4429,6 +4689,17 @@ dependencies = [ "windows-link", ] +[[package]] +name = "windows-registry" +version = "0.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "02752bf7fbdcce7f2a27a742f798510f3e5ad88dbe84871e5168e2120c3d5720" +dependencies = [ + "windows-link", + "windows-result 0.4.1", + "windows-strings", +] + [[package]] name = "windows-result" version = "0.1.2" diff --git a/crates/horizon-client/src/net.rs b/crates/horizon-client/src/net.rs index 74f1b0b6d..ebe9f226f 100644 --- a/crates/horizon-client/src/net.rs +++ b/crates/horizon-client/src/net.rs @@ -268,8 +268,13 @@ fn run( target } }; - let c = - Connection::connect(&host, port, Duration::from_secs(10)).map_err(|e| e.to_string())?; + let c = if address.starts_with(FRIEND) { + // The friends relay supplies a concrete endpoint, not a Minecraft hostname. + Connection::connect(&host, port, Duration::from_secs(10)) + } else { + Connection::connect_server(&host, port, Duration::from_secs(10)) + } + .map_err(|e| e.to_string())?; (host, port, c) }; *shared_counters.lock().unwrap() = Some(c.reader.counters.clone()); @@ -559,7 +564,7 @@ pub fn load_language(resources: &std::path::Path) -> Language { pub fn ping(address: &str, timeout: Duration) -> Result<(serde_json::Value, u128), String> { use horizon_protocol::packets::status; let (host, port) = parse_address(address).ok_or("Invalid address")?; - let mut c = Connection::connect(&host, port, timeout).map_err(|e| e.to_string())?; + let mut c = Connection::connect_server(&host, port, timeout).map_err(|e| e.to_string())?; c.reader .set_read_timeout(Some(timeout)) .map_err(|e| e.to_string())?; diff --git a/crates/horizon-protocol/Cargo.toml b/crates/horizon-protocol/Cargo.toml index 71b93a1fe..ae9049e2c 100644 --- a/crates/horizon-protocol/Cargo.toml +++ b/crates/horizon-protocol/Cargo.toml @@ -16,6 +16,9 @@ getrandom = "0.3" sha1 = "0.10" # Secure chat: SHA256withRSA message signatures. sha2 = "0.10" +# Minecraft SRV redirects, using the system DNS configuration. +hickory-resolver = "0.25.2" +tokio = { version = "1", features = ["rt", "time"] } # Its own name, not `probe`: Cargo copies every crate's examples into one target//examples. [[example]] diff --git a/crates/horizon-protocol/src/connection.rs b/crates/horizon-protocol/src/connection.rs index 8f7ae28cc..7cd7083dd 100644 --- a/crates/horizon-protocol/src/connection.rs +++ b/crates/horizon-protocol/src/connection.rs @@ -191,6 +191,19 @@ impl Connection { .to_socket_addrs() .map_err(|e| Error::new(format!("Unknown host {host}: {e}")))? .collect(); + Self::connect_addresses(host, addrs, timeout) + } + /// Minecraft's SRV redirect applies to the socket destination only. Callers + /// keep the player's original host and port in the protocol handshake. + pub fn connect_server(host: &str, port: u16, timeout: Duration) -> Result { + let addrs = crate::resolver::resolve(host, port, timeout)?; + Self::connect_addresses(host, addrs, timeout) + } + fn connect_addresses( + host: &str, + addrs: Vec, + timeout: Duration, + ) -> Result { let mut last = Error::new(format!("Unknown host {host}")); for addr in addrs { match TcpStream::connect_timeout(&addr, timeout) { diff --git a/crates/horizon-protocol/src/lib.rs b/crates/horizon-protocol/src/lib.rs index 855df6a5a..f0bea2ca2 100644 --- a/crates/horizon-protocol/src/lib.rs +++ b/crates/horizon-protocol/src/lib.rs @@ -12,6 +12,7 @@ pub mod ids; pub mod item; pub mod packets; pub mod registry; +mod resolver; pub mod rsa; pub mod secure_chat; pub mod servers; diff --git a/crates/horizon-protocol/src/resolver.rs b/crates/horizon-protocol/src/resolver.rs new file mode 100644 index 000000000..3a76578ec --- /dev/null +++ b/crates/horizon-protocol/src/resolver.rs @@ -0,0 +1,166 @@ +//! Minecraft server DNS redirects (`ServerRedirectHandler` / `ServerNameResolver`). +//! Only the default port uses SRV; no record or a failed query leaves the +//! original address in use. The protocol handshake still uses that address. +use crate::{Error, Result}; +use std::{ + net::{IpAddr, SocketAddr, ToSocketAddrs}, + time::Duration, +}; + +pub(crate) fn resolve(host: &str, port: u16, timeout: Duration) -> Result> { + resolve_with( + host, + port, + |name| srv_redirect(name, timeout), + |host, port| { + (host, port) + .to_socket_addrs() + .map(|addrs| addrs.collect()) + .map_err(|e| Error::new(format!("Unknown host {host}: {e}"))) + }, + ) +} + +fn resolve_with( + host: &str, + port: u16, + mut srv: impl FnMut(&str) -> Option<(String, u16)>, + mut addresses: impl FnMut(&str, u16) -> Result>, +) -> Result> { + if port == 25565 + && host.parse::().is_err() + && host != "localhost" + && let Some((target, target_port)) = + srv(&format!("_minecraft._tcp.{}.", host.trim_end_matches('.'))) + { + // Do not follow another SRV record at the target. Vanilla resolves its + // addresses directly, and does not fall back if the target is unknown. + return addresses(&target, target_port); + } + addresses(host, port) +} + +fn srv_redirect(name: &str, timeout: Duration) -> Option<(String, u16)> { + // Runs only on the blocking ping/login worker, never the render thread. + // Use the system's configured resolvers, not a public fallback. + let runtime = tokio::runtime::Builder::new_current_thread() + .enable_all() + .build() + .ok()?; + runtime.block_on(async { + let mut builder = hickory_resolver::TokioResolver::builder_tokio().ok()?; + builder.options_mut().attempts = 1; + builder.options_mut().timeout = timeout; + let resolver = builder.build(); + let records = tokio::time::timeout(timeout, resolver.srv_lookup(name)) + .await + .ok()? + .ok()?; + // ServerRedirectHandler uses the first record, not weighted balancing. + let record = records.iter().next()?; + Some((record.target().to_utf8(), record.port())) + }) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn redirects_default_port_even_when_the_original_host_has_no_addresses() { + let result = resolve_with( + "play.example.org", + 25565, + |name| { + assert_eq!(name, "_minecraft._tcp.play.example.org."); + Some(("backend.example.org.".into(), 25570)) + }, + |host, port| { + assert_eq!((host, port), ("backend.example.org.", 25570)); + Ok(vec!["127.0.0.1:25570".parse().unwrap()]) + }, + ) + .unwrap(); + assert_eq!( + result, + vec!["127.0.0.1:25570".parse::().unwrap()] + ); + } + + #[test] + fn no_record_or_lookup_failure_keeps_the_original_address() { + resolve_with( + "play.example.org", + 25565, + |_| None, + |host, port| { + assert_eq!((host, port), ("play.example.org", 25565)); + Ok(vec![]) + }, + ) + .unwrap(); + } + + #[test] + fn explicit_nondefault_ports_and_ip_literals_do_not_query_srv() { + for (host, port) in [ + ("play.example.org", 25570), + ("127.0.0.1", 25565), + ("::1", 25565), + ("localhost", 25565), + ] { + resolve_with( + host, + port, + |_| panic!("unexpected SRV query"), + |actual, actual_port| { + assert_eq!((actual, actual_port), (host, port)); + Ok(vec![]) + }, + ) + .unwrap(); + } + } + + #[test] + fn fully_qualified_host_does_not_get_a_second_trailing_dot() { + resolve_with( + "play.example.org.", + 25565, + |name| { + assert_eq!(name, "_minecraft._tcp.play.example.org."); + None + }, + |_, _| Ok(vec![]), + ) + .unwrap(); + } + + #[test] + fn unknown_redirect_target_does_not_fall_back_to_the_original() { + let result = resolve_with( + "play.example.org", + 25565, + |_| Some(("missing.example.org.".into(), 25570)), + |host, _| { + assert_eq!(host, "missing.example.org."); + Err(Error::new("unknown redirected host")) + }, + ); + assert_eq!(result.unwrap_err().to_string(), "unknown redirected host"); + } + + #[test] + fn literal_address_can_connect_without_dns() { + let listener = std::net::TcpListener::bind("127.0.0.1:0").unwrap(); + let address = listener.local_addr().unwrap(); + let connection = crate::connection::Connection::connect_server( + "127.0.0.1", + address.port(), + Duration::from_secs(1), + ) + .unwrap(); + let (accepted, _) = listener.accept().unwrap(); + drop((connection, accepted)); + } +} From 9223b401e7bb8864711e1f05c891b9d3187bbadb Mon Sep 17 00:00:00 2001 From: some-du6e <103129948+some-du6e@users.noreply.github.com> Date: Sat, 24 Oct 2026 12:20:45 -0600 Subject: [PATCH 007/169] Decode every item data component a server sends Horizon decoded 25 of 26.3's 122 data component types. Item data has no length prefix, so a stack with any other component (an armour trim, banner patterns, pot sherds, a stew's effects, a plugin's item) made the whole packet undecodable and it was dropped: on a Paper server the inventory arrived empty until each slot was clicked, the advancements screen said "There doesn't seem to be anything here..." and the recipe book was empty. Every other component is now read to its end with its vanilla StreamCodec (item/skip.rs) and kept as its bytes, written back as they came; components without a network codec go as their NBT. The client leaves them out of the item's components, so the item keeps its prototype's values for them. tools/test_item_wire_parity.py checks it against vanilla: the oracle encodes 374 stacks with ItemStack.OPTIONAL_STREAM_CODEC (every default component value of every item, SNBT fixtures for the rest, direct holders and removals built in Java), covering all 122 component types, and the Rust probe must consume every byte, find the same component ids and encode the read-past ones back to the same bytes. Co-Authored-By: Claude Opus 5.5 --- crates/horizon-client/src/game/remote.rs | 2 + crates/horizon-protocol/Cargo.toml | 4 + .../examples/item_wire_probe.rs | 64 +++ crates/horizon-protocol/src/item.rs | 45 +- crates/horizon-protocol/src/item/skip.rs | 427 ++++++++++++++++++ .../parity/VanillaItemWireOracle.java | 155 +++++++ tools/test_item_wire_parity.py | 177 ++++++++ 7 files changed, 871 insertions(+), 3 deletions(-) create mode 100644 crates/horizon-protocol/examples/item_wire_probe.rs create mode 100644 crates/horizon-protocol/src/item/skip.rs create mode 100644 mods/horizon/src/test/java/dev/horizonlab/parity/VanillaItemWireOracle.java create mode 100755 tools/test_item_wire_parity.py diff --git a/crates/horizon-client/src/game/remote.rs b/crates/horizon-client/src/game/remote.rs index da0def0fb..0e6127178 100644 --- a/crates/horizon-client/src/game/remote.rs +++ b/crates/horizon-client/src/game/remote.rs @@ -596,6 +596,8 @@ impl Game<'_> { continue; }; let value = match c { + // Read past, not decoded: the item keeps its prototype's value. + Component::Raw(_) => continue, Component::Int(v) if *kind == component::RARITY => { let rarity = ["common", "uncommon", "rare", "epic"]; Tag::String(rarity.get(*v as usize).copied().unwrap_or("common").into()) diff --git a/crates/horizon-protocol/Cargo.toml b/crates/horizon-protocol/Cargo.toml index 71b93a1fe..6467ed849 100644 --- a/crates/horizon-protocol/Cargo.toml +++ b/crates/horizon-protocol/Cargo.toml @@ -22,5 +22,9 @@ sha2 = "0.10" name = "protocol_probe" path = "examples/probe.rs" +[[example]] +name = "item_wire_probe" +path = "examples/item_wire_probe.rs" + [lints] workspace = true diff --git a/crates/horizon-protocol/examples/item_wire_probe.rs b/crates/horizon-protocol/examples/item_wire_probe.rs new file mode 100644 index 000000000..19760ca1a --- /dev/null +++ b/crates/horizon-protocol/examples/item_wire_probe.rs @@ -0,0 +1,64 @@ +//! The item wire harness's Rust side (tools/test_item_wire_parity.py): reads +//! the oracle's stacks (JSON lines with `label` and `hex`), decodes each with +//! `item::Slot` and prints, per stack, whether every byte was consumed, the +//! patch's component ids (added, then removed), which of them Horizon +//! decoded into its own types (the rest it reads past, keeping their bytes) +//! and whether encoding the decoded stack gives the same bytes back. +//! +//! cargo run -p horizon-protocol --example item_wire_probe -- vanilla.jsonl rust.jsonl +use horizon_protocol::{ + buf::{Codec, Reader, Writer}, + item::{Component, Slot}, +}; +use serde_json::{Value, json}; +use std::io::Write; + +fn hex(s: &str) -> Option> { + (0..s.len()) + .step_by(2) + .map(|i| u8::from_str_radix(s.get(i..i + 2)?, 16).ok()) + .collect() +} + +fn main() -> Result<(), Box> { + let args: Vec = std::env::args().collect(); + let input = std::fs::read_to_string(args.get(1).ok_or("usage: item_wire_probe IN OUT")?)?; + let mut out = std::io::BufWriter::new(std::fs::File::create( + args.get(2).ok_or("usage: item_wire_probe IN OUT")?, + )?); + for line in input.lines().filter(|l| !l.trim().is_empty()) { + let v: Value = serde_json::from_str(line)?; + let label = v["label"].clone(); + let Some(bytes) = v["hex"].as_str().and_then(hex) else { + continue; + }; + let mut r = Reader::new(&bytes); + let result = match Slot::read(&mut r) { + Err(e) => json!({"label": label, "error": e.to_string()}), + Ok(stack) => { + let mut w = Writer::new(); + Slot::write(&stack, &mut w); + let (added, removed): (Vec, Vec) = + stack.as_ref().map_or_else(Default::default, |s| { + (s.added.iter().map(|(k, _)| *k).collect(), s.removed.clone()) + }); + let typed: Vec = stack + .iter() + .flat_map(|s| &s.added) + .filter(|(_, c)| !matches!(c, Component::Raw(_))) + .map(|(k, _)| *k) + .collect(); + json!({ + "label": label, + "left": r.remaining(), + "added": added, + "removed": removed, + "typed": typed, + "same_bytes": w.data == bytes, + }) + } + }; + writeln!(out, "{result}")?; + } + Ok(()) +} diff --git a/crates/horizon-protocol/src/item.rs b/crates/horizon-protocol/src/item.rs index 650fa4baa..0aa940a38 100644 --- a/crates/horizon-protocol/src/item.rs +++ b/crates/horizon-protocol/src/item.rs @@ -2,11 +2,13 @@ //! item's registry id and a data component patch, plus the hashed form the //! client sends back in container clicks (HashedStack). use crate::{ - Error, Result, + Result, buf::{Codec, Reader, Writer}, }; use horizon_world::nbt::Tag; +mod skip; + /// minecraft:data_component_type registry ids (26.3). pub mod component { pub const CUSTOM_DATA: i32 = 0; @@ -78,6 +80,9 @@ pub enum Component { WrittenBook(WrittenBook), /// `ChargedProjectiles`: a loaded crossbow's ammunition, as templates. Stacks(Vec), + /// A component Horizon reads past without interpreting it: its encoded + /// bytes, written back as they came. + Raw(Vec), } /// `Filterable.streamCodec`: the raw value, then an optional filtered one @@ -224,11 +229,16 @@ impl Component { hidden: (0..n).map(|_| r.varint()).collect::>()?, } } - other => return Err(Error::new(format!("unsupported item component {other}"))), + other => { + let start = r.position(); + skip::component(other, r)?; + Self::Raw(r.since(start).to_vec()) + } }) } fn write(&self, kind: i32, w: &mut Writer) { match self { + Self::Raw(bytes) => w.bytes(bytes), Self::Int(v) if kind == component::DYED_COLOR => w.i32(*v), Self::Int(v) => w.varint(*v), Self::Unit => {} @@ -582,7 +592,8 @@ mod tests { #[test] fn unknown_components_are_errors() { - let bytes = [1, 5, 1, 0, 99]; + // 122 is past DataComponents' last id (cushion_color, 121). + let bytes = [1, 5, 1, 0, 122]; assert!(Slot::read(&mut Reader::new(&bytes)).is_err()); } @@ -631,4 +642,32 @@ mod tests { [("textures".to_owned(), "x".to_owned(), None)] ); } + + #[test] + fn components_read_past_keep_their_bytes() { + // Vanilla 26.3's encoding (tools/test_item_wire_parity.py) of a chestplate's + // armour trim, a banner's patterns (one direct), a pot's sherds and a stew's + // effects: one server's inventory, recipe book and advancements had them. + for (hex, kind) in [ + ("01bd0801003a0502", 58), + ("01890b01004a02200e000b6d696e6563726166743a7801790b", 74), + ("01880301004c01f60801000001be0c0100000001d30c010000", 76), + ("01a408010037020f6412a001", 55), + ] { + let bytes: Vec = (0..hex.len()) + .step_by(2) + .map(|i| u8::from_str_radix(&hex[i..i + 2], 16).unwrap()) + .collect(); + let mut r = Reader::new(&bytes); + let stack = Slot::read(&mut r).unwrap(); + assert_eq!(r.remaining(), 0, "component {kind}"); + assert!(matches!( + stack.as_ref().and_then(|s| s.component(kind)), + Some(Component::Raw(_)) + )); + let mut w = Writer::new(); + Slot::write(&stack, &mut w); + assert_eq!(w.data, bytes, "component {kind}"); + } + } } diff --git a/crates/horizon-protocol/src/item/skip.rs b/crates/horizon-protocol/src/item/skip.rs new file mode 100644 index 000000000..152d0f0f1 --- /dev/null +++ b/crates/horizon-protocol/src/item/skip.rs @@ -0,0 +1,427 @@ +//! Reading past the data components Horizon doesn't interpret: each +//! function consumes exactly what its vanilla StreamCodec writes +//! (DataComponents' `networkSynchronized` codecs; a component without one +//! goes as its persistent Codec's NBT, `ByteBufCodecs.fromCodecWithRegistries`). +//! Item data has no length prefix, so a component read short or long makes +//! everything after it unreadable. +use super::{Component, Template}; +use crate::{ + Error, Result, + buf::{Codec, Reader}, +}; + +type Read = fn(&mut Reader) -> Result<()>; + +/// DataComponents' registry order (26.3) for the ids `Component::read` +/// doesn't decode itself. +pub(super) fn component(kind: i32, r: &mut Reader) -> Result<()> { + match kind { + // Unit.STREAM_CODEC: glider, waxed. + 34 | 120 => Ok(()), + // Components without a network codec go as their NBT: intangible_projectile, + // map_decorations, debug_stick_state, recipes, lock, container_loot. + 22 | 49 | 59 | 68 | 81 | 82 => nbt(r), + // A VarInt (VAR_INT, an idMapper, a registry or holderRegistry id): damage_type, + // enchantable, additional_trade_cost, block_transformer, villager_food, dye, + // ominous_bottle_amplifier, base_color, the mob variants and colours, the pottery + // pattern and cushion_color. + 8 | 31 | 42 | 43 | 44 | 46 | 65 | 75 | 88..=108 | 110..=117 | 121 => varint(r), + // FLOAT: minimum_attack_charge, potion_duration_scale. + 7 | 54 => f32(r), + // Identifier.STREAM_CODEC: tooltip_style, note_block_sound. + 35 | 73 => ident(r), + // UseEffects: canSprint, interactVibrations, speedMultiplier. + 5 => { + r.bool()?; + r.bool()?; + f32(r) + } + // AdventureModePredicate: can_place_on, can_break. + 14 | 15 => list(r, block_predicate), + 16 => list(r, attribute_modifier), + // FoodProperties.DIRECT_STREAM_CODEC: nutrition, saturation, canAlwaysEat. + 23 => { + varint(r)?; + f32(r)?; + boolean(r) + } + // Consumable: consumeSeconds, animation, sound, hasConsumeParticles, onConsumeEffects. + 24 => { + f32(r)?; + varint(r)?; + sound(r)?; + boolean(r)?; + list(r, consume_effect) + } + // UseRemainder, SulfurCubeContent: one template. + 25 | 80 => template(r), + // UseCooldown: seconds, cooldownGroup. + 26 => { + f32(r)?; + optional(r, ident) + } + // DamageResistant, Repairable, provides_banner_patterns: a holder set. + 27 | 33 | 67 => holder_set(r), + 28 => tool(r), + // Weapon: itemDamagePerAttack, disableBlockingForSeconds. + 29 => { + varint(r)?; + f32(r) + } + 32 => equippable(r), + // DeathProtection: deathEffects. + 36 => list(r, consume_effect), + 37 => blocks_attacks(r), + // PiercingWeapon: dealsKnockback, dismounts, sound, hitSound. + 38 => { + boolean(r)?; + boolean(r)?; + optional(r, sound)?; + optional(r, sound) + } + 39 => kinetic_weapon(r), + // SwingAnimation: type, duration. + 40 | 41 => { + varint(r)?; + varint(r) + } + // BundleContents: templates. + 52 => list(r, template), + 53 => potion_contents(r), + // SuspiciousStewEffects: effect, duration. + 55 => list(r, |r| { + varint(r)?; + varint(r) + }), + // ArmorTrim: material, then Holder (assetId, description, decal). + 58 => { + trim_material(r)?; + holder(r, |r| { + ident(r)?; + nbt(r)?; + boolean(r) + }) + } + // TypedEntityData (entity_data, block_entity_data): the type id, then a compound. + 60 | 62 => { + varint(r)?; + nbt(r) + } + // CustomData: bucket_entity_data. + 61 => nbt(r), + // InstrumentComponent: Holder (soundEvent, useDuration, range, + // durabilityDamage, description). + 63 => holder(r, |r| { + sound(r)?; + f32(r)?; + f32(r)?; + varint(r)?; + nbt(r) + }), + 64 => trim_material(r), + // JukeboxPlayable: Holder (soundEvent, description, lengthInSeconds, + // comparatorOutput). + 66 => holder(r, |r| { + sound(r)?; + nbt(r)?; + f32(r)?; + varint(r) + }), + // LodestoneTracker: target (GlobalPos: dimension, BlockPos), tracked. + 69 => { + optional(r, |r| { + ident(r)?; + r.i64().map(drop) + })?; + boolean(r) + } + 70 => firework_explosion(r), + // Fireworks: flightDuration, explosions. + 71 => { + varint(r)?; + list(r, firework_explosion) + } + // BannerPatternLayers: Holder (assetId, translationKey), colour. + 74 => list(r, |r| { + holder(r, |r| { + ident(r)?; + string(r) + })?; + varint(r) + }), + // PotDecorations: back, left, right, front. + 76 => (0..4).try_for_each(|_| optional(r, template)), + // ItemContainerContents: optional templates. + 77 => list(r, |r| optional(r, template)), + // BlockItemStateProperties: a string to string map. + 78 => list(r, |r| { + string(r)?; + string(r) + }), + // Bees: Occupant (entity type and data, ticksInHive, minTicksInHive). + 79 => list(r, |r| { + varint(r)?; + nbt(r)?; + varint(r)?; + varint(r) + }), + 83 => sound(r), + // Compostable: layers. + 84 => resolvable(r, i32), + // CookingFuel (burnTime, speedMultiplier), BrewingFuel (uses, speedMultiplier). + 85 | 86 => { + resolvable(r, i32)?; + resolvable(r, f32) + } + // MobVisibility: targetingEntityTypes, visibility. + 87 => { + holder_set(r)?; + f32(r) + } + // Holder: width, height, assetId, title, author. + 109 => holder(r, |r| { + varint(r)?; + varint(r)?; + ident(r)?; + optional(r, nbt)?; + optional(r, nbt) + }), + // SignText: four messages, four optional filtered ones, colour, hasGlowingText. + 118 | 119 => { + (0..4).try_for_each(|_| nbt(r))?; + optional(r, |r| (0..4).try_for_each(|_| nbt(r)))?; + varint(r)?; + boolean(r) + } + other => Err(Error::new(format!("unsupported item component {other}"))), + } +} + +fn boolean(r: &mut Reader) -> Result<()> { + r.bool().map(drop) +} +fn varint(r: &mut Reader) -> Result<()> { + r.varint().map(drop) +} +fn f32(r: &mut Reader) -> Result<()> { + r.f32().map(drop) +} +fn i32(r: &mut Reader) -> Result<()> { + r.i32().map(drop) +} +/// ByteBufCodecs.STRING_UTF8. +fn string(r: &mut Reader) -> Result<()> { + r.string(32767).map(drop) +} +/// Identifier.STREAM_CODEC, ResourceKey.streamCodec. +fn ident(r: &mut Reader) -> Result<()> { + string(r) +} +/// A text component or compound (fromCodecWithRegistries, COMPOUND_TAG). +fn nbt(r: &mut Reader) -> Result<()> { + r.nbt().map(drop) +} +fn template(r: &mut Reader) -> Result<()> { + Template::read(r).map(drop) +} +/// ByteBufCodecs.optional: a flag, then the value. +fn optional(r: &mut Reader, value: Read) -> Result<()> { + if r.bool()? { value(r) } else { Ok(()) } +} +/// ByteBufCodecs.list and map: a VarInt count, then the elements (a map's +/// key and value each). Every element is at least a byte, so the count +/// can't pass what is left. +fn list(r: &mut Reader, element: Read) -> Result<()> { + let n = r.count(r.remaining())?; + (0..n).try_for_each(|_| element(r)) +} +/// ByteBufCodecs.holder: 0 and the value itself, or the registry id plus one. +fn holder(r: &mut Reader, direct: Read) -> Result<()> { + if r.varint()? == 0 { direct(r) } else { Ok(()) } +} +/// ByteBufCodecs.holderSet: 0 and a tag id, or the size plus one and the ids. +fn holder_set(r: &mut Reader) -> Result<()> { + match r.varint()? { + 0 => ident(r), + n => { + let n = usize::try_from(n - 1).map_err(|_| Error::new("negative holder set size"))?; + if n > r.remaining() { + return Err(Error::new("holder set past the end")); + } + (0..n).try_for_each(|_| varint(r)) + } + } +} +/// SoundEvent.STREAM_CODEC: a holder of a location and an optional fixed range. +fn sound(r: &mut Reader) -> Result<()> { + holder(r, |r| { + ident(r)?; + optional(r, f32) + }) +} +/// ResolvableInt, ResolvableFloat: Either a constant (true) or a context provider's key. +fn resolvable(r: &mut Reader, constant: Read) -> Result<()> { + if r.bool()? { constant(r) } else { ident(r) } +} +/// TrimMaterial.STREAM_CODEC: a holder of a palette id and a description. +fn trim_material(r: &mut Reader) -> Result<()> { + holder(r, |r| { + ident(r)?; + nbt(r) + }) +} +/// MobEffectInstance: the effect id, then its Details. +fn mob_effect(r: &mut Reader) -> Result<()> { + varint(r)?; + effect_details(r) +} +/// MobEffectInstance.Details: amplifier, duration, ambient, showParticles, showIcon, then the +/// hidden effect's Details, recursively. +fn effect_details(r: &mut Reader) -> Result<()> { + varint(r)?; + varint(r)?; + boolean(r)?; + boolean(r)?; + boolean(r)?; + optional(r, effect_details) +} +/// ConsumeEffect.STREAM_CODEC: the consume_effect_type id, then that type's fields. +fn consume_effect(r: &mut Reader) -> Result<()> { + match r.varint()? { + // apply_effects: effects, probability. + 0 => { + list(r, mob_effect)?; + f32(r) + } + // remove_effects: a mob effect holder set. + 1 => holder_set(r), + // clear_all_effects. + 2 => Ok(()), + // teleport_randomly: diameter, directionalParticles. + 3 => { + f32(r)?; + boolean(r) + } + // play_sound. + 4 => sound(r), + other => Err(Error::new(format!("unknown consume effect type {other}"))), + } +} +/// BlockPredicate: blocks, properties, nbt, then DataComponentMatchers (exact, partial). +fn block_predicate(r: &mut Reader) -> Result<()> { + optional(r, holder_set)?; + // StatePropertiesPredicate: PropertyMatchers, each a name and an + // Either. + optional(r, |r| { + list(r, |r| { + string(r)?; + if r.bool()? { + string(r) + } else { + optional(r, string)?; + optional(r, string) + } + }) + })?; + optional(r, nbt)?; + // DataComponentExactPredicate: TypedDataComponents, a component type id and its value. + list(r, |r| { + let kind = r.varint()?; + Component::read(kind, r).map(drop) + })?; + // DataComponentPredicate.STREAM_CODEC: an Either of a predicate type id or a component + // type id, then the predicate as NBT (fromCodecWithRegistries). + list(r, |r| { + boolean(r)?; + varint(r)?; + nbt(r) + }) +} +/// ItemAttributeModifiers.Entry: attribute, modifier (id, amount, operation), slot, display. +fn attribute_modifier(r: &mut Reader) -> Result<()> { + varint(r)?; + ident(r)?; + r.f64()?; + varint(r)?; + varint(r)?; + // Display.Type: default, hidden, or override and its text. + match r.varint()? { + 0 | 1 => Ok(()), + 2 => nbt(r), + other => Err(Error::new(format!( + "unknown attribute modifier display {other}" + ))), + } +} +/// Tool: rules (blocks, speed, correctForDrops), defaultMiningSpeed, damagePerBlock, +/// canDestroyBlocksInCreative. +fn tool(r: &mut Reader) -> Result<()> { + list(r, |r| { + holder_set(r)?; + optional(r, f32)?; + optional(r, boolean) + })?; + f32(r)?; + varint(r)?; + boolean(r) +} +/// Equippable: slot, equipSound, assetId, cameraOverlay, allowedEntities, dispensable, +/// swappable, damageOnHurt, equipOnInteract, canBeSheared, shearingSound. +fn equippable(r: &mut Reader) -> Result<()> { + varint(r)?; + sound(r)?; + optional(r, ident)?; + optional(r, ident)?; + optional(r, holder_set)?; + (0..5).try_for_each(|_| boolean(r))?; + sound(r) +} +/// BlocksAttacks: blockDelaySeconds, disableCooldownScale, damageReductions (angle, type, +/// base, factor), itemDamage (threshold, base, factor), bypassedBy, blockSound, disableSound. +fn blocks_attacks(r: &mut Reader) -> Result<()> { + f32(r)?; + f32(r)?; + list(r, |r| { + f32(r)?; + optional(r, holder_set)?; + f32(r)?; + f32(r) + })?; + (0..3).try_for_each(|_| f32(r))?; + optional(r, holder_set)?; + optional(r, sound)?; + optional(r, sound) +} +/// KineticWeapon: contactCooldownTicks, delayTicks, the dismount, knockback and damage +/// conditions (maxDurationTicks, minSpeed, minRelativeSpeed), forwardMovement, +/// damageMultiplier, sound, hitSound. +fn kinetic_weapon(r: &mut Reader) -> Result<()> { + varint(r)?; + varint(r)?; + (0..3).try_for_each(|_| { + optional(r, |r| { + varint(r)?; + f32(r)?; + f32(r) + }) + })?; + f32(r)?; + f32(r)?; + optional(r, sound)?; + optional(r, sound) +} +/// PotionContents: potion, customColor, customEffects, customName. +fn potion_contents(r: &mut Reader) -> Result<()> { + optional(r, varint)?; + optional(r, i32)?; + list(r, mob_effect)?; + optional(r, string) +} +/// FireworkExplosion: shape, colors, fadeColors, hasTrail, hasTwinkle. +fn firework_explosion(r: &mut Reader) -> Result<()> { + varint(r)?; + list(r, i32)?; + list(r, i32)?; + boolean(r)?; + boolean(r) +} diff --git a/mods/horizon/src/test/java/dev/horizonlab/parity/VanillaItemWireOracle.java b/mods/horizon/src/test/java/dev/horizonlab/parity/VanillaItemWireOracle.java new file mode 100644 index 000000000..cc95bb311 --- /dev/null +++ b/mods/horizon/src/test/java/dev/horizonlab/parity/VanillaItemWireOracle.java @@ -0,0 +1,155 @@ +package dev.horizonlab.parity; + +import io.netty.buffer.Unpooled; +import it.unimi.dsi.fastutil.objects.Reference2ObjectMap; +import it.unimi.dsi.fastutil.objects.Reference2ObjectMaps; +import java.io.PrintWriter; +import java.lang.reflect.Field; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.HashSet; +import java.util.HexFormat; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.Optional; +import net.minecraft.core.Holder; +import net.minecraft.core.component.DataComponentPatch; +import net.minecraft.core.component.DataComponentType; +import net.minecraft.core.component.DataComponents; +import net.minecraft.core.component.TypedDataComponent; +import net.minecraft.core.registries.BuiltInRegistries; +import net.minecraft.network.RegistryFriendlyByteBuf; +import net.minecraft.network.chat.Component; +import net.minecraft.resources.Identifier; +import net.minecraft.sounds.SoundEvents; +import net.minecraft.world.entity.decoration.painting.PaintingVariant; +import net.minecraft.world.item.JukeboxPlayable; +import net.minecraft.world.item.JukeboxSong; +import net.minecraft.world.item.component.MapPostProcessing; +import net.minecraft.util.Unit; +import net.minecraft.world.item.ItemStack; +import net.minecraft.world.item.Items; + +/** + * Item stacks as a server sends them (ItemStack.OPTIONAL_STREAM_CODEC), for + * every data component: each default component value of every vanilla item + * set on a stick (so it is in the patch), the SNBT fixtures given in a file + * (one `labelstack SNBT` per line), and a few patches built directly. + * Prints one JSON line per stack: its label, the encoded bytes in hex and the + * patch's component type ids in encoding order (added, then removed), or + * the error. + */ +public final class VanillaItemWireOracle { + private static final int PER_TYPE = 12; + + public static void main(String[] args) throws Exception { + ParityData.init(); + List fixtures = new ArrayList<>(); + for (String line : Files.readAllLines(Path.of(args[0]))) { + if (line.isBlank() || line.startsWith("#")) continue; + fixtures.add(line.split("\t", 2)); + } + try (PrintWriter out = new PrintWriter(Files.newBufferedWriter(Path.of(args[1])))) { + // Each distinct default value, once per component type and + // encoding, and at most PER_TYPE of them for one type. + Set seen = new HashSet<>(); + Map, Integer> perType = new HashMap<>(); + for (var item : BuiltInRegistries.ITEM) { + for (TypedDataComponent c : item.components()) { + ItemStack stack = new ItemStack(Items.STICK); + if (!set(stack, c)) continue; + String hex = encode(stack); + if (hex == null || perType.getOrDefault(c.type(), 0) >= PER_TYPE) continue; + if (!seen.add(BuiltInRegistries.DATA_COMPONENT_TYPE.getKey(c.type()) + hex)) continue; + perType.merge(c.type(), 1, Integer::sum); + print(out, "default " + BuiltInRegistries.ITEM.getKey(item) + " " + BuiltInRegistries.DATA_COMPONENT_TYPE.getKey(c.type()), stack); + } + } + for (String[] f : fixtures) { + try { + print(out, f[0], ParityData.stack(f[1])); + } catch (Exception e) { + out.println("{\"label\":" + json(f[0]) + ",\"error\":" + json(String.valueOf(e)) + "}"); + } + } + // Components without a persistent codec, direct holders item SNBT + // can't name, and removals. + ItemStack direct = new ItemStack(Items.STICK); + direct.set(DataComponents.ADDITIONAL_TRADE_COST, 4); + direct.set(DataComponents.MAP_POST_PROCESSING, MapPostProcessing.SCALE); + direct.set(DataComponents.JUKEBOX_PLAYABLE, new JukeboxPlayable(Holder.direct( + new JukeboxSong(SoundEvents.ARMOR_EQUIP_CHAIN, Component.literal("S"), 10f, 3)))); + direct.set(DataComponents.PAINTING_VARIANT, Holder.direct(new PaintingVariant( + 2, 1, Identifier.withDefaultNamespace("kebab"), Optional.of(Component.literal("T")), Optional.empty()))); + print(out, "non-persistent and direct", direct); + ItemStack locked = new ItemStack(Items.STONE); + locked.set(DataComponents.CREATIVE_SLOT_LOCK, Unit.INSTANCE); + print(out, "creative_slot_lock", locked); + ItemStack removed = new ItemStack(Items.APPLE, 3); + removed.remove(DataComponents.FOOD); + removed.remove(DataComponents.CONSUMABLE); + removed.set(DataComponents.DAMAGE, 4); + print(out, "removed food and consumable", removed); + print(out, "empty", ItemStack.EMPTY); + } + } + + @SuppressWarnings("unchecked") + private static boolean set(ItemStack stack, TypedDataComponent c) { + if (stack.getPrototype().has(c.type()) && java.util.Objects.equals(stack.getPrototype().get(c.type()), c.value())) return false; + stack.set((DataComponentType) c.type(), c.value()); + return true; + } + + private static String encode(ItemStack stack) { + var buf = new RegistryFriendlyByteBuf(Unpooled.buffer(), ParityData.access); + try { + ItemStack.OPTIONAL_STREAM_CODEC.encode(buf, stack); + } catch (RuntimeException e) { + return null; + } + byte[] bytes = new byte[buf.readableBytes()]; + buf.readBytes(bytes); + return HexFormat.of().formatHex(bytes); + } + + private static void print(PrintWriter out, String label, ItemStack stack) { + String hex = encode(stack); + if (hex == null) { + out.println("{\"label\":" + json(label) + ",\"error\":\"encode failed\"}"); + return; + } + // DataComponentPatch's encoding order: its map's fast iteration, added + // components, then removals. + StringBuilder kinds = new StringBuilder(); + StringBuilder removed = new StringBuilder(); + for (var e : Reference2ObjectMaps.fastIterable(patchMap(stack.getComponentsPatch()))) { + // Removed (package-private) marks a removal. + StringBuilder to = e.getValue().getClass().getName().equals("net.minecraft.core.component.Removed") ? removed : kinds; + to.append(to.isEmpty() ? "" : ",").append(id(e.getKey())); + } + out.println("{\"label\":" + json(label) + ",\"hex\":\"" + hex + "\",\"added\":[" + kinds + "],\"removed\":[" + removed + "]}"); + } + + @SuppressWarnings("unchecked") + private static Reference2ObjectMap, Object> patchMap(DataComponentPatch patch) { + try { + Field map = DataComponentPatch.class.getDeclaredField("map"); + map.setAccessible(true); + return (Reference2ObjectMap, Object>) map.get(patch); + } catch (ReflectiveOperationException e) { + throw new IllegalStateException(e); + } + } + + private static int id(DataComponentType type) { + return BuiltInRegistries.DATA_COMPONENT_TYPE.getId(type); + } + + private static String json(String s) { + return "\"" + s.replace("\\", "\\\\").replace("\"", "\\\"").replace("\n", "\\n") + "\""; + } +} diff --git a/tools/test_item_wire_parity.py b/tools/test_item_wire_parity.py new file mode 100755 index 000000000..1be6042ec --- /dev/null +++ b/tools/test_item_wire_parity.py @@ -0,0 +1,177 @@ +#!/usr/bin/env python3 +"""Item stacks on the wire: every data component, as vanilla 26.3 encodes it. + +VanillaItemWireOracle encodes stacks with ItemStack.OPTIONAL_STREAM_CODEC +(what a server sends in inventories, recipe books and advancements): each +default component value of every vanilla item, the SNBT fixtures below +(direct holders, tags and lists, optional fields, every consume effect, +block predicates with component matchers, the mob variants) and patches +built in Java (components without a persistent codec, removals). The Rust +probe decodes each with horizon_protocol::item::Slot and must consume every +byte and find the same component ids in the same order; a stack whose +components Horizon only reads past must also encode back to the same bytes. +Every id in DataComponents must be covered.""" +import argparse +import json +import os +import platform +import subprocess +from pathlib import Path +try: + from . import lab, test_rust_parity as base +except ImportError: + import lab + import test_rust_parity as base + +COMPONENT_TYPES = 122 + +FIXTURES = [ + ('custom_data', '{custom_data:{a:1,b:"x",c:[1,2]}}'), + ('unbreakable', '{unbreakable:{}}'), + ('custom_name', '{custom_name:{text:"Hi",color:"red",bold:1b}}'), + ('lore', '{lore:["a",{text:"b",italic:0b}]}'), + ('enchantments', '{enchantments:{"minecraft:sharpness":5,"minecraft:unbreaking":3}}'), + ('can_break tag', '{can_break:{blocks:"#minecraft:logs"}}'), + ('can_break list state nbt', '{can_break:[{blocks:["minecraft:stone","minecraft:dirt"],state:{snowy:"true",age:{min:"1",max:"3"},level:{min:"2"}},nbt:"{a:1b}"}]}'), + ('can_place_on components', '{can_place_on:{blocks:"minecraft:chest",components:{"minecraft:custom_name":"x","minecraft:damage":3},predicates:{"minecraft:custom_data":{a:1},"minecraft:damage":{durability:{min:1}}}}}'), + ('can_place_on empty', '{can_place_on:[{}]}'), + ('custom_model_data', '{custom_model_data:{floats:[1.0f,2.5f],flags:[1b,0b],strings:["a"],colors:[16711680]}}'), + ('tooltip_display', '{tooltip_display:{hide_tooltip:1b,hidden_components:["minecraft:enchantments","minecraft:damage"]}}'), + ('repair_cost', '{repair_cost:7}'), + ('intangible_projectile', '{intangible_projectile:{}}'), + ('tooltip_style', '{tooltip_style:"minecraft:fancy"}'), + ('interact_animation', '{interact_animation:{type:"stab",duration:9}}'), + ('dyed_color', '{dyed_color:16711935}'), + ('map_id', '{map_id:42}'), + ('written_book_content', '{written_book_content:{title:{raw:"T",filtered:"F"},author:"me",generation:1,pages:[{raw:"p1",filtered:"q1"},"p2"],resolved:1b}}'), + ('trim registry', '{trim:{material:"minecraft:gold",pattern:"minecraft:coast"}}'), + ('trim direct', '{trim:{material:{palette_id:"minecraft:x",description:"X"},pattern:{asset_id:"minecraft:y",description:"Y",decal:1b}}}'), + ('block_entity_data', '{block_entity_data:{id:"minecraft:chest",Items:[]}}'), + ('lodestone_tracker target', '{lodestone_tracker:{target:{dimension:"minecraft:the_nether",pos:[1,-64,3]},tracked:0b}}'), + ('lodestone_tracker empty', '{lodestone_tracker:{}}'), + ('firework_explosion', '{firework_explosion:{shape:"star",colors:[1,2],fade_colors:[3],has_trail:1b,has_twinkle:0b}}'), + ('profile name', '{profile:{name:"Notch"}}'), + ('profile full', '{profile:{name:"jeb_",id:[I;1,2,3,4],properties:[{name:"textures",value:"abc",signature:"sig"}]}}'), + ('note_block_sound', '{note_block_sound:"minecraft:block.note_block.bell"}'), + ('base_color', '{base_color:"lime"}'), + ('sulfur_cube_content', '{sulfur_cube_content:{id:"minecraft:stone",count:1}}'), + ('lock', '{lock:{items:"minecraft:diamond"}}'), + ('container_loot', '{container_loot:{loot_table:"minecraft:chests/simple_dungeon",seed:5L}}'), + ('waxed', '{waxed:{}}'), + ('banner_patterns', '{banner_patterns:[{pattern:"minecraft:stripe_bottom",color:"red"},{pattern:{asset_id:"minecraft:x",translation_key:"y"},color:"blue"}]}'), + ('pot_decorations', '{pot_decorations:{back:{id:"minecraft:brick"},left:{id:"minecraft:angler_pottery_sherd"},front:{id:"minecraft:skull_pottery_sherd",count:1}}}'), + ('suspicious_stew_effects', '{suspicious_stew_effects:[{id:"minecraft:night_vision",duration:100},{id:"minecraft:poison"}]}'), + ('potion_contents full', '{potion_contents:{potion:"minecraft:swiftness",custom_color:123,custom_effects:[{id:"minecraft:speed",amplifier:1b,duration:200,ambient:1b,show_particles:0b,show_icon:1b,hidden_effect:{id:"minecraft:speed",duration:100,hidden_effect:{id:"minecraft:speed",duration:50}}}],custom_name:"x"}}'), + ('potion_contents bare', '{potion_contents:{}}'), + ('container', '{container:[{slot:0,item:{id:"minecraft:stone",count:3}},{slot:5,item:{id:"minecraft:diamond_sword",components:{"minecraft:damage":5,"minecraft:trim":{material:"minecraft:gold",pattern:"minecraft:coast"}}}}]}'), + ('bundle_contents', '{bundle_contents:[{id:"minecraft:stone",count:2},{id:"minecraft:potion",components:{"minecraft:potion_contents":{potion:"minecraft:water"}}}]}'), + ('charged_projectiles', '{charged_projectiles:[{id:"minecraft:arrow"},{id:"minecraft:firework_rocket",components:{"minecraft:fireworks":{flight_duration:2b,explosions:[{shape:"burst",colors:[5]}]}}}]}'), + ('block_state', '{block_state:{facing:"north",half:"top"}}'), + ('bees', '{bees:[{entity_data:{id:"minecraft:bee",Health:5f},ticks_in_hive:5,min_ticks_in_hive:10}]}'), + ('entity_data', '{entity_data:{id:"minecraft:pig",NoAI:1b}}'), + ('bucket_entity_data', '{bucket_entity_data:{Health:5f}}'), + ('instrument direct', '{instrument:{sound_event:{sound_id:"minecraft:x",range:8f},use_duration:3f,range:64f,description:"Horn"}}'), + ('painting variant', '{"minecraft:painting/variant":"minecraft:kebab"}'), + ('sign_text_front', '{sign_text_front:{messages:["a","b","c","d"],filtered_messages:["e","f","g","h"],color:"red",has_glowing_text:1b}}'), + ('sign_text_back', '{sign_text_back:{messages:["a","","",""]}}'), + ('map_decorations', '{map_decorations:{a:{type:"minecraft:player",x:1.0d,z:2.0d,rotation:0f}}}'), + ('debug_stick_state', '{debug_stick_state:{"minecraft:oak_stairs":"facing"}}'), + ('recipes', '{recipes:["minecraft:stone_bricks"]}'), + ('attribute_modifiers', '{attribute_modifiers:[{type:"minecraft:attack_damage",id:"minecraft:x",amount:1.5d,operation:"add_value",slot:"mainhand",display:{type:"override",value:"hi"}},{type:"minecraft:armor",id:"minecraft:y",amount:2d,operation:"add_multiplied_total",display:{type:"hidden"}}]}'), + ('consumable all effects', '{consumable:{consume_seconds:2f,animation:"drink",sound:{sound_id:"minecraft:x",range:4f},has_consume_particles:0b,on_consume_effects:[{type:"apply_effects",effects:[{id:"minecraft:speed",duration:20}],probability:0.5f},{type:"remove_effects",effects:"minecraft:poison"},{type:"remove_effects",effects:["minecraft:poison","minecraft:wither"]},{type:"clear_all_effects"},{type:"teleport_randomly",diameter:8f},{type:"play_sound",sound:"minecraft:entity.generic.eat"}]}}'), + ('death_protection', '{death_protection:{death_effects:[{type:"clear_all_effects"}]}}'), + ('equippable full', '{equippable:{slot:"head",equip_sound:"minecraft:item.armor.equip_gold",asset_id:"minecraft:gold",camera_overlay:"minecraft:misc/pumpkinblur",allowed_entities:"#minecraft:skeletons",dispensable:0b,swappable:0b,damage_on_hurt:0b,equip_on_interact:1b,can_be_sheared:1b,shearing_sound:{sound_id:"minecraft:y"}}}'), + ('equippable bare', '{equippable:{slot:"chest"}}'), + ('tool rules', '{tool:{rules:[{blocks:"#minecraft:mineable/pickaxe",speed:4f,correct_for_drops:1b},{blocks:["minecraft:stone"]}],default_mining_speed:2f,damage_per_block:2,can_destroy_blocks_in_creative:0b}}'), + ('blocks_attacks full', '{blocks_attacks:{block_delay_seconds:0.5f,disable_cooldown_scale:2f,damage_reductions:[{horizontal_blocking_angle:45f,type:"#minecraft:is_fire",base:1f,factor:0.5f},{base:0f,factor:1f}],item_damage:{threshold:3f,base:1f,factor:2f},bypassed_by:"#minecraft:bypasses_shield",block_sound:"minecraft:item.shield.block",disable_sound:{sound_id:"minecraft:z"}}}'), + ('damage_resistant', '{damage_resistant:{types:"#minecraft:is_fire"}}'), + ('repairable list', '{repairable:{items:["minecraft:diamond","minecraft:emerald"]}}'), + ('use_cooldown group', '{use_cooldown:{seconds:1.5f,cooldown_group:"minecraft:x"}}'), + ('use_remainder', '{use_remainder:{id:"minecraft:bowl",count:2}}'), + ('fireworks', '{fireworks:{flight_duration:3b,explosions:[{shape:"creeper",colors:[1],fade_colors:[2,3],has_trail:1b},{shape:"small_ball"}]}}'), + ('provides_banner_patterns', '{provides_banner_patterns:"#minecraft:pattern_item/globe"}'), + ('wolf variant', '{"minecraft:wolf/variant":"minecraft:ashen","minecraft:wolf/sound_variant":"minecraft:angry","minecraft:wolf/collar":"red"}'), + ('fox salmon parrot', '{"minecraft:fox/variant":"snow","minecraft:salmon/size":"large","minecraft:parrot/variant":"blue"}'), + ('tropical fish', '{"minecraft:tropical_fish/pattern":"flopper","minecraft:tropical_fish/base_color":"white","minecraft:tropical_fish/pattern_color":"black"}'), + ('mooshroom rabbit', '{"minecraft:mooshroom/variant":"brown","minecraft:rabbit/variant":"gold"}'), + ('pig cow chicken', '{"minecraft:pig/variant":"minecraft:cold","minecraft:pig/sound_variant":"minecraft:big","minecraft:cow/variant":"minecraft:warm","minecraft:cow/sound_variant":"minecraft:classic","minecraft:chicken/variant":"minecraft:cold","minecraft:chicken/sound_variant":"minecraft:classic"}'), + ('nautilus frog horse', '{"minecraft:zombie_nautilus/variant":"minecraft:warm","minecraft:frog/variant":"minecraft:cold","minecraft:horse/variant":"chestnut"}'), + ('llama axolotl cat', '{"minecraft:llama/variant":"brown","minecraft:axolotl/variant":"blue","minecraft:cat/variant":"minecraft:tabby","minecraft:cat/sound_variant":"minecraft:classic","minecraft:cat/collar":"blue"}'), + ('sheep shulker villager', '{"minecraft:sheep/color":"pink","minecraft:shulker/color":"purple","minecraft:villager/variant":"minecraft:taiga"}'), + ('trim material direct provider', '{provides_trim_material:{palette_id:"minecraft:x",description:"X"}}'), + ('everything at once', '{damage:3,unbreakable:{},custom_name:"n",enchantments:{"minecraft:mending":1},trim:{material:"minecraft:gold",pattern:"minecraft:coast"},banner_patterns:[{pattern:"minecraft:globe",color:"red"}],pot_decorations:{right:{id:"minecraft:brick"}},lore:["x"],rarity:"epic"}'), +] +# Fixtures on another item than a stick (the components need it, or read better there). +ITEMS = {'profile name': 'player_head', 'profile full': 'player_head', 'trim registry': 'diamond_chestplate', + 'trim direct': 'diamond_chestplate', 'banner_patterns': 'white_banner', 'pot_decorations': 'decorated_pot', + 'everything at once': 'diamond_chestplate'} + + +def compare(vanilla, rust): + """Failures, stacks checked, and the component ids covered.""" + results = {r['label']: r for r in rust} + failures, covered = [], set() + for v in vanilla: + if 'error' in v: + failures.append(f"oracle {v['label']}: {v['error']}") + continue + covered.update(v['added'] + v['removed']) + r = results.get(v['label']) + if r is None or 'error' in r: + failures.append(f"{v['label']}: {r and r['error']}") + elif r['left'] or r['added'] != v['added'] or r['removed'] != v['removed']: + failures.append(f"{v['label']}: {r['left']} bytes left, ids {r['added']}/{r['removed']}, vanilla {v['added']}/{v['removed']}") + elif not r['same_bytes'] and not r['typed']: + failures.append(f"{v['label']}: read past, but encoded back differently") + missing = sorted(set(range(COMPONENT_TYPES)) - covered) + if missing: + failures.append(f'component ids no stack covers: {missing}') + return failures, len(vanilla), covered + + +def main(): + parser = argparse.ArgumentParser(description=__doc__) + parser.add_argument('--prepare', action='store_true') + args = parser.parse_args() + build = lab.LOCAL / 'item-wire-parity' + build.mkdir(parents=True, exist_ok=True) + report_path = build / 'report.json' + report_path.unlink(missing_ok=True) + if args.prepare: + lab.prepare() + lock, jars, libraries = base.verify_artifacts() + oracle = lab.ROOT / 'mods/horizon/src/test/java/dev/horizonlab/parity/VanillaItemWireOracle.java' + classes = build / 'classes' + classes.mkdir(exist_ok=True) + + def run(command, name): + with (build / (name + '.log')).open('w', encoding='utf-8') as log: + base.run(list(map(str, command)), stdout=log, stderr=subprocess.STDOUT) + dependency_path = os.pathsep.join(map(str, libraries)) + run(['javac', '--release', lock['minecraft']['java_major'], '-proc:none', '-sourcepath', + lab.ROOT / 'mods/horizon/src/test/java', '-cp', str(jars['server']) + os.pathsep + dependency_path, + '-d', classes, oracle], 'compile-java') + fixtures = build / 'fixtures.tsv' + fixtures.write_text(''.join(f'{label}\t{{id:"minecraft:{ITEMS.get(label, "stick")}",count:1,components:{snbt}}}\n' + for label, snbt in FIXTURES), encoding='utf-8') + vanilla_path, rust_path = build / 'vanilla.jsonl', build / 'rust.jsonl' + run(['java', '-Xmx1G', '-cp', os.pathsep.join([str(classes), str(jars['server']), dependency_path]), + 'dev.horizonlab.parity.VanillaItemWireOracle', fixtures, vanilla_path], 'oracle') + run(['cargo', 'build', '--release', '-p', 'horizon-protocol', '--example', 'item_wire_probe'], 'compile-rust') + binary = lab.cargo_target() / 'release/examples' / ('item_wire_probe.exe' if os.name == 'nt' else 'item_wire_probe') + run([binary, vanilla_path, rust_path], 'rust') + read = lambda path: [json.loads(line) for line in path.read_text(encoding='utf-8').splitlines() if line.strip()] + failures, stacks, covered = compare(read(vanilla_path), read(rust_path)) + for failure in failures[:40]: + print(failure) + if failures: + raise SystemExit(f'{len(failures)} item wire mismatches (of {stacks} stacks)') + lab.write_json(report_path, { + 'schema': 1, 'minecraft': lock['minecraft']['version'], 'platform': platform.platform(), + 'stacks': stacks, 'component_types_covered': len(covered), + 'oracle_sha256': lab.digest(vanilla_path, 'sha256'), 'rust_sha256': lab.digest(rust_path, 'sha256')}) + print(f'Item wire parity passed: {stacks} stacks, all {len(covered)} component types: {report_path}') + + +if __name__ == '__main__': + main() From 07e46daa59e2c6238a443c7992beb10af1307266 Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Sat, 24 Oct 2026 20:41:16 +0200 Subject: [PATCH 008/169] Shader packs, clean room 1: read packs and their lang files A new crate, horizon-shaders, the first piece of shader pack support written again from a specification of the format. It opens a pack (a folder or a zip whose root holds a shaders folder; decoy folders and files beside it are ignored), lists the packs in a shaderpacks folder with the reason a broken one can't be used, and reads a pack's lang files: English under the player's locale, file names matched ignoring case (packs ship en_US.lang). Nothing uses it yet: players see no change. Co-Authored-By: Claude Opus 5.5 --- AGENTS.md | 1 + Cargo.lock | 7 + Cargo.toml | 2 +- crates/horizon-shaders/Cargo.toml | 13 + crates/horizon-shaders/src/discover.rs | 82 +++++++ crates/horizon-shaders/src/lang.rs | 74 ++++++ crates/horizon-shaders/src/lib.rs | 15 ++ crates/horizon-shaders/src/pack.rs | 262 +++++++++++++++++++++ crates/horizon-shaders/tests/real_packs.rs | 43 ++++ 9 files changed, 498 insertions(+), 1 deletion(-) create mode 100644 crates/horizon-shaders/Cargo.toml create mode 100644 crates/horizon-shaders/src/discover.rs create mode 100644 crates/horizon-shaders/src/lang.rs create mode 100644 crates/horizon-shaders/src/lib.rs create mode 100644 crates/horizon-shaders/src/pack.rs create mode 100644 crates/horizon-shaders/tests/real_packs.rs diff --git a/AGENTS.md b/AGENTS.md index f6f6b463b..0656e40fc 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -45,6 +45,7 @@ Game workspace (root `Cargo.toml`); `launcher/` and `crates/horizon-telemetry-se | `horizon-friends`, `horizon-relay` | Play with Friends: invite codes, encrypted tunnel, the relay ([docs/play-with-friends.md](docs/play-with-friends.md)) | | `horizon-mods`, `horizon-mod-sdk`, `cargo-horizon-mod` | Sandboxed WebAssembly mods: runtime, SDK + WIT, `cargo horizon-mod` ([docs/mods.md](docs/mods.md)) | | `horizon-port-pack` | Porting Java modpacks ([docs/modpacks.md](docs/modpacks.md)) | +| `horizon-shaders` | Shader packs (the `shaders/` folder format), rebuilt clean-room from a written spec of the format; no wgpu | | `horizon-theme` | Design tokens and fonts for the launcher, the game's own menus and the website | | `horizon-telemetry`, `horizon-telemetry-server`, `horizon-bench` | Opt-in data collection, its ingest server, the benchmark report format | | `horizon-dualsense`, `horizon-threads`, `horizon-release-sign`, `horizon-bots`, `xtask` | DualSense output, thread priorities, signed release checksums, load-test bots, repo tasks | diff --git a/Cargo.lock b/Cargo.lock index 6da6a64b1..6c7279aa7 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1430,6 +1430,13 @@ dependencies = [ "ureq", ] +[[package]] +name = "horizon-shaders" +version = "0.1.0" +dependencies = [ + "zip", +] + [[package]] name = "horizon-telemetry" version = "0.1.0" diff --git a/Cargo.toml b/Cargo.toml index f197c34fe..b8e6b044e 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [workspace] exclude = ["launcher", "crates/horizon-telemetry-server", "third_party/wgpu-hal"] -members = ["crates/horizon-core", "crates/horizon-dualsense", "crates/horizon-threads", "crates/horizon-world", "crates/horizon-client", "crates/horizon-server-files", "crates/horizon-server", "crates/horizon-bots", "crates/horizon-assets", "crates/horizon-protocol", "crates/horizon-theme", "crates/horizon-prepare", "crates/horizon-telemetry", "crates/horizon-bench", "crates/horizon-friends", "crates/horizon-relay", "crates/horizon-mod-sdk", "crates/horizon-mods", "crates/horizon-mods/tests/guest", "crates/cargo-horizon-mod", "crates/horizon-port-pack", "crates/horizon-release-sign", "crates/horizon-mod-sdk/examples/coords-hud", "xtask"] +members = ["crates/horizon-core", "crates/horizon-dualsense", "crates/horizon-threads", "crates/horizon-world", "crates/horizon-client", "crates/horizon-server-files", "crates/horizon-server", "crates/horizon-bots", "crates/horizon-assets", "crates/horizon-protocol", "crates/horizon-theme", "crates/horizon-prepare", "crates/horizon-telemetry", "crates/horizon-bench", "crates/horizon-friends", "crates/horizon-relay", "crates/horizon-mod-sdk", "crates/horizon-mods", "crates/horizon-mods/tests/guest", "crates/cargo-horizon-mod", "crates/horizon-port-pack", "crates/horizon-shaders", "crates/horizon-release-sign", "crates/horizon-mod-sdk/examples/coords-hud", "xtask"] resolver = "2" [workspace.package] diff --git a/crates/horizon-shaders/Cargo.toml b/crates/horizon-shaders/Cargo.toml new file mode 100644 index 000000000..ed3a24266 --- /dev/null +++ b/crates/horizon-shaders/Cargo.toml @@ -0,0 +1,13 @@ +[package] +name = "horizon-shaders" +version = "0.1.0" +edition.workspace = true +license.workspace = true +rust-version = "1.85" +description = "Shader packs (the shaders/ folder format): reading packs, their .properties and .lang files, and later their GLSL" + +[dependencies] +zip = { version = "2", default-features = false, features = ["deflate"] } + +[lints] +workspace = true diff --git a/crates/horizon-shaders/src/discover.rs b/crates/horizon-shaders/src/discover.rs new file mode 100644 index 000000000..7d01d41b3 --- /dev/null +++ b/crates/horizon-shaders/src/discover.rs @@ -0,0 +1,82 @@ +//! The packs in the game's `shaderpacks` folder: every folder and `.zip` in it (spec 1.1). + +use std::fs; +use std::path::{Path, PathBuf}; + +use crate::Pack; + +/// One entry of the `shaderpacks` folder that is or looks like a pack. +#[derive(Debug, PartialEq)] +pub struct Found { + /// The folder or file name, which is how players and settings name the pack. + pub name: String, + pub path: PathBuf, + /// Why the entry can't be used, said to the player (a zip that doesn't open, a folder with + /// no `shaders` folder at its root). `None` for a usable pack. + pub problem: Option, +} + +/// The packs in `dir`, sorted by name ignoring case. Hidden entries and files that are not +/// `.zip` (the game's own option files live beside the packs) are skipped. +pub fn discover(dir: &Path) -> Vec { + let mut found: Vec = fs::read_dir(dir) + .into_iter() + .flatten() + .flatten() + .filter_map(|entry| { + let name = entry.file_name().to_string_lossy().into_owned(); + let path = entry.path(); + let is_zip = path + .extension() + .is_some_and(|e| e.eq_ignore_ascii_case("zip")); + if name.starts_with('.') || !(path.is_dir() || is_zip) { + return None; + } + let problem = Pack::open(&path).err().map(|e| e.to_string()); + Some(Found { + name, + path, + problem, + }) + }) + .collect(); + found.sort_by_cached_key(|f| (f.name.to_lowercase(), f.name.clone())); + found +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::pack::tests::{temp_dir, zip}; + + #[test] + fn lists_folders_and_zips_with_their_problems() { + let dir = temp_dir("discover"); + fs::create_dir_all(dir.join("Zeta/shaders")).unwrap(); + fs::create_dir_all(dir.join("Extracted wrong/Inner/shaders")).unwrap(); + fs::create_dir_all(dir.join(".hidden/shaders")).unwrap(); + fs::write(dir.join("alpha.ZIP"), zip(&[("shaders/final.fsh", "")])).unwrap(); + fs::write(dir.join("broken.zip"), "not a zip").unwrap(); + fs::write(dir.join("alpha.ZIP.txt"), "OPTION=1").unwrap(); + let found = discover(&dir); + let summary: Vec<(&str, bool)> = found + .iter() + .map(|f| (f.name.as_str(), f.problem.is_none())) + .collect(); + assert_eq!( + summary, + [ + ("alpha.ZIP", true), + ("broken.zip", false), + ("Extracted wrong", false), + ("Zeta", true) + ] + ); + assert_eq!( + found[2].problem.as_deref(), + Some("no shaders folder at the root of the pack") + ); + assert!(discover(&dir.join("missing")).is_empty()); + fs::remove_dir_all(&dir).unwrap(); + } +} diff --git a/crates/horizon-shaders/src/lang.rs b/crates/horizon-shaders/src/lang.rs new file mode 100644 index 000000000..483de67d2 --- /dev/null +++ b/crates/horizon-shaders/src/lang.rs @@ -0,0 +1,74 @@ +//! A pack's `lang/.lang` files (spec 8.4): `key=value` lines naming options, values, +//! screens and profiles. + +use std::collections::HashMap; + +use crate::Pack; + +#[derive(Debug, Default, PartialEq)] +pub struct Lang(HashMap); + +impl Lang { + /// English with the player's locale over it, so a key the locale lacks still has a name. + /// File names match ignoring case: packs ship `en_US.lang` for Minecraft's `en_us`. + /// Strings keep their `§` formatting codes for the game's text renderer. + pub fn load(pack: &Pack, locale: &str) -> Self { + let files = pack.list("lang"); + let mut lang = Self::default(); + for wanted in ["en_us", locale] { + let file = files.iter().find(|f| { + f.strip_suffix(".lang") + .is_some_and(|stem| stem.eq_ignore_ascii_case(wanted)) + }); + if let Some(text) = file.and_then(|f| pack.read_text(&format!("lang/{f}"))) { + lang.read(&text); + } + } + lang + } + + fn read(&mut self, text: &str) { + for line in text.lines().map(str::trim) { + if line.starts_with('#') { + continue; + } + if let Some((key, value)) = line.split_once('=') { + self.0 + .insert(key.trim().to_owned(), value.trim().to_owned()); + } + } + } + + pub fn get(&self, key: &str) -> Option<&str> { + self.0.get(key).map(String::as_str) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::pack::tests::zip; + + #[test] + fn lang_falls_back_by_case_then_english() { + let pack = Pack::from_zip_bytes( + "P.zip", + zip(&[ + ( + "shaders/lang/en_US.lang", + "# names\noption.A=Alpha\noption.B = §6Beta§r\n", + ), + ("shaders/lang/fr_FR.lang", "option.A=Alpha (fr)\n"), + ]), + ) + .unwrap(); + let fr = Lang::load(&pack, "fr_fr"); + assert_eq!(fr.get("option.A"), Some("Alpha (fr)")); + assert_eq!(fr.get("option.B"), Some("§6Beta§r")); + assert_eq!(fr.get("# names"), None); + let de = Lang::load(&pack, "de_de"); + assert_eq!(de.get("option.A"), Some("Alpha")); + let none = Pack::from_zip_bytes("Q.zip", zip(&[("shaders/final.fsh", "")])).unwrap(); + assert_eq!(Lang::load(&none, "en_us"), Lang::default()); + } +} diff --git a/crates/horizon-shaders/src/lib.rs b/crates/horizon-shaders/src/lib.rs new file mode 100644 index 000000000..1c9b46dd1 --- /dev/null +++ b/crates/horizon-shaders/src/lib.rs @@ -0,0 +1,15 @@ +//! Shader packs: the `shaderpacks/*.zip` format, written from Horizon's clean-room specification +//! (`shader-packs-spec.md`, revision 1). This crate reads the format and knows nothing of wgpu; +//! the game's renderer runs what it produces. +//! +//! - [`Pack`]: a pack as a folder or a zip, with paths relative to its `shaders` folder (spec 1.1). +//! - [`discover`]: the packs in a `shaderpacks` folder. +//! - [`Lang`]: the pack's translated names (8.4). + +mod discover; +mod lang; +mod pack; + +pub use discover::{Found, discover}; +pub use lang::Lang; +pub use pack::{Pack, PackError}; diff --git a/crates/horizon-shaders/src/pack.rs b/crates/horizon-shaders/src/pack.rs new file mode 100644 index 000000000..113db9ac9 --- /dev/null +++ b/crates/horizon-shaders/src/pack.rs @@ -0,0 +1,262 @@ +//! A pack is a folder or a `.zip` whose root holds a folder named `shaders`; everything else at +//! the root (licences, readmes, decoy folders) is ignored (spec 1.1). Every path a pack uses is +//! relative to that `shaders` folder, written with `/`. + +use std::collections::BTreeMap; +use std::fmt; +use std::fs; +use std::io::{self, Cursor, Read}; +use std::path::{Path, PathBuf}; +use std::sync::Arc; + +use zip::ZipArchive; + +const ROOT: &str = "shaders"; + +pub struct Pack { + name: String, + files: Files, +} + +enum Files { + /// The pack's `shaders` folder. + Folder(PathBuf), + /// The archive and its entries under `shaders/`, by their path inside that folder. + Zip { + archive: ZipArchive>>, + entries: BTreeMap, + }, +} + +#[derive(Debug)] +pub enum PackError { + Io(io::Error), + Zip(String), + /// A readable folder or archive with no `shaders` folder at its root. + NoShadersFolder, +} + +impl fmt::Display for PackError { + fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { + match self { + Self::Io(e) => write!(f, "{e}"), + Self::Zip(e) => write!(f, "not a readable zip: {e}"), + Self::NoShadersFolder => f.write_str("no shaders folder at the root of the pack"), + } + } +} + +impl std::error::Error for PackError {} + +impl From for PackError { + fn from(e: io::Error) -> Self { + Self::Io(e) + } +} + +impl Pack { + /// Opens a pack folder or a `.zip` archive. + pub fn open(path: &Path) -> Result { + let name = path + .file_name() + .map_or_else(String::new, |n| n.to_string_lossy().into_owned()); + let files = if path.is_dir() { + let root = path.join(ROOT); + if !root.is_dir() { + return Err(PackError::NoShadersFolder); + } + Files::Folder(root) + } else { + Self::zip_files(fs::read(path)?)? + }; + Ok(Self { name, files }) + } + + /// An archive held in memory; `name` is what [`Pack::name`] returns. + pub fn from_zip_bytes(name: &str, bytes: Vec) -> Result { + let files = Self::zip_files(bytes)?; + Ok(Self { + name: name.to_owned(), + files, + }) + } + + fn zip_files(bytes: Vec) -> Result { + let archive = ZipArchive::new(Cursor::new(Arc::from(bytes))) + .map_err(|e| PackError::Zip(e.to_string()))?; + let entries: BTreeMap = (0..archive.len()) + .filter_map(|i| { + let name = archive.name_for_index(i)?.replace('\\', "/"); + let inner = name.strip_prefix(ROOT)?.strip_prefix('/')?; + (!inner.is_empty() && !inner.ends_with('/')).then(|| (inner.to_owned(), i)) + }) + .collect(); + if entries.is_empty() { + return Err(PackError::NoShadersFolder); + } + Ok(Files::Zip { archive, entries }) + } + + /// The folder or file name the pack was opened from (`BSL.zip`). + pub fn name(&self) -> &str { + &self.name + } + + /// The bytes of a file, by its path inside `shaders` (`lang/en_us.lang`). `None` when it + /// doesn't exist or the path leaves the folder. + pub fn read(&self, path: &str) -> Option> { + let path = normalize(path)?; + match &self.files { + Files::Folder(root) => fs::read(root.join(&path)).ok(), + Files::Zip { archive, entries } => { + // A clone shares the bytes and the central directory; reading needs `&mut`. + let mut archive = archive.clone(); + let mut entry = archive.by_index(*entries.get(&path)?).ok()?; + let mut out = Vec::with_capacity(entry.size() as usize); + entry.read_to_end(&mut out).ok()?; + Some(out) + } + } + } + + /// A text file, decoded as UTF-8 (invalid bytes replaced) without its byte-order mark. + pub fn read_text(&self, path: &str) -> Option { + let bytes = self.read(path)?; + let text = String::from_utf8_lossy(&bytes); + Some(text.strip_prefix('\u{feff}').unwrap_or(&text).to_owned()) + } + + pub fn exists(&self, path: &str) -> bool { + let Some(path) = normalize(path) else { + return false; + }; + match &self.files { + Files::Folder(root) => root.join(path).is_file(), + Files::Zip { entries, .. } => entries.contains_key(&path), + } + } + + /// The names of the files directly inside a folder of the pack (`""` for `shaders` itself), + /// sorted. + pub fn list(&self, dir: &str) -> Vec { + let Some(dir) = normalize(dir) else { + return Vec::new(); + }; + let mut names: Vec = match &self.files { + Files::Folder(root) => fs::read_dir(root.join(&dir)) + .into_iter() + .flatten() + .flatten() + .filter(|e| e.file_type().is_ok_and(|t| t.is_file())) + .map(|e| e.file_name().to_string_lossy().into_owned()) + .collect(), + Files::Zip { entries, .. } => { + let prefix = if dir.is_empty() { + String::new() + } else { + format!("{dir}/") + }; + entries + .keys() + .filter_map(|k| k.strip_prefix(&prefix)) + .filter(|rest| !rest.contains('/')) + .map(str::to_owned) + .collect() + } + }; + names.sort(); + names + } +} + +/// `a/./b/../c` → `a/c`; `None` for a path that climbs out of `shaders`. +fn normalize(path: &str) -> Option { + let mut parts: Vec<&str> = Vec::new(); + for part in path.split(['/', '\\']) { + match part { + "" | "." => {} + ".." => { + parts.pop()?; + } + _ => parts.push(part), + } + } + Some(parts.join("/")) +} + +#[cfg(test)] +pub(crate) mod tests { + use super::*; + use std::io::Write; + + /// A zip of `(path, contents)` pairs, paths from the archive root. + pub(crate) fn zip(files: &[(&str, &str)]) -> Vec { + let mut w = zip::ZipWriter::new(Cursor::new(Vec::new())); + let options = zip::write::SimpleFileOptions::default() + .compression_method(zip::CompressionMethod::Deflated); + for (path, contents) in files { + w.start_file(*path, options).unwrap(); + w.write_all(contents.as_bytes()).unwrap(); + } + w.finish().unwrap().into_inner() + } + + /// A fresh empty folder under the system's temp folder. + pub(crate) fn temp_dir(name: &str) -> PathBuf { + let dir = + std::env::temp_dir().join(format!("horizon-shaders-{name}-{}", std::process::id())); + let _ = fs::remove_dir_all(&dir); + fs::create_dir_all(&dir).unwrap(); + dir + } + + #[test] + fn zip_packs_read_only_the_shaders_folder() { + let bytes = zip(&[ + ("License.txt", "x"), + ("shaderFile_A.placebo/shaders.properties", "decoy"), + ("shaders/shaders.properties", "sun=false"), + ("shaders/lang/en_US.lang", "a=b"), + ("shaders/lang/fr_FR.lang", "a=c"), + ("shaders/lib/common.glsl", ""), + ]); + let pack = Pack::from_zip_bytes("P.zip", bytes).unwrap(); + assert_eq!(pack.read_text("shaders.properties").unwrap(), "sun=false"); + assert!(pack.exists("lib/common.glsl")); + assert!(pack.exists("lib/../shaders.properties")); + assert!(!pack.exists("../License.txt")); + assert!(!pack.exists("License.txt")); + assert_eq!(pack.list("lang"), ["en_US.lang", "fr_FR.lang"]); + assert_eq!(pack.list(""), ["shaders.properties"]); + } + + #[test] + fn archives_without_a_shaders_folder_are_not_packs() { + let bytes = zip(&[("Pack/shaders/final.fsh", ""), ("readme.txt", "")]); + assert!(matches!( + Pack::from_zip_bytes("P.zip", bytes), + Err(PackError::NoShadersFolder) + )); + assert!(matches!( + Pack::from_zip_bytes("P.zip", b"not a zip".to_vec()), + Err(PackError::Zip(_)) + )); + } + + #[test] + fn folder_packs_read_the_same_way() { + let dir = temp_dir("folder"); + fs::create_dir_all(dir.join("shaders/lang")).unwrap(); + fs::write( + dir.join("shaders/lang/en_us.lang"), + "\u{feff}option.A=Alpha", + ) + .unwrap(); + fs::write(dir.join("secret.txt"), "outside").unwrap(); + let pack = Pack::open(&dir).unwrap(); + assert_eq!(pack.read_text("lang/en_us.lang").unwrap(), "option.A=Alpha"); + assert_eq!(pack.list("lang"), ["en_us.lang"]); + assert!(pack.read("../secret.txt").is_none()); + fs::remove_dir_all(&dir).unwrap(); + } +} diff --git a/crates/horizon-shaders/tests/real_packs.rs b/crates/horizon-shaders/tests/real_packs.rs new file mode 100644 index 000000000..b35aef519 --- /dev/null +++ b/crates/horizon-shaders/tests/real_packs.rs @@ -0,0 +1,43 @@ +//! Reads real packs as black boxes: `HORIZON_TEST_SHADER_PACKS= cargo test -p +//! horizon-shaders --release -- --ignored --nocapture`. The folder (and its subfolders) holds +//! pack zips or folders, which are never committed; this prints what was read and how long it took. + +use std::path::Path; +use std::time::Instant; + +use horizon_shaders::{Lang, Pack, discover}; + +#[test] +#[ignore = "needs HORIZON_TEST_SHADER_PACKS"] +fn real_packs_read() { + let dir = std::env::var_os("HORIZON_TEST_SHADER_PACKS").expect("HORIZON_TEST_SHADER_PACKS"); + let dir = Path::new(&dir); + let mut found = discover(dir); + for sub in std::fs::read_dir(dir).unwrap().flatten() { + if sub.path().is_dir() { + found.extend(discover(&sub.path())); + } + } + let mut read = 0; + for f in found.iter().filter(|f| f.problem.is_none()) { + let start = Instant::now(); + let pack = Pack::open(&f.path).unwrap(); + let properties = pack.read_text("shaders.properties"); + let lang = Lang::load(&pack, "en_us"); + println!( + "{}: {} files at the root, shaders.properties {} bytes, lang {}, {:.2} ms", + f.name, + pack.list("").len(), + properties.as_ref().map_or(0, String::len), + if lang == Lang::default() { + "none" + } else { + "read" + }, + start.elapsed().as_secs_f64() * 1000.0 + ); + assert!(properties.is_some(), "{}: no shaders.properties", f.name); + read += 1; + } + assert!(read > 0, "no packs under {}", dir.display()); +} From eb0a6f74e6d5911cc63e637b6dcd14076c28ac0e Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Sat, 24 Oct 2026 20:42:05 +0200 Subject: [PATCH 009/169] Shader packs, clean room 2: macros and #if conditions The integer arithmetic of #if/#elif that a pack's .properties files and, later, its GLSL preprocessor share: defined X and defined(X), decimal, hexadecimal and octal literals, the C operators with C precedence, macros expanded to their values (a macro is not expanded inside its own expansion), and an identifier that is not a macro read as 0. A bad condition says why. The standard macros that need no renderer: MC_VERSION, from the pinned version by the documented rule (26.3 is 260300), and the system's MC_OS_*. Nothing uses it yet: players see no change. Co-Authored-By: Claude Opus 5.5 --- Cargo.lock | 1 + crates/horizon-shaders/Cargo.toml | 1 + crates/horizon-shaders/src/condition.rs | 265 ++++++++++++++++++++++++ crates/horizon-shaders/src/lib.rs | 5 + crates/horizon-shaders/src/macros.rs | 131 ++++++++++++ 5 files changed, 403 insertions(+) create mode 100644 crates/horizon-shaders/src/condition.rs create mode 100644 crates/horizon-shaders/src/macros.rs diff --git a/Cargo.lock b/Cargo.lock index 6c7279aa7..7036ea5ca 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1434,6 +1434,7 @@ dependencies = [ name = "horizon-shaders" version = "0.1.0" dependencies = [ + "horizon-core", "zip", ] diff --git a/crates/horizon-shaders/Cargo.toml b/crates/horizon-shaders/Cargo.toml index ed3a24266..750949e83 100644 --- a/crates/horizon-shaders/Cargo.toml +++ b/crates/horizon-shaders/Cargo.toml @@ -7,6 +7,7 @@ rust-version = "1.85" description = "Shader packs (the shaders/ folder format): reading packs, their .properties and .lang files, and later their GLSL" [dependencies] +horizon-core = { path = "../horizon-core" } zip = { version = "2", default-features = false, features = ["deflate"] } [lints] diff --git a/crates/horizon-shaders/src/condition.rs b/crates/horizon-shaders/src/condition.rs new file mode 100644 index 000000000..b911eb985 --- /dev/null +++ b/crates/horizon-shaders/src/condition.rs @@ -0,0 +1,265 @@ +//! The integer arithmetic of `#if` and `#elif` (spec 1.5, GLSL 4.60 §3.3): `defined`, integer +//! literals, macros expanded to their values, and the C operators with C precedence. +//! An identifier that is not a macro counts as 0, as in C: GLSL would reject the line, and a +//! pack would then lose a whole section of its settings over one unknown name. + +use crate::Macros; +use crate::macros::{is_ident, is_ident_start}; + +/// The value of a condition; `Err` says what is wrong with it. +pub fn eval_condition(expr: &str, macros: &Macros) -> Result { + let tokens = tokens(&resolve_defined(expr, macros)?, macros)?; + let mut parser = Parser { + tokens: &tokens, + at: 0, + }; + let value = parser.binary(0)?; + match parser.tokens.get(parser.at) { + None => Ok(value), + Some(t) => Err(format!("unexpected `{}`", t.text())), + } +} + +/// `defined X` and `defined(X)` become `1` or `0` before anything is expanded. +fn resolve_defined(expr: &str, macros: &Macros) -> Result { + let mut out = String::with_capacity(expr.len()); + let mut rest = expr; + while let Some(at) = find_word(rest, "defined") { + out.push_str(&rest[..at]); + let after = rest[at + "defined".len()..].trim_start(); + let (inner, tail) = match after.strip_prefix('(') { + Some(open) => { + let close = open.find(')').ok_or("`defined(` without `)`")?; + (open[..close].trim(), &open[close + 1..]) + } + None => { + let len = after.find(|c: char| !is_ident(c)).unwrap_or(after.len()); + (&after[..len], &after[len..]) + } + }; + if inner.is_empty() || !inner.starts_with(is_ident_start) || !inner.chars().all(is_ident) { + return Err("`defined` needs a macro name".into()); + } + out.push_str(if macros.is_defined(inner) { + " 1 " + } else { + " 0 " + }); + rest = tail; + } + out.push_str(rest); + Ok(out) +} + +/// Where `word` starts in `text` as a whole identifier. +fn find_word(text: &str, word: &str) -> Option { + let mut from = 0; + while let Some(i) = text[from..].find(word).map(|i| i + from) { + let before = text[..i].chars().next_back().is_some_and(is_ident); + let after = text[i + word.len()..].chars().next().is_some_and(is_ident); + if !before && !after { + return Some(i); + } + from = i + word.len(); + } + None +} + +#[derive(Clone, Copy, Debug, PartialEq)] +enum Token { + Num(i64), + Op(&'static str), +} + +impl Token { + fn text(&self) -> String { + match self { + Token::Num(n) => n.to_string(), + Token::Op(op) => (*op).to_owned(), + } + } +} + +const OPS: [&str; 22] = [ + "<<", ">>", "<=", ">=", "==", "!=", "&&", "||", "(", ")", "!", "~", "+", "-", "*", "/", "%", + "<", ">", "&", "^", "|", +]; + +fn tokens(expr: &str, macros: &Macros) -> Result, String> { + let expanded = macros.expand(expr); + let mut out = Vec::new(); + let mut rest = expanded.trim_start(); + while let Some(c) = rest.chars().next() { + if c.is_ascii_digit() { + let len = rest + .find(|c: char| !c.is_ascii_alphanumeric()) + .unwrap_or(rest.len()); + if rest[len..].starts_with('.') { + return Err(format!("`{}`: `#if` takes integers only", &rest[..len + 1])); + } + out.push(Token::Num(int_literal(&rest[..len])?)); + rest = &rest[len..]; + } else if is_ident_start(c) { + // Not a macro: 0, as the C preprocessor counts it. + let len = rest.find(|c: char| !is_ident(c)).unwrap_or(rest.len()); + out.push(Token::Num(0)); + rest = &rest[len..]; + } else { + let op = OPS + .iter() + .find(|op| rest.starts_with(**op)) + .ok_or_else(|| format!("unexpected `{c}`"))?; + out.push(Token::Op(op)); + rest = &rest[op.len()..]; + } + rest = rest.trim_start(); + } + Ok(out) +} + +/// Decimal, `0x` hexadecimal or leading-zero octal, with an optional `u` suffix. +fn int_literal(text: &str) -> Result { + let digits = text.strip_suffix(['u', 'U']).unwrap_or(text); + let parsed = if let Some(hex) = digits.strip_prefix("0x").or(digits.strip_prefix("0X")) { + i64::from_str_radix(hex, 16) + } else if digits.len() > 1 && digits.starts_with('0') { + i64::from_str_radix(&digits[1..], 8) + } else { + digits.parse() + }; + parsed.map_err(|_| format!("`{text}` is not an integer")) +} + +struct Parser<'a> { + tokens: &'a [Token], + at: usize, +} + +/// Binary operators from the loosest to the tightest (GLSL §5.1 / §3.3). +const LEVELS: [&[&str]; 10] = [ + &["||"], + &["&&"], + &["|"], + &["^"], + &["&"], + &["==", "!="], + &["<", ">", "<=", ">="], + &["<<", ">>"], + &["+", "-"], + &["*", "/", "%"], +]; + +impl Parser<'_> { + fn next(&mut self) -> Option { + let t = self.tokens.get(self.at).copied(); + self.at += 1; + t + } + + fn binary(&mut self, level: usize) -> Result { + if level == LEVELS.len() { + return self.unary(); + } + let mut left = self.binary(level + 1)?; + while let Some(&Token::Op(op)) = self.tokens.get(self.at) { + if !LEVELS[level].contains(&op) { + break; + } + self.at += 1; + let right = self.binary(level + 1)?; + left = apply(op, left, right)?; + } + Ok(left) + } + + fn unary(&mut self) -> Result { + match self.next() { + Some(Token::Num(n)) => Ok(n), + Some(Token::Op("(")) => { + let value = self.binary(0)?; + match self.next() { + Some(Token::Op(")")) => Ok(value), + _ => Err("missing `)`".into()), + } + } + Some(Token::Op("-")) => Ok(self.unary()?.wrapping_neg()), + Some(Token::Op("+")) => self.unary(), + Some(Token::Op("!")) => Ok((self.unary()? == 0) as i64), + Some(Token::Op("~")) => Ok(!self.unary()?), + Some(t) => Err(format!("unexpected `{}`", t.text())), + None => Err("the condition ends too early".into()), + } + } +} + +fn apply(op: &str, a: i64, b: i64) -> Result { + Ok(match op { + "||" => (a != 0 || b != 0) as i64, + "&&" => (a != 0 && b != 0) as i64, + "|" => a | b, + "^" => a ^ b, + "&" => a & b, + "==" => (a == b) as i64, + "!=" => (a != b) as i64, + "<" => (a < b) as i64, + ">" => (a > b) as i64, + "<=" => (a <= b) as i64, + ">=" => (a >= b) as i64, + "<<" => a.wrapping_shl(b as u32), + ">>" => a.wrapping_shr(b as u32), + "+" => a.wrapping_add(b), + "-" => a.wrapping_sub(b), + "*" => a.wrapping_mul(b), + "/" | "%" if b == 0 => return Err("division by zero".into()), + "/" => a.wrapping_div(b), + _ => a.wrapping_rem(b), + }) +} + +#[cfg(test)] +mod tests { + use super::*; + + fn eval(expr: &str) -> Result { + let mut m = Macros::standard(); + m.define("SHADOW_RES", "2048"); + m.define("WAVES", ""); + m.define("QUALITY", "SHADOW_RES / 1024"); + eval_condition(expr, &m) + } + + #[test] + fn precedence_and_operators_follow_c() { + assert_eq!(eval("1 + 2 * 3"), Ok(7)); + assert_eq!(eval("(1 + 2) * 3"), Ok(9)); + assert_eq!(eval("1 << 2 + 1"), Ok(8)); + assert_eq!(eval("6 & 3 == 3"), Ok(0)); + assert_eq!(eval("1 || 0 && 0"), Ok(1)); + assert_eq!(eval("-7 / 2"), Ok(-3)); + assert_eq!(eval("-7 % 2"), Ok(-1)); + assert_eq!(eval("!0 + ~0"), Ok(0)); + assert_eq!(eval("0x10 + 010 + 3u"), Ok(27)); + } + + #[test] + fn macros_and_defined() { + assert_eq!(eval("MC_VERSION >= 11300"), Ok(1)); + assert_eq!(eval("MC_VERSION <= 12111"), Ok(0)); + assert_eq!(eval("QUALITY == 2"), Ok(1)); + assert_eq!(eval("defined WAVES && defined(SHADOW_RES)"), Ok(1)); + assert_eq!(eval("!defined NOPE"), Ok(1)); + assert_eq!(eval("NOPE == 0"), Ok(1)); + assert_eq!(eval("undefinedFeature"), Ok(0)); + } + + #[test] + fn bad_conditions_say_why() { + assert!(eval("1 / 0").is_err()); + assert!(eval("SHADOW_RES == 0.5").is_err()); + assert!(eval("(1 + 2").is_err()); + assert!(eval("1 2").is_err()); + assert!(eval("").is_err()); + assert!(eval("defined").is_err()); + assert!(eval("1 @ 2").is_err()); + } +} diff --git a/crates/horizon-shaders/src/lib.rs b/crates/horizon-shaders/src/lib.rs index 1c9b46dd1..e7ccb26d6 100644 --- a/crates/horizon-shaders/src/lib.rs +++ b/crates/horizon-shaders/src/lib.rs @@ -5,11 +5,16 @@ //! - [`Pack`]: a pack as a folder or a zip, with paths relative to its `shaders` folder (spec 1.1). //! - [`discover`]: the packs in a `shaderpacks` folder. //! - [`Lang`]: the pack's translated names (8.4). +//! - [`Macros`] and [`eval_condition`]: the macros packs test, and the `#if` arithmetic (1.5). +mod condition; mod discover; mod lang; +mod macros; mod pack; +pub use condition::eval_condition; pub use discover::{Found, discover}; pub use lang::Lang; +pub use macros::{MC_VERSION, Macros}; pub use pack::{Pack, PackError}; diff --git a/crates/horizon-shaders/src/macros.rs b/crates/horizon-shaders/src/macros.rs new file mode 100644 index 000000000..f3a53722f --- /dev/null +++ b/crates/horizon-shaders/src/macros.rs @@ -0,0 +1,131 @@ +//! Object-like macros: the ones packs test in `#if` lines and use inside property values +//! (spec 1.5, 1.5.1). The GLSL preprocessor's function-like macros are not needed here. + +use std::collections::BTreeMap; + +/// `MC_VERSION` of the version Horizon plays: 26.3 → 260300. +pub const MC_VERSION: u32 = mc_version(horizon_core::version::VERSION_ID); + +/// The documented rule, `major * 10000 + minor * 100 + patch` (spec 1.5.1, OQ-1): `1.21` → 12100, +/// `1.7.10` → 10710. Parts that are not digits count as 0. +pub const fn mc_version(id: &str) -> u32 { + let bytes = id.as_bytes(); + let (mut parts, mut part, mut i) = ([0u32; 3], 0, 0); + while i < bytes.len() && part < 3 { + match bytes[i] { + b'.' => part += 1, + b @ b'0'..=b'9' => parts[part] = parts[part] * 10 + (b - b'0') as u32, + _ => break, + } + i += 1; + } + parts[0] * 10000 + parts[1] * 100 + parts[2] +} + +#[derive(Clone, Debug, Default, PartialEq)] +pub struct Macros(BTreeMap); + +impl Macros { + /// The standard macros that need no renderer: `MC_VERSION` and this system's `MC_OS_*`. + /// The graphics ones arrive with the renderer. + pub fn standard() -> Self { + let mut m = Self::default(); + m.define("MC_VERSION", MC_VERSION.to_string()); + let os = match std::env::consts::OS { + "windows" => "MC_OS_WINDOWS", + "macos" => "MC_OS_MAC", + "linux" => "MC_OS_LINUX", + _ => "MC_OS_OTHER", + }; + m.define(os, ""); + m + } + + pub fn define(&mut self, name: impl Into, value: impl Into) { + self.0.insert(name.into(), value.into()); + } + + pub fn undef(&mut self, name: &str) { + self.0.remove(name); + } + + pub fn is_defined(&self, name: &str) -> bool { + self.0.contains_key(name) + } + + pub fn get(&self, name: &str) -> Option<&str> { + self.0.get(name).map(String::as_str) + } + + /// `text` with every identifier that names a macro replaced by its value, repeatedly; a macro + /// is not expanded again inside its own expansion, so `A` defined as `A + 1` stops. + pub fn expand(&self, text: &str) -> String { + self.expand_hiding(text, &mut Vec::new()) + } + + fn expand_hiding<'a>(&'a self, text: &str, hidden: &mut Vec<&'a str>) -> String { + let mut out = String::with_capacity(text.len()); + let mut rest = text; + while let Some(start) = rest.find(is_ident_start) { + out.push_str(&rest[..start]); + // A digit run glued to letters (`1e5`, `0x1F`) is a number, not a name. + let glued = out + .chars() + .next_back() + .is_some_and(|c| c.is_ascii_alphanumeric() || c == '.'); + let len = rest[start..] + .find(|c: char| !is_ident(c)) + .unwrap_or(rest.len() - start); + let word = &rest[start..start + len]; + match self.0.get_key_value(word) { + Some((name, value)) if !glued && !hidden.contains(&name.as_str()) => { + hidden.push(name); + out.push_str(&self.expand_hiding(value, hidden)); + hidden.pop(); + } + _ => out.push_str(word), + } + rest = &rest[start + len..]; + } + out.push_str(rest); + out + } +} + +pub(crate) fn is_ident_start(c: char) -> bool { + c.is_ascii_alphabetic() || c == '_' +} + +pub(crate) fn is_ident(c: char) -> bool { + c.is_ascii_alphanumeric() || c == '_' +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn versions_follow_the_documented_rule() { + assert_eq!(mc_version("1.21"), 12100); + assert_eq!(mc_version("1.21.0"), 12100); + assert_eq!(mc_version("1.7.10"), 10710); + assert_eq!(mc_version("26.3"), 260300); + assert_eq!(MC_VERSION, 260300); + assert_eq!(Macros::standard().get("MC_VERSION"), Some("260300")); + } + + #[test] + fn expansion_replaces_whole_words_and_stops_on_recursion() { + let mut m = Macros::default(); + m.define("RES", "SIZE"); + m.define("SIZE", "512"); + m.define("LOOP", "LOOP + 1"); + assert_eq!(m.expand("RES RES 0.5"), "512 512 0.5"); + assert_eq!( + m.expand("RESOLUTION colortex4 LOOP"), + "RESOLUTION colortex4 LOOP + 1" + ); + m.define("e5", "x"); + assert_eq!(m.expand("1e5"), "1e5"); + } +} From 397d529db72a17a1def83e1d7c50e9f866beb69e Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Sat, 24 Oct 2026 20:42:33 +0200 Subject: [PATCH 010/169] Shader packs, clean room 3: .properties files with conditional directives shaders.properties and the id files (block, item, entity, dimension): key=value lines in file order with their line numbers, # comments, a value continued on the next line by a trailing backslash, and the conditional directives evaluated with the standard and option macros. A # line is a directive only when its first word is one, so a commented-out key such as #ifdefault=1 stays a comment. #define and #undef apply to the lines after them in every one of these files: a public pack defines a macro inside #ifdef MC_OS_MAC in its shaders.properties and tests it further down. A later duplicate key replaces the earlier one; broken conditionals, lines that are not key=value and duplicates are kept as notes for the pack's log. Nothing uses it yet: players see no change. Co-Authored-By: Claude Opus 5.5 --- crates/horizon-shaders/src/lib.rs | 3 + crates/horizon-shaders/src/properties.rs | 279 +++++++++++++++++++++ crates/horizon-shaders/tests/real_packs.rs | 30 ++- 3 files changed, 305 insertions(+), 7 deletions(-) create mode 100644 crates/horizon-shaders/src/properties.rs diff --git a/crates/horizon-shaders/src/lib.rs b/crates/horizon-shaders/src/lib.rs index e7ccb26d6..bdfef7067 100644 --- a/crates/horizon-shaders/src/lib.rs +++ b/crates/horizon-shaders/src/lib.rs @@ -4,6 +4,7 @@ //! //! - [`Pack`]: a pack as a folder or a zip, with paths relative to its `shaders` folder (spec 1.1). //! - [`discover`]: the packs in a `shaderpacks` folder. +//! - [`Properties`]: `shaders.properties` and the id files, with their conditional directives (3.1, 1.5). //! - [`Lang`]: the pack's translated names (8.4). //! - [`Macros`] and [`eval_condition`]: the macros packs test, and the `#if` arithmetic (1.5). @@ -12,9 +13,11 @@ mod discover; mod lang; mod macros; mod pack; +mod properties; pub use condition::eval_condition; pub use discover::{Found, discover}; pub use lang::Lang; pub use macros::{MC_VERSION, Macros}; pub use pack::{Pack, PackError}; +pub use properties::{Entry, Note, Properties}; diff --git a/crates/horizon-shaders/src/properties.rs b/crates/horizon-shaders/src/properties.rs new file mode 100644 index 000000000..fc3f00c81 --- /dev/null +++ b/crates/horizon-shaders/src/properties.rs @@ -0,0 +1,279 @@ +//! `.properties` files: `shaders.properties` (spec 3.1) and the id files `block.properties`, +//! `item.properties`, `entity.properties` (4.1). `key=value` lines, `#` comments, a trailing `\` +//! continuing a value on the next line, and conditional directives evaluated with the +//! standard and option macros (1.5 item 2). `#define` and `#undef` work in every one of them: +//! a public pack defines a macro in its `shaders.properties` and tests it further down. +//! No other escape is read: values are names, numbers and expressions. A later duplicate key +//! replaces the earlier one, with a note. + +use crate::{Macros, eval_condition}; + +/// One `key=value`, with the line it starts on (from 1). +#[derive(Clone, Debug, PartialEq)] +pub struct Entry { + pub key: String, + pub value: String, + pub line: u32, +} + +/// Something wrong with a line, for the pack's log. +#[derive(Clone, Debug, PartialEq)] +pub struct Note { + pub line: u32, + pub message: String, +} + +#[derive(Debug, Default, PartialEq)] +pub struct Properties { + /// In file order; a key appears once (a later duplicate replaces the earlier one). + pub entries: Vec, + pub notes: Vec, +} + +/// One branch level of `#if` ... `#endif`. +struct Branch { + /// This branch's lines are read. + on: bool, + /// A branch of this `#if` was already taken (the rest are skipped). + taken: bool, + /// The enclosing level is read. + outer: bool, + seen_else: bool, +} + +impl Properties { + /// Reads `text`; `#define`/`#undef` change the macros for the lines after them only. + pub fn parse(text: &str, macros: &Macros) -> Self { + let mut out = Self::default(); + let mut macros = macros.clone(); + let mut branches: Vec = Vec::new(); + let mut lines = text.lines().zip(1u32..); + while let Some((raw, number)) = lines.next() { + let line = raw.trim(); + let on = branches.last().is_none_or(|b| b.on); + if let Some(directive) = line.strip_prefix('#') { + out.directive(directive.trim_start(), number, &mut branches, &mut macros); + continue; + } + // Continuation lines belong to their entry even inside a skipped branch. + let mut logical = line.to_owned(); + while ends_with_continuation(&logical) { + logical.pop(); + match lines.next() { + Some((next, _)) => logical.push_str(next.trim()), + None => break, + } + } + if !on || logical.is_empty() { + continue; + } + match logical.split_once('=') { + Some((key, value)) if !key.trim().is_empty() => out.insert(Entry { + key: key.trim().to_owned(), + value: value.trim().to_owned(), + line: number, + }), + _ => out.note(number, "not a key=value line"), + } + } + if !branches.is_empty() { + out.note(text.lines().count() as u32, "`#if` without `#endif`"); + } + out + } + + pub fn get(&self, key: &str) -> Option<&str> { + self.entry(key).map(|e| e.value.as_str()) + } + + pub fn entry(&self, key: &str) -> Option<&Entry> { + self.entries.iter().find(|e| e.key == key) + } + + fn insert(&mut self, entry: Entry) { + if let Some(at) = self.entries.iter().position(|e| e.key == entry.key) { + let first = self.entries.remove(at).line; + self.note( + entry.line, + &format!( + "`{}` is set again (first on line {first}); this one counts", + entry.key + ), + ); + } + self.entries.push(entry); + } + + fn note(&mut self, line: u32, message: &str) { + self.notes.push(Note { + line, + message: message.to_owned(), + }); + } + + /// A line starting with `#`. It is a directive only when its first word is one; anything + /// else (`# text`, `#commented.key=1`, `#ifdefault`) is a comment. + fn directive( + &mut self, + line: &str, + number: u32, + branches: &mut Vec, + macros: &mut Macros, + ) { + let word_len = line + .find(|c: char| !c.is_ascii_alphabetic()) + .unwrap_or(line.len()); + let (word, rest) = line.split_at(word_len); + if !(rest.is_empty() || rest.starts_with(char::is_whitespace) || rest.starts_with("//")) { + return; + } + let rest = rest.split("//").next().unwrap_or("").trim(); + let on = branches.last().is_none_or(|b| b.on); + match word { + "if" | "ifdef" | "ifndef" => { + let value = on && self.condition(word, rest, number, macros); + branches.push(Branch { + on: value, + taken: value, + outer: on, + seen_else: false, + }); + } + "elif" | "else" => { + let Some(b) = branches.last_mut() else { + return self.note(number, &format!("`#{word}` without `#if`")); + }; + if b.seen_else { + return self.note(number, &format!("`#{word}` after `#else`")); + } + let take = b.outer && !b.taken; + b.seen_else = word == "else"; + b.on = take && (word == "else" || self.condition("if", rest, number, macros)); + b.taken |= b.on; + } + "endif" => { + if branches.pop().is_none() { + self.note(number, "`#endif` without `#if`"); + } + } + "define" if on => { + let (name, value) = rest.split_once(char::is_whitespace).unwrap_or((rest, "")); + macros.define(name, value.trim()); + } + "undef" if on => macros.undef(rest), + _ => {} + } + } + + fn condition(&mut self, word: &str, rest: &str, number: u32, macros: &Macros) -> bool { + let name = rest.split_whitespace().next().unwrap_or(""); + let result = match word { + "ifdef" => Ok(macros.is_defined(name) as i64), + "ifndef" => Ok(!macros.is_defined(name) as i64), + _ => eval_condition(rest, macros), + }; + result.unwrap_or_else(|e| { + self.note(number, &format!("`#{word} {rest}`: {e}; read as false")); + 0 + }) != 0 + } +} + +/// An odd number of trailing backslashes: the last one joins the next line (`\\` is a literal). +fn ends_with_continuation(line: &str) -> bool { + line.bytes().rev().take_while(|&b| b == b'\\').count() % 2 == 1 +} + +#[cfg(test)] +mod tests { + use super::*; + + fn read(text: &str) -> Properties { + let mut m = Macros::standard(); + m.define("SHADOWS", ""); + m.define("QUALITY", "2"); + Properties::parse(text, &m) + } + + fn pairs(p: &Properties) -> Vec<(&str, &str)> { + p.entries + .iter() + .map(|e| (e.key.as_str(), e.value.as_str())) + .collect() + } + + #[test] + fn keys_values_and_comments() { + let p = + read("# a comment\n\n sun = false\n#commented.key=1\nscreen=A B [C]\r\nbad line\n"); + assert_eq!(pairs(&p), [("sun", "false"), ("screen", "A B [C]")]); + assert_eq!(p.entry("screen").unwrap().line, 5); + assert_eq!( + p.notes, + [Note { + line: 6, + message: "not a key=value line".into() + }] + ); + } + + #[test] + fn continuation_lines_join() { + let p = read("screen=A B \\\n C D\\\n E\nsliders=X\nliteral=a\\\\\nnext=1"); + assert_eq!( + pairs(&p), + [ + ("screen", "A B C DE"), + ("sliders", "X"), + ("literal", "a\\\\"), + ("next", "1") + ] + ); + assert_eq!(p.entry("sliders").unwrap().line, 4); + } + + #[test] + fn conditionals_pick_one_branch() { + let p = read( + "#if MC_VERSION >= 11300\nnew=1\n#else\nold=1\n#endif\n\ + #ifdef SHADOWS\n#if QUALITY == 1\nq=1\n#elif QUALITY == 2\nq=2\n#elif QUALITY >= 2\nq=3\n#endif\n#endif\n\ + #ifndef SHADOWS\nnone=1\n#elif 0\nnever=1\n#else\nfallback=1\n#endif\n# ifdef SHADOWS // trailing comment\nspaced=1\n#endif", + ); + assert_eq!( + pairs(&p), + [("new", "1"), ("q", "2"), ("fallback", "1"), ("spaced", "1")] + ); + assert!(p.notes.is_empty(), "{:?}", p.notes); + } + + #[test] + fn comment_lines_are_not_directives() { + let p = read("#ifdefault=1\n#iffy\n#endiff\n#else-where\nkey=1"); + assert_eq!(pairs(&p), [("key", "1")]); + assert!(p.notes.is_empty(), "{:?}", p.notes); + } + + #[test] + fn defines_apply_to_the_lines_after_them() { + let text = "#ifdef MC_OS_NONE\n#define WATER 0\n#endif\n#define WATER 8\n\ + #if WATER == 8\nblock.8=minecraft:water\n#endif\n#undef WATER\n#ifdef WATER\nno=1\n#endif"; + let p = Properties::parse(text, &Macros::default()); + assert_eq!(pairs(&p), [("block.8", "minecraft:water")]); + assert!(p.notes.is_empty(), "{:?}", p.notes); + } + + #[test] + fn duplicate_keys_keep_the_last() { + let p = read("a=1\nb=2\na=3"); + assert_eq!(pairs(&p), [("b", "2"), ("a", "3")]); + assert_eq!(p.notes[0].line, 3); + } + + #[test] + fn broken_conditionals_are_noted() { + let p = read("#endif\n#else\n#if 1 +\nx=1\n#endif\n#if 1\n#else\n#else\n"); + let lines: Vec = p.notes.iter().map(|n| n.line).collect(); + assert_eq!(lines, [1, 2, 3, 8, 8]); + assert!(p.entries.is_empty()); + } +} diff --git a/crates/horizon-shaders/tests/real_packs.rs b/crates/horizon-shaders/tests/real_packs.rs index b35aef519..e0ad38c25 100644 --- a/crates/horizon-shaders/tests/real_packs.rs +++ b/crates/horizon-shaders/tests/real_packs.rs @@ -5,7 +5,7 @@ use std::path::Path; use std::time::Instant; -use horizon_shaders::{Lang, Pack, discover}; +use horizon_shaders::{Lang, Macros, Pack, Properties, discover}; #[test] #[ignore = "needs HORIZON_TEST_SHADER_PACKS"] @@ -22,21 +22,37 @@ fn real_packs_read() { for f in found.iter().filter(|f| f.problem.is_none()) { let start = Instant::now(); let pack = Pack::open(&f.path).unwrap(); - let properties = pack.read_text("shaders.properties"); + let macros = Macros::standard(); + let shaders = Properties::parse( + &pack.read_text("shaders.properties").unwrap_or_default(), + ¯os, + ); + let ids: Vec = ["block", "item", "entity", "dimension"] + .iter() + .filter_map(|n| pack.read_text(&format!("{n}.properties"))) + .map(|t| Properties::parse(&t, ¯os)) + .collect(); let lang = Lang::load(&pack, "en_us"); + let elapsed = start.elapsed(); println!( - "{}: {} files at the root, shaders.properties {} bytes, lang {}, {:.2} ms", + "{}: shaders.properties {} keys ({} notes), {} id files {} keys ({} notes), lang {}, {:.2} ms", f.name, - pack.list("").len(), - properties.as_ref().map_or(0, String::len), + shaders.entries.len(), + shaders.notes.len(), + ids.len(), + ids.iter().map(|p| p.entries.len()).sum::(), + ids.iter().map(|p| p.notes.len()).sum::(), if lang == Lang::default() { "none" } else { "read" }, - start.elapsed().as_secs_f64() * 1000.0 + elapsed.as_secs_f64() * 1000.0 ); - assert!(properties.is_some(), "{}: no shaders.properties", f.name); + for n in &shaders.notes { + println!(" shaders.properties:{}: {}", n.line, n.message); + } + assert!(!shaders.entries.is_empty(), "{}: no keys read", f.name); read += 1; } assert!(read > 0, "no packs under {}", dir.display()); From f80d00802e54bfafccfbdb314ecf80d817fbd99c Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Sat, 24 Oct 2026 20:42:51 +0200 Subject: [PATCH 011/169] Server reference generated from horizon-server's source docs/api/server-reference.md lists horizon-server's commands (its help text), every server.toml key (config::TEMPLATE: default, the server.properties key it writes, what it does) and the control API's endpoints. Tests fail when the page is out of date (HORIZON_WRITE_DOCS=1 rewrites it), when the template and Config disagree on the keys, when a key has no comment, or when api::ROUTES and the endpoints route() answers differ. api::ROUTES replaces the endpoint list in api.rs's module comment and the hand-kept path list of the 405 arm. The template's uncommented keys get a comment (what init writes for new servers; no setting changes). Co-Authored-By: Claude Opus 5.5 --- .gitattributes | 1 + crates/horizon-server/src/api.rs | 112 ++++++++++++--- crates/horizon-server/src/config.rs | 16 +-- crates/horizon-server/src/main.rs | 2 + crates/horizon-server/src/reference.rs | 190 +++++++++++++++++++++++++ docs/api/server-reference.md | 137 ++++++++++++++++++ 6 files changed, 433 insertions(+), 25 deletions(-) create mode 100644 crates/horizon-server/src/reference.rs create mode 100644 docs/api/server-reference.md diff --git a/.gitattributes b/.gitattributes index 13584e4d9..358aeae7a 100644 --- a/.gitattributes +++ b/.gitattributes @@ -3,3 +3,4 @@ docs/launcher-commands.md text eol=lf docs/horizon-ctl-commands.md text eol=lf website/src/tokens.css text eol=lf +docs/api/*-reference.md text eol=lf diff --git a/crates/horizon-server/src/api.rs b/crates/horizon-server/src/api.rs index c9e553fab..3b0741e8a 100644 --- a/crates/horizon-server/src/api.rs +++ b/crates/horizon-server/src/api.rs @@ -2,17 +2,7 @@ //! `.horizon/api.json` that only the server's own user can read. The CLI manages a running server through //! it; the web panel and the MCP server will too. //! -//! - `GET /api/v1/status`: the supervisor's state, the game's status (TPS, MSPT, players), RAM and CPU. -//! - `GET /api/v1/logs?since=N`: the log lines after the Nth. -//! - `POST /api/v1/command {"line": "..."}`: a console command; the lines it logged. -//! - `POST /api/v1/stop`, `POST /api/v1/restart`. -//! - `GET /api/v1/metrics?since=T`: the samples taken after T (seconds since 1970), up to 10 minutes. -//! - `GET /api/v1/backups`; `POST /api/v1/backups {"name": "..."}` backs up now; `POST /api/v1/restore -//! {"name": "..."}` restarts the game with that backup's world. -//! - `POST /api/v1/update {"tag": "...", "timeout": seconds}`: restarts the game on that installed release, -//! and goes back to the one in use if it isn't up within the timeout; without a tag, downloads the newest -//! release first (update.rs). `GET /api/v1/status` says how it went (`update`). -//! - `POST /api/v1/panel/login`: a one-time login link for the web panel (with the token only). +//! Its routes are [`ROUTES`], listed in docs/api/server-reference.md. use crate::{ backup, @@ -41,6 +31,99 @@ const LOG_LINES: usize = 2000; /// The samples kept for the panel's graphs: 10 minutes, one a second. const METRICS: usize = 600; +/// One endpoint of the control API: what the reference (docs/api/server-reference.md) says about it. +#[cfg_attr(not(test), expect(dead_code, reason = "only the reference reads all of it"))] +pub struct Route { + pub method: &'static str, + pub path: &'static str, + /// The JSON body or query it takes, "" for none. + pub takes: &'static str, + /// The JSON it answers with. + pub answers: &'static str, + pub what: &'static str, +} + +/// Every endpoint `start` and [`route`] answer; a test checks the two agree. +pub const ROUTES: [Route; 11] = [ + Route { + method: "GET", + path: "/api/v1/status", + takes: "", + answers: "`phase`, `version`, `pid`, `uptime_seconds`, `engine_pid`, `engine_uptime_seconds`, `crashes`, `last_crash`, `sample` (TPS, MSPT, players, RAM, CPU), `update`", + what: "How the server does", + }, + Route { + method: "GET", + path: "/api/v1/metrics", + takes: "`?since=T` (seconds since 1970)", + answers: "`{\"samples\": [...]}`: one a second, the last 10 minutes", + what: "The samples taken after T, for graphs", + }, + Route { + method: "GET", + path: "/api/v1/logs", + takes: "`?since=N`", + answers: "`{\"next\": N, \"lines\": [...]}`", + what: "The log lines after the Nth (the last 2000 are kept)", + }, + Route { + method: "POST", + path: "/api/v1/command", + takes: "`{\"line\": \"\"}`", + answers: "the lines the command logged", + what: "Run a console command on the running game", + }, + Route { + method: "POST", + path: "/api/v1/stop", + takes: "", + answers: "`{\"ok\": true}`", + what: "Stop the game and the supervisor", + }, + Route { + method: "POST", + path: "/api/v1/restart", + takes: "", + answers: "`{\"ok\": true}`", + what: "Restart the game", + }, + Route { + method: "GET", + path: "/api/v1/backups", + takes: "", + answers: "`{\"backups\": [{\"name\", \"bytes\"}]}`", + what: "List the backups", + }, + Route { + method: "POST", + path: "/api/v1/backups", + takes: "`{\"name\": \"...\"}` (optional)", + answers: "`{\"name\": \"\"}`", + what: "Back up now (a running game saves first and stays up)", + }, + Route { + method: "POST", + path: "/api/v1/restore", + takes: "`{\"name\": \"\"}`", + answers: "`{\"name\": \"\"}`", + what: "Restart the game with that backup's world (the current one is kept in backups/)", + }, + Route { + method: "POST", + path: "/api/v1/update", + takes: "`{\"tag\": \"...\", \"timeout\": seconds}` (both optional)", + answers: "`{\"ok\": true}`; `status` says how it went (`update`)", + what: "Restart on that installed release, or download the newest first; goes back if the game isn't up within the timeout", + }, + Route { + method: "POST", + path: "/api/v1/panel/login", + takes: "", + answers: "`{\"url\": \"...\"}`", + what: "A one-time login link for the web panel (with the token only, not from the panel)", + }, +]; + /// What the supervisor is doing. #[derive(Clone, Copy, Debug, PartialEq, Eq)] pub enum Phase { @@ -488,12 +571,7 @@ pub fn route(shared: &Arc, request: &Request) -> Response { Err(e) => Response::error(409, &e), } } - ( - _, - "/api/v1/status" | "/api/v1/logs" | "/api/v1/command" | "/api/v1/stop" - | "/api/v1/restart" | "/api/v1/backups" | "/api/v1/restore" | "/api/v1/metrics" - | "/api/v1/update", - ) => Response::error(405, "wrong method"), + (_, path) if ROUTES.iter().any(|r| r.path == path) => Response::error(405, "wrong method"), _ => Response::error(404, "no such endpoint"), } } diff --git a/crates/horizon-server/src/config.rs b/crates/horizon-server/src/config.rs index 0a66b6fdf..32e2be79b 100644 --- a/crates/horizon-server/src/config.rs +++ b/crates/horizon-server/src/config.rs @@ -19,22 +19,22 @@ pub const TEMPLATE: &str = r##"# Horizon server settings (docs/server.md). The s # every start: edit this file, not that one. [server] -motd = "A Minecraft Server" -port = 25565 +motd = "A Minecraft Server" # the line under the server's name in the server list +port = 25565 # the port players connect to bind = "" # listen on every address, or only on this one (server-ip) -max_players = 20 +max_players = 20 # how many players can be online at once online_mode = true # check players' Minecraft accounts (false: anyone joins under any name) whitelist = true # only whitelisted players and operators can join enforce_whitelist = false # kick online players taken off the whitelist -view_distance = 10 -simulation_distance = 10 +view_distance = 10 # chunks sent around each player +simulation_distance = 10 # chunks around each player where mobs, crops and redstone tick [world] name = "world" # the world folder seed = "" # empty: a random seed on the first start game_mode = "survival" # survival, creative, adventure or spectator difficulty = "easy" # peaceful, easy, normal or hard -hardcore = false +hardcore = false # one life: a player who dies becomes a spectator # Any other server.properties key, spelled as vanilla spells it, for example: # spawn-protection = 16 @@ -43,7 +43,7 @@ hardcore = false [engine] path = "" # the game program; empty: the one installed beside horizon-server resources = "" # the prepared game files; empty: resources/ here, else the usual places -restart_on_crash = true +restart_on_crash = true # start the game again when it crashes [backups] every = "6h" # automatic backups while the server runs: 30m, 6h, 1d...; "0" turns them off @@ -58,7 +58,7 @@ allow_public = false # true lets bind be any address; never put the pane "##; /// Each typed setting: its section, its name, and the vanilla key it writes. -const TYPED: [(&str, &str, &str); 14] = [ +pub(crate) const TYPED: [(&str, &str, &str); 14] = [ ("server", "motd", "motd"), ("server", "port", "server-port"), ("server", "bind", "server-ip"), diff --git a/crates/horizon-server/src/main.rs b/crates/horizon-server/src/main.rs index b4512530c..0526bcd55 100644 --- a/crates/horizon-server/src/main.rs +++ b/crates/horizon-server/src/main.rs @@ -10,6 +10,8 @@ mod http; mod init; mod lists; mod panel; +#[cfg(test)] +mod reference; mod service; mod settings; mod signals; diff --git a/crates/horizon-server/src/reference.rs b/crates/horizon-server/src/reference.rs new file mode 100644 index 000000000..e8297565a --- /dev/null +++ b/crates/horizon-server/src/reference.rs @@ -0,0 +1,190 @@ +//! docs/api/server-reference.md: `horizon-server`'s commands, every `server.toml` key and the control API's +//! endpoints, generated from the source, and the tests that fail when it is out of date. Update it with: +//! `HORIZON_WRITE_DOCS=1 cargo test -p horizon-server reference`. + +use crate::{api::ROUTES, config}; +use std::fmt::Write; + +const DOC: &str = "docs/api/server-reference.md"; + +/// One `key = value # what it means` line of the template, under its `[section]`. +struct Key { + section: String, + name: String, + default: String, + what: String, +} + +/// The template's sections, each with the comment lines above it, and its keys, in order. +fn template() -> (Vec<(String, String)>, Vec) { + let (mut sections, mut keys, mut notes) = (Vec::new(), Vec::new(), Vec::<&str>::new()); + for line in config::TEMPLATE.lines().map(str::trim) { + if let Some(note) = line.strip_prefix('#') { + notes.push(note.trim()); + } else if let Some(section) = line.strip_prefix('[').and_then(|l| l.strip_suffix(']')) { + sections.push((section.to_owned(), notes.join(" "))); + notes.clear(); + } else if let Some((name, rest)) = line.split_once(" = ") { + let (default, what) = rest.split_once(" # ").unwrap_or((rest, "")); + keys.push(Key { + section: sections.last().map(|(s, _)| s.clone()).unwrap_or_default(), + name: name.trim().to_owned(), + default: default.trim().to_owned(), + what: what.trim().to_owned(), + }); + } + } + (sections, keys) +} + +pub fn markdown() -> String { + let mut out = String::new(); + let w = &mut out; + let _ = writeln!( + w, + "" + ); + let _ = writeln!(w, "# Server reference\n"); + let _ = writeln!( + w, + "Everything `horizon-server` offers a host or a tool: its commands, every `server.toml` key and the \ + control API. How to host: [hosting.md](../hosting.md); the design: [server.md](../server.md); \ + stability and versions: [stability.md](stability.md).\n" + ); + + let _ = writeln!(w, "## Commands\n\n`horizon-server help` prints:\n"); + let _ = writeln!(w, "```text\n{}```\n", crate::HELP); + + let _ = writeln!(w, "## `server.toml`\n"); + let (sections, keys) = template(); + let _ = writeln!( + w, + "{} Unknown keys are refused. `horizon-server init` writes this file with these defaults; \ + `horizon-server config set SECTION.KEY=VALUE` changes it.\n", + sections[0].1 + ); + for (i, (section, note)) in sections.iter().enumerate() { + let _ = writeln!(w, "### `[{section}]`\n"); + if i > 0 && !note.is_empty() { + let _ = writeln!(w, "{note}\n"); + } + let rows: Vec<&Key> = keys.iter().filter(|k| &k.section == section).collect(); + if rows.is_empty() { + continue; + } + let _ = writeln!( + w, + "| Key | Default | In `server.properties` | What it does |\n| --- | --- | --- | --- |" + ); + for k in rows { + let vanilla = config::TYPED + .iter() + .find(|(s, n, _)| s == section && *n == k.name) + .map_or(String::new(), |(_, _, v)| format!("`{v}`")); + let _ = writeln!( + w, + "| `{}` | `{}` | {vanilla} | {} |", + k.name, k.default, k.what + ); + } + let _ = writeln!(w); + } + + let _ = writeln!(w, "## Control API (`/api/v1`)\n"); + let _ = writeln!( + w, + "HTTP and JSON on 127.0.0.1. A running server writes its address and a random token to \ + `.horizon/api.json`, readable only by its own user; every request sends \ + `Authorization: Bearer ` and a `Host` that is that address. Errors answer \ + `{{\"error\": \"...\"}}` with 400, 401, 403, 404, 405 or 409. The web panel uses the same \ + routes with its session.\n" + ); + let _ = writeln!( + w, + "| Method | Path | Takes | Answers | What it does |\n| --- | --- | --- | --- | --- |" + ); + for r in &ROUTES { + let takes = if r.takes.is_empty() { + "nothing" + } else { + r.takes + }; + let _ = writeln!( + w, + "| `{}` | `{}` | {takes} | {} | {} |", + r.method, r.path, r.answers, r.what + ); + } + out +} + +#[test] +fn the_server_reference_is_up_to_date() { + let path = std::path::Path::new(env!("CARGO_MANIFEST_DIR")) + .join("../..") + .join(DOC); + let want = markdown(); + if std::env::var_os("HORIZON_WRITE_DOCS").is_some() { + std::fs::write(&path, &want).unwrap(); + } + let have = std::fs::read_to_string(&path) + .unwrap_or_default() + .replace("\r\n", "\n"); + assert!( + have == want, + "{DOC} is out of date: HORIZON_WRITE_DOCS=1 cargo test -p horizon-server reference" + ); +} + +/// The template, which the reference lists, holds every key `Config` reads and no other. +#[test] +fn the_reference_lists_every_setting() { + let config = toml::Value::try_from(config::Config::default()).unwrap(); + let mut listed: Vec = template() + .1 + .iter() + .map(|k| format!("{}.{}", k.section, k.name)) + .collect(); + let mut read: Vec = config + .as_table() + .unwrap() + .iter() + .filter_map(|(section, keys)| Some((section, keys.as_table()?))) + .flat_map(|(section, keys)| keys.keys().map(move |k| format!("{section}.{k}"))) + .collect(); + listed.sort(); + read.sort(); + assert_eq!(listed, read); + for key in template().1 { + assert!( + !key.what.is_empty(), + "{}.{} needs a `# what it does` comment in config::TEMPLATE", + key.section, + key.name + ); + } +} + +/// `ROUTES` holds exactly the endpoints the API's code answers. +#[test] +fn the_routes_table_matches_the_code() { + let source = include_str!("api.rs"); + let mut answered: Vec<(String, String)> = Vec::new(); + for method in ["GET", "POST"] { + let open = format!("(\"{method}\", \"/api/v1/"); + for (at, _) in source.match_indices(&open) { + let rest = &source[at + open.len()..]; + let path = &rest[..rest.find('"').unwrap()]; + if rest[path.len()..].starts_with("\")") { + answered.push((method.into(), format!("/api/v1/{path}"))); + } + } + } + let mut listed: Vec<(String, String)> = ROUTES + .iter() + .map(|r| (r.method.into(), r.path.into())) + .collect(); + answered.sort(); + listed.sort(); + assert_eq!(answered, listed); +} diff --git a/docs/api/server-reference.md b/docs/api/server-reference.md new file mode 100644 index 000000000..93fb9c7fe --- /dev/null +++ b/docs/api/server-reference.md @@ -0,0 +1,137 @@ + +# Server reference + +Everything `horizon-server` offers a host or a tool: its commands, every `server.toml` key and the control API. How to host: [hosting.md](../hosting.md); the design: [server.md](../server.md); stability and versions: [stability.md](stability.md). + +## Commands + +`horizon-server help` prints: + +```text +horizon-server: host a Horizon (Minecraft Java Edition 26.3) server + +Usage: horizon-server [--dir DIR] + + init Set up a server here: the EULA, the world, the port, who may join (asks, or takes flags: + --eula --world NAME --seed SEED --port N --whitelist/--no-whitelist --player NAME... --op NAME + --offline --yes) + run Run the server in the foreground; type console commands, Ctrl-C stops it cleanly. It + restarts the game if it crashes. + start Run the server in the background (its output goes to logs/supervisor.log) + stop, restart + status [--json] + Up or not, TPS, MSPT, players, RAM and CPU + cmd COMMAND... + Run a console command on the running server and print what it answers + logs [-f] [-n N] + The last N lines of the log (default 50); -f follows it + backup [NAME] + Zip the world and the settings into backups/ (a running server saves first and stays up) + backups [--json] + List the backups + restore BACKUP [--yes] + Put a backup's world in place (the current one is kept in backups/); a running + server restarts with it + service install|uninstall|print [--system] + Start the server at boot or login: a systemd unit on Linux (--system: for every user, + with sudo), a launchd agent on macOS, a task at logon on Windows + panel A one-time login link for the web panel ([panel] in server.toml; 127.0.0.1:8130 by + default) + update [--check [--json]] [--version TAG] [--timeout SECONDS] + Install the newest release (checked against GitHub's SHA-256), back up the world and + restart on it; goes back by itself if the game isn't up within the timeout (300 s). + --archive FILE --version NAME installs an archive you have + rollback Back to the release used before the update + config [--json] + The settings in server.toml + config set KEY=VALUE... [--json] + Change settings (for example world.difficulty=hard server.max_players=10), checked first; + a running server takes the difficulty, default game mode and whitelist at once, the rest + at its next start + import FILE Write server.toml from a vanilla server.properties + op NAME, deop NAME + whitelist on|off|list, whitelist add|remove NAME + Who may join (on the running server, or in the files when it is stopped) + + --dir DIR The server folder (default: the current folder) + +Settings live in server.toml; the server writes server.properties from it before every start. +``` + +## `server.toml` + +Horizon server settings (docs/server.md). The server writes them into server.properties before every start: edit this file, not that one. Unknown keys are refused. `horizon-server init` writes this file with these defaults; `horizon-server config set SECTION.KEY=VALUE` changes it. + +### `[server]` + +| Key | Default | In `server.properties` | What it does | +| --- | --- | --- | --- | +| `motd` | `"A Minecraft Server"` | `motd` | the line under the server's name in the server list | +| `port` | `25565` | `server-port` | the port players connect to | +| `bind` | `""` | `server-ip` | listen on every address, or only on this one (server-ip) | +| `max_players` | `20` | `max-players` | how many players can be online at once | +| `online_mode` | `true` | `online-mode` | check players' Minecraft accounts (false: anyone joins under any name) | +| `whitelist` | `true` | `white-list` | only whitelisted players and operators can join | +| `enforce_whitelist` | `false` | `enforce-whitelist` | kick online players taken off the whitelist | +| `view_distance` | `10` | `view-distance` | chunks sent around each player | +| `simulation_distance` | `10` | `simulation-distance` | chunks around each player where mobs, crops and redstone tick | + +### `[world]` + +| Key | Default | In `server.properties` | What it does | +| --- | --- | --- | --- | +| `name` | `"world"` | `level-name` | the world folder | +| `seed` | `""` | `level-seed` | empty: a random seed on the first start | +| `game_mode` | `"survival"` | `gamemode` | survival, creative, adventure or spectator | +| `difficulty` | `"easy"` | `difficulty` | peaceful, easy, normal or hard | +| `hardcore` | `false` | `hardcore` | one life: a player who dies becomes a spectator | + +### `[properties]` + +Any other server.properties key, spelled as vanilla spells it, for example: spawn-protection = 16 + +### `[engine]` + +| Key | Default | In `server.properties` | What it does | +| --- | --- | --- | --- | +| `path` | `""` | | the game program; empty: the one installed beside horizon-server | +| `resources` | `""` | | the prepared game files; empty: resources/ here, else the usual places | +| `restart_on_crash` | `true` | | start the game again when it crashes | + +### `[backups]` + +| Key | Default | In `server.properties` | What it does | +| --- | --- | --- | --- | +| `every` | `"6h"` | | automatic backups while the server runs: 30m, 6h, 1d...; "0" turns them off | +| `keep` | `12` | | automatic backups kept (backups made by hand are never deleted) | + +### `[updates]` + +| Key | Default | In `server.properties` | What it does | +| --- | --- | --- | --- | +| `keep` | `1` | | other releases kept by updates, besides the one in use and the one rollback goes to | + +### `[panel]` + +| Key | Default | In `server.properties` | What it does | +| --- | --- | --- | --- | +| `bind` | `"127.0.0.1:8130"` | | the web panel: this computer only, or a tailnet address (100.x); "" turns it off | +| `allow_public` | `false` | | true lets bind be any address; never put the panel on the open internet | + +## Control API (`/api/v1`) + +HTTP and JSON on 127.0.0.1. A running server writes its address and a random token to `.horizon/api.json`, readable only by its own user; every request sends `Authorization: Bearer ` and a `Host` that is that address. Errors answer `{"error": "..."}` with 400, 401, 403, 404, 405 or 409. The web panel uses the same routes with its session. + +| Method | Path | Takes | Answers | What it does | +| --- | --- | --- | --- | --- | +| `GET` | `/api/v1/status` | nothing | `phase`, `version`, `pid`, `uptime_seconds`, `engine_pid`, `engine_uptime_seconds`, `crashes`, `last_crash`, `sample` (TPS, MSPT, players, RAM, CPU), `update` | How the server does | +| `GET` | `/api/v1/metrics` | `?since=T` (seconds since 1970) | `{"samples": [...]}`: one a second, the last 10 minutes | The samples taken after T, for graphs | +| `GET` | `/api/v1/logs` | `?since=N` | `{"next": N, "lines": [...]}` | The log lines after the Nth (the last 2000 are kept) | +| `POST` | `/api/v1/command` | `{"line": ""}` | the lines the command logged | Run a console command on the running game | +| `POST` | `/api/v1/stop` | nothing | `{"ok": true}` | Stop the game and the supervisor | +| `POST` | `/api/v1/restart` | nothing | `{"ok": true}` | Restart the game | +| `GET` | `/api/v1/backups` | nothing | `{"backups": [{"name", "bytes"}]}` | List the backups | +| `POST` | `/api/v1/backups` | `{"name": "..."}` (optional) | `{"name": ""}` | Back up now (a running game saves first and stays up) | +| `POST` | `/api/v1/restore` | `{"name": ""}` | `{"name": ""}` | Restart the game with that backup's world (the current one is kept in backups/) | +| `POST` | `/api/v1/update` | `{"tag": "...", "timeout": seconds}` (both optional) | `{"ok": true}`; `status` says how it went (`update`) | Restart on that installed release, or download the newest first; goes back if the game isn't up within the timeout | +| `POST` | `/api/v1/panel/login` | nothing | `{"url": "..."}` | A one-time login link for the web panel (with the token only, not from the panel) | From 66235cc981d0b9cb4414260f31275e7dccfb085d Mon Sep 17 00:00:00 2001 From: levzzz <86072227+levzzz5154@users.noreply.github.com> Date: Sat, 24 Oct 2026 23:49:37 +0500 Subject: [PATCH 012/169] Let mobs ride boats, and make boats collide with and push entities A moving boat now stops at other boats, minecarts, mobs and players (AbstractBoat.canVehicleCollide), and on the server it pushes what it touches and is pushed back (AbstractBoat.push, LivingEntity.pushEntities). A boat no player steers picks up the mobs that touch it, two seats in a boat and one in a chest boat, with the player always in front (getPassengerAttachmentPoint, clampRotation). Mobs get out when the boat breaks or stays under water, are saved under the boat's Passengers, and are seated by the client, which is sent no passenger's position. A boat can't be placed where it would overlap an entity (BoatItem.use's noCollision), and the player sits at the raft's and chest boat's vanilla seat. A server player breaking a boat with a mob in it hits the boat. Co-Authored-By: Claude Opus 5.5 --- crates/horizon-client/src/collisions.rs | 24 + crates/horizon-client/src/game.rs | 1 + .../src/game/boat_passengers.rs | 440 ++++++++++++++++++ crates/horizon-client/src/game/boats.rs | 104 ++++- crates/horizon-client/src/game/lan_actions.rs | 14 + .../horizon-client/src/game/lan_vehicles.rs | 19 +- crates/horizon-client/src/game/minecarts.rs | 2 +- crates/horizon-client/src/game/passengers.rs | 31 +- crates/horizon-client/src/game/persist.rs | 142 +++--- crates/horizon-client/src/game/remote.rs | 3 + .../src/game/remote_vehicles.rs | 13 +- crates/horizon-client/src/mobs.rs | 6 +- crates/horizon-client/src/mobs/drops.rs | 3 +- docs/architecture.md | 2 +- 14 files changed, 712 insertions(+), 92 deletions(-) create mode 100644 crates/horizon-client/src/game/boat_passengers.rs diff --git a/crates/horizon-client/src/collisions.rs b/crates/horizon-client/src/collisions.rs index cfca854dc..3ff2cfdd6 100644 --- a/crates/horizon-client/src/collisions.rs +++ b/crates/horizon-client/src/collisions.rs @@ -133,6 +133,30 @@ impl> EntityMovementWorld for EntityCo border.collision_shape().map(Some).map_err(io::Error::other) } } +impl EntityCollisions<'_, SceneCollisions<'_, '_>> { + /// `SceneCollisions::resolve` that also stops at the entity boxes. + pub fn resolve( + &mut self, + bounds: Aabb, + movement: Vec3, + max_step: f32, + on_ground: bool, + ) -> Result { + let context = self.blocks.context(bounds); + Ok(resolve_world_movement( + self, + MovementRequest { + entity: EntityIdentity(0), + context, + bounds, + movement, + max_step, + on_ground, + candidate_budget: 1_000_000, + }, + )?) + } +} impl SceneCollisions<'_, '_> { /// Position contexts permit geometric movement probes without inventing a /// player, inventory, effects or fluid-standing behavior; a lava walker diff --git a/crates/horizon-client/src/game.rs b/crates/horizon-client/src/game.rs index 533973805..9ebfb13a8 100644 --- a/crates/horizon-client/src/game.rs +++ b/crates/horizon-client/src/game.rs @@ -13,6 +13,7 @@ mod block_entity_anims; mod block_entity_ticks; mod block_items; mod blockctl; +mod boat_passengers; mod boats; mod books; mod bossbars; diff --git a/crates/horizon-client/src/game/boat_passengers.rs b/crates/horizon-client/src/game/boat_passengers.rs new file mode 100644 index 000000000..f62381a1a --- /dev/null +++ b/crates/horizon-client/src/game/boat_passengers.rs @@ -0,0 +1,440 @@ +//! Boats and the entities around them: what a boat runs into +//! (`AbstractBoat.canVehicleCollide`), the pushes between a boat and what +//! touches it (`AbstractBoat.push`, `LivingEntity.pushEntities`), the mobs +//! it picks up (the end of `AbstractBoat.tick`), where they sit +//! (`positionRider`, `clampRotation`) and how they get out. +//! Saving them under the boat's `Passengers` lives in `persist.rs`. +use super::{Game, boats::Boat, lan_mobs::guest_bounds}; +use horizon_client::{ + camera::wrap_degrees, + mobs::{Mob, Species, Who, drops::is_animal, equine, riders}, + scoreboard::pushable_by, +}; +use horizon_core::geometry::{Aabb, Vec3}; + +/// `Entity.boardingCooldown` once a mob leaves its boat. +const BOARDING_COOLDOWN: i32 = 60; +/// `Player.DEFAULT_VEHICLE_ATTACHMENT`: how far below the seat a player's +/// feet are. +const PLAYER_RIDING_OFFSET: f64 = 0.6; + +/// `Entity.isVehicle`: a player or a mob rides it. +fn carries(m: &Mob) -> bool { + m.rider.is_some() || m.extra.rider.is_some() +} +/// `isPushable`, as `pushableBy` and `canVehicleCollide` ask it: +/// `Mob::pushable` plus the shulkers it leaves out (they take no push, but +/// count), less a ridden horse (`AbstractHorse.isPushable`). +fn pushable(m: &Mob) -> bool { + !m.removed + && (m.pushable() || m.species() == Species::Shulker && m.alive()) + && !(equine::is_equine(m.species()) && carries(m)) +} +/// Whether `Entity.push` moves the mob: it is pushable and carries no one. +fn moved_by_push(m: &Mob) -> bool { + !m.removed && m.pushable() && !carries(m) +} +/// `Entity.push(Entity)`: the push `other` gets from `this` (which takes the +/// opposite one), or None when they stand on nearly the same spot. +fn push_impulse(this: Vec3, other: Vec3) -> Option { + let (mut xa, mut za) = (other.x - this.x, other.z - this.z); + let mut dd = xa.abs().max(za.abs()); + if dd < f64::from(0.01_f32) { + return None; + } + dd = dd.sqrt(); + xa /= dd; + za /= dd; + let pow = (1.0 / dd).min(1.0); + let k = f64::from(0.05_f32); + Some(Vec3::new(xa * pow * k, 0.0, za * pow * k)) +} +/// `AbstractBoat.push`: another boat is pushed while it is lower than this +/// boat's top, anything else while its feet are no higher than the boat's. +fn boat_pushes(boat: Aabb, other: Aabb, other_is_boat: bool) -> bool { + if other_is_boat { + other.min_position().y < boat.max_position().y + } else { + other.min_position().y <= boat.min_position().y + } +} + +impl Game<'_> { + /// The players in boat `id`: the window's player (or the server player + /// acting as it) and the server's other players. + pub(super) fn boat_players(&self, id: u32) -> usize { + let guests = self.lan.as_ref().map_or(0, |h| { + h.hub + .guests + .iter() + .filter(|g| Some(g.conn) != self.lan_acting && g.vehicle == Some(id)) + .count() + }); + usize::from(self.riding == Some(id)) + guests + } + /// The mobs in boat `id`, in their seat order after the players + /// (`Entity.addPassenger` puts a player first). + pub(super) fn boat_mobs(&self, id: u32) -> Vec { + (0..self.mobs.len()) + .filter(|&j| { + let m = &self.mobs[j]; + m.extra.mount == Some(id) && !m.removed && m.alive() + }) + .collect() + } + /// `getPassengers().size()` of boat `id`. + pub(super) fn boat_passengers(&self, id: u32) -> usize { + self.boat_players(id) + self.boat_mobs(id).len() + } + /// `AbstractBoat.canAddPassenger`: a seat is free and the boat is not + /// under water. + pub(super) fn boat_has_room(&self, i: usize) -> bool { + let b = &self.boats[i]; + self.boat_passengers(b.id) < b.max_passengers() && !b.under_water() + } + /// Where the player in boat `i` sits: in the middle alone, in front of a + /// mob. + pub(super) fn player_boat_seat(&self, i: usize) -> Vec3 { + let b = &self.boats[i]; + let count = self.boat_players(b.id).max(1) + self.boat_mobs(b.id).len(); + b.seat(0, count, false, PLAYER_RIDING_OFFSET, false) + } + /// `getRootVehicle` of mob `j`: the mob or boat at the bottom of what it + /// rides, None when it rides nothing. + fn mob_root_vehicle(&self, mut j: usize) -> Option { + let mut root = None; + for _ in 0..8 { + let Some(v) = self.mobs[j].extra.mount else { + break; + }; + root = Some(v); + match self.mobs.iter().position(|m| m.id == v) { + Some(k) => j = k, + None => break, + } + } + root + } + /// The players outside boat `id` that push and block it (living, not + /// spectators), with the window player's team. + fn players_outside(&self, id: u32) -> Vec<(Aabb, bool)> { + let mut out = Vec::new(); + if let Some(p) = self.player.as_ref() + && self.riding != Some(id) + && !self.spectator() + && !p.health.dead_or_dying() + { + out.push((p.bounds(), true)); + } + if let Some(host) = self.lan.as_ref() { + for g in host.hub.guests.iter().filter(|g| { + Some(g.conn) != self.lan_acting + && host.hub.here(g) + && g.loaded + && !g.dead + && !g.spectator() + && g.vehicle != Some(id) + }) { + out.push((guest_bounds(g), false)); + } + } + out + } + /// `getEntityCollisions` of boat `id` within `area`, with + /// `AbstractBoat.canVehicleCollide`: the other boats, minecarts, + /// shulkers and pushable mobs and players, but not its own passengers. + pub(super) fn boat_obstacles(&self, id: u32, area: Aabb) -> Vec { + let mut out: Vec = (0..self.mobs.len()) + .filter(|&j| { + let m = &self.mobs[j]; + pushable(m) + && m.bounds().intersects(area) + && (m.extra.mount.is_none() || self.mob_root_vehicle(j) != Some(id)) + }) + .map(|j| self.mobs[j].bounds()) + .collect(); + out.extend( + self.boats + .iter() + .filter(|b| b.id != id) + .map(Boat::bounds) + .chain(self.carts.iter().map(|c| c.bounds())) + .chain(self.players_outside(id).into_iter().map(|(bb, _)| bb)) + .filter(|bb| bb.intersects(area)), + ); + out + } + /// What boat `b` may run into this tick. + pub(super) fn boat_move_obstacles(&self, b: &Boat) -> Vec { + let reach = b.velocity.length() + 1.0; + self.boat_obstacles(b.id, b.bounds().inflate(Vec3::new(reach, reach, reach))) + } + /// `noEntityCollision(boat, box)` for a new boat (`BoatItem.use`). + pub(super) fn boat_entity_collision(&self, bb: Aabb) -> bool { + // EntityGetter.getEntityCollisions: the box grown by 1e-7. + let area = bb.inflate(Vec3::new(1.0e-7, 1.0e-7, 1.0e-7)); + !self.boat_obstacles(u32::MAX, area).is_empty() + } + + /// The end of `AbstractBoat.tick` on the server for boat `i`: each + /// entity it touches gets in (a mob, while no player steers) or is + /// pushed apart from it, and `LivingEntity.pushEntities` of each mob and + /// player touching it pushes the two apart once more. The player's own + /// share of a push only reaches the server's copy of it, which its + /// client never feels, so players are not moved here. + pub(super) fn boat_contacts(&mut self, i: usize) { + let (id, bb, max) = { + let b = &self.boats[i]; + (b.id, b.bounds(), b.max_passengers()) + }; + let area = bb.inflate(Vec3::new( + f64::from(0.2_f32), + f64::from(-0.01_f32), + f64::from(0.2_f32), + )); + let mut count = self.boat_passengers(id); + // getControllingPassenger is a player: one rides it (players sit first). + let pick_up = self.boat_players(id) == 0 && !self.boats[i].under_water(); + // (mob, touched by the boat's sweep, its own pushEntities reaches the boat) + let teams = self.mob_teams(); + let mobs: Vec<(usize, bool, bool)> = (0..self.mobs.len()) + .filter_map(|j| { + let m = &self.mobs[j]; + if !pushable(m) || m.extra.mount.is_some() && self.mob_root_vehicle(j) == Some(id) { + return None; + } + let mb = m.bounds(); + let team = teams.of(Who::Mob(m.id)); + let touched = mb.intersects(area) && pushable_by(None, team, true); + // Bats push nothing (Bat.pushEntities). + let pushes = m.species() != Species::Bat + && mb.intersects(bb) + && pushable_by(team, None, true); + (touched || pushes).then_some((j, touched, pushes)) + }) + .collect(); + let player_team = teams.of(Who::Player); + let players: Vec<(Aabb, bool, bool)> = self + .players_outside(id) + .into_iter() + .map(|(pb, own)| { + let team = if own { player_team } else { None }; + ( + pb, + pb.intersects(area) && pushable_by(None, team, true), + pb.intersects(bb) && pushable_by(team, None, true), + ) + }) + .collect(); + drop(teams); + for (j, touched, pushes) in mobs { + if touched { + let m = &self.mobs[j]; + let boards = pick_up + && count < max + && m.extra.mount.is_none() + && m.width() < super::boats::WIDTH as f32 + && !self + .res + .mob_data() + .entity_has("minecraft:cannot_be_pushed_onto_boats", &m.kind.id); + if boards { + // Entity.canRide: not while its boarding cooldown runs. + if m.extra.boarding_cooldown <= 0 { + let m = &mut self.mobs[j]; + m.extra.mount = Some(id); + m.extra.passenger = true; + m.ai.nav.stop(); + count += 1; + } + continue; + } + self.boat_push_mob(i, j, count); + } + if pushes { + self.boat_push_mob(i, j, count); + } + } + for (pb, touched, pushes) in players { + for _ in 0..usize::from(touched) + usize::from(pushes) { + let b = &mut self.boats[i]; + if count == 0 + && boat_pushes(bb, pb, false) + && let Some(v) = push_impulse(b.position, pb.center()) + { + b.velocity = b.velocity.subtract(v); + } + } + } + for k in 0..self.boats.len() { + let ob = self.boats[k].bounds(); + if k == i || !ob.intersects(area) || !boat_pushes(bb, ob, true) { + continue; + } + let Some(v) = push_impulse(self.boats[i].position, self.boats[k].position) else { + continue; + }; + if count == 0 { + self.boats[i].velocity = self.boats[i].velocity.subtract(v); + } + if self.boat_passengers(self.boats[k].id) == 0 { + self.boats[k].velocity = self.boats[k].velocity.add_vector(v); + } + } + let guest_carts = self.guest_vehicles(); + for c in 0..self.carts.len() { + let cb = self.carts[c].bounds(); + if !cb.intersects(area) || !boat_pushes(bb, cb, false) { + continue; + } + let Some(v) = push_impulse(self.boats[i].position, self.carts[c].position) else { + continue; + }; + if count == 0 { + self.boats[i].velocity = self.boats[i].velocity.subtract(v); + } + let cid = self.carts[c].id; + let ridden = self.riding == Some(cid) + || guest_carts.contains(&cid) + || self.mobs.iter().any(|m| m.extra.mount == Some(cid)); + if !ridden { + self.carts[c].velocity = self.carts[c].velocity.add_vector(v); + } + } + } + /// `AbstractBoat.push(mob)` from boat `i`, which has `count` passengers. + fn boat_push_mob(&mut self, i: usize, j: usize, count: usize) { + let (b, m) = (&self.boats[i], &self.mobs[j]); + if !boat_pushes(b.bounds(), m.bounds(), false) { + return; + } + let Some(v) = push_impulse(b.position, m.position) else { + return; + }; + if count == 0 { + let b = &mut self.boats[i]; + b.velocity = b.velocity.subtract(v); + } + let m = &mut self.mobs[j]; + if moved_by_push(m) { + m.velocity = m.velocity.add_vector(v); + m.needs_sync = true; + } + } + + /// `positionRider` and `clampRotation` for the mobs in boats: each sits + /// in its seat facing the way the boat does, an animal in a full boat + /// sideways, its head kept within its reach of its body. + pub(super) fn seat_boat_mobs(&mut self) { + for i in 0..self.boats.len() { + let id = self.boats[i].id; + let mobs = self.boat_mobs(id); + if mobs.is_empty() { + continue; + } + let players = self.boat_players(id); + let count = players + mobs.len(); + let b = &self.boats[i]; + let full = count == b.max_passengers(); + let delta = b.delta_rotation; + let seats: Vec<_> = mobs + .iter() + .enumerate() + .map(|(n, &j)| { + let m = &self.mobs[j]; + let animal = is_animal(m.species()); + // Another player, on a server's client. + let offset = if &*m.kind.id == "minecraft:player" { + PLAYER_RIDING_OFFSET + } else { + riders::vehicle_attachment(m) + }; + let index = players + n; + // calculatePassengerBodyYRot. + let turn = match (animal && full, m.id.is_multiple_of(2)) { + (false, _) => 0.0, + (true, true) => 90.0, + (true, false) => 270.0, + }; + let turns = !self + .res + .mob_data() + .entity_has("minecraft:can_turn_in_boats", &m.kind.id); + ( + j, + b.seat(index, count, animal, offset, false), + b.seat(index, count, animal, offset, true), + turns.then_some((b.yaw + turn, b.previous_yaw + turn)), + ) + }) + .collect(); + for (j, at, previous, facing) in seats { + let m = &mut self.mobs[j]; + m.position = at; + m.previous = previous; + m.velocity = Vec3::ZERO; + m.fall_distance = 0.0; + m.on_ground = false; + m.extra.passenger = true; + m.ai.nav.stop(); + let Some((body, previous_body)) = facing else { + continue; + }; + m.head_yaw += delta; + m.body_yaw = body; + m.previous_body_yaw = previous_body; + m.yaw = body; + m.previous_yaw = previous_body; + // Mob.clampHeadRotationToBody. + let limit = m.kind.max_head_y_rot; + let d = wrap_degrees(body - m.head_yaw); + m.head_yaw += d - d.clamp(-limit, limit); + } + } + } + /// `ejectPassengers` for the mobs in boat `i`: each gets out where + /// `getDismountLocationForPassenger` puts it (beside the boat when it + /// broke: `LivingEntity.dismountVehicle`) and can't board for a while. + pub(super) fn eject_boat_mobs(&mut self, i: usize, broken: bool) { + let b = &self.boats[i]; + let (id, y) = (b.id, b.position.y); + for j in self.boat_mobs(id) { + let m = &self.mobs[j]; + let at = if broken { + Vec3::new(m.position.x, m.position.y.max(y), m.position.z) + } else { + self.boat_dismount_target(i, f64::from(m.width()), m.yaw) + }; + let m = &mut self.mobs[j]; + m.extra.mount = None; + m.extra.passenger = false; + m.extra.boarding_cooldown = BOARDING_COOLDOWN; + m.position = at; + m.previous = at; + } + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn push_is_capped_and_scaled() { + // One block apart on x: the full 0.05 along x. + let v = push_impulse(Vec3::ZERO, Vec3::new(1.0, 0.0, 0.0)).unwrap(); + assert!((v.x - f64::from(0.05_f32)).abs() < 1e-12 && v.z == 0.0); + // Almost on the same spot: no push. + assert!(push_impulse(Vec3::ZERO, Vec3::new(0.005, 0.0, 0.0)).is_none()); + } + + #[test] + fn boats_push_by_height() { + let boat = Aabb::new(Vec3::new(0.0, 64.0, 0.0), Vec3::new(1.0, 64.5625, 1.0)); + let at = |y: f64| Aabb::new(Vec3::new(0.0, y, 0.0), Vec3::new(1.0, y + 1.0, 1.0)); + assert!(boat_pushes(boat, at(64.0), false)); + assert!(!boat_pushes(boat, at(64.1), false)); + assert!(boat_pushes(boat, at(64.5), true)); + assert!(!boat_pushes(boat, at(64.5625), true)); + } +} diff --git a/crates/horizon-client/src/game/boats.rs b/crates/horizon-client/src/game/boats.rs index bc9afd18b..9f1341599 100644 --- a/crates/horizon-client/src/game/boats.rs +++ b/crates/horizon-client/src/game/boats.rs @@ -5,10 +5,10 @@ use super::{Game, Keys, entity_culling::at, view_vector}; use horizon_client::{ blocks::Fluid, - collisions::SceneCollisions, + collisions::{EntityCollisions, SceneCollisions}, items::ItemStack, mesher::Vertex, - mobs::{Part, anim::Poses}, + mobs::{Part, anim::Poses, riders}, }; use horizon_core::{ geometry::{Aabb, Vec3}, @@ -54,10 +54,8 @@ pub(super) struct Boat { } /// `ChestBoat.CONTAINER_SIZE`. pub(super) const CHEST_SLOTS: usize = 27; -const WIDTH: f64 = 1.375; +pub(super) const WIDTH: f64 = 1.375; const HEIGHT: f64 = 0.5625; -/// Player.DEFAULT_VEHICLE_ATTACHMENT minus the boat's passenger attachment. -pub(super) const SEAT: f64 = 0.1875 - 0.6; impl Boat { pub fn new(id: u32, wood: Arc, position: Vec3, yaw: f32) -> Self { Self { @@ -98,6 +96,53 @@ impl Boat { Vec3::new(p.x + w, p.y + HEIGHT, p.z + w), ) } + /// Under water or flowing water (`isEyeInFluid(WATER)` for its seats). + pub fn under_water(&self) -> bool { + matches!(self.status, Status::UnderWater | Status::UnderFlowingWater) + } + /// `getMaxPassengers`: two, one beside a chest. + pub fn max_passengers(&self) -> usize { + if self.chest { 1 } else { 2 } + } + /// `rideHeight`: a third of a boat's height, 8/9 of a raft's. + fn ride_height(&self) -> f64 { + let height = HEIGHT as f32; + f64::from(if &*self.wood == "bamboo" { + height * 0.888_888_9 + } else { + height / 3.0 + }) + } + /// Where the passenger at `index` of `count` stands, at the boat's current + /// (or, with `previous`, last) place: `getPassengerAttachmentPoint` + /// turned with the boat, less the passenger's `rider_offset`. + pub fn seat( + &self, + index: usize, + count: usize, + animal: bool, + rider_offset: f64, + previous: bool, + ) -> Vec3 { + let mut z = if self.chest { 0.15f32 } else { 0.0 }; + if count > 1 { + z = if index == 0 { 0.2 } else { -0.6 }; + if animal { + z += 0.2; + } + } + let (at, yaw) = if previous { + (self.previous, self.previous_yaw) + } else { + (self.position, self.yaw) + }; + riders::seat( + [0.0, self.ride_height(), f64::from(z)], + rider_offset, + at, + yaw, + ) + } /// `getRowingTime`. pub fn rowing_time(&self, side: usize, a: f32) -> f32 { if self.paddling[side] { @@ -320,6 +365,7 @@ impl Game<'_> { let mut vspeed = -0.04; let mut buoyancy = 0.0; let inv_friction: f32; + let obstacles = self.boat_move_obstacles(&b); let mut scene = SceneCollisions { world: &self.world, binding: self.collision, @@ -401,6 +447,11 @@ impl Game<'_> { b.paddling = [right && !left || up, left && !right || up]; } // Entity.move: collisions zero the blocked components. + let mut scene = EntityCollisions { + blocks: scene, + entities: &obstacles, + border: None, + }; if let Ok(moved) = scene.resolve(b.bounds(), b.velocity, 0.0, b.on_ground) { b.position = Vec3::new( b.position.x + moved.x, @@ -477,6 +528,19 @@ impl Game<'_> { i += 1; } } + // The rest of AbstractBoat.tick on the server, for every boat: the + // passengers of one under water too long get out, and it picks up or + // pushes what it touches. + for i in 0..self.boats.len() { + let p = self.boats[i].position; + if !ticking(p.x.floor() as i32, p.z.floor() as i32) { + continue; + } + if self.boats[i].out_of_control >= 60.0 { + self.eject_boat_mobs(i, false); + } + self.boat_contacts(i); + } } /// `LavaFluid.entityInside` (`lavaHurt`) from the two /// `applyEffectsFromBlocks` calls in `AbstractBoat.tick`: twice 40 @@ -540,13 +604,14 @@ impl Game<'_> { self.yaw += b.delta_rotation; let delta = (self.yaw - b.yaw + 180.0).rem_euclid(360.0) - 180.0; self.yaw += delta.clamp(-105.0, 105.0) - delta; + self.boats[i] = b; + let seat = self.player_boat_seat(i); if let Some(p) = self.player.as_mut() { self.previous_position = p.position; - p.position = Vec3::new(b.position.x, b.position.y + SEAT, b.position.z); + p.position = seat; p.velocity = Vec3::ZERO; p.fall_distance = 0.0; } - self.boats[i] = b; if self.boat_lava_tick(i) { self.riding = None; } @@ -556,9 +621,18 @@ impl Game<'_> { /// floor there, else on top of the boat. pub(super) fn dismount(&mut self, i: usize) { self.riding = None; + let target = self.boat_dismount_target(i, 0.6, self.yaw); + if let Some(p) = self.player.as_mut() { + p.position = target; + p.velocity = Vec3::ZERO; + } + } + /// `getDismountLocationForPassenger` for a passenger `width` wide + /// facing `yaw`. + pub(super) fn boat_dismount_target(&self, i: usize, width: f64, yaw: f32) -> Vec3 { let b = &self.boats[i]; - let r = self.yaw.to_radians(); - let distance = (WIDTH * std::f64::consts::SQRT_2 + 0.6 + 1.0e-5) / 2.0; + let r = yaw.to_radians(); + let distance = (WIDTH * std::f64::consts::SQRT_2 + width + 1.0e-5) / 2.0; let (s, c) = (-(r.sin()) as f64, r.cos() as f64); let m = s.abs().max(c.abs()); let (x, z) = ( @@ -569,17 +643,13 @@ impl Game<'_> { let (bx, by, bz) = (x.floor() as i32, top.floor() as i32, z.floor() as i32); let below = self.res.facts().get(self.world.block(bx, by - 1, bz)); let here = self.res.facts().get(self.world.block(bx, by, bz)); - let target = if below.fluid != Fluid::Water + if below.fluid != Fluid::Water && !here.full_collision && (below.full_collision || below.legacy_solid) { Vec3::new(x, f64::from(by), z) } else { Vec3::new(b.position.x, top, b.position.z) - }; - if let Some(p) = self.player.as_mut() { - p.position = target; - p.velocity = Vec3::ZERO; } } /// `BoatItem.use`: aim at a block or the water surface. @@ -656,7 +726,7 @@ impl Game<'_> { binding: self.collision, subject: None, }; - if !scene.unobstructed(inner).unwrap_or(false) { + if !scene.unobstructed(inner).unwrap_or(false) || self.boat_entity_collision(bb) { return false; } self.next_entity += 1; @@ -711,7 +781,7 @@ impl Game<'_> { return false; } // ChestBoat.interact: sneaking (or a full seat) opens the chest. - if self.boats[i].chest && (sneaking || self.riding.is_some()) { + if self.boats[i].chest && (sneaking || self.riding.is_some() || !self.boat_has_room(i)) { let b = &self.boats[i]; let key = (i32::MAX - 15, super::minecarts::CART_KEY_Y, b.id as i32); self.world.block_entities.insert( @@ -728,6 +798,7 @@ impl Game<'_> { || self.boats[i].out_of_control >= 60.0 || self.riding.is_some() || self.ridden_by_guest(self.boats[i].id) + || !self.boat_has_room(i) { return false; } @@ -758,6 +829,7 @@ impl Game<'_> { b.damage += damage * 10.0; let destroyed = creative || b.damage > 40.0; if destroyed { + self.eject_boat_mobs(i, true); let b = self.boats.remove(i); let at = [b.position.x, b.position.y, b.position.z]; if !creative && self.ui.rules.bool("entity_drops") { diff --git a/crates/horizon-client/src/game/lan_actions.rs b/crates/horizon-client/src/game/lan_actions.rs index 5bee2af96..1fcb05249 100644 --- a/crates/horizon-client/src/game/lan_actions.rs +++ b/crates/horizon-client/src/game/lan_actions.rs @@ -1277,10 +1277,24 @@ impl Game<'_> { id: i32, location: Option<[f64; 3]>, ) -> Option<([f64; 3], [f64; 3])> { + let eye = { + let g = &host.hub.guests[gi]; + [g.position[0], g.position[1] + g.eye_height(), g.position[2]] + }; let object = || { let (lo, hi, origin) = self.object_target(id)?; let middle = [0, 1, 2].map(|k| (lo[k] + hi[k]) / 2.0); let Some(l) = location else { + // A boat's mobs sit over its middle: aim low at its near + // side, so the ray meets the boat before them (the server + // attacks the entity it is sent). + let carries = u32::try_from(id).is_ok_and(|v| { + self.boats.iter().any(|b| b.id == v) && !self.boat_mobs(v).is_empty() + }); + if carries { + let near = |k: usize| eye[k].clamp(lo[k] + 0.01, hi[k] - 0.01); + return Some([near(0), lo[1] + 0.05, near(2)]); + } return Some(middle); }; let point = [0, 1, 2].map(|k| origin[k] + l[k]); diff --git a/crates/horizon-client/src/game/lan_vehicles.rs b/crates/horizon-client/src/game/lan_vehicles.rs index 71e9936a5..f16a1e37d 100644 --- a/crates/horizon-client/src/game/lan_vehicles.rs +++ b/crates/horizon-client/src/game/lan_vehicles.rs @@ -9,7 +9,7 @@ //! here with the rider's input (`ServerPlayer.getLastClientMoveIntent`). //! Sneaking gets out (`Player.rideTick`: `wantsToStopRiding`), and the client //! is teleported where the player lands (`ServerPlayer.dismountTo`). -use super::{Game, Keys, boats::SEAT, lan::LanHost}; +use super::{Game, Keys, lan::LanHost, minecarts::SEAT}; use horizon_client::collisions::SceneCollisions; use horizon_core::geometry::{Aabb, Vec3}; use horizon_protocol::{ @@ -120,8 +120,8 @@ impl Game<'_> { game.dismount(i); return None; } - let p = game.boats[i].position; - return Some([p.x, p.y + SEAT, p.z]); + let p = game.player_boat_seat(i); + return Some([p.x, p.y, p.z]); } // The minecart moves with the rider's input, and lets it out when // it sneaks or the cart breaks. An animal takes the rider's input @@ -161,19 +161,19 @@ impl Game<'_> { let at = self .boats .iter() - .find(|b| b.id == vehicle) - .map(|b| b.position) + .position(|b| b.id == vehicle) + .map(|i| (self.boats[i].position, self.player_boat_seat(i))) .or_else(|| { self.carts .iter() .find(|c| c.id == vehicle) - .map(|c| c.position) + .map(|c| (c.position, c.position.add_vector(Vec3::new(0.0, SEAT, 0.0)))) }); - if let Some(p) = at { + if let Some((p, seat)) = at { let g = &mut host.hub.guests[gi]; g.vehicle_good = Some([p.x, p.y, p.z]); g.previous_position = g.position; - g.position = [p.x, p.y + SEAT, p.z]; + g.position = [seat.x, seat.y, seat.z]; g.on_ground = false; return; } @@ -289,10 +289,11 @@ impl Game<'_> { b.previous_yaw = b.yaw; b.yaw = p.yaw; b.on_ground = p.on_ground; + let seat = self.player_boat_seat(i); let g = &mut host.hub.guests[gi]; g.vehicle_good = Some([target.x, target.y, target.z]); g.previous_position = g.position; - g.position = [target.x, target.y + SEAT, target.z]; + g.position = [seat.x, seat.y, seat.z]; } /// `handlePaddleBoat`: the paddles of the boat the player drives. diff --git a/crates/horizon-client/src/game/minecarts.rs b/crates/horizon-client/src/game/minecarts.rs index 0b58e4f88..6b8b51dde 100644 --- a/crates/horizon-client/src/game/minecarts.rs +++ b/crates/horizon-client/src/game/minecarts.rs @@ -95,7 +95,7 @@ fn display_offset(kind: CartKind) -> f64 { if kind == CartKind::Hopper { 1.0 } else { 6.0 } } /// The minecart's passenger attachment minus Player.DEFAULT_VEHICLE_ATTACHMENT. -const SEAT: f64 = 0.1875 - 0.6; +pub(super) const SEAT: f64 = 0.1875 - 0.6; /// The placeholder container key under which an open cart's items live. pub(super) const CART_KEY_Y: i32 = -100_000; diff --git a/crates/horizon-client/src/game/passengers.rs b/crates/horizon-client/src/game/passengers.rs index 4e6ba339d..b20c1560b 100644 --- a/crates/horizon-client/src/game/passengers.rs +++ b/crates/horizon-client/src/game/passengers.rs @@ -38,9 +38,16 @@ impl Game<'_> { m.extra.rider = Some(rider); } } - /// Riders sit on their vehicles (`Entity.positionRider`), and let go when - /// the vehicle dies or is gone. + /// Riders sit on their vehicles (`Entity.positionRider`), mobs or boats, + /// and let go when the vehicle dies or is gone. pub(super) fn sync_riders(&mut self) { + // Entity.baseTick. + for m in &mut self.mobs { + if m.extra.boarding_cooldown > 0 { + m.extra.boarding_cooldown -= 1; + } + } + let boats: std::collections::HashSet = self.boats.iter().map(|b| b.id).collect(); let index: HashMap = self .mobs .iter() @@ -54,9 +61,10 @@ impl Game<'_> { }; let valid = self.mobs[i].alive() && !self.mobs[i].removed - && index - .get(&v) - .is_some_and(|&j| self.mobs[j].alive() && !self.mobs[j].removed); + && (boats.contains(&v) + || index + .get(&v) + .is_some_and(|&j| self.mobs[j].alive() && !self.mobs[j].removed)); if valid { riding.insert(v, self.mobs[i].id); } else { @@ -68,6 +76,19 @@ impl Game<'_> { for m in &mut self.mobs { m.extra.rider = riding.get(&m.id).copied(); } + self.position_riders(); + } + /// `Entity.positionRider` for every mob passenger: in its boat, then on + /// its mob. A server's client places them itself too, as the server sends + /// no passenger's position. + pub(super) fn position_riders(&mut self) { + self.seat_boat_mobs(); + let index: HashMap = self + .mobs + .iter() + .enumerate() + .map(|(i, m)| (m.id, i)) + .collect(); // Riders of riders settle over a few passes. for _ in 0..3 { for i in 0..self.mobs.len() { diff --git a/crates/horizon-client/src/game/persist.rs b/crates/horizon-client/src/game/persist.rs index eb30ab5ed..ad9d7fe7e 100644 --- a/crates/horizon-client/src/game/persist.rs +++ b/crates/horizon-client/src/game/persist.rs @@ -243,6 +243,8 @@ impl Game<'_> { .is_some_and(|(wood, chest)| self.boat_models.has(wood, chest)) => { if let Some((position, velocity, yaw)) = entity_nbt::boat_from_nbt(&tag) { + let mut tag = tag; + let riders = self.take_mob_passengers(&mut tag); self.next_entity += 1; let id = self.next_entity; let (wood, chest) = @@ -263,6 +265,9 @@ impl Game<'_> { b.velocity = velocity; self.remember(id, uuid, tag); self.boats.push(b); + for rider in riders { + self.load_mob(rider, Some(id)); + } } } k if super::minecarts::CartKind::from_id(k).is_some() => { @@ -341,25 +346,10 @@ impl Game<'_> { // Structure entities placed with finalizeEntities. let mut tag = tag; let mut finalize = false; - let mut riders = Vec::new(); - let mut unknown = Vec::new(); if let Tag::Compound(c) = &mut tag { finalize = c.remove(&"horizon:finalize".into()).is_some(); - if let Some(Tag::List(list)) = c.remove(&"Passengers".into()) { - for p in list { - let known = - entity_nbt::kind(&p).is_some_and(|k| self.res.mob_types().contains_key(&k)); - if known { - riders.push(p); - } else { - unknown.push(p); - } - } - } - if !unknown.is_empty() { - c.insert("Passengers".into(), Tag::List(unknown)); - } } + let riders = self.take_mob_passengers(&mut tag); let mut m = entity_nbt::mob_from_nbt(&tag, self.res.mob_types(), self.next_entity)?; m.extra.mount = mount; m.extra.passenger = mount.is_some(); @@ -401,6 +391,49 @@ impl Game<'_> { } Some(id) } + /// The mobs under an entity's `Passengers`, taken out of it; the + /// passengers Horizon doesn't simulate stay. + fn take_mob_passengers(&self, tag: &mut Tag) -> Vec { + let mut riders = Vec::new(); + if let Tag::Compound(c) = tag + && let Some(Tag::List(list)) = c.remove(&"Passengers".into()) + { + let mut unknown = Vec::new(); + for p in list { + let known = + entity_nbt::kind(&p).is_some_and(|k| self.res.mob_types().contains_key(&k)); + if known { + riders.push(p); + } else { + unknown.push(p); + } + } + if !unknown.is_empty() { + c.insert("Passengers".into(), Tag::List(unknown)); + } + } + riders + } + /// The mobs riding entity `id` under `tag`'s `Passengers`, after the + /// passengers it kept from loading. + fn put_mob_passengers(&mut self, tag: &mut Tag, id: u32) { + let riders: Vec = (0..self.mobs.len()) + .filter(|&j| self.mobs[j].extra.mount == Some(id) && self.mobs[j].alive()) + .collect(); + let riders: Vec = riders.into_iter().map(|j| self.mob_tree_nbt(j)).collect(); + if let Tag::Compound(c) = tag { + let mut list = match c.get(&"Passengers".into()) { + Some(Tag::List(l)) => l.clone(), + _ => Vec::new(), + }; + list.extend(riders); + if list.is_empty() { + c.remove(&"Passengers".into()); + } else { + c.insert("Passengers".into(), Tag::List(list)); + } + } + } /// An entity of a type Horizon does not simulate, kept as its compound. fn load_other(&mut self, tag: Tag, kind: &str) -> Option { let position = entity_nbt::position(&tag)?; @@ -476,22 +509,7 @@ impl Game<'_> { let uuid = self.uuid_for(id); let mut tag = entity_nbt::mob_to_nbt(&self.mobs[i], uuid, self.persist.raw.get(&id)); self.write_leash(&mut tag, i); - let riders: Vec = (0..self.mobs.len()) - .filter(|&j| self.mobs[j].extra.mount == Some(id) && self.mobs[j].alive()) - .collect(); - let riders: Vec = riders.into_iter().map(|j| self.mob_tree_nbt(j)).collect(); - if let Tag::Compound(c) = &mut tag { - let mut list = match c.get(&"Passengers".into()) { - Some(Tag::List(l)) => l.clone(), - _ => Vec::new(), - }; - list.extend(riders); - if list.is_empty() { - c.remove(&"Passengers".into()); - } else { - c.insert("Passengers".into(), Tag::List(list)); - } - } + self.put_mob_passengers(&mut tag, id); tag } /// Forget an entity that left the world (its UUID and loaded compound). @@ -569,10 +587,15 @@ impl Game<'_> { let mut out: HashMap<(i32, i32), Vec> = keys.iter().map(|k| (*k, Vec::new())).collect(); let player_uuid = self.level.player_uuid; - // A rider is saved inside its root vehicle, in the root's chunk. + // A rider is saved inside its root vehicle, in the root's chunk; a + // boat's passengers inside the boat. let mobs: Vec = (0..self.mobs.len()) .filter(|&i| { self.mob_root(i) == i + && self.mobs[i] + .extra + .mount + .is_none_or(|v| self.boats.iter().all(|b| b.id != v)) && keys.contains(&chunk_of(self.mobs[i].position)) && self.mobs[i].alive() }) @@ -650,25 +673,29 @@ impl Game<'_> { .push(with_raw(tag, raw.as_ref())); } } - for b in &self.boats { - if keys.contains(&chunk_of(b.position)) { - let uuid = self - .persist - .uuids - .get(&b.id) - .copied() - .unwrap_or_else(random_uuid); - let tag = entity_nbt::boat_to_nbt( - &b.entity_type(), - b.position, - b.velocity, - b.yaw, - uuid, - self.persist.raw.get(&b.id), - b.chest.then_some(&b.items[..]), - ); - out.entry(chunk_of(b.position)).or_default().push(tag); - } + let boats: Vec = (0..self.boats.len()) + .filter(|&i| keys.contains(&chunk_of(self.boats[i].position))) + .collect(); + for i in boats { + let b = &self.boats[i]; + let (id, at) = (b.id, b.position); + let uuid = self + .persist + .uuids + .get(&id) + .copied() + .unwrap_or_else(random_uuid); + let mut tag = entity_nbt::boat_to_nbt( + &b.entity_type(), + b.position, + b.velocity, + b.yaw, + uuid, + self.persist.raw.get(&id), + b.chest.then_some(&b.items[..]), + ); + self.put_mob_passengers(&mut tag, id); + out.entry(chunk_of(at)).or_default().push(tag); } if let Some(d) = &self.dragon && keys.contains(&chunk_of(d.position)) @@ -833,9 +860,16 @@ impl Game<'_> { } keep }); - // Riders leave with their root vehicle. + // Riders leave with their root vehicle, a boat's with the boat. let leaving: HashSet = (0..self.mobs.len()) - .filter(|&i| gone(self.mobs[self.mob_root(i)].position)) + .filter(|&i| { + let r = self.mob_root(i); + match self.mobs[r].extra.mount { + Some(v) if removed.contains(&v) => true, + Some(v) if self.boats.iter().any(|b| b.id == v) => false, + _ => gone(self.mobs[r].position), + } + }) .map(|i| self.mobs[i].id) .collect(); self.mobs.retain(|m| { diff --git a/crates/horizon-client/src/game/remote.rs b/crates/horizon-client/src/game/remote.rs index da0def0fb..38f9497ec 100644 --- a/crates/horizon-client/src/game/remote.rs +++ b/crates/horizon-client/src/game/remote.rs @@ -3136,6 +3136,9 @@ impl Game<'_> { | u8::from(keys.sprint) << 6; // A passenger moves with its vehicle (Entity.rideTick), not by itself. let riding = self.screen != Screen::Dead && self.remote_ride(keys); + // The server sends no passenger's position: they sit where their + // vehicles are now. + self.position_riders(); let Some(player) = self.player.as_mut() else { return Ok(()); }; diff --git a/crates/horizon-client/src/game/remote_vehicles.rs b/crates/horizon-client/src/game/remote_vehicles.rs index 027983145..cf1b2d683 100644 --- a/crates/horizon-client/src/game/remote_vehicles.rs +++ b/crates/horizon-client/src/game/remote_vehicles.rs @@ -88,8 +88,10 @@ impl Game<'_> { for m in &mut self.mobs { if m.extra.mount == Some(vehicle_id) && !passengers.contains(&(m.id as i32)) { m.extra.mount = None; + m.extra.passenger = false; } else if passengers.contains(&(m.id as i32)) { m.extra.mount = Some(vehicle_id); + m.extra.passenger = true; } } if passengers.contains(&me) { @@ -129,17 +131,20 @@ impl Game<'_> { self.yaw += b.delta_rotation; let delta = (self.yaw - b.yaw + 180.0).rem_euclid(360.0) - 180.0; self.yaw += delta.clamp(-105.0, 105.0) - delta; - let seat = b.position; self.boats[i] = b; - Some(seat) + // In front of a mob that shares the boat. + Some(self.player_boat_seat(i)) } else { // A minecart: the server moves it, the rider sits in it. - self.carts.iter().find(|c| c.id == id).map(|c| c.position) + self.carts.iter().find(|c| c.id == id).map(|c| { + c.position + .add_vector(Vec3::new(0.0, super::minecarts::SEAT, 0.0)) + }) }; if let Some(p) = self.player.as_mut() { self.previous_position = p.position; if let Some(v) = seat { - p.position = Vec3::new(v.x, v.y + super::boats::SEAT, v.z); + p.position = v; } p.velocity = Vec3::ZERO; p.fall_distance = 0.0; diff --git a/crates/horizon-client/src/mobs.rs b/crates/horizon-client/src/mobs.rs index 47bd8a73e..4e3879fe5 100644 --- a/crates/horizon-client/src/mobs.rs +++ b/crates/horizon-client/src/mobs.rs @@ -736,9 +736,13 @@ pub struct Extra { /// The sniffer's and the ghastling's brain. pub animal_brain: Option>, pub axolotl: axolotl::Animation, - /// The mob this one rides, and the mob riding it (`getVehicle`, `getFirstPassenger`). + /// The mob or boat this one rides, and the mob riding it (`getVehicle`, + /// `getFirstPassenger`). pub mount: Option, pub rider: Option, + /// `Entity.boardingCooldown`: ticks after leaving a boat before a boat + /// can pick this mob up again. + pub boarding_cooldown: i32, /// A chicken carrying a zombie (`IsChickenJockey`). pub jockey: bool, /// A skeleton horse waiting to spring its trap, and how long it has waited. diff --git a/crates/horizon-client/src/mobs/drops.rs b/crates/horizon-client/src/mobs/drops.rs index 3ebcc71f5..e5ccfd283 100644 --- a/crates/horizon-client/src/mobs/drops.rs +++ b/crates/horizon-client/src/mobs/drops.rs @@ -96,7 +96,8 @@ fn xp_reward(m: &Mob) -> i32 { _ => 0, } } -fn is_animal(s: Species) -> bool { +/// The mobs that extend `Animal`. +pub fn is_animal(s: Species) -> bool { use Species as S; matches!( s, diff --git a/docs/architecture.md b/docs/architecture.md index 29e98f2e6..f95073e57 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -41,7 +41,7 @@ file selects ~103. | 24 | Container menus and inventory (61) | `L/menu.rs`, `L/container_screen.rs`, `L/containers.rs`, `L/creative.rs`; game.rs `fn menu_ops`, `fn click_inventory` | menu_click, container_screen, creative, lan_e2e containers clicks | | 25 | Workstations (60) | `L/stations.rs`, `G/stations.rs`, `L/enchant.rs`, `L/brewing.rs` | enchanting, screen_layout, lan_e2e brewing loom stonecutter grindstone anvil smithing | | 26 | Crafting and the recipe book (59) | `L/crafting.rs`, `L/recipe_book.rs`, `L/recipe_book_screen.rs`, `G/recipe_book.rs`, `G/machines.rs`, `G/machines/crafter.rs` | recipe, recipe_book, recipe_book_view, place_recipe, ghost_recipe, crafter | -| 27 | Vehicles and mounts (54) | `G/boats.rs`, `G/minecarts.rs`, `G/mounts.rs`, `G/mount_menu.rs`, `G/llamas.rs`, `G/passengers.rs` | server_entities, lan_e2e boats minecarts riding mounts | +| 27 | Vehicles and mounts (54) | `G/boats.rs`, `G/boat_passengers.rs`, `G/minecarts.rs`, `G/mounts.rs`, `G/mount_menu.rs`, `G/llamas.rs`, `G/passengers.rs` | server_entities, lan_e2e boats minecarts riding mounts | | 28 | Villagers, trading, raids (50) | `L/mobs/villager*.rs`, `L/merchant.rs`, `G/trading.rs`, `G/villagers.rs`, `L/raid.rs`, `G/raids.rs`, `L/gossip.rs` | trading, raid, mob_ai | | 29 | Title, worlds, startup (49) | `L/title.rs` + `L/title/`, `G/startup_menu.rs`, `L/title_edition.rs` | world_options; `cargo test -p horizon-client --lib title` | | 30 | Dedicated server, horizon-server (48) | `G/dedicated.rs`, `G/dedicated/status.rs`, `crates/horizon-server/`, `crates/horizon-server-files/` | dedicated_server, server_files, user_cache, online_mode, server_ops_feedback | From 0a1d3a75345f94cee5f4c578cace07b6d8449c6d Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Sat, 24 Oct 2026 20:50:20 +0200 Subject: [PATCH 013/169] Horizon APIs: the docs portal and the stability and versioning policy docs/api/ gets one page per surface other programs build on (mods, shaders, agent control, servers, the launcher, data formats), each with an overview measured from the source, the guide, the generated reference, examples, its stability, what is not there yet and a changelog, plus the policy every API follows (docs/api/stability.md): a version per API, semver lines, experimental / preview / stable, deprecation windows, compatibility tests and the level of every part today. The website gets a "Build on Horizon" page (website/docs/apis.md) that summarises them and links the repository's pages. Co-Authored-By: Claude Opus 5.5 --- docs/README.md | 1 + docs/api/README.md | 55 +++++++++++++++++++++ docs/api/agent-control.md | 55 +++++++++++++++++++++ docs/api/data-formats.md | 40 +++++++++++++++ docs/api/launcher.md | 57 ++++++++++++++++++++++ docs/api/mods.md | 76 +++++++++++++++++++++++++++++ docs/api/server.md | 60 +++++++++++++++++++++++ docs/api/shaders.md | 54 ++++++++++++++++++++ docs/api/stability.md | 100 ++++++++++++++++++++++++++++++++++++++ website/docs/apis.md | 34 +++++++++++++ website/docs/nav.json | 1 + 11 files changed, 533 insertions(+) create mode 100644 docs/api/README.md create mode 100644 docs/api/agent-control.md create mode 100644 docs/api/data-formats.md create mode 100644 docs/api/launcher.md create mode 100644 docs/api/mods.md create mode 100644 docs/api/server.md create mode 100644 docs/api/shaders.md create mode 100644 docs/api/stability.md create mode 100644 website/docs/apis.md diff --git a/docs/README.md b/docs/README.md index 00460d12d..cdc2cda2a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -20,6 +20,7 @@ To play, use [the launcher](../launcher/README.md); the project site is [playhor - [Resource packs](resource-packs.md): everything a 26.3 resource pack can change, whether Horizon honours it, and the proof. - [Opt-in data collection](telemetry.md): the consent, exactly what is sent, how it is stored and sent. - [Benchmark report format](benchmark-report.md): the versioned JSON every benchmark writes (game, launcher, `tools/perf_bench.py`), the local log and, with consent, the upload. +- [Horizon APIs](api/README.md): every surface other programs build on (mods, shaders, agent control, servers, the launcher, data formats), each with its guide, generated reference, stability and changelog, and the [stability and versioning policy](api/stability.md). - Menus: every screen is vanilla's (title, world list, create world, multiplayer, options, pause). Horizon's own settings hang off vanilla's Options the way mods add theirs: **Horizon Settings...** and **Mods...** in the last two slots of the Options grid (Horizon Settings opens Graphics, Advanced Graphics, Controller Settings, Extras and Mods, each a vanilla options list), with Horizon Graphics and Advanced Graphics also at the top of Video Settings and Controller Settings at the bottom of Controls. The title screen's and pause menu's Friends buttons open Join a Friend and Play with Friends ([play-with-friends.md](play-with-friends.md)). ## Parity diff --git a/docs/api/README.md b/docs/api/README.md new file mode 100644 index 000000000..ad49ff609 --- /dev/null +++ b/docs/api/README.md @@ -0,0 +1,55 @@ +# Horizon APIs + +Horizon has six surfaces that other programs and people build on. Each one has an **API** (the contract: what you +may call, read or write, and what Horizon promises about it) and an **SDK** (the tools that help you use it). This +section has one page per surface, plus the rules every surface follows: +[stability and versioning](stability.md). + +| Surface | For | API today | Stability | Reference | +| --- | --- | --- | --- | --- | +| [Mods](mods.md) | mod authors | WIT `horizon:mods@0.1.0`, manifest `api` 0.1 (code) and 0.2 (content) | preview | [mods-reference.md](mods-reference.md) (generated) | +| [Shaders](shaders.md) | shader authors | none yet: packs were removed on 2026-10-24 | planned | none | +| [Agent control](agent-control.md) | agents, scripts, tests | `horizon-ctl`, its MCP server, the game's control socket | preview | [horizon-ctl-commands.md](../horizon-ctl-commands.md) (generated) | +| [Servers](server.md) | hosts, panels, bots | `horizon-server` commands, `server.toml`, control API `/api/v1` | stable | [server-reference.md](server-reference.md) (generated) | +| [Launcher](launcher.md) | players' agents, pack makers | `horizon-launcher` commands and its MCP server | preview | [launcher-commands.md](../launcher-commands.md) (generated) | +| [Data formats](data-formats.md) | tools that read Horizon's files | benchmark reports, telemetry, settings files, signed checksums | stable or preview, per format | on that page | + +## How these APIs are designed + +- **From the people who use them.** Each API starts from what a mod author, a pack author, a server host or an agent + needs to do, written down as tasks ("a host backs up the world from a script"), and from how Horizon is built: + Rust, wgpu, WebAssembly components and a server thread that runs every world. A function exists because a task + needs it. +- **Our own design.** Horizon's APIs are not modelled on any other project's. Contributors may know other mod + loaders, renderers and server platforms exist, but their source and API references are never read, copied or + paraphrased here, and our names, shapes and docs are not taken from theirs. Vanilla Minecraft 26.3 is the reference for game + concepts: ids, commands, `server.properties`, data packs and resource packs. +- **Safe by default.** Mods run in a sandbox and can only use the capabilities their manifest declares; the control + sockets listen on this computer only, behind a token; nothing here is on by default where it would change vanilla's + look or behaviour. +- **Free when unused.** An API nobody uses costs nothing per tick or per frame: no engine, no thread, no allocation. +- **One contract for every mode.** In-frame single player, the server thread, LAN and the dedicated server run the + same gameplay code ([AGENTS.md](../../AGENTS.md)), so a server-side API serves all of them. + +## References are generated + +A reference page is written by code from the source it describes, and a test fails when the two differ: + +| Page | Generated from | Update it with | +| --- | --- | --- | +| [mods-reference.md](mods-reference.md) | `crates/horizon-mod-sdk/wit/horizon.wit`, the manifest's capabilities | `HORIZON_WRITE_DOCS=1 cargo test -p horizon-mods --features pack --test api_reference` | +| [server-reference.md](server-reference.md) | `horizon-server`'s help, `config::TEMPLATE`, `api::ROUTES` | `HORIZON_WRITE_DOCS=1 cargo test -p horizon-server reference` | +| [horizon-ctl-commands.md](../horizon-ctl-commands.md) | the command table in `crates/horizon-client/src/bin/horizon-ctl/commands.rs` | `horizon-ctl help --markdown > docs/horizon-ctl-commands.md` | +| [launcher-commands.md](../launcher-commands.md) | `launcher/src/cli.rs` | `HORIZON_WRITE_DOCS=1 cargo test --manifest-path launcher/Cargo.toml the_launcher_reference` | + +So a pull request that changes an API also changes its reference, and the reviewer sees the API's diff in the +reference's diff. The guides (overview, how-to, examples) are written by hand. + +## Each surface's page + +Every page has the same parts: **Overview** (what you can build), **Guide** (where to start), **Reference**, +**Examples**, **Stability** (the level of each part, per [stability.md](stability.md)), **Changelog** and +**Not there yet** (what is planned, so nobody builds on a guess). + +The website's summary for players and authors is [playhorizon.dev/docs/apis](https://playhorizon.dev/docs/apis) +(`website/docs/apis.md`). diff --git a/docs/api/agent-control.md b/docs/api/agent-control.md new file mode 100644 index 000000000..593447dde --- /dev/null +++ b/docs/api/agent-control.md @@ -0,0 +1,55 @@ +# Agent control API + +How a program drives a running game: an AI agent through MCP, a script through `horizon-ctl`, a test through the +control socket. Design and inventory: [agent-control.md](../agent-control.md); for players: +[playhorizon.dev/docs/agents](https://playhorizon.dev/docs/agents). + +## Overview + +The game listens on a local control socket (a Unix socket, or localhost TCP with a token on Windows), takes one +command per text line and answers one JSON line. `horizon-ctl` wraps it: it starts the game, sends commands and +serves the same commands as MCP tools. The launcher's MCP server offers them too, as `game_`. + +| | Count | +| --- | --- | +| `horizon-ctl` commands | 96, in 8 groups (session, observe, move and look, act, screens and chat, multiplayer, world and cheats, scripting and benchmarks) | +| MCP tools | 88 (8 commands are CLI only) | +| Destructive commands (need `--confirm`) | 3 | +| Command names the game's socket answers | about 160, test hooks included (`horizon-ctl help --game`) | + +## Guide + +1. Build `horizon-ctl` (`cargo build --profile fast -p horizon-client`), then + `horizon-ctl --socket $PWD/ctl.sock launch --world W --creative --wait --resources `. +2. `horizon-ctl --socket … state`, `keys`, `turn`, `command`, `screenshot`, `quit`. +3. For an agent: `horizon-ctl mcp`, or the launcher's `horizon-launcher mcp` with `agent-config` to connect a client + ([launcher-commands.md](../launcher-commands.md)). + +## Reference + +[horizon-ctl-commands.md](../horizon-ctl-commands.md), generated from the command table in +`crates/horizon-client/src/bin/horizon-ctl/commands.rs`: every command, its MCP tool and its arguments. + +## Examples + +- `tools/agent_control_e2e.py`: starts a game and drives it end to end through `horizon-ctl` and MCP. +- `tools/lan_e2e.py`: two games over LAN, both driven through their sockets. + +## Stability + +Preview ([stability.md](stability.md)). The commands in `horizon-ctl`'s table and their MCP tool names are what the +API offers; the other commands the game's socket answers are test hooks and experimental. + +## Not there yet + +- **A version.** A `hello` command that answers the protocol version, the game's release and the features it has; + MCP `serverInfo` carries the same version; `horizon-ctl` refuses a game whose major it doesn't speak. +- **Reply schemas.** Each command's reply described in the table (fields, types, units), so the reference documents + replies as well as arguments and MCP tools declare an output schema. +- **Events as a stream.** `events --since` polls today; a subscription that pushes events as they happen. +- **Test hooks apart.** The hooks only harnesses use move under their own prefix, out of the agent's tool list. +- **Compatibility tests.** A transcript per protocol version: commands and the reply keys each must keep. + +## Changelog + +- Unversioned so far: the command table and the generated reference are the contract. diff --git a/docs/api/data-formats.md b/docs/api/data-formats.md new file mode 100644 index 000000000..3127248a1 --- /dev/null +++ b/docs/api/data-formats.md @@ -0,0 +1,40 @@ +# Data formats + +The files Horizon writes that other tools may read: benchmark reports, telemetry, settings, mods, release checksums +and worlds. Each entry names its version field, its documentation and its level ([stability.md](stability.md)). + +## Overview + +| Format | Where | Version | Level | Documented in | +| --- | --- | --- | --- | --- | +| Benchmark report | the benchmark's output, the local log, uploads | `"format": "horizon-benchmark-report"`, `"version": 1` | stable | [benchmark-report.md](../benchmark-report.md) | +| Telemetry batch | `POST /v1/batch` from the launcher | `"schema": 1` | stable | [telemetry.md](../telemetry.md) | +| Telemetry consent | `telemetry/consent.json` in the game folder | `"version": 2` | stable | [telemetry.md](../telemetry.md) | +| Mod package | `.hmod`: a zip with `horizon-mod.toml`, `mod.wasm`, `assets/`, `data/` | the manifest's `api` | preview | [mods.md](../mods.md#the-manifest), [mods-reference.md](mods-reference.md) | +| Mods turned on | `horizon-mods.txt` | none | preview | [mods.md](../mods.md#playing-with-mods) | +| Horizon settings | `horizon-graphics.txt`, `horizon-extras.txt` (`key:value`, as `options.txt`) | none: unknown keys fall back to defaults | preview | [graphics.md](../graphics.md), [extras.md](../extras.md#options-storage) | +| Server settings | `server.toml` | its keys | stable | [server-reference.md](server-reference.md) | +| Control endpoints | the game's socket file (TCP form), `.horizon/api.json` | none | preview | [agent-control.md](agent-control.md), [server-reference.md](server-reference.md) | +| Release checksums | `SHA256SUMS`, `SHA256SUMS.sig` on releases since signing began (#1011) | the signed text names the tag | stable | [security.md](../security.md) | +| Worlds | the world folder | vanilla 26.3's (`DataVersion`) | vanilla's | [world-data.md](../world-data.md) | + +Worlds are vanilla's format, so any tool that reads a 26.3 world reads a Horizon world; Horizon adds itself to +`level.dat`'s `ServerBrands` as vanilla's server does. + +## Rules for every format + +- A reader ignores fields it doesn't know, and refuses a version newer than it knows with a clear message. +- An optional field may be added in the same version; renaming, removing or changing the meaning of a field makes the + next version, and Horizon's own readers keep reading the older ones for the deprecation window. +- Each versioned format has a sample file of every version its reader accepts, read by a test. + +## Not there yet + +- Versions for the settings files and the control endpoint files (a `version` line or field). +- Sample files and reader tests for every versioned format. +- A generated schema for the benchmark report and the telemetry batch from their Rust types, checked by a test like + the references. + +## Changelog + +- Benchmark report version 1; telemetry schema 1, consent version 2. diff --git a/docs/api/launcher.md b/docs/api/launcher.md new file mode 100644 index 000000000..8b100d972 --- /dev/null +++ b/docs/api/launcher.md @@ -0,0 +1,57 @@ +# Launcher API + +What a player's agent, a script or a pack maker can do with `horizon-launcher`: install and run versions, manage +accounts, settings, mods, modpacks and hosted servers, from a terminal or over MCP. The launcher itself: +[launcher/README.md](../../launcher/README.md). + +## Overview + +Every page of the launcher has a command, and every command but three has an MCP tool with the same arguments; a tool +runs the command with `--json`. Tools that change the player's things for good need `confirm: true`; with No AI on, +the MCP server is off. + +| | Count | +| --- | --- | +| Commands | 46: versions, installs, play, the server, notes, links, accounts, settings, logs, updates, data collection, modpacks, mods, hosted servers, MCP, benchmark | +| MCP tools | 43, plus the game's tools as `game_` ([agent-control.md](agent-control.md)) | +| Modpack formats it imports | 3: a Modrinth `.mrpack`, a CurseForge zip, an instance folder | + +## Guide + +1. `horizon-launcher versions`, `horizon-launcher install latest`, `horizon-launcher play`. +2. Modpacks: `horizon-launcher modpack import `, then `modpack port` and `modpack play` + ([modpacks.md](../modpacks.md)). +3. For an agent: `horizon-launcher agent-config` prints how to connect a client to `horizon-launcher mcp`. + +## Reference + +[launcher-commands.md](../launcher-commands.md), generated from `launcher/src/cli.rs`: every command, its arguments +and its MCP tool. + +## Examples + +```sh +horizon-launcher versions --installed --json +horizon-launcher mods search minimap --kind mod --json +horizon-launcher servers create --name "Weekend" --player Alex --json +``` + +## Stability + +Preview ([stability.md](stability.md)): command names, arguments and MCP tool names are the contract; `--json` +output shapes are not yet described in the reference. + +## Not there yet + +- **A Horizon modpack manifest.** A pack made for Horizon (not a port of a Java pack) needs its own file: the pack's + id, name and version; the Horizon API lines and the release line it needs; its `.hmod` mods (id, version, SHA-256, + where to download it, client, server or both); resource packs; default settings; and whether it has a server side. + One manifest serves the launcher, `horizon-server` (a server installs the server side of the same pack) and the mod + browser. Designed from what a pack maker does, versioned per [stability.md](stability.md), with a schema test. +- **JSON output schemas** for every command, in the generated reference, so MCP tools declare their output. +- **A version** in MCP `serverInfo` and `--json` output, as for agent control. +- **Compatibility tests**: golden `--json` output per command. + +## Changelog + +- Unversioned so far: the command table and the generated reference are the contract. diff --git a/docs/api/mods.md b/docs/api/mods.md new file mode 100644 index 000000000..ec42bc0db --- /dev/null +++ b/docs/api/mods.md @@ -0,0 +1,76 @@ +# Mod API + +Mods are Rust crates compiled to sandboxed WebAssembly components. They run in the player's game and, once server +mods land, wherever a world is simulated. Design and the runtime: [mods.md](../mods.md). + +## Overview + +A mod today can read the local player and the world clock, show chat lines only that player sees, draw a text panel +on the HUD, keep small files of its own, register chat commands, and run on every tick, frame or chat line it asks +for. A content mod adds blocks and items from JSON in its `.hmod`, copying vanilla templates, plus tags, recipes, +loot, models, textures and structures in its own namespaces. Every capability is declared in the manifest, shown to +the player before the mod is turned on, and checked against the component's real imports. + +| | Count | +| --- | --- | +| Interfaces the game offers | 5: `log`, `game`, `chat`, `hud`, `storage` | +| Functions in them | 9 | +| Hooks a mod exports | 5: `init`, `tick`, `frame`, `command`, `chat` | +| Capabilities | 5: `game-read`, `chat`, `hud`, `storage`, `registries` | +| Manifest `api` lines served | 2: `0.1` (code), `0.2` (content) | +| SDK | the `Mod` trait (5 methods), `Registration` (4 builders), `export_mod!`, log helpers | +| `cargo horizon-mod` | `new`, `build`, `run` | +| Example mods | `coords-hud` (code), `ruby-content` (content) | + +## Guide + +1. `rustup target add wasm32-unknown-unknown`, `cargo install --git https://github.com/ludovic111/horizon + cargo-horizon-mod`, then `cargo horizon-mod new my-mod` ([Making a mod](../mods.md#making-a-mod)). +2. Implement `Mod` for your type, list the capabilities you import in `horizon-mod.toml` + ([The manifest](../mods.md#the-manifest)). +3. `cargo horizon-mod run` builds the `.hmod` and starts the game with it as a dev mod; after an edit, + `cargo horizon-mod build` and the running game reloads it. +4. Content mods: [Content mods (API 0.2)](../mods.md#content-mods-api-02). + +## Reference + +[mods-reference.md](mods-reference.md), generated from `crates/horizon-mod-sdk/wit/horizon.wit`: every capability, +interface, type, function and hook, with the limits the guide lists (16 HUD lines of 256 characters, 8 chat lines per +call, 4 MiB of storage, fuel per call). + +## Examples + +- `crates/horizon-mod-sdk/examples/coords-hud`: coordinates, facing and time on the HUD; `/where`, `/coords`; storage. +- `crates/horizon-mod-sdk/examples/ruby-content`: no code; a gem and a block of ruby from vanilla templates, with + their recipes, loot, tags, models, textures and names. +- `crates/horizon-mods/tests/guest`: a mod that misbehaves on command (spins, panics, grows its memory), for the + sandbox tests. + +## Stability + +Preview ([stability.md](stability.md)): API 0.1 and content 0.2 are served together; a mod built for 0.1.0 keeps +loading on every 0.1.x game. Block entities (draft #1189, `api = "0.4"`) are experimental. + +## Not there yet + +What real mods need next, in the order modpacks and servers need it: + +- **Server mods**: the same component running on the server thread and the dedicated server, with world events (block + broken or placed, entity spawned or killed, player joined or left), game rules and server commands with typed + arguments. +- **World and blocks**: read blocks, block states and biomes in loaded chunks; change them through the server's block + log, so clients and the parity harnesses see vanilla's updates. +- **Items and inventories**: the player's inventory, held item and open container; item stacks with components. +- **Entities**: query and change entities near a position; spawn from a mod's own entity types (data first). +- **Block entities and menus**: ticking machines with slots and their screens (draft #1189 is the first step). +- **Screens and UI**: widgets built from vanilla's, a screen the mod owns, a settings page under Options > Mods. +- **Networking**: a channel between a mod's two halves, client and server, typed by the mod's own WIT. +- **Config**: typed settings the game shows and stores for the mod, on the server too. +- **Keys and the crosshair target**: keybinds in Controls; what the player is looking at. +- **SDK**: a headless test runner (load a mod, feed it ticks and events, assert on its output, no window), templates + per kind of mod, typed wrappers in the SDK for every interface. Dev mods already reload when rebuilt. + +## Changelog + +- API 0.2 (content): data-driven blocks and items, tags, `horizon:add_to`, terrain adaptation. +- API 0.1.0: `log`, `game`, `chat`, `hud`, `storage`; `init`, `tick`, `frame`, `command`, `chat`. diff --git a/docs/api/server.md b/docs/api/server.md new file mode 100644 index 000000000..81f54c6fe --- /dev/null +++ b/docs/api/server.md @@ -0,0 +1,60 @@ +# Server API + +What a host, a panel or a bot can do with a Horizon server: the `horizon-server` commands, `server.toml` and the +control API. How to host: [hosting.md](../hosting.md); the design: [server.md](../server.md). + +## Overview + +`horizon-server` sets up a server folder, runs the game as a dedicated server under a supervisor (restarts on a crash, +backups on a schedule, updates with a rollback), and lets other programs manage it through a local HTTP API with a +token. The web panel uses that API. + +| | Count | +| --- | --- | +| Commands | 22 (`init`, `run`, `start`, `stop`, `restart`, `status`, `cmd`, `logs`, `backup`, `backups`, `restore`, `service`, `panel`, `update`, `rollback`, `config`, `config set`, `import`, `op`, `deop`, `whitelist`, `version`) | +| `server.toml` keys | 22 in 6 sections, plus `[properties]` for any other vanilla key | +| Control API endpoints | 11 under `/api/v1` | + +## Guide + +1. `horizon-server init` in an empty folder, then `horizon-server start` ([hosting.md](../hosting.md)). +2. From a script: `horizon-server status --json`, `horizon-server cmd say hi`, `horizon-server backup`. +3. From a program: read `.horizon/api.json` (address and token), then `GET /api/v1/status` with + `Authorization: Bearer `. + +## Reference + +[server-reference.md](server-reference.md), generated from `horizon-server`'s source: the help text, every +`server.toml` key with its default and the `server.properties` key it writes, and every endpoint. + +## Examples + +```sh +token=$(jq -r .token .horizon/api.json); address=$(jq -r .address .horizon/api.json) +curl -s -H "Authorization: Bearer $token" "http://$address/api/v1/status" +curl -s -H "Authorization: Bearer $token" -d '{"line": "list"}' "http://$address/api/v1/command" +``` + +## Stability + +Stable ([stability.md](stability.md)): the commands, `server.toml`'s keys and `/api/v1`. A new key or endpoint is an +addition; a change to one starts `/api/v2`, served beside `/api/v1`. + +## Not there yet + +- **Players**: list with ping and position, kick, ban and pardon, op and deop, the whitelist, as endpoints (today only + through `cmd` and the files). +- **Console stream**: the log as a stream (server-sent events) rather than `logs?since=N` polling; chat, joins, leaves, + deaths and crashes as typed events. +- **Metrics**: a plain-text metrics endpoint any monitoring tool can scrape (TPS, MSPT percentiles, players, chunks, + entities, RAM, CPU), from the samples `status` already takes. +- **Backups**: delete and download one; restore a single dimension. +- **Server mods**: list, turn on and off, and their settings, once the mod API runs on the server + ([mods.md](mods.md)). +- **An MCP server** for the same endpoints, so a host's agent manages the server as it manages the game. +- **Compatibility tests**: golden replies per endpoint, and a `server.toml` from each release line. + +## Changelog + +- `api::ROUTES` lists the endpoints; the reference is generated from it. +- `/api/v1`: status, metrics, logs, command, stop, restart, backups, restore, update, panel login. diff --git a/docs/api/shaders.md b/docs/api/shaders.md new file mode 100644 index 000000000..10d1ae3de --- /dev/null +++ b/docs/api/shaders.md @@ -0,0 +1,54 @@ +# Shader API + +Horizon has no shader packs today: the earlier implementation was removed on 2026-10-24. Two things will replace it, +designed separately: a **Horizon shader API**, described here, and a clean-room loader for the existing pack format +(its own spec; it is not part of this API). Both sit on the same renderer hooks, agreed between the two. + +## Overview: what a shader author will be able to do + +Write WGSL against documented stages of Horizon's renderer, with typed inputs, options the player can change, a +reload as soon as a file is saved and an overlay that shows what each pass costs and draws. The renderer keeps +everything that makes it fast (culling, batching, LOD, the mesher); a pack changes how surfaces and light look, not +how the world is fed to the GPU. + +## The design + +- **A pack** is a folder or a zip with `horizon-shaders.toml` (id, name, version, the `api` line, the stages it + uses, its options) and WGSL files. No preprocessor and no other shading language: WGSL is what wgpu validates and + compiles for Vulkan, Metal and DirectX 12. +- **Stages, not pipelines.** A stage is a function with a fixed signature that the renderer calls inside its own pass, + for example a terrain material (`fn material(input: TerrainInput) -> Surface`), the lighting of the visible + surfaces, the sky, an optional shadow pass, and a chain of full-screen post passes ending in the frame. A pack + that leaves a stage out gets vanilla's look for it. +- **Typed inputs.** Each stage receives structs (the frame: time, camera, sun and moon, weather, fog; the surface: + position, normal, block and its light) whose WGSL is generated from the Rust types the renderer uploads. The + generated reference lists every field with its unit and range, and a test fails when it drifts. +- **Options are WGSL `override` constants.** The manifest declares each option (on/off, a number in a range, a choice) + with its default; the game shows them on the pack's settings screen and sets them when it builds the pipeline. No + text substitution, and every option combination is validated the same way. +- **Hot reload.** The game watches the pack's folder. A saved file is validated with naga and the stage rebuilt; on an + error the last good version keeps drawing and the error, with its file and line, is shown in the overlay. +- **Debug overlay.** GPU time per stage and pass (timestamp queries), the targets each pass writes (show any of them + full-screen), the pack's options and its compile errors. +- **Budgets.** A pack declares the targets and passes it needs; the renderer refuses more than its limits, and the + benchmark ([benchmark-report.md](../benchmark-report.md)) records the pack and its cost, so "fast" stays measured. +- **Off by default.** Without a pack the renderer is vanilla's look, and no pack code runs. + +## Guide, reference and examples + +None yet. When the first stage lands: a guide here, a generated reference (`shaders-reference.md`) and an example pack +in the repository that the renderer's tests load. + +## Stability + +Not started. The first stages will be experimental (opt-in), then preview once a reference, an example and a test +pack exist ([stability.md](stability.md)). + +## Not there yet + +Everything on this page. The order: the renderer hooks shared with the format loader, then the material and post +stages with options and hot reload, then the overlay, lighting, sky and shadow stages. + +## Changelog + +- 2026-10-24: the earlier shader pack code was removed; this API is designed from scratch. diff --git a/docs/api/stability.md b/docs/api/stability.md new file mode 100644 index 000000000..deca14d1d --- /dev/null +++ b/docs/api/stability.md @@ -0,0 +1,100 @@ +# API stability and versioning + +The rules every Horizon API follows ([the APIs](README.md)): how each one is versioned, what the stability levels +promise, how something is deprecated and removed, and the tests that keep old mods, scripts and tools working. + +## Versions + +- **Each API has its own version**, separate from the game's release (`v0.2.14`, [versioning.md](../versioning.md)) + and from Minecraft's. A game release says which API versions it serves. +- **Semantic versioning**, `MAJOR.MINOR.PATCH`. A **line** is what stays compatible: `0.1`, `0.2`, … before 1.0, + then `1`, `2`, …. + - Before 1.0: an addition makes the next patch (`0.1.0` → `0.1.1`); a breaking change starts the next line + (`0.2.0`). + - From 1.0: an addition makes the next minor (`1.0` → `1.1`); a breaking change starts the next major (`2.0`). +- **Where the version lives:** + +| API | The version | A user names the line they need | +| --- | --- | --- | +| Mods | the WIT package (`horizon:mods@0.1.0`) | `api = "0.1"` in `horizon-mod.toml` | +| Agent control | the control protocol's version (planned: a `hello` reply and MCP `serverInfo`) | `horizon-ctl --api 1` (planned) | +| Server control API | the path (`/api/v1/`) | the path | +| `server.toml` | the file's keys; a key is never renamed in place | nothing: old files keep loading | +| Launcher commands | the command names and their `--json` output | nothing | +| Data formats | a `version` or `schema` field in the file | the reader rejects versions newer than it knows | + +## What counts as a breaking change + +Breaking: removing or renaming anything; changing a type, a default, a unit or a meaning; making something optional +required; refusing input that was accepted; a new case in a WIT `enum` or `variant` the game sends to mods (an older +component cannot decode it); a JSON field that changes type. + +Not breaking: a new function, interface, capability, command, endpoint, tool or `server.toml` key; a new optional +argument or JSON field (readers must ignore fields they don't know); a new WIT case the mod *sends* (the game decodes +every case it ever served); faster, or fixing behaviour to what the reference already says. + +## Stability levels + +Every part of an API has one level, shown in its reference and its surface page. + +| | Experimental | Preview | Stable | +| --- | --- | --- | --- | +| Who may use it | opt-in only (a flag or a manifest field naming it); never in a release default | anyone; marked "preview" where players see it (a mod's row on the Mods page) | anyone | +| May change | in any release, without notice | only at a new line, after a deprecation | only at a new major, after a deprecation | +| Deprecation window | none | at least 30 days, with one release line serving old and new | at least 180 days, with the old major served beside the new one | +| Needs | a design note | a generated reference, a guide section, an example, compatibility tests | the same, plus one line of real use without a break | + +- **Promotion.** Experimental → preview when it has what the table asks. Preview → stable when real users (a published + mod, a host's script, an agent's tool) used it for a whole line and nothing broke; Ludovic decides that step. +- **Horizon-only by design.** An API is stable only for what Horizon itself does; a vanilla concept it exposes (a block + id, a command, a `server.properties` key) changes when vanilla changes it, with a version port + ([version-ports.md](../version-ports.md)), and the changelog says so. + +## Deprecation and removal + +1. The pull request that deprecates marks it where it is defined (a `/// Deprecated: use X; goes in 0.3.` doc comment, + WIT's `@deprecated`, a `deprecated` field in a tool's schema) and adds the replacement in the same release. +2. The reference shows it as deprecated, and the surface page's changelog says what replaces it and when it goes. +3. Using it logs one warning per mod, session or client, naming the replacement; it keeps working. +4. It is removed only after the window, and only at the next line (preview) or major (stable). +5. A line or major that is no longer served is refused with a clear message (`needs API 0.1; this Horizon serves 0.3 + and 0.4`), never loaded half-way. + +## Compatibility tests + +Every preview and stable API has tests that run old users against the current code, in CI: + +| API | The test | +| --- | --- | +| Mods | a test mod per served line, built from source against that line's WIT and SDK, loaded by today's runtime with expected output (`crates/horizon-mods/tests/`); a line is served as long as its test mod passes | +| Agent control | a transcript per protocol version: commands and the reply keys each must have | +| Server | `api::ROUTES` against `route()` (generated reference); a `server.toml` from each release line parses to the same settings; golden replies per endpoint | +| Launcher | the generated reference; golden `--json` output per command | +| Data formats | a sample file of every version a reader accepts, read by today's reader | + +The generated references are the API's own diff: a pull request that changes an API changes its reference, and the +reviewer applies the rules above to that diff. + +## Changelog + +Each surface page ends with a changelog: one line per change, newest first, with the API version and the pull request. +Deprecations and breaking changes are in bold. The release notes of the game release that ships a change link it. + +## Today + +| Part | Level | Version | +| --- | --- | --- | +| Mod API: `log`, `game`, `chat`, `hud`, `storage`, `events` | preview | 0.1.0 | +| Content mods (`registries`: data-driven blocks and items) | preview | manifest `api = "0.2"` | +| Block entities for code mods (draft #1189) | experimental | manifest `api = "0.4"` | +| `cargo horizon-mod` (`new`, `build`, `run`), `horizon-mod-sdk` | preview | 0.1.0 | +| Shader API | not started | | +| `horizon-ctl` commands and MCP tools | preview | none yet (unversioned) | +| The game's own control-socket commands outside `horizon-ctl`'s table (test hooks) | experimental | | +| `horizon-server` commands, `server.toml` | stable | `horizon-server --version` | +| Server control API | stable | `/api/v1` | +| `horizon-launcher` commands and MCP tools | preview | none yet (unversioned) | +| Benchmark report | stable | `"version": 1` | +| Telemetry batch and consent | stable | `"schema": 1`, consent `2` | +| `horizon-graphics.txt`, `horizon-extras.txt`, `horizon-mods.txt` | preview | none | +| `SHA256SUMS` and `SHA256SUMS.sig` | stable | | diff --git a/website/docs/apis.md b/website/docs/apis.md new file mode 100644 index 000000000..0c4d431db --- /dev/null +++ b/website/docs/apis.md @@ -0,0 +1,34 @@ +# Horizon's APIs + +Horizon is built to be built on. Mods, shaders, agents, server panels, launchers' scripts and tools all get a documented API with a version, a stability level and a reference generated from the code, so it never says something the game doesn't do. + +## What you can build on + +| Surface | For | Today | Stability | +| --- | --- | --- | --- | +| **Mods** | mod authors | Rust compiled to sandboxed WebAssembly: read the player and the clock, chat, a HUD panel, storage, commands, tick and frame hooks; data-driven blocks and items | preview | +| **Shaders** | shader authors | a new shader API in WGSL is being designed: stages with typed inputs, options, reload on save, a debug overlay | planned | +| **Agent control** | AI agents, scripts, tests | `horizon-ctl` and its MCP server: 96 commands to watch and play the game | preview | +| **Servers** | hosts, panels, bots | `horizon-server`'s commands, `server.toml` and a local HTTP control API | stable | +| **Launcher** | your agent, pack makers | `horizon-launcher`'s 46 commands and its MCP server | preview | +| **Data formats** | tools that read Horizon's files | benchmark reports, telemetry, settings, release checksums; worlds are vanilla's format | per format | + +The full pages, one per surface, are in the repository: [docs/api](https://github.com/ludovic111/horizon/tree/main/docs/api). Mods for players: [Mods](/docs/mods). Agents: [Control Horizon with your AI agent](/docs/agents). Hosting: [Host a server](/docs/hosting). + +## What the levels mean + +- **Stable**: only additions within a major version. A change that would break you comes as a new major, served beside the old one for at least 180 days. +- **Preview**: documented and tested. It may change at a new line (0.1 to 0.2), after a deprecation of at least 30 days during which old and new both work. +- **Experimental**: opt-in only, and it may change in any release. + +Every API has its own version (the mod API is `horizon:mods@0.1.0`, the server's control API is `/api/v1`), separate from the game's release number. The whole policy: [stability and versioning](https://github.com/ludovic111/horizon/blob/main/docs/api/stability.md). + +## How they are designed + +Each API starts from what its users need to do, and from how Horizon is built: Rust, wgpu, WebAssembly and a server thread that runs every world. Horizon's APIs are its own: they are not modelled on another mod loader's, renderer's or server platform's. Vanilla Minecraft 26.3 is the reference for game concepts such as ids, commands and data packs. + +They are safe by default (mods run in a sandbox with the permissions you allow; control sockets only listen on your computer, behind a token) and cost nothing when unused. + +## References that can't drift + +Each reference is written by code from the source it describes, and a test fails when the two differ: the mod API from its WIT contract, `horizon-ctl` and the launcher from their command tables, the server from its settings template and route table. A change to an API changes its reference in the same pull request. diff --git a/website/docs/nav.json b/website/docs/nav.json index e44fddb26..3a88a0069 100644 --- a/website/docs/nav.json +++ b/website/docs/nav.json @@ -3,5 +3,6 @@ { "group": "Playing", "pages": ["settings", "multiplayer", "troubleshooting"] }, { "group": "Hosting", "pages": ["hosting"] }, { "group": "Going further", "pages": ["modpacks", "mods", "performance", "agents"] }, + { "group": "Build on Horizon", "pages": ["apis"] }, { "group": "Project", "pages": ["contributing", "faq"] } ] From e5bfce3b37e94b6583b37d6061aa1cd428dfaa0d Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Sat, 24 Oct 2026 20:53:43 +0200 Subject: [PATCH 014/169] Horizon APIs: ways in for mods, server mods as api 0.3, who promotes to stable docs/api/mods.md gets "Ways in": one API (the WIT world) and one sandbox (WebAssembly) for every language. Rust is first-class; Lua scripts are planned, run by an interpreter that is itself a WebAssembly mod linked with the script's capabilities only, with hot reload of the script; C, C++, Zig, TinyGo, AssemblyScript and JavaScript/TypeScript are to be evaluated, each listed with its cost measured against Rust. Server mods are their own line (api 0.3); block entities are no longer tied to a draft. Promotion to stable: the orchestrator proposes with the evidence, Ludovic approves. Co-Authored-By: Claude Opus 5.5 --- docs/api/mods.md | 29 ++++++++++++++++++++++++++--- docs/api/stability.md | 7 +++++-- website/docs/apis.md | 2 +- 3 files changed, 32 insertions(+), 6 deletions(-) diff --git a/docs/api/mods.md b/docs/api/mods.md index ec42bc0db..bec03e84e 100644 --- a/docs/api/mods.md +++ b/docs/api/mods.md @@ -46,27 +46,50 @@ call, 4 MiB of storage, fuel per call). - `crates/horizon-mods/tests/guest`: a mod that misbehaves on command (spins, panics, grows its memory), for the sandbox tests. +## Ways in + +One API (the WIT world) and one sandbox (WebAssembly), whatever the mod is written in. Every way in produces a +component for the same world, checked against the same capabilities and given the same limits; there is no second +scripting runtime in the game. + +| Way in | For | Status | Template and example | +| --- | --- | --- | --- | +| Rust | most mods; the fastest | first-class: the SDK, `cargo horizon-mod` | `cargo horizon-mod new`, `coords-hud` | +| Lua scripts | people who don't want a compiler | planned: a script mod whose code is a `.lua` file, run by Horizon's own interpreter mod | planned, with the same example as Rust | +| C, C++, Zig | authors of those languages | to evaluate: bindings generated from the WIT, built without WASI | one each if it passes | +| Go (TinyGo), AssemblyScript, JavaScript / TypeScript | authors of those languages | to evaluate: each needs its toolchain to emit a component without WASI imports, or an interpreter mod as for Lua | one each if it passes | + +- **Scripts run inside the sandbox.** The Lua interpreter is itself a WebAssembly mod, built in Rust with the SDK and + shipped by Horizon. A script mod's manifest names the interpreter and its own capabilities; the game links the + interpreter with only those, so a script can do exactly what a compiled mod with the same manifest can. +- **Hot reload.** The game keeps the interpreter compiled and loads the script into a fresh instance when the file + changes, without restarting the game; what it saved with `storage` survives, as for dev mods. +- **Measured, not guessed.** Each way in is listed with its measured cost on the same tick-heavy example (time and + fuel per tick, memory, load time) against Rust, and a language is supported only with a template, an example and a + test that builds and loads it in CI. + ## Stability Preview ([stability.md](stability.md)): API 0.1 and content 0.2 are served together; a mod built for 0.1.0 keeps -loading on every 0.1.x game. Block entities (draft #1189, `api = "0.4"`) are experimental. +loading on every 0.1.x game. Server mods come as their own line, `api = "0.3"`, experimental first. ## Not there yet What real mods need next, in the order modpacks and servers need it: -- **Server mods**: the same component running on the server thread and the dedicated server, with world events (block +- **Server mods** (`api = "0.3"`): the same component running on the server thread and the dedicated server, with world events (block broken or placed, entity spawned or killed, player joined or left), game rules and server commands with typed arguments. - **World and blocks**: read blocks, block states and biomes in loaded chunks; change them through the server's block log, so clients and the parity harnesses see vanilla's updates. - **Items and inventories**: the player's inventory, held item and open container; item stacks with components. - **Entities**: query and change entities near a position; spawn from a mod's own entity types (data first). -- **Block entities and menus**: ticking machines with slots and their screens (draft #1189 is the first step). +- **Block entities and menus**: ticking machines with slots and their screens. - **Screens and UI**: widgets built from vanilla's, a screen the mod owns, a settings page under Options > Mods. - **Networking**: a channel between a mod's two halves, client and server, typed by the mod's own WIT. - **Config**: typed settings the game shows and stores for the mod, on the server too. - **Keys and the crosshair target**: keybinds in Controls; what the player is looking at. +- **Script mods and other languages**: see [Ways in](#ways-in). - **SDK**: a headless test runner (load a mod, feed it ticks and events, assert on its output, no window), templates per kind of mod, typed wrappers in the SDK for every interface. Dev mods already reload when rebuilt. diff --git a/docs/api/stability.md b/docs/api/stability.md index deca14d1d..2d4476fc7 100644 --- a/docs/api/stability.md +++ b/docs/api/stability.md @@ -45,7 +45,9 @@ Every part of an API has one level, shown in its reference and its surface page. | Needs | a design note | a generated reference, a guide section, an example, compatibility tests | the same, plus one line of real use without a break | - **Promotion.** Experimental → preview when it has what the table asks. Preview → stable when real users (a published - mod, a host's script, an agent's tool) used it for a whole line and nothing broke; Ludovic decides that step. + mod, a host's script, an agent's tool) used it for a whole line and nothing broke. The maintainers' orchestrator + proposes the promotion with the evidence (the compatibility tests, the complete docs, that line of use) and Ludovic + approves it. - **Horizon-only by design.** An API is stable only for what Horizon itself does; a vanilla concept it exposes (a block id, a command, a `server.properties` key) changes when vanilla changes it, with a version port ([version-ports.md](../version-ports.md)), and the changelog says so. @@ -86,7 +88,8 @@ Deprecations and breaking changes are in bold. The release notes of the game rel | --- | --- | --- | | Mod API: `log`, `game`, `chat`, `hud`, `storage`, `events` | preview | 0.1.0 | | Content mods (`registries`: data-driven blocks and items) | preview | manifest `api = "0.2"` | -| Block entities for code mods (draft #1189) | experimental | manifest `api = "0.4"` | +| Server mods (events, world, server commands) | not started | manifest `api = "0.3"`, experimental first | +| Script mods (Lua run by an interpreter mod, [mods.md](mods.md#ways-in)) | not started | | | `cargo horizon-mod` (`new`, `build`, `run`), `horizon-mod-sdk` | preview | 0.1.0 | | Shader API | not started | | | `horizon-ctl` commands and MCP tools | preview | none yet (unversioned) | diff --git a/website/docs/apis.md b/website/docs/apis.md index 0c4d431db..f948b1d54 100644 --- a/website/docs/apis.md +++ b/website/docs/apis.md @@ -6,7 +6,7 @@ Horizon is built to be built on. Mods, shaders, agents, server panels, launchers | Surface | For | Today | Stability | | --- | --- | --- | --- | -| **Mods** | mod authors | Rust compiled to sandboxed WebAssembly: read the player and the clock, chat, a HUD panel, storage, commands, tick and frame hooks; data-driven blocks and items | preview | +| **Mods** | mod authors | Rust compiled to sandboxed WebAssembly: read the player and the clock, chat, a HUD panel, storage, commands, tick and frame hooks; data-driven blocks and items. Lua scripts, run in the same sandbox, are planned | preview | | **Shaders** | shader authors | a new shader API in WGSL is being designed: stages with typed inputs, options, reload on save, a debug overlay | planned | | **Agent control** | AI agents, scripts, tests | `horizon-ctl` and its MCP server: 96 commands to watch and play the game | preview | | **Servers** | hosts, panels, bots | `horizon-server`'s commands, `server.toml` and a local HTTP control API | stable | From aee0b8b5892c5c22083f4c2539ff1a05cc2bf0f5 Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Sat, 24 Oct 2026 21:07:26 +0200 Subject: [PATCH 015/169] Format the endpoint table Co-Authored-By: Claude Opus 5.5 --- crates/horizon-server/src/api.rs | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/crates/horizon-server/src/api.rs b/crates/horizon-server/src/api.rs index 3b0741e8a..7d0ca8918 100644 --- a/crates/horizon-server/src/api.rs +++ b/crates/horizon-server/src/api.rs @@ -32,7 +32,10 @@ const LOG_LINES: usize = 2000; const METRICS: usize = 600; /// One endpoint of the control API: what the reference (docs/api/server-reference.md) says about it. -#[cfg_attr(not(test), expect(dead_code, reason = "only the reference reads all of it"))] +#[cfg_attr( + not(test), + expect(dead_code, reason = "only the reference reads all of it") +)] pub struct Route { pub method: &'static str, pub path: &'static str, From 352645b41711436306bc30e41e139b2d3809005a Mon Sep 17 00:00:00 2001 From: levzzz <86072227+levzzz5154@users.noreply.github.com> Date: Sun, 25 Oct 2026 00:07:31 +0500 Subject: [PATCH 016/169] Predict block placement on the client, so fast bridging stops losing clicks MultiPlayerGameMode.useItemOn places the block on the client's level at once, kept under the use's sequence until BlockChangedAck. Without it the next fast click aimed past the block still on its way from the server, the server refused it, and the arm swung for nothing. Co-Authored-By: Claude Opus 5.5 --- crates/horizon-client/src/game/remote.rs | 56 +++++++++++++++++++----- 1 file changed, 46 insertions(+), 10 deletions(-) diff --git a/crates/horizon-client/src/game/remote.rs b/crates/horizon-client/src/game/remote.rs index da0def0fb..e54b33b02 100644 --- a/crates/horizon-client/src/game/remote.rs +++ b/crates/horizon-client/src/game/remote.rs @@ -3862,11 +3862,17 @@ impl Game<'_> { self.predict_item_on_block(stack, &hit); } if held_block { - if reacts - || held - .as_ref() - .is_some_and(|stack| self.remote_can_place(&hit, stack)) - { + let placed = if reacts { + None + } else { + held.as_ref() + .and_then(|stack| self.remote_can_place(&hit, stack)) + }; + if let Some(placed) = &placed { + self.predict_place(placed, seq); + self.with_hand(hand, Game::consume_held); + } + if reacts || placed.is_some() { self.with_hand(hand, Game::swing_arm); } // BlockItem.place returns FAIL when placement is rejected: @@ -3997,12 +4003,41 @@ impl Game<'_> { }) } - /// Run BlockItem.place on a disposable level before predicting its swing. - /// The real level supplies collision shapes and building-blocking entities; - /// block writes, random draws, scheduled ticks and events stay in the preview. - fn remote_can_place(&mut self, hit: &super::Hit, stack: &ItemStack) -> bool { + /// MultiPlayerGameMode.useItemOn inside startPrediction, for a block item: + /// the blocks `BlockItem.place` set are placed on this client's level at + /// once, each kept as predicted under the use's sequence until the server + /// acknowledges it (a placement the server refused goes back). Without + /// this, the next click of a fast bridge aims past the block still on its + /// way from the server, and the server refuses it. + fn predict_place( + &mut self, + changes: &[(horizon_core::position::BlockPos, BlockStateId)], + seq: i32, + ) { + for &(p, state) in changes { + let pos = [p.x, p.y, p.z]; + let before = self.world.block(p.x, p.y, p.z); + // BlockStatePredictionHandler.retainKnownServerState. + if let Some(r) = self.remote.as_mut() { + r.predictions + .entry(pos) + .and_modify(|e| e.0 = seq) + .or_insert((seq, before.0 as i32)); + } + self.set_block(pos, state.0 as i32); + } + } + + /// Run BlockItem.place on a disposable level: the blocks it set, if it + /// placed. The real level supplies collision shapes and building-blocking + /// entities; random draws, scheduled ticks and events stay in the preview. + fn remote_can_place( + &mut self, + hit: &super::Hit, + stack: &ItemStack, + ) -> Option> { if !self.may_build() { - return false; + return None; } let ctx = horizon_world::level::PlaceContext { clicked_pos: horizon_core::position::BlockPos::new(hit.pos[0], hit.pos[1], hit.pos[2]), @@ -4025,6 +4060,7 @@ impl Game<'_> { ), horizon_world::level::PlaceOutcome::Placed { .. } ) + .then(|| level.changed.into_iter().collect()) }) } From 4c65ed2f5c6c4e089cf4f0bec4b32ab97004e4bc Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Sat, 24 Oct 2026 21:09:07 +0200 Subject: [PATCH 017/169] Shader packs, clean room 4: function-like macros and the standard macros The macro engine the GLSL preprocessor needs, shared with the .properties reader: function-like macros take their arguments (expanded first, raw beside ##, which pastes) when a ( follows their name; a macro is still not expanded inside its own expansion. Text is cut into preprocessing tokens, so numbers such as 1e5 or 0x1F are never mistaken for names. The #if/#elif/#else/#endif state moves out of the .properties reader so the preprocessor uses the same code. Standard macros: MC_GL_VERSION and MC_GLSL_VERSION 460, the 24 MC_RENDER_STAGE_* as ascending integers in draw order, render and shadow quality 1.0, MC_HAND_DEPTH 0.125, MAX_COLOR_BUFFERS 16. Nothing uses it yet: players see no change. Co-Authored-By: Claude Opus 5.5 --- crates/horizon-shaders/src/condition.rs | 104 ++++++++++ crates/horizon-shaders/src/lib.rs | 2 +- crates/horizon-shaders/src/macros.rs | 242 ++++++++++++++++++++--- crates/horizon-shaders/src/properties.rs | 98 +++------ 4 files changed, 343 insertions(+), 103 deletions(-) diff --git a/crates/horizon-shaders/src/condition.rs b/crates/horizon-shaders/src/condition.rs index b911eb985..c476bb663 100644 --- a/crates/horizon-shaders/src/condition.rs +++ b/crates/horizon-shaders/src/condition.rs @@ -20,6 +20,110 @@ pub fn eval_condition(expr: &str, macros: &Macros) -> Result { } } +/// The text after a line's `#`, split into the directive word and the rest without its `//` +/// comment. `None` when the first word is followed by something other than white space, `//` or +/// the end of the line (`#ifdefault=1` is a comment, not `#ifdef`). +pub(crate) fn split_directive(after_hash: &str) -> Option<(&str, &str)> { + let line = after_hash.trim_start(); + let len = line + .find(|c: char| !c.is_ascii_alphabetic()) + .unwrap_or(line.len()); + let (word, rest) = line.split_at(len); + let ok = rest.is_empty() || rest.starts_with(char::is_whitespace) || rest.starts_with("//"); + ok.then(|| (word, rest.split("//").next().unwrap_or("").trim())) +} + +/// One level of `#if` ... `#endif`. +struct Branch { + /// This branch's lines are read. + on: bool, + /// A branch of this `#if` was already taken (the rest are skipped). + taken: bool, + /// The enclosing level is read. + outer: bool, + seen_else: bool, +} + +/// The state of nested conditional directives. +#[derive(Default)] +pub(crate) struct Conditionals(Vec); + +impl Conditionals { + /// Lines here are read. + pub(crate) fn active(&self) -> bool { + self.0.last().is_none_or(|b| b.on) + } + + /// An `#if` is still open. + pub(crate) fn open(&self) -> bool { + !self.0.is_empty() + } + + /// Applies `#word rest` when it is a conditional directive (`Ok(false)` when it is not). A + /// condition that can't be evaluated reads as false and returns why. + pub(crate) fn apply( + &mut self, + word: &str, + rest: &str, + macros: &Macros, + ) -> Result { + let on = self.active(); + match word { + "if" | "ifdef" | "ifndef" => { + let value = if on { + test(word, rest, macros) + } else { + Ok(false) + }; + let v = *value.as_ref().unwrap_or(&false); + self.0.push(Branch { + on: v, + taken: v, + outer: on, + seen_else: false, + }); + value.map(|_| true) + } + "elif" | "else" => { + let b = self + .0 + .last_mut() + .ok_or_else(|| format!("`#{word}` without `#if`"))?; + if b.seen_else { + return Err(format!("`#{word}` after `#else`")); + } + b.seen_else = word == "else"; + let take = b.outer && !b.taken; + let value = match word { + "else" => Ok(take), + _ if take => test("if", rest, macros), + _ => Ok(false), + }; + b.on = *value.as_ref().unwrap_or(&false); + b.taken |= b.on; + value.map(|_| true) + } + "endif" => self + .0 + .pop() + .map(|_| true) + .ok_or_else(|| "`#endif` without `#if`".into()), + _ => Ok(false), + } + } +} + +fn test(word: &str, rest: &str, macros: &Macros) -> Result { + let name = rest.split_whitespace().next().unwrap_or(""); + match word { + "ifdef" => Ok(macros.is_defined(name)), + "ifndef" => Ok(!macros.is_defined(name)), + _ => eval_condition(rest, macros) + .map(|v| v != 0) + .map_err(|e| format!("`#{word} {rest}`: {e}; read as false")), + } +} + /// `defined X` and `defined(X)` become `1` or `0` before anything is expanded. fn resolve_defined(expr: &str, macros: &Macros) -> Result { let mut out = String::with_capacity(expr.len()); diff --git a/crates/horizon-shaders/src/lib.rs b/crates/horizon-shaders/src/lib.rs index bdfef7067..05e51a53d 100644 --- a/crates/horizon-shaders/src/lib.rs +++ b/crates/horizon-shaders/src/lib.rs @@ -18,6 +18,6 @@ mod properties; pub use condition::eval_condition; pub use discover::{Found, discover}; pub use lang::Lang; -pub use macros::{MC_VERSION, Macros}; +pub use macros::{MC_VERSION, Macros, RENDER_STAGES}; pub use pack::{Pack, PackError}; pub use properties::{Entry, Note, Properties}; diff --git a/crates/horizon-shaders/src/macros.rs b/crates/horizon-shaders/src/macros.rs index f3a53722f..d8a184f41 100644 --- a/crates/horizon-shaders/src/macros.rs +++ b/crates/horizon-shaders/src/macros.rs @@ -22,12 +22,48 @@ pub const fn mc_version(id: &str) -> u32 { parts[0] * 10000 + parts[1] * 100 + parts[2] } +#[derive(Clone, Debug, PartialEq)] +struct Macro { + /// `None` for an object-like macro; the parameter names of a function-like one. + params: Option>, + body: String, +} + #[derive(Clone, Debug, Default, PartialEq)] -pub struct Macros(BTreeMap); +pub struct Macros(BTreeMap); + +/// `MC_RENDER_STAGE_*` in the order the stages draw (spec 5.4); each is its index (OQ-7). +pub const RENDER_STAGES: [&str; 24] = [ + "NONE", + "SKY", + "SUNSET", + "CUSTOM_SKY", + "SUN", + "MOON", + "STARS", + "VOID", + "TERRAIN_SOLID", + "TERRAIN_CUTOUT_MIPPED", + "TERRAIN_CUTOUT", + "ENTITIES", + "BLOCK_ENTITIES", + "DESTROY", + "OUTLINE", + "DEBUG", + "HAND_SOLID", + "TERRAIN_TRANSLUCENT", + "TRIPWIRE", + "PARTICLES", + "CLOUDS", + "RAIN_SNOW", + "WORLD_BORDER", + "HAND_TRANSLUCENT", +]; impl Macros { - /// The standard macros that need no renderer: `MC_VERSION` and this system's `MC_OS_*`. - /// The graphics ones arrive with the renderer. + /// The standard macros that need no renderer (spec 1.5.1): `MC_VERSION`, this system's + /// `MC_OS_*`, the GL and GLSL versions Horizon's translation accepts, the render stages and + /// the host settings at their defaults. The GPU vendor and family arrive with the renderer. pub fn standard() -> Self { let mut m = Self::default(); m.define("MC_VERSION", MC_VERSION.to_string()); @@ -38,11 +74,32 @@ impl Macros { _ => "MC_OS_OTHER", }; m.define(os, ""); + m.define("MC_GL_VERSION", "460"); + m.define("MC_GLSL_VERSION", "460"); + for (i, stage) in RENDER_STAGES.iter().enumerate() { + m.define(format!("MC_RENDER_STAGE_{stage}"), i.to_string()); + } + m.define("MC_RENDER_QUALITY", "1.0"); + m.define("MC_SHADOW_QUALITY", "1.0"); + m.define("MC_HAND_DEPTH", "0.125"); + m.define("MAX_COLOR_BUFFERS", "16"); m } pub fn define(&mut self, name: impl Into, value: impl Into) { - self.0.insert(name.into(), value.into()); + let body = value.into(); + self.0.insert(name.into(), Macro { params: None, body }); + } + + pub fn define_function(&mut self, name: &str, params: Vec, body: &str) { + let body = body.to_owned(); + self.0.insert( + name.to_owned(), + Macro { + params: Some(params), + body, + }, + ); } pub fn undef(&mut self, name: &str) { @@ -53,43 +110,158 @@ impl Macros { self.0.contains_key(name) } + /// The value of an object-like macro. pub fn get(&self, name: &str) -> Option<&str> { - self.0.get(name).map(String::as_str) + self.0 + .get(name) + .filter(|m| m.params.is_none()) + .map(|m| m.body.as_str()) } - /// `text` with every identifier that names a macro replaced by its value, repeatedly; a macro - /// is not expanded again inside its own expansion, so `A` defined as `A + 1` stops. + /// `text` with every macro expanded, repeatedly; a macro is not expanded again inside its own + /// expansion, so `A` defined as `A + 1` stops. Function-like macros take their arguments + /// (expanded first, raw beside `##`, which pastes) when a `(` follows their name. pub fn expand(&self, text: &str) -> String { self.expand_hiding(text, &mut Vec::new()) } fn expand_hiding<'a>(&'a self, text: &str, hidden: &mut Vec<&'a str>) -> String { let mut out = String::with_capacity(text.len()); - let mut rest = text; - while let Some(start) = rest.find(is_ident_start) { - out.push_str(&rest[..start]); - // A digit run glued to letters (`1e5`, `0x1F`) is a number, not a name. - let glued = out - .chars() - .next_back() - .is_some_and(|c| c.is_ascii_alphanumeric() || c == '.'); - let len = rest[start..] - .find(|c: char| !is_ident(c)) - .unwrap_or(rest.len() - start); - let word = &rest[start..start + len]; - match self.0.get_key_value(word) { - Some((name, value)) if !glued && !hidden.contains(&name.as_str()) => { - hidden.push(name); - out.push_str(&self.expand_hiding(value, hidden)); - hidden.pop(); - } - _ => out.push_str(word), + let tokens = lex(text); + let mut i = 0; + while i < tokens.len() { + let word = tokens[i]; + i += 1; + let Some((name, m)) = self.0.get_key_value(word) else { + out.push_str(word); + continue; + }; + if hidden.contains(&name.as_str()) { + out.push_str(word); + continue; } - rest = &rest[start + len..]; + let body = match &m.params { + None => m.body.clone(), + Some(params) => { + let Some((args, next)) = arguments(&tokens, i) else { + out.push_str(word); + continue; + }; + i = next; + self.substitute(params, &args, &m.body, hidden) + } + }; + hidden.push(name); + out.push_str(&self.expand_hiding(&body, hidden)); + hidden.pop(); } - out.push_str(rest); out } + + /// A function-like macro's body with its parameters replaced. + fn substitute<'a>( + &'a self, + params: &[String], + args: &[String], + body: &str, + hidden: &mut Vec<&'a str>, + ) -> String { + let tokens = lex(body); + let pasted = |at: usize, step: isize| { + let mut j = at as isize + step; + while (0..tokens.len() as isize).contains(&j) && tokens[j as usize].trim().is_empty() { + j += step; + } + (0..tokens.len() as isize).contains(&j) && tokens[j as usize] == "##" + }; + let mut out = String::new(); + for (at, token) in tokens.iter().enumerate() { + match params.iter().position(|p| p == token) { + Some(k) => { + let arg = args.get(k).map_or("", |a| a.trim()); + if pasted(at, -1) || pasted(at, 1) { + out.push_str(arg); + } else { + out.push_str(&self.expand_hiding(arg, hidden)); + } + } + None => out.push_str(token), + } + } + // `a ## b` → `ab`. + let mut joined = String::with_capacity(out.len()); + for (k, part) in out.split("##").enumerate() { + joined.push_str(if k == 0 { part.trim_end() } else { part.trim() }); + } + if out.contains("##") { joined } else { out } + } +} + +/// The arguments of a call whose `(` is the next non-blank token from `i`, split at top-level +/// commas, and the index after its `)`. `None` when no `(` follows or it never closes. +fn arguments(tokens: &[&str], mut i: usize) -> Option<(Vec, usize)> { + while tokens.get(i)?.trim().is_empty() { + i += 1; + } + if tokens[i] != "(" { + return None; + } + let (mut depth, mut args, mut from) = (0, Vec::new(), i + 1); + for (j, t) in tokens.iter().enumerate().skip(i + 1) { + match *t { + "(" => depth += 1, + ")" if depth == 0 => { + args.push(tokens[from..j].concat()); + return Some((args, j + 1)); + } + ")" => depth -= 1, + "," if depth == 0 => { + args.push(tokens[from..j].concat()); + from = j + 1; + } + _ => {} + } + } + None +} + +/// Preprocessing tokens: identifiers, numbers (with their suffixes and exponents), runs of +/// white space, `##`, and single characters. Concatenated they give back `text`. +pub(crate) fn lex(text: &str) -> Vec<&str> { + let bytes = text.as_bytes(); + let mut out = Vec::new(); + let mut i = 0; + while i < bytes.len() { + let c = bytes[i] as char; + let start = i; + i += 1; + if is_ident_start(c) { + while i < bytes.len() && is_ident(bytes[i] as char) { + i += 1; + } + } else if c.is_ascii_digit() || (c == '.' && bytes.get(i).is_some_and(u8::is_ascii_digit)) { + while i < bytes.len() { + let d = bytes[i] as char; + let exp_sign = (d == '+' || d == '-') && matches!(bytes[i - 1], b'e' | b'E'); + if !(is_ident(d) || d == '.' || exp_sign) { + break; + } + i += 1; + } + } else if c.is_whitespace() { + while i < bytes.len() && (bytes[i] as char).is_whitespace() { + i += 1; + } + } else if c == '#' && bytes.get(i) == Some(&b'#') { + i += 1; + } else { + while !text.is_char_boundary(i) { + i += 1; + } + } + out.push(&text[start..i]); + } + out } pub(crate) fn is_ident_start(c: char) -> bool { @@ -128,4 +300,18 @@ mod tests { m.define("e5", "x"); assert_eq!(m.expand("1e5"), "1e5"); } + + #[test] + fn function_like_macros_take_arguments_and_paste() { + let mut m = Macros::default(); + m.define("N", "4"); + m.define_function("SQ", vec!["x".into()], "((x) * (x))"); + m.define_function("CAT", vec!["a".into(), "b".into()], "a ## b"); + m.define_function("PI", vec![], "3.14"); + assert_eq!(m.expand("SQ(N + 1)"), "((4 + 1) * (4 + 1))"); + assert_eq!(m.expand("SQ(min(N, 2))"), "((min(4, 2)) * (min(4, 2)))"); + assert_eq!(m.expand("CAT(N, 2) CAT(col, ortex4)"), "N2 colortex4"); + assert_eq!(m.expand("PI() SQ SQ(1"), "3.14 SQ SQ(1"); + assert_eq!(m.get("SQ"), None); + } } diff --git a/crates/horizon-shaders/src/properties.rs b/crates/horizon-shaders/src/properties.rs index fc3f00c81..b9d27f3e3 100644 --- a/crates/horizon-shaders/src/properties.rs +++ b/crates/horizon-shaders/src/properties.rs @@ -6,7 +6,8 @@ //! No other escape is read: values are names, numbers and expressions. A later duplicate key //! replaces the earlier one, with a note. -use crate::{Macros, eval_condition}; +use crate::Macros; +use crate::condition::{Conditionals, split_directive}; /// One `key=value`, with the line it starts on (from 1). #[derive(Clone, Debug, PartialEq)] @@ -30,29 +31,20 @@ pub struct Properties { pub notes: Vec, } -/// One branch level of `#if` ... `#endif`. -struct Branch { - /// This branch's lines are read. - on: bool, - /// A branch of this `#if` was already taken (the rest are skipped). - taken: bool, - /// The enclosing level is read. - outer: bool, - seen_else: bool, -} - impl Properties { /// Reads `text`; `#define`/`#undef` change the macros for the lines after them only. pub fn parse(text: &str, macros: &Macros) -> Self { let mut out = Self::default(); let mut macros = macros.clone(); - let mut branches: Vec = Vec::new(); + let mut conditionals = Conditionals::default(); let mut lines = text.lines().zip(1u32..); while let Some((raw, number)) = lines.next() { let line = raw.trim(); - let on = branches.last().is_none_or(|b| b.on); + let on = conditionals.active(); if let Some(directive) = line.strip_prefix('#') { - out.directive(directive.trim_start(), number, &mut branches, &mut macros); + if let Some((word, rest)) = split_directive(directive) { + out.directive(word, rest, number, &mut conditionals, &mut macros); + } continue; } // Continuation lines belong to their entry even inside a skipped branch. @@ -76,7 +68,7 @@ impl Properties { _ => out.note(number, "not a key=value line"), } } - if !branches.is_empty() { + if conditionals.open() { out.note(text.lines().count() as u32, "`#if` without `#endif`"); } out @@ -111,72 +103,30 @@ impl Properties { }); } - /// A line starting with `#`. It is a directive only when its first word is one; anything - /// else (`# text`, `#commented.key=1`, `#ifdefault`) is a comment. + /// A line starting with `#` whose first word may be a directive; any other word makes it a + /// comment. fn directive( &mut self, - line: &str, + word: &str, + rest: &str, number: u32, - branches: &mut Vec, + conditionals: &mut Conditionals, macros: &mut Macros, ) { - let word_len = line - .find(|c: char| !c.is_ascii_alphabetic()) - .unwrap_or(line.len()); - let (word, rest) = line.split_at(word_len); - if !(rest.is_empty() || rest.starts_with(char::is_whitespace) || rest.starts_with("//")) { - return; - } - let rest = rest.split("//").next().unwrap_or("").trim(); - let on = branches.last().is_none_or(|b| b.on); - match word { - "if" | "ifdef" | "ifndef" => { - let value = on && self.condition(word, rest, number, macros); - branches.push(Branch { - on: value, - taken: value, - outer: on, - seen_else: false, - }); - } - "elif" | "else" => { - let Some(b) = branches.last_mut() else { - return self.note(number, &format!("`#{word}` without `#if`")); - }; - if b.seen_else { - return self.note(number, &format!("`#{word}` after `#else`")); + match conditionals.apply(word, rest, macros) { + Err(e) => self.note(number, &e), + Ok(true) => {} + Ok(false) if conditionals.active() => match word { + "define" => { + let (name, value) = rest.split_once(char::is_whitespace).unwrap_or((rest, "")); + macros.define(name, value.trim()); } - let take = b.outer && !b.taken; - b.seen_else = word == "else"; - b.on = take && (word == "else" || self.condition("if", rest, number, macros)); - b.taken |= b.on; - } - "endif" => { - if branches.pop().is_none() { - self.note(number, "`#endif` without `#if`"); - } - } - "define" if on => { - let (name, value) = rest.split_once(char::is_whitespace).unwrap_or((rest, "")); - macros.define(name, value.trim()); - } - "undef" if on => macros.undef(rest), - _ => {} + "undef" => macros.undef(rest), + _ => {} + }, + Ok(false) => {} } } - - fn condition(&mut self, word: &str, rest: &str, number: u32, macros: &Macros) -> bool { - let name = rest.split_whitespace().next().unwrap_or(""); - let result = match word { - "ifdef" => Ok(macros.is_defined(name) as i64), - "ifndef" => Ok(!macros.is_defined(name) as i64), - _ => eval_condition(rest, macros), - }; - result.unwrap_or_else(|e| { - self.note(number, &format!("`#{word} {rest}`: {e}; read as false")); - 0 - }) != 0 - } } /// An odd number of trailing backslashes: the last one joins the next line (`\\` is a literal). From f2399559979c1fd1a0e62c578a83ae4e5a29cd75 Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Sat, 24 Oct 2026 21:09:29 +0200 Subject: [PATCH 018/169] Shader packs, clean room 5: the GLSL preprocessor and #include A stage file goes through comment removal, #include, conditionals and macro expansion, and every output line remembers the pack file and line it came from, so later errors point at the pack's own code. - #include "x" from the including file's folder, "/x" from the shaders folder, expanded in live code only (an include inside a false #if is not read), ten levels at most, paths that leave the pack refused; a file is read once per run however often it is included. - #define, #undef, line continuations, __LINE__ and __VERSION__; #version and #extension kept apart for the translation's own header; the block comments of live code kept for the directives packs write in them (DRAWBUFFERS, buffer formats); #error and unknown directives diagnosed. Black box over the public test packs: every stage file of the base and dimension folders (126 to 219 per pack) preprocesses with no diagnostic. Nothing uses it yet: players see no change. Co-Authored-By: Claude Opus 5.5 --- crates/horizon-shaders/src/lib.rs | 3 + crates/horizon-shaders/src/pack.rs | 2 +- crates/horizon-shaders/src/preprocess.rs | 374 +++++++++++++++++++++ crates/horizon-shaders/tests/real_packs.rs | 36 +- 4 files changed, 413 insertions(+), 2 deletions(-) create mode 100644 crates/horizon-shaders/src/preprocess.rs diff --git a/crates/horizon-shaders/src/lib.rs b/crates/horizon-shaders/src/lib.rs index 05e51a53d..14f85b758 100644 --- a/crates/horizon-shaders/src/lib.rs +++ b/crates/horizon-shaders/src/lib.rs @@ -6,6 +6,7 @@ //! - [`discover`]: the packs in a `shaderpacks` folder. //! - [`Properties`]: `shaders.properties` and the id files, with their conditional directives (3.1, 1.5). //! - [`Lang`]: the pack's translated names (8.4). +//! - [`preprocess`]: a stage file through `#include` and the GLSL preprocessor, lines mapped back (1.4, 1.5). //! - [`Macros`] and [`eval_condition`]: the macros packs test, and the `#if` arithmetic (1.5). mod condition; @@ -13,6 +14,7 @@ mod discover; mod lang; mod macros; mod pack; +mod preprocess; mod properties; pub use condition::eval_condition; @@ -20,4 +22,5 @@ pub use discover::{Found, discover}; pub use lang::Lang; pub use macros::{MC_VERSION, Macros, RENDER_STAGES}; pub use pack::{Pack, PackError}; +pub use preprocess::{Diagnostic, Origin, Preprocessed, preprocess}; pub use properties::{Entry, Note, Properties}; diff --git a/crates/horizon-shaders/src/pack.rs b/crates/horizon-shaders/src/pack.rs index 113db9ac9..ae2230618 100644 --- a/crates/horizon-shaders/src/pack.rs +++ b/crates/horizon-shaders/src/pack.rs @@ -170,7 +170,7 @@ impl Pack { } /// `a/./b/../c` → `a/c`; `None` for a path that climbs out of `shaders`. -fn normalize(path: &str) -> Option { +pub(crate) fn normalize(path: &str) -> Option { let mut parts: Vec<&str> = Vec::new(); for part in path.split(['/', '\\']) { match part { diff --git a/crates/horizon-shaders/src/preprocess.rs b/crates/horizon-shaders/src/preprocess.rs new file mode 100644 index 000000000..4884f28f7 --- /dev/null +++ b/crates/horizon-shaders/src/preprocess.rs @@ -0,0 +1,374 @@ +//! The GLSL preprocessor a program's stage file goes through before translation (spec 1.4, +//! 1.5, 1.6): comments removed, `#include` expanded, conditionals evaluated, macros expanded. +//! Every output line remembers the pack file and line it came from, so errors found later point +//! at the pack's own code. +//! +//! `#include` is expanded where it stands in live code only: an include inside a false `#if` +//! is not read, so it can't fail (OQ-14). Ten levels deep at most, which also stops a file that +//! includes itself. `#version` and `#extension` are taken out of the code and kept apart: the +//! translation writes its own header. + +use std::collections::HashMap; + +use crate::Macros; +use crate::Pack; +use crate::condition::{Conditionals, split_directive}; +use crate::pack::normalize; + +const MAX_DEPTH: usize = 10; + +/// Where a line came from: an index into [`Preprocessed::files`] and a line number from 1. +#[derive(Clone, Copy, Debug, Default, PartialEq)] +pub struct Origin { + pub file: u16, + pub line: u32, +} + +#[derive(Clone, Debug, PartialEq)] +pub struct Diagnostic { + pub origin: Origin, + pub message: String, +} + +#[derive(Debug, Default)] +pub struct Preprocessed { + /// The code, one line per entry of `lines`. + pub code: String, + pub lines: Vec, + /// The pack paths of the files read, the stage file first. + pub files: Vec, + /// `#version` of the stage file: the number and the profile word, if any. + pub version: Option<(u32, Option)>, + /// `#extension` lines of live code, as written after `#extension`. + pub extensions: Vec, + /// The text of every block comment in live code (`DRAWBUFFERS:`, buffer formats). + pub comments: Vec<(Origin, String)>, + pub diagnostics: Vec, +} + +impl Preprocessed { + /// `file:line` of an output line (from 0), for messages. + pub fn locate(&self, line: usize) -> String { + let o = self.lines.get(line).copied().unwrap_or_default(); + let file = self.files.get(o.file as usize).map_or("?", String::as_str); + format!("{file}:{}", o.line) + } +} + +/// Runs the preprocessor on the stage file `path` of `pack` with `macros` defined. +pub fn preprocess(pack: &Pack, path: &str, macros: &Macros) -> Preprocessed { + let mut run = Run { + pack, + macros: macros.clone(), + conditionals: Conditionals::default(), + out: Preprocessed::default(), + code: Vec::new(), + texts: HashMap::new(), + }; + run.file(path, 0, Origin::default()); + if run.conditionals.open() { + run.diagnose(Origin::default(), "`#if` without `#endif`"); + } + run.out.code = run.code.join("\n"); + run.out +} + +struct Run<'p> { + pack: &'p Pack, + macros: Macros, + conditionals: Conditionals, + out: Preprocessed, + code: Vec, + /// Files already read: a guarded header is included many times. + texts: HashMap>, +} + +impl Run<'_> { + fn file(&mut self, path: &str, depth: usize, from: Origin) { + let cached = self + .texts + .entry(path.to_owned()) + .or_insert_with(|| self.pack.read_text(path)); + let Some(text) = cached.clone() else { + return self.diagnose(from, &format!("can't find `{path}`")); + }; + let file = match self.out.files.iter().position(|f| f == path) { + Some(i) => i, + None => { + self.out.files.push(path.to_owned()); + self.out.files.len() - 1 + } + } as u16; + let (text, comments) = strip_comments(&text); + let lines: Vec<&str> = text.split('\n').map(|l| l.trim_end_matches('\r')).collect(); + let mut comments = comments.into_iter().peekable(); + let mut n = 0; + while n < lines.len() { + let first = n; + let mut line = lines[n].to_owned(); + while line.ends_with('\\') && n + 1 < lines.len() { + line.pop(); + n += 1; + line.push_str(lines[n]); + } + n += 1; + let origin = Origin { + file, + line: first as u32 + 1, + }; + self.line(&line, origin, path, depth); + for k in first + 1..n { + self.emit( + String::new(), + Origin { + file, + line: k as u32 + 1, + }, + ); + } + while let Some((_, comment)) = comments.next_if(|(at, _)| *at < n) { + if self.conditionals.active() { + self.out.comments.push((origin, comment)); + } + } + } + } + + fn line(&mut self, line: &str, origin: Origin, path: &str, depth: usize) { + let Some(after) = line.trim_start().strip_prefix('#') else { + let code = if self.conditionals.active() { + self.macros.define("__LINE__", origin.line.to_string()); + self.macros.expand(line) + } else { + String::new() + }; + return self.emit(code, origin); + }; + self.emit(String::new(), origin); + let Some((word, rest)) = split_directive(after) else { + return self.diagnose(origin, &format!("unknown directive `#{}`", after.trim())); + }; + match self.conditionals.apply(word, rest, &self.macros) { + Err(e) => return self.diagnose(origin, &e), + Ok(true) => return, + Ok(false) if !self.conditionals.active() => return, + Ok(false) => {} + } + match word { + "define" => self.define(rest, origin), + "undef" => self.macros.undef(rest), + "include" => { + let target = rest.trim_matches(|c| c == '"' || c == '<' || c == '>'); + match resolve(path, target) { + _ if depth + 1 >= MAX_DEPTH => self.diagnose( + origin, + &format!("`{target}`: includes nest more than {MAX_DEPTH} deep"), + ), + Some(file) => { + // The include line's own (empty) output line stays; the file follows. + self.file(&file, depth + 1, origin); + } + None => self.diagnose(origin, &format!("`{target}` is outside the pack")), + } + } + "version" if depth == 0 && self.out.version.is_none() => { + let mut words = rest.split_whitespace(); + let number = words.next().and_then(|v| v.parse().ok()).unwrap_or(110); + self.out.version = Some((number, words.next().map(str::to_owned))); + self.macros.define("__VERSION__", number.to_string()); + } + "extension" => self.out.extensions.push(rest.to_owned()), + "error" => self.diagnose(origin, &format!("#error {rest}")), + "version" | "pragma" | "line" | "" => {} + _ => self.diagnose(origin, &format!("unknown directive `#{word}`")), + } + } + + /// `#define NAME body` or `#define NAME(a, b) body` (no space before the `(`). + fn define(&mut self, rest: &str, origin: Origin) { + let len = rest + .find(|c: char| !(c.is_ascii_alphanumeric() || c == '_')) + .unwrap_or(rest.len()); + let (name, tail) = rest.split_at(len); + if name.is_empty() { + return self.diagnose(origin, "`#define` without a name"); + } + if let Some(params) = tail.strip_prefix('(') { + let Some((params, body)) = params.split_once(')') else { + return self.diagnose(origin, &format!("`#define {name}(` without `)`")); + }; + let params = params + .split(',') + .map(|p| p.trim().to_owned()) + .filter(|p| !p.is_empty()) + .collect(); + self.macros.define_function(name, params, body.trim()); + } else { + self.macros.define(name, tail.trim()); + } + } + + fn emit(&mut self, code: String, origin: Origin) { + self.code.push(code); + self.out.lines.push(origin); + } + + fn diagnose(&mut self, origin: Origin, message: &str) { + self.out.diagnostics.push(Diagnostic { + origin, + message: message.to_owned(), + }); + } +} + +/// An `#include` path: from the `shaders` folder with a leading `/`, else from the including +/// file's folder (spec 1.4). `None` when it climbs out of the pack. +fn resolve(from_file: &str, target: &str) -> Option { + match target.strip_prefix('/') { + Some(absolute) => normalize(absolute), + None => { + let dir = from_file.rsplit_once('/').map_or("", |(dir, _)| dir); + normalize(&format!("{dir}/{target}")) + } + } +} + +/// `text` with comments replaced by spaces (new lines kept, so line numbers hold), and the body of +/// each block comment with the index of the line it starts on. +fn strip_comments(text: &str) -> (String, Vec<(usize, String)>) { + let mut out = String::with_capacity(text.len()); + let mut comments = Vec::new(); + let (mut rest, mut line) = (text, 0); + while let Some(at) = rest.find('/') { + let (before, from) = rest.split_at(at); + out.push_str(before); + line += before.matches('\n').count(); + if let Some(body) = from.strip_prefix("//") { + let end = body.find('\n').unwrap_or(body.len()); + rest = &body[end..]; + } else if let Some(body) = from.strip_prefix("/*") { + let end = body.find("*/").unwrap_or(body.len()); + let comment = &body[..end]; + comments.push((line, comment.to_owned())); + let newlines = comment.matches('\n').count(); + line += newlines; + out.push(' '); + out.extend(std::iter::repeat_n('\n', newlines)); + rest = body.get(end + 2..).unwrap_or(""); + } else { + out.push('/'); + rest = &from[1..]; + } + } + out.push_str(rest); + (out, comments) +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::pack::tests::zip; + + fn run(files: &[(&str, &str)]) -> Preprocessed { + let files: Vec<(String, &str)> = files + .iter() + .map(|(p, t)| (format!("shaders/{p}"), *t)) + .collect(); + let files: Vec<(&str, &str)> = files.iter().map(|(p, t)| (p.as_str(), *t)).collect(); + let pack = Pack::from_zip_bytes("P.zip", zip(&files)).unwrap(); + preprocess(&pack, "program/final.fsh", &Macros::standard()) + } + + fn code_lines(p: &Preprocessed) -> Vec<(&str, String)> { + p.code + .lines() + .enumerate() + .filter(|(_, l)| !l.trim().is_empty()) + .map(|(i, l)| (l.trim(), p.locate(i))) + .collect() + } + + #[test] + fn includes_resolve_and_lines_map_back() { + let p = run(&[ + ( + "program/final.fsh", + "#version 330 compatibility\n#include \"/lib/a.glsl\"\nvoid main() {}\n", + ), + ( + "lib/a.glsl", + "#ifndef A\n#define A\n#include \"b.glsl\"\nfloat a;\n#endif\n", + ), + ("lib/b.glsl", "// b\nfloat b;\n#include \"a.glsl\"\n"), + ]); + assert_eq!(p.version, Some((330, Some("compatibility".into())))); + assert_eq!( + code_lines(&p), + [ + ("float b;", "lib/b.glsl:2".into()), + ("float a;", "lib/a.glsl:4".into()), + ("void main() {}", "program/final.fsh:3".into()), + ] + ); + assert!(p.diagnostics.is_empty(), "{:?}", p.diagnostics); + } + + #[test] + fn missing_and_runaway_includes_are_diagnosed_where_they_stand() { + let p = run(&[( + "program/final.fsh", + "#ifdef NOPE\n#include \"gone.glsl\"\n#endif\n#include \"gone.glsl\"\n#include \"final.fsh\"\n", + )]); + let messages: Vec = p + .diagnostics + .iter() + .map(|d| format!("{}: {}", d.origin.line, d.message)) + .collect(); + assert_eq!(messages[0], "4: can't find `program/gone.glsl`"); + assert!( + messages + .last() + .unwrap() + .ends_with("includes nest more than 10 deep") + ); + assert!( + run(&[("program/final.fsh", "#include \"../../x\"")]).diagnostics[0] + .message + .contains("outside") + ); + } + + #[test] + fn macros_expand_like_the_glsl_preprocessor() { + let p = run(&[( + "program/final.fsh", + "#define SQ(x) ((x) * (x))\n#define CAT(a, b) a ## b\n#define N 4\n#define \\\n LONG 1\n\ + float v = SQ(N + 1) + CAT(N, 2) + LONG;\nint l = __LINE__;\n#if MC_VERSION > 12100 && defined MC_RENDER_STAGE_SKY\nint ok;\n#else\nint bad;\n#endif\n", + )]); + let lines: Vec<&str> = code_lines(&p).into_iter().map(|(l, _)| l).collect(); + assert_eq!( + lines, + [ + "float v = ((4 + 1) * (4 + 1)) + N2 + 1;", + "int l = 7;", + "int ok;" + ] + ); + assert_eq!(p.lines.len(), p.code.split('\n').count()); + } + + #[test] + fn comments_extensions_and_errors() { + let p = run(&[( + "program/final.fsh", + "#version 120\n#extension GL_ARB_shader_texture_lod : enable\n/* DRAWBUFFERS:04 */\n#if 0\n/* RENDERTARGETS: 1 */\n#error dead\n#endif\n\ + /* multi\nline */ float x; // gone\n#error live\n#bogus\n", + )]); + assert_eq!(p.extensions, ["GL_ARB_shader_texture_lod : enable"]); + let comments: Vec<&str> = p.comments.iter().map(|(_, c)| c.trim()).collect(); + assert_eq!(comments, ["DRAWBUFFERS:04", "multi\nline"]); + assert_eq!(code_lines(&p), [("float x;", "program/final.fsh:9".into())]); + let messages: Vec<&str> = p.diagnostics.iter().map(|d| d.message.as_str()).collect(); + assert_eq!(messages, ["#error live", "unknown directive `#bogus`"]); + } +} diff --git a/crates/horizon-shaders/tests/real_packs.rs b/crates/horizon-shaders/tests/real_packs.rs index e0ad38c25..c252df6e3 100644 --- a/crates/horizon-shaders/tests/real_packs.rs +++ b/crates/horizon-shaders/tests/real_packs.rs @@ -5,7 +5,7 @@ use std::path::Path; use std::time::Instant; -use horizon_shaders::{Lang, Macros, Pack, Properties, discover}; +use horizon_shaders::{Lang, Macros, Pack, Properties, discover, preprocess}; #[test] #[ignore = "needs HORIZON_TEST_SHADER_PACKS"] @@ -52,6 +52,40 @@ fn real_packs_read() { for n in &shaders.notes { println!(" shaders.properties:{}: {}", n.line, n.message); } + // Every stage file of the base and dimension folders through the preprocessor. + let start = Instant::now(); + let (mut stages, mut lines, mut diagnostics) = (0, 0, Vec::new()); + for dir in ["", "world0", "world-1", "world1"] { + for file in pack.list(dir) { + if [".vsh", ".fsh", ".gsh", ".csh"] + .iter() + .any(|e| file.ends_with(e)) + { + let path = if dir.is_empty() { + file + } else { + format!("{dir}/{file}") + }; + let p = preprocess(&pack, &path, ¯os); + stages += 1; + lines += p.lines.len(); + diagnostics.extend(p.diagnostics.iter().map(|d| { + let file = &p.files[d.origin.file as usize]; + format!("{file}:{}: {}", d.origin.line, d.message) + })); + } + } + } + println!( + " {stages} stage files preprocessed, {lines} lines out, {} diagnostics, {:.1} ms", + diagnostics.len(), + start.elapsed().as_secs_f64() * 1000.0 + ); + diagnostics.sort(); + diagnostics.dedup(); + for d in diagnostics.iter().take(8) { + println!(" {d}"); + } assert!(!shaders.entries.is_empty(), "{}: no keys read", f.name); read += 1; } From 7c1dd4981062ce9e0cb0db0b7d919109243b2470 Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Sat, 24 Oct 2026 21:13:00 +0200 Subject: [PATCH 019/169] Renderer: leave out solid quads that face away from the eye Meshing sorts each section's and distant tile's solid quads into seven buckets: one per axis direction (all four corners in one axis plane, both triangles wound the same way) and one for everything else, and keeps each axis bucket's extreme plane. A quad facing +X at x = p is a back face from an eye at x <= p, which the solid pipeline culls anyway, so the frame draws only the buckets that can face the eye, merged into runs of adjacent buckets: one to three indirect draws per section on the existing page-run, occlusion-culling and flat paths. The eye comes from the frame's view-projection, so view bobbing is exact. The picture does not change; `horizon-ctl section-sides on|off` switches it for A/B checks. Written from scratch from the general back-face technique; no other renderer's code or Horizon's removed code read. Co-Authored-By: Claude Opus 5.5 --- crates/horizon-client/src/game/control.rs | 10 + .../horizon-client/src/game/render_control.rs | 1 + crates/horizon-client/src/gfx.rs | 94 ++++- crates/horizon-client/src/lod/mesh.rs | 6 +- crates/horizon-client/src/mesher.rs | 14 + crates/horizon-client/src/mesher/sides.rs | 346 ++++++++++++++++++ 6 files changed, 455 insertions(+), 16 deletions(-) create mode 100644 crates/horizon-client/src/mesher/sides.rs diff --git a/crates/horizon-client/src/game/control.rs b/crates/horizon-client/src/game/control.rs index 205a66074..6fbd984fd 100644 --- a/crates/horizon-client/src/game/control.rs +++ b/crates/horizon-client/src/game/control.rs @@ -226,6 +226,16 @@ impl Game<'_> { } Ok(Some(json!({ "ok": true, "cull": r.section_cull() }))) } + "section-sides" => { + let r = self.renderer.as_mut().ok_or("no renderer")?; + match words.get(1).copied() { + None => {} + Some("on") => r.set_section_sides(true), + Some("off") => r.set_section_sides(false), + Some(other) => return Err(format!("unknown section sides mode {other}").into()), + } + Ok(Some(json!({ "ok": true, "sides": r.section_sides() }))) + } "sculk" => Ok(Some(self.sculk_command(&words)?)), "status" => Ok(Some(self.control_status())), "pad" => Ok(Some(self.pad_command(&words)?)), diff --git a/crates/horizon-client/src/game/render_control.rs b/crates/horizon-client/src/game/render_control.rs index 31a7a33a0..0a2f9b715 100644 --- a/crates/horizon-client/src/game/render_control.rs +++ b/crates/horizon-client/src/game/render_control.rs @@ -13,6 +13,7 @@ pub const HELP: &[&str] = &[ "signedit X Y Z [front|back] open the sign editor for the sign at X Y Z", "section-draws [flat|indirect] how terrain sections are drawn (A/B checks); replies the mode", "section-cull [on|off] occlusion culling of solid sections (A/B checks); replies the mode", + "section-sides [on|off] leave out solid quads facing away from the eye (A/B checks); replies the mode", ]; impl Game<'_> { diff --git a/crates/horizon-client/src/gfx.rs b/crates/horizon-client/src/gfx.rs index 9ed0bd8a5..e4c3367f9 100644 --- a/crates/horizon-client/src/gfx.rs +++ b/crates/horizon-client/src/gfx.rs @@ -6,7 +6,7 @@ use crate::{ environment::Sky, graphics::GraphicsApi, hud::{HudBatch, HudRenderer}, - mesher::{SectionMesh, TerrainVertex, Vertex}, + mesher::{SectionMesh, Sides, TerrainVertex, Vertex}, sprites::SpriteAnimation, }; use glam::{DVec3, Mat4, Vec3, Vec4}; @@ -156,6 +156,8 @@ struct SectionGpu { page: u32, start: u64, solid: u32, + /// Where the solid quads' buckets by facing side end (`mesher::Sides`). + sides: Sides, translucent: u32, sort: translucency::SortState, sorted_indices: Option<(u32, u64)>, @@ -323,6 +325,8 @@ pub struct Renderer { /// counts reach a multi-draw's entries (Vulkan, Metal). cull: Option, cull_on: bool, + /// Solid quads facing away from the eye are left out (`mesher::Sides`). + sides_on: bool, sky: wgpu::RenderPipeline, dark_disc: wgpu::RenderPipeline, lines: wgpu::RenderPipeline, @@ -2202,6 +2206,7 @@ impl Renderer { translucent, flat_on: flat.is_some(), cull_on: cull.is_some(), + sides_on: true, cull, flat, sky, @@ -2451,6 +2456,14 @@ impl Renderer { self.flat_on = on; Ok(()) } + /// Whether solid quads facing away from the eye are left out. + pub fn section_sides(&self) -> bool { + self.sides_on + } + /// Switches leaving out solid quads facing away, for A/B checks. + pub fn set_section_sides(&mut self, on: bool) { + self.sides_on = on; + } /// Whether solid sections are occlusion culled (`cull`). pub fn section_cull(&self) -> bool { self.cull_on @@ -2573,6 +2586,11 @@ impl Renderer { page, start, solid, + sides: if mesh.sides.quads() == solid { + mesh.sides + } else { + Sides::unsorted(solid) + }, translucent, sort: translucency::SortState::new( mesh.translucent @@ -3039,6 +3057,9 @@ impl Renderer { }; let camera = frame.camera; let camera_section = camera_section(camera); + // Solid quads facing away from the eye are left out: the bob moves + // the eye off `camera`, so it is found from the projection. + let eye = projection_center(view_proj).filter(|_| self.sides_on); let culling = !frame.title && frame.cave_culling; if culling { crate::spans::time("occlusion", || { @@ -3127,11 +3148,13 @@ impl Renderer { }; let start = draws.len(); let instances = u32::from(first_phase); - let indices = s.solid * 6; - if indices > 0 { - draws.push([indices, instances, 0, s.start as u32, i as u32]); + let mut indices = 0; + facing_runs(&s.sides, eye, v.origin, |first, quads| { + indices += quads * 6; + let base = s.start as u32 + first * 4; + draws.push([quads * 6, instances, 0, base, i as u32]); pages.push((s.page, None)); - } + }); let runs = if first_phase { &mut self.solid_runs } else { @@ -3168,16 +3191,12 @@ impl Renderer { for (i, v) in visible_lods.iter().enumerate() { let s = &self.lods[&v.key].mesh; let start = self.draws.len(); - if s.solid > 0 { - self.draws.push([ - s.solid * 6, - 1, - 0, - s.start as u32, - (visible.len() + i) as u32, - ]); + let instance = (visible.len() + i) as u32; + facing_runs(&s.sides, eye, v.origin, |first, quads| { + let base = s.start as u32 + first * 4; + self.draws.push([quads * 6, 1, 0, base, instance]); self.draw_pages.push((s.page, None)); - } + }); self.solid_runs .push(v.distance, s.page, start, self.draws.len() - start, [0; 3]); } @@ -4196,6 +4215,34 @@ fn world_projection(fov_degrees: f32, aspect: f32, far: f32) -> Mat4 { Mat4::perspective_rh(fov_degrees.to_radians(), aspect, far, 0.05) } +/// Where a perspective `view_proj` sees from, in its own (camera-relative) +/// space: the point whose clip x, y and w are all 0. `None` for a +/// projection without one (orthographic). +fn projection_center(view_proj: Mat4) -> Option { + let m = view_proj.as_dmat4(); + let rows = [m.row(0), m.row(1), m.row(3)]; + let a = glam::DMat3::from_cols( + DVec3::new(rows[0].x, rows[1].x, rows[2].x), + DVec3::new(rows[0].y, rows[1].y, rows[2].y), + DVec3::new(rows[0].z, rows[1].z, rows[2].z), + ); + let det = a.determinant(); + if !det.is_normal() { + return None; + } + let b = DVec3::new(rows[0].w, rows[1].w, rows[2].w); + Some((a.inverse() * -b).as_vec3()) +} +/// Calls `draw(first, quads)` for each run of a mesh's solid quads that can +/// face `eye` (`projection_center`), the mesh at the camera-relative +/// `origin`; all of them when there is no eye. +fn facing_runs(sides: &Sides, eye: Option, origin: [f32; 3], mut draw: impl FnMut(u32, u32)) { + match eye { + Some(eye) => sides.visible((eye - Vec3::from(origin)).to_array(), draw), + None if sides.quads() > 0 => draw(0, sides.quads()), + None => {} + } +} fn frustum(m: Mat4) -> [Vec4; 6] { let r = |i| m.row(i); let planes = [ @@ -4423,6 +4470,25 @@ mod tests { assert_eq!(super::outline_width(3840), 5.0); } #[test] + fn the_projection_center_follows_the_view_bob() { + use glam::{Mat4, Vec3}; + let projection = super::world_projection(70.0, 16.0 / 9.0, 512.0); + let view = crate::camera::view_matrix(30.0, 20.0); + let eye = super::projection_center(projection * view).unwrap(); + assert!(eye.length() < 1e-5, "{eye}"); + // A pose translated by the bob: the eye is where the pose's inverse + // takes the view's origin. + let bob = Mat4::from_rotation_z(0.02) * Mat4::from_translation(Vec3::new(0.03, -0.08, 0.0)); + let expected = (bob * view).inverse().transform_point3(Vec3::ZERO); + let eye = super::projection_center(projection * bob * view).unwrap(); + assert!(eye.distance(expected) < 1e-5, "{eye} {expected}"); + assert!(expected.length() > 0.05); + assert!( + super::projection_center(Mat4::orthographic_rh(-1.0, 1.0, -1.0, 1.0, 0.0, 1.0)) + .is_none() + ); + } + #[test] fn indirect_draws_are_validated_only_in_debug_builds_and_on_directx_12() { let validated = |backends| { super::instance_descriptor(backends) diff --git a/crates/horizon-client/src/lod/mesh.rs b/crates/horizon-client/src/lod/mesh.rs index 852f45e5b..bdd77fbea 100644 --- a/crates/horizon-client/src/lod/mesh.rs +++ b/crates/horizon-client/src/lod/mesh.rs @@ -67,7 +67,7 @@ impl Mesher { neighbors: &[Vec; 4], finer: &[TileKey], ) -> SectionMesh { - mesh_columns_with_edges( + let mut mesh = mesh_columns_with_edges( key, columns, covered, @@ -75,7 +75,9 @@ impl Mesher { neighbors, finer, |span, direction| self.material(span, direction, context), - ) + ); + mesh.sort_solid(); + mesh } fn material(&mut self, span: &Span, direction: Direction, context: &WorkerContext) -> Material { let styles = *self diff --git a/crates/horizon-client/src/mesher.rs b/crates/horizon-client/src/mesher.rs index ec6f2ae73..d1b27bec9 100644 --- a/crates/horizon-client/src/mesher.rs +++ b/crates/horizon-client/src/mesher.rs @@ -5,6 +5,7 @@ //! follow `FluidRenderer` (see `fluid`). mod fluid; mod lighting; +mod sides; use crate::{ assets::{Assets, RenderAssets}, biome::Biomes, @@ -20,6 +21,7 @@ use horizon_world::{ fluid::{FluidKind, FluidState}, registry::BlockStateId, }; +pub use sides::Sides; use std::sync::Arc; /// An entity, item and effect vertex (the entity pipelines), with a face @@ -114,6 +116,9 @@ mod vertex_tests { } pub struct SectionMesh { pub solid: Vec, + /// The buckets `solid` is sorted in by the side its quads face + /// (`sort_solid`; empty until then). + pub sides: Sides, pub translucent: Vec, /// VisGraph: bit `a * 6 + b` is set when faces `a` and `b` (Direction /// order) are connected through non-opaque blocks. @@ -127,12 +132,20 @@ impl Default for SectionMesh { fn default() -> Self { Self { solid: Vec::new(), + sides: Sides::default(), translucent: Vec::new(), visibility: ALL_VISIBLE, block_entities: Vec::new(), } } } +impl SectionMesh { + /// Sorts the solid quads by the side they face, for the renderer to + /// leave out those facing away from the eye (`sides`). + pub fn sort_solid(&mut self) { + self.sides = sides::sort(&mut self.solid); + } +} pub const ALL_VISIBLE: u64 = (1 << 36) - 1; /// VisGraph.resolve: flood fill non-opaque cells and connect the faces each region touches. fn visibility(pad: &Padded, info: &[Info]) -> u64 { @@ -798,6 +811,7 @@ impl Mesher<'_> { } } } + out.sort_solid(); out } /// `BlockColors` tint source `index`, or `None` for an untinted (-1) layer. diff --git a/crates/horizon-client/src/mesher/sides.rs b/crates/horizon-client/src/mesher/sides.rs new file mode 100644 index 000000000..797d60127 --- /dev/null +++ b/crates/horizon-client/src/mesher/sides.rs @@ -0,0 +1,346 @@ +//! A mesh's solid quads sorted by the side they face, so that the renderer +//! can leave out the quads turned away from the eye before the GPU shades +//! their vertices. +//! +//! A quad in the plane `x = p` whose corners go counter-clockwise seen from +//! +X faces +X. From an eye at `x < p` it is seen from behind, and at +//! `x = p` edge on; the solid pipeline culls back faces, so it draws nothing +//! from there. A bucket of such quads draws nothing at all while the eye is +//! at or below the lowest of their planes, and likewise for the other five +//! axis directions. The seventh bucket holds every other quad (sloped, +//! rotated, degenerate, or whose two triangles wind opposite ways): it is +//! drawn from everywhere. +//! +//! The buckets lie one after another in the mesh, in an order chosen so that +//! the buckets an eye can see are usually one or two runs of quads: one draw +//! each. Inside a bucket quads keep their model order, so coplanar quads +//! facing one way (an overlay on its base) still draw in that order. +use super::TerrainVertex; + +/// The buckets in mesh order: +X, +Z, other, +Y, -Z, -X, -Y. Seen from +/// above (+Y, the commonest case), each pair of horizontal sides with a +/// common corner is then one run, or two. +const BUCKETS: [Bucket; 7] = [ + Bucket::Side(0, true), + Bucket::Side(2, true), + Bucket::Other, + Bucket::Side(1, true), + Bucket::Side(2, false), + Bucket::Side(0, false), + Bucket::Side(1, false), +]; +const OTHER: usize = 2; +/// How far, in blocks, the eye must be behind a bucket's planes before the +/// bucket is left out. The renderer computes both the eye and the section +/// origins in `f32`, with errors far below this. +const MARGIN: f32 = 1.0 / 16.0; + +#[derive(Clone, Copy)] +enum Bucket { + /// Quads in a plane across `axis` facing its positive (`true`) or + /// negative direction. + Side(usize, bool), + Other, +} + +/// Where each bucket of a mesh's solid quads ends, and the planes that tell +/// whether it can face the eye. +#[derive(Clone, Copy, Debug, Default, PartialEq)] +pub struct Sides { + /// The solid quads up to the end of each bucket, in `BUCKETS` order. + ends: [u32; 7], + /// Per bucket facing a positive direction, its lowest plane; facing a + /// negative one, its highest (unused for the other bucket). + planes: [f32; 7], +} + +impl Sides { + /// `quads` solid quads in one bucket drawn from everywhere: for meshes + /// that were not sorted. + pub fn unsorted(quads: u32) -> Self { + let mut ends = [0; 7]; + ends[OTHER..].fill(quads); + Self { + ends, + planes: [0.0; 7], + } + } + + /// The number of solid quads the buckets hold. + pub fn quads(&self) -> u32 { + self.ends[6] + } + + /// Calls `draw(first, count)` for each run of quads an eye at `eye` + /// (relative to the mesh's origin) can see the front of, nearest the + /// start first. Empty buckets do not break a run. + pub fn visible(&self, eye: [f32; 3], mut draw: impl FnMut(u32, u32)) { + let mut start = 0; + let mut run: Option = None; + for (i, bucket) in BUCKETS.iter().enumerate() { + let end = self.ends[i]; + if end == start { + continue; + } + let seen = match *bucket { + Bucket::Side(axis, true) => eye[axis] > self.planes[i] - MARGIN, + Bucket::Side(axis, false) => eye[axis] < self.planes[i] + MARGIN, + Bucket::Other => true, + }; + match (seen, run) { + (true, None) => run = Some(start), + (false, Some(first)) => { + draw(first, start - first); + run = None; + } + _ => {} + } + start = end; + } + if let Some(first) = run { + draw(first, start - first); + } + } +} + +/// The bucket of a quad: the axis plane it lies in and the side its +/// triangles (corners 0, 1, 2 and 0, 2, 3, as the renderer draws them) face. +fn bucket(quad: &[TerrainVertex; 4]) -> usize { + let p = quad.map(|v| v.pos); + for axis in 0..3 { + if p.iter().any(|v| v[axis] != p[0][axis]) { + continue; + } + // The normal's component along `axis`, twice each triangle's area. + let (u, w) = ((axis + 1) % 3, (axis + 2) % 3); + let area = |a: usize, b: usize, c: usize| { + (p[b][u] - p[a][u]) * (p[c][w] - p[a][w]) - (p[b][w] - p[a][w]) * (p[c][u] - p[a][u]) + }; + let (first, second) = (area(0, 1, 2), area(0, 2, 3)); + let positive = first >= 0.0 && second >= 0.0; + let negative = first <= 0.0 && second <= 0.0; + if positive == negative { + // Opposite windings, or no area at all. + return OTHER; + } + return BUCKETS + .iter() + .position(|b| matches!(*b, Bucket::Side(a, s) if a == axis && s == positive)) + .expect("every side has a bucket"); + } + OTHER +} + +/// Reorders `solid`'s quads by bucket, keeping their order inside each. +pub fn sort(solid: &mut Vec) -> Sides { + let (quads, rest) = solid.as_chunks::<4>(); + debug_assert!(rest.is_empty(), "solid vertices come in quads"); + let buckets: Vec = quads.iter().map(|q| bucket(q) as u8).collect(); + let mut counts = [0u32; 7]; + let mut planes = [0f32; 7]; + for (quad, &b) in quads.iter().zip(&buckets) { + let b = usize::from(b); + if let Bucket::Side(axis, positive) = BUCKETS[b] { + let p = quad[0].pos[axis]; + planes[b] = match (counts[b], positive) { + (0, _) => p, + (_, true) => planes[b].min(p), + (_, false) => planes[b].max(p), + }; + } + counts[b] += 1; + } + let mut ends = [0u32; 7]; + let mut total = 0; + for (end, count) in ends.iter_mut().zip(counts) { + total += count; + *end = total; + } + if counts.iter().filter(|&&c| c > 0).count() > 1 { + let mut next: [u32; 7] = std::array::from_fn(|b| ends[b] - counts[b]); + let mut sorted = vec![quads[0]; quads.len()]; + for (quad, &b) in quads.iter().zip(&buckets) { + let slot = &mut next[usize::from(b)]; + sorted[*slot as usize] = *quad; + *slot += 1; + } + *solid = sorted.into_flattened(); + } + Sides { ends, planes } +} + +#[cfg(test)] +mod tests { + use super::*; + + fn quad(corners: [[f32; 3]; 4], layer: u16) -> [TerrainVertex; 4] { + corners.map(|p| TerrainVertex::new(p, [0.0; 2], layer, 0, 0)) + } + + /// A unit block's six faces at `origin`, wound counter-clockwise seen + /// from outside, as block models are. + fn cube(origin: [f32; 3], layer: u16) -> Vec { + let [x, y, z] = origin; + let (a, b, c) = (x + 1.0, y + 1.0, z + 1.0); + [ + [[a, y, z], [a, b, z], [a, b, c], [a, y, c]], // +X + [[x, y, z], [x, y, c], [x, b, c], [x, b, z]], // -X + [[x, b, z], [x, b, c], [a, b, c], [a, b, z]], // +Y + [[x, y, z], [a, y, z], [a, y, c], [x, y, c]], // -Y + [[x, y, c], [a, y, c], [a, b, c], [x, b, c]], // +Z + [[x, y, z], [x, b, z], [a, b, z], [a, y, z]], // -Z + ] + .into_iter() + .flat_map(|q| quad(q, layer)) + .collect() + } + + fn runs(sides: &Sides, eye: [f32; 3]) -> Vec<(u32, u32)> { + let mut out = Vec::new(); + sides.visible(eye, |first, count| out.push((first, count))); + out + } + + /// The quads of `solid` whose triangles face `eye`, by their layer. + fn front_facing(solid: &[TerrainVertex], eye: [f32; 3]) -> Vec { + let sub = |a: [f32; 3], b: [f32; 3]| [a[0] - b[0], a[1] - b[1], a[2] - b[2]]; + solid + .as_chunks::<4>() + .0 + .iter() + .filter(|q| { + [[0, 1, 2], [0, 2, 3]].iter().any(|t| { + let (e1, e2) = (sub(q[t[1]].pos, q[t[0]].pos), sub(q[t[2]].pos, q[t[0]].pos)); + let n = [ + e1[1] * e2[2] - e1[2] * e2[1], + e1[2] * e2[0] - e1[0] * e2[2], + e1[0] * e2[1] - e1[1] * e2[0], + ]; + let to_eye = sub(eye, q[t[0]].pos); + n[0] * to_eye[0] + n[1] * to_eye[1] + n[2] * to_eye[2] > 0.0 + }) + }) + .map(|q| q[0].layer) + .collect() + } + + #[test] + fn cube_faces_go_to_their_buckets_in_order() { + let mut solid = cube([3.0, 4.0, 5.0], 0); + for (i, v) in solid.iter_mut().enumerate() { + v.layer = (i / 4) as u16; + } + let sides = sort(&mut solid); + assert_eq!(sides.ends, [1, 2, 2, 3, 4, 5, 6]); + let layers: Vec = solid.iter().step_by(4).map(|v| v.layer).collect(); + // +X, +Z, +Y, -Z, -X, -Y. + assert_eq!(layers, [0, 4, 2, 5, 1, 3]); + assert_eq!(sides.planes[0], 4.0); // +X at x = 4 + assert_eq!(sides.planes[5], 3.0); // -X at x = 3 + assert_eq!(sides.planes[3], 5.0); // +Y at y = 5 + } + + #[test] + fn the_drawn_runs_hold_every_quad_that_faces_the_eye() { + // Blocks across a section, with a sloped quad and a bowtie. + let mut solid = Vec::new(); + let mut layer = 0; + for origin in [ + [0.0, 0.0, 0.0], + [7.0, 3.0, 12.0], + [15.0, 15.0, 15.0], + [2.0, 9.0, 4.0], + ] { + for q in cube(origin, 0).chunks(4) { + solid.extend(q.iter().map(|v| TerrainVertex { layer, ..*v })); + layer += 1; + } + } + let slope = [ + [1.0, 1.0, 1.0], + [2.0, 1.0, 1.0], + [2.0, 2.0, 2.0], + [1.0, 2.0, 2.0], + ]; + let bowtie = [ + [5.0, 1.0, 1.0], + [5.0, 2.0, 2.0], + [5.0, 1.0, 2.0], + [5.0, 2.0, 1.0], + ]; + for corners in [slope, bowtie] { + solid.extend(quad(corners, layer)); + layer += 1; + } + let sides = sort(&mut solid); + assert_eq!(sides.quads(), u32::from(layer)); + let eyes = [-20.0f32, -0.5, 0.0, 3.5, 8.0, 15.99, 16.0, 30.0]; + for &x in &eyes { + for &y in &eyes { + for &z in &eyes { + let eye = [x, y, z]; + let mut drawn = Vec::new(); + for (first, count) in runs(&sides, eye) { + drawn.extend( + solid[first as usize * 4..(first + count) as usize * 4] + .iter() + .step_by(4) + .map(|v| v.layer), + ); + } + for layer in front_facing(&solid, eye) { + assert!(drawn.contains(&layer), "{eye:?} misses quad {layer}"); + } + } + } + } + } + + #[test] + fn runs_merge_across_hidden_and_empty_buckets() { + let mut solid = cube([0.0; 3], 0); + let sides = sort(&mut solid); + // From above, +X and +Z: +X, +Z, (no other), +Y is one run. + assert_eq!(runs(&sides, [8.0, 8.0, 8.0]), [(0, 3)]); + // From below, -X and -Z: -Z, -X, -Y. + assert_eq!(runs(&sides, [-8.0, -8.0, -8.0]), [(3, 3)]); + // From above, -X and +Z: +Z, +Y, then -X. + assert_eq!(runs(&sides, [-8.0, 8.0, 8.0]), [(1, 2), (4, 1)]); + // Inside the block every face is seen from behind. + assert!(runs(&sides, [0.5; 3]).is_empty()); + // Level with its top, the eye may see it: the margin keeps it. + assert_eq!(runs(&sides, [0.5, 1.0, 0.5]), [(2, 1)]); + } + + #[test] + fn unsorted_meshes_draw_everything() { + let sides = Sides::unsorted(9); + assert_eq!(sides.quads(), 9); + assert_eq!(runs(&sides, [-100.0; 3]), [(0, 9)]); + assert!(runs(&Sides::unsorted(0), [0.0; 3]).is_empty()); + } + + #[test] + fn one_bucket_keeps_the_mesh_as_it_is() { + let mut solid: Vec<_> = (0..3) + .flat_map(|i| { + quad( + [ + [1.0, 0.0, 0.0], + [1.0, 1.0, 0.0], + [1.0, 1.0, 1.0], + [1.0, 0.0, 1.0], + ], + i, + ) + }) + .collect(); + let before = solid.clone(); + let sides = sort(&mut solid); + assert_eq!(sides.ends, [3; 7]); + assert_eq!( + solid.iter().map(|v| v.layer).collect::>(), + before.iter().map(|v| v.layer).collect::>() + ); + } +} From 787c3a2f19e52cdbd63069a29a47e1a6507b6d77 Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Sat, 24 Oct 2026 21:20:34 +0200 Subject: [PATCH 020/169] Website: /mods, Horizon's registry of mods, modpacks and resource packs The list (search, a filter per kind) and a page per project: what a mod may do in the game's own words, Signed or Unsigned, how to install it from the launcher, the CLI or by hand, its file, SHA-256 and versions, and links to its source, its registry entry and the report form. Baked from the published index at build time (HORIZON_MOD_INDEX for a test index) and refreshed by the page; Caddy serves /mods/ from its baked page, else the list page, which shows a project published since. Co-Authored-By: Claude Opus 5.5 --- website/Caddyfile | 12 ++++- website/README.md | 7 ++- website/build.mjs | 71 +++++++++++++++++++++--- website/src/mods-page.js | 66 +++++++++++++++++++++++ website/src/mods.html | 37 +++++++++++++ website/src/mods.js | 110 ++++++++++++++++++++++++++++++++++++++ website/src/mods.test.mjs | 42 +++++++++++++++ website/src/style.css | 48 +++++++++++++++++ 8 files changed, 383 insertions(+), 10 deletions(-) create mode 100644 website/src/mods-page.js create mode 100644 website/src/mods.html create mode 100644 website/src/mods.js create mode 100644 website/src/mods.test.mjs diff --git a/website/Caddyfile b/website/Caddyfile index 1571566ad..60554fd20 100644 --- a/website/Caddyfile +++ b/website/Caddyfile @@ -20,7 +20,7 @@ Referrer-Policy strict-origin-when-cross-origin X-Frame-Options DENY Permissions-Policy "interest-cohort=(), browsing-topics=(), camera=(), microphone=(), geolocation=()" - Content-Security-Policy "default-src 'self'; script-src 'self' {$CSP_SCRIPT}; style-src 'self' {$CSP_STYLE}; img-src 'self' data: https://avatars.githubusercontent.com; font-src 'self'; connect-src 'self' https://api.github.com https://raw.githubusercontent.com https://telemetry.playhorizon.dev; frame-ancestors 'none'; base-uri 'self'; form-action 'self'" + Content-Security-Policy "default-src 'self'; script-src 'self' {$CSP_SCRIPT}; style-src 'self' {$CSP_STYLE}; img-src 'self' data: https://avatars.githubusercontent.com https://ludovic111.github.io; font-src 'self'; connect-src 'self' https://api.github.com https://raw.githubusercontent.com https://telemetry.playhorizon.dev https://ludovic111.github.io; frame-ancestors 'none'; base-uri 'self'; form-action 'self'" -Server } @assets path /assets/* @@ -35,7 +35,15 @@ rewrite /benchmarks /benchmarks.html @doc path_regexp doc ^/docs/([a-z-]+)$ rewrite @doc /docs/{re.doc.1}.html - @pages path / /index.html /404.html /privacy.html /releases /releases.html /benchmarks /benchmarks.html /benchmarks.json /docs /docs/* /sitemap.xml + # The registry: /mods, and /mods/ baked at build time, else the list page, whose script shows a project + # published since. + rewrite /mods /mods.html + @mod { + path_regexp ^/mods/[a-z0-9_]+$ + file {path}.html /mods.html + } + rewrite @mod {file_match.relative} + @pages path / /index.html /404.html /privacy.html /releases /releases.html /benchmarks /benchmarks.html /benchmarks.json /docs /docs/* /mods /mods.html /mods/* /sitemap.xml header @pages Cache-Control "no-cache" @legal path /LEGAL.md /fonts/*.txt header @legal Content-Type "text/plain; charset=utf-8" diff --git a/website/README.md b/website/README.md index 8ac6e3910..52e26ec61 100644 --- a/website/README.md +++ b/website/README.md @@ -22,12 +22,14 @@ src/404.html the not-found page src/privacy.html what the launcher can send when players allow it, retention, deletion (/privacy) src/releases.html every release, newest first, with what it adds and fixes, its notes and downloads (/releases) src/benchmarks.html Horizon against vanilla 26.3 on our machines, the hardware picker, players' results (/benchmarks) +src/mods.html the registry's list (/mods) and a page per project (/mods/), one template src/docs.html the template of every documentation page (/docs/...), with its left navigation src/tokens.css the design tokens, generated from crates/horizon-theme (do not edit) src/style.css every style, on top of the tokens src/main.js the home page: download buttons, recent releases, links, contributors, nav, tabs, lightbox, motion src/chrome.js the light/dark switch, the phone menu and GitHub fetching, shared by the pages src/releases-page.js the Releases page: the channel filter and the refresh from GitHub +src/mods.js the registry's markup (list, project page), shared by build and page; mods-page.js: the filter, the search, the refresh src/benchmarks-page.js the Benchmarks page: players' results from the telemetry server, the picker src/bench.js the Benchmarks tables, shared by build and page src/hardware.js the spec table estimates use (GPU TFLOPS and bandwidth, CPU single-thread score) @@ -48,14 +50,15 @@ shots/ (gitignored) full-page screenshots at 360–1920 px, a 1250× ## What comes from where -- **Built in** (`build.mjs`): the parity table, its score, harness count and audit date, +- **Built in** (`build.mjs`): Horizon's registry (`/mods`, one page per project) from the index ludovic111/horizon-mods + publishes (`HORIZON_MOD_INDEX=` builds from a test index; docs/api/mod-index.md); the parity table, its score, harness count and audit date, all from `README.md`; the documentation pages (`/docs`) from `website/docs/`; the Discord and Sponsor links from `launcher/links.json`; the latest releases and the contributors (`/repos/ludovic111/horizon/contributors`, bots left out, the owner first), when GitHub answers; without an answer the build still succeeds and the Contributors block and its menu entries stay hidden until the page loads them. Locally these come from the checkout; on Railway, which builds only this folder, from `main` on GitHub. The build fails if the README has no parity table, so a broken README never deploys. -- **Fetched by the page**: the releases (the download button picks the newest +- **Fetched by the page**: the registry's index (a project merged after the build shows at once), the releases (the download button picks the newest `launcher-v*` release's asset for the visitor's OS, the home page lists the newest game releases, and the Releases page reloads its list when GitHub has a newer release), players' benchmark results (`GET https://telemetry.playhorizon.dev/v1/benchmarks/summary`, 3-second timeout), the contributors (avatars come from `avatars.githubusercontent.com`), diff --git a/website/build.mjs b/website/build.mjs index 781e838bb..0a813063b 100644 --- a/website/build.mjs +++ b/website/build.mjs @@ -16,6 +16,7 @@ import { machinesHtml, playersHtml } from "./src/bench.js"; import { CPUS, GPUS, singleThread } from "./src/hardware.js"; import { isGame, isLauncher, launcherVersion, newestFirst } from "./src/versions.js"; import { contributorsFrom, contributorsHtml } from "./src/contributors.js"; +import { INDEX_URL, KINDS, SUBMIT, listHtml, projectHtml, readIndex } from "./src/mods.js"; const site = dirname(fileURLToPath(import.meta.url)); const dist = join(site, "dist"); @@ -41,6 +42,21 @@ try { console.warn(`links.json: ${e.message}; using the built-in links`); } +// Horizon's registry (/mods): the index its repository publishes, or HORIZON_MOD_INDEX (a file or an address) to +// try a test registry. Without an answer the pages are built empty and load the index themselves. +let modProjects = []; +let modIndex = null; +try { + const from = process.env.HORIZON_MOD_INDEX || INDEX_URL; + const text = from.startsWith("https://") + ? await fetch(from, { signal: AbortSignal.timeout(15000) }).then((r) => (r.ok ? r.text() : Promise.reject(new Error(`${r.status}`)))) + : await readFile(from, "utf8"); + modIndex = JSON.parse(text); + modProjects = readIndex(modIndex) ?? (console.warn("mod index: a schema this site doesn't read"), []); +} catch (e) { + console.warn(`mod index: ${e.message}; the pages will load it themselves`); +} + // An optional token (a Railway variable, or `gh auth token` locally) lifts the rate limit. const githubHeaders = { Accept: "application/vnd.github+json", ...(process.env.GITHUB_TOKEN ? { Authorization: `Bearer ${process.env.GITHUB_TOKEN}` } : {}) }; // Every release (the Releases page lists them all), a page of 100 at a time. @@ -170,7 +186,7 @@ await writeFile(join(dist, "favicon.ico"), Buffer.concat([ico, png32])); const names = {}; const rewrite = (code) => code.replace(/"\.\/(\w+\.js)"/g, (all, file) => (names[file] ? `"./${names[file]}"` : all)); // Dependencies before what imports them. -const modules = ["markdown.js", "versions.js", "chrome.js", "hardware.js", "estimate.js", "releases.js", "contributors.js", "bench.js", "main.js", "releases-page.js", "benchmarks-page.js"]; +const modules = ["markdown.js", "versions.js", "chrome.js", "hardware.js", "estimate.js", "releases.js", "contributors.js", "bench.js", "main.js", "releases-page.js", "benchmarks-page.js", "mods.js", "mods-page.js"]; for (const file of modules) { const code = rewrite(await readFile(join(site, "src", file), "utf8")); names[file] = `${file.replace(".js", "")}.${fingerprint(code)}.js`; @@ -202,7 +218,7 @@ const baked = { const unavailable = `

The release notes could not be loaded here.

Read them on GitHub`; // The top bar and the footer of the pages beside the home page (Releases, Benchmarks). -const navLinks = [["/#about", "About"], ["/releases", "Releases"], ["/benchmarks", "Benchmarks"], ["/docs/", "Docs"]]; +const navLinks = [["/#about", "About"], ["/mods", "Mods"], ["/releases", "Releases"], ["/benchmarks", "Benchmarks"], ["/docs/", "Docs"]]; const siteNav = (current) => `