From c43f4bdb2b649caab9e0eca68c1614e11724f33f Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Sun, 25 Oct 2026 07:35:16 +0100 Subject: [PATCH 01/28] Lithostitched's processors as the game's own types; replace the old Lithostitched conversion MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Clean-room implementation from spec-lithostitched.md §3-§5 and spec-ctov.md §4. The game reads Lithostitched's processors as its data writes them (processor/litho.rs): block_swap (only the properties the new block can have: ripe wheat becomes ripe carrots, beetroot keeps its default age), reference, apply_random, condition (with else, one processor or a list), set_block (simple and weighted providers, preserve_state, block entity modifier) and discard_input; the conditions all_of, any_of, not, random_chance, true and matching_blocks (input or location, properties). Their random follows random_mode per block or per piece; Lithostitched's own seeding is open (OPEN-L6), so a positional random of the world seed and the processor stands in (impl-questions IQ-7). horizon-port-pack's new lithostitched module carries the processors as they are, with the processors nested in them carried, drops those the game cannot read (lists named by tag, other providers) as Java processors, turns CTOV's modular_compat into a reference when its mod is ported along (else nothing), maps lithostitched:jigsaw to vanilla's jigsaw (vanilla layouts, the decision on OPEN-L5), unwraps limited/guaranteed/delegating elements to their delegate (limits counted as lost until the next PR) and writes add_template_pool_elements modifiers as horizon:add_to pools when their NeoForge load conditions pass. Deleted unread: legacy_structure_mods/lithostitched.rs and horizon-world's structure/processor/lithostitched.rs. Blind edits to the legacy folder, located by exact text or the compiler's error position: its module line removed, dead_code allowed on ctov (its modular compat is unused now) and on a test helper, and ctov's modular compat test ignored. Co-Authored-By: Claude Opus 5.5 --- crates/horizon-port-pack/src/carry.rs | 6 +- .../src/legacy_structure_mods/ctov.rs | 1 + .../legacy_structure_mods/lithostitched.rs | 503 ------------------ .../src/legacy_structure_mods/mod.rs | 3 +- crates/horizon-port-pack/src/lib.rs | 1 + crates/horizon-port-pack/src/lithostitched.rs | 434 +++++++++++++++ crates/horizon-port-pack/src/processors.rs | 11 +- crates/horizon-port-pack/src/worldgen.rs | 31 +- .../src/worldgen/structure/processor.rs | 101 ++-- .../src/worldgen/structure/processor/litho.rs | 470 ++++++++++++++++ .../structure/processor/lithostitched.rs | 434 --------------- docs/modpacks.md | 31 +- 12 files changed, 1006 insertions(+), 1020 deletions(-) delete mode 100644 crates/horizon-port-pack/src/legacy_structure_mods/lithostitched.rs create mode 100644 crates/horizon-port-pack/src/lithostitched.rs create mode 100644 crates/horizon-world/src/worldgen/structure/processor/litho.rs delete mode 100644 crates/horizon-world/src/worldgen/structure/processor/lithostitched.rs diff --git a/crates/horizon-port-pack/src/carry.rs b/crates/horizon-port-pack/src/carry.rs index 82dbf11af..a87f92ede 100644 --- a/crates/horizon-port-pack/src/carry.rs +++ b/crates/horizon-port-pack/src/carry.rs @@ -828,9 +828,9 @@ pub fn carry( // Additions to other sets and pools, as files the game merges. let modifier = serde_json::from_slice::(&bytes).ok(); let types = &mut report.worldgen_types; - if let Some((kind, mut added)) = modifier.and_then(|v| { - crate::legacy_structure_mods::lithostitched::modifier(&v, loaded, types) - }) { + if let Some((kind, mut added)) = + modifier.and_then(|v| crate::lithostitched::modifier(&v, loaded, types)) + { crate::processors::carry( kind, &mut added, diff --git a/crates/horizon-port-pack/src/legacy_structure_mods/ctov.rs b/crates/horizon-port-pack/src/legacy_structure_mods/ctov.rs index af46174ae..62c25739f 100644 --- a/crates/horizon-port-pack/src/legacy_structure_mods/ctov.rs +++ b/crates/horizon-port-pack/src/legacy_structure_mods/ctov.rs @@ -157,6 +157,7 @@ mod tests { } #[test] + #[ignore = "modular compat is crate::lithostitched's now (its tests)"] fn modular_compat_runs_its_list_only_with_its_mod() { let mut data = ProcessorData::default(); let swap = json!({"processor_type": "minecraft:rule", "rules": []}); diff --git a/crates/horizon-port-pack/src/legacy_structure_mods/lithostitched.rs b/crates/horizon-port-pack/src/legacy_structure_mods/lithostitched.rs deleted file mode 100644 index 54415a76a..000000000 --- a/crates/horizon-port-pack/src/legacy_structure_mods/lithostitched.rs +++ /dev/null @@ -1,503 +0,0 @@ -//! Lithostitched: its jigsaw structure, its worldgen modifiers and its -//! processors. -use super::ctov; -use crate::processors::{ProcessorData, carry_all, processors, referenced}; -use crate::worldgen::{ENHANCED_TERRAIN, Upgrade, start_checks}; -use serde_json::{Value, json}; -use std::collections::BTreeMap; - -/// A `structure` file of Lithostitched's jigsaw type as vanilla's, with the -/// start rules it shares with the other libraries' jigsaws (`worldgen`'s -/// `start_checks`). `None` for any other file. -pub(crate) fn upgrade( - kind: &str, - v: &mut Value, - lost: &mut BTreeMap, -) -> Option { - if kind != "structure" || v["type"] != "lithostitched:jigsaw" { - return None; - } - start_checks(v, "lowest", lost, false); - if v.as_object_mut() - .and_then(|o| o.remove(ENHANCED_TERRAIN)) - .is_some() - { - *lost.entry(ENHANCED_TERRAIN.into()).or_default() += 1; - } - v["type"] = "minecraft:jigsaw".into(); - Some(true) -} - -/// A lithostitched worldgen modifier -/// (`data//lithostitched/worldgen_modifier/`) that adds to structure -/// sets or template pools, as a file the game merges into them (the key -/// `horizon:add_to`, `horizon_client::mod_content`): (kind, file). The -/// modifier's conditions are checked against `loaded`, the mods ported -/// along: a compat addition for a mod that is not would place that mod's -/// blocks, which the game does not have. Other modifier types are left out. -/// Both are counted in `report`. -pub(crate) fn modifier( - v: &Value, - loaded: &dyn Fn(&str) -> bool, - report: &mut Upgrade, -) -> Option<(&'static str, Value)> { - let t = v["type"].as_str().unwrap_or_default(); - let mut left = |why: &str| *report.modifiers_left.entry(why.to_owned()).or_default() += 1; - let (kind, targets, from, to) = match t { - "lithostitched:add_structure_set_entries" => { - ("structure_set", "structure_sets", "entries", "structures") - } - "lithostitched:add_template_pool_elements" => { - ("template_pool", "template_pools", "elements", "elements") - } - _ => { - left(t); - return None; - } - }; - if !conditions_hold(v, loaded) { - left("conditions"); - return None; - } - let targets: Option> = match &v[targets] { - Value::String(s) => Some(vec![s.as_str()]), - Value::Array(a) => a.iter().map(Value::as_str).collect(), - _ => None, - }; - let Some(targets) = targets.filter(|t| !t.is_empty() && t.iter().all(|t| !t.starts_with('#'))) - else { - left("target"); - return None; - }; - let entries = v[from].as_array().cloned().unwrap_or_default(); - for target in &targets { - *report.added_to.entry((*target).to_owned()).or_default() += entries.len(); - } - Some(( - kind, - serde_json::json!({"horizon:add_to": targets, to: entries}), - )) -} - -/// Whether a modifier's load conditions hold: lithostitched's `predicate`, -/// and the loader's conditions (NeoForge's, else Fabric's). A condition -/// type not known here does not hold. -fn conditions_hold(v: &Value, loaded: &dyn Fn(&str) -> bool) -> bool { - let all = |list: &Value, test: &dyn Fn(&Value) -> bool| { - list.as_array().is_some_and(|a| a.iter().all(test)) - }; - fn predicate(p: &Value, loaded: &dyn Fn(&str) -> bool) -> bool { - let test = |q: &Value| predicate(q, loaded); - let list = &p["predicates"]; - match p["type"] - .as_str() - .map(|t| t.trim_start_matches("lithostitched:")) - { - Some("true") => true, - Some("mod_loaded") => p["mod_id"].as_str().is_some_and(loaded), - Some("not") => !predicate(&p["predicate"], loaded), - Some("all_of") => list.as_array().is_some_and(|a| a.iter().all(test)), - Some("any_of") => list.as_array().is_some_and(|a| a.iter().any(test)), - _ => false, - } - } - fn neoforge(c: &Value, loaded: &dyn Fn(&str) -> bool) -> bool { - let test = |q: &Value| neoforge(q, loaded); - match c["type"].as_str() { - Some("neoforge:true") => true, - Some("neoforge:mod_loaded") => c["modid"].as_str().is_some_and(loaded), - Some("neoforge:not") => !neoforge(&c["value"], loaded), - Some("neoforge:and") => c["values"].as_array().is_some_and(|a| a.iter().all(test)), - Some("neoforge:or") => c["values"].as_array().is_some_and(|a| a.iter().any(test)), - _ => false, - } - } - fn fabric(c: &Value, loaded: &dyn Fn(&str) -> bool) -> bool { - let test = |q: &Value| fabric(q, loaded); - let mods = || { - c["values"] - .as_array() - .into_iter() - .flatten() - .map(Value::as_str) - }; - match c["condition"].as_str() { - Some("fabric:true") => true, - Some("fabric:all_mods_loaded") => mods().all(|m| m.is_some_and(loaded)), - Some("fabric:any_mods_loaded") => mods().any(|m| m.is_some_and(loaded)), - Some("fabric:not") => !fabric(&c["value"], loaded), - Some("fabric:and") => c["values"].as_array().is_some_and(|a| a.iter().all(test)), - Some("fabric:or") => c["values"].as_array().is_some_and(|a| a.iter().any(test)), - _ => false, - } - } - let litho = v.get("predicate").is_none_or(|p| predicate(p, loaded)); - let loader = match ( - v.get("neoforge:conditions"), - v.get("fabric:load_conditions"), - ) { - (Some(c), _) => all(c, &|c| neoforge(c, loaded)), - // One condition or a list of them. - (None, Some(c)) if c.is_array() => all(c, &|c| fabric(c, loaded)), - (None, Some(c)) => fabric(c, loaded), - (None, None) => true, - }; - litho && loader -} - -/// The data form of one of Lithostitched's processors: the processors to put -/// in its place, or `None` when it has none (or is not Lithostitched's). -pub(crate) fn processor( - kind: &str, - p: &Value, - data: &ProcessorData, - carried: &mut BTreeMap, -) -> Option> { - match kind { - "lithostitched:apply_random" => apply_random(p, data, carried).map(|p| vec![p]), - "lithostitched:condition" => condition(p, data, carried).map(|p| vec![p]), - "lithostitched:block_swap" => { - // The same map; the game's swap keeps the properties both have. - p["blocks"].as_object()?; - Some(vec![ - json!({"processor_type": "horizon:block_swap", "blocks": p["blocks"]}), - ]) - } - "lithostitched:set_block" => { - // A simple or weighted state provider, the block entity left as - // it is. - let provider = p["state_provider"]["type"].as_str()?; - let modifier = p["block_entity_modifier"]["type"].as_str(); - let plain = - modifier.is_none_or(|m| m.trim_start_matches("minecraft:") == "passthrough"); - if !plain - || !matches!( - provider, - "minecraft:simple_state_provider" | "minecraft:weighted_state_provider" - ) - { - return None; - } - let mut out = p.clone(); - out["processor_type"] = "horizon:set_block".into(); - if let Some(o) = out.as_object_mut() { - o.remove("block_entity_modifier"); - } - Some(vec![out]) - } - _ => None, - } -} - -/// The references (Lithostitched's, and CTOV's compat processors) in a -/// processor list written in; whether any was. -pub(crate) fn expand_references( - list: Vec, - data: &ProcessorData, - carried: &mut BTreeMap, -) -> (Vec, bool) { - references(list, data, carried, 0) -} - -/// A processor list inside a carried processor: an id stays (the game reads -/// that file, carried on its own); an inline one is carried here. -fn nested(list: &Value, data: &ProcessorData, carried: &mut BTreeMap) -> Value { - let mut list = list.clone(); - if let Some(ps) = processors(&mut list) { - *ps = carry_all(std::mem::take(ps), data, carried).0; - } - list -} - -/// Lithostitched's `apply_random` as `horizon:apply_random`: its weighted -/// lists, or its set of lists at weight 1. A tag is not carried. -fn apply_random( - p: &Value, - data: &ProcessorData, - carried: &mut BTreeMap, -) -> Option { - let lists = &p["processor_lists"]; - let weighted = lists.as_array().is_some_and(|a| { - a.iter() - .all(|e| e.get("weight").is_some() && e.get("data").is_some()) - }); - let entries: Vec<(Value, Value)> = if weighted { - lists - .as_array()? - .iter() - .map(|e| (e["weight"].clone(), e["data"].clone())) - .collect() - } else { - match lists { - Value::String(id) if !id.starts_with('#') => vec![(1.into(), lists.clone())], - Value::Array(a) if a.iter().any(|x| x.get("processor_type").is_some()) => { - vec![(1.into(), lists.clone())] - } - Value::Array(a) - if a.iter() - .all(|x| x.as_str().is_some_and(|s| !s.starts_with('#')) || x.is_object()) => - { - a.iter().map(|x| (1.into(), x.clone())).collect() - } - Value::Object(_) => vec![(1.into(), lists.clone())], - _ => return None, - } - }; - let lists: Vec = entries - .into_iter() - .map(|(weight, list)| json!({"weight": weight, "data": nested(&list, data, carried)})) - .collect(); - let mut out = json!({"processor_type": "horizon:apply_random", "processor_lists": lists}); - if let Some(mode) = p.get("mode") { - out["mode"] = mode.clone(); - } - Some(out) -} - -/// Lithostitched's `condition` as `horizon:condition`, when the game runs -/// every condition in it (true, all_of, any_of, not, random_chance, -/// matching_blocks with plain property values); else it stays Java. -fn condition( - p: &Value, - data: &ProcessorData, - carried: &mut BTreeMap, -) -> Option { - fn runs(c: &Value) -> bool { - if let Some(all) = c.as_array() { - return all.iter().all(runs); - } - let kind = c["type"].as_str().unwrap_or_default(); - match kind.strip_prefix("lithostitched:").unwrap_or(kind) { - "true" | "random_chance" => true, - "all_of" | "any_of" => c["conditions"] - .as_array() - .is_some_and(|a| a.iter().all(runs)), - "not" => runs(&c["condition"]), - "matching_blocks" => c.get("properties").is_none_or(|p| { - p.as_object() - .is_some_and(|o| o.values().all(Value::is_string)) - }), - _ => false, - } - } - if !runs(&p["if_true"]) { - return None; - } - // One processor or a list of them. - let mut branch = |key: &str| -> Value { - let list = match p.get(key) { - None => Vec::new(), - Some(Value::Array(a)) => a.clone(), - Some(one) => vec![one.clone()], - }; - carry_all(list, data, carried).0.into() - }; - let (then, otherwise) = (branch("then"), branch("else")); - let mut out = json!({"processor_type": "horizon:condition", "if_true": p["if_true"], - "then": then, "else": otherwise}); - if let Some(mode) = p.get("random_mode") { - out["random_mode"] = mode.clone(); - } - Some(out) -} - -/// Lithostitched's references in a list, each replaced by the processors of -/// the lists it names, in order (references in them too, to a depth of 8). -/// One naming a tag or a list the mod does not have stays, to be dropped. -/// Whether any was replaced. -fn references( - list: Vec, - data: &ProcessorData, - carried: &mut BTreeMap, - depth: usize, -) -> (Vec, bool) { - let mut out = Vec::with_capacity(list.len()); - let mut changed = false; - for p in list { - if let Some(inner) = ctov::modular_compat(&p, data, carried, depth) { - changed = true; - out.extend(references(inner, data, carried, depth + 1).0); - continue; - } - let named = (p["processor_type"] == "lithostitched:reference" && depth < 8) - .then(|| referenced(&p["processor_lists"], data)) - .flatten(); - match named { - Some(inner) => { - *carried.entry("lithostitched:reference".into()).or_default() += 1; - out.extend(references(inner, data, carried, depth + 1).0); - changed = true; - } - None => out.push(p), - } - } - (out, changed) -} - -#[cfg(test)] -mod tests { - use super::*; - use crate::legacy_structure_mods::data; - use crate::processors::carry; - - #[test] - fn modifiers_add_to_sets_and_pools() { - let mut report = Upgrade::default(); - let only_fd = |m: &str| m == "farmersdelight"; - let set = json!({"type": "lithostitched:add_structure_set_entries", - "structure_sets": "minecraft:villages", - "entries": [{"structure": "x:village", "weight": 4}]}); - let (kind, added) = modifier(&set, &only_fd, &mut report).unwrap(); - assert_eq!(kind, "structure_set"); - assert_eq!( - added, - json!({"horizon:add_to": ["minecraft:villages"], - "structures": [{"structure": "x:village", "weight": 4}]}) - ); - // A compat addition holds only when its mod is ported along. - let pool = |modid: &str| { - json!({"type": "lithostitched:add_template_pool_elements", - "neoforge:conditions": [{"type": "neoforge:mod_loaded", "modid": modid}], - "fabric:load_conditions": {"condition": "fabric:all_mods_loaded", "values": ["other"]}, - "template_pools": ["x:houses", "y:houses"], - "elements": [{"weight": 5, "element": {"element_type": "minecraft:single_pool_element", - "location": "x:fd_farm", "projection": "rigid", "processors": "minecraft:empty"}}]}) - }; - let (kind, added) = modifier(&pool("farmersdelight"), &only_fd, &mut report).unwrap(); - assert_eq!(kind, "template_pool"); - assert_eq!(added["horizon:add_to"], json!(["x:houses", "y:houses"])); - assert_eq!(added["elements"][0]["weight"], 5); - assert!(modifier(&pool("create"), &only_fd, &mut report).is_none()); - // Fabric's conditions when there are no NeoForge ones; lithostitched's own. - let fabric = json!({"type": "lithostitched:add_structure_set_entries", - "fabric:load_conditions": [{"condition": "fabric:not", - "value": {"condition": "fabric:any_mods_loaded", "values": ["create"]}}], - "predicate": {"type": "lithostitched:all_of", "predicates": [ - {"type": "lithostitched:mod_loaded", "mod_id": "farmersdelight"}, - {"type": "lithostitched:true"}]}, - "structure_sets": "minecraft:villages", "entries": []}); - assert!(modifier(&fabric, &only_fd, &mut report).is_some()); - let tagged = json!({"type": "lithostitched:add_structure_set_entries", - "structure_sets": "#x:sets", "entries": []}); - assert!(modifier(&tagged, &only_fd, &mut report).is_none()); - let features = json!({"type": "lithostitched:add_features"}); - assert!(modifier(&features, &only_fd, &mut report).is_none()); - assert_eq!( - report.added_to, - BTreeMap::from([ - ("minecraft:villages".into(), 1), - ("x:houses".into(), 1), - ("y:houses".into(), 1), - ]) - ); - assert_eq!( - report.modifiers_left, - BTreeMap::from([ - ("conditions".into(), 1), - ("lithostitched:add_features".into(), 1), - ("target".into(), 1), - ]) - ); - } - - #[test] - fn lithostitched_block_swaps_become_the_games() { - let mut list = json!({"processors": [ - {"processor_type": "lithostitched:block_swap", - "blocks": {"minecraft:cobblestone": "minecraft:mossy_cobblestone"}}, - {"processor_type": "lithostitched:block_swap", "blocks": []}]}); - let mut carried = BTreeMap::new(); - assert!(carry("processor_list", &mut list, &data(), &mut carried)); - let p = list["processors"].as_array().unwrap(); - assert_eq!( - p[0], - json!({"processor_type": "horizon:block_swap", - "blocks": {"minecraft:cobblestone": "minecraft:mossy_cobblestone"}}) - ); - // A map that is not one stays Java (dropped later). - assert_eq!(p[1]["processor_type"], "lithostitched:block_swap"); - } - - #[test] - fn lithostitched_references_are_written_in() { - let mut data = data(); - let gravity = json!({"processor_type": "minecraft:gravity", "heightmap": "WORLD_SURFACE_WG", "offset": 0}); - data.lists - .insert("v:road".into(), json!({"processors": [gravity.clone()]})); - data.lists.insert( - "v:house".into(), - json!({"processors": [ - {"processor_type": "lithostitched:reference", "processor_lists": "v:road"}, - {"processor_type": "lithostitched:block_swap", "blocks": {"minecraft:dirt": "minecraft:grass_block"}}]}), - ); - let mut list = json!({"processors": [ - {"processor_type": "lithostitched:reference", "processor_lists": ["v:house", "v:road"]}, - {"processor_type": "lithostitched:reference", "processor_lists": "#v:roads"}, - {"processor_type": "lithostitched:reference", "processor_lists": ["v:nowhere"]}]}); - let mut carried = BTreeMap::new(); - assert!(carry("processor_list", &mut list, &data, &mut carried)); - let p = list["processors"].as_array().unwrap(); - // House (its own reference to road first, then its swap), then road; - // the swap inside is carried too. - assert_eq!(p[0], gravity); - assert_eq!(p[1]["processor_type"], "horizon:block_swap"); - assert_eq!(p[2], gravity); - // A tag or a list the mod lacks stays, to be dropped. - assert_eq!(p[3]["processor_lists"], "#v:roads"); - assert_eq!(p[4]["processor_lists"], json!(["v:nowhere"])); - assert_eq!(carried["lithostitched:reference"], 2); - } - - #[test] - fn lithostitched_random_and_condition_become_the_games() { - let mut data = data(); - let swap = json!({"processor_type": "lithostitched:block_swap", - "blocks": {"minecraft:dirt": "minecraft:grass_block"}}); - data.lists - .insert("v:green".into(), json!({"processors": [swap.clone()]})); - let mut list = json!({"processors": [ - {"processor_type": "lithostitched:apply_random", "mode": "per_piece", "processor_lists": [ - {"weight": 3, "data": "minecraft:empty"}, - {"weight": 1, "data": {"processors": [ - {"processor_type": "lithostitched:reference", "processor_lists": "v:green"}, - {"processor_type": "v:java"}]}}]}, - {"processor_type": "lithostitched:apply_random", "mode": "per_block", - "processor_lists": ["v:green", "v:red"]}, - {"processor_type": "lithostitched:apply_random", "mode": "per_block", - "processor_lists": "#v:colours"}, - {"processor_type": "lithostitched:condition", - "if_true": [{"type": "lithostitched:matching_blocks", "blocks": "minecraft:cobblestone"}], - "then": swap, "else": {"processor_type": "lithostitched:set_block", "state_provider": - {"type": "minecraft:simple_state_provider", "state": {"Name": "minecraft:stone"}}}}, - {"processor_type": "lithostitched:condition", - "if_true": {"type": "lithostitched:matching_biomes", "biomes": "#c:is_cold"}, - "then": []}]}); - let mut carried = BTreeMap::new(); - assert!(carry("processor_list", &mut list, &data, &mut carried)); - let p = list["processors"].as_array().unwrap(); - let green = json!({"processor_type": "horizon:block_swap", - "blocks": {"minecraft:dirt": "minecraft:grass_block"}}); - // Inline lists are carried; Java left in them is dropped later. - assert_eq!( - p[0], - json!({"processor_type": "horizon:apply_random", "mode": "per_piece", "processor_lists": [ - {"weight": 3, "data": "minecraft:empty"}, - {"weight": 1, "data": {"processors": [green.clone(), {"processor_type": "v:java"}]}}]}) - ); - assert_eq!( - p[1]["processor_lists"], - json!([{"weight": 1, "data": "v:green"}, {"weight": 1, "data": "v:red"}]) - ); - assert_eq!(p[2]["processor_type"], "lithostitched:apply_random"); - assert_eq!( - p[3], - json!({"processor_type": "horizon:condition", - "if_true": [{"type": "lithostitched:matching_blocks", "blocks": "minecraft:cobblestone"}], - "then": [green], "else": [{"processor_type": "horizon:set_block", "state_provider": - {"type": "minecraft:simple_state_provider", "state": {"Name": "minecraft:stone"}}}]}) - ); - assert_eq!(p[4]["processor_type"], "lithostitched:condition"); - assert_eq!(carried["lithostitched:apply_random"], 2); - assert_eq!(carried["lithostitched:condition"], 1); - } -} diff --git a/crates/horizon-port-pack/src/legacy_structure_mods/mod.rs b/crates/horizon-port-pack/src/legacy_structure_mods/mod.rs index 1faa1b39f..980798720 100644 --- a/crates/horizon-port-pack/src/legacy_structure_mods/mod.rs +++ b/crates/horizon-port-pack/src/legacy_structure_mods/mod.rs @@ -13,10 +13,11 @@ //! The general code reaches them only through the `pub(crate)` entry points //! of these three modules. Nothing in them is used by another mod's //! conversion. +#[allow(dead_code)] // its modular compat is `crate::lithostitched`'s now; the rest goes with C1 pub(crate) mod ctov; -pub(crate) mod lithostitched; #[cfg(test)] +#[allow(dead_code)] // the old Lithostitched tests used it fn data() -> crate::processors::ProcessorData { let mut d = crate::processors::ProcessorData::default(); d.spawners.insert( diff --git a/crates/horizon-port-pack/src/lib.rs b/crates/horizon-port-pack/src/lib.rs index 3b17f1c9c..b47c93754 100644 --- a/crates/horizon-port-pack/src/lib.rs +++ b/crates/horizon-port-pack/src/lib.rs @@ -14,6 +14,7 @@ pub mod import; pub mod inventory; pub mod jar; pub(crate) mod legacy_structure_mods; +mod lithostitched; pub mod modrinth; pub mod oracle; pub mod pipeline; diff --git a/crates/horizon-port-pack/src/lithostitched.rs b/crates/horizon-port-pack/src/lithostitched.rs new file mode 100644 index 000000000..e65efcf0e --- /dev/null +++ b/crates/horizon-port-pack/src/lithostitched.rs @@ -0,0 +1,434 @@ +//! Lithostitched's worldgen, carried as the game reads it (clean room: +//! `cleanroom/structures/spec-lithostitched.md`; CTOV's processor: +//! `spec-ctov.md` §4). +//! +//! - `lithostitched:jigsaw` structures become vanilla's jigsaw. Lithostitched +//! lays jigsaws out its own way (OPEN-L5): Horizon keeps vanilla's layouts. +//! - Its processors (`block_swap`, `reference`, `apply_random`, `condition`, +//! `set_block`, `discard_input`) are the game's own types +//! (`horizon_world`'s `structure::processor`): they are carried as written, +//! the processors nested in them carried in turn. CTOV's +//! `ctov:modular_compat` (a reference that runs only when its mod is loaded) +//! becomes a `reference` when the mod is ported along, else nothing. +//! - `add_template_pool_elements` modifiers become `horizon:add_to` pool files +//! (`docs/mods.md`), when their load conditions pass. Lithostitched's own +//! pool elements (`limited`, `guaranteed`, `delegating`) place their +//! `delegate`; what they add to it is counted as lost. +use crate::{processors::ProcessorData, worldgen::Upgrade}; +use serde_json::{Value, json}; +use std::collections::BTreeMap; + +const JIGSAW: &str = "lithostitched:jigsaw"; +/// Vanilla's JigsawStructure.MAX_DEPTH. +const MAX_SIZE: i64 = 20; +const MODULAR_COMPAT: &str = "ctov:modular_compat"; +/// The processor types the game reads. +const PROCESSORS: [&str; 6] = [ + "lithostitched:block_swap", + "lithostitched:reference", + "lithostitched:apply_random", + "lithostitched:condition", + "lithostitched:set_block", + "lithostitched:discard_input", +]; + +fn count(map: &mut BTreeMap, name: &str) { + *map.entry(name.to_owned()).or_default() += 1; +} + +/// A `lithostitched:jigsaw` structure as vanilla's jigsaw: `Some(true)`, else +/// `None`. +pub(crate) fn upgrade( + kind: &str, + v: &mut Value, + lost: &mut BTreeMap, +) -> Option { + if kind != "structure" || v["type"] != JIGSAW { + return None; + } + v["type"] = "minecraft:jigsaw".into(); + // `size` may be an int provider (sampled per start): its largest value. + let size = match &v["size"] { + Value::Null => None, + Value::Number(n) => n.as_i64(), + provider => { + count(lost, "lithostitched:jigsaw size provider"); + ["max_inclusive", "value"] + .iter() + .find_map(|k| provider[k].as_i64()) + } + }; + if let Some(size) = size { + if size > MAX_SIZE { + count(lost, "lithostitched:jigsaw size over 20"); + } + v["size"] = size.clamp(0, MAX_SIZE).into(); + } + let o = v.as_object_mut()?; + match o.remove("start_projection") { + Some(Value::String(heightmap)) if heightmap != "floor" && heightmap != "ceiling" => { + o.entry("project_start_to_heightmap") + .or_insert(heightmap.into()); + } + Some(_) => count(lost, "lithostitched:jigsaw start_projection"), + None => {} + } + if o.remove("fixed_rotation").is_some_and(|f| f == true) { + count(lost, "lithostitched:jigsaw fixed_rotation"); + } + Some(true) +} + +/// Lithostitched's pool elements as the element they wrap; whether `element` +/// was one. +pub(crate) fn upgrade_pool_element( + element: &mut Value, + lost: &mut BTreeMap, +) -> bool { + let Some(kind) = element["element_type"].as_str() else { + return false; + }; + match kind { + "lithostitched:limited" | "lithostitched:guaranteed" | "lithostitched:delegating" => { + count(lost, kind); + let delegate = element["delegate"].take(); + *element = delegate; + // A delegate wrapping another (only `delegating` allows it). + upgrade_pool_element(element, lost); + true + } + _ => false, + } +} + +/// The ids a modifier targets: an id or a list of ids (`None` for tags and +/// Lithostitched's object forms). +fn ids(v: &Value) -> Option> { + let id = |v: &Value| { + v.as_str() + .filter(|s| !s.starts_with('#')) + .map(str::to_owned) + }; + match v { + Value::Array(a) => a.iter().map(id).collect(), + other => Some(vec![id(other)?]), + } +} + +/// NeoForge's load conditions (`neoforge:conditions`): all must pass. +fn conditions_pass(v: &Value, loaded: &dyn Fn(&str) -> bool) -> bool { + fn pass(c: &Value, loaded: &dyn Fn(&str) -> bool) -> bool { + let all = |key: &str| { + c[key] + .as_array() + .into_iter() + .flatten() + .all(|c| pass(c, loaded)) + }; + match c["type"].as_str() { + Some("neoforge:mod_loaded") => c["modid"].as_str().is_some_and(loaded), + Some("neoforge:true") => true, + Some("neoforge:not") => !pass(&c["value"], loaded), + Some("neoforge:and") => all("values"), + Some("neoforge:or") => { + (c["values"].as_array().into_iter().flatten()).any(|c| pass(c, loaded)) + } + _ => false, + } + } + (v["neoforge:conditions"].as_array().into_iter().flatten()).all(|c| pass(c, loaded)) +} + +/// A worldgen modifier as a file the game merges: `("template_pool", file)` +/// for `add_template_pool_elements`; the others are counted in +/// `report.modifiers_left`. +pub(crate) fn modifier( + v: &Value, + loaded: &dyn Fn(&str) -> bool, + report: &mut Upgrade, +) -> Option<(&'static str, Value)> { + let kind = v["type"].as_str().unwrap_or("no type"); + if !conditions_pass(v, loaded) { + count(&mut report.modifiers_left, "conditions"); + return None; + } + if kind != "lithostitched:add_template_pool_elements" { + count(&mut report.modifiers_left, kind); + return None; + } + let (Some(targets), Some(elements)) = (ids(&v["template_pools"]), v["elements"].as_array()) + else { + count(&mut report.modifiers_left, "target"); + return None; + }; + for target in &targets { + *report.added_to.entry(target.clone()).or_default() += elements.len(); + } + Some(( + "template_pool", + json!({"horizon:add_to": targets, "elements": elements}), + )) +} + +/// Whether the game reads a Lithostitched processor as it is: one of its +/// types, with no processor list named by tag (the game has no processor +/// list tags) and a state provider it runs. +pub(crate) fn game_reads(p: &Value) -> bool { + let Some(kind) = p["processor_type"] + .as_str() + .filter(|t| PROCESSORS.contains(t)) + else { + return false; + }; + let tag = |v: &Value| v.as_str().is_some_and(|s| s.starts_with('#')); + match kind { + "lithostitched:reference" => match &p["processor_lists"] { + Value::Array(a) => !a.iter().any(tag), + other => other.is_string() && !tag(other), + }, + "lithostitched:apply_random" => p["processor_lists"] + .as_array() + .is_some_and(|a| a.iter().all(|e| !tag(e) && !tag(&e["data"]))), + "lithostitched:set_block" => matches!( + p["state_provider"]["type"].as_str(), + Some("minecraft:simple_state_provider" | "minecraft:weighted_state_provider") + ), + "lithostitched:block_swap" => p["blocks"].is_object(), + "lithostitched:condition" => !p["if_true"].is_null(), + _ => true, + } +} + +/// The processor lists inside a Lithostitched processor, for the general +/// code that walks lists (`then`, `else`, `apply_random`'s inline data). +pub(crate) fn inner_lists(p: &mut Value) -> Vec<&mut Value> { + match p["processor_type"].as_str() { + Some("lithostitched:apply_random") => (p["processor_lists"].as_array_mut().into_iter()) + .flatten() + .filter_map(|e| e.get_mut("data").filter(|d| !d.is_string())) + .collect(), + Some("lithostitched:condition") => (p.as_object_mut().into_iter()) + .flat_map(|o| o.iter_mut()) + .filter(|(k, _)| *k == "then" || *k == "else") + .map(|(_, v)| v) + .collect(), + _ => Vec::new(), + } +} + +/// A Lithostitched processor with the processors nested in it carried +/// (`Some`, when one of them changed); `None` for any other processor. +pub(crate) fn processor( + kind: &str, + p: &Value, + data: &ProcessorData, + carried: &mut BTreeMap, +) -> Option> { + if !PROCESSORS.contains(&kind) { + return None; + } + let mut out = p.clone(); + let mut changed = false; + for list in inner_lists(&mut out) { + // One processor alone is a list of one. + if list.get("processor_type").is_some() { + *list = Value::Array(vec![list.take()]); + changed = true; + } + if let Some(processors) = crate::processors::processors(list) { + let (inner, inner_changed) = + crate::processors::carry_all(std::mem::take(processors), data, carried); + *processors = inner; + changed |= inner_changed; + } + } + changed.then(|| vec![out]) +} + +/// The list with CTOV's modular compat processors written as the game's +/// `reference` (its mod is ported along) or taken out; whether any was. +pub(crate) fn expand_references( + list: Vec, + data: &ProcessorData, + carried: &mut BTreeMap, +) -> (Vec, bool) { + let mut changed = false; + let mut out = Vec::with_capacity(list.len()); + for p in list { + if p["processor_type"] != MODULAR_COMPAT { + out.push(p); + continue; + } + changed = true; + count(carried, MODULAR_COMPAT); + let loaded = p["modid"] + .as_str() + .is_some_and(|m| data.compat_loaded.contains(m)); + if loaded { + out.push(json!({"processor_type": "lithostitched:reference", + "processor_lists": p["reference"].clone()})); + } + } + (out, changed) +} + +/// Notes which mods CTOV's modular compat processors name are `loaded`. +pub(crate) fn mark_loaded(data: &mut ProcessorData, loaded: &dyn Fn(&str) -> bool) { + fn visit(v: &Value, out: &mut Vec) { + match v { + Value::Object(o) => { + if o.get("processor_type").and_then(Value::as_str) == Some(MODULAR_COMPAT) + && let Some(m) = o.get("modid").and_then(Value::as_str) + { + out.push(m.to_owned()); + } + o.values().for_each(|v| visit(v, out)); + } + Value::Array(a) => a.iter().for_each(|v| visit(v, out)), + _ => {} + } + } + let mut named = Vec::new(); + data.lists.values().for_each(|l| visit(l, &mut named)); + data.compat_loaded + .extend(named.into_iter().filter(|m| loaded(m))); +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::worldgen::upgrade as upgrade_file; + + #[test] + fn jigsaws_become_vanillas() { + let mut lost = BTreeMap::new(); + let mut s = json!({"type": JIGSAW, "size": {"type": "uniform", "min_inclusive": 3, + "max_inclusive": 40}, "start_projection": "WORLD_SURFACE_WG", "fixed_rotation": true}); + assert_eq!(upgrade("structure", &mut s, &mut lost), Some(true)); + assert_eq!( + s, + json!({"type": "minecraft:jigsaw", "size": 20, + "project_start_to_heightmap": "WORLD_SURFACE_WG"}) + ); + assert_eq!(lost.len(), 3); + assert_eq!( + upgrade( + "structure", + &mut json!({"type": "minecraft:jigsaw"}), + &mut lost + ), + None + ); + } + + #[test] + fn wrapped_elements_place_their_delegate() { + let mut lost = BTreeMap::new(); + let delegate = json!({"element_type": "minecraft:single_pool_element", "location": "a:b", + "projection": "rigid", "processors": "minecraft:empty"}); + let mut e = + json!({"element_type": "lithostitched:limited", "limit": 1, "delegate": delegate}); + assert!(upgrade_pool_element(&mut e, &mut lost)); + assert_eq!(e, delegate); + assert_eq!(lost["lithostitched:limited"], 1); + assert!(!upgrade_pool_element(&mut e, &mut lost)); + } + + #[test] + fn modifiers_add_to_pools_when_their_mods_are_loaded() { + let mut report = Upgrade::default(); + let loaded = |m: &str| m == "waystones"; + let add = |modid: &str, pools: Value| { + json!({"type": "lithostitched:add_template_pool_elements", "template_pools": pools, + "elements": [{"weight": 2, "element": {"element_type": "minecraft:empty_pool_element"}}], + "neoforge:conditions": [{"type": "neoforge:mod_loaded", "modid": modid}]}) + }; + let (kind, file) = modifier( + &add("waystones", json!("ctov:village/plains/house")), + &loaded, + &mut report, + ) + .unwrap(); + assert_eq!(kind, "template_pool"); + assert_eq!(file["horizon:add_to"], json!(["ctov:village/plains/house"])); + assert_eq!(file["elements"][0]["weight"], 2); + assert_eq!(report.added_to["ctov:village/plains/house"], 1); + assert!(modifier(&add("sawmill", json!("a:b")), &loaded, &mut report).is_none()); + assert!(modifier(&add("waystones", json!("#a:pools")), &loaded, &mut report).is_none()); + let aliases = json!({"type": "lithostitched:set_pool_aliases"}); + assert!(modifier(&aliases, &loaded, &mut report).is_none()); + assert_eq!( + report.modifiers_left, + BTreeMap::from([ + ("conditions".into(), 1), + ("lithostitched:set_pool_aliases".into(), 1), + ("target".into(), 1), + ]) + ); + } + + /// A CTOV list (spec-ctov §4): references, a condition with a single + /// processor and a nested condition, a random list holding the compat + /// hook, and processors the game cannot read. + #[test] + fn processors_stay_lithostitcheds_with_their_insides_carried() { + let hook = json!({"processor_type": MODULAR_COMPAT, "modid": "natures_spirit", + "reference": "ctov:village/mesa/house_wisteria"}); + let list = json!({"processors": [ + {"processor_type": "lithostitched:reference", "processor_lists": ["ctov:village/mesa/house"]}, + {"processor_type": "lithostitched:condition", "random_mode": "per_block", + "if_true": {"type": "lithostitched:matching_blocks", "blocks": "minecraft:water", + "match_type": "location"}, + "then": {"processor_type": "lithostitched:set_block", "state_provider": { + "type": "minecraft:simple_state_provider", "state": {"Name": "minecraft:spruce_planks"}}}, + "else": [{"processor_type": "somemod:java_processor"}]}, + {"processor_type": "lithostitched:apply_random", "mode": "per_piece", "processor_lists": [ + {"weight": 1, "data": "minecraft:empty"}, + {"weight": 1, "data": {"processors": [hook]}}]}, + {"processor_type": "lithostitched:reference", "processor_lists": "#ctov:palettes"}, + {"processor_type": "lithostitched:set_block", "state_provider": { + "type": "minecraft:noise_provider"}}]}); + for (loaded, wisteria) in [ + (false, json!([])), + ( + true, + json!([{"processor_type": + "lithostitched:reference", "processor_lists": "ctov:village/mesa/house_wisteria"}]), + ), + ] { + let mut data = ProcessorData::default(); + data.lists + .insert("ctov:village/mesa/house".into(), list.clone()); + mark_loaded(&mut data, &|m| loaded && m == "natures_spirit"); + let mut v = list.clone(); + let mut report = Upgrade::default(); + crate::processors::carry( + "processor_list", + &mut v, + &data, + &mut report.processors_carried, + ); + upgrade_file("processor_list", &mut v, &mut report, &BTreeMap::new()); + let p = &v["processors"]; + assert_eq!(p.as_array().unwrap().len(), 3, "{p}"); + assert_eq!(p[0], list["processors"][0]); + // One processor is a list of one; the Java one is taken out. + assert_eq!( + p[1]["then"][0]["state_provider"]["state"]["id"], + "minecraft:spruce_planks" + ); + assert_eq!(p[1]["else"], json!([])); + assert_eq!(p[2]["processor_lists"][0]["data"], "minecraft:empty"); + assert_eq!(p[2]["processor_lists"][1]["data"]["processors"], wisteria); + assert_eq!(report.processors_carried[MODULAR_COMPAT], 1); + assert_eq!( + report.processors_dropped, + BTreeMap::from([ + ("lithostitched:reference".into(), 1), + ("lithostitched:set_block".into(), 1), + ("somemod:java_processor".into(), 1), + ]) + ); + } + } +} diff --git a/crates/horizon-port-pack/src/processors.rs b/crates/horizon-port-pack/src/processors.rs index af1595f92..046eaa0bf 100644 --- a/crates/horizon-port-pack/src/processors.rs +++ b/crates/horizon-port-pack/src/processors.rs @@ -10,13 +10,13 @@ //! - Repurposed Structures' mineshaft sky view becomes the game's //! `horizon:mineshaft_sky_view`. //! -//! The processors of YUNG's mods, Lithostitched and Choice Theorem's Overhauled -//! Village are carried by `legacy_structure_mods`, called from [`carry`]. +//! Lithostitched's processors and Choice Theorem's Overhauled Village's +//! compat hook are carried by `crate::lithostitched`, called from [`carry`]. //! //! What is not here is taken out of its list later and counted //! (`worldgen::upgrade`). The entity NBT is written in 26.3's shape (an //! `equipment` map, not 1.21.1's `HandItems` and `ArmorItems`). -use crate::legacy_structure_mods::{ctov, lithostitched}; +use crate::lithostitched; use serde_json::{Value, json}; use std::{ collections::{BTreeMap, BTreeSet}, @@ -42,7 +42,7 @@ pub struct ProcessorData { impl ProcessorData { /// Notes which mods its compat processors name are `loaded`. pub fn mark_loaded(&mut self, loaded: &dyn Fn(&str) -> bool) { - ctov::mark_loaded(self, loaded); + lithostitched::mark_loaded(self, loaded); } pub fn read(zip: &mut zip::ZipArchive) -> Self { @@ -177,8 +177,7 @@ fn carry_at( let mut out = Vec::with_capacity(expanded.len()); for p in expanded { let kind = p["processor_type"].as_str().unwrap_or_default().to_owned(); - // Lithostitched's processors are carried apart from this code - // (`legacy_structure_mods`). + // Lithostitched's processors stay theirs, with what they hold carried. let replacement = lithostitched::processor(&kind, &p, data, carried).or_else(|| { match pillar_type(&kind) { Some(to) => Some(vec![pillar(&p, to, data, carried, depth)]), diff --git a/crates/horizon-port-pack/src/worldgen.rs b/crates/horizon-port-pack/src/worldgen.rs index 298179acf..0e3d968e3 100644 --- a/crates/horizon-port-pack/src/worldgen.rs +++ b/crates/horizon-port-pack/src/worldgen.rs @@ -15,10 +15,10 @@ //! closely. //! //! YUNG's API's files are carried as written ([`crate::yung`]). -//! Lithostitched's and CTOV's worldgen files are converted by -//! `legacy_structure_mods`, called from [`upgrade`], [`crate::carry`] and the -//! processors. -use crate::{legacy_structure_mods::lithostitched, yung}; +//! Lithostitched's jigsaws, elements, modifiers and processors are carried by +//! [`crate::lithostitched`]; the entries CTOV adds to vanilla's structure sets +//! by `legacy_structure_mods`, called from [`crate::carry`]. +use crate::{lithostitched, yung}; use serde_json::Value; use std::{ collections::{BTreeMap, BTreeSet}, @@ -191,28 +191,19 @@ fn drop_java_processors(list: &mut Value, dropped: &mut BTreeMap) let before = processors.len(); processors.retain(|p| { let t = p["processor_type"].as_str().unwrap_or_default(); - let java = !t.starts_with("minecraft:") && !t.starts_with("horizon:"); + let java = !t.starts_with("minecraft:") + && !t.starts_with("horizon:") + && !lithostitched::game_reads(p); if java { *dropped.entry(t.to_owned()).or_default() += 1; } !java }); let mut changed = processors.len() != before; - // The inline lists inside the game's apply_random and condition. + // The inline lists inside Lithostitched's apply_random and condition. for p in processors.iter_mut() { let inner: Vec<&mut Value> = match p["processor_type"].as_str() { - Some("horizon:apply_random") => p["processor_lists"] - .as_array_mut() - .into_iter() - .flatten() - .map(|e| &mut e["data"]) - .collect(), - Some("horizon:condition") => { - let o = p.as_object_mut().into_iter().flat_map(|o| o.iter_mut()); - o.filter(|(k, _)| *k == "then" || *k == "else") - .map(|(_, v)| v) - .collect() - } + Some(t) if t.starts_with("lithostitched:") => lithostitched::inner_lists(p), Some("horizon:pillar" | "horizon:bottom_pillar") => { p.get_mut("pillar_processor_list").into_iter().collect() } @@ -398,7 +389,9 @@ fn upgrade_types( } } for element in elements { - if yung::upgrade_pool_element(element, lost) { + if yung::upgrade_pool_element(element, lost) + || lithostitched::upgrade_pool_element(element, lost) + { changed = true; continue; } diff --git a/crates/horizon-world/src/worldgen/structure/processor.rs b/crates/horizon-world/src/worldgen/structure/processor.rs index f6f5d4508..b0a0622b7 100644 --- a/crates/horizon-world/src/worldgen/structure/processor.rs +++ b/crates/horizon-world/src/worldgen/structure/processor.rs @@ -21,7 +21,7 @@ use horizon_core::{ use serde_json::Value; use std::{collections::BTreeSet, sync::Arc}; -mod lithostitched; +mod litho; mod pillars; mod sea_level; @@ -238,6 +238,23 @@ impl Modifier { ) } } +impl Modifier { + /// RuleBlockEntityModifier.apply: the block entity the output gets. + fn apply(&self, nbt: Option<&Compound>, random: &mut impl ProcessorRandom) -> Option { + match self { + Self::Passthrough => nbt.cloned(), + Self::Clear => Some(Compound::new()), + Self::AppendLoot(table) => { + let mut nbt = nbt.cloned().unwrap_or_default(); + nbt.insert("LootTable".into(), Tag::String(table.as_str().into())); + nbt.insert("LootTableSeed".into(), Tag::Long(random.long())); + Some(nbt) + } + Self::AppendStatic(data) => Some(edited(nbt, &[], data)), + Self::Edit { remove, data } => Some(edited(nbt, remove, data)), + } + } +} /// A block entity with `remove`'s keys taken out and `data` merged in /// (append_static is the one with nothing to remove). fn edited(nbt: Option<&Compound>, remove: &[String], data: &Compound) -> Compound { @@ -292,17 +309,21 @@ pub enum Processor { SpawnerMobs(Box), Pick(Box), CountCap(Box), - /// `horizon:block_swap` (Lithostitched's `block_swap`): blocks by name - /// become others, keeping the properties both have. + /// `lithostitched:block_swap`: blocks by name become others, keeping + /// the properties both have (a block the game lacks is left alone). BlockSwap(std::collections::BTreeMap), - /// `horizon:apply_random` (Lithostitched's `apply_random`): a processor - /// list drawn by weight runs on the block. - ApplyRandom(Box), - /// `horizon:condition` (Lithostitched's `condition`): `then` or `else` + /// `lithostitched:apply_random`: a processor list drawn by weight runs + /// on the block. + ApplyRandom(Box), + /// `lithostitched:reference`: the named lists run on the block in turn. + Reference(Vec), + /// `lithostitched:discard_input`: the world's block stays. + DiscardInput, + /// `lithostitched:condition`: `then` or `else` /// runs on the block, by a test of it. - Condition(Box), - /// `horizon:set_block` (Lithostitched's `set_block`). - SetBlock(Box), + Condition(Box), + /// `lithostitched:set_block`: the block from a state provider. + SetBlock(Box), /// `horizon:pillar` (Repurposed Structures' and Moog's pillars): a /// trigger block starts a column down to the ground. Pillar(Box), @@ -786,7 +807,7 @@ impl Processor { })?)) } "horizon:pick" => Self::Pick(Box::new(Pick::decode(value, state)?)), - "horizon:block_swap" => Self::BlockSwap( + "lithostitched:block_swap" => Self::BlockSwap( value["blocks"] .as_object() .ok_or(DecodeError::Field("blocks"))? @@ -801,12 +822,16 @@ impl Processor { .collect::>()?, ), "horizon:count_cap" => Self::CountCap(Box::new(CountCap::decode(value, state)?)), - "horizon:apply_random" => Self::ApplyRandom(Box::new( - lithostitched::ApplyRandom::decode(value, resources, bindings)?, + "lithostitched:apply_random" => Self::ApplyRandom(Box::new( + litho::ApplyRandom::decode(value, resources, bindings)?, )), - "horizon:set_block" => { - Self::SetBlock(Box::new(lithostitched::SetBlock::decode(value, state)?)) + "lithostitched:set_block" => { + Self::SetBlock(Box::new(litho::SetBlock::decode(value, state)?)) } + "lithostitched:reference" => { + Self::Reference(litho::reference(value, resources, bindings)?) + } + "lithostitched:discard_input" => Self::DiscardInput, "horizon:pillar" => Self::Pillar(Box::new(pillars::Pillar::decode( value, resources, bindings, state, )?)), @@ -834,7 +859,7 @@ impl Processor { "horizon:keep_world_block" => { Self::KeepWorldBlock(Box::new(sea_level::KeepWorldBlock::decode(value)?)) } - "horizon:condition" => Self::Condition(Box::new(lithostitched::Conditional::decode( + "lithostitched:condition" => Self::Condition(Box::new(litho::Conditional::decode( value, resources, bindings, )?)), _ => return Err(DecodeError::Field("structure processor type")), @@ -1115,24 +1140,10 @@ fn process_block( if !position_ok { continue; } - let nbt = match &rule.modifier { - Modifier::Passthrough => info.nbt.clone(), - Modifier::Clear => Some(Compound::new()), - Modifier::AppendLoot(table) => { - let mut nbt = info.nbt.clone().unwrap_or_default(); - nbt.insert("LootTable".into(), Tag::String(table.as_str().into())); - nbt.insert("LootTableSeed".into(), Tag::Long(random.next_long())); - Some(nbt) - } - Modifier::AppendStatic(data) => Some(edited(info.nbt.as_ref(), &[], data)), - Modifier::Edit { remove, data } => { - Some(edited(info.nbt.as_ref(), remove, data)) - } - }; return Ok(Some(BlockInfo { pos: info.pos, state: rule.output, - nbt, + nbt: rule.modifier.apply(info.nbt.as_ref(), &mut random), })); } Some(info) @@ -1165,8 +1176,7 @@ fn process_block( false => Some(info), }, Processor::ApplyRandom(apply) => { - let seed = world.world_seed()?; - let mut random = apply.random.create(seed, position, reference, info.pos); + let mut random = apply.draws.random(world.world_seed()?, position, info.pos); match apply.pick(&mut random) { Some(list) => { return process_list( @@ -1176,21 +1186,34 @@ fn process_block( None => Some(info), } } + Processor::Reference(lists) => { + let mut current = info; + for list in lists { + match process_list( + list, world, resources, position, reference, relative, current, settings, + )? { + Some(next) => current = next, + None => return Ok(None), + } + } + Some(current) + } + Processor::DiscardInput => None, Processor::SetBlock(set) => { - let seed = world.world_seed()?; - let state = set.state(seed, position, reference, info.pos); - let state = match set.preserves() { + let mut random = set.draws.random(world.world_seed()?, position, info.pos); + let state = set.state(&mut random); + let state = match set.preserve { true => registry .state(state) .and_then(|s| with_properties_of(registry, &s.name, info.state)) .unwrap_or(state), false => state, }; - Some(BlockInfo { state, ..info }) + let nbt = set.modifier.apply(info.nbt.as_ref(), &mut random); + Some(BlockInfo { state, nbt, ..info }) } Processor::Condition(c) => { - let seed = world.world_seed()?; - let mut random = c.random.create(seed, position, reference, info.pos); + let mut random = c.draws.random(world.world_seed()?, position, info.pos); let location = world.block_state(info.pos)?; let passed = c .condition diff --git a/crates/horizon-world/src/worldgen/structure/processor/litho.rs b/crates/horizon-world/src/worldgen/structure/processor/litho.rs new file mode 100644 index 000000000..d243eb1c7 --- /dev/null +++ b/crates/horizon-world/src/worldgen/structure/processor/litho.rs @@ -0,0 +1,470 @@ +//! Lithostitched's processors (spec-lithostitched §5), read as its data +//! writes them: `lithostitched:block_swap` (in `processor.rs`), `reference`, +//! `apply_random`, `condition`, `set_block` and `discard_input`. +//! +//! The draws of `random_chance`, `apply_random` and `set_block` follow +//! Lithostitched's `random_mode` (per block or per piece), but its seeding is +//! not known (OPEN-L6): a positional random of the world seed, the block's or +//! the piece's position and the processor itself, so the shares match while +//! the blocks chosen do not. +use super::{BlockStateId, DecodeError, Modifier, ProcessorList, ProcessorRandom}; +use crate::worldgen::{block_feature::FeatureBlockBindings, structure::StructureResources}; +use horizon_core::{ + position::BlockPos, + random::{LegacyRandom, position_seed}, +}; +use serde_json::Value; +use std::collections::BTreeSet; + +/// `random_mode` (`condition`, `set_block`) or `mode` (`apply_random`). +#[derive(Clone, Copy, Debug)] +pub(super) struct Draws { + per_piece: bool, + /// The processor's own salt, so two processors on a block draw apart. + salt: i64, +} +impl Draws { + fn decode(mode: Option<&Value>, processor: &Value) -> Result { + let per_piece = match mode.and_then(Value::as_str) { + None | Some("per_block") => false, + Some("per_piece") => true, + _ => return Err(DecodeError::Field("random_mode")), + }; + // FNV-1a over the processor's JSON: the same in every run. + let salt = (processor.to_string().bytes()).fold(0xcbf2_9ce4_8422_2325_u64, |h, b| { + (h ^ u64::from(b)).wrapping_mul(0x0100_0000_01b3) + }) as i64; + Ok(Self { per_piece, salt }) + } + /// The random for the block at `pos` of the piece at `piece`. + pub(super) fn random(self, world_seed: i64, piece: [i32; 3], pos: [i32; 3]) -> LegacyRandom { + let [x, y, z] = if self.per_piece { piece } else { pos }; + LegacyRandom::new(world_seed ^ self.salt ^ position_seed(BlockPos::new(x, y, z))) + } +} + +/// A processor or a list of them (`then`, `else`, `apply_random`'s data): +/// a list holder (`ProcessorList::decode`), or one processor object. +fn processors( + value: &Value, + resources: &StructureResources, + bindings: &FeatureBlockBindings<'_>, +) -> Result { + let one = value.get("processor_type").is_some(); + let holder = if one { + Value::Array(vec![value.clone()]) + } else { + value.clone() + }; + ProcessorList::decode(&holder.to_string(), resources, bindings) +} + +/// `reference`: the named lists, run in turn on the block. +pub(super) fn reference( + value: &Value, + resources: &StructureResources, + bindings: &FeatureBlockBindings<'_>, +) -> Result, DecodeError> { + let names = match &value["processor_lists"] { + Value::Array(a) => a.clone(), + other => vec![other.clone()], + }; + (names.iter()) + .map(|name| match name.as_str() { + Some(n) if n.starts_with('#') => Err(DecodeError::Field("processor list tag")), + Some(_) => ProcessorList::decode(&name.to_string(), resources, bindings), + None => Err(DecodeError::Field("processor_lists")), + }) + .collect() +} + +/// `apply_random`: one list drawn by weight runs on the block. +#[derive(Clone, Debug)] +pub struct ApplyRandom { + pub(super) draws: Draws, + lists: Vec<(i32, ProcessorList)>, + total: i32, +} +impl ApplyRandom { + pub(super) fn decode( + value: &Value, + resources: &StructureResources, + bindings: &FeatureBlockBindings<'_>, + ) -> Result { + let entries = value["processor_lists"] + .as_array() + .ok_or(DecodeError::Field("apply_random processor_lists"))?; + let lists = (entries.iter()) + .map(|e| match e.get("data") { + Some(data) => { + let weight = e["weight"] + .as_i64() + .unwrap_or(1) + .clamp(0, i64::from(i32::MAX)); + Ok((weight as i32, processors(data, resources, bindings)?)) + } + None => Ok((1, processors(e, resources, bindings)?)), + }) + .collect::, DecodeError>>()?; + let total = lists + .iter() + .map(|(w, _)| *w) + .fold(0i32, i32::saturating_add); + Ok(Self { + draws: Draws::decode(value.get("mode"), value)?, + lists, + total, + }) + } + /// The list drawn: one bounded draw over the total weight. + pub(super) fn pick(&self, random: &mut impl ProcessorRandom) -> Option<&ProcessorList> { + if self.total <= 0 { + return None; + } + let mut at = random.int(self.total); + for (weight, list) in &self.lists { + at -= weight; + if at < 0 { + return Some(list); + } + } + None + } +} + +/// Lithostitched's processor conditions. +#[derive(Clone, Debug)] +pub(super) enum Condition { + True, + AllOf(Vec), + AnyOf(Vec), + Not(Box), + Chance(f32), + /// `matching_blocks`: the template's block (`input`) or the world's + /// (`location`) is one of `blocks`, with `properties`. + Matching { + blocks: BTreeSet, + properties: Vec<(String, String)>, + location: bool, + }, +} +impl Condition { + /// One condition, or a list of them that must all pass (`if_true`). + pub(super) fn decode( + value: &Value, + bindings: &FeatureBlockBindings<'_>, + ) -> Result { + let list = |v: &Value| -> Result, DecodeError> { + (v.as_array().ok_or(DecodeError::Field("conditions"))?.iter()) + .map(|c| Self::decode(c, bindings)) + .collect() + }; + if value.is_array() { + return Ok(Self::AllOf(list(value)?)); + } + let kind = value["type"].as_str().unwrap_or_default(); + Ok(match crate::worldgen::tags::identifier(kind)?.as_str() { + "lithostitched:true" => Self::True, + "lithostitched:all_of" => Self::AllOf(list(&value["conditions"])?), + "lithostitched:any_of" => Self::AnyOf(list(&value["conditions"])?), + "lithostitched:not" => { + Self::Not(Box::new(Self::decode(&value["condition"], bindings)?)) + } + "lithostitched:random_chance" => Self::Chance( + value["chance"] + .as_f64() + .ok_or(DecodeError::Field("random_chance chance"))? as f32, + ), + "lithostitched:matching_blocks" => Self::Matching { + blocks: blocks(&value["blocks"], bindings)?, + properties: (value + .get("properties") + .and_then(Value::as_object) + .into_iter()) + .flatten() + .map(|(k, v)| { + ( + k.clone(), + v.as_str().map_or_else(|| v.to_string(), str::to_owned), + ) + }) + .collect(), + location: match value.get("match_type").and_then(Value::as_str) { + None | Some("input") => false, + Some("location") => true, + _ => return Err(DecodeError::Field("matching_blocks match_type")), + }, + }, + _ => return Err(DecodeError::Field("lithostitched condition type")), + }) + } + pub(super) fn test( + &self, + input: BlockStateId, + location: BlockStateId, + registry: &crate::registry::BlockRegistry, + random: &mut impl ProcessorRandom, + ) -> bool { + match self { + Self::True => true, + Self::AllOf(all) => all + .iter() + .all(|c| c.test(input, location, registry, random)), + Self::AnyOf(any) => any + .iter() + .any(|c| c.test(input, location, registry, random)), + Self::Not(c) => !c.test(input, location, registry, random), + Self::Chance(chance) => random.float() < *chance, + Self::Matching { + blocks, + properties, + location: at_location, + } => { + let Some(state) = registry.state(if *at_location { location } else { input }) + else { + return false; + }; + blocks.contains(&state.name) + && (properties.iter()).all(|(k, v)| state.properties.get(k) == Some(v)) + } + } + } +} +/// A block set (an id, a list, `#tag`) by block name. Blocks the game does +/// not have are left out: no template block can be one. +fn blocks( + value: &Value, + bindings: &FeatureBlockBindings<'_>, +) -> Result, DecodeError> { + let names: Vec<&str> = match value { + Value::String(s) => vec![s.as_str()], + Value::Array(a) => a.iter().filter_map(Value::as_str).collect(), + _ => return Err(DecodeError::Field("matching_blocks blocks")), + }; + let registry = bindings.registry(); + let mut out = BTreeSet::new(); + for name in names { + match name.strip_prefix('#') { + Some(tag) => { + let tag = crate::worldgen::tags::identifier(tag)?; + let states = bindings.tags.get(&tag).into_iter().flat_map(|s| s.iter()); + out.extend(states.filter_map(|s| Some(registry.state(*s)?.name.clone()))); + } + None => { + out.insert(crate::worldgen::tags::identifier(name)?.to_string()); + } + } + } + Ok(out) +} + +/// `condition`: `then` when the conditions pass, else `else` (none: the +/// block as it is). +#[derive(Clone, Debug)] +pub struct Conditional { + pub(super) draws: Draws, + pub(super) condition: Condition, + pub(super) then: ProcessorList, + pub(super) otherwise: ProcessorList, +} +impl Conditional { + pub(super) fn decode( + value: &Value, + resources: &StructureResources, + bindings: &FeatureBlockBindings<'_>, + ) -> Result { + let branch = |key| match value.get(key) { + Some(v) => processors(v, resources, bindings), + None => Ok(ProcessorList(Vec::new())), + }; + Ok(Self { + draws: Draws::decode(value.get("random_mode"), value)?, + condition: Condition::decode(&value["if_true"], bindings)?, + then: branch("then")?, + otherwise: branch("else")?, + }) + } +} + +/// `set_block`: the block from a state provider (simple or weighted). +#[derive(Clone, Debug)] +pub struct SetBlock { + pub(super) draws: Draws, + states: Vec<(i32, BlockStateId)>, + total: i32, + /// `preserve_state` (true by default): the template block's properties + /// the new block has too are kept. + pub(super) preserve: bool, + pub(super) modifier: Modifier, +} +impl SetBlock { + pub(super) fn decode( + value: &Value, + state: impl Fn(&Value) -> Result, + ) -> Result { + let provider = &value["state_provider"]; + let kind = provider["type"].as_str().unwrap_or_default(); + let states = match crate::worldgen::tags::identifier(kind)?.as_str() { + "minecraft:simple_state_provider" => vec![(1, state(&provider["state"])?)], + "minecraft:weighted_state_provider" => (provider["entries"].as_array().into_iter()) + .flatten() + .map(|e| { + Ok(( + e["weight"].as_i64().unwrap_or(1).clamp(0, 1 << 30) as i32, + state(&e["data"])?, + )) + }) + .collect::>()?, + _ => return Err(DecodeError::Field("set_block state_provider")), + }; + let total = states.iter().map(|(w, _)| *w).sum(); + if total <= 0 { + return Err(DecodeError::Field("set_block state_provider")); + } + Ok(Self { + draws: Draws::decode(value.get("random_mode"), value)?, + states, + total, + preserve: value + .get("preserve_state") + .and_then(Value::as_bool) + .unwrap_or(true), + modifier: Modifier::decode(value.get("block_entity_modifier"))?, + }) + } + /// The provider's state: WeightedList.getRandom, one bounded draw. + pub(super) fn state(&self, random: &mut impl ProcessorRandom) -> BlockStateId { + let mut at = random.int(self.total); + for (weight, state) in &self.states { + at -= weight; + if at < 0 { + return *state; + } + } + self.states[0].1 + } +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::registry::BlockRegistry; + use serde_json::json; + + // 0 air, 1 cobblestone, 2..=9 wheat age 0..7, 10..=13 beetroots age 0..3, + // 14..=21 carrots age 0..7, 22 water. + fn registry() -> BlockRegistry { + let row = |name: &str, age: u32| json!([name, false, false, "", {"id": name, "properties": {"age": age.to_string()}}]); + let mut states = vec![ + json!(["minecraft:air", false, false, "", "minecraft:air"]), + json!([ + "minecraft:cobblestone", + false, + false, + "", + "minecraft:cobblestone" + ]), + ]; + states.extend((0..8).map(|a| row("minecraft:wheat", a))); + states.extend((0..4).map(|a| row("minecraft:beetroots", a))); + states.extend((0..8).map(|a| row("minecraft:carrots", a))); + states.push(json!([ + "minecraft:water", + false, + false, + "", + "minecraft:water" + ])); + let facts = json!({"defaults": {"minecraft:air": 0, "minecraft:cobblestone": 1, "minecraft:wheat": 2, + "minecraft:beetroots": 10, "minecraft:carrots": 14, "minecraft:water": 22}, "states": states}); + BlockRegistry::from_facts_json(facts.to_string().as_bytes()).unwrap() + } + + #[test] + fn swaps_keep_only_the_properties_the_new_block_can_have() { + // spec-ctov §4: wheat[age=7] becomes carrots[age=7] but beetroots[age=0]. + let registry = registry(); + let ripe_wheat = BlockStateId(9); + let swap = |to| super::super::with_properties_of(®istry, to, ripe_wheat); + assert_eq!(swap("minecraft:carrots"), Some(BlockStateId(21))); + assert_eq!(swap("minecraft:beetroots"), Some(BlockStateId(10))); + // A block the game does not have: the template's block stays. + assert_eq!(swap("natures_spirit:olive_log"), None); + } + + #[test] + fn conditions_read_the_template_or_the_world() { + let registry = registry(); + let mut random = LegacyRandom::new(1); + let matching = |location| Condition::Matching { + blocks: BTreeSet::from(["minecraft:water".to_owned()]), + properties: Vec::new(), + location, + }; + let (cobblestone, water) = (BlockStateId(1), BlockStateId(22)); + assert!(!matching(false).test(cobblestone, water, ®istry, &mut random)); + assert!(matching(true).test(cobblestone, water, ®istry, &mut random)); + let ripe = Condition::Matching { + blocks: BTreeSet::from(["minecraft:wheat".to_owned()]), + properties: vec![("age".into(), "7".into())], + location: false, + }; + assert!(ripe.test(BlockStateId(9), water, ®istry, &mut random)); + assert!(!ripe.test(BlockStateId(8), water, ®istry, &mut random)); + let both = Condition::AllOf(vec![ + matching(true), + Condition::Not(Box::new(Condition::True)), + ]); + assert!(!both.test(cobblestone, water, ®istry, &mut random)); + assert!( + Condition::AnyOf(vec![Condition::Chance(0.), matching(true)]).test( + cobblestone, + water, + ®istry, + &mut random + ) + ); + } + + #[test] + fn per_piece_draws_once_per_piece() { + let p = json!({"processor_type": "lithostitched:apply_random"}); + let piece = Draws::decode(Some(&json!("per_piece")), &p).unwrap(); + let block = Draws::decode(None, &p).unwrap(); + let first = |d: Draws, pos| d.random(42, [0, 64, 0], pos).int(1 << 30); + assert_eq!(first(piece, [1, 64, 1]), first(piece, [9, 70, 3])); + assert_ne!(first(block, [1, 64, 1]), first(block, [9, 70, 3])); + // Another processor draws apart on the same block. + let other = + Draws::decode(None, &json!({"processor_type": "lithostitched:set_block"})).unwrap(); + assert_ne!(first(block, [1, 64, 1]), first(other, [1, 64, 1])); + assert!(Draws::decode(Some(&json!("per_structure")), &p).is_err()); + } + + #[test] + fn set_block_draws_by_weight() { + let set = SetBlock::decode( + &json!({"processor_type": "lithostitched:set_block", "preserve_state": false, + "state_provider": {"type": "minecraft:weighted_state_provider", "entries": [ + {"weight": 1, "data": {"id": "minecraft:cobblestone"}}, + {"weight": 3, "data": {"id": "minecraft:water"}}]}}), + |v| { + Ok(BlockStateId(if v["id"] == "minecraft:water" { + 22 + } else { + 1 + })) + }, + ) + .unwrap(); + assert!(!set.preserve); + let water = (0..4000) + .filter(|x| { + set.state(&mut set.draws.random(7, [0; 3], [*x, 64, 0])) == BlockStateId(22) + }) + .count(); + assert!((2850..3150).contains(&water), "{water}"); + let unknown = json!({"state_provider": {"type": "minecraft:noise_provider"}}); + assert!(SetBlock::decode(&unknown, |_| Ok(BlockStateId(0))).is_err()); + } +} diff --git a/crates/horizon-world/src/worldgen/structure/processor/lithostitched.rs b/crates/horizon-world/src/worldgen/structure/processor/lithostitched.rs deleted file mode 100644 index f0bb1c6ba..000000000 --- a/crates/horizon-world/src/worldgen/structure/processor/lithostitched.rs +++ /dev/null @@ -1,434 +0,0 @@ -//! Lithostitched's processors that pick processors, carried as data -//! (`horizon:apply_random` and `horizon:condition`): one runs a processor -//! list drawn by weight, the other one list or another by a test of the -//! block. Both draw from Lithostitched's RandomSettings: a random seeded from -//! the world seed and a name, at the block, the piece or the structure. -//! `horizon:set_block` is its `set_block`, which the conditions mostly run. -use super::{Processor, ProcessorList}; -use crate::{ - registry::{BlockRegistry, BlockStateId}, - worldgen::{DecodeError, block_feature::FeatureBlockBindings, structure::StructureResources}, -}; -use horizon_core::{ - position::BlockPos, - random::{LegacyRandom, PositionalRandom, RandomSource}, -}; -use serde_json::Value; -use std::{collections::BTreeSet, sync::Arc}; - -/// RandomSettings: where the random is taken, and the name salting it. -#[derive(Clone, Debug, PartialEq)] -pub struct RandomSettings { - mode: Mode, - /// ResourceLocation.hashCode of the name (`lithostitched:default`). - salt: i32, -} -#[derive(Clone, Copy, Debug, PartialEq)] -enum Mode { - Block, - Piece, - Structure, -} -impl RandomSettings { - /// A mode alone, or `{"mode": ..., "name": ...}`; per block when unset. - fn decode(v: Option<&Value>) -> Result { - let mode = Mode::decode; - let (mode, name) = match v { - None => (Mode::Block, "lithostitched:default"), - Some(Value::String(m)) => (mode(Some(m))?, "lithostitched:default"), - Some(o) => ( - mode(o["mode"].as_str())?, - o["name"] - .as_str() - .ok_or(DecodeError::Field("random name"))?, - ), - }; - let (namespace, path) = name.split_once(':').unwrap_or(("minecraft", name)); - Ok(Self { - mode, - salt: java_hash(namespace) - .wrapping_mul(31) - .wrapping_add(java_hash(path)), - }) - } - /// RandomSource.create(seed + hash).forkPositional().at(the chosen - /// position): the piece's position, the structure's pivot or the block. - pub(super) fn create( - &self, - seed: i64, - piece: [i32; 3], - pivot: [i32; 3], - block: [i32; 3], - ) -> LegacyRandom { - let [x, y, z] = self.mode.select(piece, pivot, block); - LegacyRandom::new(seed.wrapping_add(i64::from(self.salt))) - .fork_positional() - .at(BlockPos::new(x, y, z)) - } -} -impl Mode { - fn decode(m: Option<&str>) -> Result { - match m { - None | Some("per_block") => Ok(Self::Block), - Some("per_piece") => Ok(Self::Piece), - Some("per_structure") => Ok(Self::Structure), - _ => Err(DecodeError::Field("random mode")), - } - } - fn select(self, piece: [i32; 3], pivot: [i32; 3], block: [i32; 3]) -> [i32; 3] { - match self { - Self::Block => block, - Self::Piece => piece, - Self::Structure => pivot, - } - } -} - -/// SetBlockProcessor with a simple or weighted state provider and no block -/// entity change: the block becomes the state, keeping the properties it -/// shares with the old one unless `preserve_state` is off. -#[derive(Clone, Debug)] -pub struct SetBlock { - /// The states and their weights; one state alone is a simple provider, - /// which draws nothing. - states: Vec<(BlockStateId, i32)>, - weighted: bool, - preserve: bool, - mode: Mode, -} -impl SetBlock { - pub(super) fn decode( - v: &Value, - state: impl Fn(&Value) -> Result, - ) -> Result { - let provider = &v["state_provider"]; - let (states, weighted) = match provider["type"].as_str() { - Some("minecraft:simple_state_provider") => { - (vec![(state(&provider["state"])?, 1)], false) - } - Some("minecraft:weighted_state_provider") => ( - provider["entries"] - .as_array() - .ok_or(DecodeError::Field("set_block entries"))? - .iter() - .map(|e| { - let weight = e["weight"] - .as_i64() - .ok_or(DecodeError::Field("set_block weight"))?; - Ok((state(&e["data"])?, weight as i32)) - }) - .collect::>()?, - true, - ), - _ => return Err(DecodeError::Field("set_block state_provider")), - }; - if states.is_empty() { - return Err(DecodeError::Field("set_block entries")); - } - Ok(Self { - states, - weighted, - preserve: v["preserve_state"].as_bool().unwrap_or(true), - mode: Mode::decode(v["random_mode"].as_str())?, - }) - } - /// The state to set, before `preserve`: drawn with - /// RandomSource.create(seed).forkPositional().at(the chosen position). - pub(super) fn state( - &self, - seed: i64, - piece: [i32; 3], - pivot: [i32; 3], - block: [i32; 3], - ) -> BlockStateId { - if !self.weighted { - return self.states[0].0; - } - let [x, y, z] = self.mode.select(piece, pivot, block); - let mut random = LegacyRandom::new(seed) - .fork_positional() - .at(BlockPos::new(x, y, z)); - let total: i32 = self.states.iter().map(|s| s.1).sum(); - let mut value = random.next_int_bound(total.max(1)).unwrap_or(0); - for (state, weight) in &self.states { - if value < *weight { - return *state; - } - value -= weight; - } - self.states[0].0 - } - pub(super) fn preserves(&self) -> bool { - self.preserve - } -} - -/// String.hashCode over UTF-16 units. -fn java_hash(s: &str) -> i32 { - s.encode_utf16() - .fold(0i32, |h, c| h.wrapping_mul(31).wrapping_add(i32::from(c))) -} - -fn list( - v: &Value, - resources: &StructureResources, - bindings: &FeatureBlockBindings<'_>, -) -> Result { - ProcessorList::decode(&v.to_string(), resources, bindings) -} - -/// ApplyRandomStructureProcessor: a weighted list of processor lists, one -/// drawn per block with `nextInt(total)`. -#[derive(Clone, Debug)] -pub struct ApplyRandom { - pub(super) random: RandomSettings, - lists: Vec<(ProcessorList, i32)>, - total: i32, -} -impl ApplyRandom { - pub(super) fn decode( - v: &Value, - resources: &StructureResources, - bindings: &FeatureBlockBindings<'_>, - ) -> Result { - let lists = v["processor_lists"] - .as_array() - .ok_or(DecodeError::Field("apply_random processor_lists"))? - .iter() - .map(|e| { - let weight = e["weight"] - .as_i64() - .ok_or(DecodeError::Field("apply_random weight"))?; - Ok((list(&e["data"], resources, bindings)?, weight as i32)) - }) - .collect::, DecodeError>>()?; - Ok(Self { - random: RandomSettings::decode(v.get("mode"))?, - total: lists.iter().map(|l| l.1).sum(), - lists, - }) - } - /// WeightedList.getRandom: none when the weights add up to 0. - pub(super) fn pick(&self, random: &mut impl RandomSource) -> Option<&ProcessorList> { - if self.total <= 0 { - return None; - } - let mut value = random.next_int_bound(self.total).unwrap_or(0); - for (list, weight) in &self.lists { - if value < *weight { - return Some(list); - } - value -= weight; - } - None - } -} - -/// ConditionProcessor: `then` when the condition holds for the block, else -/// `else`. -#[derive(Clone, Debug)] -pub struct Conditional { - pub(super) random: RandomSettings, - pub(super) condition: Condition, - pub(super) then: ProcessorList, - pub(super) otherwise: ProcessorList, -} -impl Conditional { - pub(super) fn decode( - v: &Value, - resources: &StructureResources, - bindings: &FeatureBlockBindings<'_>, - ) -> Result { - // A processor alone or a list of them. - let processors = |key: &str| -> Result { - match v.get(key) { - None => Ok(ProcessorList::default()), - Some(Value::Object(p)) if p.contains_key("processor_type") => Ok(ProcessorList( - vec![Processor::decode(&v[key], resources, bindings)?], - )), - Some(other) => list(other, resources, bindings), - } - }; - Ok(Self { - random: RandomSettings::decode(v.get("random_mode"))?, - condition: Condition::decode(&v["if_true"], bindings)?, - then: processors("then")?, - otherwise: processors("else")?, - }) - } -} - -/// Lithostitched's processor conditions the game runs. -#[derive(Clone, Debug)] -pub(super) enum Condition { - True, - AllOf(Vec), - AnyOf(Vec), - Not(Box), - RandomChance(f32), - /// The block placed (`input`) or the one in the world (`location`) is - /// one of these, with these property values. - MatchingBlocks { - blocks: Arc>, - properties: Vec<(String, String)>, - location: bool, - }, -} -impl Condition { - fn decode(v: &Value, bindings: &FeatureBlockBindings<'_>) -> Result { - let all = |a: &Value| -> Result, DecodeError> { - a.as_array() - .ok_or(DecodeError::Field("processor conditions"))? - .iter() - .map(|c| Self::decode(c, bindings)) - .collect() - }; - if v.is_array() { - return Ok(Self::AllOf(all(v)?)); - } - let kind = v["type"].as_str().unwrap_or_default(); - Ok(match kind.strip_prefix("lithostitched:").unwrap_or(kind) { - "true" => Self::True, - "all_of" => Self::AllOf(all(&v["conditions"])?), - "any_of" => Self::AnyOf(all(&v["conditions"])?), - "not" => Self::Not(Box::new(Self::decode(&v["condition"], bindings)?)), - "random_chance" => Self::RandomChance(super::float(v, "chance")?), - "matching_blocks" => Self::MatchingBlocks { - blocks: super::holder_set(&v["blocks"], bindings)?, - properties: match v.get("properties") { - None => Vec::new(), - Some(p) => p - .as_object() - .ok_or(DecodeError::Field("matching_blocks properties"))? - .iter() - .map(|(k, x)| { - let x = x - .as_str() - .ok_or(DecodeError::Field("matching_blocks property"))?; - Ok((k.clone(), x.to_owned())) - }) - .collect::>()?, - }, - location: match v["match_type"].as_str() { - None | Some("input") => false, - Some("location") => true, - _ => return Err(DecodeError::Field("matching_blocks match_type")), - }, - }, - _ => return Err(DecodeError::Field("processor condition type")), - }) - } - /// ProcessorCondition.test with the block placed and the one there. - pub(super) fn test( - &self, - input: BlockStateId, - location: BlockStateId, - registry: &BlockRegistry, - random: &mut impl RandomSource, - ) -> bool { - match self { - Self::True => true, - Self::AllOf(all) => all - .iter() - .all(|c| c.test(input, location, registry, random)), - Self::AnyOf(any) => any - .iter() - .any(|c| c.test(input, location, registry, random)), - Self::Not(c) => !c.test(input, location, registry, random), - Self::RandomChance(chance) => random.next_float() < *chance, - Self::MatchingBlocks { - blocks, - properties, - location: at_location, - } => { - let state = if *at_location { location } else { input }; - blocks.contains(&state) - && properties.iter().all(|(k, x)| { - registry - .state(state) - .and_then(|s| s.properties.get(k)) - .is_some_and(|v| v == x) - }) - } - } - } -} - -#[cfg(test)] -mod tests { - use super::*; - - #[test] - fn random_settings_salt_and_position() { - // ResourceLocation.hashCode: 31 * namespace + path. - let default = RandomSettings::decode(Some(&"per_piece".into())).unwrap(); - assert_eq!( - default.salt, - java_hash("lithostitched") - .wrapping_mul(31) - .wrapping_add(java_hash("default")) - ); - assert_eq!(java_hash("default"), 1544803905); - let (seed, piece, pivot, block) = (12345, [16, 64, -32], [8, 70, 8], [17, 65, -30]); - let mut ours = default.create(seed, piece, pivot, block); - let mut theirs = LegacyRandom::new(seed + i64::from(default.salt)) - .fork_positional() - .at(BlockPos::new(16, 64, -32)); - assert_eq!(ours.next_long(), theirs.next_long()); - let named: Value = serde_json::json!({"mode": "per_structure", "name": "v:roof"}); - let named = RandomSettings::decode(Some(&named)).unwrap(); - assert_eq!(named.mode, Mode::Structure); - assert_eq!( - named.salt, - java_hash("v") - .wrapping_mul(31) - .wrapping_add(java_hash("roof")) - ); - } - - #[test] - fn apply_random_draws_by_weight() { - let apply = ApplyRandom { - random: RandomSettings { - mode: Mode::Block, - salt: 0, - }, - lists: vec![ - (ProcessorList(vec![Processor::Nop]), 3), - (ProcessorList::default(), 1), - ], - total: 4, - }; - let mut ours = LegacyRandom::new(9); - let mut theirs = LegacyRandom::new(9); - for _ in 0..32 { - let draw = theirs.next_int_bound(4).unwrap(); - let picked = apply.pick(&mut ours).unwrap(); - assert_eq!(picked.0.len(), usize::from(draw < 3)); - } - } - - #[test] - fn set_block_draws_from_the_unsalted_seed() { - let (a, b) = (BlockStateId(1), BlockStateId(2)); - let set = SetBlock::decode( - &serde_json::json!({"state_provider": {"type": "minecraft:weighted_state_provider", - "entries": [{"weight": 1, "data": 1}, {"weight": 2, "data": 2}]}, - "random_mode": "per_piece"}), - |v| Ok(BlockStateId(v.as_u64().unwrap() as u32)), - ) - .unwrap(); - assert!(set.preserves()); - for x in 0..16 { - let mut java = LegacyRandom::new(77) - .fork_positional() - .at(BlockPos::new(x, 5, 3)); - let want = if java.next_int_bound(3).unwrap() < 1 { - a - } else { - b - }; - assert_eq!(set.state(77, [x, 5, 3], [0; 3], [9, 9, 9]), want); - } - } -} diff --git a/docs/modpacks.md b/docs/modpacks.md index 13ad619ed..8e3980dd2 100644 --- a/docs/modpacks.md +++ b/docs/modpacks.md @@ -504,21 +504,22 @@ Two cases the oracle fills in: mod. Better Dungeons' small dungeons keep one chest and each other one with a fifth's chance, two at most (the game's `horizon:count_cap`, counted per placement as the mod's DungeonContext is): 12 chests in five small dungeons at seed 1234 become 6. - Lithostitched's `block_swap` (137 lists, all in ChoiceTheorem's Overhauled Village) is the - game's `horizon:block_swap`: the same map, with Block.withPropertiesOf's properties kept; - a target block the game does not have (most of them are Nature's Spirit's and Croptopia's) - leaves the block as it is, as the mod does. Lithostitched's `reference` (CTOV builds most - of its lists from others) has the referenced lists' processors written in its place; its - `apply_random`, `condition` and `set_block` are the game's `horizon:apply_random`, - `horizon:condition` and `horizon:set_block`, with Lithostitched's random (the world seed - plus the name's hash, at the block, piece or structure). In a CTOV plains village at seed - 1234 the farms now grow carrots, potatoes and beetroot besides wheat, and 1,655 - cobblestone blocks become paths, grass, mossy cobblestone and planks. No Lithostitched processor is - dropped now (130 before). CTOV's compat hooks for other mods inside them (its - `modular_compat`, 142 copies) run a list of their own only when the mod they name is - loaded: carry writes that list in when the mod is ported along and takes the hook out (a - no-op, as in the mod) when it is not. In ATM10 all 142 name Nature's Spirit, which the - pack does not have. + Lithostitched's processors (all in ChoiceTheorem's Overhauled Village in ATM10) are the + game's own types, read as the mod writes them. `block_swap` keeps the properties the new + block can have: a farm's ripe wheat becomes ripe carrots, but beetroot, whose age stops at + 3, keeps its default; a target block the game does not have (most are Nature's Spirit's and + Croptopia's) leaves the block as it is. `reference` runs the lists it names, `condition` + tests the template's block or the world's, `apply_random` and `set_block` draw per block or + per piece as the data says. Lithostitched's own random is not known yet, so the shares of a + random choice are the Java pack's but the blocks chosen differ. Lists named by tag and state + providers other than simple and weighted ones are dropped and counted (ATM10 has none). + CTOV's compat hooks for other mods (its `modular_compat`, 30 of them in 17 lists) become a + `reference` when the mod they name is ported along, and are taken out (a no-op, as in the + mod) when it is not. In ATM10 they all name Nature's Spirit, which the pack does not have. + In Java, Lithostitched also lays out every jigsaw structure its own way (villages, + outposts, trial chambers; CTOV's villages are `lithostitched:jigsaw`, carried as vanilla's + jigsaw). Horizon keeps vanilla's layouts, so with Lithostitched in a pack, structure layouts + differ from the Java pack's for the same seed (their positions do not). The processors that build outside their template are carried too: Repurposed's and Moog's pillar processors become the game's `horizon:pillar` (a column from a placeholder block down to the ground, with the processor list they run on each of its blocks written From d89fb16f601c245c23d9ab2ba98323cec84cc084 Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Sun, 25 Oct 2026 09:06:14 +0100 Subject: [PATCH 02/28] Structure blocks harness: CTOV's known differences Co-Authored-By: Claude Opus 5.5 --- tools/test_structure_blocks_parity.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/tools/test_structure_blocks_parity.py b/tools/test_structure_blocks_parity.py index 39ccb4e49..fc4151f8d 100644 --- a/tools/test_structure_blocks_parity.py +++ b/tools/test_structure_blocks_parity.py @@ -55,6 +55,12 @@ KNOWN = { "Better Dungeons' own structure types (spec-betterdungeons §5, §6; OPEN-B14, B15) are not " 'implemented yet', }, + 'ctov': { + r'^ctov:': "Lithostitched's random is not known (spec-lithostitched OPEN-L6): per-block road and palette " + 'choices match by share, not by block; and decoration (grass, trees) differs where the village ' + 'changed the terrain', + r'^minecraft:village_plains$': 'decoration (grass, trees) differs where the village changed the terrain', + }, } From eb6c81945ad8b1d6acb2c5b9a089b0e7239a7092 Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Sun, 25 Oct 2026 09:29:53 +0100 Subject: [PATCH 03/28] Lithostitched processors: unit tests rewritten from the spec The previous tests of litho.rs are deleted unread (clean-room ruling of 2026-10-25). The new ones build their own block registry from a facts table and run each processor through process_list against a one-block world: block_swap's property copy (CTOV's beetroots), references in order and discard_input, the probe pack's nested condition with else, apply_random per piece and per block, set_block's providers and its block entity modifier. Co-Authored-By: Claude Opus 5.5 --- .../src/worldgen/structure/processor/litho.rs | 577 ++++++++++++++---- 1 file changed, 474 insertions(+), 103 deletions(-) diff --git a/crates/horizon-world/src/worldgen/structure/processor/litho.rs b/crates/horizon-world/src/worldgen/structure/processor/litho.rs index d243eb1c7..6ba006fd6 100644 --- a/crates/horizon-world/src/worldgen/structure/processor/litho.rs +++ b/crates/horizon-world/src/worldgen/structure/processor/litho.rs @@ -347,124 +347,495 @@ impl SetBlock { #[cfg(test)] mod tests { - use super::*; - use crate::registry::BlockRegistry; - use serde_json::json; + use super::super::{BlockInfo, PlaceSettings, ProcessorList, process_list}; + use crate::{ + heightmap::HeightmapType, + nbt::{JavaString, Tag}, + registry::{BlockRegistry, BlockStateId}, + worldgen::{ + anchor::WorldGenerationContext, + block_feature::FeatureBlockBindings, + placement::{PlacementContext, PlacementQueryError}, + structure::{ + Rotation, StateTransforms, StructureResources, template::parse_state_string, + }, + }, + }; + use serde_json::{Value, json}; + use std::collections::{BTreeMap, BTreeSet}; - // 0 air, 1 cobblestone, 2..=9 wheat age 0..7, 10..=13 beetroots age 0..3, - // 14..=21 carrots age 0..7, 22 water. - fn registry() -> BlockRegistry { - let row = |name: &str, age: u32| json!([name, false, false, "", {"id": name, "properties": {"age": age.to_string()}}]); - let mut states = vec![ - json!(["minecraft:air", false, false, "", "minecraft:air"]), - json!([ - "minecraft:cobblestone", - false, - false, - "", - "minecraft:cobblestone" - ]), + /// Every combination of `properties`' values, the first one the default. + fn states(name: &str, properties: &[(&str, &[&str])]) -> Vec { + let mut out = vec![serde_json::Map::new()]; + for (key, values) in properties { + out = (out.iter()) + .flat_map(|o| { + values.iter().map(move |v| { + let mut o = o.clone(); + o.insert((*key).into(), (*v).into()); + o + }) + }) + .collect(); + } + (out.into_iter()) + .map(|p| json!([name, name.ends_with("air"), false, "", {"id": name, "properties": p}])) + .collect() + } + + /// A registry of the blocks CTOV's lists and the probe pack use. + fn registry() -> &'static BlockRegistry { + let ages: Vec = (0..8).map(|a| a.to_string()).collect(); + let ages: Vec<&str> = ages.iter().map(String::as_str).collect(); + let levels: Vec = (0..16).map(|a| a.to_string()).collect(); + let levels: Vec<&str> = levels.iter().map(String::as_str).collect(); + let water = [("level", &levels[..])]; + let stairs: &[(&str, &[&str])] = + &[("facing", &["north", "east"]), ("half", &["bottom", "top"])]; + let blocks: Vec<(&str, &[(&str, &[&str])])> = vec![ + ("minecraft:air", &[]), + ("minecraft:cave_air", &[]), + ("minecraft:void_air", &[]), + ("minecraft:lava", &water), + ("minecraft:cobblestone", &[]), + ("minecraft:blackstone", &[]), + ("minecraft:deepslate", &[]), + ("minecraft:water", &water), + ("minecraft:spruce_planks", &[]), + ("minecraft:chest", &[]), + ("minecraft:oak_log", &[("axis", &["y", "x"])]), + ("minecraft:stripped_cherry_log", &[("axis", &["y", "x"])]), + ("minecraft:oak_stairs", stairs), + ("minecraft:warped_stairs", stairs), ]; - states.extend((0..8).map(|a| row("minecraft:wheat", a))); - states.extend((0..4).map(|a| row("minecraft:beetroots", a))); - states.extend((0..8).map(|a| row("minecraft:carrots", a))); - states.push(json!([ - "minecraft:water", - false, - false, - "", - "minecraft:water" - ])); - let facts = json!({"defaults": {"minecraft:air": 0, "minecraft:cobblestone": 1, "minecraft:wheat": 2, - "minecraft:beetroots": 10, "minecraft:carrots": 14, "minecraft:water": 22}, "states": states}); - BlockRegistry::from_facts_json(facts.to_string().as_bytes()).unwrap() + let wheat = [("age", &ages[..])]; + let beetroots = [("age", &ages[..4])]; + let mut rows = Vec::new(); + let mut defaults = BTreeMap::new(); + let crops: [(&str, &[(&str, &[&str])]); 3] = [ + ("minecraft:wheat", &wheat), + ("minecraft:carrots", &wheat), + ("minecraft:beetroots", &beetroots), + ]; + for (name, properties) in blocks.into_iter().chain(crops) { + defaults.insert(name, rows.len()); + rows.extend(states(name, properties)); + } + let facts = json!({"states": rows, "defaults": defaults}); + let registry = BlockRegistry::from_facts_json(facts.to_string().as_bytes()).unwrap(); + Box::leak(Box::new(registry)) } - #[test] - fn swaps_keep_only_the_properties_the_new_block_can_have() { - // spec-ctov §4: wheat[age=7] becomes carrots[age=7] but beetroots[age=0]. - let registry = registry(); - let ripe_wheat = BlockStateId(9); - let swap = |to| super::super::with_properties_of(®istry, to, ripe_wheat); - assert_eq!(swap("minecraft:carrots"), Some(BlockStateId(21))); - assert_eq!(swap("minecraft:beetroots"), Some(BlockStateId(10))); - // A block the game does not have: the template's block stays. - assert_eq!(swap("natures_spirit:olive_log"), None); + /// The world a piece is placed in: one block everywhere. + struct World { + seed: i64, + block: BlockStateId, + } + impl PlacementContext for World { + fn world_seed(&mut self) -> Result { + Ok(self.seed) + } + fn block_state(&mut self, _: [i32; 3]) -> Result { + Ok(self.block) + } + fn generation(&self) -> WorldGenerationContext { + WorldGenerationContext::new(-64, 384, 63) + } + fn min_y(&mut self) -> Result { + Ok(-64) + } + fn height(&mut self, _: HeightmapType, _: i32, _: i32) -> Result { + Err(PlacementQueryError::Unavailable) + } } - #[test] - fn conditions_read_the_template_or_the_world() { - let registry = registry(); - let mut random = LegacyRandom::new(1); - let matching = |location| Condition::Matching { - blocks: BTreeSet::from(["minecraft:water".to_owned()]), - properties: Vec::new(), - location, - }; - let (cobblestone, water) = (BlockStateId(1), BlockStateId(22)); - assert!(!matching(false).test(cobblestone, water, ®istry, &mut random)); - assert!(matching(true).test(cobblestone, water, ®istry, &mut random)); - let ripe = Condition::Matching { - blocks: BTreeSet::from(["minecraft:wheat".to_owned()]), - properties: vec![("age".into(), "7".into())], - location: false, - }; - assert!(ripe.test(BlockStateId(9), water, ®istry, &mut random)); - assert!(!ripe.test(BlockStateId(8), water, ®istry, &mut random)); - let both = Condition::AllOf(vec![ - matching(true), - Condition::Not(Box::new(Condition::True)), - ]); - assert!(!both.test(cobblestone, water, ®istry, &mut random)); - assert!( - Condition::AnyOf(vec![Condition::Chance(0.), matching(true)]).test( - cobblestone, - water, - ®istry, - &mut random + struct Lists { + registry: &'static BlockRegistry, + resources: StructureResources, + } + impl Lists { + fn new(lists: &[(&str, Value)]) -> Self { + let registry = registry(); + let lists = (lists.iter()) + .map(|(id, list)| ((*id).to_owned(), list.to_string())) + .collect(); + let resources = StructureResources::new( + registry, + StateTransforms::default(), + std::path::Path::new("/nonexistent"), + lists, + &BTreeMap::new(), + ); + Self { + registry, + resources, + } + } + fn id(&self, state: &str) -> BlockStateId { + parse_state_string(self.registry, state).unwrap() + } + fn decode(&self, processors: Value) -> Result { + let bindings = FeatureBlockBindings::new(self.registry, BTreeSet::new()).unwrap(); + ProcessorList::decode(&processors.to_string(), &self.resources, &bindings) + } + /// The block the list makes of template block `state` at `pos` of the + /// piece at `piece`, in a world of `world`: None when it is not placed. + fn run( + &self, + list: &ProcessorList, + world: (i64, &str), + piece: [i32; 3], + pos: [i32; 3], + state: &str, + ) -> Option { + let mut world = World { + seed: world.0, + block: self.id(world.1), + }; + let info = BlockInfo { + pos, + state: self.id(state), + nbt: None, + }; + let mut settings = PlaceSettings::new(Rotation::None); + process_list( + list, + &mut world, + &self.resources, + piece, + piece, + [0; 3], + info, + &mut settings, ) + .unwrap() + } + fn name(&self, info: Option) -> String { + match info { + None => "none".into(), + Some(info) => { + let s = self.registry.state(info.state).unwrap(); + let props: Vec = s + .properties + .iter() + .map(|(k, v)| format!("{k}={v}")) + .collect(); + match props.is_empty() { + true => s.name.clone(), + false => format!("{}[{}]", s.name, props.join(",")), + } + } + } + } + /// `name(run(...))` for one template block in an air world of seed 0. + fn out(&self, list: &ProcessorList, state: &str) -> String { + self.name(self.run(list, (0, "minecraft:air"), [0; 3], [0; 3], state)) + } + } + + fn swap(blocks: Value) -> Value { + json!({"processor_type": "lithostitched:block_swap", "blocks": blocks}) + } + fn set_block(provider: Value) -> Value { + json!({"processor_type": "lithostitched:set_block", "state_provider": provider}) + } + fn simple(name: &str) -> Value { + json!({"type": "minecraft:simple_state_provider", "state": {"id": name}}) + } + + #[test] + fn block_swap_keeps_the_properties_the_new_block_can_have() { + let t = Lists::new(&[]); + let list = t + .decode(json!([swap(json!({ + "minecraft:wheat": "minecraft:carrots", + "oak_stairs": "minecraft:warped_stairs", + "minecraft:cobblestone": "natures_spirit:missing"}))])) + .unwrap(); + assert_eq!( + t.out(&list, "minecraft:wheat[age=7]"), + "minecraft:carrots[age=7]" + ); + assert_eq!( + t.out(&list, "minecraft:oak_stairs[facing=east,half=top]"), + "minecraft:warped_stairs[facing=east,half=top]" + ); + // A block the game lacks leaves the template's; others pass. + assert_eq!( + t.out(&list, "minecraft:cobblestone"), + "minecraft:cobblestone" + ); + assert_eq!( + t.out(&list, "minecraft:oak_log[axis=x]"), + "minecraft:oak_log[axis=x]" + ); + // Beetroots' age stops at 3: ripe wheat gives the default (spec-ctov §4). + let beet = t + .decode(json!([swap( + json!({"minecraft:wheat": "minecraft:beetroots"}) + )])) + .unwrap(); + assert_eq!( + t.out(&beet, "minecraft:wheat[age=7]"), + "minecraft:beetroots[age=0]" + ); + assert_eq!( + t.out(&beet, "minecraft:wheat[age=2]"), + "minecraft:beetroots[age=2]" ); } #[test] - fn per_piece_draws_once_per_piece() { - let p = json!({"processor_type": "lithostitched:apply_random"}); - let piece = Draws::decode(Some(&json!("per_piece")), &p).unwrap(); - let block = Draws::decode(None, &p).unwrap(); - let first = |d: Draws, pos| d.random(42, [0, 64, 0], pos).int(1 << 30); - assert_eq!(first(piece, [1, 64, 1]), first(piece, [9, 70, 3])); - assert_ne!(first(block, [1, 64, 1]), first(block, [9, 70, 3])); - // Another processor draws apart on the same block. - let other = - Draws::decode(None, &json!({"processor_type": "lithostitched:set_block"})).unwrap(); - assert_ne!(first(block, [1, 64, 1]), first(other, [1, 64, 1])); - assert!(Draws::decode(Some(&json!("per_structure")), &p).is_err()); + fn references_run_the_named_lists_in_turn() { + let t = Lists::new(&[ + ( + "t:logs", + json!({"processors": [swap(json!({"minecraft:oak_log": "minecraft:stripped_cherry_log"}))]}), + ), + ( + "t:stone", + json!([swap( + json!({"minecraft:stripped_cherry_log": "minecraft:cobblestone"}) + )]), + ), + ( + "t:discard", + json!([{"processor_type": "lithostitched:discard_input"}]), + ), + ]); + let reference = |lists: Value| json!([{"processor_type": "lithostitched:reference", "processor_lists": lists}]); + let one = t.decode(reference(json!("t:logs"))).unwrap(); + assert_eq!( + t.out(&one, "minecraft:oak_log[axis=x]"), + "minecraft:stripped_cherry_log[axis=x]" + ); + let both = t.decode(reference(json!(["t:logs", "t:stone"]))).unwrap(); + assert_eq!(t.out(&both, "minecraft:oak_log"), "minecraft:cobblestone"); + let reversed = t.decode(reference(json!(["t:stone", "t:logs"]))).unwrap(); + assert_eq!( + t.out(&reversed, "minecraft:oak_log"), + "minecraft:stripped_cherry_log[axis=y]" + ); + // discard_input: the template block is not placed, and the lists after it do not run. + let discard = t.decode(reference(json!(["t:discard", "t:logs"]))).unwrap(); + assert_eq!(t.out(&discard, "minecraft:oak_log"), "none"); + // The game has no processor list tags; unknown lists are errors. + assert!(t.decode(reference(json!(["#t:palettes"]))).is_err()); + assert!(t.decode(reference(json!("t:missing"))).is_err()); + } + + /// The probe pack's nested condition (spec-lithostitched §7.3): template + /// cobblestone becomes blackstone or deepslate, half each. + #[test] + fn conditions_run_then_or_else() { + let t = Lists::new(&[]); + let inner = json!({"processor_type": "lithostitched:condition", "random_mode": "per_block", + "if_true": {"type": "lithostitched:random_chance", "chance": 0.5}, + "then": set_block(simple("minecraft:blackstone")), + "else": [set_block(simple("minecraft:deepslate"))]}); + let list = t + .decode(json!([{"processor_type": "lithostitched:condition", + "if_true": [{"type": "lithostitched:matching_blocks", "blocks": "minecraft:cobblestone"}], + "then": [inner]}])) + .unwrap(); + let mut counts = BTreeMap::::new(); + for i in 0..4000 { + let out = t.run( + &list, + (1234, "minecraft:air"), + [0; 3], + [i % 64, i / 64, 7], + "minecraft:cobblestone", + ); + *counts.entry(t.name(out)).or_default() += 1; + } + assert_eq!(counts.len(), 2, "{counts:?}"); + assert!( + (1850..2150).contains(&counts["minecraft:blackstone"]), + "{counts:?}" + ); + // Not cobblestone, and no `else`: the block as it is. + assert_eq!( + t.out(&list, "minecraft:oak_log"), + "minecraft:oak_log[axis=y]" + ); + + // `location` tests the world's block, with properties on the input. + let water = t + .decode( + json!([{"processor_type": "lithostitched:condition", "random_mode": "per_piece", + "if_true": {"type": "lithostitched:matching_blocks", "blocks": ["minecraft:water"], + "match_type": "location"}, + "then": set_block(simple("minecraft:spruce_planks"))}]), + ) + .unwrap(); + let at = |world| { + t.name(t.run( + &water, + (0, world), + [0; 3], + [1, 2, 3], + "minecraft:cobblestone", + )) + }; + assert_eq!(at("minecraft:water"), "minecraft:spruce_planks"); + assert_eq!(at("minecraft:air"), "minecraft:cobblestone"); + let ripe = t + .decode(json!([{"processor_type": "lithostitched:condition", + "if_true": {"type": "lithostitched:all_of", "conditions": [ + {"type": "lithostitched:true"}, + {"type": "lithostitched:matching_blocks", "blocks": "minecraft:wheat", "properties": {"age": "7"}}, + {"type": "lithostitched:not", "condition": {"type": "lithostitched:any_of", "conditions": [ + {"type": "lithostitched:random_chance", "chance": 0.0}, + {"type": "lithostitched:matching_blocks", "blocks": "minecraft:water", "match_type": "location"}]}}]}, + "then": swap(json!({"minecraft:wheat": "minecraft:carrots"}))}])) + .unwrap(); + assert_eq!( + t.out(&ripe, "minecraft:wheat[age=7]"), + "minecraft:carrots[age=7]" + ); + assert_eq!( + t.out(&ripe, "minecraft:wheat[age=6]"), + "minecraft:wheat[age=6]" + ); + let bad = json!([{"processor_type": "lithostitched:condition", "random_mode": "per_chunk", + "if_true": {"type": "lithostitched:true"}}]); + assert!(t.decode(bad).is_err()); + } + + /// `apply_random` (spec-lithostitched §7.3: crimson 1 : birch 3, one + /// choice per piece): here blackstone 1 : deepslate 3. + #[test] + fn apply_random_draws_per_piece_or_per_block() { + let t = Lists::new(&[( + "t:deepslate", + json!([swap( + json!({"minecraft:cobblestone": "minecraft:deepslate"}) + )]), + )]); + let random = |mode: &str| { + t.decode(json!([{"processor_type": "lithostitched:apply_random", "mode": mode, + "processor_lists": [ + {"weight": 1, "data": [swap(json!({"minecraft:cobblestone": "minecraft:blackstone"}))]}, + {"weight": 3, "data": "t:deepslate"}]}])) + .unwrap() + }; + let (per_piece, per_block) = (random("per_piece"), random("per_block")); + let outcomes = |list: &ProcessorList, seed: i64, piece: [i32; 3]| -> Vec { + (0..20) + .map(|i| { + let pos = [piece[0] + i, piece[1], piece[2] + 3 * i]; + t.name(t.run( + list, + (seed, "minecraft:air"), + piece, + pos, + "minecraft:cobblestone", + )) + }) + .collect() + }; + let mut blackstone_pieces = 0; + for p in 0..400 { + let piece = [16 * p, 70, -40 * p]; + let blocks = outcomes(&per_piece, 1234, piece); + assert!(blocks.iter().all(|b| *b == blocks[0]), "{blocks:?}"); + blackstone_pieces += u32::from(blocks[0] == "minecraft:blackstone"); + // The same piece and seed give the same blocks. + assert_eq!(outcomes(&per_piece, 1234, piece), blocks); + } + assert!( + (70..130).contains(&blackstone_pieces), + "{blackstone_pieces}" + ); + // Per block, one piece mixes both. + let mixed: BTreeSet = (0..10) + .flat_map(|p| outcomes(&per_block, 1234, [p, 0, 0])) + .collect(); + assert_eq!(mixed.len(), 2, "{mixed:?}"); + // A plain list: every entry weight 1. An entry list holding nothing is a no-op. + let plain = t + .decode( + json!([{"processor_type": "lithostitched:apply_random", "mode": "per_block", + "processor_lists": ["t:deepslate", []]}]), + ) + .unwrap(); + let seen: BTreeSet = (0..10) + .flat_map(|p| outcomes(&plain, 9, [p, 0, 0])) + .collect(); + assert_eq!( + seen, + BTreeSet::from(["minecraft:cobblestone".into(), "minecraft:deepslate".into()]) + ); } #[test] - fn set_block_draws_by_weight() { - let set = SetBlock::decode( - &json!({"processor_type": "lithostitched:set_block", "preserve_state": false, - "state_provider": {"type": "minecraft:weighted_state_provider", "entries": [ - {"weight": 1, "data": {"id": "minecraft:cobblestone"}}, - {"weight": 3, "data": {"id": "minecraft:water"}}]}}), - |v| { - Ok(BlockStateId(if v["id"] == "minecraft:water" { - 22 - } else { - 1 - })) - }, - ) - .unwrap(); - assert!(!set.preserve); - let water = (0..4000) - .filter(|x| { - set.state(&mut set.draws.random(7, [0; 3], [*x, 64, 0])) == BlockStateId(22) + fn set_block_runs_its_provider() { + let t = Lists::new(&[]); + let stairs = "minecraft:oak_stairs[facing=east,half=top]"; + let warped = |preserve: Value| { + let mut p = set_block(simple("minecraft:warped_stairs")); + if !preserve.is_null() { + p["preserve_state"] = preserve; + } + t.decode(json!([p])).unwrap() + }; + // preserve_state (true by default) keeps the properties both blocks have. + assert_eq!( + t.out(&warped(Value::Null), stairs), + "minecraft:warped_stairs[facing=east,half=top]" + ); + assert_eq!( + t.out(&warped(json!(false)), stairs), + "minecraft:warped_stairs[facing=north,half=bottom]" + ); + + let weighted = t + .decode(json!([set_block( + json!({"type": "minecraft:weighted_state_provider", "entries": [ + {"weight": 1, "data": {"id": "minecraft:blackstone"}}, + {"weight": 3, "data": {"id": "minecraft:deepslate"}}]}) + )])) + .unwrap(); + let blackstone = (0..2000) + .filter(|i| { + let out = t.run( + &weighted, + (42, "minecraft:air"), + [0; 3], + [*i, 0, -*i], + "minecraft:cobblestone", + ); + t.name(out) == "minecraft:blackstone" }) .count(); - assert!((2850..3150).contains(&water), "{water}"); - let unknown = json!({"state_provider": {"type": "minecraft:noise_provider"}}); - assert!(SetBlock::decode(&unknown, |_| Ok(BlockStateId(0))).is_err()); + assert!((420..580).contains(&blackstone), "{blackstone}"); + + // block_entity_modifier gives the output its block entity. + let mut loot = set_block(simple("minecraft:chest")); + loot["block_entity_modifier"] = + json!({"type": "minecraft:append_loot", "loot_table": "t:chests/house"}); + let out = t + .run( + &t.decode(json!([loot])).unwrap(), + (0, "minecraft:air"), + [0; 3], + [0; 3], + "minecraft:air", + ) + .unwrap(); + let table = out + .nbt + .as_ref() + .and_then(|n| n.get(&JavaString::from("LootTable"))); + assert_eq!(table, Some(&Tag::String("t:chests/house".into()))); + + // Providers the game does not run are refused. + assert!( + t.decode(json!([set_block( + json!({"type": "minecraft:noise_provider"}) + )])) + .is_err() + ); } } From c9f554d1c4842ce6b408f5db95479879df545cd5 Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Sun, 25 Oct 2026 15:51:15 +0100 Subject: [PATCH 04/28] Mod API 0.3 (experimental): server mods' contract, runtime and SDK A server mod runs where the world is simulated. Its manifest says side = "server" and api = "0.3" (only a server mod may), and its component targets the new WIT world horizon-server-mod: - imports log and storage as client mods do, and the new capability players: online() (id, name, position, dimension, game mode, health), tell(id, text), broadcast(text), 8 lines per call shared with chat; - exports server-events: init, tick, player-joined, player-left, chat, command (with the player who typed it; its feedback goes back to that player), block-broken and block-placed (with the block state as text). horizon-mods: a second bindgen world sharing log and storage with the first; a running mod holds either kind of hooks; Mods::load_for(Runs) starts only the mods a game runs (the window client mods, the world's server server mods, in-frame single player both) and marks the others Elsewhere. Client and server commands are owned separately. The game passes Runs::Client for now, so nothing changes in game until its server code calls these hooks. The SDK gains horizon_mod_sdk::server (ServerMod, Registration, export_server_mod!), the example server mod welcome (greets, announces newcomers kept in storage, /online, /mined), and cargo horizon-mod check's trial run plays a server mod with a player joining, chatting, typing its commands and leaving. The manifest refuses client capabilities on a server mod and players on a client mod. The generated reference, the guide, the portal and the stability table describe it. Co-Authored-By: Claude Opus 5.5 --- Cargo.lock | 7 + Cargo.toml | 2 +- crates/cargo-horizon-mod/src/check.rs | 73 ++-- crates/horizon-client/src/game/mods.rs | 12 +- .../examples/welcome/Cargo.toml | 16 + .../examples/welcome/horizon-mod.toml | 8 + .../examples/welcome/src/lib.rs | 84 ++++ crates/horizon-mod-sdk/src/lib.rs | 152 +++++++- crates/horizon-mod-sdk/wit/horizon.wit | 88 +++++ crates/horizon-mods/src/manifest.rs | 57 ++- crates/horizon-mods/src/runtime.rs | 363 +++++++++++++++--- crates/horizon-mods/src/testing.rs | 1 + crates/horizon-mods/tests/sandbox.rs | 85 +++- docs/api/mods-reference.md | 85 +++- docs/api/mods.md | 27 +- docs/api/stability.md | 2 +- docs/mods.md | 34 +- 17 files changed, 984 insertions(+), 112 deletions(-) create mode 100644 crates/horizon-mod-sdk/examples/welcome/Cargo.toml create mode 100644 crates/horizon-mod-sdk/examples/welcome/horizon-mod.toml create mode 100644 crates/horizon-mod-sdk/examples/welcome/src/lib.rs diff --git a/Cargo.lock b/Cargo.lock index 2d09d2d0e..0b8adf3ea 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -4197,6 +4197,13 @@ dependencies = [ "rustls-pki-types", ] +[[package]] +name = "welcome" +version = "0.1.0" +dependencies = [ + "horizon-mod-sdk", +] + [[package]] name = "wgpu" version = "30.0.1" diff --git a/Cargo.toml b/Cargo.toml index c6f2bc581..44ed89122 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [workspace] exclude = ["launcher", "crates/horizon-telemetry-server", "crates/horizon-mod-registry", "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-shaders", "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", "crates/horizon-mod-sdk/examples/welcome", "xtask"] resolver = "2" [workspace.package] diff --git a/crates/cargo-horizon-mod/src/check.rs b/crates/cargo-horizon-mod/src/check.rs index 0294bec98..86ce9654d 100644 --- a/crates/cargo-horizon-mod/src/check.rs +++ b/crates/cargo-horizon-mod/src/check.rs @@ -1,10 +1,11 @@ //! `cargo horizon-mod check `: what the registry checks of a submission, //! run anywhere: its kind's own checks (docs/api/mod-index.md), its signature //! when given a key, and for a mod a trial run in the sandbox: it must start, -//! survive ticks, frames, a chat line and each of its commands, and import -//! no more than its capabilities. +//! survive ticks, frames, a chat line and each of its commands (a server mod: +//! a player joining, chatting, typing them and leaving), and import no more +//! than its capabilities. use horizon_mods::{ - Clock, Mods, Output, Package, Player, Snapshot, Status, + Clock, GameMode, Mods, Output, Package, Player, ServerPlayer, Snapshot, Status, index::{self, Facts, Kind}, manifest::component_imports, }; @@ -181,37 +182,63 @@ fn play(path: &Path, report: &mut Report) -> Result<(), String> { if let Some(reason) = failed(&mods) { return Err(format!("it didn't start: {reason}")); } - report.commands = mods.commands().map(str::to_owned).collect(); + let client: Vec = mods.commands().map(str::to_owned).collect(); + let server: Vec = mods.server_commands().map(str::to_owned).collect(); + report.commands = [client.clone(), server.clone()].concat(); + // A server mod plays with one player on, who joins, chats and leaves. + let steve = ServerPlayer { + id: "00000000-0000-4000-8000-000000000001".into(), + name: "Steve".into(), + x: 0.5, + y: 64.0, + z: 0.5, + dimension: "minecraft:overworld".into(), + game_mode: GameMode::Survival, + health: 20.0, + }; + let snapshot = |t: u64| Snapshot { + player: Some(Player { + x: 0.5 + t as f64 * 0.1, + y: 64.0, + z: 0.5, + yaw: 90.0, + pitch: 0.0, + health: 20.0, + food: 20, + dimension: "minecraft:overworld".into(), + }), + clock: Some(Clock { + game_time: t, + day_time: 1000 + t, + }), + players: vec![steve.clone()], + }; + mods.set_snapshot(snapshot(0)); + mods.player_joined(&steve); for t in 0..TICKS { - mods.set_snapshot(Snapshot { - player: Some(Player { - x: 0.5 + t as f64 * 0.1, - y: 64.0, - z: 0.5, - yaw: 90.0, - pitch: 0.0, - health: 20.0, - food: 20, - dimension: "minecraft:overworld".into(), - }), - clock: Some(Clock { - game_time: t, - day_time: 1000 + t, - }), - }); + mods.set_snapshot(snapshot(t)); mods.tick(t); + mods.server_tick(t); for _ in 0..FRAMES_PER_TICK { mods.frame(1.0 / 60.0); } } mods.chat(" hello"); - for name in report.commands.clone() { - mods.command(&name); + mods.player_chat(&steve, "hello"); + for name in &client { + mods.command(name); } + for name in &server { + mods.server_command(&steve, name); + } + mods.set_snapshot(Snapshot::default()); + mods.player_left(&steve); for out in mods.drain() { report.output.push(match out { Output::Chat { text, .. } => format!("chat: {text}"), - Output::Feedback { text, error } => { + Output::Tell { text, .. } => format!("tell: {text}"), + Output::Broadcast { text, .. } => format!("broadcast: {text}"), + Output::Feedback { text, error } | Output::Reply { text, error, .. } => { format!("{}: {text}", if error { "error" } else { "feedback" }) } Output::Stopped { reason, .. } => return Err(format!("it stopped: {reason}")), diff --git a/crates/horizon-client/src/game/mods.rs b/crates/horizon-client/src/game/mods.rs index 572f9fe2b..5cd7bc368 100644 --- a/crates/horizon-client/src/game/mods.rs +++ b/crates/horizon-client/src/game/mods.rs @@ -23,7 +23,7 @@ use { mod_list::Installed, text::{self, Text}, }, - horizon_mods::{Clock, Mods, Output, Player, Snapshot, Status}, + horizon_mods::{Clock, Mods, Output, Player, Runs, Snapshot, Status}, std::time::Instant, }; @@ -185,7 +185,7 @@ impl Game<'_> { .collect(); let enabled = &self.settings.mods.enabled; let on = |id: &str| enabled.contains(id) || dev_ids.iter().any(|d| d == id); - let mods = Mods::load(&paths, on, vanilla_command); + let mods = Mods::load_for(Runs::Client, &paths, on, vanilla_command); self.mods.mods = mods; self.list_mods(); self.sync_mod_commands(); @@ -279,7 +279,11 @@ impl Game<'_> { game_time: self.world.game_time.max(0) as u64, day_time: self.world.day_time.max(0) as u64, }); - Snapshot { player, clock } + Snapshot { + player, + clock, + players: Vec::new(), + } } /// A game tick. pub(super) fn tick_mods(&mut self) { @@ -347,6 +351,8 @@ impl Game<'_> { self.sync_mod_commands(); Text::literal(format!("Mod {name} stopped: {reason}")).with_color(text::RED) } + // Server mods' lines: this game runs no server mod yet. + Output::Tell { .. } | Output::Broadcast { .. } | Output::Reply { .. } => continue, }; // Not through system_message: a mod must not hear its own lines. let focused = self.screen == Screen::Chat; diff --git a/crates/horizon-mod-sdk/examples/welcome/Cargo.toml b/crates/horizon-mod-sdk/examples/welcome/Cargo.toml new file mode 100644 index 000000000..50ab1a10a --- /dev/null +++ b/crates/horizon-mod-sdk/examples/welcome/Cargo.toml @@ -0,0 +1,16 @@ +[package] +name = "welcome" +version = "0.1.0" +edition.workspace = true +license.workspace = true +publish = false +description = "Example Horizon server mod: greets players, announces newcomers, /online and /mined" + +[lib] +crate-type = ["cdylib"] + +[dependencies] +horizon-mod-sdk = { path = "../.." } + +[lints] +workspace = true diff --git a/crates/horizon-mod-sdk/examples/welcome/horizon-mod.toml b/crates/horizon-mod-sdk/examples/welcome/horizon-mod.toml new file mode 100644 index 000000000..f8e73c482 --- /dev/null +++ b/crates/horizon-mod-sdk/examples/welcome/horizon-mod.toml @@ -0,0 +1,8 @@ +id = "welcome" +name = "Welcome" +version = "0.1.0" +description = "Greets each player who joins, announces a newcomer to everyone, /online lists who is on, /mined counts the blocks you broke." +authors = ["Horizon"] +api = "0.3" +side = "server" +capabilities = ["players", "storage"] diff --git a/crates/horizon-mod-sdk/examples/welcome/src/lib.rs b/crates/horizon-mod-sdk/examples/welcome/src/lib.rs new file mode 100644 index 000000000..c45712c88 --- /dev/null +++ b/crates/horizon-mod-sdk/examples/welcome/src/lib.rs @@ -0,0 +1,84 @@ +//! Example Horizon server mod (`docs/mods.md`, "Server mods"): greets each +//! player who joins, announces a newcomer to everyone (the players it has +//! seen are kept in `storage`), `/online` lists who is on and where, and +//! `/mined` counts the blocks the player broke since the server started. +use horizon_mod_sdk::{ + server::{BlockPos, Player, Registration, ServerMod, players}, + storage, +}; +use std::collections::HashMap; + +struct Welcome { + /// Ids of every player seen, one per line in storage key `seen`. + seen: Vec, + mined: HashMap, +} + +impl ServerMod for Welcome { + fn init() -> Result<(Self, Registration), String> { + let seen = storage::get("seen") + .map(|b| { + String::from_utf8_lossy(&b) + .lines() + .map(str::to_owned) + .collect() + }) + .unwrap_or_default(); + let hooks = Registration::new() + .command("online") + .command("mined") + .on_joins() + .on_blocks(); + Ok(( + Welcome { + seen, + mined: HashMap::new(), + }, + hooks, + )) + } + + fn player_joined(&mut self, player: &Player) { + let others = players::online().len() - 1; + players::tell( + &player.id, + &format!("Welcome, {}! {others} other player(s) online.", player.name), + ); + if !self.seen.contains(&player.id) { + self.seen.push(player.id.clone()); + let _ = storage::set("seen", self.seen.join("\n").as_bytes()); + players::broadcast(&format!("{} is here for the first time", player.name)); + } + } + + fn command( + &mut self, + player: &Player, + name: &str, + _args: &str, + ) -> Result, String> { + Ok(Some(match name { + "online" => players::online() + .iter() + .map(|p| { + format!( + "{} ({})", + p.name, + p.dimension.trim_start_matches("minecraft:") + ) + }) + .collect::>() + .join(", "), + _ => { + let n = self.mined.get(&player.id).copied().unwrap_or(0); + format!("You broke {n} block(s)") + } + })) + } + + fn block_broken(&mut self, player: &Player, _pos: BlockPos, _state: &str) { + *self.mined.entry(player.id.clone()).or_default() += 1; + } +} + +horizon_mod_sdk::export_server_mod!(Welcome); diff --git a/crates/horizon-mod-sdk/src/lib.rs b/crates/horizon-mod-sdk/src/lib.rs index 71c36cf80..1cffcc183 100644 --- a/crates/horizon-mod-sdk/src/lib.rs +++ b/crates/horizon-mod-sdk/src/lib.rs @@ -21,7 +21,8 @@ //! ``` //! //! Every interface but `log` is a capability: list the ones the mod uses in -//! `horizon-mod.toml` (`game-read`, `chat`, `hud`, `storage`). +//! `horizon-mod.toml` (`game-read`, `chat`, `hud`, `storage`; a server mod +//! `storage` and `players`). Server mods: [`server`]. wit_bindgen::generate!({ path: "wit", @@ -145,3 +146,152 @@ macro_rules! export_mod { }; }; } + +/// Server mods (manifest `side = "server"`, `api = "0.3"`, experimental): a +/// type implementing [`ServerMod`](server::ServerMod), exported with +/// [`export_server_mod!`]. It runs where the world is simulated, and reads +/// and messages the players with capability `players`. +pub mod server { + wit_bindgen::generate!({ + path: "wit", + world: "horizon-server-mod", + pub_export_macro: true, + export_macro_name: "__export_horizon_server_mod", + default_bindings_module: "horizon_mod_sdk::server", + with: { + "horizon:mods/log@0.1.0": crate::log, + "horizon:mods/storage@0.1.0": crate::storage, + }, + }); + + pub use exports::horizon::mods::server_events::{BlockPos, Guest as __Guest, Registration}; + pub use horizon::mods::players::{self, GameMode, Player}; + + /// The server's calls into a mod. Only the hooks [`Registration`] asks + /// for are called; the others may stay as their defaults. + pub trait ServerMod: Sized + 'static { + /// Once, after loading: the mod's state and the hooks it wants. An + /// error keeps the mod off and is logged. + fn init() -> Result<(Self, Registration), String>; + /// Every server tick, when [`Registration::tick`] is set. + fn tick(&mut self, _tick: u64) {} + /// When [`Registration::joins`] is set. + fn player_joined(&mut self, _player: &Player) {} + fn player_left(&mut self, _player: &Player) {} + /// A chat message a player sent, when [`Registration::chat`] is set. + fn chat(&mut self, _player: &Player, _text: &str) {} + /// `/name args` typed by `player`. `Ok(Some(text))` is their + /// feedback, `Err(text)` their error in red. + fn command( + &mut self, + _player: &Player, + _name: &str, + _args: &str, + ) -> Result, String> { + Err("This command does nothing".into()) + } + /// When [`Registration::blocks`] is set: `state` is what was there. + fn block_broken(&mut self, _player: &Player, _pos: BlockPos, _state: &str) {} + fn block_placed(&mut self, _player: &Player, _pos: BlockPos, _state: &str) {} + } + + impl Registration { + /// No commands and no hooks. + pub fn new() -> Self { + Self { + commands: Vec::new(), + tick: false, + joins: false, + chat: false, + blocks: false, + } + } + /// Adds `/name`. + pub fn command(mut self, name: &str) -> Self { + self.commands.push(name.into()); + self + } + pub fn on_tick(mut self) -> Self { + self.tick = true; + self + } + pub fn on_joins(mut self) -> Self { + self.joins = true; + self + } + pub fn on_chat(mut self) -> Self { + self.chat = true; + self + } + pub fn on_blocks(mut self) -> Self { + self.blocks = true; + self + } + } + impl Default for Registration { + fn default() -> Self { + Self::new() + } + } +} + +/// Exports a [`ServerMod`](server::ServerMod) as the component's +/// `server-events` interface, as [`export_mod!`] does for a client mod. +#[macro_export] +macro_rules! export_server_mod { + ($t:ty) => { + const _: () = { + use ::std::cell::RefCell; + use $crate::server::{BlockPos, Player, Registration, ServerMod}; + ::std::thread_local! { + static STATE: RefCell> = const { RefCell::new(None) }; + } + fn with(f: impl FnOnce(&mut $t)) { + STATE.with(|s| { + if let Some(m) = s.borrow_mut().as_mut() { + f(m) + } + }) + } + struct Export; + impl $crate::server::__Guest for Export { + fn init() -> Result { + let (m, registration) = <$t as ServerMod>::init()?; + STATE.with(|s| *s.borrow_mut() = Some(m)); + Ok(registration) + } + fn tick(tick: u64) { + with(|m| m.tick(tick)) + } + fn player_joined(player: Player) { + with(|m| m.player_joined(&player)) + } + fn player_left(player: Player) { + with(|m| m.player_left(&player)) + } + fn chat(player: Player, text: String) { + with(|m| m.chat(&player, &text)) + } + fn command( + player: Player, + name: String, + args: String, + ) -> Result, String> { + let mut out = Err("The mod is not running".to_string()); + with(|m| out = m.command(&player, &name, &args)); + out + } + fn block_broken(player: Player, pos: BlockPos, state: String) { + with(|m| m.block_broken(&player, pos, &state)) + } + fn block_placed(player: Player, pos: BlockPos, state: String) { + with(|m| m.block_placed(&player, pos, &state)) + } + } + #[cfg(target_arch = "wasm32")] + $crate::server::__export_horizon_server_mod!(Export); + #[cfg(not(target_arch = "wasm32"))] + let _ = ::init; + }; + }; +} diff --git a/crates/horizon-mod-sdk/wit/horizon.wit b/crates/horizon-mod-sdk/wit/horizon.wit index 9f00a12b1..3a9027bba 100644 --- a/crates/horizon-mod-sdk/wit/horizon.wit +++ b/crates/horizon-mod-sdk/wit/horizon.wit @@ -111,6 +111,84 @@ interface events { chat: func(text: string); } +/// Capability `players`, server mods only (manifest `api = "0.3"`, +/// experimental): the players on the server, and messages to them. +interface players { + enum game-mode { + survival, + creative, + adventure, + spectator, + } + record player { + /// The player's UUID, `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`. + id: string, + name: string, + /// Feet position, in blocks. + x: f64, + y: f64, + z: f64, + /// `minecraft:overworld`, `minecraft:the_nether`, ... + dimension: string, + game-mode: game-mode, + /// Hit points as vanilla counts them: 20 is full health without effects. + health: f32, + } + /// The players online, in the order they joined. + online: func() -> list; + /// A system message to one player, after the mod's name; false when no + /// player with that id is online. Up to 8 messages per call. + tell: func(player: string, text: string) -> bool; + /// A system message to every player and the server's log, after the + /// mod's name. Counts toward the same 8 per call. + broadcast: func(text: string); +} + +/// What the server calls in a server mod (manifest `api = "0.3"`, +/// experimental). Only the hooks `init` asks for are ever called. The player +/// in each event is as the server saw them when it happened. +interface server-events { + use players.{player}; + + record registration { + /// Commands players may type, without the slash. A name vanilla + /// already uses is refused (vanilla's command runs). + commands: list, + /// Call `tick` every server tick (20 per second). + tick: bool, + /// Call `player-joined` and `player-left`. + joins: bool, + /// Call `chat` for each chat message a player sends. + chat: bool, + /// Call `block-broken` and `block-placed`. + blocks: bool, + } + record block-pos { + x: s32, + y: s32, + z: s32, + } + /// Once, after loading. An error keeps the mod off and is logged. + init: func() -> result; + /// Each server tick, with the server's tick counter. + tick: func(tick: u64); + /// A player joined the server; they are in `players.online` already. + player-joined: func(player: player); + /// A player left the server; they are no longer in `players.online`. + player-left: func(player: player); + /// A chat message a player sent, as plain text. + chat: func(player: player, text: string); + /// `/name args` typed by `player`: ok(some(text)) is their feedback, + /// err(text) their error in red. + command: func(player: player, name: string, args: string) -> result, string>; + /// A player broke the block at `pos` in their dimension: `state` is what + /// was there, as `minecraft:oak_log[axis=y]`. + block-broken: func(player: player, pos: block-pos, state: string); + /// A player placed `state` at `pos` in their dimension. + block-placed: func(player: player, pos: block-pos, state: string); +} + +/// A client mod: runs in the player's game. world horizon-mod { import log; import game; @@ -119,3 +197,13 @@ world horizon-mod { import storage; export events; } + +/// A server mod (manifest `side = "server"`, `api = "0.3"`, experimental): +/// runs where the world is simulated, on the dedicated server, a LAN host +/// and single player's own server. +world horizon-server-mod { + import log; + import storage; + import players; + export server-events; +} diff --git a/crates/horizon-mods/src/manifest.rs b/crates/horizon-mods/src/manifest.rs index 3a93b2512..1caf2038f 100644 --- a/crates/horizon-mods/src/manifest.rs +++ b/crates/horizon-mods/src/manifest.rs @@ -16,7 +16,10 @@ pub const API: &str = "0.1"; /// The manifest `api` lines this build loads. 0.2 is 0.1 plus content: /// `assets/` and `data/` in the `.hmod`, with blocks and items declared in /// `data//horizon/` (docs/modpacks.md). Code still links API 0.1. -pub const APIS: [&str; 2] = [API, "0.2"]; +/// 0.3 is a server mod (experimental): the `horizon-server-mod` world. +pub const APIS: [&str; 3] = [API, "0.2", SERVER_API]; +/// The line of server mods, experimental: `side = "server"`. +pub const SERVER_API: &str = "0.3"; /// Namespaces no mod may claim: vanilla's, the convention tags' (mods add /// to those, docs/mods.md) and the game's own. const RESERVED_NAMESPACES: [&str; 3] = ["minecraft", "c", "horizon"]; @@ -57,7 +60,7 @@ pub enum Side { /// Runs in the player's game only (HUD, keys, chat commands). #[default] Client, - /// Runs where the world is simulated (rules, blocks); not run yet. + /// Runs where the world is simulated (rules, blocks): `api = "0.3"`. Server, /// Both, and the server tells clients which version it expects. Both, @@ -75,15 +78,22 @@ pub enum Capability { /// New blocks and items from the mod's `data/` (API 0.2): no WIT /// interface, the game reads them before the world loads. Registries, + /// The players on the server and messages to them (server mods). + Players, } impl Capability { - pub const ALL: [Capability; 5] = [ + pub const ALL: [Capability; 6] = [ Capability::GameRead, Capability::Chat, Capability::Hud, Capability::Storage, Capability::Registries, + Capability::Players, ]; + /// Whether a server mod may have it: the others act on a local player. + pub fn on_server(self) -> bool { + matches!(self, Capability::Storage | Capability::Players) + } /// The WIT interface it grants, in `horizon:mods`. pub fn interface(self) -> &'static str { match self { @@ -92,6 +102,7 @@ impl Capability { Capability::Hud => "hud", Capability::Storage => "storage", Capability::Registries => "registries", + Capability::Players => "players", } } /// What the player reads before turning the mod on: "May ". @@ -102,6 +113,7 @@ impl Capability { Capability::Hud => "draw text on your screen", Capability::Storage => "save its own settings to disk", Capability::Registries => "add blocks and items to your worlds", + Capability::Players => "see who is on the server and message them", } } /// The capability a component import needs, `Ok(None)` for one every @@ -132,6 +144,7 @@ impl fmt::Display for Capability { Capability::Hud => "hud", Capability::Storage => "storage", Capability::Registries => "registries", + Capability::Players => "players", }; f.write_str(name) } @@ -162,6 +175,20 @@ impl Manifest { "{MANIFEST}: capability registries needs api = \"0.2\"" )); } + let server = m.side == Side::Server; + if server != (m.api == SERVER_API) { + return Err(format!( + "{MANIFEST}: a server mod is side = \"server\" with api = \"{SERVER_API}\", and only it" + )); + } + if let Some(c) = m + .capabilities + .iter() + .find(|c| c.on_server() != server && **c != Capability::Storage) + { + let side = if server { "client" } else { "server" }; + return Err(format!("{MANIFEST}: capability {c} is for {side} mods")); + } if !m.namespaces.is_empty() && !m.capabilities.contains(&Capability::Registries) { return Err(format!( "{MANIFEST}: namespaces are for content, which needs capability registries" @@ -378,12 +405,32 @@ capabilities = ["game-read", "hud"] fn refuses_bad_ids_and_apis() { let bad_id = EXAMPLE.replace("coords_hud", "Coords HUD"); assert!(Manifest::parse(&bad_id).unwrap_err().contains("is not")); - let bad_api = EXAMPLE.replace("api = \"0.1\"", "api = \"0.3\""); - assert!(Manifest::parse(&bad_api).unwrap_err().contains("API 0.3")); + let bad_api = EXAMPLE.replace("api = \"0.1\"", "api = \"0.4\""); + assert!(Manifest::parse(&bad_api).unwrap_err().contains("API 0.4")); let unknown = format!("{EXAMPLE}network = true\n"); assert!(Manifest::parse(&unknown).is_err()); } + #[test] + fn server_mods_are_api_0_3_with_server_capabilities() { + let server = |api: &str, side: &str, caps: &str| { + Manifest::parse(&format!( + "id = \"w\"\nname = \"W\"\nversion = \"1\"\napi = \"{api}\"\nside = \"{side}\"\ncapabilities = [{caps}]\n" + )) + }; + let m = server("0.3", "server", "\"players\", \"storage\"").unwrap(); + let imports = ["horizon:mods/players@0.1.0", "horizon:mods/storage@0.1.0"]; + assert_eq!(m.check_imports(imports), Ok(())); + for (api, side) in [("0.3", "client"), ("0.3", "both"), ("0.1", "server")] { + let e = server(api, side, "").unwrap_err(); + assert!(e.contains("a server mod is side"), "{e}"); + } + let e = server("0.3", "server", "\"hud\"").unwrap_err(); + assert!(e.contains("capability hud is for client mods"), "{e}"); + let e = server("0.1", "client", "\"players\"").unwrap_err(); + assert!(e.contains("capability players is for server mods"), "{e}"); + } + #[test] fn checks_extra_namespaces() { let content = "id = \"t_and_t\"\nname = \"T\"\nversion = \"1\"\napi = \"0.2\"\ncapabilities = [\"registries\"]\n"; diff --git a/crates/horizon-mods/src/runtime.rs b/crates/horizon-mods/src/runtime.rs index 52da641b4..e80dbdc9f 100644 --- a/crates/horizon-mods/src/runtime.rs +++ b/crates/horizon-mods/src/runtime.rs @@ -1,5 +1,9 @@ //! Loading and calling mods with wasmtime's component model. use crate::manifest::{Manifest, Package, Side}; +use server_bindings::{ + HorizonServerMod, exports::horizon::mods::server_events::Registration as ServerRegistration, + horizon::mods::players, +}; use std::{ path::{Path, PathBuf}, sync::Arc, @@ -16,6 +20,17 @@ mod bindings { world: "horizon-mod", }); } +/// The server mods' world: `log` and `storage` are the client world's. +mod server_bindings { + wasmtime::component::bindgen!({ + path: "../horizon-mod-sdk/wit", + world: "horizon-server-mod", + with: { + "horizon:mods/log": super::bindings::horizon::mods::log, + "horizon:mods/storage": super::bindings::horizon::mods::storage, + }, + }); +} pub use bindings::horizon::mods::{ game::{Clock, Player}, hud::{Corner, Line}, @@ -25,6 +40,12 @@ use bindings::{ exports::horizon::mods::events::Registration, horizon::mods::{chat, game, hud, log as mod_log, storage}, }; +pub use server_bindings::{ + exports::horizon::mods::server_events::BlockPos, + horizon::mods::players::{GameMode, Player as ServerPlayer}, +}; +type ClientEvents = bindings::exports::horizon::mods::events::Guest; +type ServerEvents = server_bindings::exports::horizon::mods::server_events::Guest; /// A mod's linear memory cap. const MEMORY: usize = 64 << 20; @@ -55,6 +76,26 @@ const STORAGE_WRITE_BUDGET: u64 = 1 << 20; pub struct Snapshot { pub player: Option, pub clock: Option, + /// The players on the server, for server mods. + pub players: Vec, +} + +/// Which mods a game starts: the window's game the client mods, the game +/// simulating the world the server mods, single player in the frame both. +#[derive(Clone, Copy, Debug, PartialEq)] +pub enum Runs { + Client, + Server, + Both, +} +impl Runs { + fn starts(self, side: Side) -> bool { + match self { + Runs::Both => true, + Runs::Client => side != Side::Server, + Runs::Server => side == Side::Server, + } + } } /// What mods asked the game to show since the last [`Mods::drain`]. @@ -66,6 +107,20 @@ pub enum Output { Feedback { text: String, error: bool }, /// The mod was turned off: it trapped, overran or failed to start. Stopped { name: String, reason: String }, + /// `players.tell`: a line after the mod's name, to the player with this id. + Tell { + name: String, + player: String, + text: String, + }, + /// `players.broadcast`: a line after the mod's name, to every player. + Broadcast { name: String, text: String }, + /// A server mod command's feedback, to the player who typed it. + Reply { + player: String, + text: String, + error: bool, + }, } /// A mod's text panel, drawn every frame until it changes. @@ -80,6 +135,9 @@ pub enum Status { /// Installed and turned off by the player. Off, Running, + /// Turned on, and run by another game: a server mod in the window while + /// the world runs on its server thread. + Elsewhere, /// Could not load or start, or stopped while running. Failed(String), } @@ -98,8 +156,33 @@ pub struct Entry { struct Running { store: Store, - exports: HorizonMod, - hooks: Registration, + hooks: Hooks, +} + +/// A running mod's exports and the hooks its `init` asked for. +enum Hooks { + Client(HorizonMod, Registration), + Server(HorizonServerMod, ServerRegistration), +} +impl Hooks { + fn client(&self) -> Option<&Registration> { + match self { + Hooks::Client(_, r) => Some(r), + Hooks::Server(..) => None, + } + } + fn server(&self) -> Option<&ServerRegistration> { + match self { + Hooks::Server(_, r) => Some(r), + Hooks::Client(..) => None, + } + } + fn commands(&self) -> &[String] { + match self { + Hooks::Client(_, r) => &r.commands, + Hooks::Server(_, r) => &r.commands, + } + } } struct State { @@ -129,13 +212,23 @@ pub struct Mods { } impl Mods { - /// Reads every mod at `paths` and starts those `enabled` says are on. - /// A command that `reserved` (vanilla's commands) or an earlier mod - /// already uses is refused. + /// Reads every mod at `paths` and starts those `enabled` says are on, + /// client and server mods alike. A command that `reserved` (vanilla's + /// commands) or an earlier mod already uses is refused. pub fn load( paths: &[PathBuf], enabled: impl Fn(&str) -> bool, reserved: impl Fn(&str) -> bool, + ) -> Mods { + Mods::load_for(Runs::Both, paths, enabled, reserved) + } + /// [`Mods::load`], starting only the mods `runs` says this game runs; the + /// others that are on are [`Status::Elsewhere`]. + pub fn load_for( + runs: Runs, + paths: &[PathBuf], + enabled: impl Fn(&str) -> bool, + reserved: impl Fn(&str) -> bool, ) -> Mods { let mut mods = Mods::default(); for path in paths { @@ -153,7 +246,9 @@ impl Mods { Ok(package) => { let on = enabled(&package.manifest.id); entry.manifest = Some(package.manifest.clone()); - if on { + if on && !runs.starts(package.manifest.side) { + entry.status = Status::Elsewhere; + } else if on { // Content is read before the world loads; a mod whose // content is refused stays off, with the reason. let content = crate::Content::read(path, &package.manifest); @@ -184,6 +279,8 @@ impl Mods { let mut linker = Linker::new(&engine); HorizonMod::add_to_linker::>(&mut linker, |s| s) .map_err(|e| e.to_string())?; + players::add_to_linker::>(&mut linker, |s| s) + .map_err(|e| e.to_string())?; self.engine = Some((engine, linker)); } Ok(self.engine.as_ref().expect("made above")) @@ -203,9 +300,6 @@ impl Mods { let Some(wasm) = &package.wasm else { return Ok(None); }; - if m.side == Side::Server { - return Err("server mods do not run yet".into()); - } // Two running mods with the same id would share one `data_dir` // (capability `storage`): the first loaded keeps the id. if self @@ -215,11 +309,13 @@ impl Mods { { return Err(format!("another running mod already uses id {}", m.id)); } + let server = m.side == Side::Server; let taken: Vec = self .entries .iter() .filter_map(|e| e.run.as_ref()) - .flat_map(|r| r.hooks.commands.iter().cloned()) + .filter(|r| r.hooks.server().is_some() == server) + .flat_map(|r| r.hooks.commands().iter().cloned()) .collect(); let snapshot = self.snapshot.clone(); let (engine, linker) = self.engine()?; @@ -252,13 +348,28 @@ impl Mods { let mut store = Store::new(engine, state); store.limiter(|s| &mut s.limits); store.set_fuel(FUEL_INIT).map_err(|e| e.to_string())?; - let exports = - HorizonMod::instantiate(&mut store, &component, linker).map_err(|e| reason(&e))?; - let mut hooks = exports - .horizon_mods_events() - .call_init(&mut store) - .map_err(|e| reason(&e))??; - hooks.commands.retain(|c| { + let mut hooks = if server { + let exports = HorizonServerMod::instantiate(&mut store, &component, linker) + .map_err(|e| reason(&e))?; + let r = exports + .horizon_mods_server_events() + .call_init(&mut store) + .map_err(|e| reason(&e))??; + Hooks::Server(exports, r) + } else { + let exports = + HorizonMod::instantiate(&mut store, &component, linker).map_err(|e| reason(&e))?; + let r = exports + .horizon_mods_events() + .call_init(&mut store) + .map_err(|e| reason(&e))??; + Hooks::Client(exports, r) + }; + let commands = match &mut hooks { + Hooks::Client(_, r) => &mut r.commands, + Hooks::Server(_, r) => &mut r.commands, + }; + commands.retain(|c| { let free = !reserved(c) && !taken.contains(c); if !free { log::warn!("Horizon: mod {} cannot take /{c}: already a command", m.id); @@ -266,17 +377,19 @@ impl Mods { free }); self.out.append(&mut store.data_mut().out); - Ok(Some(Running { - store, - exports, - hooks, - })) + Ok(Some(Running { store, hooks })) } /// True when at least one mod runs: the game skips its mod work otherwise. pub fn is_running(&self) -> bool { self.entries.iter().any(|e| e.run.is_some()) } + /// True when a server mod runs: the server skips its mod work otherwise. + pub fn runs_server(&self) -> bool { + self.entries + .iter() + .any(|e| e.run.as_ref().is_some_and(|r| r.hooks.server().is_some())) + } pub fn entries(&self) -> &[Entry] { &self.entries } @@ -289,8 +402,8 @@ impl Mods { fn each( &mut self, fuel: u64, - wants: impl Fn(&Registration) -> bool, - mut f: impl FnMut(&HorizonMod, &mut Store) -> wasmtime::Result<()>, + wants: impl Fn(&Hooks) -> bool, + mut f: impl FnMut(&Hooks, &mut Store) -> wasmtime::Result<()>, ) { for i in 0..self.entries.len() { if self.entries[i] @@ -302,13 +415,45 @@ impl Mods { } } } + /// [`Mods::each`] over the client mods. + fn each_client( + &mut self, + fuel: u64, + wants: impl Fn(&Registration) -> bool, + mut f: impl FnMut(&ClientEvents, &mut Store) -> wasmtime::Result<()>, + ) { + self.each( + fuel, + |h| h.client().is_some_and(&wants), + |h, s| match h { + Hooks::Client(m, _) => f(m.horizon_mods_events(), s), + Hooks::Server(..) => Ok(()), + }, + ); + } + /// [`Mods::each`] over the server mods. + fn each_server( + &mut self, + fuel: u64, + wants: impl Fn(&ServerRegistration) -> bool, + mut f: impl FnMut(&ServerEvents, &mut Store) -> wasmtime::Result<()>, + ) { + self.each( + fuel, + |h| h.server().is_some_and(&wants), + |h, s| match h { + Hooks::Server(m, _) => f(m.horizon_mods_server_events(), s), + Hooks::Client(..) => Ok(()), + }, + ); + } /// One call into mod `i`; a trap or an overrun turns the mod off. fn call( &mut self, i: usize, fuel: u64, - f: impl FnOnce(&HorizonMod, &mut Store) -> wasmtime::Result, + f: impl FnOnce(&Hooks, &mut Store) -> wasmtime::Result, ) -> Option { let entry = &mut self.entries[i]; let run = entry.run.as_mut()?; @@ -318,7 +463,7 @@ impl Mods { let result = run .store .set_fuel(fuel) - .and_then(|()| f(&run.exports, &mut run.store)); + .and_then(|()| f(&run.hooks, &mut run.store)); // An average over about the last 64 calls. entry.cost = (entry.cost * 63 + started.elapsed()) / 64; self.out.append(&mut run.store.data_mut().out); @@ -341,48 +486,37 @@ impl Mods { /// A game tick. pub fn tick(&mut self, tick: u64) { - self.each( - FUEL_TICK, - |h| h.tick, - |m, s| m.horizon_mods_events().call_tick(s, tick), - ); + self.each_client(FUEL_TICK, |h| h.tick, |m, s| m.call_tick(s, tick)); } /// A rendered frame, `seconds` after the last. pub fn frame(&mut self, seconds: f32) { - self.each( - FUEL_FRAME, - |h| h.frame, - |m, s| m.horizon_mods_events().call_frame(s, seconds), - ); + self.each_client(FUEL_FRAME, |h| h.frame, |m, s| m.call_frame(s, seconds)); } /// A chat line the player received, as plain text. pub fn chat(&mut self, text: &str) { - self.each( - FUEL_EVENT, - |h| h.chat, - |m, s| m.horizon_mods_events().call_chat(s, text), - ); + self.each_client(FUEL_EVENT, |h| h.chat, |m, s| m.call_chat(s, text)); } - /// Whether a running mod owns `/name`. + /// Whether a running client mod owns `/name`. pub fn has_command(&self, name: &str) -> bool { - self.command_owner(name).is_some() + self.command_owner(false, name).is_some() } - fn command_owner(&self, name: &str) -> Option { + fn command_owner(&self, server: bool, name: &str) -> Option { self.entries.iter().position(|e| { - e.run - .as_ref() - .is_some_and(|r| r.hooks.commands.iter().any(|c| c == name)) + e.run.as_ref().is_some_and(|r| { + r.hooks.server().is_some() == server && r.hooks.commands().iter().any(|c| c == name) + }) }) } - /// Runs `line` (without its slash) if a mod owns its command; false - /// when none does. + /// Runs `line` (without its slash) if a client mod owns its command; + /// false when none does. pub fn command(&mut self, line: &str) -> bool { let (name, args) = line.split_once(' ').unwrap_or((line, "")); - let Some(i) = self.command_owner(name) else { + let Some(i) = self.command_owner(false, name) else { return false; }; - let result = self.call(i, FUEL_EVENT, |m, s| { - m.horizon_mods_events().call_command(s, name, args) + let result = self.call(i, FUEL_EVENT, |h, s| match h { + Hooks::Client(m, _) => m.horizon_mods_events().call_command(s, name, args), + Hooks::Server(..) => Ok(Ok(None)), }); match result { Some(Ok(Some(text))) => self.out.push(Output::Feedback { text, error: false }), @@ -391,14 +525,88 @@ impl Mods { } true } - /// The commands running mods own, for suggestions. + /// The commands running client mods own, for suggestions. pub fn commands(&self) -> impl Iterator { + self.owned_commands(false) + } + fn owned_commands(&self, server: bool) -> impl Iterator { self.entries .iter() .filter_map(|e| e.run.as_ref()) - .flat_map(|r| r.hooks.commands.iter().map(String::as_str)) + .filter(move |r| r.hooks.server().is_some() == server) + .flat_map(|r| r.hooks.commands().iter().map(String::as_str)) } + /// A server tick. + pub fn server_tick(&mut self, tick: u64) { + self.each_server(FUEL_TICK, |h| h.tick, |m, s| m.call_tick(s, tick)); + } + /// `player` joined the server (they are in the snapshot's players). + pub fn player_joined(&mut self, player: &ServerPlayer) { + self.each_server( + FUEL_EVENT, + |h| h.joins, + |m, s| m.call_player_joined(s, player), + ); + } + /// `player` left the server (they are no longer in the snapshot's players). + pub fn player_left(&mut self, player: &ServerPlayer) { + self.each_server( + FUEL_EVENT, + |h| h.joins, + |m, s| m.call_player_left(s, player), + ); + } + /// A chat message `player` sent, as plain text. + pub fn player_chat(&mut self, player: &ServerPlayer, text: &str) { + self.each_server(FUEL_EVENT, |h| h.chat, |m, s| m.call_chat(s, player, text)); + } + /// `player` broke `state` at `pos`. + pub fn block_broken(&mut self, player: &ServerPlayer, pos: BlockPos, state: &str) { + self.each_server( + FUEL_EVENT, + |h| h.blocks, + |m, s| m.call_block_broken(s, player, pos, state), + ); + } + /// `player` placed `state` at `pos`. + pub fn block_placed(&mut self, player: &ServerPlayer, pos: BlockPos, state: &str) { + self.each_server( + FUEL_EVENT, + |h| h.blocks, + |m, s| m.call_block_placed(s, player, pos, state), + ); + } + /// The commands running server mods own, for the server's command tree. + pub fn server_commands(&self) -> impl Iterator { + self.owned_commands(true) + } + /// Runs `line` (without its slash), typed by `player`, if a server mod + /// owns its command; its feedback is an [`Output::Reply`]. False when + /// none does. + pub fn server_command(&mut self, player: &ServerPlayer, line: &str) -> bool { + let (name, args) = line.split_once(' ').unwrap_or((line, "")); + let Some(i) = self.command_owner(true, name) else { + return false; + }; + let result = self.call(i, FUEL_EVENT, |h, s| match h { + Hooks::Server(m, _) => m + .horizon_mods_server_events() + .call_command(s, player, name, args), + Hooks::Client(..) => Ok(Ok(None)), + }); + let reply = |text, error| Output::Reply { + player: player.id.clone(), + text, + error, + }; + match result { + Some(Ok(Some(text))) => self.out.push(reply(text, false)), + Some(Err(text)) => self.out.push(reply(text, true)), + Some(Ok(None)) | None => {} + } + true + } /// The running mods' HUD panels. pub fn panels(&self) -> impl Iterator { self.entries @@ -417,7 +625,7 @@ impl Mods { for i in 0..self.entries.len() { let entry = &self.entries[i]; let now = modified(&entry.path); - let was_on = entry.status != Status::Off; + let was_on = !matches!(entry.status, Status::Off | Status::Elsewhere); if now == entry.modified || !was_on { continue; } @@ -495,20 +703,51 @@ impl game::Host for State { self.snapshot.clock } } -impl chat::Host for State { - fn show(&mut self, text: String) { +impl State { + /// Queues a chat line unless the call already sent [`CHAT_PER_CALL`]. + fn say(&mut self, line: impl FnOnce(String) -> Output) -> bool { let shown = self .out .iter() - .filter(|o| matches!(o, Output::Chat { .. })) + .filter(|o| { + matches!( + o, + Output::Chat { .. } | Output::Tell { .. } | Output::Broadcast { .. } + ) + }) .count(); if shown < CHAT_PER_CALL { let name = self.name.clone(); - self.out.push(Output::Chat { - name, - text: clip(text), - }); + self.out.push(line(name)); } + shown < CHAT_PER_CALL + } +} +impl chat::Host for State { + fn show(&mut self, text: String) { + self.say(|name| Output::Chat { + name, + text: clip(text), + }); + } +} +impl players::Host for State { + fn online(&mut self) -> Vec { + self.snapshot.players.clone() + } + fn tell(&mut self, player: String, text: String) -> bool { + self.snapshot.players.iter().any(|p| p.id == player) + && self.say(|name| Output::Tell { + name, + player, + text: clip(text), + }) + } + fn broadcast(&mut self, text: String) { + self.say(|name| Output::Broadcast { + name, + text: clip(text), + }); } } impl hud::Host for State { diff --git a/crates/horizon-mods/src/testing.rs b/crates/horizon-mods/src/testing.rs index 4a62b3838..4fcb595a0 100644 --- a/crates/horizon-mods/src/testing.rs +++ b/crates/horizon-mods/src/testing.rs @@ -87,6 +87,7 @@ impl TestGame { self.mods.set_snapshot(Snapshot { player: self.player.clone(), clock: self.clock, + ..Snapshot::default() }); } diff --git a/crates/horizon-mods/tests/sandbox.rs b/crates/horizon-mods/tests/sandbox.rs index 48f77aaef..dd74591d6 100644 --- a/crates/horizon-mods/tests/sandbox.rs +++ b/crates/horizon-mods/tests/sandbox.rs @@ -1,7 +1,8 @@ //! Loads real mods built with the SDK: the coords-hud example and a guest //! that misbehaves on command. Needs `rustup target add wasm32-unknown-unknown`. use horizon_mods::{ - Clock, Corner, Mods, Output, Package, Player, Snapshot, Status, + BlockPos, Clock, Corner, GameMode, Mods, Output, Package, Player, Runs, ServerPlayer, Snapshot, + Status, manifest::componentize, testing::{Script, TestGame}, }; @@ -33,6 +34,8 @@ fn mods_dir() -> &'static Path { "-p", "coords-hud", "-p", + "welcome", + "-p", "horizon-mods-test-guest", "--target-dir", ]) @@ -46,9 +49,13 @@ fn mods_dir() -> &'static Path { let built = target.join("wasm32-unknown-unknown/release"); let dir = target.join("mods"); std::fs::create_dir_all(&dir).unwrap(); - let example = root.join("crates/horizon-mod-sdk/examples/coords-hud/horizon-mod.toml"); + let example = |name: &str| { + let path = format!("crates/horizon-mod-sdk/examples/{name}/horizon-mod.toml"); + std::fs::read_to_string(root.join(path)).unwrap() + }; let mods = [ - ("coords_hud", std::fs::read_to_string(example).unwrap()), + ("coords_hud", example("coords-hud")), + ("welcome", example("welcome")), ("horizon_mods_test_guest", GUEST_MANIFEST.to_string()), ]; for (name, manifest) in mods { @@ -80,6 +87,7 @@ fn player() -> Snapshot { game_time: 100, day_time: 24000 + 6000, }), + players: Vec::new(), } } @@ -475,3 +483,74 @@ fn a_test_script_reloads_and_expects_a_stop() { "the scratch copy and its storage are removed" ); } + +fn alex() -> ServerPlayer { + ServerPlayer { + id: "00000000-0000-4000-8000-000000000001".into(), + name: "Alex".into(), + x: 0.5, + y: 64.0, + z: 0.5, + dimension: "minecraft:the_nether".into(), + game_mode: GameMode::Survival, + health: 20.0, + } +} + +#[test] +fn a_server_mod_runs_only_where_the_world_does() { + // A fresh folder: what the mod stored in an earlier run is beside it. + let dir = mods_dir().join("server"); + let _ = std::fs::remove_dir_all(&dir); + std::fs::create_dir_all(&dir).unwrap(); + let path = dir.join("welcome.hmod"); + std::fs::copy(mods_dir().join("welcome.hmod"), &path).unwrap(); + let paths = std::slice::from_ref(&path); + let window = Mods::load_for(Runs::Client, paths, |_| true, |_| false); + assert_eq!(window.entries()[0].status, Status::Elsewhere); + assert!(!window.is_running()); + + let mut mods = Mods::load_for(Runs::Server, paths, |_| true, |c| c == "give"); + assert!(mods.runs_server()); + assert_eq!( + mods.server_commands().collect::>(), + ["online", "mined"] + ); + assert_eq!(mods.commands().count(), 0, "not the window's chat commands"); + let alex = alex(); + mods.set_snapshot(Snapshot { + players: vec![alex.clone()], + ..Snapshot::default() + }); + mods.player_joined(&alex); + let greeted = [ + Output::Tell { + name: "Welcome".into(), + player: alex.id.clone(), + text: "Welcome, Alex! 0 other player(s) online.".into(), + }, + Output::Broadcast { + name: "Welcome".into(), + text: "Alex is here for the first time".into(), + }, + ]; + assert_eq!(mods.drain(), greeted); + let stone = BlockPos { x: 1, y: 63, z: 0 }; + mods.block_broken(&alex, stone, "minecraft:stone"); + assert!(mods.server_command(&alex, "mined")); + assert!(mods.server_command(&alex, "online")); + let reply = |text: &str| Output::Reply { + player: alex.id.clone(), + text: text.into(), + error: false, + }; + assert_eq!( + mods.drain(), + [reply("You broke 1 block(s)"), reply("Alex (the_nether)")] + ); + assert!(!mods.server_command(&alex, "where")); + assert!( + !mods.command("online"), + "a server command isn't the window's" + ); +} diff --git a/docs/api/mods-reference.md b/docs/api/mods-reference.md index ca2fe9d7a..f179e99cc 100644 --- a/docs/api/mods-reference.md +++ b/docs/api/mods-reference.md @@ -1,7 +1,7 @@ # Mod API reference -The contract between Horizon and its mods: the WIT package `horizon:mods@0.1.0`, every interface, type, function and hook in it, and the capabilities a manifest may list. The guide is [mods.md](../mods.md); stability and versions: [stability.md](stability.md). Manifest `api` lines this game serves: `0.1`, `0.2`. +The contract between Horizon and its mods: the WIT package `horizon:mods@0.1.0`, every interface, type, function and hook in it, and the capabilities a manifest may list. The guide is [mods.md](../mods.md); stability and versions: [stability.md](stability.md). Manifest `api` lines this game serves: `0.1`, `0.2`, `0.3`. ## Capabilities @@ -12,12 +12,22 @@ The contract between Horizon and its mods: the WIT package `horizon:mods@0.1.0`, | `hud` | [`hud`](#hud) | draw text on your screen | | `storage` | [`storage`](#storage) | save its own settings to disk | | `registries` | data files (`assets/`, `data/`), no interface | add blocks and items to your worlds | +| `players` | [`players`](#players) | see who is on the server and message them | ## World `horizon-mod` +A client mod: runs in the player's game. + - Imports (what the game offers): `log`, `game`, `chat`, `hud`, `storage` - Exports (what the mod provides): `events` +## World `horizon-server-mod` + +A server mod (manifest `side = "server"`, `api = "0.3"`, experimental): runs where the world is simulated, on the dedicated server, a LAN host and single player's own server. + +- Imports (what the game offers): `log`, `storage`, `players` +- Exports (what the mod provides): `server-events` + ## `log` Access: always granted. @@ -139,3 +149,76 @@ What the game calls. Only the hooks `init` asks for are ever called. | `frame` | `func(seconds: f32)` | Each rendered frame, with the seconds since the last one. | | `command` | `func(name: string, args: string) -> result, string>` | `/name args`: ok(some(text)) is shown as feedback, err(text) in red. | | `chat` | `func(text: string)` | Each chat line the player receives, as plain text. | + +## `players` + +Access: capability `players`. + +Capability `players`, server mods only (manifest `api = "0.3"`, experimental): the players on the server, and messages to them. + +### enum `game-mode` + +| Case | | +| --- | --- | +| `survival` | | +| `creative` | | +| `adventure` | | +| `spectator` | | + +### record `player` + +| Field | Type | | +| --- | --- | --- | +| `id` | `string` | The player's UUID, `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`. | +| `name` | `string` | | +| `x` | `f64` | Feet position, in blocks. | +| `y` | `f64` | | +| `z` | `f64` | | +| `dimension` | `string` | `minecraft:overworld`, `minecraft:the_nether`, ... | +| `game-mode` | `game-mode` | | +| `health` | `f32` | Hit points as vanilla counts them: 20 is full health without effects. | + +| Function | Signature | What it does | +| --- | --- | --- | +| `online` | `func() -> list` | The players online, in the order they joined. | +| `tell` | `func(player: string, text: string) -> bool` | A system message to one player, after the mod's name; false when no player with that id is online. Up to 8 messages per call. | +| `broadcast` | `func(text: string)` | A system message to every player and the server's log, after the mod's name. Counts toward the same 8 per call. | + +## `server-events` + +Access: exported by the mod: the game calls it. + +What the server calls in a server mod (manifest `api = "0.3"`, experimental). Only the hooks `init` asks for are ever called. The player in each event is as the server saw them when it happened. + +### type `player` + +`type player = player` + +### record `registration` + +| Field | Type | | +| --- | --- | --- | +| `commands` | `list` | Commands players may type, without the slash. A name vanilla already uses is refused (vanilla's command runs). | +| `tick` | `bool` | Call `tick` every server tick (20 per second). | +| `joins` | `bool` | Call `player-joined` and `player-left`. | +| `chat` | `bool` | Call `chat` for each chat message a player sends. | +| `blocks` | `bool` | Call `block-broken` and `block-placed`. | + +### record `block-pos` + +| Field | Type | | +| --- | --- | --- | +| `x` | `s32` | | +| `y` | `s32` | | +| `z` | `s32` | | + +| Function | Signature | What it does | +| --- | --- | --- | +| `init` | `func() -> result` | Once, after loading. An error keeps the mod off and is logged. | +| `tick` | `func(tick: u64)` | Each server tick, with the server's tick counter. | +| `player-joined` | `func(player: player)` | A player joined the server; they are in `players.online` already. | +| `player-left` | `func(player: player)` | A player left the server; they are no longer in `players.online`. | +| `chat` | `func(player: player, text: string)` | A chat message a player sent, as plain text. | +| `command` | `func(player: player, name: string, args: string) -> result, string>` | `/name args` typed by `player`: ok(some(text)) is their feedback, err(text) their error in red. | +| `block-broken` | `func(player: player, pos: block-pos, state: string)` | A player broke the block at `pos` in their dimension: `state` is what was there, as `minecraft:oak_log[axis=y]`. | +| `block-placed` | `func(player: player, pos: block-pos, state: string)` | A player placed `state` at `pos` in their dimension. | diff --git a/docs/api/mods.md b/docs/api/mods.md index b382744e9..5db01a9b8 100644 --- a/docs/api/mods.md +++ b/docs/api/mods.md @@ -13,14 +13,14 @@ the player before the mod is turned on, and checked against the component's real | | 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 | +| Interfaces the game offers | 6: `log`, `game`, `chat`, `hud`, `storage`; `players` for server mods | +| Functions in them | 12 | +| Hooks a mod exports | 5: `init`, `tick`, `frame`, `command`, `chat`; a server mod 8: `init`, `tick`, `player-joined`, `player-left`, `chat`, `command`, `block-broken`, `block-placed` | +| Capabilities | 6: `game-read`, `chat`, `hud`, `storage`, `registries`, `players` | +| Manifest `api` lines served | 3: `0.1` (code), `0.2` (content), `0.3` (server mods, experimental) | +| SDK | the `Mod` trait (5 methods), `Registration` (4 builders), `export_mod!`, log helpers; `server::ServerMod` (8 methods), `server::Registration` (5 builders), `export_server_mod!` | | `cargo horizon-mod` | `new`, `build`, `run`, `test`, `check` | -| Example mods | `coords-hud` (code), `ruby-content` (content) | +| Example mods | `coords-hud` (code), `ruby-content` (content), `welcome` (server) | ## Guide @@ -46,6 +46,8 @@ call, 4 MiB of storage, fuel per call). - `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-mod-sdk/examples/welcome`: a server mod; greets players who join, announces newcomers (kept in + storage), `/online` and `/mined`. - `crates/horizon-mods/tests/guest`: a mod that misbehaves on command (spins, panics, grows its memory), for the sandbox tests. @@ -74,15 +76,16 @@ scripting runtime in the game. ## 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. Server mods come as their own line, `api = "0.3"`, experimental first. +loading on every 0.1.x game. Server mods are their own line, `api = "0.3"`, experimental: they may change in any +release. ## Not there yet What real mods need next, in the order modpacks and servers need it: -- **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. +- **Server mods in the game** (`api = "0.3"`, [Server mods](../mods.md#server-mods-api-03-experimental)): the + contract, runtime and SDK are here; next the server thread, LAN host and dedicated server start them and call + their hooks, then entity events, 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. @@ -98,6 +101,8 @@ What real mods need next, in the order modpacks and servers need it: ## Changelog +- API 0.3 (server mods, experimental): world `horizon-server-mod`, capability `players`, the `server-events` + hooks; SDK `server::ServerMod`; example `welcome`. - SDK: `cargo horizon-mod test` and `horizon_mods::testing`, test scripts in TOML; the template has one. - 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/stability.md b/docs/api/stability.md index 2d4476fc7..30d8c699c 100644 --- a/docs/api/stability.md +++ b/docs/api/stability.md @@ -88,7 +88,7 @@ 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"` | -| Server mods (events, world, server commands) | not started | manifest `api = "0.3"`, experimental first | +| Server mods: world `horizon-server-mod`, `players`, `server-events` | experimental | manifest `api = "0.3"` | | 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 | | diff --git a/docs/mods.md b/docs/mods.md index 326007e20..ffe64e88e 100644 --- a/docs/mods.md +++ b/docs/mods.md @@ -116,7 +116,7 @@ loading. Ordered by what the first native ports need: | `world-read` | blocks and biomes around the player, within the render distance | minimaps, schematics | | `render` | world-space lines, boxes and ghost blocks in a per-frame budget | Litematica-style placement, waypoints | | `registries` | new blocks, items, entities and recipes, mostly data: JSON models, textures, loot and recipes in the `.hmod`'s `assets/` and `data/` | server side; see [Multiplayer](#multiplayer) | -| `server` | world events (block break/place, entity spawn/death, player join), game rules, server commands | runs where the world is simulated | +| `server` | world events (entity spawn/death), game rules, world read/write, typed server commands | after [server mods 0.3](#server-mods-api-03-experimental)'s players, chat, blocks and commands | | `net` | a mod's own client↔server channel (custom payloads) | only between the two halves of the same mod | There is no file, socket, process or raw-input interface, on purpose. @@ -439,6 +439,38 @@ none. "top": "carve", "bottom": "none", "rigid_junctions": true, "inflate": true } } ``` +### Server mods (API 0.3, experimental) + +A server mod runs where the world is simulated: on the dedicated server, on a +LAN host and on single player's own server, never in a player's window. Its +manifest says `side = "server"` and `api = "0.3"` (and only a server mod may); +its component targets the WIT world `horizon-server-mod` instead of +`horizon-mod`. Experimental: it may change in any release +([stability](api/stability.md)). + +| Interface | Capability | Functions | +|---|---|---| +| `log` | always | as for client mods | +| `storage` | `storage` | as for client mods, in the server's `horizon-mods/` | +| `players` | `players` | `online()`: id, name, position, dimension, game mode, health of each player on; `tell(id, text)`, `broadcast(text)`: system messages after the mod's name, 8 per call | + +| Hook (export `server-events`) | When | +|---|---| +| `init() -> result` | once, after loading | +| `tick(tick)` | each server tick | +| `player-joined(player)`, `player-left(player)` | `registration.joins` | +| `chat(player, text)` | `registration.chat`: each chat message a player sends | +| `command(player, name, args)` | `/name args` typed by a player, for a command it registered; `ok(some)` is that player's feedback, `err` their red error | +| `block-broken(player, pos, state)`, `block-placed(player, pos, state)` | `registration.blocks`, with the state as `minecraft:oak_log[axis=y]` | + +Capabilities that act on a local player (`game-read`, `chat`, `hud`) are for +client mods; `players` is for server mods. In Rust: `impl +horizon_mod_sdk::server::ServerMod` and `export_server_mod!`; the example is +[`welcome`](../crates/horizon-mod-sdk/examples/welcome/src/lib.rs). The +runtime, the registry's `check` and the SDK run them today; the game starts +them once its server code calls these hooks (the next step), and until then a +server mod that is turned on shows as run elsewhere. + ## Versions and compatibility - The API is the WIT package `horizon:mods@0.1.0`. New functions and From bcd42f50e9592b11d7fe9444c8f9928ed1f1c786 Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Sun, 25 Oct 2026 15:55:55 +0100 Subject: [PATCH 05/28] cargo horizon-mod test: server mods' scripts A test script drives a server mod as a server would: join = "Alex" brings a player in (ids stable per name, so a rejoin is the same player), as = "Steve" picks who acts (the first player on otherwise), and player, chat, command, break and place are that player's doing; leave = "Alex" lets them go. Server expectations: told (every players.tell, "Name: text") and broadcast; feedback and error read the reply to the player who typed the command. Ticks call both kinds of tick hooks, so one script format serves client and server mods. The welcome example gets two scripts (greeting, a newcomer announced once even after a reload, /online across dimensions, /mined per player), run by the sandbox tests with coords-hud's; docs/mods.md lists the server keys. Co-Authored-By: Claude Opus 5.5 --- .../examples/welcome/tests/commands.toml | 31 +++ .../examples/welcome/tests/welcome.toml | 21 ++ crates/horizon-mods/src/testing.rs | 251 +++++++++++++++++- crates/horizon-mods/tests/sandbox.rs | 32 ++- docs/mods.md | 14 +- 5 files changed, 323 insertions(+), 26 deletions(-) create mode 100644 crates/horizon-mod-sdk/examples/welcome/tests/commands.toml create mode 100644 crates/horizon-mod-sdk/examples/welcome/tests/welcome.toml diff --git a/crates/horizon-mod-sdk/examples/welcome/tests/commands.toml b/crates/horizon-mod-sdk/examples/welcome/tests/commands.toml new file mode 100644 index 000000000..5f0018346 --- /dev/null +++ b/crates/horizon-mod-sdk/examples/welcome/tests/commands.toml @@ -0,0 +1,31 @@ +# /online lists the players and their dimension; /mined counts the acting player's blocks. + +[[step]] +join = "Alex" +expect.commands = ["online", "mined"] + +[[step]] +join = "Steve" +as = "Steve" +player = { dimension = "minecraft:the_nether" } +command = "online" +expect.feedback = "Alex (overworld), Steve (the_nether)" + +[[step]] +as = "Alex" +break = { x = 1, y = 63, z = 0, state = "minecraft:stone" } + +[[step]] +as = "Alex" +break = { x = 2, y = 63, z = 0, state = "minecraft:dirt" } + +# A step's command comes before its break and place. +[[step]] +as = "Alex" +command = "mined" +expect.feedback = "You broke 2 block(s)" + +[[step]] +as = "Steve" +command = "mined" +expect.feedback = "You broke 0 block(s)" diff --git a/crates/horizon-mod-sdk/examples/welcome/tests/welcome.toml b/crates/horizon-mod-sdk/examples/welcome/tests/welcome.toml new file mode 100644 index 000000000..c8a1836db --- /dev/null +++ b/crates/horizon-mod-sdk/examples/welcome/tests/welcome.toml @@ -0,0 +1,21 @@ +# Joins are greeted; a newcomer is announced once, even after a reload (storage). + +[[step]] +join = "Alex" +expect.told = ["Alex: Welcome, Alex! 0 other player(s) online."] +expect.broadcast = ["Alex is here for the first time"] + +[[step]] +join = "Steve" +expect.told = ["Steve: Welcome, Steve! 1 other player(s) online."] +expect.broadcast = ["Steve is here for the first time"] + +[[step]] +leave = "Alex" +expect.told = [] + +[[step]] +reload = true +join = "Alex" +expect.told = ["Alex: Welcome, Alex! 1 other player(s) online."] +expect.broadcast = [] diff --git a/crates/horizon-mods/src/testing.rs b/crates/horizon-mods/src/testing.rs index 4fcb595a0..31ff27227 100644 --- a/crates/horizon-mods/src/testing.rs +++ b/crates/horizon-mods/src/testing.rs @@ -2,10 +2,14 @@ //! //! [`TestGame`] loads one `.hmod` from a scratch copy (its `storage` lives and //! dies with the run) into the same sandbox the game uses, and plays the game's -//! part: the snapshot, ticks, frames, chat lines and commands. [`Script`] is a +//! part: the snapshot, ticks, frames, chat lines and commands, and for a +//! server mod the players joining, leaving, chatting and breaking or placing +//! blocks. [`Script`] is a //! test written in TOML, `tests/.toml` in the mod's folder: steps, each //! saying what happens and what the mod must have shown by then. -use crate::{Clock, Corner, Mods, Output, Panel, Player, Snapshot, Status}; +use crate::{ + BlockPos, Clock, Corner, GameMode, Mods, Output, Panel, Player, ServerPlayer, Snapshot, Status, +}; use serde::Deserialize; use std::{ path::{Path, PathBuf}, @@ -20,6 +24,10 @@ pub struct TestGame { /// What the mod reads with `game-read`; ticks move the clock as the game does. pub player: Option, pub clock: Option, + /// The players on the server, for a server mod, in join order. + pub players: Vec, + /// Every name that joined, for their id. + names: Vec, tick: u64, } @@ -60,6 +68,8 @@ impl TestGame { game_time: 0, day_time: 0, }), + players: Vec::new(), + names: Vec::new(), tick: 0, }; copy_mod(hmod, ©)?; @@ -87,9 +97,13 @@ impl TestGame { self.mods.set_snapshot(Snapshot { player: self.player.clone(), clock: self.clock, - ..Snapshot::default() + players: self.players.clone(), }); } + /// Whether the mod is a server mod. + pub fn server(&self) -> bool { + self.mods.runs_server() + } /// `n` game ticks; each moves the clock one tick on, as the game does. pub fn tick(&mut self, n: u64) { @@ -101,6 +115,7 @@ impl TestGame { } self.snapshot(); self.mods.tick(self.tick); + self.mods.server_tick(self.tick); } } /// `n` frames, 1/60 s apart. @@ -122,13 +137,76 @@ impl TestGame { self.mods.command(line) } + /// A player named `name` joins the server, standing where a script starts + /// in survival. Their id is `00000000-0000-4000-8000-000000000001` for + /// the first name that joined, `...0002` for the second, and so on. + pub fn join(&mut self, name: &str) -> ServerPlayer { + let n = match self.names.iter().position(|n| n == name) { + Some(i) => i + 1, + None => { + self.names.push(name.to_owned()); + self.names.len() + } + }; + let p = default_player(); + let player = ServerPlayer { + id: format!("00000000-0000-4000-8000-{n:012x}"), + name: name.to_owned(), + x: p.x, + y: p.y, + z: p.z, + dimension: p.dimension, + game_mode: GameMode::Survival, + health: p.health, + }; + self.players.push(player.clone()); + self.snapshot(); + self.mods.player_joined(&player); + player + } + /// The player named `name` leaves; false when no such player is on. + pub fn leave(&mut self, name: &str) -> bool { + let Some(i) = self.players.iter().position(|p| p.name == name) else { + return false; + }; + let player = self.players.remove(i); + self.snapshot(); + self.mods.player_left(&player); + true + } + /// A chat message `player` sends, for a server mod. + pub fn player_chat(&mut self, player: &ServerPlayer, line: &str) { + self.snapshot(); + self.mods.player_chat(player, line); + } + /// `/line` typed by `player`, for a server mod; false when the mod owns + /// no such command. + pub fn player_command(&mut self, player: &ServerPlayer, line: &str) -> bool { + self.snapshot(); + self.mods.server_command(player, line) + } + /// `player` breaks (or places) `state` at `pos`. + pub fn block(&mut self, player: &ServerPlayer, pos: BlockPos, state: &str, placed: bool) { + self.snapshot(); + if placed { + self.mods.block_placed(player, pos, state); + } else { + self.mods.block_broken(player, pos, state); + } + } + /// The scratch copy the mod runs from; its `storage` is beside it. pub fn hmod(&self) -> &Path { &self.hmod } /// The commands the mod registered. pub fn commands(&self) -> Vec { - self.mods.commands().map(str::to_owned).collect() + let server = self.mods.server_commands(); + self.mods + .commands() + .chain(server) + .map(str::to_owned) + .collect() } pub fn panel(&self) -> Option<&Panel> { self.mods.panels().next() @@ -164,7 +242,7 @@ fn copy_mod(from: &Path, to: &Path) -> Result<(), String> { Ok(()) } -/// A test in TOML: where the player starts, then steps run in order. +/// A test in TOML: where a client mod's player starts, then steps run in order. #[derive(Debug, Default, Deserialize)] #[serde(deny_unknown_fields, rename_all = "kebab-case")] pub struct Script { @@ -176,9 +254,11 @@ pub struct Script { pub steps: Vec, } -/// Fields of the player to change; the others keep their values. +/// Fields of the player to change; the others keep their values. A server +/// mod's players have no `yaw`, `pitch` or `food`, and a client mod's player +/// no `game-mode`. #[derive(Debug, Default, Deserialize)] -#[serde(deny_unknown_fields)] +#[serde(deny_unknown_fields, rename_all = "kebab-case")] pub struct PlayerSet { x: Option, y: Option, @@ -188,6 +268,37 @@ pub struct PlayerSet { health: Option, food: Option, dimension: Option, + game_mode: Option, +} + +/// `players.game-mode` as a script spells it. +#[derive(Clone, Copy, Debug, Deserialize)] +#[serde(rename_all = "lowercase")] +enum Mode { + Survival, + Creative, + Adventure, + Spectator, +} +impl From for GameMode { + fn from(m: Mode) -> GameMode { + match m { + Mode::Survival => GameMode::Survival, + Mode::Creative => GameMode::Creative, + Mode::Adventure => GameMode::Adventure, + Mode::Spectator => GameMode::Spectator, + } + } +} + +/// A block a player breaks or places. +#[derive(Debug, Deserialize)] +#[serde(deny_unknown_fields)] +pub struct BlockSet { + x: i32, + y: i32, + z: i32, + state: String, } #[derive(Debug, Default, Deserialize)] @@ -198,8 +309,11 @@ pub struct ClockSet { } /// One step. Its parts happen in this order: `reload`, `title-screen`, -/// `player`, `clock`, `ticks`, `frames`, `chat`, `command`; then `expect` is -/// checked against what the mod showed during the step. +/// `join`, `player`, `clock`, `ticks`, `frames`, `chat`, `command`, `break`, +/// `place`, `leave`; then `expect` is checked against what the mod showed +/// during the step. For a server mod, `player`, `chat`, `command`, `break` +/// and `place` are the doing of the player named by `as`, or of the first +/// player on. #[derive(Debug, Default, Deserialize)] #[serde(deny_unknown_fields, rename_all = "kebab-case")] pub struct Step { @@ -216,6 +330,14 @@ pub struct Step { frames: u64, chat: Option, command: Option, + /// Server mods: a player joins, leaves, breaks or places a block. + join: Option, + leave: Option, + #[serde(rename = "as")] + actor: Option, + #[serde(rename = "break")] + broken: Option, + place: Option, #[serde(default)] expect: Expect, } @@ -231,6 +353,10 @@ pub struct Expect { /// The command's feedback, and its red error. feedback: Option, error: Option, + /// Server mods: every `players.tell` as `"Name: text"`, and every + /// `players.broadcast`, in order. + told: Option>, + broadcast: Option>, /// The panel's lines (`[]`: no panel) and its corner. panel: Option>, corner: Option, @@ -274,6 +400,17 @@ impl PlayerSet { p.dimension.clone_from(d); } } + fn apply_server(&self, p: &mut ServerPlayer) { + let set = |to: &mut f64, v: Option| *to = v.unwrap_or(*to); + set(&mut p.x, self.x); + set(&mut p.y, self.y); + set(&mut p.z, self.z); + p.health = self.health.unwrap_or(p.health); + p.game_mode = self.game_mode.map_or(p.game_mode, GameMode::from); + if let Some(d) = &self.dimension { + p.dimension.clone_from(d); + } + } } impl ClockSet { @@ -302,6 +439,17 @@ impl Step { if let Some(line) = &self.command { parts.push(format!("/{line}")); } + if let Some(name) = &self.join { + parts.insert(0, format!("{name} joins")); + } + for (what, b) in [("breaks", &self.broken), ("places", &self.place)] { + if let Some(b) = b { + parts.push(format!("{what} {} at {} {} {}", b.state, b.x, b.y, b.z)); + } + } + if let Some(name) = &self.leave { + parts.push(format!("{name} leaves")); + } if parts.is_empty() { parts.push("checks".into()); } @@ -316,8 +464,35 @@ impl Step { game.player = None; game.clock = None; } + if let Some(name) = &self.join { + game.join(name); + } + let server = game.server(); + let actor = |game: &TestGame| match &self.actor { + Some(name) => game + .players + .iter() + .position(|p| p.name == *name) + .ok_or_else(|| format!("{name} is not on the server")), + None => (!game.players.is_empty()) + .then_some(0) + .ok_or_else(|| "no player is on the server: add join = \"Name\"".to_string()), + }; + let acts = self.player.is_some() + || self.chat.is_some() + || self.command.is_some() + || self.broken.is_some() + || self.place.is_some(); + let actor = if server && acts { + Some(actor(game)?) + } else { + None + }; if let Some(set) = &self.player { - set.apply(game.player.get_or_insert_with(default_player)); + match actor { + Some(i) => set.apply_server(&mut game.players[i]), + None => set.apply(game.player.get_or_insert_with(default_player)), + } } if let Some(set) = &self.clock { set.apply(game.clock.get_or_insert(Clock { @@ -327,10 +502,32 @@ impl Step { } game.tick(self.ticks); game.frames(self.frames); + let who = actor.map(|i| game.players[i].clone()); if let Some(line) = &self.chat { - game.chat(line); + match &who { + Some(p) => game.player_chat(p, line), + None => game.chat(line), + } + } + let owned = self.command.as_ref().map(|line| match &who { + Some(p) => game.player_command(p, line), + None => game.command(line), + }); + for (b, placed) in [(&self.broken, false), (&self.place, true)] { + if let (Some(b), Some(p)) = (b, &who) { + let pos = BlockPos { + x: b.x, + y: b.y, + z: b.z, + }; + game.block(p, pos, &b.state, placed); + } + } + if let Some(name) = &self.leave + && !game.leave(name) + { + return Err(format!("{name} is not on the server")); } - let owned = self.command.as_ref().map(|line| game.command(line)); let out = game.drain(); let stopped = out.iter().find_map(|o| match o { Output::Stopped { reason, .. } => Some(reason.as_str()), @@ -370,10 +567,38 @@ impl Step { } let feedback = |error: bool| { out.iter().rev().find_map(|o| match o { - Output::Feedback { text, error: e } if *e == error => Some(text.clone()), + Output::Feedback { text, error: e } | Output::Reply { text, error: e, .. } + if *e == error => + { + Some(text.clone()) + } _ => None, }) }; + if let Some(want) = &e.told { + let name = |id: &str| { + let p = game.players.iter().find(|p| p.id == id); + p.map_or(id.to_owned(), |p| p.name.clone()) + }; + let got: Vec = out + .iter() + .filter_map(|o| match o { + Output::Tell { player, text, .. } => Some(format!("{}: {text}", name(player))), + _ => None, + }) + .collect(); + same("told", want, &got)?; + } + if let Some(want) = &e.broadcast { + let got: Vec = out + .iter() + .filter_map(|o| match o { + Output::Broadcast { text, .. } => Some(text.clone()), + _ => None, + }) + .collect(); + same("broadcast", want, &got)?; + } if let Some(want) = &e.feedback { same("feedback", &Some(want.clone()), &feedback(false))?; } diff --git a/crates/horizon-mods/tests/sandbox.rs b/crates/horizon-mods/tests/sandbox.rs index dd74591d6..ca2b8896e 100644 --- a/crates/horizon-mods/tests/sandbox.rs +++ b/crates/horizon-mods/tests/sandbox.rs @@ -407,22 +407,23 @@ capabilities = ["registries"] assert!(!mods.is_running()); } -/// `cargo horizon-mod test` on the example: its own `tests/*.toml` pass. +/// `cargo horizon-mod test` on the examples: their own `tests/*.toml` pass. #[test] fn the_examples_test_scripts_pass() { - let tests = - Path::new(env!("CARGO_MANIFEST_DIR")).join("../horizon-mod-sdk/examples/coords-hud/tests"); + let examples = Path::new(env!("CARGO_MANIFEST_DIR")).join("../horizon-mod-sdk/examples"); let mut ran = 0; - for entry in std::fs::read_dir(tests).unwrap() { - let path = entry.unwrap().path(); - let script = Script::parse(&std::fs::read_to_string(&path).unwrap()).unwrap(); - let mut game = TestGame::load(&mods_dir().join("coords_hud.hmod")).unwrap(); - script - .run(&mut game) - .unwrap_or_else(|e| panic!("{}: {e}", path.display())); - ran += 1; + for (example, hmod) in [("coords-hud", "coords_hud"), ("welcome", "welcome")] { + for entry in std::fs::read_dir(examples.join(example).join("tests")).unwrap() { + let path = entry.unwrap().path(); + let script = Script::parse(&std::fs::read_to_string(&path).unwrap()).unwrap(); + let mut game = TestGame::load(&mods_dir().join(format!("{hmod}.hmod"))).unwrap(); + script + .run(&mut game) + .unwrap_or_else(|e| panic!("{}: {e}", path.display())); + ran += 1; + } } - assert_eq!(ran, 2); + assert_eq!(ran, 4); } #[test] @@ -446,6 +447,13 @@ fn a_test_script_says_which_step_failed_and_why() { Script::parse("[[step]]\ntick = 1").is_err(), "a typo is an error" ); + + let mut game = TestGame::load(&mods_dir().join("welcome.hmod")).unwrap(); + let script = "[[step]]\njoin = \"Alex\"\n\n[[step]]\nas = \"Steve\"\ncommand = \"mined\""; + assert_eq!( + Script::parse(script).unwrap().run(&mut game).unwrap_err(), + "step 2 (/mined): Steve is not on the server" + ); } #[test] diff --git a/docs/mods.md b/docs/mods.md index ffe64e88e..6a095adba 100644 --- a/docs/mods.md +++ b/docs/mods.md @@ -244,7 +244,8 @@ key> --signature .minisig`. `cargo horizon-mod test` builds the mod, then runs each `tests/.toml` in the sandbox the game uses, with no game and no window: the test plays the game's part (the player and the clock the mod reads, ticks, frames, chat lines, -commands) and checks what the mod showed. A script fails at its first wrong +commands; for a server mod, players joining, chatting, typing commands, +breaking and placing blocks and leaving) and checks what the mod showed. A script fails at its first wrong step, with what it expected and what it got; the command fails if any script does. `--debug` builds without optimizing, `--hmod ` tests a `.hmod` already built, and a name runs only the scripts whose path holds it. Each @@ -281,6 +282,16 @@ A step's parts happen in this order: | `ticks = n`, `frames = n` | that many ticks (the game's tick counter and the clock move on), then frames 1/60 s apart | | `chat = " hi"` | a chat line the player receives | | `command = "where north"` | the player types `/where north`; a command the mod doesn't own fails the step | +| `break = { x = 1, y = 63, z = 0, state = "minecraft:stone" }`, `place = { ... }` | server mods: the player breaks or places that block | +| `leave = "Alex"` | server mods: that player leaves | + +A server mod starts with nobody on: `join = "Alex"` (after `reload` and `title-screen`) brings a +player in at the defaults, in survival, with the id +`00000000-0000-4000-8000-000000000001` for the first name that joined, `...2` +for the second, the same id when a name joins again. `player`, `chat`, +`command`, `break` and `place` are then that player's doing: the one named by +`as = "Steve"`, or the first one on. `player` takes `game-mode` there, and the +script's own `[player]` and `[clock]` are a client mod's. Then `expect` checks what the mod did during the step; a key left out is not checked: @@ -291,6 +302,7 @@ checked: | `chat = ["..."]` | every chat line it showed, in order (`[]`: none) | | `feedback = "..."`, `error = "..."` | the command's answer, shown plain or in red | | `panel = ["..."]`, `corner = "top-left"` | its HUD panel's lines (`[]`: no panel) and corner | +| `told = ["Alex: Welcome!"]`, `broadcast = ["..."]` | server mods: every `players.tell` (as `name: text`) and `players.broadcast`, in order | | `stopped = "panic"` | the mod was turned off, for a reason holding this text; without it, a mod that traps, panics or overruns fails the test | Unknown keys are errors, so a typo never passes silently. The same runner is From bd09f8b03eb2338086a7c0a1fe49c19e0c37fc7e Mon Sep 17 00:00:00 2001 From: rdbtCVS <87152661+rdbtCVS@users.noreply.github.com> Date: Sun, 25 Oct 2026 19:36:11 +0000 Subject: [PATCH 06/28] Migrate player integration coverage to server-thread hosting Co-Authored-By: OpenAI Codex GPT-6.1 --- AGENTS.md | 8 +- .../src/bin/horizon-ctl/main.rs | 7 +- crates/horizon-client/src/game.rs | 3 + crates/horizon-client/src/game/agent.rs | 3 + crates/horizon-client/src/game/control.rs | 57 ++++ crates/horizon-client/src/game/creatures.rs | 3 + crates/horizon-client/src/game/integrated.rs | 6 + .../src/game/remote_projectiles.rs | 3 +- docs/architecture.md | 2 +- docs/parity-workflow.md | 46 +++ docs/validation/server-thread-migration.md | 297 ++++++++++++++++++ .../dev/horizonlab/parity/ParityFont.java | 40 ++- .../parity/VanillaPackScreenOracle.java | 2 +- .../parity/VanillaTabListOracle.java | 26 +- tests/test_game_home.py | 1 + tests/test_integration_env.py | 50 +++ tools/agent_control_e2e.py | 2 + tools/integration_env.py | 54 ++++ tools/lan_e2e.py | 296 +++++++++++++---- tools/oracle_harness.py | 5 +- tools/test_command_exec_parity.py | 5 +- tools/test_dedicated_server_parity.py | 12 +- tools/test_dispenser_parity.py | 5 +- tools/test_friends.py | 47 ++- tools/test_friends_integration_parity.py | 30 ++ tools/test_lan_integration_parity.py | 14 + tools/test_online_mode_parity.py | 4 +- tools/test_pack_screen_parity.py | 2 +- tools/test_tab_list_parity.py | 2 +- 29 files changed, 932 insertions(+), 100 deletions(-) create mode 100644 docs/validation/server-thread-migration.md create mode 100644 tests/test_integration_env.py create mode 100644 tools/integration_env.py create mode 100644 tools/test_friends_integration_parity.py create mode 100644 tools/test_lan_integration_parity.py diff --git a/AGENTS.md b/AGENTS.md index a72c6723a..c8bfcdb34 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -66,7 +66,7 @@ cargo build --profile fast -p horizon-client # optimized, quick to link: python3 tools/parity.py --changed origin/main # the harnesses your branch can affect (CI's parity job) python3 tools/parity.py --changed-files paths.txt --list # which harnesses cover these files, without running them python3 tools/parity.py mob_ai sculk # named harnesses -python3 tools/lan_e2e.py --check chest # two real games over LAN (host in-frame); --server-thread for the host on its server thread +python3 tools/lan_e2e.py --check chest # two real games over LAN (server-thread host); --in-frame compares the fallback python3 tools/agent_control_e2e.py # horizon-ctl / MCP end to end ``` @@ -156,7 +156,7 @@ python3 tools/agent_control_e2e.py # horizon-ctl / MCP end to end exactly as a LAN guest or a dedicated server's player does. This is what players run. Open `[server-thread]` issues list the gaps left. 2. **In-frame (`--in-frame`, `--no-server-thread` or `HORIZON_SERVER_THREAD=0`):** the window's `Game` ticks - the world itself, one level that follows the player (`fn enter_dimension`). Most harnesses test this path. + the world itself, one level that follows the player (`fn enter_dimension`). Deterministic rule fixtures still use this path; player-facing integration uses the default server thread. LAN guests and dedicated servers always use the server code, so a fix there serves both. Test both paths when you touch player-facing gameplay: @@ -164,8 +164,8 @@ when you touch player-facing gameplay: ```sh cargo run --profile fast -p horizon-client -- --resources .local/horizon-client/26.3 --world T # server thread cargo run --profile fast -p horizon-client -- --resources .local/horizon-client/26.3 --world T --in-frame # in-frame -python3 tools/lan_e2e.py --check # host in-frame, guest is a server client -python3 tools/lan_e2e.py --server-thread --check # host on its server thread (portals, levels, distance, lava need it) +python3 tools/lan_e2e.py --check # host on its server thread, guest is a server client +python3 tools/lan_e2e.py --in-frame --check # comparison (portals, levels, distance, lava need server-thread mode) python3 tools/parity.py dedicated_server server_entities server_player_damage ``` diff --git a/crates/horizon-client/src/bin/horizon-ctl/main.rs b/crates/horizon-client/src/bin/horizon-ctl/main.rs index 402808e81..33ea1f870 100644 --- a/crates/horizon-client/src/bin/horizon-ctl/main.rs +++ b/crates/horizon-client/src/bin/horizon-ctl/main.rs @@ -610,12 +610,17 @@ mod tests { #[test] fn unreachable_games_fail_with_status_3() { - let mut s = Session::new(std::env::temp_dir().join("horizon-ctl-nobody.sock"), None); + let home = + std::env::temp_dir().join(format!("horizon-ctl-unreachable-{}", std::process::id())); + std::fs::create_dir_all(&home).unwrap(); + let mut s = Session::new(home.join("nobody.sock"), None); + s.home = home.clone(); let f = s.run(&["state".to_owned()]).unwrap_err(); assert_eq!(f.status, UNREACHABLE); assert_eq!(f.reply["kind"], "connection"); let f = s.run(&["sleep".to_owned(), "x".to_owned()]).unwrap_err(); assert_eq!(f.status, USAGE); + std::fs::remove_dir_all(home).unwrap(); } #[test] diff --git a/crates/horizon-client/src/game.rs b/crates/horizon-client/src/game.rs index a246afebc..5901c3362 100644 --- a/crates/horizon-client/src/game.rs +++ b/crates/horizon-client/src/game.rs @@ -4073,6 +4073,9 @@ impl Game<'_> { self.with_level(|b, level, ticks| b.notify_written(level, ticks, position, flags)); } fn tick(&mut self) -> Result<()> { + if self.agent.hold_server { + return Ok(()); + } self.tick_debug_keys()?; self.tick_debug_charts(); if self.remote.is_some() { diff --git a/crates/horizon-client/src/game/agent.rs b/crates/horizon-client/src/game/agent.rs index 57c12da97..935717eb5 100644 --- a/crates/horizon-client/src/game/agent.rs +++ b/crates/horizon-client/src/game/agent.rs @@ -300,6 +300,8 @@ struct Glide { pub(super) struct Agent { task: Option, glide: Option, + /// Control-fixture barrier: hold simulation and packet handling, not transport threads. + pub hold_server: bool, } pub(super) enum Handled { @@ -662,6 +664,7 @@ impl Game<'_> { }); if let Some(chat) = &self.ui.chat_screen { v["chat_input"] = json!(chat.input.value); + v["chat_suggestions"] = json!(chat.suggestions_visible()); } if self.title.is_some() { v["menu"] = self.title_value(); diff --git a/crates/horizon-client/src/game/control.rs b/crates/horizon-client/src/game/control.rs index a0d8987d8..a7312c99b 100644 --- a/crates/horizon-client/src/game/control.rs +++ b/crates/horizon-client/src/game/control.rs @@ -11,6 +11,9 @@ use winit::{event::MouseButton, event_loop::ActiveEventLoop, keyboard::KeyCode}; const HELP: &[&str] = &[ "status game, player, streaming and renderer state", + "simulation authoritative projectiles in the owner's level", + "server-hold on|off hold simulation and player packets at a control-fixture barrier", + "stall MILLISECONDS stall the window thread (0..5000), leaving transport alive", "key KEY down|up|tap|repeat press, release or auto-repeat a key (w a s d space shift ctrl e q esc f3 1-9 arrows ...)", "release release every key and mouse button", "mouse left|right|middle down|up|click", @@ -238,6 +241,47 @@ impl Game<'_> { } "sculk" => Ok(Some(self.sculk_command(&words)?)), "status" => Ok(Some(self.control_status())), + "stall" => { + let millis: u64 = arg(1)?.parse()?; + if millis > 5000 { + return Err("stall is limited to 5000 milliseconds".into()); + } + std::thread::sleep(Duration::from_millis(millis)); + ok() + } + "simulation" => { + self.require_world()?; + let value = if let Some(server) = &self.integrated { + server + .call(|g| { + g.in_owner_level(|g| { + json!({ "game_time": g.world.game_time, "projectiles": g.projectiles_status() }) + }) + }) + .ok_or("the integrated server stopped")? + } else { + json!({ "game_time": self.world.game_time, "projectiles": self.projectiles_status() }) + }; + Ok(Some(value)) + } + "server-hold" => { + self.require_world()?; + let held = match arg(1)? { + "on" => true, + "off" => false, + _ => return Err("server-hold on|off".into()), + }; + if let Some(server) = &self.integrated { + server + .call(move |g| g.agent.hold_server = held) + .ok_or("the integrated server stopped")?; + } else if self.remote.is_some() { + return Err("server-hold requires the world's host".into()); + } else { + self.agent.hold_server = held; + } + ok() + } "pad" => Ok(Some(self.pad_command(&words)?)), "key" => { let key = key_code(arg(1)?).ok_or_else(|| format!("unknown key {}", words[1]))?; @@ -496,10 +540,23 @@ impl Game<'_> { "mobs" => { self.require_world()?; let radius: f64 = words.get(1).map_or(Ok(64.0), |r| r.parse())?; + if let Some(server) = &self.integrated { + let center = self.player.as_ref().map_or(Vec3::ZERO, |p| p.position); + let value = server + .call(move |g| g.in_owner_level(|g| g.control_mobs_at(radius, center))) + .ok_or("the integrated server stopped")?; + return Ok(Some(value)); + } Ok(Some(self.control_mobs(radius))) } "hurtlog" => { self.require_world()?; + if let Some(server) = &self.integrated { + let value = server + .call(|g| g.control_hurt_log()) + .ok_or("the integrated server stopped")?; + return Ok(Some(value)); + } Ok(Some(self.control_hurt_log())) } "resume" => { diff --git a/crates/horizon-client/src/game/creatures.rs b/crates/horizon-client/src/game/creatures.rs index c4779dbf7..60f3d57db 100644 --- a/crates/horizon-client/src/game/creatures.rs +++ b/crates/horizon-client/src/game/creatures.rs @@ -316,6 +316,9 @@ impl Game<'_> { /// The `mobs` command: nearby mobs with position, health and running goals. pub(super) fn control_mobs(&self, radius: f64) -> serde_json::Value { let center = self.player.as_ref().map_or(Vec3::ZERO, |p| p.position); + self.control_mobs_at(radius, center) + } + pub(super) fn control_mobs_at(&self, radius: f64, center: Vec3) -> serde_json::Value { let list: Vec = self .mobs .iter() diff --git a/crates/horizon-client/src/game/integrated.rs b/crates/horizon-client/src/game/integrated.rs index d4726f2f1..21e46f51e 100644 --- a/crates/horizon-client/src/game/integrated.rs +++ b/crates/horizon-client/src/game/integrated.rs @@ -360,6 +360,12 @@ impl Game<'_> { let mut next = Instant::now(); while !flags.stop.load(Ordering::Relaxed) { self.run_tasks(); + if self.agent.hold_server { + // Keep servicing control requests so the fixture can release the barrier. + // Unlike /tick freeze, no player's queued packets are applied here. + self.wait_for_next_server_tick(&mut next, true); + continue; + } let paused = flags.paused.load(Ordering::Relaxed); if paused { // Only the connections run. diff --git a/crates/horizon-client/src/game/remote_projectiles.rs b/crates/horizon-client/src/game/remote_projectiles.rs index bc6d0b13e..e70426a4a 100644 --- a/crates/horizon-client/src/game/remote_projectiles.rs +++ b/crates/horizon-client/src/game/remote_projectiles.rs @@ -272,7 +272,8 @@ impl Game<'_> { out.push(json!({"id": t.id, "kind": "minecraft:trident", "position": at(t.position)})); } for p in &self.creatures.projectiles { - out.push(json!({"id": p.id, "kind": format!("{:?}", p.kind).split([' ', '{']).next().unwrap_or(""), "position": at(p.position)})); + out.push(json!({"id": p.id, "kind": format!("{:?}", p.kind).split([' ', '{']).next().unwrap_or(""), "position": at(p.position), "velocity": at(p.velocity), + "player_owned": p.owner == Some(horizon_client::mobs::Who::Player)})); } for (kind, p, _) in self.potions.thrown_entities() { out.push(json!({"kind": kind, "position": at(p)})); diff --git a/docs/architecture.md b/docs/architecture.md index f95073e57..0350bd1ea 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -51,7 +51,7 @@ file selects ~103. | 34 | Multiplayer and LAN screens, friends (44) | `L/multiplayer.rs`, `G/lan_screen.rs`, `G/friends.rs`, `L/friends_screen.rs`, `crates/horizon-friends/`, `crates/horizon-relay/` | lan, world_options; `python3 tools/test_friends.py` | | 35 | Dispensers (43) | `G/dispenser.rs`, `G/dispense_fixture.rs` (the harness side) | dispenser | | 36 | Audio and music (38) | `L/audio.rs`, `L/sound_engine.rs`, `L/sound_events.rs`, `L/music.rs`, `G/music.rs`, `L/ambience.rs`, `G/subtitle_hud.rs` | sound_engine, sound_event, music, situational_music, ambient_sound, subtitle | -| 37 | Integrated server and levels (34) | `G/integrated.rs`, `G/levels.rs`, `G/server_travel.rs` | server_dimension_players, `lan_e2e --server-thread` (portals, levels, distance, lava) | +| 37 | Integrated server and levels (34) | `G/integrated.rs`, `G/levels.rs`, `G/server_travel.rs` | server_dimension_players, `lan_e2e` (server-thread by default; portals, levels, distance, lava) | | 38 | Command parsing (34) | `L/command/` (`args.rs`, `selector.rs`, `tree_*.rs`, `vanilla.rs`) | command_parse (corpus `tools/command_parse_corpus.py`) | | 39 | Benchmarks and telemetry (34) | `L/benchmark.rs`, `tools/perf_bench.py`, `L/telemetry.rs`, `crates/horizon-telemetry*/`, `crates/horizon-bench/` | `python3 -m unittest tests.test_perf_bench`; [benchmark.md](benchmark.md) | | 40 | Explosions and TNT (31) | `G/explosion.rs`, `G/tnt.rs` | lan_e2e blast; no dedicated harness yet | diff --git a/docs/parity-workflow.md b/docs/parity-workflow.md index f9f222071..3834234c9 100644 --- a/docs/parity-workflow.md +++ b/docs/parity-workflow.md @@ -77,3 +77,49 @@ On ludodesktop, source `~/code/horizon-parity/env.sh` first: it sets the ALSA bu ## Reading vanilla Besides the Vineflower sources in `.local/minecraft//sources/`, `tools/rea_vanilla.py` queries the shipped bytecode through REA (callers through lambdas, overloads, a second decompiler); see [decompilation status](decompilation-status.md#querying-the-shipped-bytecode-with-rea). + +## Player-facing integration and deterministic fixtures + +`python3 tools/lan_e2e.py` runs every LAN check with an integrated server thread, +the same path as normal single player. `python3 tools/test_friends.py --client +target/fast/horizon-client --relay target/fast/horizon-relay --baseline` covers +plain LAN, direct invitations, a local relay and ended invitations in that mode. +Both accept `--in-frame` for comparison and retain `--server-thread` for existing +callers. Run Linux games under `xvfb-run -a` when no display is available. Each +process gets scratch game, launcher, XDG data and config homes; telemetry, audio +and launcher self-update are disabled. + +`lan_integration` and `friends_integration` register these suites with the normal +`parity.py` selection used by CI. Their traced imports and Cargo artifacts select +them when the drivers or game implementation change. LAN writes `results.json` +with the host mode and each result beside its screenshots and logs. A skipped +case is recorded explicitly and does not count as passing coverage. + +The game-binary fixture audit keeps these complementary direct rule tests: + +- `command_harness.rs`: command feedback, styled spans and result callbacks, + held player position, explicit ticks and portal completion matching + `VanillaCommandExecOracle`. LAN `commands`, `feedback`, `styles`, `levels` and + `portals` cover command input, packet feedback and travel across the boundary. +- `dispense_fixture.rs`: seeded synthetic worlds, block/event traces, item + use/mining and combat hooks matching `VanillaDispenserOracle`. These isolate + rule results and RNG order; LAN machines, crafting, clicks, fireball, mining + and combat exercise real input and server handling separately. The new + `dispenser_input_host` / `dispenser_input_guest` checks press a button and + verify authoritative inventory consumption and exactly one drop on both clients. +- `sculk_fixture.rs`: scripted events and exact per-tick sculk/warden traces + matching `VanillaSculkOracle`; introducing wall-clock network ticks would + destroy that deterministic oracle contract. `sculk_input_host` and + `sculk_input_guest` separately exercise real footsteps reaching a sensor; + failures remain visible rather than changing the oracle trace. +- `net_harness.rs`: already a real network client of a dedicated server; keep + its handshake, world loading, chat and command packet assertions. + +Library probes, `lan_bot`'s protocol hub fixture, generation/save tests and +streaming/mesh tests remain fast deterministic coverage. They do not become +full game launches. Setup and authoritative reads use the owning server; +interactions stay on the client. `server-hold on|off` provides a prediction-test +barrier between server ticks, including player packet handling, while transport +threads and control calls remain responsive. `stall MILLISECONDS` stalls only +the window to test recovery from a hung frame without process signals interrupting +socket reads. Neither mechanism changes normal gameplay. diff --git a/docs/validation/server-thread-migration.md b/docs/validation/server-thread-migration.md new file mode 100644 index 000000000..62c1609b7 --- /dev/null +++ b/docs/validation/server-thread-migration.md @@ -0,0 +1,297 @@ +# Server-thread integration coverage migration: validation ledger + +Tested on 2026-10-24, Linux / NVIDIA Vulkan, with Java 25 and the pinned 26.3 +resources and jars. Base: `e423e570c`. Player integration uses real Horizon +clients under Xvfb and real control sockets. The migrated game drivers use fresh +temporary game, launcher and XDG data/config homes; telemetry, audio and launcher +self-update are disabled. No player data or prepared resources are committed. +An interrupted historical-world generator initially inherited the harness +environment instead of those per-game homes. It wrote only to ignored `.local` +fixture folders; it was stopped, and subsequent validation uses the already +prepared historical worlds. That setup mistake is not counted as a passing run. + +## Before editing + +Open PR searches for server-thread, integration, LAN and friends work found no +overlapping migration. The full original LAN suite was started with +`--server-thread` against a build of the unchanged base before repository edits. + +| Run | Hosting | Result | +| --- | --- | --- | +| Original full LAN attempt | Server thread | 58 checks reported: 39 passed, 18 failed, deflection skipped; the runner then aborted at `light` with an uncaught `TypeError`. | +| Original remaining 45 checks | Server thread | 31 passed, 14 failed, no skips. Used the unchanged loaded driver and original executable. | +| Friends, including `--baseline` | Server thread | Plain LAN, direct invitation, local relay and ended-invite rejection passed. | + +Together the two LAN invocations attempted all 103 original checks. The initial +`sign` case left its editor open, breaking the later death-screen assertion. +`predict` suspended the whole host process; resuming it interrupted a socket +read (`Interrupted system call`), disconnected the guest and caused later +session failures. The remaining run also exposed sign placement outside reach +and cascading dead-player failures. These are recorded failures, not passes. + +## Infrastructure changes validated during migration + +- Close the sign editor after the original placement check. Give the two-player + sign case a reachable arena and wait for placement data/feedback before typing. + Observe the submitted text on both clients within the existing assertion budget. + The revised sign case passed three consecutive server-thread reruns. +- Release held input, close screens and respawn dead players before independent + cases. Keep every case's death, menu and held-action assertions inside the case. +- Replace process signals with a server barrier for prediction and an intentional + window-thread stall for frame-recovery tests. Prediction still tests immediate + client prediction, authoritative agreement, iron-door rejection and exactly-once + sound; it also asserts that the server clock did not advance at the barrier. +- Route mob/projectile/hurt-log inspection to the owning server. Deflection runs + in the default suite rather than reporting an in-frame-only skip as a pass. +- Record skipped checks explicitly as uncovered, and record ordinary case errors + without aborting the rest of the suite. Write mode and results to `results.json`. +- Serialize the two CI integration entry points on the shared GPU. An earlier + concurrent comparison failed to start a graphics device because of GPU memory + exhaustion; it was rerun serially, without changing a gameplay timeout. + +## Post-migration runs + +The first complete server-thread migration run, before the case-cleanup fixes, +ran all 103 original cases: 88 passed and 15 failed. Failures were `deflect`, +`light`, `swings`, `cracks`, `effects`, `portals`, `flight`, `boats`, `minecarts`, +`frames`, `hands`, `riding`, `mounts`, `contacts` and `absorption`. Many followed +the host's deflection damage/death. They are not used as evidence of a clean suite. + +The next complete default server-thread run executed all 107 cases (the original +103 plus four separate host/guest sensor and dispenser input cases): **97 passed, +10 failed, zero skipped**. Failures were `commands`, `deflect`, `swings`, `flight`, +`boats`, `minecarts`, `keepinv`, `fishing`, `sculk_input_host` and +`sculk_input_guest`. Lighting passed this run; earlier lighting failures are not +claimed as a persistent blocker. + +A subsequent input-timing correction runs the existing double-jump key/wait +sequence through one `horizon-ctl script` process, preserving the seven-tick +flight window. A targeted server-thread rerun passed flight for both players, +swings, boats and minecarts. Command completion still failed: the observable +suggestion list did not appear within the existing two-tick budget. The in-frame +rerun passed flight and failed completion in the same way. Passing isolated +swings/vehicle cases does not clear the unexplained failures in the full sequence. +The full-run inventory retention and fishing failures also remain unresolved. + +Friends passed plain LAN, direct invitation, local relay and ended-invite checks +both after making server-thread hosting the default and with explicit `--in-frame`. + +Targeted in-frame comparisons passed chest, sign placement, prediction, clock +recovery, lighting and deflection. The revised two-player sign case and both +new dispenser input cases passed too. Command completion failed twice: Tab after +`/gamem` left `/gamem` unchanged. The host's sculk input passed; the guest's failed. + +Targeted server-thread checks passed prediction and both new dispenser input +cases. Dispensing checks authoritative inventory consumption and exactly one +matching item on each client. Both sensor cases confirmed movement on the client +and server, but the sensor stayed inactive. Deflection still failed the original +no-fireball-damage assertion after allowing the click through a normal client +input tick. An experimental frozen-world synchronization approach also failed +and is not part of the final implementation. + +## Deterministic rule and source checks + +`python3 tools/parity.py command_exec dispenser sculk --timeout 1500 --jobs 2`: + +| Direct fixture | Result | +| --- | --- | +| Command execution | 781/781 command/callback records match the vanilla oracle. | +| Dispenser and related rule calls | 6000 cases match; no difference groups. | +| Sculk | 435 scenarios match every compared tick. | + +All three harnesses passed. Their seeded rule calls and controlled ticks remain +direct; they do not claim client/server boundary coverage. The existing +`net_harness.rs` remains a real dedicated-server client fixture. + +The first quick self-check passed 289 Python tests, rustfmt and Clippy. Rust tests +reported 1081 passed, one failed and 26 ignored: the shared prepared resource +folder lacked `registries.json`. The pinned local datagen report was copied into +a private ignored resource copy; the failed +`mod_content::tests::content_root_loads_with_every_table` test then passed. +The focused environment/parity-runner/self-check Python tests passed (38 tests). + +The full `python3 tools/pr_ready.py --base origin/main` completed: 1205 Rust tests +and 291 Python tests passed, as did rustfmt, Clippy and documentation checks. +Its parity phase failed after the historical-world setup interruption described +above, so the overall self-check is **not green**. A subsequent `parity.py --changed origin/main --timeout 1500` selected 160 +harnesses, 151 requiring runs. Three completed and passed (`firework_tooltip`, +`held_drop`, `interaction_input`). Both integration wrappers exceeded that +invocation's 25-minute per-harness deadline: friends was waiting for the shared +GPU lock, and LAN was still executing cases. Automatic retries were stopped and +the detached game processes cleaned up. The remaining affected harnesses did not +complete. This is incomplete validation, not a passing corrected parity gate; +compilation is not a substitute for the gameplay failures above. + +The final source self-check, `python3 tools/pr_ready.py --quick`, passed 1205 Rust +tests, 291 Python tests, rustfmt, Clippy and documentation checks. After correcting +the integration build arguments to name each binary (so traced selection includes +`game.rs` and `game/integrated.rs`), the named client/control/relay build and 38 +focused Python tests passed. Dependency extraction from the real Cargo dep-info +confirmed both game files are selected. + +## Limitations recorded before the follow-up fixes + +These were the remaining blockers when this ledger was first written; the +completion runs below record their status after the follow-up fixes. + +- Server-player footsteps do not reach sculk sensors. `tick_entity_events` in + `game/sculk.rs` emits player motion events from `Game.player`; the integrated + server's players live in its guest hub. The in-frame host passes and its guest + fails too, separating this shared server-player gap from the deterministic rule + oracle. A fix needs per-player event identity/state rather than weakening the test. +- The server-thread host takes fireball damage in deflection; the equivalent + in-frame check passes. Client-visible and authoritative projectile state diverge + during the synchronization investigation. No gameplay fix is included. +- Command completion fails in both modes as described above; it is not reported + as a passing fallback comparison. +- Full-sequence swings, vehicle, inventory-retention and fishing failures need + further fixture/state investigation. Swings and both vehicles passed isolated + reruns; that evidence does not establish a gameplay defect or a full-suite pass. + +No failing case is skipped, expectation relaxed, or existing timeout increased to +hide these results. At that stage the PR stayed draft with these coverage blockers. + +## Combined validation before the gameplay split (2026-10-25) + +Merged `main` at `bd591f985` and resolved the overlapping motion, projectile and +test-driver changes. The shared projectile inertia helper retains main's custom +acceleration power, with a regression test. Integration environments now call +`lab.game_env`; the friends entry point delegates its actual launches to that +isolated driver. The dedicated-server process keeps one environment argument, +and the control-tool connection test uses a scratch home rather than reading +the player's No AI setting. + +The first complete run after that merge executed **119 cases: 114 passed, +five failed, zero skipped**. Failures were `swings`, `flight`, `boats`, +`minecarts` and `keepinv`. All the additional regression cases from main passed. +Command completion, deflection, fishing and both sensor/dispenser input roles +also passed in that full sequence. + +The failures exposed fixture setup, input cadence and an off-hand clearing bug: + +- Aim at the hoe target's top face, observe that target, then send a normal + mouse click. Keep the exact one-swing/farmland assertion. A subsequent full + repeat passed flight and both vehicle checks but still failed the hoe case; + it was stopped after identifying the root cause rather than counted as green. + The earlier explosion case leaves an off-hand shield, and `/clear` omitted + that slot. Vanilla correctly blocks hoe use with that shield. Follow + `Inventory.clearOrCountMatchingItems`, `getContainerSize`, `getItem` and its + equipment-slot mapping: clear off-hand items and visit armor feet to head. + New oracle cases cover off-hand counting, partial/full removal and limited + armor-slot ordering. The explosion-then-swings sequence passes after this fix. +- Keep the original double-jump key sequence and seven-tick flight rule; run + this tick-sensitive case at four ticks per second so IPC scheduling on a busy + machine cannot stretch the input past that window. Restore 20 TPS afterward. +- Deliver the original ten vehicle punches and two-tick waits over one control + connection. Separate process launches had stretched the gaps to ten ticks, + letting the vehicle's damage decay before the next hit. +- Protect inactive inventory-test players after the low-health totem case, + assert that the active player is alive before the intended death, and provide + a full floor under scattered death drops. A targeted retry with the old small + platform lost a helmet over its edge; both players' exact drop/retention + assertions passed with the larger floor. + +Targeted server-thread reruns passed all five corrected cases, plus totems, +fishing and both sensor input roles. Friends passed plain LAN, direct invites, +the local relay and ended-invite rejection. The six focused parity harnesses +passed: `command_exec`, `dispenser`, `sculk`, `dedicated_server`, +`server_entities` and `server_player_damage`. + +The normal-runner full repeat also exposed an XP observation race: the guest +had already collected all 21 points before the two-tick in-flight snapshot +(`seen=0`, with the correct XP gain and no remaining orbs). Freeze spawning, +step two world ticks, observe the tracked orbs, then unfreeze for the original +pickup assertions. The targeted check passed with three visible orbs and +exactly 21 points; the full runner restarted with that correction. + +That repeat passed the former XP, swings, flight, boat and minecart failures, +but its level-ticking subcase found a wandering pig on a neighboring block at +Y=66 instead of the landing floor at Y=65. The armor stand landed correctly. +This subcase measures falling and simultaneous level ticking. Each level now +gets a full clear landing/walking area, retaining the pigs' normal AI. A +hazard-then-levels rerun confirmed that both pigs and armor stands land at the +expected heights with distinct entity IDs across levels. + +The broader parity invocation completed **116/117 runs passed**. The remaining +`tab_list` comparison matched 998/1000 lists and all 400 skin images. Both +list mismatches contained `Ⅻ`: the oracle's bitmap-only font setup used the +missing glyph instead of vanilla's Unicode fallback. Load the full default font +reference chain from the prepared assets with vanilla's provider definitions +and default option filters. Prefetch the fake skin lookups together before the +unchanged one-second observation window, retaining deliberately pending cases. +A fresh rerun passed **1000/1000 lists, 3510 frames and 400/400 skin images**, +with zero oracle errors. Fresh secure-chat and dimension-player parity reruns +passed after the command fix as well. The extended command oracle matched all +**843 command/callback records**. + +Rechecking the shared font helper passed eight of nine additional harnesses; +`pack_screen` matched 2778/3000 cases with its old bitmap-only oracle. Its +newline/control glyph metrics also require the Unicode fallback (the newline +advance is 9 with the full font, 6 with the bitmap-only setup). Give this oracle +the same full default font and prepared asset root. A fresh rerun matched +**3000/3000 pack screens**, with zero oracle errors and unchanged comparisons. + +The source self-check passed **1237 Rust tests and 270 Python tests**, rustfmt, +Clippy and doc tests. The private resource copy contains both pinned reports +and a regular `facts.json`, as required by the resource-isolation regression. +Prepared historical test worlds were copied into the ignored fixture cache +where available; they are not player saves or committed resources. + +The final in-frame comparison passed **14/14 cases, zero skipped**: commands, +deflection, both sensor roles, flight, swings, boats, minecarts, chest, prediction, +signs, both dispenser roles and inventory retention. A separate in-frame XP +comparison passed with three visible orbs and exactly 21 points. Friends and +the dedicated-server harness passed through the normal parity runner. + +The final normal-runner server-thread LAN repeat passed **119/119 cases, +zero skipped**, in 1940 seconds. This full sequence includes all earlier failure +cases, both sensor/dispenser roles and the additional regressions from main. +The final full `python3 tools/pr_ready.py` gate passed against merge base +`bd591f985`: **1237 Rust tests, 270 Python tests**, rustfmt, Clippy, public-tree +checks and documentation tests. Its parity stage selected **118 affected +harnesses**; 117 had current content-matched passing records and the remaining +harness passed during the gate. No failed or skipped harness remained. +The gate reported the existing scope warning (35 files, 584 lines of code); +the combined migration exceeded the suggested 500-line size. At that point +the combined PR was marked ready for review. The split below supersedes that +readiness status and the earlier description block. + + +## Gameplay fixes split into independent PRs (2026-10-25) + +At the user's request, the three gameplay fixes were removed from this PR's +net diff and opened independently against `main`: + +- [#1903](https://github.com/ludovic111/horizon/pull/1903): `/clear` off-hand + handling and vanilla inventory-slot order, including the added command-oracle + cases. The independent branch matches **843/843 command/callback records**. +- [#1904](https://github.com/ludovic111/horizon/pull/1904): connected-client + fireball motion and authoritative corrections, including the acceleration + regression and a focused `remote_fireball` integration harness. The new + harness fails on unchanged main in both hosting modes and passes with only + that gameplay fix applied. +- [#1905](https://github.com/ludovic111/horizon/pull/1905): per-player sculk + emission and history, including a focused `server_player_sculk` integration + harness. Without the fix, both server-thread players and the in-frame guest + fail while the in-frame host passes. With only this fix, **4/4 cases** pass, + along with **435/435 vanilla scenarios matching on every tick**. + +Each independent branch passes the quick source self-check using +`lab.game_env()` scratch homes (287 Python tests; 1241 Rust tests for clear +and sculk, 1242 for fireballs; formatting, Clippy and doc tests). Their broader +parity selections are listed for CI, rather than claimed as standalone full +parity passes. + +The migration was merged with main at `8177a6f45` before removing the fixes. +Its test migration, fixture synchronization, isolated environments, control +inspection and font-oracle corrections remain. The **119/119 full LAN pass** +and full affected-parity readiness result above belong to the combined +pre-extraction snapshot `cc9410b6`; they do not establish that the migration +alone passes after the gameplay code has been removed. This PR stays draft +until the three dependencies land and its full integration suite is rerun. + +The post-split migration quick source gate passes **1241 Rust tests and 290 +Python tests**, formatting, Clippy, public-tree and doc checks. It lists **70 +affected parity harnesses** for CI. Full post-split integration validation is +pending the three gameplay dependencies; no replacement full-suite pass is +claimed here. diff --git a/mods/horizon/src/test/java/dev/horizonlab/parity/ParityFont.java b/mods/horizon/src/test/java/dev/horizonlab/parity/ParityFont.java index 09e9911d6..3390b37f6 100644 --- a/mods/horizon/src/test/java/dev/horizonlab/parity/ParityFont.java +++ b/mods/horizon/src/test/java/dev/horizonlab/parity/ParityFont.java @@ -10,6 +10,8 @@ import java.nio.charset.StandardCharsets; import java.nio.file.Path; import java.util.ArrayList; import java.util.List; +import java.util.HashSet; +import java.util.Set; import net.minecraft.client.gui.Font; import net.minecraft.client.gui.GlyphSource; import net.minecraft.client.gui.font.glyphs.BakedGlyph; @@ -31,9 +33,13 @@ import net.minecraft.util.RandomSource; */ public final class ParityFont { public static ResourceManager resources() throws Exception { + return resources(Path.of("/nonexistent-horizon-assets")); + } + + public static ResourceManager resources(Path assets) throws Exception { var method = net.minecraft.client.resources.ClientPackSource.class.getDeclaredMethod("createVanillaPackSource", Path.class); method.setAccessible(true); - var pack = (net.minecraft.server.packs.VanillaPackResources) method.invoke(null, Path.of("/nonexistent-horizon-assets")); + var pack = (net.minecraft.server.packs.VanillaPackResources) method.invoke(null, assets); return pack.asResourceManager(); } @@ -50,6 +56,38 @@ public final class ParityFont { } } } + return create(providers); + } + + /** The full default font, including references and the external Unihex fallback. */ + public static Font createDefault(ResourceManager resources) throws Exception { + List providers = new ArrayList<>(); + loadProviders(resources, Identifier.withDefaultNamespace("default"), providers, new HashSet<>()); + return create(providers); + } + + private static void loadProviders(ResourceManager resources, Identifier font, List providers, + Set visiting) throws Exception { + if (!visiting.add(font)) throw new IllegalArgumentException("Cyclic font reference: " + font); + var file = font.withPath("font/" + font.getPath() + ".json"); + try (var reader = new InputStreamReader(resources.open(file), StandardCharsets.UTF_8)) { + var json = JsonParser.parseReader(reader).getAsJsonObject(); + for (var element : json.getAsJsonArray("providers")) { + var conditional = GlyphProviderDefinition.Conditional.CODEC.parse(JsonOps.INSTANCE, element).getOrThrow(); + if (!conditional.filter().apply(Set.of())) continue; + var definition = conditional.definition().unpack(); + if (definition.left().isPresent()) { + providers.add(definition.left().orElseThrow().load(resources)); + } else { + loadProviders(resources, definition.right().orElseThrow().id(), providers, visiting); + } + } + } finally { + visiting.remove(font); + } + } + + private static Font create(List providers) { GlyphSource source = new GlyphSource() { @Override public BakedGlyph getGlyph(int codepoint) { diff --git a/mods/horizon/src/test/java/dev/horizonlab/parity/VanillaPackScreenOracle.java b/mods/horizon/src/test/java/dev/horizonlab/parity/VanillaPackScreenOracle.java index 9b3509e94..d3513d3ac 100644 --- a/mods/horizon/src/test/java/dev/horizonlab/parity/VanillaPackScreenOracle.java +++ b/mods/horizon/src/test/java/dev/horizonlab/parity/VanillaPackScreenOracle.java @@ -370,7 +370,7 @@ public final class VanillaPackScreenOracle { unsafeField.setAccessible(true); unsafe = unsafeField.get(null); allocate = unsafe.getClass().getMethod("allocateInstance", Class.class); - font = ParityFont.create(ParityFont.resources()); + font = ParityFont.createDefault(ParityFont.resources(Path.of(args[2]))); Minecraft mc = alloc(Minecraft.class); put(mc, Minecraft.class, "font", font); put(mc, Minecraft.class, "lastInputType", InputType.MOUSE); diff --git a/mods/horizon/src/test/java/dev/horizonlab/parity/VanillaTabListOracle.java b/mods/horizon/src/test/java/dev/horizonlab/parity/VanillaTabListOracle.java index b48d45041..532c8823c 100644 --- a/mods/horizon/src/test/java/dev/horizonlab/parity/VanillaTabListOracle.java +++ b/mods/horizon/src/test/java/dev/horizonlab/parity/VanillaTabListOracle.java @@ -230,7 +230,7 @@ public final class VanillaTabListOracle { unsafeField.setAccessible(true); unsafe = unsafeField.get(null); allocate = unsafe.getClass().getMethod("allocateInstance", Class.class); - Font font = ParityFont.create(ParityFont.resources()); + Font font = ParityFont.createDefault(ParityFont.resources(Path.of(args[2]))); var gson = new Gson(); var out = new StringBuilder(); for (String line : Files.readAllLines(Path.of(args[0]))) { @@ -284,6 +284,8 @@ public final class VanillaTabListOracle { put(mc, Minecraft.class, "user", user); var skins = skinManager(c); put(mc, Minecraft.class, "skinManager", skins); + var profiles = new ArrayList(); + var lookups = new ArrayList>(); for (var p : c.getAsJsonArray("players")) { var o = p.getAsJsonObject(); var uuid = UUID.fromString(o.get("uuid").getAsString()); @@ -296,12 +298,22 @@ public final class VanillaTabListOracle { : new Property("textures", t.get("value").getAsString(), sig.getAsString())); } var profile = new GameProfile(uuid, o.get("name").getAsString(), new PropertyMap(properties)); - // Let the lookup's unpacking and downloads run before the first frame, - // as they would have by the time a player list shows. - try { - skins.get(profile).get(1, java.util.concurrent.TimeUnit.SECONDS); - } catch (java.util.concurrent.TimeoutException pending) { - } + profiles.add(profile); + lookups.add(skins.get(profile)); + } + // Start every lookup before waiting: intentionally pending fake + // downloads must not add a second for each player in the list. + // Keep the same observation window and leave those futures pending. + try { + CompletableFuture.allOf(lookups.toArray(CompletableFuture[]::new)) + .get(1, java.util.concurrent.TimeUnit.SECONDS); + } catch (java.util.concurrent.TimeoutException pending) { + } + int profileIndex = 0; + for (var p : c.getAsJsonArray("players")) { + var o = p.getAsJsonObject(); + var profile = profiles.get(profileIndex++); + var uuid = profile.id(); var info = new PlayerInfo(profile, false); put(info, PlayerInfo.class, "gameMode", GameType.byId(o.get("gameMode").getAsInt())); put(info, PlayerInfo.class, "latency", o.get("latency").getAsInt()); diff --git a/tests/test_game_home.py b/tests/test_game_home.py index b4d9e017f..b0561a9a2 100644 --- a/tests/test_game_home.py +++ b/tests/test_game_home.py @@ -29,6 +29,7 @@ EXEMPT = { "build_release.py": "builds and packs the release", "release_train.py": "release bookkeeping", "pr_ready.py": "runs cargo checks and parity.py", + "test_friends_integration_parity.py": "builds binaries; test_friends.Game isolates every game through integration_env", "port_harness.py": "ports Java code, starts no game", } diff --git a/tests/test_integration_env.py b/tests/test_integration_env.py new file mode 100644 index 000000000..07ba97a1b --- /dev/null +++ b/tests/test_integration_env.py @@ -0,0 +1,50 @@ +"""Automated game runs must never inherit a real player's data directories.""" +import json +import os +from pathlib import Path +import sys +import tempfile +import unittest + +from tools.integration_env import game_environment, run_game, require_server_reports + + +class IntegrationEnvironmentTests(unittest.TestCase): + def test_all_data_homes_and_network_settings_are_overridden(self): + keys = ('HORIZON_HOME', 'HORIZON_LAUNCHER_HOME', 'XDG_DATA_HOME', 'XDG_CONFIG_HOME') + with tempfile.TemporaryDirectory() as root: + env = game_environment({**dict.fromkeys(keys, '/real/player'), 'DISPLAY': ':123'}, root) + homes = [Path(env[key]) for key in keys] + self.assertEqual(len(set(homes)), 4) + self.assertTrue(all(p.is_dir() and p.is_relative_to(root) for p in homes)) + self.assertEqual(env['DISPLAY'], ':123') + self.assertEqual(env['HORIZON_TELEMETRY_URL'], 'off') + self.assertEqual(env['HORIZON_LAUNCHER_NO_SELF_UPDATE'], '1') + self.assertEqual(env['HORIZON_NO_AUDIO'], '1') + + def test_each_fixture_process_gets_fresh_homes_and_cleanup(self): + script = ('import json, os; from pathlib import Path; ' + 'homes = [os.environ[k] for k in ' + '("HORIZON_HOME", "HORIZON_LAUNCHER_HOME", "XDG_DATA_HOME", "XDG_CONFIG_HOME")]; ' + 'assert all(Path(p).is_dir() for p in homes); print(json.dumps(homes))') + runs = [json.loads(run_game([sys.executable, '-c', script], env=os.environ, + capture_output=True, text=True, check=True).stdout) for _ in range(2)] + self.assertFalse(set(runs[0]) & set(runs[1])) + self.assertTrue(all(not Path(p).exists() for homes in runs for p in homes)) + + +class PreparedReportTests(unittest.TestCase): + def test_partial_report_install_shadows_complete_fallback(self): + with tempfile.TemporaryDirectory() as root: + resources = Path(root) / 'horizon-client' / '26.3' + fallback = Path(root) / 'datagen' / 'out' / 'reports' + resources.mkdir(parents=True) + fallback.mkdir(parents=True) + for name in ('registries.json', 'commands.json'): + (fallback / name).write_text('{}') + self.assertEqual(require_server_reports(resources).resolve(), fallback) + (resources / 'registries.json').write_text('{}') + with self.assertRaisesRegex(ValueError, 'installed together'): + require_server_reports(resources) + (resources / 'commands.json').write_text('{}') + self.assertEqual(require_server_reports(resources), resources) diff --git a/tools/agent_control_e2e.py b/tools/agent_control_e2e.py index 7f0c52bce..116aed49b 100644 --- a/tools/agent_control_e2e.py +++ b/tools/agent_control_e2e.py @@ -75,6 +75,8 @@ def game_env(screen, home=None): extra['HORIZON_HOME'] = home if sys.platform == 'darwin': return lab.game_env(**extra) + if not shutil.which('vscreen') and os.environ.get('DISPLAY'): + 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 diff --git a/tools/integration_env.py b/tools/integration_env.py new file mode 100644 index 000000000..ed7122c1e --- /dev/null +++ b/tools/integration_env.py @@ -0,0 +1,54 @@ +"""Per-process scratch data for game integration tests (never a player's home).""" +from pathlib import Path +from contextlib import contextmanager +import os +import subprocess +import tempfile + +try: + from . import lab +except ImportError: + import lab + + +def game_environment(base, root): + root = Path(root) + env = dict(base, HORIZON_TELEMETRY_URL='off') + for key, folder in [('HORIZON_HOME', 'home'), ('HORIZON_LAUNCHER_HOME', 'launcher'), + ('XDG_DATA_HOME', 'data'), ('XDG_CONFIG_HOME', 'config')]: + path = root / folder + path.mkdir(parents=True, exist_ok=True) + env[key] = str(path) + return lab.game_env(env) + + +def run_game(command, **kwargs): + """Run a headless game fixture with the same isolation as real-client tests.""" + with tempfile.TemporaryDirectory(prefix='hz-fixture-') as root: + kwargs['env'] = game_environment(kwargs.pop('env', os.environ), root) + if any(key in kwargs['env'] for key in + ('HORIZON_COMMAND_SCRIPT', 'HORIZON_DISPENSE_FIXTURE', 'HORIZON_SCULK_FIXTURE')): + # These compare seeded rule/callback traces, not the client/server boundary. + command = [*command, '--in-frame'] + return subprocess.run(command, **kwargs) + + +@contextmanager +def suite_lock(): + """Real-client CI suites share a GPU, even when parity.py runs harnesses in parallel.""" + import fcntl + with (Path(tempfile.gettempdir()) / 'horizon-integration-gpu.lock').open('a') as lock: + fcntl.flock(lock, fcntl.LOCK_EX) + yield + + +def require_server_reports(resources): + """Match Builtin.find: a registry report shadows later fallback directories.""" + resources = Path(resources) + reports = next((p for p in (resources, resources / '../../datagen/out/reports', + resources / '../datagen/out/reports') + if (p / 'registries.json').is_file()), None) + if reports is None or not (reports / 'commands.json').is_file(): + raise ValueError(f'incomplete prepared resources in {resources}: registries.json and ' + 'commands.json must be installed together; prepare the pinned resources again') + return reports diff --git a/tools/lan_e2e.py b/tools/lan_e2e.py index f79e07033..ec3b58913 100755 --- a/tools/lan_e2e.py +++ b/tools/lan_e2e.py @@ -1,7 +1,8 @@ #!/usr/bin/env python3 """LAN multiplayer end to end: a host opens its world to LAN and a guest joins, both real games. -Two Horizon clients run side by side under horizon-ctl, each in its own scratch folder. The host +The host uses its integrated server thread by default; --in-frame compares the fallback, and +--server-thread remains accepted. Two Horizon clients run under horizon-ctl in scratch folders. The host creates a survival world and opens it to LAN with commands allowed; the guest connects to it by address. The script then checks, from both sides, what a guest's game used to get wrong (#366): @@ -268,7 +269,6 @@ import math import os import re import shutil -import signal import subprocess import sys import tempfile @@ -280,11 +280,12 @@ from pathlib import Path sys.path.insert(0, str(Path(__file__).resolve().parent)) from agent_control_e2e import Cli, Failed, game_env # noqa: E402 import lab # noqa: E402 +from integration_env import game_environment, require_server_reports # noqa: E402 ROOT = Path(__file__).resolve().parents[1] GUEST_NAME = 'Guest' -# The host plays single player on its server thread (--server-thread). -SERVER_THREAD = False +# Match normal single player; --in-frame is the comparison path. +SERVER_THREAD = True CHECKS = ['tab', 'self', 'armour', 'nametags', 'walls', 'chest', 'crafting', 'sign', 'damage', 'mobs', 'hazards', 'pvp', 'arrows', 'kills', 'hurt', 'looks', 'leads', 'respawn', 'containers', 'feedback', 'titles', 'chat', 'styles', 'commands', 'recipes', 'machines', 'brewing', 'loom', 'stonecutter', 'grindstone', 'anvil', 'smithing', 'enchanting', 'beacon', 'crafter', 'lectern', 'cartography', 'trials', 'clicks', 'sleep', 'predict', 'push', 'eat', 'eating', 'xp', 'objects', 'projectiles', 'thrown', 'sparks', 'hud', 'sidebar', 'border', 'particles', 'worn', 'blast', 'barter', 'deflect', 'fireball', 'light', 'time', 'swings', 'cracks', 'plates', 'effects', 'portals', 'distance', 'growth', 'doors', 'flight', 'ladder', 'boats', 'minecarts', 'frames', 'hands', 'lightning', 'riding', 'mounts', 'worldspawn', 'beds', 'shield', 'deathmining', 'contacts', 'absorption', 'breath', 'lava', 'levels', 'drops', 'underwater'] @@ -298,6 +299,7 @@ class Game: 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'), home=self.work / 'home') + env = game_environment(env, self.work) self.d = Cli(ctl, self.socket, self.work, env) self.d.name = name @@ -323,6 +325,28 @@ class Game: def wait(self, ticks): self.d('wait', ticks=ticks) + def script(self, lines): + """Keep tick-sensitive input in one ctl process, through the normal control commands.""" + result = subprocess.run(self.d.base + ['script'], input='\n'.join(lines) + '\n', + cwd=self.work, env=self.d.env, capture_output=True, text=True, + timeout=600) + replies = [json.loads(line) for line in result.stdout.splitlines() if line.strip()] + ticks = [r['ticks'] for r in replies if 'ticks' in r] + print(f'[{self.name}] script {lines} -> {replies[-1] if replies else result.stderr[:400]}; ticks={ticks}') + assert result.returncode == 0 and replies and not any('error' in r for r in replies), result.stdout + return replies[-1] + + def until(self, observe, predicate, ticks=100): + """Wait for an observable answer, within the existing tick budget.""" + last = observe() + for _ in range(ticks): + if predicate(last): + return last + self.wait(1) + last = observe() + assert predicate(last), f'{self.name}: state did not arrive within {ticks} ticks: {last}' + return last + def close(self): try: self.d('quit') @@ -530,6 +554,8 @@ def check_sign(host, guest, out): host.shot(out, 'sign') assert placed and 'sign' in placed, f'the guest placed {placed}' host_unaffected(host, "the guest's sign") + guest.raw('key', 'esc', 'tap') + guest.raw('wait-for', 'screen', 'playing') return placed @@ -674,7 +700,7 @@ def check_levels(host, guest, out): for name, step in LEVEL_STEPS: try: steps[name] = step(host, guest, out) - except (Failed, AssertionError, StopIteration, KeyError) as e: + except (Failed, AssertionError, StopIteration, KeyError, TypeError, IndexError) as e: steps[name], failed = repr(e), failed + [name] for g in (host, guest): back_to_game(g) @@ -747,10 +773,12 @@ def level_ticking(host, guest, out): has its own id across the levels.""" gx, gy, gz = pos_of(guest) hx, hy, hz = pos_of(host) - # A floor of its own beside the host (earlier checks may have broken the open one there). - bx, by, bz = int(hx // 1), int(hy // 1), int(hz // 1) - host('command', command=f'fill {bx - 4} {by - 1} {bz - 4} {bx + 4} {by - 1} {bz - 2} minecraft:stone') - host('command', command=f'fill {bx - 4} {by} {bz - 4} {bx + 4} {by + 4} {bz - 2} minecraft:air') + # Clear the whole walking area in each level: normal pig AI can leave a + # narrow landing strip during the fall/observation window. + for game, x, y, z in ((host, hx, hy, hz), (guest, gx, gy, gz)): + bx, by, bz = int(x // 1), int(y // 1), int(z // 1) + game('command', command=f'fill {bx - 12} {by - 1} {bz - 12} {bx + 12} {by - 1} {bz + 12} minecraft:stone') + game('command', command=f'fill {bx - 12} {by} {bz - 12} {bx + 12} {by + 6} {bz + 12} minecraft:air') guest('command', command=f'summon minecraft:pig {gx + 2.5:.2f} {gy + 3:.2f} {gz:.2f}') guest('command', command=f'summon minecraft:armor_stand {gx - 2.5:.2f} {gy + 3:.2f} {gz:.2f}') host('command', command=f'summon minecraft:pig {hx + 2.5:.2f} {hy + 3:.2f} {hz - 3:.2f}') @@ -762,6 +790,7 @@ def level_ticking(host, guest, out): mobs = [m for m in g.raw('mobs', 8)['near'] if m['kind'] == 'minecraft:pig'] stands = [o for o in g('status')['objects'] if o['kind'] == 'minecraft:armor_stand'] seen[name] = {'pigs': [(m['id'], round(m['pos'][1], 2)) for m in mobs], + 'pig_positions': [m['pos'] for m in mobs], 'stands': [(o['id'], round(o['position'][1], 2)) for o in stands], 'floor': floor} finally: guest('command', command='kill @e[type=!minecraft:player,distance=..8]') @@ -1979,12 +2008,11 @@ def chat_input(game): def complete(guest, text): """Opens the chat on `/`, types `text` and presses Tab: the input after it.""" guest.raw('key', 'slash', 'tap') - guest.wait(3) + guest.until(lambda: guest('screen').get('screen'), lambda s: s == 'chat', ticks=3) guest.raw('type', text) - guest.wait(2) + guest.until(lambda: guest('screen').get('chat_suggestions'), bool, ticks=2) guest.raw('key', 'tab', 'tap') - guest.wait(2) - return chat_input(guest) + return guest.until(lambda: chat_input(guest), lambda value: value != '/' + text, ticks=2) def check_commands(host, guest, out): @@ -2394,7 +2422,8 @@ def check_predict(host, guest, out): seen = {} creaks = lambda game: sum(n for s, n in game('status')['heard'].items() if 'door' in s) heard = {'guest': creaks(guest), 'host': creaks(host)} - os.kill(host.pid, signal.SIGSTOP) + host.raw('server-hold', 'on') + held_at = host.raw('simulation')['game_time'] try: guest.raw('interact', *wood) seen['guest_frozen'] = (state(guest, wood), state(guest, (wood[0], wood[1] + 1, wood[2]))) @@ -2402,8 +2431,9 @@ def check_predict(host, guest, out): seen['guest_heard_frozen'] = creaks(guest) - heard['guest'] guest.raw('interact', *iron) seen['guest_iron_frozen'] = state(guest, iron) + assert host.raw('simulation')['game_time'] == held_at, 'server barrier advanced the world' finally: - os.kill(host.pid, signal.SIGCONT) + host.raw('server-hold', 'off') guest.wait(20) seen['guest_after'] = state(guest, wood) seen['host_after'] = state(host, wood) @@ -2515,7 +2545,11 @@ def check_swings(host, guest, out): guest.wait(10) guest.raw('select', 'minecraft:wooden_hoe') before = guest('state')['swings'] - guest.raw('interact', *soil) + guest.raw('look-at', soil[0] + 0.5, soil[1] + 1, soil[2] + 0.5) + guest.wait(1) + target = guest('state')['looking_at']['block'] + assert target and target['pos'] == list(soil) and target['face'] == 'up', target + guest.raw('mouse', 'right', 'click') guest.wait(10) hoe = {'swings': guest('state')['swings'] - before, 'soil': host.raw('block', *soil)['block']} guest('command', command=f'setblock {soil[0]} {soil[1]} {soil[2]} minecraft:stone') @@ -2622,16 +2656,22 @@ def check_xp(host, guest, out): x, y, z = pos_of(guest) # Three orbs of 7 points 4 blocks east of the guest (out of reach, within the 8 blocks orbs # follow from): they fly to the guest. + # Freeze setup so command/IPC latency cannot let all three be collected + # before the two-tick in-flight observation. + host('command', command='tick freeze') for _ in range(3): guest('command', command=f'summon minecraft:experience_orb {x + 4:.2f} {y + 0.5:.2f} {z:.2f} {{Value:7s}}') + host('command', command='tick step 2') guest.wait(2) seen = remote(guest).get('entities', {}).get('minecraft:experience_orb', 0) guest.shot(out, 'xp-orbs') + host('command', command='tick unfreeze') guest.wait(60) xp = guest('state')['player']['xp'] host_xp = host('state')['player']['xp'] left = remote(guest).get('entities', {}).get('minecraft:experience_orb', 0) finally: + host('command', command='tick unfreeze') host('command', command='gamemode survival') # Back where it stood: a spectator sinks (Player.travel keeps 0.6 of its fall speed each tick, # about 0.2 blocks from standing), and a later check that makes it survival again would land @@ -2657,9 +2697,7 @@ def check_time(host, guest, out): guest.wait(20) # A stalled game runs at most 10 missed ticks when it wakes (DeltaTracker); the server's # game time, sent every second, moves the guest's clock on (ClientClockManager.tick). - os.kill(guest.pid, signal.SIGSTOP) - time.sleep(4) - os.kill(guest.pid, signal.SIGCONT) + guest.raw('stall', 4000) guest.wait(60) stalled = times() detail = {'paused': paused, 'after_stall': stalled} @@ -3112,12 +3150,10 @@ def same_light(host, guest, lo, hi, what, ticks=100): def check_flight(host, guest, out): def double_jump(game): # LocalPlayer.aiStep: a second jump press within 7 ticks of the first toggles flight. + lines = [] for hold in (1, 4): - game.raw('key', 'space', 'down') - game.wait(hold) - game.raw('key', 'space', 'up') - game.wait(2) - game.wait(10) + lines += ['key space down', f'wait {hold}', 'key space up', 'wait 2'] + game.script(lines + ['wait 10']) return game('state')['player'] def set_mode(game, mode): @@ -3132,6 +3168,9 @@ def check_flight(host, guest, out): players = [('guest', guest)] + ([('host', host)] if SERVER_THREAD else []) seen = {} + # The rule is seven simulation ticks, independent of wall time. A slow + # server clock leaves enough time to deliver the key events even on busy CI. + host('command', command='tick rate 4') try: for name, game in players: set_mode(game, 'creative') @@ -3145,6 +3184,7 @@ def check_flight(host, guest, out): 'stayed': round(later['position'][1] - up['position'][1], 2), 'survival_flying': fell['flying']} finally: + host('command', command='tick rate 20') for _, game in players: game('command', command='gamemode survival') for name, s in seen.items(): @@ -3659,15 +3699,16 @@ def leave_vehicle(player, kind): def break_vehicle(player, vehicle_id, kind): """Hit it with fists until it breaks: VehicleEntity.tick takes 1 off its damage every tick.""" - for _ in range(10): - here = [o for o in player('status')['objects'] if o['id'] == vehicle_id] - if not here: - return - vp = here[0]['position'] - player.raw('look-at', f'{vp[0]:.2f}', f'{vp[1] + 0.3:.2f}', f'{vp[2]:.2f}') - player.raw('mouse', 'left', 'click') - player.wait(2) - raise AssertionError(f'ten hits left the {kind} in place') + here = [o for o in player('status')['objects'] if o['id'] == vehicle_id] + if not here: + return + vp = here[0]['position'] + # Keep the original ten hits/two-tick spacing in one connection. Starting + # several ctl processes per hit lets the vehicle's damage decay between hits. + player.script([f'look-at {vp[0]:.2f} {vp[1] + 0.3:.2f} {vp[2]:.2f}', + *[line for _ in range(10) for line in ('mouse left click', 'wait 2')]]) + assert not any(o['id'] == vehicle_id for o in player('status')['objects']), \ + f'ten hits left the {kind} in place' def check_boats(host, guest, out): @@ -4311,10 +4352,8 @@ def check_deflect(host, guest, out): (Player.attack: AIM_DEFLECT on #redirectable_projectile; Ghast.isReflectedFireball). The ghast is caged (a window toward the host); the game runs at 4 ticks a second, and once the fireball is within 4.5 blocks the host looks at the ghast and clicks.""" - if SERVER_THREAD: - # The fireball's position and the host's hurts are read from the host's own level. - return 'skipped (in-frame only)' - x, y, z = (int(v // 1) for v in pos_of(host)) + back = pos_of(host) + x, y, z = (int(v // 1) for v in back) guest('command', command='gamemode creative') host('command', command='gamemode survival') host('command', command='difficulty normal') @@ -4335,23 +4374,36 @@ def check_deflect(host, guest, out): try: deadline = time.monotonic() + 120 while time.monotonic() < deadline: - balls = [q for q in host.raw('status')['projectiles'] if q['kind'] == 'LargeFireball'] + # Aim and click at the projectile the client actually sees. Holding + # non-player simulation keeps the reach window open while ordinary + # player input and its attack packet cross the connection. + balls = [q for q in host('status')['projectiles'] if q['kind'] == 'LargeFireball'] near = min((math.dist(q['position'], eye) for q in balls), default=None) if near is not None and near < 4.5: + ball = min(balls, key=lambda q: math.dist(q['position'], eye)) + host('command', command='tick freeze') + held_tick = host.raw('simulation')['game_time'] g = [m['pos'] for m in host.raw('mobs', 60).get('near', []) if m['kind'].endswith('ghast')][0] - host.raw('look-at', f'{g[0]:.2f}', f'{g[1] + 2:.2f}', f'{g[2]:.2f}') - host.raw('mouse', 'left', 'down') - host.raw('mouse', 'left', 'up') + host.script([f'look-at {g[0]:.2f} {g[1] + 2:.2f} {g[2]:.2f}', + 'wait 1', 'mouse left click', 'wait 1']) + host.until(lambda: host.raw('simulation')['projectiles'], + lambda qs: any(q.get('id') == ball['id'] and q.get('player_owned') for q in qs), + ticks=60) + assert host.raw('simulation')['game_time'] == held_tick, 'the deflection barrier advanced simulation' + host('command', command='tick unfreeze') turned = near break host('command', command='tick rate 20') host.wait(60) ghast = [m for m in host.raw('mobs', 60).get('near', []) if m['kind'].endswith('ghast') and m['health'] > 0] - hurt = [h for pl in host.raw('hurtlog')['players'] if pl['name'] == 'host' for h in pl['hurts'] + hurt = [h for pl in host.raw('hurtlog')['players'] if pl['name'] == (host.player if SERVER_THREAD else 'host') for h in pl['hurts'] if 'fireball' in h['source'] or 'explosion' in h['source']] finally: + host('command', command='tick unfreeze') host('command', command='tick rate 20') host('command', command='kill @e[type=minecraft:ghast]') + host('command', command=f'tp @s {back[0]} {back[1]} {back[2]}') + host.until(lambda: pos_of(host), lambda p: math.dist(p, back) < 0.1) host('command', command=f'fill {gx - 3} {gy - 1} {gz - 3} {gx + 24} {gy + 8} {gz + 3} minecraft:air') guest('command', command='gamemode survival') assert turned is not None, f'no fireball came within 4.5 blocks (nearest {near})' @@ -4537,8 +4589,22 @@ def run(ctl, out, resources, checks): guest.shot(out, 'joined') for name in checks: try: - results[name] = {'pass': True, 'detail': CHECK_FNS[name](host, guest, out)} - except (Failed, AssertionError, StopIteration, KeyError) as e: + # Cases assert their own deaths, menus and held actions before returning. + # Do not let those states turn later independent cases into false failures. + for game in (host, guest): + game.raw('release') + back_to_game(game) + state = game('state') + assert state.get('player') is not None, f'{game.name} lost its session before {name}: {state}' + if state.get('screen') == 'dead' or state['player']['health'] <= 0: + game.raw('respawn') + game.until(lambda: game('state'), + lambda s: s.get('screen') == 'playing' and s['player']['health'] > 0, + ticks=40) + detail = CHECK_FNS[name](host, guest, out) + skipped = isinstance(detail, str) and detail.startswith('skipped') + results[name] = {'pass': not skipped, 'skipped': skipped, 'detail': detail} + except (Failed, AssertionError, StopIteration, KeyError, TypeError, IndexError) as e: results[name] = {'pass': False, 'detail': repr(e)} for g in (host, guest): back_to_game(g) @@ -4557,14 +4623,19 @@ def main(): parser.add_argument('--bin-dir', help='prebuilt horizon-client and horizon-ctl (default: build with the fast profile)') parser.add_argument('--check', action='append', choices=CHECKS, help='run only these checks (repeatable)') parser.add_argument('--out', default=str(ROOT / '.local/lan-e2e'), help='screenshots and game logs go here') - parser.add_argument('--server-thread', action='store_true', help="the host's world runs on its server thread") + mode = parser.add_mutually_exclusive_group() + mode.add_argument('--server-thread', dest='server_thread', action='store_true', default=True, + help='host on its server thread (default; retained for existing callers)') + mode.add_argument('--in-frame', dest='server_thread', action='store_false', + help='host the world in the window, for comparison') args = parser.parse_args() global SERVER_THREAD SERVER_THREAD = args.server_thread if args.bin_dir: bins = Path(args.bin_dir).resolve() else: - subprocess.run(['cargo', 'build', '--locked', '--profile', 'fast', '-p', 'horizon-client', '--bins'], + subprocess.run(['cargo', 'build', '--locked', '--profile', 'fast', '-p', 'horizon-client', + '--bin', 'horizon-client', '--bin', 'horizon-ctl'], cwd=ROOT, check=True) meta = json.loads(subprocess.run(['cargo', 'metadata', '--format-version', '1', '--no-deps'], cwd=ROOT, capture_output=True, text=True, check=True).stdout) @@ -4572,9 +4643,16 @@ def main(): resources = lab.RESOURCES.resolve() if not (resources / 'horizon-resources.json').exists(): sys.exit(f'no prepared resources in {resources}') - out = Path(args.out) + try: + require_server_reports(resources) + except ValueError as error: + sys.exit(str(error)) + out = Path(args.out).resolve() out.mkdir(parents=True, exist_ok=True) + print(f'LAN host mode: {"server-thread" if SERVER_THREAD else "in-frame"}') results = run(bins / 'horizon-ctl', out, resources, args.check or CHECKS) + (out / 'results.json').write_text(json.dumps({'mode': 'server-thread' if SERVER_THREAD else 'in-frame', + 'checks': results}, indent=2) + '\n') print(json.dumps(results, indent=1)) sys.exit(0 if results and all(r['pass'] for r in results.values()) else 1) @@ -4631,16 +4709,33 @@ def check_keep_inventory(host, guest, out): neither; with it on, nothing drops and it respawns with both (#1284).""" hx, hy, hz = (int(v // 1) for v in pos_of(host)) seen = {} + # Totem coverage leaves both players near one health. Protect the waiting + # player from residual fire/damage while the other player's death is tested. + for game in (host, guest): + game('command', command='gamemode creative') + game('command', command='effect clear @s') + game('command', command='effect give @s minecraft:instant_health 1 5 true') host('command', command=f'setworldspawn {hx} {hy} {hz}') host('command', command='gamerule respawn_radius 0') + # Keep the inactive player alive and away from the death drops. Earlier + # fixtures may leave a personal respawn point or an unsafe waiting position. + host('command', command=f'fill {hx - 6} {hy - 1} {hz - 6} {hx + 6} {hy - 1} {hz + 6} minecraft:stone') + host('command', command=f'fill {hx - 6} {hy} {hz - 6} {hx + 6} {hy + 3} {hz + 6} minecraft:air') + for game, dz in ((host, -3), (guest, 3)): + waiting = (hx - 3.5, hy, hz + dz + 0.5) + game('command', command=f'spawnpoint @s {hx} {hy} {hz}') + game('command', command=f'tp @s {waiting[0]} {waiting[1]} {waiting[2]}') + game.until(lambda: pos_of(game), lambda p: math.dist(p, waiting) < 0.1) try: for keep in ('false', 'true'): host('command', command=f'gamerule keep_inventory {keep}') for game, dz in ((host, -3), (guest, 3)): # 14 blocks from the world spawn: nothing dropped is picked up on respawning. x, z = hx + 14, hz + dz - host('command', command=f'fill {x - 2} {hy - 1} {z - 1} {x + 2} {hy - 1} {z + 1} minecraft:stone') - host('command', command=f'fill {x - 2} {hy} {z - 1} {x + 2} {hy + 2} {z + 1} minecraft:air') + # Death drops scatter several blocks before landing. Keep the + # entire observation area solid so they cannot fall off a ledge. + host('command', command=f'fill {x - 6} {hy - 1} {z - 6} {x + 6} {hy - 1} {z + 6} minecraft:stone') + host('command', command=f'fill {x - 6} {hy} {z - 6} {x + 6} {hy + 3} {z + 6} minecraft:air') host('command', command='kill @e[type=minecraft:item]') game('command', command='gamemode survival') game('command', command='clear @s') @@ -4648,8 +4743,10 @@ def check_keep_inventory(host, guest, out): game('command', command='item replace entity @s armor.head with minecraft:iron_helmet') game('command', command=f'tp @s {x + 0.5} {hy} {z + 0.5}') game.wait(20) + assert game('state').get('screen') == 'playing', f'{game.name} died during setup' game('command', command='kill @s') game.wait(30) + assert game('state').get('screen') == 'dead', f'{game.name} did not die' dropped = sorted((e['item']['item'], e['item']['count']) for e in game.raw('entities', 8, 'minecraft:item')['entities']) game.shot(out, f'keepinv-{keep}') @@ -4659,12 +4756,14 @@ def check_keep_inventory(host, guest, out): seen[f'{game.name}-keep-{keep}'] = { 'dropped': dropped, 'kept': {item: server_count(game, item) for item in ('diamond', 'iron_helmet')}} + game('command', command='gamemode creative') finally: host('command', command='gamerule keep_inventory false') host('command', command='gamerule respawn_radius 10') host('command', command='kill @e[type=minecraft:item]') for game in (host, guest): game('command', command='clear @s') + game('command', command='gamemode survival') face_each_other(host, guest) for case, s in seen.items(): want = ({'dropped': [], 'kept': {'diamond': 7, 'iron_helmet': 1}} if case.endswith('true') else @@ -4682,6 +4781,16 @@ def check_signs(host, guest, out): seen = {} for game, other, dz in ((host, guest, -2), (guest, host, 2)): spot = (hx + 2, hy, hz + dz) + for viewer in (game, other): + back_to_game(viewer) + # Earlier death/travel checks leave the players at different spawn points. + # Give this placement case its own floor, line of sight and reachable target. + host('command', command=f'fill {spot[0] - 3} {hy - 1} {spot[2] - 1} {spot[0] + 3} {hy - 1} {spot[2] + 1} minecraft:stone') + host('command', command=f'fill {spot[0] - 3} {hy} {spot[2] - 1} {spot[0] + 3} {hy + 3} {spot[2] + 1} minecraft:air') + for viewer, dx in ((game, -2), (other, 2)): + at = (spot[0] + dx + 0.5, hy, spot[2] + 0.5) + viewer('command', command=f'tp @s {at[0]} {at[1]} {at[2]}') + viewer.until(lambda: pos_of(viewer), lambda p: math.dist(p, at) < 0.1) game('command', command=f'setblock {spot[0]} {spot[1] - 1} {spot[2]} minecraft:stone') game('command', command=f'setblock {spot[0]} {spot[1]} {spot[2]} minecraft:air') game('command', command='gamemode survival') @@ -4689,7 +4798,12 @@ def check_signs(host, guest, out): game('command', command='give @s minecraft:oak_sign 1') game.wait(10) game.raw('place', *spot, '--item', 'minecraft:oak_sign') - game.wait(10) + game.until(lambda: game('state').get('screen'), lambda s: s == 'sign', ticks=10) + # Drain the placement's initial block-entity data before typing. The + # reply travels on the same connection after that data, unlike a local + # screen check which may see the editor before the initial data arrives. + server_reply(game, f'data get block {spot[0]} {spot[1]} {spot[2]} front_text.messages', + 'following block data') opened = {g.name: g('state').get('screen') for g in (game, other)} game.shot(out, 'signs-editor') lines = [f'{game.name} wrote', 'line two'] @@ -4697,11 +4811,13 @@ def check_signs(host, guest, out): game.raw('key', 'enter', 'tap') game.raw('type', lines[1]) game.raw('key', 'esc', 'tap') - game.wait(20) + game.until(lambda: game('state').get('screen'), lambda s: s == 'playing', ticks=20) back_to_game(other) + shown = {g.name: g.until(lambda: (g.raw('block', *spot).get('sign') or {}).get('front'), + lambda front: front == lines + ['', ''], ticks=20) + for g in (game, other)} seen[game.name] = {'opened': opened, - 'shown': {g.name: (g.raw('block', *spot).get('sign') or {}).get('front') - for g in (game, other)}} + 'shown': shown} other.shot(out, 'signs-shown') for name, s in seen.items(): other = 'guest' if name == 'host' else 'host' @@ -5052,8 +5168,12 @@ def check_fishing(host, guest, out): tracked to the clients as a fishing bobber under its owner), lands on the ground and reels back in; cast into open water with Lure III, a fish bites and reeling in during the bite catches it for 1 (#1348).""" + # Both players need a safe floor for the entire other player's fishing wait. + apart(host, guest) hx, hy, hz = (int(v // 1) for v in pos_of(host)) host('command', command='weather clear') + for game in (host, guest): + game('command', command='effect give @s minecraft:instant_health 1 5 true') seen = {} try: for game, other, dz in ((host, guest, -5), (guest, host, 5)): @@ -5369,12 +5489,8 @@ def check_digging(host, guest, out): before = heard('minecraft:block.stone.break') guest.raw('look-at', *at(stone)) guest.raw('mouse', 'left', 'down') - time.sleep(0.4) - os.kill(guest.pid, signal.SIGSTOP) - try: - time.sleep(1.0) - finally: - os.kill(guest.pid, signal.SIGCONT) + guest.wait(8) + guest.raw('stall', 1000) resumed = {'guest': guest.raw('block', *stone).get('block'), 'server': host.raw('block', *stone).get('block'), 'mining': guest('state').get('mining')} # Let go once it breaks: past it the crosshair reaches the floor. @@ -5534,6 +5650,68 @@ CHECKS += ['knockback'] CHECK_FNS.update(knockback=check_knockback) + +def check_fixture_input(host, guest, out, kind, role): + """Complement seeded rules with real client input and authoritative observations.""" + player = host if role == 'host' else guest + hx, y, hz = (int(v // 1) for v in pos_of(host)) + x, z = hx + 6, hz + (-8 if role == 'host' else 8) + sensor, dispenser, button = (x + 3, y, z + 1), (x, y, z + 3), (x, y, z + 2) + player('command', command='gamemode survival') + player('command', command='item replace entity @s weapon.mainhand with minecraft:air') + host('command', command=f'fill {x - 2} {y - 1} {z - 2} {x + 5} {y - 1} {z + 5} minecraft:stone') + host('command', command=f'fill {x - 2} {y} {z - 2} {x + 5} {y + 3} {z + 5} minecraft:air') + start = (x + 0.5, y, z + 0.5) + player('command', command=f'tp @s {start[0]} {start[1]} {start[2]} 0 0') + player.until(lambda: pos_of(player), lambda p: math.dist(p, start) < 0.1) + player.raw('look', 0, 0) + try: + if kind == 'sculk': + player.wait(2) # finish setup movement before installing the listener + host.raw('setblock', *sensor, 'minecraft:sculk_sensor') + phase = lambda: host.raw('getblock', *sensor)['block'] + host.until(phase, lambda state: 'sculk_sensor_phase=inactive' in state) + player.wait(10) + assert 'sculk_sensor_phase=inactive' in phase(), 'setup activated the sensor before player input' + player.raw('key', 'w', 'down') + try: + player.wait(15) # defined input duration; no wall-clock simulation sleep + finally: + player.raw('key', 'w', 'up') + moved = {'client': math.dist(pos_of(player), start), + 'server': math.dist(server_player(host, player)['position'], start)} + assert all(d > 1 for d in moved.values()), f'{role} did not walk on both sides: {moved}' + active = host.until(phase, lambda state: 'sculk_sensor_phase=active' in state, ticks=85) + for viewer in (host, guest): + viewer.until(lambda: state_of(viewer, sensor, 'sculk_sensor_phase'), lambda v: v == 'active') + return {'moved': moved, 'phase': active} + host.raw('setblock', *dispenser, 'minecraft:dispenser[facing=east]') + host.raw('container', *dispenser, 'minecraft:diamond', 1) + host.raw('setblock', *button, 'minecraft:stone_button[face=wall,facing=north]') + player.until(lambda: player.raw('block', *button)['block'], lambda v: v == 'minecraft:stone_button') + player.raw('interact', *button) + slots = host.until(lambda: host.raw('container', *dispenser)['slots'], lambda v: all(s is None for s in v)) + dropped = {} + for viewer in (host, guest): + dropped[viewer.name] = viewer.until( + lambda: [e for e in viewer.raw('entities', 24, 'minecraft:item')['entities'] + if e.get('item', {}).get('item') == 'minecraft:diamond' + and math.dist(e['pos'], (x + 1.5, y + 0.5, z + 3.5)) < 3], + lambda drops: len(drops) == 1 and drops[0]['item']['count'] == 1) + player.shot(out, f'{kind}-input') + return {'slots': slots, 'drops': dropped} + finally: + player.raw('key', 'w', 'up') + host('command', command=f'fill {x - 2} {y} {z - 2} {x + 5} {y + 3} {z + 5} minecraft:air') + + +for _kind in ('sculk', 'dispenser'): + for _role in ('host', 'guest'): + _name = f'{_kind}_input_{_role}' + CHECKS.append(_name) + CHECK_FNS[_name] = lambda h, g, o, kind=_kind, role=_role: check_fixture_input(h, g, o, kind, role) + + def check_hero_trading(host, guest, out): """Villager.updateSpecialPrices keeps the trading player's Hero effect: the offer sent to the client and the server's payment consumption agree, independently of the other player's effect.""" diff --git a/tools/oracle_harness.py b/tools/oracle_harness.py index 92e2a26a2..787c8a293 100644 --- a/tools/oracle_harness.py +++ b/tools/oracle_harness.py @@ -9,13 +9,16 @@ import subprocess try: from . import lab, test_rust_parity as base, test_model_baking_parity as baking + from .integration_env import run_game except ImportError: import lab, test_rust_parity as base, test_model_baking_parity as baking + from integration_env import run_game def run_logged(command, build, name, timeout=900, **kwargs): with (build / (name + '.log')).open('w') as log: - subprocess.run([str(c) for c in command], cwd=lab.ROOT, check=True, timeout=timeout, + runner = run_game if Path(command[0]).name == 'horizon-client' else subprocess.run + runner([str(c) for c in command], cwd=lab.ROOT, check=True, timeout=timeout, stdout=log, stderr=subprocess.STDOUT, **kwargs) diff --git a/tools/test_command_exec_parity.py b/tools/test_command_exec_parity.py index 877bd0b38..5761ef485 100644 --- a/tools/test_command_exec_parity.py +++ b/tools/test_command_exec_parity.py @@ -25,9 +25,11 @@ import sys try: from . import lab, test_rust_parity as base + from .integration_env import run_game from . import command_exec_corpus as corpus_module except ImportError: import lab + from integration_env import run_game import test_rust_parity as base import command_exec_corpus as corpus_module @@ -55,7 +57,8 @@ def main(): def run(command, name, **kw): with (build / (name + '.log')).open('w', encoding='utf-8') as log: - result = subprocess.run(list(map(str, command)), stdout=log, stderr=subprocess.STDOUT, **kw) + runner = run_game if Path(command[0]).name == 'horizon-client' else subprocess.run + result = runner(list(map(str, command)), stdout=log, stderr=subprocess.STDOUT, **kw) if result.returncode: tail = (build / (name + '.log')).read_text(errors='replace')[-3000:] sys.exit(f'{name} failed ({result.returncode}):\n{tail}') diff --git a/tools/test_dedicated_server_parity.py b/tools/test_dedicated_server_parity.py index 49a934987..ee0eb46f5 100644 --- a/tools/test_dedicated_server_parity.py +++ b/tools/test_dedicated_server_parity.py @@ -65,13 +65,16 @@ import struct import subprocess import sys import threading +import tempfile import time import zlib try: from . import lab, oracle_harness as oh, test_rust_parity as base + from .integration_env import game_environment, run_game from .lab import free_port # the other server harnesses import it from here except ImportError: + from integration_env import game_environment, run_game import lab import oracle_harness as oh import test_rust_parity as base @@ -124,9 +127,11 @@ class Server: self.log_path = directory.parent / f'{log_name}.log' self.log = self.log_path.open('w', encoding='utf-8') self.lines = [] - self.process = subprocess.Popen(list(map(str, command)), cwd=directory, stdin=subprocess.PIPE, + self.scratch = tempfile.TemporaryDirectory(prefix='hz-server-') + env = game_environment(os.environ, self.scratch.name) + self.process = subprocess.Popen(list(map(str, command)), cwd=directory, env=env, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, text=True, - encoding='utf-8', errors='replace', env=lab.game_env()) + encoding='utf-8', errors='replace') self.reader = threading.Thread(target=self._read, daemon=True) self.reader.start() @@ -163,6 +168,7 @@ class Server: self.process.wait() self.reader.join(timeout=10) self.log.close() + self.scratch.cleanup() def settle(server, ticks=600, timeout=600): @@ -359,7 +365,7 @@ def horizon_client_joins(vanilla_server, binary, world, build, reference): server.wait_for(r'Done \(') 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, + run_game([str(c) for c in [binary, '--resources', lab.RESOURCES, '--render-distance', 2, '--server', f'127.0.0.1:{port}', '--name', PLAYER]], cwd=client_dir, env=env, stdout=log, stderr=subprocess.STDOUT, timeout=300, check=True) server.wait_for(r'left the game', timeout=30) diff --git a/tools/test_dispenser_parity.py b/tools/test_dispenser_parity.py index a6d1f429a..04f599e34 100644 --- a/tools/test_dispenser_parity.py +++ b/tools/test_dispenser_parity.py @@ -17,7 +17,9 @@ import random import subprocess try: from . import block_update_harness as h, lab, test_rust_parity as base + from .integration_env import run_game except ImportError: + from integration_env import run_game import block_update_harness as h import lab import test_rust_parity as base @@ -349,7 +351,8 @@ def voice(line): def run(command, **kwargs): - done = subprocess.run(command, capture_output=True, text=True, **kwargs) + runner = run_game if str(command[0]).endswith('/horizon-client') else subprocess.run + done = runner(command, capture_output=True, text=True, **kwargs) if done.returncode: print((done.stdout + done.stderr)[-4000:]) raise SystemExit(f'{command[0]} failed') diff --git a/tools/test_friends.py b/tools/test_friends.py index cc5d15b92..fd3d626a9 100644 --- a/tools/test_friends.py +++ b/tools/test_friends.py @@ -15,8 +15,9 @@ is off: nothing leaves the machine. python3 tools/test_friends.py --client target/fast/horizon-client --relay target/fast/horizon-relay -`--server-thread` runs the host's world on its integrated server's own -thread (the window is a client of it, as Open to LAN publishes it). +The host runs on its integrated server thread by default (the window is a +client of it). `--in-frame` compares the fallback; `--server-thread` is accepted +for compatibility. `--role host|guest` runs one side only (two machines, e.g. over a tailnet): the host prints the code, the guest takes it with `--code` (`--relay-url` @@ -36,8 +37,10 @@ import urllib.request try: from . import lab + from .integration_env import game_environment, require_server_reports except ImportError: import lab + from integration_env import game_environment, require_server_reports ROOT = Path(__file__).resolve().parents[1] @@ -84,7 +87,7 @@ class Game: prefix = [] extra = [] # The host's world on its server thread (`--server-thread`), else in the window. - server_thread = False + server_thread = True def __init__(self, client, resources, work, name, env): # Either way explicitly, whatever the game's default. @@ -96,7 +99,8 @@ 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=lab.game_env(HORIZON_HOME=self.home, **env), + ] + Game.extra, cwd=self.home, + env={**game_environment({**os.environ, **env}, self.home), 'HORIZON_HOME': str(self.home)}, stdout=self.log, stderr=subprocess.STDOUT) wait_for(self.endpoint, 'screen', lambda v: v['screen'] == 'title', 120, f'{name} title') @@ -149,10 +153,11 @@ def play_together(host, guest, name, round_index): before = guest_pos(host, name) guest('look 0 0') guest('key w down') - time.sleep(1.5) - guest('key w up') - host.wait('lan status', lambda v: math.dist(before, next(g['position'] for g in v['guests'] if g['name'] == name)) > 1.0, - 20, 'guest movement on the host') + try: + host.wait('lan status', lambda v: math.dist(before, next(g['position'] for g in v['guests'] if g['name'] == name)) > 1.0, + 20, 'guest movement on the host') + finally: + guest('key w up') # The host moves; the guest sees the host's player there. hp = host('status')['player']['position'] target = [hp[0] + 3.0, hp[1], hp[2] + 1.0] @@ -179,10 +184,11 @@ def play_together(host, guest, name, round_index): guest.wait('status', lambda v: v['target']['pos'] == block, 10, 'the guest aiming at the block') # Held for a few ticks, as a player clicks (creative breaks at once). guest('mouse left down') - time.sleep(0.25) - guest('mouse left up') - host.wait(f'getblock {block[0]} {block[1]} {block[2]}', lambda v: v['block'] == 'minecraft:air', 20, - 'the guest breaking the block, on the host') + try: + host.wait(f'getblock {block[0]} {block[1]} {block[2]}', lambda v: v['block'] == 'minecraft:air', 20, + 'the guest breaking the block, on the host') + finally: + guest('mouse left up') guest.wait(f'getblock {block[0]} {block[1]} {block[2]}', lambda v: v['block'] == 'minecraft:air', 20, 'the broken block on the guest') @@ -250,7 +256,7 @@ def full(args, work): join(guest, code, 'Guest') play_together(host, guest, 'Guest', 1) assert host('friends status')['direct'] == 1, host('friends status') - print('code alone: chat, movement and blocks both ways, no server involved') + print('code alone: chat, movement and blocks both ways, no relay involved') leave(host, guest, 'Guest') host('friends stop') assert host('friends status')['code'] is None @@ -316,8 +322,8 @@ def one_side(args, work): if args.role == 'host': code = host_world(game) print(f'CODE {code}', flush=True) - game.wait('lan status', lambda v: v['guests'], args.wait, 'a guest') - game.wait('lan status', lambda v: not v['guests'], args.wait, 'the guest leaving') + game.wait('lan status', lambda v: any(g['name'] == 'Remote' for g in v['guests']), args.wait, 'a guest') + game.wait('lan status', lambda v: all(g['name'] != 'Remote' for g in v['guests']), args.wait, 'the guest leaving') print(f'host: {game("friends status")}') else: join(game, args.code, 'Remote') @@ -347,16 +353,25 @@ def main(): parser.add_argument('--hold', type=float, default=0, help='guest: stay this many seconds before leaving') parser.add_argument('--baseline', action='store_true', help='first run the same checks over plain LAN') parser.add_argument('--offscreen', action='store_true', help='run the games without a window') - parser.add_argument('--server-thread', action='store_true', help="the host's world on its server thread") + mode = parser.add_mutually_exclusive_group() + mode.add_argument('--server-thread', dest='server_thread', action='store_true', default=True, + help='host on its server thread (default; retained for existing callers)') + mode.add_argument('--in-frame', dest='server_thread', action='store_false', + help='host the world in the window, for comparison') parser.add_argument('--xvfb', action='store_true', help='run the games under xvfb-run (headless Linux)') args = parser.parse_args() Game.prefix = ['xvfb-run', '-a'] if args.xvfb else [] Game.extra = ['--offscreen'] if args.offscreen else [] Game.server_thread = args.server_thread args.client, args.resources = args.client.resolve(), args.resources.resolve() + try: + require_server_reports(args.resources) + except ValueError as error: + parser.error(str(error)) # Short: Unix socket paths are limited to about 100 bytes. with tempfile.TemporaryDirectory(prefix='hzf-', dir='/tmp') as directory: work = Path(directory) + print(f'Friends host mode: {"server-thread" if Game.server_thread else "in-frame"}') if args.role: return one_side(args, work) assert args.relay, 'give --relay (the relay binary, run locally for the relay half)' diff --git a/tools/test_friends_integration_parity.py b/tools/test_friends_integration_parity.py new file mode 100644 index 000000000..c97787803 --- /dev/null +++ b/tools/test_friends_integration_parity.py @@ -0,0 +1,30 @@ +#!/usr/bin/env python3 +"""Real clients over LAN, direct invitations and a local relay, with a server-thread host. + +Registered with parity.py so changes to the drivers and the game binary select +this integration coverage in CI as well as the deterministic library probes. +""" +import json +from pathlib import Path +import subprocess +import sys + +import lab +import test_friends +from integration_env import suite_lock + + +if __name__ == '__main__': + subprocess.run(['cargo', 'build', '--locked', '--profile', 'fast', '-p', 'horizon-client', + '-p', 'horizon-relay', '--bin', 'horizon-client', '--bin', 'horizon-ctl', + '--bin', 'horizon-relay'], cwd=lab.ROOT, check=True) + metadata = json.loads(subprocess.check_output( + ['cargo', 'metadata', '--format-version', '1', '--no-deps'], cwd=lab.ROOT, text=True)) + bins = Path(metadata['target_directory']) / 'fast' + sys.argv = [sys.argv[0], '--client', str(bins / 'horizon-client'), + '--relay', str(bins / 'horizon-relay'), '--baseline', + *(['--offscreen'] if sys.platform == 'darwin' else [])] + with suite_lock(): + # The wrapper only selects binaries; test_friends isolates each game + # through integration_env and lab.game_env. + test_friends.main() diff --git a/tools/test_lan_integration_parity.py b/tools/test_lan_integration_parity.py new file mode 100644 index 000000000..773a7cd82 --- /dev/null +++ b/tools/test_lan_integration_parity.py @@ -0,0 +1,14 @@ +#!/usr/bin/env python3 +"""Register the real-client LAN suite with parity.py's traced harness selection. + +The assertions live in lan_e2e; this is integration coverage, alongside the +fast vanilla differential probes. The host uses the normal server thread. +Linux runners need a display (for example xvfb-run -a). +""" +import lan_e2e +from integration_env import suite_lock + + +if __name__ == '__main__': + with suite_lock(): + lan_e2e.main() diff --git a/tools/test_online_mode_parity.py b/tools/test_online_mode_parity.py index d03838bf3..8096efd80 100644 --- a/tools/test_online_mode_parity.py +++ b/tools/test_online_mode_parity.py @@ -50,11 +50,13 @@ import urllib.parse try: from . import lab, oracle_harness as oh, test_rust_parity as base from .test_dedicated_server_parity import Server, free_port + from .integration_env import run_game except ImportError: import lab import oracle_harness as oh import test_rust_parity as base from test_dedicated_server_parity import Server, free_port + from integration_env import run_game NAME = 'online-mode-parity' PLAYER = 'Tester' @@ -185,7 +187,7 @@ def run_client(binary, build, port, label, token, discovery): if token: command += ['--session-file', session_file(directory, token)] with (build / f'client-{label}.log').open('w') as log: - subprocess.run([str(c) for c in command], cwd=directory, env=env, stdout=log, stderr=subprocess.STDOUT, + run_game([str(c) for c in command], cwd=directory, env=env, stdout=log, stderr=subprocess.STDOUT, timeout=300, check=True) got = json.loads(report.read_text()) got['session file left'] = (directory / 'session.json').exists() diff --git a/tools/test_pack_screen_parity.py b/tools/test_pack_screen_parity.py index 1f3f03ede..77249ec5e 100644 --- a/tools/test_pack_screen_parity.py +++ b/tools/test_pack_screen_parity.py @@ -147,7 +147,7 @@ def main(): run(['javac', '--release', lock['minecraft']['java_major'], '-proc:none', '-nowarn', '-cp', dependencies, '-d', classes, *(PARITY / f'{n}.java' for n in ('ParityData', 'ParityFont', 'VanillaPackScreenOracle'))], 'compile-java') run(['java', '-Xmx1G', '-cp', str(classes) + os.pathsep + dependencies, 'dev.horizonlab.parity.VanillaPackScreenOracle', - inputs, build / 'vanilla.jsonl'], 'vanilla') + inputs, build / 'vanilla.jsonl', lab.RESOURCES / 'assets'], 'vanilla') lib.cargo_example('horizon-client', 'pack_screen_fixture', lib.RESOURCES, inputs, build / 'rust.jsonl') vanilla = [json.loads(l) for l in (build / 'vanilla.jsonl').read_text().splitlines()] rust = [json.loads(l) for l in (build / 'rust.jsonl').read_text().splitlines()] diff --git a/tools/test_tab_list_parity.py b/tools/test_tab_list_parity.py index 4075859e7..3d7c84d62 100644 --- a/tools/test_tab_list_parity.py +++ b/tools/test_tab_list_parity.py @@ -240,7 +240,7 @@ def main(): run(['javac', '--release', lock['minecraft']['java_major'], '-proc:none', '-nowarn', '-cp', dependencies, '-d', classes, *(PARITY / f'{n}.java' for n in ('ParityData', 'ParityFont', 'VanillaTabListOracle', 'VanillaSkinImageOracle'))], 'compile-java') run(['java', '-Xmx2G', '-cp', str(classes) + os.pathsep + dependencies, 'dev.horizonlab.parity.VanillaTabListOracle', - inputs, build / 'vanilla.jsonl'], 'vanilla') + inputs, build / 'vanilla.jsonl', resources / 'assets'], 'vanilla') run(['cargo', 'run', '--quiet', '--profile', 'fast', '-p', 'horizon-client', '--example', 'client_probe', '--', 'tab_list_fixture', resources, inputs, build / 'rust.jsonl'], 'rust') images = build / 'skins.txt'; images.write_text(''.join(i + '\n' for i in skin_images(args.images))) From e50a4c6443ef1a8dcb997ef79fc47ab759c36f04 Mon Sep 17 00:00:00 2001 From: Kacpherek Date: Sun, 25 Oct 2026 20:57:18 +0100 Subject: [PATCH 07/28] Play no place sound when a block item placement is refused Clicking with a torch or flower into a space that is already taken (or where the block cannot stand) made the server-thread client play the block's place sound when the server resent the refused target. BlockItem.place returns FAIL before playSound when canPlace() is false, and the client only hears its own predicted placement, so clear the pending place sound when no placement was predicted. --- crates/horizon-client/src/game/remote.rs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/crates/horizon-client/src/game/remote.rs b/crates/horizon-client/src/game/remote.rs index 03b48df3d..97edae862 100644 --- a/crates/horizon-client/src/game/remote.rs +++ b/crates/horizon-client/src/game/remote.rs @@ -3905,6 +3905,10 @@ impl Game<'_> { if let Some(placed) = &placed { self.predict_place(placed, seq); self.with_hand(hand, Game::consume_held); + } else if let Some(r) = self.remote.as_mut() { + // BlockItem.place plays its sound only once the block is set: the + // server's resend of the target it refused is no placement. + r.placing = None; } if reacts || placed.is_some() { self.with_hand(hand, Game::swing_arm); From 9aa6d7723fd8297a91783c7fb3b6828b8205a81c Mon Sep 17 00:00:00 2001 From: Kacpherek Date: Sun, 25 Oct 2026 21:52:43 +0100 Subject: [PATCH 08/28] Shulker bullets home on the guest the shulker targets A mob that sees a guest (a LAN guest, or the player of the server thread) holds Who::Player as its target, and what it does to that player runs with the guest swapped in. A shulker's bullet, though, keeps the target it was fired with until it lands, and the projectiles tick outside that swap: there Who::Player is the host's own player, so on a server thread the bullet found no target, stopped homing and fell onto the blocks. The bullet now carries the guest's entity id, as ShulkerBullet.finalTarget holds the targeted entity in vanilla (ShulkerAttackGoal.tick passes Shulker.getTarget()), so it homes on the guest among the projectiles' targets and its hit runs as that guest: 4 damage and Levitation. --- crates/horizon-client/src/game/creatures.rs | 24 +++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/crates/horizon-client/src/game/creatures.rs b/crates/horizon-client/src/game/creatures.rs index f027a04fc..664f1f642 100644 --- a/crates/horizon-client/src/game/creatures.rs +++ b/crates/horizon-client/src/game/creatures.rs @@ -508,6 +508,17 @@ impl Game<'_> { Some(host) if !guests.is_empty() => std::mem::take(&mut host.mob_players), _ => Default::default(), }; + // The guests' entity ids by connection, for the shulker bullets fired + // at the guest a mob sees. + let guest_ids: Vec<(u32, u32)> = match self.lan.as_ref() { + Some(host) if !guests.is_empty() => host + .hub + .guests + .iter() + .map(|g| (g.conn, g.entity_id as u32)) + .collect(), + _ => Vec::new(), + }; let mut guest_events = Vec::new(); let level_random; { @@ -582,6 +593,19 @@ impl Game<'_> { let kept = m.tick(&w, &mut scratch, &mut events); horizon_client::mobs::take_mob_pushes(&mut events, from, &mut pushes); if let Some(conn) = seen_guest { + // ShulkerBullet.finalTarget is the guest's entity: the + // bullet homes on it while the projectiles tick, where + // `Who::Player` is the host's own player. + if let Some(&(_, id)) = guest_ids.iter().find(|g| g.0 == conn) { + for e in &mut events[from..] { + if let MobEvent::Projectile(p) = e + && let ProjectileKind::ShulkerBullet { target, .. } = &mut p.kind + && *target == Who::Player + { + *target = Who::Mob(id); + } + } + } let mut k = from; while k < events.len() { if super::lan_mobs::acts_on_player(&events[k]) { From 785e83feebb6bfcff4a28585113161e26f484af6 Mon Sep 17 00:00:00 2001 From: Kacpherek Date: Sun, 25 Oct 2026 21:31:31 +0100 Subject: [PATCH 09/28] Firework explosions hurt nearby players, not only the boosted one FireworkRocketEntity.dealExplosionDamage hurts every LivingEntity within 5 blocks that the rocket can see (its feet or its middle, ClipContext COLLIDER with no fluids), besides the entity it is attached to. Horizon only hurt the attached player and the nearby mobs, so a rocket bursting next to a player on foot did nothing to them, in both single player modes. The player (unless it is the attached one) and every guest in the level now take damageAmount * sqrt((5 - distanceTo) / 5) as fireworks damage, with the armor wear of hurtServer. distanceTo is a float, as vanilla computes it, for the mobs too. --- crates/horizon-client/src/game/fireworks.rs | 82 +++++++++++++++++---- crates/horizon-client/src/game/lan_mobs.rs | 14 +++- 2 files changed, 79 insertions(+), 17 deletions(-) diff --git a/crates/horizon-client/src/game/fireworks.rs b/crates/horizon-client/src/game/fireworks.rs index 7838c9590..2c98a12ad 100644 --- a/crates/horizon-client/src/game/fireworks.rs +++ b/crates/horizon-client/src/game/fireworks.rs @@ -71,6 +71,12 @@ impl Rocket { (self.position, self.velocity) } } +/// `damageAmount * (float)Math.sqrt((5.0 - this.distanceTo(target)) / 5.0)`, +/// `distanceTo` being a float. +fn blast_damage(damage: f32, distance_sqr: f64) -> f32 { + let distance = distance_sqr.sqrt() as f32; + damage * ((5.0 - f64::from(distance)) / 5.0).sqrt() as f32 +} pub(super) fn fireworks_of(stack: &ItemStack) -> (u8, Vec) { // The item's default component: flight 1, no explosions. stack @@ -251,21 +257,24 @@ impl Game<'_> { let at = [r.position.x, r.position.y, r.position.z]; if !r.explosions.is_empty() { let damage = 5.0 + r.explosions.len() as f32 * 2.0; - // The player it boosts takes the full damage, a guest as well. - if r.attached { - match r.guest { - None => self.hurt_player_by("minecraft:fireworks", damage), - Some(conn) => { - if let Some(mut host) = self.lan.take() { - self.as_guest(&mut host, conn, |g| { - g.hurt_player_by("minecraft:fireworks", damage); - }); - self.lan = Some(host); - } - } - } - } let from = r.position; + // `attachedToEntity` takes the full damage, a guest as well; every + // other player in range and in sight takes the blast. + let boosted = r.guest.filter(|_| r.attached); + if r.attached && boosted.is_none() { + self.rocket_hurt_player(damage); + } else { + self.rocket_blast_player(from, damage); + } + if let Some(conn) = boosted + && let Some(mut host) = self.lan.take() + { + self.as_guest(&mut host, conn, |g| g.rocket_hurt_player(damage)); + self.lan = Some(host); + } + // Every other player in the level (LAN guests, the players of a + // server thread), each swapped in as the player. + self.each_guest_hit_except(boosted, |g| g.rocket_blast_player(from, damage)); let hits: Vec<(u32, f32)> = { let world = self.mob_world_base(&[]); self.mobs @@ -285,7 +294,7 @@ impl Game<'_> { ); world.clear_between(from, to, false) }); - sees.then(|| (m.id, damage * ((5.0 - d2.sqrt()) / 5.0).sqrt() as f32)) + sees.then(|| (m.id, blast_damage(damage, d2))) }) .collect() }; @@ -307,6 +316,49 @@ impl Game<'_> { self.particles .fireworks(at, v, r.explosions.clone(), camera); } + /// `dealExplosionDamage` on a player that is not the rocket's + /// `attachedToEntity`: within 5 blocks, when the rocket sees its feet or + /// its middle (`ClipContext.Block.COLLIDER`, no fluids). + fn rocket_blast_player(&mut self, from: Vec3, damage: f32) { + let Some(p) = self.player.as_ref() else { + return; + }; + let feet = p.position; + let d2 = (feet.x - from.x).powi(2) + (feet.y - from.y).powi(2) + (feet.z - from.z).powi(2); + if d2 > 25.0 { + return; + } + let height = f64::from(p.dimensions.height); + let sees = { + let world = self.mob_world_base(&[]); + (0..2).any(|step| { + let to = Vec3::new(feet.x, feet.y + height * 0.5 * f64::from(step), feet.z); + world.clear_between(from, to, false) + }) + }; + if sees { + self.rocket_hurt_player(blast_damage(damage, d2)); + } + } + /// `hurtServer` with `damageSources().fireworks`: armor absorbs it and + /// wears (`hurtArmor`); creative and spectator players are immune. + fn rocket_hurt_player(&mut self, amount: f32) { + if self.creative || self.spectator() { + return; + } + let hurt = if let Some(p) = self.player.as_mut() + && !p.health.dead_or_dying() + && let Some(id) = self.motion.health.damage.id("minecraft:fireworks") + { + p.hurt(&self.motion.health, self.world.health_rules, id, amount) + .unwrap_or(false) + } else { + false + }; + if hurt { + self.hurt_armor(amount); + } + } /// `FireworkEntityRenderer.submit`: the item (GROUND) facing the camera, /// lit at the rocket's light probe. pub(super) fn rocket_geometry(&self, camera: glam::DVec3, alpha: f64, out: &mut Vec) { diff --git a/crates/horizon-client/src/game/lan_mobs.rs b/crates/horizon-client/src/game/lan_mobs.rs index be277b6e0..ee38869a4 100644 --- a/crates/horizon-client/src/game/lan_mobs.rs +++ b/crates/horizon-client/src/game/lan_mobs.rs @@ -119,7 +119,17 @@ impl Game<'_> { /// Runs `f` as each guest in play here, for what strikes every player in /// an area (`Level.getEntities`), not only the window's own. - pub(super) fn each_guest_hit(&mut self, mut f: impl FnMut(&mut Self)) { + pub(super) fn each_guest_hit(&mut self, f: impl FnMut(&mut Self)) { + self.each_guest_hit_except(None, f); + } + + /// [`Self::each_guest_hit`] leaving out the guest `except` (the one a + /// firework rocket is attached to, which it hurts on its own). + pub(super) fn each_guest_hit_except( + &mut self, + except: Option, + mut f: impl FnMut(&mut Self), + ) { let Some(mut host) = self.lan.take() else { return; }; @@ -127,7 +137,7 @@ impl Game<'_> { .hub .guests .iter() - .filter(|g| host.hub.here(g) && g.loaded && !g.dead) + .filter(|g| host.hub.here(g) && g.loaded && !g.dead && Some(g.conn) != except) .map(|g| g.conn) .collect(); for conn in conns { From 21019afc2bdfe37454fbe05a609de7ccffc8c5b4 Mon Sep 17 00:00:00 2001 From: Kacpherek Date: Sun, 25 Oct 2026 22:18:14 +0100 Subject: [PATCH 10/28] Vehicle storage menus edit the vehicle's own items A chest minecart, hopper minecart or chest boat's menu edits a stand-in container, which is meant to be copied back to the vehicle when the menu closes. close_container took the open container before calling close_cart_container, which then found nothing open and copied nothing: items taken out came back on the next open, and items put in vanished. Copy the stand-in back from the key close_container took. A server player's clicks in such a menu copy it back at once, since the menu is the vehicle's own inventory (ContainerEntity, AbstractMinecartContainer and ChestBoat implement the container the menu reads and writes). --- crates/horizon-client/src/game.rs | 3 +- crates/horizon-client/src/game/lan_actions.rs | 4 ++ crates/horizon-client/src/game/minecarts.rs | 37 +++++++++++++------ 3 files changed, 31 insertions(+), 13 deletions(-) diff --git a/crates/horizon-client/src/game.rs b/crates/horizon-client/src/game.rs index 1e6158bc4..021d8fa32 100644 --- a/crates/horizon-client/src/game.rs +++ b/crates/horizon-client/src/game.rs @@ -5472,6 +5472,8 @@ impl Game<'_> { self.craft_size = 2; self.craft_table = None; if let Some(key) = self.container.take() { + // A cart's or chest boat's items go back to it. + self.close_cart_container(key); self.container_opener_event(key, false); self.post_block_game_event( "minecraft:container_close", @@ -5511,7 +5513,6 @@ impl Game<'_> { self.world.modified.insert((key.0 >> 4, key.2 >> 4)); } self.close_ender_chest(); - self.close_cart_container(); } /// `quickMoveStack` of the open plain menu for a shift-click. fn inventory_quick_move(&mut self, slot: usize) -> bool { diff --git a/crates/horizon-client/src/game/lan_actions.rs b/crates/horizon-client/src/game/lan_actions.rs index 9d4d868e0..cd7d8035b 100644 --- a/crates/horizon-client/src/game/lan_actions.rs +++ b/crates/horizon-client/src/game/lan_actions.rs @@ -1138,6 +1138,10 @@ impl Game<'_> { { self.container_changed(key); } + // A vehicle's menu edits the vehicle's own items. + if let Some(Slots::Block(key)) = slots { + self.store_cart_items(key); + } self.drop_guest_items(host, gi, drops); } S::ContainerClose(p) => { diff --git a/crates/horizon-client/src/game/minecarts.rs b/crates/horizon-client/src/game/minecarts.rs index 6b8b51dde..004b72ebf 100644 --- a/crates/horizon-client/src/game/minecarts.rs +++ b/crates/horizon-client/src/game/minecarts.rs @@ -1117,22 +1117,35 @@ impl Game<'_> { self.swing_arm(); true } - /// Closing a cart's container copies the items back. - pub(super) fn close_cart_container(&mut self) { - let Some(key) = self.container.filter(|k| k.1 == CART_KEY_Y) else { - return; - }; - let Some(BlockEntity::Chest(items)) = self.world.block_entities.remove(&key) else { + /// Closing the cart's container open under `key` copies the items back. + pub(super) fn close_cart_container(&mut self, key: (i32, i32, i32)) { + if key.1 != CART_KEY_Y { + return; + } + self.store_cart_items(key); + self.world.block_entities.remove(&key); + if let Some(c) = self.carts.iter().find(|c| c.id as i32 == key.2) + && c.kind == CartKind::Chest + { + let at = [c.position.x, c.position.y, c.position.z]; + let pitch = self.world.random.next_float() * 0.1 + 0.9; + self.audio + .play("minecraft:block.chest.close", Some(at), 0.5, pitch); + } + } + /// The menu of a chest or hopper minecart or a chest boat works on the + /// vehicle's own items (`ContainerEntity`): the placeholder under `key` + /// that the menu edits is copied back to the vehicle. + pub(super) fn store_cart_items(&mut self, key: (i32, i32, i32)) { + if key.1 != CART_KEY_Y { + return; + } + let Some(BlockEntity::Chest(items)) = self.world.block_entities.get(&key) else { return; }; + let items = items.clone(); if let Some(c) = self.carts.iter_mut().find(|c| c.id as i32 == key.2) { c.items = items; - let at = [c.position.x, c.position.y, c.position.z]; - if c.kind == CartKind::Chest { - let pitch = self.world.random.next_float() * 0.1 + 0.9; - self.audio - .play("minecraft:block.chest.close", Some(at), 0.5, pitch); - } } else if let Some(b) = self.boats.iter_mut().find(|b| b.id as i32 == key.2) { b.items = items; } From f988ed417a70f61f285cadf00cc627afb56a0128 Mon Sep 17 00:00:00 2001 From: Kacpherek Date: Sun, 25 Oct 2026 21:41:32 +0100 Subject: [PATCH 11/28] Drop a pending server trip when its player is teleported within the level A server's player sent into another level waits on a trip until the chunks around its target load, and the server leaves its body alone and skips its portal checks until then. A /tp within the level while the arrival was still loading left that trip behind: its target lost its loading tickets and never finished, so Nether, End and gateway portals stopped taking the player until they went back to the abandoned spot. ServerPlayer.teleport within a level places the player at once, so the pending arrival is now abandoned. server-dimension-players gains the case: sent far into the Nether, teleported back near the origin before the far chunks load, then an End portal there. --- crates/horizon-client/src/game/commands.rs | 6 ++++++ tools/test_server_dimension_players_parity.py | 5 +++++ 2 files changed, 11 insertions(+) diff --git a/crates/horizon-client/src/game/commands.rs b/crates/horizon-client/src/game/commands.rs index 69c06d97e..585f8f357 100644 --- a/crates/horizon-client/src/game/commands.rs +++ b/crates/horizon-client/src/game/commands.rs @@ -1094,6 +1094,12 @@ impl Game<'_> { Target::Player => { // ServerPlayer.teleport: removeVehicle before placing the player. self.stop_riding(); + // A server's player teleported within their level is placed + // there at once: the arrival they were waiting for elsewhere + // in it (whose chunks lose their tickets) is abandoned. + if let Some(conn) = self.lan_acting { + self.server_trips.retain(|trip| !trip.is(conn)); + } if let Some(p) = self.player.as_mut() { p.position = v; p.velocity = Vec3::new(0.0, 0.0, 0.0); diff --git a/tools/test_server_dimension_players_parity.py b/tools/test_server_dimension_players_parity.py index b1efc4378..7ce04cb3f 100644 --- a/tools/test_server_dimension_players_parity.py +++ b/tools/test_server_dimension_players_parity.py @@ -41,6 +41,11 @@ SCRIPT = [ # Through an End portal (Entity.handlePortal), and back by command. ('bob-portal', ['cmd Bob setblock 2 101 3 minecraft:end_portal', 'cmd Bob tp @s 2.5 101 3.5']), ('bob-portal-back', [f'cmd Bob execute in {OVERWORLD} run tp @s 2.5 100 0.5']), + # Sent far into the Nether, then teleported within it before the far chunks load: a portal there + # still takes him (the abandoned arrival does not hold him). + ('bob-retarget', [f'cmd Bob execute in {NETHER} run tp @s 8192.5 100 0.5', 'cmd Bob tp @s 0.5 100 0.5']), + ('bob-retarget-portal', ['cmd Bob setblock 0 101 3 minecraft:end_portal', 'cmd Bob tp @s 0.5 101 3.5']), + ('bob-retarget-back', [f'cmd Bob execute in {OVERWORLD} run tp @s 2.5 100 0.5']), ] STEP_SECONDS = 5.0 From 2c0d9cc30efe46a2d1c39c9d06cb86b825ff840b Mon Sep 17 00:00:00 2001 From: Kacpherek Date: Sun, 25 Oct 2026 21:37:13 +0100 Subject: [PATCH 12/28] Tick End gateways' server copies on a server without a window A used End gateway never worked again on the server thread or on a dedicated server. TheEndGatewayBlockEntity's server ticker (portalTick) ran only inside the client block-entity pass, which returns at once when there is no renderer, so the 40 tick cooldown that EndGatewayBlock.entityInside starts (triggerCooldown) never ran out. A Game without a renderer now runs portalTick on the gateways it keeps a server copy of, in block-ticking chunks as Level.tickBlockEntities does, and sends triggerCooldown's block event every 2400 ticks of age. --- .../src/game/block_entity_anims.rs | 30 +++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/crates/horizon-client/src/game/block_entity_anims.rs b/crates/horizon-client/src/game/block_entity_anims.rs index 619fcd009..6df2ff02a 100644 --- a/crates/horizon-client/src/game/block_entity_anims.rs +++ b/crates/horizon-client/src/game/block_entity_anims.rs @@ -171,6 +171,11 @@ impl Game<'_> { /// client tick (`ClientLevel.tickBlockEntities`). pub(super) fn tick_block_entity_anims(&mut self) { let Some(r) = &self.renderer else { + // A server has no window, but its gateways still run their + // server ticker. + if self.remote.is_none() { + self.tick_gateway_servers(); + } return; }; // Sorted by position: the order they tick in, and a quick lookup. @@ -330,6 +335,31 @@ impl Game<'_> { } self.be_anims.present = positions; } + /// `TheEndGatewayBlockEntity.portalTick` (the server ticker) of the + /// gateways a server keeps a copy of, in block-ticking chunks + /// (`Level.tickBlockEntities`): the cooldown an entry started runs out, + /// and every 2400 ticks `triggerCooldown` sends its block event. + fn tick_gateway_servers(&mut self) { + let levels = self.tickets.levels(); + let mut positions: Vec<[i32; 3]> = self + .be_anims + .gateway_servers + .keys() + .copied() + .filter(|p| levels.block_ticking_at(p[0], p[2])) + .collect(); + positions.sort_unstable(); + for pos in positions { + let triggered = self + .be_anims + .gateway_servers + .get_mut(&pos) + .is_some_and(EndGateway::portal_tick); + if triggered { + self.block_entity_event(pos, 1, 0); + } + } + } /// `EndGatewayBlock.entityInside` on the server: whether the gateway at /// `pos` let the entity in (`triggerCooldown`, with its block event). pub(super) fn gateway_enter(&mut self, pos: [i32; 3]) -> bool { From c7432c21e152dfc566580a40917d092c227ac197 Mon Sep 17 00:00:00 2001 From: Kacpherek Date: Sun, 25 Oct 2026 22:39:25 +0100 Subject: [PATCH 13/28] Check a server player's moves with the box of its pose A player sprint-swimming up under a ceiling was sent back every tick on the server thread (and for LAN guests): the server never updated the player's pose, and handlePlayerPositionChange's collision check always used a standing 1.8-block box, so the 0.6-block swimming box the client moved with looked like it entered the ceiling. Player.tick ends with updatePlayerPose, and the check uses getBoundingBox, so run updatePlayerPose in the server player's tick and check moves with the pose's dimensions. Fixes #1899. --- crates/horizon-client/src/game/lan_actions.rs | 3 +++ crates/horizon-client/src/lan/hub.rs | 19 +++++++++++++------ 2 files changed, 16 insertions(+), 6 deletions(-) diff --git a/crates/horizon-client/src/game/lan_actions.rs b/crates/horizon-client/src/game/lan_actions.rs index 9d4d868e0..6dfc68c08 100644 --- a/crates/horizon-client/src/game/lan_actions.rs +++ b/crates/horizon-client/src/game/lan_actions.rs @@ -2111,6 +2111,9 @@ impl Game<'_> { let _ = w.tick_environment_damage(); let _ = w.apply_fire_contact(); let _ = w.server_hazards_tick(in_wall); + // Player.tick ends with updatePlayerPose: a swimmer, or a player + // crawling under a block, takes the short box its moves are checked with. + let _ = w.update_player_pose(); let mut events = std::mem::take(&mut w.player.events); // WitherRoseBlock.entityInside along those moves. for event in &events { diff --git a/crates/horizon-client/src/lan/hub.rs b/crates/horizon-client/src/lan/hub.rs index b462536b9..910911d80 100644 --- a/crates/horizon-client/src/lan/hub.rs +++ b/crates/horizon-client/src/lan/hub.rs @@ -2175,17 +2175,24 @@ impl Hub { if g.spectator() || g.sleeping { return (false, false); } - let height = if g.fall_flying { - 0.6 + // getBoundingBox: the box of the body's pose (swimming and crawling + // are 0.6 tall), so a swimmer under a ceiling isn't sent back. + let (half, height) = if g.fall_flying { + (0.3, 0.6) + } else if let Some(m) = &g.motion { + ( + f64::from(m.dimensions.width) / 2.0, + f64::from(m.dimensions.height), + ) } else if g.sneaking { - 1.5 + (0.3, 1.5) } else { - 1.8 + (0.3, 1.8) }; let at = |p: [f64; 3]| { Aabb::new( - Vec3::new(p[0] - 0.3, p[1], p[2] - 0.3), - Vec3::new(p[0] + 0.3, p[1] + height, p[2] + 0.3), + Vec3::new(p[0] - half, p[1], p[2] - half), + Vec3::new(p[0] + half, p[1] + height, p[2] + half), ) }; let (old, new) = (at(g.position), at(to)); From d143666e46d910ea7bbad51fa6765f26500c9e07 Mon Sep 17 00:00:00 2001 From: Kacpherek Date: Sun, 25 Oct 2026 22:14:43 +0100 Subject: [PATCH 14/28] Mark a server's player dead while its arrival in a level is loading A server's player on a trip into another level was skipped by tick_guests before its zero-health body was marked dead, so a death during the arrival (a /kill, damage) only counted once the destination had loaded. The client already showed the death screen, and a Respawn press in between was refused (guest_respawn wants a dead player) and then lost, leaving the player on the death screen until a second press. LivingEntity.hurt calls die at once, loaded or not: the death half of the guest tick is now its own guest_die, which also runs for a player on a trip. --- crates/horizon-client/src/game/lan_actions.rs | 123 +++++++++--------- 1 file changed, 65 insertions(+), 58 deletions(-) diff --git a/crates/horizon-client/src/game/lan_actions.rs b/crates/horizon-client/src/game/lan_actions.rs index 9d4d868e0..409dcb8e5 100644 --- a/crates/horizon-client/src/game/lan_actions.rs +++ b/crates/horizon-client/src/game/lan_actions.rs @@ -1777,6 +1777,10 @@ impl Game<'_> { continue; } if self.on_server_trip(conn) { + // LivingEntity.hurt kills at once (die), whether the level + // has loaded around the player or not: its respawn request + // is taken as soon as it comes. + self.guest_die(host, gi, conn); continue; } let play = host.play.entry(conn).or_default(); @@ -1851,69 +1855,72 @@ impl Game<'_> { self.guest_dig_feedback(host, conn); self.guest_pickups(host, gi); self.guest_orbs(host, gi); - if host.hub.guests[gi].health <= 0.0 && !host.hub.guests[gi].dead { - self.guest_forget_digging(host, conn); - // FishingHook.shouldStopFishing: its owner is dead. - if let Some(play) = host.play.get_mut(&conn) { - play.hook = None; - } + self.guest_die(host, gi, conn); + } + } + + /// `ServerPlayer.die` for a guest whose health has run out: the death + /// message, the loot and experience, the death screen. + fn guest_die(&mut self, host: &mut LanHost, gi: usize, conn: u32) { + if host.hub.guests[gi].health <= 0.0 && !host.hub.guests[gi].dead { + self.guest_forget_digging(host, conn); + // FishingHook.shouldStopFishing: its owner is dead. + if let Some(play) = host.play.get_mut(&conn) { + play.hook = None; } - let g = &mut host.hub.guests[gi]; - if g.health <= 0.0 && !g.dead { - g.dead = true; - g.last_death = Some(g.position.map(|v| v.floor() as i32)); - let (id, at) = (g.entity_id, g.position); - let reward = Experience { - level: g.xp_level, - progress: g.xp_progress, - total: g.xp_total, - } - .death_reward(self.ui.rules.bool("keep_inventory") || g.game_mode == SPECTATOR); - let (name, uuid) = (g.name.clone(), g.uuid); - // ServerPlayer.die: dropAllDeathLoot unless a spectator, from the eyes less 0.3. - let drops = (g.game_mode != SPECTATOR) - .then(|| [at[0], at[1] + g.eye_height() - 0.3, at[2]]); - let cause = host.play.get_mut(&conn).and_then(|p| p.death_cause.take()); - // ServerPlayer.die: with showDeathMessages, the message goes to - // the dying player's death screen and to everyone the team lets - // see it; without it, the death screen gets an empty one. - let message = if self.ui.rules.bool("show_death_messages") { - let me = self.player_text(&name, uuid); - let text = match cause { - Some(key) => horizon_client::text::Text::translate(&key, &[me]), - None if at[1] < f64::from(horizon_client::chunk::MIN_Y - 64) => { - horizon_client::text::Text::translate("death.attack.outOfWorld", &[me]) - } - None => self.guest_death_message(conn, me), - }; - let message = horizon_client::lan::data::component_nbt(&text.component()); - let team = self.score.board.players_team(&name); - if horizon_client::scoreboard::own_death_message_shown(team) { - host.hub.system_message(message.clone()); - if self.options.dedicated.is_some() { - super::dedicated::log( - "INFO", - &format!("System chat: {}", text.plain()), - ); - } else if self.player.is_some() { - self.system_message(text); - } + } + let g = &mut host.hub.guests[gi]; + if g.health <= 0.0 && !g.dead { + g.dead = true; + g.last_death = Some(g.position.map(|v| v.floor() as i32)); + let (id, at) = (g.entity_id, g.position); + let reward = Experience { + level: g.xp_level, + progress: g.xp_progress, + total: g.xp_total, + } + .death_reward(self.ui.rules.bool("keep_inventory") || g.game_mode == SPECTATOR); + let (name, uuid) = (g.name.clone(), g.uuid); + // ServerPlayer.die: dropAllDeathLoot unless a spectator, from the eyes less 0.3. + let drops = + (g.game_mode != SPECTATOR).then(|| [at[0], at[1] + g.eye_height() - 0.3, at[2]]); + let cause = host.play.get_mut(&conn).and_then(|p| p.death_cause.take()); + // ServerPlayer.die: with showDeathMessages, the message goes to + // the dying player's death screen and to everyone the team lets + // see it; without it, the death screen gets an empty one. + let message = if self.ui.rules.bool("show_death_messages") { + let me = self.player_text(&name, uuid); + let text = match cause { + Some(key) => horizon_client::text::Text::translate(&key, &[me]), + None if at[1] < f64::from(horizon_client::chunk::MIN_Y - 64) => { + horizon_client::text::Text::translate("death.attack.outOfWorld", &[me]) } - message - } else { - literal("") + None => self.guest_death_message(conn, me), }; - host.hub.send_to( - conn, - &C::PlayerCombatKill(play::PlayerCombatKill { id, message }), - ); - // LivingEntity.die: the death animation, the dying player included. - host.hub.entity_event(id, 3, at); - if let Some(eyes) = drops { - self.as_guest(host, conn, |game| game.drop_inventory(eyes)); + let message = horizon_client::lan::data::component_nbt(&text.component()); + let team = self.score.board.players_team(&name); + if horizon_client::scoreboard::own_death_message_shown(team) { + host.hub.system_message(message.clone()); + if self.options.dedicated.is_some() { + super::dedicated::log("INFO", &format!("System chat: {}", text.plain())); + } else if self.player.is_some() { + self.system_message(text); + } } - self.spawn_orbs(at, reward); + message + } else { + literal("") + }; + host.hub.send_to( + conn, + &C::PlayerCombatKill(play::PlayerCombatKill { id, message }), + ); + // LivingEntity.die: the death animation, the dying player included. + host.hub.entity_event(id, 3, at); + if let Some(eyes) = drops { + self.as_guest(host, conn, |game| game.drop_inventory(eyes)); } + self.spawn_orbs(at, reward); } } From bbc57aa838c52a7120722a0bf4ea2df2f644c473 Mon Sep 17 00:00:00 2001 From: Kacpherek Date: Sun, 25 Oct 2026 21:59:37 +0100 Subject: [PATCH 15/28] Save furnace, brewing stand and crafter edits made through a server menu A server player's clicks in a furnace, brewing stand or crafter menu wrote the block entity's slots but never marked it changed, so the chunk was not saved: an idle furnace (nothing burning, so its own tick changes nothing) given or emptied through its menu rolled back on reopen or chunk unload, losing or duplicating the items. Comparators kept the old reading too. When the click changed the container's slots, call container_changed (BlockEntity.setChanged, reached through Slot.setChanged in vanilla's AbstractContainerMenu.doClick and quickMoveStack), as chest-like menus already do. --- crates/horizon-client/src/game/lan_crafting.rs | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/crates/horizon-client/src/game/lan_crafting.rs b/crates/horizon-client/src/game/lan_crafting.rs index f74935522..d3c4b1825 100644 --- a/crates/horizon-client/src/game/lan_crafting.rs +++ b/crates/horizon-client/src/game/lan_crafting.rs @@ -291,6 +291,11 @@ impl Game<'_> { let at = host.hub.guests[gi].position; self.award_furnace_recipes(pos, at); } + // Slot.setChanged on a changed container slot: BlockEntity.setChanged, + // so the chunk is saved and comparators read the block again. + if (0..items.len()).any(|k| menu.slot(k) != items[k].as_ref()) { + self.container_changed(pos); + } host.play.entry(conn).or_default().crafting.machine = Some((p.container, menu)); host.hub.inventory_clicked(conn, p, &self.world, &changed); true From a6548089c4677e1cf11a03a6f52cff63ba116f2b Mon Sep 17 00:00:00 2001 From: Kacpherek Date: Sun, 25 Oct 2026 23:09:19 +0100 Subject: [PATCH 16/28] Count the death roll in ticks so the dead camera eases instead of shaking The camera's death roll and zoom (GameRenderer.bobHurt, Camera.modifyFovBasedOnDeathOrFluid) read deathTime + partialTick. Horizon derived deathTime from the wall clock since the death message, which the server thread path never set: there deathTime stayed 0, so every frame used 0 + partialTick and the view rolled from 0 to 0.2 degrees and snapped back twenty times a second (with a matching zoom pulse) instead of settling at vanilla's 3.6 degrees. In frame, the wall-clock ticks were not in step with the frame's partial tick either. deathTime is now the tick counter LivingEntity.tickDeath keeps: the in-frame tick already counted it, and the server thread path now resets it when the death screen opens and counts it once per client tick. horizon-ctl state reports it as player.death_time. --- crates/horizon-client/src/game/agent.rs | 2 ++ crates/horizon-client/src/game/fov.rs | 14 +++++++------- crates/horizon-client/src/game/remote.rs | 7 +++++++ 3 files changed, 16 insertions(+), 7 deletions(-) diff --git a/crates/horizon-client/src/game/agent.rs b/crates/horizon-client/src/game/agent.rs index 0d2d218ab..79d13be84 100644 --- a/crates/horizon-client/src/game/agent.rs +++ b/crates/horizon-client/src/game/agent.rs @@ -476,6 +476,8 @@ impl Game<'_> { "absorption": p.health.absorption(), // The hurt animation's ticks left (the camera's hurt tilt). "hurt_time": p.health.hurt_animation_time, + // LivingEntity.deathTime while dead (the camera's death roll). + "death_time": self.death_time(), "air": p.air, "food": p.health.food.food, "saturation": p.health.food.saturation, diff --git a/crates/horizon-client/src/game/fov.rs b/crates/horizon-client/src/game/fov.rs index 27d3fb61e..95e2e1e6e 100644 --- a/crates/horizon-client/src/game/fov.rs +++ b/crates/horizon-client/src/game/fov.rs @@ -64,14 +64,14 @@ impl Game<'_> { }); self.view.tick(eye, target); } - /// The player's `deathTime` while dead or dying. - fn death_time(&self) -> Option { + /// The player's `deathTime` while dead or dying: whole ticks counted by + /// `LivingEntity.tickDeath`, so `deathTime + partialTicks` in + /// `Camera.extractRenderState` rises smoothly across frames. + pub(super) fn death_time(&self) -> Option { let p = self.player.as_ref()?; - p.health.dead_or_dying().then(|| { - self.ui - .died_at - .map_or(0, |t| (t.elapsed().as_secs_f32() * 20.0) as i32) - }) + p.health + .dead_or_dying() + .then(|| self.ui.death_time.min(i32::MAX as u32) as i32) } /// The fluid at the camera, as `Camera.getFluidInCamera` reports it. pub(super) fn camera_fluid(&self, camera: [f64; 3]) -> CameraFluid { diff --git a/crates/horizon-client/src/game/remote.rs b/crates/horizon-client/src/game/remote.rs index 03b48df3d..4d48e7af5 100644 --- a/crates/horizon-client/src/game/remote.rs +++ b/crates/horizon-client/src/game/remote.rs @@ -2155,6 +2155,7 @@ impl Game<'_> { self.apply_remote_health(); if p.health <= 0.0 && self.screen != Screen::Dead && self.player.is_some() { self.screen = Screen::Dead; + self.ui.death_time = 0; self.capture(false); } } @@ -2171,6 +2172,7 @@ impl Game<'_> { // screen, whatever health was last sent. if me && self.screen != Screen::Dead && self.player.is_some() { self.screen = Screen::Dead; + self.ui.death_time = 0; self.capture(false); } } @@ -3137,6 +3139,11 @@ impl Game<'_> { ); let was_flying = player.flying; self.sync_player_body(); + // LivingEntity.tickDeath: the local player counts its deathTime once + // per client tick while dead (the camera's death roll and zoom). + if self.screen == Screen::Dead { + self.ui.death_time = self.ui.death_time.saturating_add(1); + } let Some(player) = self.player.as_mut() else { return Ok(()); }; From 2d088739e5fb1e1b28347770a5ae35ca6c00c95a Mon Sep 17 00:00:00 2001 From: rdbtCVS <87152661+rdbtCVS@users.noreply.github.com> Date: Sun, 25 Oct 2026 23:40:17 +0000 Subject: [PATCH 17/28] Fix dropped items following fluid currents Sample item immersion and apply shared entity currents before and after movement, matching vanilla tick order. Cover item-sized fluid scans and flowing-water movement. Co-Authored-By: Codex gpt-6.1-sol --- crates/horizon-client/src/entities.rs | 16 +- crates/horizon-client/src/entities/fluids.rs | 226 +++++++++++++++++++ crates/horizon-client/src/game.rs | 8 +- crates/horizon-client/src/game/remote.rs | 2 +- tools/test_entity_fluid_parity.py | 9 + 5 files changed, 252 insertions(+), 9 deletions(-) create mode 100644 crates/horizon-client/src/entities/fluids.rs diff --git a/crates/horizon-client/src/entities.rs b/crates/horizon-client/src/entities.rs index 65536d710..6e8089e9d 100644 --- a/crates/horizon-client/src/entities.rs +++ b/crates/horizon-client/src/entities.rs @@ -10,6 +10,8 @@ use crate::{ use horizon_core::geometry::{Aabb, Vec3}; use horizon_world::block_collision::BlockCollisionRegistry; +mod fluids; + #[derive(Clone, Debug)] pub struct ItemEntity { pub health: i32, @@ -165,18 +167,16 @@ impl ItemEntity { facts: &BlockFacts, collision: &BlockCollisionRegistry<'_>, no_physics: bool, + fluids: &crate::motion::FluidResources, ) -> bool { self.ticks += 1; self.previous = self.position; if self.pickup_delay > 0 && self.pickup_delay != u32::MAX { self.pickup_delay -= 1; } - let eye = world.block( - self.position.x.floor() as i32, - (self.position.y + 0.1).floor() as i32, - self.position.z.floor() as i32, - ); - let in_water = facts.get(eye).fluid == Fluid::Water; + // Entity.baseTick pushes before ItemEntity applies buoyancy and moves. + let (water_height, lava_height) = self.update_fluids(world, fluids); + let in_water = water_height > f64::from(0.1f32); if in_water { // ItemEntity.setUnderwaterMovement self.velocity = Vec3::new( @@ -184,7 +184,7 @@ impl ItemEntity { self.velocity.y + if self.velocity.y < 0.06 { 5.0e-4 } else { 0.0 }, self.velocity.z * 0.99, ); - } else if facts.get(eye).fluid == Fluid::Lava { + } else if lava_height > f64::from(0.1f32) { self.velocity = Vec3::new( self.velocity.x * 0.95, self.velocity.y + if self.velocity.y < 0.06 { 5.0e-4 } else { 0.0 }, @@ -245,6 +245,8 @@ impl ItemEntity { } } self.age += 1; + // ItemEntity.tick refreshes immersion and pushes again after moving. + self.update_fluids(world, fluids); self.age < 6000 && self.position.y > -128.0 } /// `ItemEntity.isMergable` at `age`: a stack below its size whose pickup diff --git a/crates/horizon-client/src/entities/fluids.rs b/crates/horizon-client/src/entities/fluids.rs new file mode 100644 index 000000000..1d202e129 --- /dev/null +++ b/crates/horizon-client/src/entities/fluids.rs @@ -0,0 +1,226 @@ +//! Dropped-item immersion and currents through the shared vanilla fluid helpers. +use super::ItemEntity; +use crate::{ + motion::{FluidResources, LAVA, WATER}, + world::World, +}; +use horizon_core::{ + geometry::{Aabb, Direction, Vec3}, + position::BlockPos, +}; +use horizon_world::{ + entity_fluid::{ + CurrentTarget, EntityFluidInteraction, FluidInteractionWorld, FluidMembership, + FluidSections, FluidTagId, + }, + fluid::{FluidHeightWorld, FluidKind, FluidState}, + fluid_flow::{FluidFlowWorld, flow_at}, + registry::BlockStateId, +}; +type Error = std::convert::Infallible; +struct ItemFluidWorld<'a> { + item: &'a mut ItemEntity, + world: &'a World, + fluids: &'a FluidResources, +} +impl ItemEntity { + pub(super) fn update_fluids(&mut self, world: &World, fluids: &FluidResources) -> (f64, f64) { + let mut interaction = EntityFluidInteraction::new([WATER, LAVA]); + let mut scene = ItemFluidWorld { + item: self, + world, + fluids, + }; + if interaction.update(&mut scene, false, 4096).is_err() { + return (0.0, 0.0); + } + let water_height = interaction.fluid_height(&scene, WATER); + let lava_height = interaction.fluid_height(&scene, LAVA); + let _ = interaction.apply_current(&mut scene, WATER, 0.014); + let _ = interaction.apply_current( + &mut scene, + LAVA, + if world.fast_lava { + 0.007 + } else { + 0.0023333333333333335 + }, + ); + (water_height, lava_height) + } +} +struct Tags; +impl FluidMembership for Tags { + fn fluid_in_tag(&self, kind: FluidKind, tag: FluidTagId) -> bool { + if tag == WATER { + matches!(kind, FluidKind::Water | FluidKind::FlowingWater) + } else { + matches!(kind, FluidKind::Lava | FluidKind::FlowingLava) + } + } +} +impl FluidMembership for ItemFluidWorld<'_> { + fn fluid_in_tag(&self, kind: FluidKind, tag: FluidTagId) -> bool { + Tags.fluid_in_tag(kind, tag) + } +} +impl CurrentTarget for ItemFluidWorld<'_> { + type Error = Error; + fn is_player_class(&self) -> bool { + false + } + fn velocity(&mut self) -> Result { + Ok(self.item.velocity) + } + fn add_delta_movement(&mut self, delta: Vec3) -> Result<(), Error> { + let v = self.item.velocity; + let sum = Vec3::new(v.x + delta.x, v.y + delta.y, v.z + delta.z); + if delta.is_finite() && sum.is_finite() { + self.item.velocity = sum; + } + Ok(()) + } +} +impl FluidInteractionWorld for ItemFluidWorld<'_> { + type Error = Error; + type Chunk = (); + fn interaction_box(&mut self) -> Result, Error> { + Ok(Some( + self.item.bounds().deflate(Vec3::new(0.001, 0.001, 0.001)), + )) + } + fn loaded_chunk(&mut self, x: i32, z: i32) -> Result, Error> { + Ok(self.world.chunks.contains_key(&(x, z)).then_some(())) + } + fn chunk_sections(&mut self, _: ()) -> Result, Error> { + static SECTIONS: [bool; crate::chunk::SECTIONS] = [true; crate::chunk::SECTIONS]; + Ok(FluidSections { + minimum_section_y: crate::chunk::MIN_Y >> 4, + has_fluid: &SECTIONS, + }) + } + fn bounding_box_min_y(&self) -> f64 { + self.item.position.y + } + fn block_x(&self) -> i32 { + self.item.position.x.floor() as i32 + } + fn eye_y(&mut self) -> Result { + Ok(self.item.position.y + f64::from(0.2125f32)) + } + fn block_z(&self) -> i32 { + self.item.position.z.floor() as i32 + } + fn fluid_state(&mut self, p: BlockPos) -> Result { + Ok(self.fluids.fluid(self.world.block(p.x, p.y, p.z))) + } + fn fluid_height(&mut self, f: FluidState, p: BlockPos) -> Result { + f.height_at(self, [p.x, p.y, p.z]) + } + fn camera_height(&mut self, f: FluidState, p: BlockPos) -> Result { + f.camera_height_at(self, [p.x, p.y, p.z]) + } + fn flow(&mut self, f: FluidState, p: BlockPos) -> Result { + flow_at(self, f, p) + } +} +impl FluidHeightWorld for ItemFluidWorld<'_> { + type Error = Error; + fn fluid(&mut self, p: [i32; 3]) -> Result { + Ok(self.fluids.fluid(self.world.block(p[0], p[1], p[2]))) + } + fn sturdy_down(&mut self, p: [i32; 3]) -> Result { + let state = self.world.block(p[0], p[1], p[2]); + Ok(self.fluids.sturdy(state, Direction::Down)) + } +} +impl FluidFlowWorld for ItemFluidWorld<'_> { + type Error = Error; + type Block = BlockStateId; + fn fluid(&mut self, p: BlockPos) -> Result { + Ok(self.fluids.fluid(self.world.block(p.x, p.y, p.z))) + } + fn block(&mut self, p: BlockPos) -> Result { + Ok(self.world.block(p.x, p.y, p.z)) + } + fn blocks_fluid_flow(&self, s: BlockStateId) -> bool { + self.fluids.blocks_flow(s) + } + fn is_ice_class(&self, s: BlockStateId) -> bool { + self.fluids.ice(s) + } + fn is_face_sturdy( + &mut self, + s: BlockStateId, + _: BlockPos, + d: Direction, + ) -> Result { + Ok(self.fluids.sturdy(s, d)) + } +} + +#[cfg(test)] +mod tests { + use super::*; + #[test] + fn items_follow_flowing_water_but_still_water_has_no_horizontal_push() { + let root = std::path::Path::new(env!("CARGO_MANIFEST_DIR")) + .join("../../.local/horizon-client") + .join(horizon_core::VANILLA_VERSION); + if !root.join("movement-properties.nbt").exists() { + return; + } + let assets = crate::assets::Assets::load(&root).unwrap(); + let render = assets.reload(&root).unwrap(); + let facts = crate::blocks::BlockFacts::load(&root, assets.registry).unwrap(); + let fluids = FluidResources::new(&assets, &facts).unwrap(); + let collision = crate::collisions::load(&root, assets.registry).unwrap(); + let mut world = World::test_scene(&assets, &render, 3).unwrap(); + let stone = assets.registry.default_state("minecraft:stone").unwrap(); + let water = assets.registry.default_state("minecraft:water").unwrap(); + let mut state = assets.registry.state(water).unwrap().clone(); + state.properties.insert("level".into(), "1".into()); + let flowing = assets.registry.resolve(&state).unwrap(); + for x in 19..=21 { + for z in 19..=21 { + world.set(x, 3, z, stone).unwrap(); + world.set(x, 4, z, water).unwrap(); + } + } + let at = Vec3::new(20.5, 4.0, 20.5); + let item = ItemEntity { + id: 1, + health: 5, + fire_ticks: 0, + stack: crate::items::ItemStack { + item: "minecraft:sugar_cane".into(), + count: 1, + damage: 0, + extra: None, + }, + thrower: None, + position: at, + previous: at, + velocity: Vec3::ZERO, + on_ground: false, + age: 0, + pickup_delay: 0, + bob_offset: 0.0, + ticks: 0, + }; + let mut still = item.clone(); + assert!(still.tick(&world, &facts, &collision, false, &fluids)); + assert_eq!(still.position.x, at.x); + assert_eq!(still.velocity.x, 0.0); + world.set(21, 4, 20, flowing).unwrap(); + let mut carried = item; + assert!(carried.tick(&world, &facts, &collision, false, &fluids)); + // First push is damped by buoyancy before motion, second follows drag. + assert!((carried.position.x - at.x - 0.014 * 0.99).abs() < 1e-12); + assert!((carried.velocity.x - (0.014 * 0.99 * 0.98 + 0.014)).abs() < 1e-12); + for _ in 0..20 { + carried.tick(&world, &facts, &collision, false, &fluids); + } + assert!(carried.position.x > at.x + 0.5); + } +} diff --git a/crates/horizon-client/src/game.rs b/crates/horizon-client/src/game.rs index f5803ad08..133381b27 100644 --- a/crates/horizon-client/src/game.rs +++ b/crates/horizon-client/src/game.rs @@ -2238,7 +2238,13 @@ impl Game<'_> { let speed = self.world.random.next_float() * 0.2 + 0.1; item.move_towards_closest_space(&self.world, self.res.facts(), speed); } - let alive = item.tick(&self.world, self.res.facts(), self.collision, no_physics); + let alive = item.tick( + &self.world, + self.res.facts(), + self.collision, + no_physics, + &self.res.motion().fluids, + ); cells.moved(i, item.previous, item.position); // ItemEntity.tick: merge every 2 ticks while moving between // blocks, every 40 otherwise, before the lifetime check. diff --git a/crates/horizon-client/src/game/remote.rs b/crates/horizon-client/src/game/remote.rs index 2636b0064..7ebccf351 100644 --- a/crates/horizon-client/src/game/remote.rs +++ b/crates/horizon-client/src/game/remote.rs @@ -3464,7 +3464,7 @@ impl Game<'_> { // ticks), and only the server removes it. let (world, facts, collision) = (&self.world, self.res.facts(), self.collision); for d in self.dropped.iter_mut().filter(|_| running) { - d.tick(world, facts, collision, false); + d.tick(world, facts, collision, false, &self.res.motion().fluids); } head_lerps.retain(|_, (_, steps)| *steps > 0); for (item, ticks, at, eye, pitch, yaw) in using { diff --git a/tools/test_entity_fluid_parity.py b/tools/test_entity_fluid_parity.py index b37a3e11d..f8cbf918d 100644 --- a/tools/test_entity_fluid_parity.py +++ b/tools/test_entity_fluid_parity.py @@ -29,6 +29,15 @@ def corpus(): if v[k] is not None:v[k]=[bits(n) for n in v[k]] return v def row(ops,player=False,order=(0,1,2)):return dict(ops=ops,player=player,order=order) + # Dropped items: the 0.25-wide box is deflated by Entity before scanning. + # Cover surface grazing, buoyancy depth, cell boundaries and repeated pushes. + for x in [.5, 1.0, 15.99]: + for y in [0, .1, .7, 8/9-.1, 8/9-.001, 8/9, 1]: + for flow in [(0,0,0),(1,0,0),(-1,0,1),(0,-1,0)]: + update=op(bounds=[x-.124,y+.001,.376,x+.124,y+.249,.624], + base_y=y,eye=y+.2125,block=[int(x),int(y),0], + default=cell(flow=flow)) + yield row([update,op(mode='apply'),update,op(mode='apply')]) values=[-float('inf'),-1,-.0,0,.1,.39999998,.4,.40000004,8/9,1,2,float('inf'),float('nan')] for kind in range(5): for height in values: From 31eecdc271750def0532029e62ef007878762c01 Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Mon, 26 Oct 2026 01:03:25 +0100 Subject: [PATCH 18/28] Compute a firework's blast distance in floats, as Entity.distanceTo does Entity.distanceTo casts each offset to float and sums the squares in floats; taking the double distance and rounding it gave a slightly different damage at the edge of rounding. Co-Authored-By: Claude Opus 5.5 --- crates/horizon-client/src/game/fireworks.rs | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/crates/horizon-client/src/game/fireworks.rs b/crates/horizon-client/src/game/fireworks.rs index 2c98a12ad..e6b4eb136 100644 --- a/crates/horizon-client/src/game/fireworks.rs +++ b/crates/horizon-client/src/game/fireworks.rs @@ -71,10 +71,16 @@ impl Rocket { (self.position, self.velocity) } } -/// `damageAmount * (float)Math.sqrt((5.0 - this.distanceTo(target)) / 5.0)`, -/// `distanceTo` being a float. -fn blast_damage(damage: f32, distance_sqr: f64) -> f32 { - let distance = distance_sqr.sqrt() as f32; +/// `damageAmount * (float)Math.sqrt((5.0 - this.distanceTo(target)) / 5.0)` +/// from the rocket at `from` to a target at `to`; `Entity.distanceTo` sums +/// the squared offsets in floats. +fn blast_damage(damage: f32, from: Vec3, to: Vec3) -> f32 { + let (x, y, z) = ( + (from.x - to.x) as f32, + (from.y - to.y) as f32, + (from.z - to.z) as f32, + ); + let distance = f64::from(x * x + y * y + z * z).sqrt() as f32; damage * ((5.0 - f64::from(distance)) / 5.0).sqrt() as f32 } pub(super) fn fireworks_of(stack: &ItemStack) -> (u8, Vec) { @@ -294,7 +300,7 @@ impl Game<'_> { ); world.clear_between(from, to, false) }); - sees.then(|| (m.id, blast_damage(damage, d2))) + sees.then(|| (m.id, blast_damage(damage, from, m.position))) }) .collect() }; @@ -337,7 +343,7 @@ impl Game<'_> { }) }; if sees { - self.rocket_hurt_player(blast_damage(damage, d2)); + self.rocket_hurt_player(blast_damage(damage, from, feet)); } } /// `hurtServer` with `damageSources().fireworks`: armor absorbs it and From 7dfd4c628070d391b3dd16020517eaf64555854d Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Mon, 26 Oct 2026 01:04:20 +0100 Subject: [PATCH 19/28] Share the player's water and lava tags with dropped items The item's fluid world had its own copy of the FluidTags.WATER/LAVA membership the player's immersion uses; motion now exports that one. Co-Authored-By: Claude Opus 5.5 --- crates/horizon-client/src/entities/fluids.rs | 14 ++------------ crates/horizon-client/src/motion.rs | 2 +- crates/horizon-client/src/motion/fluids.rs | 11 ++++++----- 3 files changed, 9 insertions(+), 18 deletions(-) diff --git a/crates/horizon-client/src/entities/fluids.rs b/crates/horizon-client/src/entities/fluids.rs index 1d202e129..fffa0ae2b 100644 --- a/crates/horizon-client/src/entities/fluids.rs +++ b/crates/horizon-client/src/entities/fluids.rs @@ -1,7 +1,7 @@ //! Dropped-item immersion and currents through the shared vanilla fluid helpers. use super::ItemEntity; use crate::{ - motion::{FluidResources, LAVA, WATER}, + motion::{FluidResources, FluidTags, LAVA, WATER}, world::World, }; use horizon_core::{ @@ -49,19 +49,9 @@ impl ItemEntity { (water_height, lava_height) } } -struct Tags; -impl FluidMembership for Tags { - fn fluid_in_tag(&self, kind: FluidKind, tag: FluidTagId) -> bool { - if tag == WATER { - matches!(kind, FluidKind::Water | FluidKind::FlowingWater) - } else { - matches!(kind, FluidKind::Lava | FluidKind::FlowingLava) - } - } -} impl FluidMembership for ItemFluidWorld<'_> { fn fluid_in_tag(&self, kind: FluidKind, tag: FluidTagId) -> bool { - Tags.fluid_in_tag(kind, tag) + FluidTags.fluid_in_tag(kind, tag) } } impl CurrentTarget for ItemFluidWorld<'_> { diff --git a/crates/horizon-client/src/motion.rs b/crates/horizon-client/src/motion.rs index 5918bccd9..734a13176 100644 --- a/crates/horizon-client/src/motion.rs +++ b/crates/horizon-client/src/motion.rs @@ -44,7 +44,7 @@ use std::{ pub(crate) mod environment; mod fluids; -pub use fluids::{FluidResources, LAVA, PlayerFluids, WATER}; +pub use fluids::{FluidResources, FluidTags, LAVA, PlayerFluids, WATER}; pub struct MotionResources { pub attributes: Arc, diff --git a/crates/horizon-client/src/motion/fluids.rs b/crates/horizon-client/src/motion/fluids.rs index 89affeb64..894e6d907 100644 --- a/crates/horizon-client/src/motion/fluids.rs +++ b/crates/horizon-client/src/motion/fluids.rs @@ -103,10 +103,10 @@ fn is_tagged(kind: FluidKind, tag: FluidTagId) -> bool { } impl PlayerMotion { pub fn fluid_height(&self, tag: FluidTagId) -> f64 { - self.fluids.interaction.fluid_height(&Membership, tag) + self.fluids.interaction.fluid_height(&FluidTags, tag) } pub fn is_eye_in_fluid(&self, tag: FluidTagId) -> bool { - self.fluids.interaction.is_eye_in_fluid(&Membership, tag) + self.fluids.interaction.is_eye_in_fluid(&FluidTags, tag) } /// `LocalPlayer.isUnderWater`: `wasUnderwater`, the eye sample `Player.tick` /// takes before the base tick (`Entity.isUnderWater` also needs the body @@ -116,11 +116,12 @@ impl PlayerMotion { } /// `Entity.isInLava`. pub fn is_in_lava(&self) -> bool { - !self.fluids.first_tick && self.fluids.interaction.is_in_fluid(&Membership, LAVA) + !self.fluids.first_tick && self.fluids.interaction.is_in_fluid(&FluidTags, LAVA) } } -struct Membership; -impl FluidMembership for Membership { +/// Which fluids `FluidTags.WATER` and `FluidTags.LAVA` hold. +pub struct FluidTags; +impl FluidMembership for FluidTags { fn fluid_in_tag(&self, kind: FluidKind, tag: FluidTagId) -> bool { is_tagged(kind, tag) } From bb3a289caaa091b9ffd910e51780bacb31f0ac4c Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Mon, 26 Oct 2026 01:07:48 +0100 Subject: [PATCH 20/28] Read the click's changed slots for the machine's setChanged The menu op already lists the slots the click changed; a container slot among them is the Slot.setChanged that saves the block entity. Co-Authored-By: Claude Opus 5.5 --- crates/horizon-client/src/game/lan_crafting.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/crates/horizon-client/src/game/lan_crafting.rs b/crates/horizon-client/src/game/lan_crafting.rs index d3c4b1825..db6235c4d 100644 --- a/crates/horizon-client/src/game/lan_crafting.rs +++ b/crates/horizon-client/src/game/lan_crafting.rs @@ -293,7 +293,7 @@ impl Game<'_> { } // Slot.setChanged on a changed container slot: BlockEntity.setChanged, // so the chunk is saved and comparators read the block again. - if (0..items.len()).any(|k| menu.slot(k) != items[k].as_ref()) { + if changed.iter().any(|&s| s < items.len()) { self.container_changed(pos); } host.play.entry(conn).or_default().crafting.machine = Some((p.container, menu)); From 2631eca00b66b81ea5582b5421a7ed6c30197b7b Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Mon, 26 Oct 2026 03:32:44 +0100 Subject: [PATCH 21/28] Drop the migration's validation ledger from the docs It records an agent's runs and diagnoses, which the pull request and its branch history already keep; docs/ is for how the project works. Co-Authored-By: Claude Opus 5.5 --- docs/validation/server-thread-migration.md | 297 --------------------- 1 file changed, 297 deletions(-) delete mode 100644 docs/validation/server-thread-migration.md diff --git a/docs/validation/server-thread-migration.md b/docs/validation/server-thread-migration.md deleted file mode 100644 index 62c1609b7..000000000 --- a/docs/validation/server-thread-migration.md +++ /dev/null @@ -1,297 +0,0 @@ -# Server-thread integration coverage migration: validation ledger - -Tested on 2026-10-24, Linux / NVIDIA Vulkan, with Java 25 and the pinned 26.3 -resources and jars. Base: `e423e570c`. Player integration uses real Horizon -clients under Xvfb and real control sockets. The migrated game drivers use fresh -temporary game, launcher and XDG data/config homes; telemetry, audio and launcher -self-update are disabled. No player data or prepared resources are committed. -An interrupted historical-world generator initially inherited the harness -environment instead of those per-game homes. It wrote only to ignored `.local` -fixture folders; it was stopped, and subsequent validation uses the already -prepared historical worlds. That setup mistake is not counted as a passing run. - -## Before editing - -Open PR searches for server-thread, integration, LAN and friends work found no -overlapping migration. The full original LAN suite was started with -`--server-thread` against a build of the unchanged base before repository edits. - -| Run | Hosting | Result | -| --- | --- | --- | -| Original full LAN attempt | Server thread | 58 checks reported: 39 passed, 18 failed, deflection skipped; the runner then aborted at `light` with an uncaught `TypeError`. | -| Original remaining 45 checks | Server thread | 31 passed, 14 failed, no skips. Used the unchanged loaded driver and original executable. | -| Friends, including `--baseline` | Server thread | Plain LAN, direct invitation, local relay and ended-invite rejection passed. | - -Together the two LAN invocations attempted all 103 original checks. The initial -`sign` case left its editor open, breaking the later death-screen assertion. -`predict` suspended the whole host process; resuming it interrupted a socket -read (`Interrupted system call`), disconnected the guest and caused later -session failures. The remaining run also exposed sign placement outside reach -and cascading dead-player failures. These are recorded failures, not passes. - -## Infrastructure changes validated during migration - -- Close the sign editor after the original placement check. Give the two-player - sign case a reachable arena and wait for placement data/feedback before typing. - Observe the submitted text on both clients within the existing assertion budget. - The revised sign case passed three consecutive server-thread reruns. -- Release held input, close screens and respawn dead players before independent - cases. Keep every case's death, menu and held-action assertions inside the case. -- Replace process signals with a server barrier for prediction and an intentional - window-thread stall for frame-recovery tests. Prediction still tests immediate - client prediction, authoritative agreement, iron-door rejection and exactly-once - sound; it also asserts that the server clock did not advance at the barrier. -- Route mob/projectile/hurt-log inspection to the owning server. Deflection runs - in the default suite rather than reporting an in-frame-only skip as a pass. -- Record skipped checks explicitly as uncovered, and record ordinary case errors - without aborting the rest of the suite. Write mode and results to `results.json`. -- Serialize the two CI integration entry points on the shared GPU. An earlier - concurrent comparison failed to start a graphics device because of GPU memory - exhaustion; it was rerun serially, without changing a gameplay timeout. - -## Post-migration runs - -The first complete server-thread migration run, before the case-cleanup fixes, -ran all 103 original cases: 88 passed and 15 failed. Failures were `deflect`, -`light`, `swings`, `cracks`, `effects`, `portals`, `flight`, `boats`, `minecarts`, -`frames`, `hands`, `riding`, `mounts`, `contacts` and `absorption`. Many followed -the host's deflection damage/death. They are not used as evidence of a clean suite. - -The next complete default server-thread run executed all 107 cases (the original -103 plus four separate host/guest sensor and dispenser input cases): **97 passed, -10 failed, zero skipped**. Failures were `commands`, `deflect`, `swings`, `flight`, -`boats`, `minecarts`, `keepinv`, `fishing`, `sculk_input_host` and -`sculk_input_guest`. Lighting passed this run; earlier lighting failures are not -claimed as a persistent blocker. - -A subsequent input-timing correction runs the existing double-jump key/wait -sequence through one `horizon-ctl script` process, preserving the seven-tick -flight window. A targeted server-thread rerun passed flight for both players, -swings, boats and minecarts. Command completion still failed: the observable -suggestion list did not appear within the existing two-tick budget. The in-frame -rerun passed flight and failed completion in the same way. Passing isolated -swings/vehicle cases does not clear the unexplained failures in the full sequence. -The full-run inventory retention and fishing failures also remain unresolved. - -Friends passed plain LAN, direct invitation, local relay and ended-invite checks -both after making server-thread hosting the default and with explicit `--in-frame`. - -Targeted in-frame comparisons passed chest, sign placement, prediction, clock -recovery, lighting and deflection. The revised two-player sign case and both -new dispenser input cases passed too. Command completion failed twice: Tab after -`/gamem` left `/gamem` unchanged. The host's sculk input passed; the guest's failed. - -Targeted server-thread checks passed prediction and both new dispenser input -cases. Dispensing checks authoritative inventory consumption and exactly one -matching item on each client. Both sensor cases confirmed movement on the client -and server, but the sensor stayed inactive. Deflection still failed the original -no-fireball-damage assertion after allowing the click through a normal client -input tick. An experimental frozen-world synchronization approach also failed -and is not part of the final implementation. - -## Deterministic rule and source checks - -`python3 tools/parity.py command_exec dispenser sculk --timeout 1500 --jobs 2`: - -| Direct fixture | Result | -| --- | --- | -| Command execution | 781/781 command/callback records match the vanilla oracle. | -| Dispenser and related rule calls | 6000 cases match; no difference groups. | -| Sculk | 435 scenarios match every compared tick. | - -All three harnesses passed. Their seeded rule calls and controlled ticks remain -direct; they do not claim client/server boundary coverage. The existing -`net_harness.rs` remains a real dedicated-server client fixture. - -The first quick self-check passed 289 Python tests, rustfmt and Clippy. Rust tests -reported 1081 passed, one failed and 26 ignored: the shared prepared resource -folder lacked `registries.json`. The pinned local datagen report was copied into -a private ignored resource copy; the failed -`mod_content::tests::content_root_loads_with_every_table` test then passed. -The focused environment/parity-runner/self-check Python tests passed (38 tests). - -The full `python3 tools/pr_ready.py --base origin/main` completed: 1205 Rust tests -and 291 Python tests passed, as did rustfmt, Clippy and documentation checks. -Its parity phase failed after the historical-world setup interruption described -above, so the overall self-check is **not green**. A subsequent `parity.py --changed origin/main --timeout 1500` selected 160 -harnesses, 151 requiring runs. Three completed and passed (`firework_tooltip`, -`held_drop`, `interaction_input`). Both integration wrappers exceeded that -invocation's 25-minute per-harness deadline: friends was waiting for the shared -GPU lock, and LAN was still executing cases. Automatic retries were stopped and -the detached game processes cleaned up. The remaining affected harnesses did not -complete. This is incomplete validation, not a passing corrected parity gate; -compilation is not a substitute for the gameplay failures above. - -The final source self-check, `python3 tools/pr_ready.py --quick`, passed 1205 Rust -tests, 291 Python tests, rustfmt, Clippy and documentation checks. After correcting -the integration build arguments to name each binary (so traced selection includes -`game.rs` and `game/integrated.rs`), the named client/control/relay build and 38 -focused Python tests passed. Dependency extraction from the real Cargo dep-info -confirmed both game files are selected. - -## Limitations recorded before the follow-up fixes - -These were the remaining blockers when this ledger was first written; the -completion runs below record their status after the follow-up fixes. - -- Server-player footsteps do not reach sculk sensors. `tick_entity_events` in - `game/sculk.rs` emits player motion events from `Game.player`; the integrated - server's players live in its guest hub. The in-frame host passes and its guest - fails too, separating this shared server-player gap from the deterministic rule - oracle. A fix needs per-player event identity/state rather than weakening the test. -- The server-thread host takes fireball damage in deflection; the equivalent - in-frame check passes. Client-visible and authoritative projectile state diverge - during the synchronization investigation. No gameplay fix is included. -- Command completion fails in both modes as described above; it is not reported - as a passing fallback comparison. -- Full-sequence swings, vehicle, inventory-retention and fishing failures need - further fixture/state investigation. Swings and both vehicles passed isolated - reruns; that evidence does not establish a gameplay defect or a full-suite pass. - -No failing case is skipped, expectation relaxed, or existing timeout increased to -hide these results. At that stage the PR stayed draft with these coverage blockers. - -## Combined validation before the gameplay split (2026-10-25) - -Merged `main` at `bd591f985` and resolved the overlapping motion, projectile and -test-driver changes. The shared projectile inertia helper retains main's custom -acceleration power, with a regression test. Integration environments now call -`lab.game_env`; the friends entry point delegates its actual launches to that -isolated driver. The dedicated-server process keeps one environment argument, -and the control-tool connection test uses a scratch home rather than reading -the player's No AI setting. - -The first complete run after that merge executed **119 cases: 114 passed, -five failed, zero skipped**. Failures were `swings`, `flight`, `boats`, -`minecarts` and `keepinv`. All the additional regression cases from main passed. -Command completion, deflection, fishing and both sensor/dispenser input roles -also passed in that full sequence. - -The failures exposed fixture setup, input cadence and an off-hand clearing bug: - -- Aim at the hoe target's top face, observe that target, then send a normal - mouse click. Keep the exact one-swing/farmland assertion. A subsequent full - repeat passed flight and both vehicle checks but still failed the hoe case; - it was stopped after identifying the root cause rather than counted as green. - The earlier explosion case leaves an off-hand shield, and `/clear` omitted - that slot. Vanilla correctly blocks hoe use with that shield. Follow - `Inventory.clearOrCountMatchingItems`, `getContainerSize`, `getItem` and its - equipment-slot mapping: clear off-hand items and visit armor feet to head. - New oracle cases cover off-hand counting, partial/full removal and limited - armor-slot ordering. The explosion-then-swings sequence passes after this fix. -- Keep the original double-jump key sequence and seven-tick flight rule; run - this tick-sensitive case at four ticks per second so IPC scheduling on a busy - machine cannot stretch the input past that window. Restore 20 TPS afterward. -- Deliver the original ten vehicle punches and two-tick waits over one control - connection. Separate process launches had stretched the gaps to ten ticks, - letting the vehicle's damage decay before the next hit. -- Protect inactive inventory-test players after the low-health totem case, - assert that the active player is alive before the intended death, and provide - a full floor under scattered death drops. A targeted retry with the old small - platform lost a helmet over its edge; both players' exact drop/retention - assertions passed with the larger floor. - -Targeted server-thread reruns passed all five corrected cases, plus totems, -fishing and both sensor input roles. Friends passed plain LAN, direct invites, -the local relay and ended-invite rejection. The six focused parity harnesses -passed: `command_exec`, `dispenser`, `sculk`, `dedicated_server`, -`server_entities` and `server_player_damage`. - -The normal-runner full repeat also exposed an XP observation race: the guest -had already collected all 21 points before the two-tick in-flight snapshot -(`seen=0`, with the correct XP gain and no remaining orbs). Freeze spawning, -step two world ticks, observe the tracked orbs, then unfreeze for the original -pickup assertions. The targeted check passed with three visible orbs and -exactly 21 points; the full runner restarted with that correction. - -That repeat passed the former XP, swings, flight, boat and minecart failures, -but its level-ticking subcase found a wandering pig on a neighboring block at -Y=66 instead of the landing floor at Y=65. The armor stand landed correctly. -This subcase measures falling and simultaneous level ticking. Each level now -gets a full clear landing/walking area, retaining the pigs' normal AI. A -hazard-then-levels rerun confirmed that both pigs and armor stands land at the -expected heights with distinct entity IDs across levels. - -The broader parity invocation completed **116/117 runs passed**. The remaining -`tab_list` comparison matched 998/1000 lists and all 400 skin images. Both -list mismatches contained `Ⅻ`: the oracle's bitmap-only font setup used the -missing glyph instead of vanilla's Unicode fallback. Load the full default font -reference chain from the prepared assets with vanilla's provider definitions -and default option filters. Prefetch the fake skin lookups together before the -unchanged one-second observation window, retaining deliberately pending cases. -A fresh rerun passed **1000/1000 lists, 3510 frames and 400/400 skin images**, -with zero oracle errors. Fresh secure-chat and dimension-player parity reruns -passed after the command fix as well. The extended command oracle matched all -**843 command/callback records**. - -Rechecking the shared font helper passed eight of nine additional harnesses; -`pack_screen` matched 2778/3000 cases with its old bitmap-only oracle. Its -newline/control glyph metrics also require the Unicode fallback (the newline -advance is 9 with the full font, 6 with the bitmap-only setup). Give this oracle -the same full default font and prepared asset root. A fresh rerun matched -**3000/3000 pack screens**, with zero oracle errors and unchanged comparisons. - -The source self-check passed **1237 Rust tests and 270 Python tests**, rustfmt, -Clippy and doc tests. The private resource copy contains both pinned reports -and a regular `facts.json`, as required by the resource-isolation regression. -Prepared historical test worlds were copied into the ignored fixture cache -where available; they are not player saves or committed resources. - -The final in-frame comparison passed **14/14 cases, zero skipped**: commands, -deflection, both sensor roles, flight, swings, boats, minecarts, chest, prediction, -signs, both dispenser roles and inventory retention. A separate in-frame XP -comparison passed with three visible orbs and exactly 21 points. Friends and -the dedicated-server harness passed through the normal parity runner. - -The final normal-runner server-thread LAN repeat passed **119/119 cases, -zero skipped**, in 1940 seconds. This full sequence includes all earlier failure -cases, both sensor/dispenser roles and the additional regressions from main. -The final full `python3 tools/pr_ready.py` gate passed against merge base -`bd591f985`: **1237 Rust tests, 270 Python tests**, rustfmt, Clippy, public-tree -checks and documentation tests. Its parity stage selected **118 affected -harnesses**; 117 had current content-matched passing records and the remaining -harness passed during the gate. No failed or skipped harness remained. -The gate reported the existing scope warning (35 files, 584 lines of code); -the combined migration exceeded the suggested 500-line size. At that point -the combined PR was marked ready for review. The split below supersedes that -readiness status and the earlier description block. - - -## Gameplay fixes split into independent PRs (2026-10-25) - -At the user's request, the three gameplay fixes were removed from this PR's -net diff and opened independently against `main`: - -- [#1903](https://github.com/ludovic111/horizon/pull/1903): `/clear` off-hand - handling and vanilla inventory-slot order, including the added command-oracle - cases. The independent branch matches **843/843 command/callback records**. -- [#1904](https://github.com/ludovic111/horizon/pull/1904): connected-client - fireball motion and authoritative corrections, including the acceleration - regression and a focused `remote_fireball` integration harness. The new - harness fails on unchanged main in both hosting modes and passes with only - that gameplay fix applied. -- [#1905](https://github.com/ludovic111/horizon/pull/1905): per-player sculk - emission and history, including a focused `server_player_sculk` integration - harness. Without the fix, both server-thread players and the in-frame guest - fail while the in-frame host passes. With only this fix, **4/4 cases** pass, - along with **435/435 vanilla scenarios matching on every tick**. - -Each independent branch passes the quick source self-check using -`lab.game_env()` scratch homes (287 Python tests; 1241 Rust tests for clear -and sculk, 1242 for fireballs; formatting, Clippy and doc tests). Their broader -parity selections are listed for CI, rather than claimed as standalone full -parity passes. - -The migration was merged with main at `8177a6f45` before removing the fixes. -Its test migration, fixture synchronization, isolated environments, control -inspection and font-oracle corrections remain. The **119/119 full LAN pass** -and full affected-parity readiness result above belong to the combined -pre-extraction snapshot `cc9410b6`; they do not establish that the migration -alone passes after the gameplay code has been removed. This PR stays draft -until the three dependencies land and its full integration suite is rerun. - -The post-split migration quick source gate passes **1241 Rust tests and 290 -Python tests**, formatting, Clippy, public-tree and doc checks. It lists **70 -affected parity harnesses** for CI. Full post-split integration validation is -pending the three gameplay dependencies; no replacement full-suite pass is -claimed here. From 3df60c21c2ca64b9ce2703c803e4aa555d7f23d0 Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Mon, 26 Oct 2026 05:28:30 +0100 Subject: [PATCH 22/28] tests: compare resolved paths in the prepared-report fallback test macOS temp dirs live under /var, a symlink to /private/var, so the resolved report path never equalled the unresolved fallback. Co-Authored-By: Claude Opus 5.5 --- tests/test_integration_env.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/test_integration_env.py b/tests/test_integration_env.py index 07ba97a1b..018b02763 100644 --- a/tests/test_integration_env.py +++ b/tests/test_integration_env.py @@ -42,7 +42,7 @@ class PreparedReportTests(unittest.TestCase): fallback.mkdir(parents=True) for name in ('registries.json', 'commands.json'): (fallback / name).write_text('{}') - self.assertEqual(require_server_reports(resources).resolve(), fallback) + self.assertEqual(require_server_reports(resources).resolve(), fallback.resolve()) (resources / 'registries.json').write_text('{}') with self.assertRaisesRegex(ValueError, 'installed together'): require_server_reports(resources) From 108ced5793a63fee19235a94c34f14647748bd2b Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Mon, 26 Oct 2026 07:41:24 +0100 Subject: [PATCH 23/28] launcher: a Shader packs tab that installs Horizon's own shader packs The Mods page gets a fourth kind, Shader packs, which searches Horizon's registry and installs a `.hshader` into `shaderpacks/` once `index::check_file` has run the game's own `horizon_shader_api::check`. Modrinth and CurseForge answer that tab with a pointer to the registry: their shader packs are the shaders/ format and are not offered. The sample index lists a shader pack (`glow`, made with `horizon-shader new` and `pack`), so the registry build, check_file and the launcher's install are tested on a real file. A file of the same name the registry didn't put in place is no longer called a mod. Co-Authored-By: Claude Opus 5.5 --- crates/horizon-mods/src/index.rs | 2 +- .../horizon-mods/src/index/registry/tests.rs | 31 +++++++++++++-- crates/horizon-mods/src/index/tests.rs | 11 ++++-- .../tests/index/glow-1.0.0.hshader | Bin 0 -> 689 bytes crates/horizon-mods/tests/index/index-v1.json | 28 ++++++++++++++ docs/api/mod-index.md | 4 +- docs/launcher-commands.md | 2 +- docs/mod-browser.md | 16 +++++--- docs/shaders.md | 3 +- launcher/src/browser.rs | 11 +++++- launcher/src/browser/curseforge.rs | 10 ++++- launcher/src/browser/horizon.rs | 17 ++++++--- launcher/src/browser/horizon/tests.rs | 36 ++++++++++++++++++ launcher/src/browser/modrinth.rs | 6 +++ launcher/src/cli.rs | 3 ++ launcher/src/cli_tools.rs | 2 +- launcher/src/main.rs | 6 +-- launcher/src/mods_page.rs | 29 +++++++++----- 18 files changed, 178 insertions(+), 39 deletions(-) create mode 100644 crates/horizon-mods/tests/index/glow-1.0.0.hshader diff --git a/crates/horizon-mods/src/index.rs b/crates/horizon-mods/src/index.rs index 13dd69eb6..3b456c538 100644 --- a/crates/horizon-mods/src/index.rs +++ b/crates/horizon-mods/src/index.rs @@ -449,7 +449,7 @@ pub fn check_file( (None, None) => Trust::Unsigned, _ => return Err("its signature and the project's key don't go together".into()), }; - if matches!(project.kind, Kind::Shader | Kind::Other(_)) { + if matches!(project.kind, Kind::Other(_)) { return Err(format!( "this Horizon can't install a {} yet", project.kind.name() diff --git a/crates/horizon-mods/src/index/registry/tests.rs b/crates/horizon-mods/src/index/registry/tests.rs index 9e17c695f..923d64615 100644 --- a/crates/horizon-mods/src/index/registry/tests.rs +++ b/crates/horizon-mods/src/index/registry/tests.rs @@ -1,9 +1,10 @@ -//! A registry checkout holding the sample index's mod and modpack builds the -//! sample index (`tests/index/index-v1.json`) exactly. +//! A registry checkout holding the sample index's mod, modpack and shader pack +//! builds the sample index (`tests/index/index-v1.json`) exactly. use super::*; const HMOD: &str = "e1135345692f6dd8fd4c51920151944b82333e17049c9bb7d756f27b8deefc53"; const HPACK: &str = "241ac840f9c5ea3f6252d849da10c90d36cb1da4d6cd8d1d268c2760a353cd65"; +const HSHADER: &str = "331cfe29a666a0de804e9a9ff3d19d246eebcfbfa70b4f49bba8482d30ad9f02"; fn fixtures() -> PathBuf { Path::new(env!("CARGO_MANIFEST_DIR")).join("tests/index") @@ -61,6 +62,23 @@ file = "cozy-1.0.0.hpack" sha256 = "241ac840f9c5ea3f6252d849da10c90d36cb1da4d6cd8d1d268c2760a353cd65" "#; +const GLOW: &str = r#"id = "glow" +kind = "shader" +name = "Soft Glow" +summary = "A post-processing pass over the world." +authors = ["Horizon"] +owners = ["ludovic111"] +license = "MIT" +source = "https://github.com/ludovic111/horizon-mods" + +[[versions]] +version = "1.0.0" +published = "2026-10-26" +game = "26.3" +file = "glow-1.0.0.hshader" +sha256 = "331cfe29a666a0de804e9a9ff3d19d246eebcfbfa70b4f49bba8482d30ad9f02" +"#; + const REVOKED_TOML: &str = r#"[[revoked]] id = "bad_mod" sha256 = "1111111111111111111111111111111111111111111111111111111111111111" @@ -82,9 +100,14 @@ impl Scratch { let s = Scratch(dir); s.write("mods/coords_hud.toml", &hud_entry()); s.write("mods/cozy.toml", COZY); + s.write("mods/glow.toml", GLOW); s.write("revoked.toml", REVOKED_TOML); s.write("icons/coords_hud.png", "png"); - for (name, hash) in [("coords_hud-0.1.0.hmod", HMOD), ("cozy-1.0.0.hpack", HPACK)] { + for (name, hash) in [ + ("coords_hud-0.1.0.hmod", HMOD), + ("cozy-1.0.0.hpack", HPACK), + ("glow-1.0.0.hshader", HSHADER), + ] { std::fs::copy(fixtures().join(name), s.0.join("files").join(hash)).unwrap(); } s @@ -117,7 +140,7 @@ fn builds_the_sample_index() { let s = Scratch::new("sample"); let built = s.build().unwrap(); let sample = sample(); - assert_eq!(built.projects, sample.projects[..2]); + assert_eq!(built.projects, sample.projects[..3]); assert_eq!(built.revoked, sample.revoked); assert_eq!(built.generated, sample.generated); // What it writes reads back. diff --git a/crates/horizon-mods/src/index/tests.rs b/crates/horizon-mods/src/index/tests.rs index 1da921300..be5abd910 100644 --- a/crates/horizon-mods/src/index/tests.rs +++ b/crates/horizon-mods/src/index/tests.rs @@ -1,7 +1,8 @@ //! The sample index (`tests/index/index-v1.json`, the one docs/api/mod-index.md //! shows) and its files: `coords_hud-0.1.0.hmod`, signed with the throwaway -//! key `test.pub` by minisign 0.12 (its secret key was deleted), and -//! `cozy-1.0.0.hpack`, unsigned. +//! key `test.pub` by minisign 0.12 (its secret key was deleted), +//! `cozy-1.0.0.hpack`, unsigned, and `glow-1.0.0.hshader`, unsigned +//! (`horizon-shader new --template post`, then `horizon-shader pack`). use super::*; use std::path::PathBuf; @@ -25,8 +26,8 @@ fn reads_the_sample_and_keeps_unknown_kinds() { let index = sample(); assert_eq!(index.schema, SCHEMA); let kinds: Vec<&str> = index.projects.iter().map(|p| p.kind.name()).collect(); - assert_eq!(kinds, ["mod", "modpack", "world"]); - assert_eq!(index.projects[2].kind, Kind::Other("world".into())); + assert_eq!(kinds, ["mod", "modpack", "shader", "world"]); + assert_eq!(index.projects[3].kind, Kind::Other("world".into())); let hud = index.project("coords_hud").unwrap(); assert_eq!( hud.versions[0].capabilities, @@ -44,6 +45,8 @@ fn files_pass_against_their_entries() { assert_eq!(check(&index, "coords_hud", &hmod), Ok(Trust::Verified)); let hpack = fixtures().join("cozy-1.0.0.hpack"); assert_eq!(check(&index, "cozy", &hpack), Ok(Trust::Unsigned)); + let hshader = fixtures().join("glow-1.0.0.hshader"); + assert_eq!(check(&index, "glow", &hshader), Ok(Trust::Unsigned)); let world = index.project("skyblock_start").unwrap(); let e = check_file(&index, world, &world.versions[0], &hpack).unwrap_err(); assert!(e.contains("bytes"), "{e}"); diff --git a/crates/horizon-mods/tests/index/glow-1.0.0.hshader b/crates/horizon-mods/tests/index/glow-1.0.0.hshader new file mode 100644 index 0000000000000000000000000000000000000000..dda1651f89f0f8cdb22180846e9e10316dcb1680 GIT binary patch literal 689 zcmWIWW@Zs#U|`??VnqfyGh>NkK$Zz30|Q7jBfluKDnC!RI3qD7wWwIHBtJLDw|`^a zVFMnQ^19Xqdz)epB)2bewqKB(AhJqVn@J^DV5Qa1-yL2JDN64j9-e7=8s($lCl8>XMr z?^(Zdv+knQ%$+x-BJY_#X3_Mx`HfqpI`ek*?T*-ehgY)xyL#1n-ofX;X0Q0nnHPZK zZ}I8}o0)-rUIfIPKz|qH7nkUjrx)j>_MP@SY#`wJ{b$#1<%vPh1HG1t>`G#^ZaK0~ zZJxc_MXi8<@@WW=-W zBfShWkIuZ1wKR;w+GgH8IoBy0yQDT9S;ckgir(bp={v)W9*2F~uFlqK5inOy{e6&( zls3CnOs?)%n@(?+6u*?*;=Vusu<609 ze&MUzzsuZztj)B3o=x90JIU~8hdOS3ImT68O5(SZg4>MmPfMNj zX5Bo=/` and turned on | Checked from its jar before install: **Works**, **Partly** or **Doesn't run** ([below](#java-mods)) | | Resource packs | `resourcepacks/` beside `options.txt` | **Works** when made for 26.3 ([resource-packs.md](resource-packs.md) lists what Horizon reads). Older packs are **Partly**: they load with vanilla's compatibility warning | | Modpacks (`.mrpack`, CurseForge zip) | the Modpacks page's import | **Partly**: Horizon runs the mods it can port, from the player's own downloads ([modpacks.md](modpacks.md)) | +| Shader packs (`.hshader`, Horizon's registry only) | `shaderpacks/` beside `options.txt` | **Works** when made for 26.3: checked by the game's own check before install ([shaders.md](shaders.md)). The `shaders/`-format packs on Modrinth and CurseForge are not offered | By default a search shows only what runs: Java mods made for 26.3, resource packs made for 26.3, and every modpack. **Show everything** lists the rest of the kind too, each marked with how well it runs; what doesn't run is never offered for install. @@ -74,7 +75,8 @@ start); the hedge places and its recipe crafts 4. ## The Mods page -The launcher's **Mods** page has the three kinds as tabs (Mods, Modpacks, Resource packs), a search field (Enter searches), **Show everything** and +The launcher's **Mods** page has the four kinds as tabs (Mods, Modpacks, Resource packs, Shader packs; the last +searches Horizon's registry), a search field (Enter searches), **Show everything** and the source: Modrinth, with **CurseForge (coming soon)** beside it, disabled. Each result is an index row: its summary, author, downloads, source and licence, how well it runs (and why), **Page** (the project's page on its source) and **Install** (**Import** for a modpack). The Modpacks tab lists the imported packs first, with their coverage @@ -125,7 +127,8 @@ same name the player put there is never overwritten. - **Install** picks the newest version that runs, then its required dependencies, checked before any download: a dependency that isn't a pack Horizon loads (a Java mod) stops the install. Dependencies go in first. A resource - pack still has to be turned on in the game's Resource Packs screen, as in vanilla. + pack still has to be turned on in the game's Resource Packs screen, as in vanilla, and a shader pack picked in + the game's Shader Packs page. - **Update** installs the newer version and removes the old file. - **Remove** deletes the file and its entry. Packs installed as dependencies stay. - **A modpack** is downloaded (checked the same way) into `ports/downloads/`, imported, and ported straight away @@ -149,7 +152,7 @@ horizon-launcher mods remove faithful-32x ## Sources -**Horizon's registry.** Mods (`.hmod`) and resource packs made for Horizon, reviewed as pull requests in +**Horizon's registry.** Mods (`.hmod`), modpacks (`.hpack`), resource packs and shader packs (`.hshader`) made for Horizon, reviewed as pull requests in [ludovic111/horizon-mods](https://github.com/ludovic111/horizon-mods) ([api/mod-index.md](api/mod-index.md)). The launcher reads its `index.json` (`browser/horizon.rs`; `HORIZON_MOD_INDEX=` reads a test registry instead, whose files may then be on disk) at most every ten minutes, and keeps the last copy in @@ -164,7 +167,8 @@ checked pack, `pack.json` and `home/`, the profile's game folder, where each of like any registry mod and turned on or off as the pack says; its overrides (settings, resource packs, a mod's saved settings) are copied in on the first install only, so the player's changes survive updates. A pack whose mod was taken down installs nothing. It is listed on the Modpacks tab with **Play** and **Remove**, and plays like an imported pack -(`modpacks::apply_profile`). Shader packs are listed by the index but not installed by this launcher yet. +(`modpacks::apply_profile`). A shader pack goes to `shaderpacks/` once `check_file` has run the game's own +check on it (`horizon_shader_api::check`); a taken-down one is named, for the player to remove. ```sh horizon-launcher mods search --source horizon --kind mod coords # with whether it is signed and what it may do diff --git a/docs/shaders.md b/docs/shaders.md index ef8521cfe..394397193 100644 --- a/docs/shaders.md +++ b/docs/shaders.md @@ -14,7 +14,8 @@ Horizon's own format. | Templates | `crates/horizon-shader-api/templates/` | post, sky, material | | Example pack | `crates/horizon-shader-api/packs/golden_hour` | a warm sky and two post passes | | In the game: the post stage | `HORIZON_SHADER_PACK=` (for development, until the Shader Packs page) | post passes, hot reload | -| In the game: sky and material; the launcher and the registry | | not yet | +| The registry and the launcher | `shader` kind ([api/mod-index.md](api/mod-index.md)); the Mods page's Shader packs tab | checked, then installed into `shaderpacks/` | +| In the game: sky and material | | not yet | ## Quick start diff --git a/launcher/src/browser.rs b/launcher/src/browser.rs index 7f81d5e37..295ba3c08 100644 --- a/launcher/src/browser.rs +++ b/launcher/src/browser.rs @@ -28,16 +28,20 @@ pub enum Kind { Modpack, /// A Java mod: its content is ported ([`java`]). Mod, + /// One of Horizon's own shader packs (`.hshader`, docs/shaders.md), from Horizon's registry + /// only. + Shader, } impl Kind { - pub const ALL: [Kind; 3] = [Kind::Mod, Kind::Modpack, Kind::ResourcePack]; + pub const ALL: [Kind; 4] = [Kind::Mod, Kind::Modpack, Kind::ResourcePack, Kind::Shader]; pub fn label(self) -> &'static str { match self { Kind::Mod => "Mods", Kind::ResourcePack => "Resource packs", Kind::Modpack => "Modpacks", + Kind::Shader => "Shader packs", } } @@ -46,6 +50,7 @@ impl Kind { pub fn folder(self) -> Option<&'static str> { match self { Kind::ResourcePack => Some("resourcepacks"), + Kind::Shader => Some("shaderpacks"), Kind::Modpack | Kind::Mod => None, } } @@ -237,6 +242,9 @@ pub trait Source: Send + Sync { /// What the launcher says wherever CurseForge would be. pub const CURSEFORGE_SOON: &str = "CurseForge support is coming soon."; +/// What another source answers for shader packs: Horizon's own are on its registry only. +pub const SHADERS_ON_HORIZON: &str = + "Horizon's shader packs are on Horizon's registry: pick Horizon."; /// The sources this launcher uses: Modrinth and Horizon's registry. CurseForge support is coming /// soon: its API needs a paid key, so no search or install goes to it; `curseforge` is kept for @@ -277,6 +285,7 @@ pub fn support(kind: Kind, game_versions: &[String], loaders: &[String]) -> Supp Kind::Modpack => { Support::Partial("Horizon runs the mods it can port, from your own downloads.".into()) } + Kind::Shader => Support::No("Not one of Horizon's own shader packs.".into()), Kind::Mod => { if !loaders.iter().any(|l| java::LOADERS.contains(&l.as_str())) { Support::No("Not a Fabric, NeoForge or Forge mod.".into()) diff --git a/launcher/src/browser/curseforge.rs b/launcher/src/browser/curseforge.rs index e17a6b822..1db533a93 100644 --- a/launcher/src/browser/curseforge.rs +++ b/launcher/src/browser/curseforge.rs @@ -24,11 +24,16 @@ fn class(kind: Kind) -> u64 { Kind::ResourcePack => 12, Kind::Modpack => 4471, Kind::Mod => 6, + Kind::Shader => 6552, } } +/// The kind of a CurseForge class; its shader packs (the shaders/ format) are not offered. fn kind_of(class_id: u64) -> Option { - Kind::ALL.into_iter().find(|k| class(*k) == class_id) + Kind::ALL + .into_iter() + .filter(|k| *k != Kind::Shader) + .find(|k| class(*k) == class_id) } /// The key: the environment's, else the one built in. Empty counts as none. @@ -196,6 +201,9 @@ impl Source for CurseForge { } fn search(&self, query: &Query) -> Result, String> { + if query.kind == Kind::Shader { + return Err(super::SHADERS_ON_HORIZON.into()); + } let found = self.get(&search_url(query))?; Ok(found["data"] .as_array() diff --git a/launcher/src/browser/horizon.rs b/launcher/src/browser/horizon.rs index 66553ab50..1aad20734 100644 --- a/launcher/src/browser/horizon.rs +++ b/launcher/src/browser/horizon.rs @@ -111,13 +111,14 @@ fn fetch_index() -> Result<(Index, String), String> { } /// The browser's kind for a registry kind; None for one the launcher doesn't install yet -/// (shader packs, kinds newer than this launcher). +/// (kinds newer than this launcher). fn kind_of(kind: &index::Kind) -> Option { match kind { index::Kind::Mod => Some(Kind::Mod), index::Kind::ResourcePack => Some(Kind::ResourcePack), index::Kind::Modpack => Some(Kind::Modpack), - index::Kind::Shader | index::Kind::Other(_) => None, + index::Kind::Shader => Some(Kind::Shader), + index::Kind::Other(_) => None, } } @@ -372,6 +373,7 @@ fn relative(kind: Kind, id: &str, file_name: &str) -> Result { match kind { Kind::Mod => Ok(format!("{}/{id}.hmod", java::MODS_DIR)), Kind::ResourcePack => Ok(format!("resourcepacks/{file_name}")), + Kind::Shader => Ok(format!("shaderpacks/{file_name}")), Kind::Modpack => Err("A modpack installs as its own profile (pack::install).".into()), } } @@ -418,7 +420,8 @@ fn newest<'a>(index: &Index, p: &'a index::Project) -> Result<&'a index::Version }) } -/// Installs version `v` of the registry's mod or resource pack `p` into the game folder `home`. +/// Installs version `v` of the registry's mod, resource pack or shader pack `p` into the game +/// folder `home`. fn install_version( index: &Index, local: bool, @@ -447,13 +450,17 @@ fn install_version( other.title )); } - if (target.exists() && old.as_ref().is_none_or(|o| o.file != relative)) || folder_mod.exists() { + let clash = target.exists() && old.as_ref().is_none_or(|o| o.file != relative); + if project.kind == Kind::Mod && (clash || folder_mod.exists()) { return Err(format!( "A mod with the id {} is already in {}: move it away first.", p.id, java::MODS_DIR )); } + if clash { + return Err(format!("{relative} is already there: move it away first.")); + } let line = format!("{} {}", p.name, v.version); let file = &version_of(index, p, v).files[0]; let staging = home.join("mod-browser/downloads"); @@ -518,7 +525,7 @@ pub fn turn_off_revoked(index: &Index, home: &Path) -> Vec { e.title, r.reason )); } - } else if e.kind == Kind::ResourcePack { + } else if matches!(e.kind, Kind::ResourcePack | Kind::Shader) { out.push(format!( "{} was taken down: {} Remove it.", e.title, r.reason diff --git a/launcher/src/browser/horizon/tests.rs b/launcher/src/browser/horizon/tests.rs index fb99462e1..314be2050 100644 --- a/launcher/src/browser/horizon/tests.rs +++ b/launcher/src/browser/horizon/tests.rs @@ -48,6 +48,7 @@ fn searches_by_kind_and_words() { // Modpacks under Modpacks; a kind this launcher can't install yet (a world) never. assert_eq!(found("", Kind::Modpack), ["cozy"]); assert!(found("skyblock", Kind::ResourcePack).is_empty()); + assert_eq!(found("", Kind::Shader), ["glow"]); let p = hud(&index); assert_eq!(p.support(), super::super::Support::Works); assert_eq!(p.page, "https://playhorizon.dev/mods/coords_hud"); @@ -95,6 +96,41 @@ fn installs_checked_turns_on_and_removes() { fs::remove_dir_all(&home).unwrap(); } +#[test] +fn installs_a_shader_pack_into_shaderpacks() { + let index = sample(); + let home = scratch("shader"); + let p = project_of(index.project("glow").unwrap()).unwrap(); + assert_eq!(p.support(), super::super::Support::Works); + let done = install_from(&index, true, &p, &home, &|_, _| {}).unwrap(); + assert_eq!(done[0].file, "shaderpacks/glow-1.0.0.hshader"); + assert_eq!(done[0].kind, Kind::Shader); + assert!(home.join("shaderpacks/glow-1.0.0.hshader").is_file()); + // Not a mod: nothing turns on in horizon-mods.txt; the game's Shader Packs page picks it. + assert!(!home.join("horizon-mods.txt").exists()); + + let mut revoked = index.clone(); + revoked.revoked.push(index::Revoked { + id: "glow".into(), + sha256: None, + reason: "Test.".into(), + date: String::new(), + }); + let said = turn_off_revoked(&revoked, &home); + assert_eq!(said, ["Soft Glow was taken down: Test. Remove it."]); + + installed::remove(&home, "glow").unwrap(); + assert!(!home.join("shaderpacks/glow-1.0.0.hshader").exists()); + // A file of the same name the registry didn't put there is left alone. + fs::write(home.join("shaderpacks/glow-1.0.0.hshader"), b"mine").unwrap(); + let e = install_from(&index, true, &p, &home, &|_, _| {}).unwrap_err(); + assert_eq!( + e, + "shaderpacks/glow-1.0.0.hshader is already there: move it away first." + ); + fs::remove_dir_all(&home).unwrap(); +} + #[test] fn refuses_a_changed_file_a_taken_id_and_local_files_from_the_real_registry() { let index = sample(); diff --git a/launcher/src/browser/modrinth.rs b/launcher/src/browser/modrinth.rs index 52e0aa7f0..dabd9a604 100644 --- a/launcher/src/browser/modrinth.rs +++ b/launcher/src/browser/modrinth.rs @@ -13,12 +13,15 @@ fn project_type(kind: Kind) -> &'static str { Kind::ResourcePack => "resourcepack", Kind::Modpack => "modpack", Kind::Mod => "mod", + Kind::Shader => "shader", } } +/// The kind of a Modrinth project; its shader packs (the shaders/ format) are not offered. fn kind_of(project_type: &str) -> Option { Kind::ALL .into_iter() + .filter(|k| *k != Kind::Shader) .find(|k| self::project_type(*k) == project_type) } @@ -170,6 +173,9 @@ impl Source for Modrinth { } fn search(&self, query: &Query) -> Result, String> { + if query.kind == Kind::Shader { + return Err(super::SHADERS_ON_HORIZON.into()); + } let found = get(&search_url(query))?; Ok(found["hits"] .as_array() diff --git a/launcher/src/cli.rs b/launcher/src/cli.rs index 25bbe0bee..64ddb1bd2 100644 --- a/launcher/src/cli.rs +++ b/launcher/src/cli.rs @@ -210,6 +210,8 @@ enum KindArg { Mod, Resource, Modpack, + /// Horizon's own shader packs (Horizon's registry only) + Shader, } #[derive(Clone, Copy, clap::ValueEnum)] @@ -1120,6 +1122,7 @@ fn mods(action: ModsCmd, as_json: bool) -> Result<(), String> { KindArg::Resource => Kind::ResourcePack, KindArg::Modpack => Kind::Modpack, KindArg::Mod => Kind::Mod, + KindArg::Shader => Kind::Shader, }; let query = Query { everything, diff --git a/launcher/src/cli_tools.rs b/launcher/src/cli_tools.rs index e420576b5..45763296a 100644 --- a/launcher/src/cli_tools.rs +++ b/launcher/src/cli_tools.rs @@ -394,7 +394,7 @@ mod tests { let kinds = &schema["inputSchema"]["properties"]["kind"]["enum"]; assert!( kinds.as_array().unwrap().contains(&json!("modpack")) - && !kinds.as_array().unwrap().contains(&json!("shader")), + && kinds.as_array().unwrap().contains(&json!("shader")), "{kinds}" ); assert_eq!( diff --git a/launcher/src/main.rs b/launcher/src/main.rs index 9105f71a2..7d778b6b9 100644 --- a/launcher/src/main.rs +++ b/launcher/src/main.rs @@ -54,11 +54,11 @@ enum Page { } impl Page { - /// `HORIZON_LAUNCHER_PAGE=mods` (or `modpacks`, `servers`, `versions`, `notes`, `settings`) - /// opens on that page, for screenshots; Home otherwise. + /// `HORIZON_LAUNCHER_PAGE=mods` (or `modpacks`, `shaders`, `servers`, `versions`, `notes`, + /// `settings`) opens on that page, for screenshots; Home otherwise. fn from_env() -> Page { match std::env::var("HORIZON_LAUNCHER_PAGE").as_deref() { - Ok("mods" | "modpacks") => Page::Mods, + Ok("mods" | "modpacks" | "shaders") => Page::Mods, Ok("servers") => Page::Servers, Ok("versions") => Page::Versions, Ok("notes") => Page::Notes, diff --git a/launcher/src/mods_page.rs b/launcher/src/mods_page.rs index 50434756c..e6ebedc5b 100644 --- a/launcher/src/mods_page.rs +++ b/launcher/src/mods_page.rs @@ -14,10 +14,11 @@ use horizon_port_pack::check::Check; use std::collections::HashMap; /// The kinds, as the Mods page's tabs: name and icon. -const KINDS: [(PackKind, &str, &str); 3] = [ +const KINDS: [(PackKind, &str, &str); 4] = [ (PackKind::Mod, "Mods", "box"), (PackKind::Modpack, "Modpacks", "archive"), (PackKind::ResourcePack, "Resource packs", "image"), + (PackKind::Shader, "Shader packs", "zap"), ]; /// Java mods checked at once. const CHECKING: usize = 2; @@ -99,14 +100,18 @@ impl Mods { pub(super) fn new(cx: &mut App) -> Self { let (tx, rx) = channel(); + let page = std::env::var("HORIZON_LAUNCHER_PAGE"); + let kind = match page.as_deref() { + Ok("modpacks") => PackKind::Modpack, + Ok("shaders") => PackKind::Shader, + _ => PackKind::Mod, + }; Self { - kind: if std::env::var("HORIZON_LAUNCHER_PAGE").as_deref() == Ok("modpacks") { - PackKind::Modpack - } else { - PackKind::Mod - }, - // `HORIZON_LAUNCHER_SOURCE=horizon` opens on Horizon's registry, for screenshots. + kind, + // `HORIZON_LAUNCHER_SOURCE=horizon` opens on Horizon's registry, for screenshots; + // shader packs are only there. source: match std::env::var("HORIZON_LAUNCHER_SOURCE").as_deref() { + _ if kind == PackKind::Shader => SourceId::Horizon, Ok("horizon") => SourceId::Horizon, _ => SourceId::Modrinth, }, @@ -602,9 +607,9 @@ impl Launcher { } let header = page_header( "Mods", - "Mods made for Horizon from its own reviewed registry, and Java mods, modpacks and \ - resource packs from Modrinth: Horizon ports what a Java mod carries (blocks, items, \ - recipes, worldgen) and says before you install what runs. Each file is checked \ + "Mods and shader packs made for Horizon from its own reviewed registry, and Java \ + mods, modpacks and resource packs from Modrinth: Horizon ports what a Java mod \ + carries (blocks, items, recipes, worldgen) and says before you install what runs. Each file is checked \ against its source's checksum before it reaches your game folder.", &t, ); @@ -615,6 +620,10 @@ impl Launcher { let _ = this.update(cx, |this, cx| { if this.mods.kind != kind { this.mods.kind = kind; + // Horizon's own shader packs are on its registry only. + if kind == PackKind::Shader { + this.mods.source = SourceId::Horizon; + } // Categories and loaders differ by kind. this.mods.browse.filters = Default::default(); this.mods.browse.open = None; From 8cc8c6180d729d345d41d4bc0093d8108ca5c730 Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Mon, 26 Oct 2026 10:38:57 +0100 Subject: [PATCH 24/28] Mod API levels: refuse a mod made for a newer Horizon, list each version's level Every function the game offers mods has the API level it arrived at (crates/horizon-mods/src/api_level.rs): level 0 is the contract of Horizon 0.2.67 and 0.2.68, level 1 adds render.set-minimap. A mod needs the level of the newest function it imports, read from its component. - The game refuses a mod that calls a function it doesn't have with "made for a newer Horizon (it uses ...): update Horizon to run it" instead of wasmtime's linking error. - The registry index lists each mod version's level (api_level, read from the file by CI); check_file compares it when the entry has one, and the moved extras' installer takes the newest version this game can run. - cargo horizon-mod check prints the level. - The api_reference test fails until a new WIT function has a level. Co-Authored-By: Claude Opus 5.5 --- Cargo.lock | 24 +++ crates/cargo-horizon-mod/src/check.rs | 4 + crates/horizon-client/src/moved_extras.rs | 22 +-- crates/horizon-mods/Cargo.toml | 11 +- crates/horizon-mods/src/api_level.rs | 151 ++++++++++++++++++ crates/horizon-mods/src/index.rs | 33 +++- crates/horizon-mods/src/index/registry.rs | 1 + crates/horizon-mods/src/index/tests.rs | 33 ++++ crates/horizon-mods/src/lib.rs | 1 + crates/horizon-mods/src/runtime.rs | 6 + crates/horizon-mods/tests/api_reference.rs | 35 ++++ crates/horizon-mods/tests/index/index-v1.json | 1 + crates/horizon-mods/tests/sandbox.rs | 59 +++++++ docs/api/mod-index.md | 6 +- docs/api/stability.md | 16 ++ docs/mods.md | 6 + launcher/Cargo.lock | 19 +++ 17 files changed, 412 insertions(+), 16 deletions(-) create mode 100644 crates/horizon-mods/src/api_level.rs diff --git a/Cargo.lock b/Cargo.lock index ae1738593..db77c7d35 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1443,6 +1443,7 @@ dependencies = [ "serde_json", "sha2", "toml", + "wasmparser", "wasmtime", "wit-component", "wit-parser", @@ -4147,6 +4148,28 @@ dependencies = [ "wit-parser", ] +[[package]] +name = "wast" +version = "254.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "febc59cde513fc8f39b8ffd487893723c555fdd024e2e3dc7d165181e6397ea0" +dependencies = [ + "bumpalo", + "leb128fmt", + "memchr", + "unicode-width", + "wasm-encoder", +] + +[[package]] +name = "wat" +version = "1.254.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7db96351e51a3a1bbe6812f029e1100b4d9a5e02161fb63104bd2271fc847e7e" +dependencies = [ + "wast", +] + [[package]] name = "wayland-backend" version = "0.3.17" @@ -5005,6 +5028,7 @@ dependencies = [ "wasm-encoder", "wasm-metadata", "wasmparser", + "wat", "wit-parser", ] diff --git a/crates/cargo-horizon-mod/src/check.rs b/crates/cargo-horizon-mod/src/check.rs index cf2968858..6e6913058 100644 --- a/crates/cargo-horizon-mod/src/check.rs +++ b/crates/cargo-horizon-mod/src/check.rs @@ -46,6 +46,7 @@ impl Report { "api": self.facts.api, "side": self.facts.side, "capabilities": self.facts.capabilities, + "api_level": self.facts.api_level, "game": self.facts.game, "requires": requires, "sha256": self.sha256, @@ -84,6 +85,9 @@ impl Report { ")\n {} bytes, SHA-256 {}, {signed}\n", self.size, self.sha256 ); + if let Some(level) = f.api_level { + out += &format!(" needs mod API level {level} or newer\n"); + } for c in &f.capabilities { out += &format!(" may {}\n", c.describe()); } diff --git a/crates/horizon-client/src/moved_extras.rs b/crates/horizon-client/src/moved_extras.rs index 3b5db6fbc..ce949047d 100644 --- a/crates/horizon-client/src/moved_extras.rs +++ b/crates/horizon-client/src/moved_extras.rs @@ -149,21 +149,21 @@ pub fn fetch_index() -> Result { /// Installs `m` into the game folder `dir` (where `options.txt` is), for a /// player whose extras were `e`: its newest version for this game that -/// wasn't taken down, checked against the index (size, SHA-256, signature, -/// manifest), as `horizon-mods/.hmod`, turned on, with the extra's -/// settings in its storage unless the mod has its own already. +/// wasn't taken down and that this Horizon's mod API level runs, checked +/// against the index (size, SHA-256, signature, manifest), as +/// `horizon-mods/.hmod`, turned on, with the extra's settings in its +/// storage unless the mod has its own already. pub fn install(index: &Index, m: &Moved, e: &Extras, dir: &Path) -> Result<(), String> { let project = index .project(m.id) .ok_or_else(|| format!("{} isn't in Horizon's registry yet", m.id))?; - let version = project - .versions - .iter() - .find(|v| { - v.game == horizon_core::version::VERSION_ID - && index.revoked(&project.id, &v.file.sha256).is_none() - }) - .ok_or_else(|| format!("{} has no version for this game", m.id))?; + let version = index + .installable( + project, + horizon_core::version::VERSION_ID, + horizon_mods::api_level::LEVEL, + ) + .ok_or_else(|| format!("{} has no version this Horizon can run", m.id))?; let mods = dir.join(crate::mod_list::DIR); fs::create_dir_all(&mods).map_err(|e| format!("{}: {e}", mods.display()))?; let target = mods.join(format!("{}.hmod", m.id)); diff --git a/crates/horizon-mods/Cargo.toml b/crates/horizon-mods/Cargo.toml index a398e4d8b..bbe8f2572 100644 --- a/crates/horizon-mods/Cargo.toml +++ b/crates/horizon-mods/Cargo.toml @@ -17,18 +17,25 @@ wasmtime = { version = "48.0.7", default-features = false, features = ["runtime" # Turns a mod's core module into a component (cargo horizon-mod build, the tests). wit-component = { version = "0.254", optional = true } wit-parser = { version = "0.254", optional = true } +# The functions a mod imports, for its API level (src/api_level.rs): the game and the registry index. +wasmparser = { version = "0.254", optional = true } # The registry index's checks (feature `index`): SHA-256, and minisign signatures (no dependencies of its own). sha2 = { version = "0.10", optional = true } minisign-verify = { version = "0.3", optional = true } +[dev-dependencies] +# A component made for a newer Horizon, from the WIT alone (tests/sandbox.rs). +wit-component = { version = "0.254", features = ["dummy-module"] } +wit-parser = "0.254" + [features] # Loads and runs mods (the game's `mods` feature); without it only manifests, # content and packaging. Off by default so builds that don't run mods (the # game's tests and probes) skip wasmtime and cranelift. -runtime = ["dep:wasmtime"] +runtime = ["dep:wasmtime", "dep:wasmparser"] pack = ["dep:wit-component", "dep:wit-parser"] # The mod registry's index (docs/api/mod-index.md): the launcher, the registry server and its CI. -index = ["dep:sha2", "dep:minisign-verify"] +index = ["dep:sha2", "dep:minisign-verify", "dep:wasmparser"] # Runs real mods: `cargo test -p horizon-mods --features runtime,pack`. [[test]] diff --git a/crates/horizon-mods/src/api_level.rs b/crates/horizon-mods/src/api_level.rs new file mode 100644 index 000000000..a81cf27bc --- /dev/null +++ b/crates/horizon-mods/src/api_level.rs @@ -0,0 +1,151 @@ +//! Mod API levels: which of the WIT contract's functions a Horizon has +//! (`docs/api/stability.md`). Every function the game offers mods has the +//! level it arrived at; a Horizon serves every level up to its [`LEVEL`]. +//! A mod needs the level of the newest function it imports, so a mod that +//! calls a function this Horizon doesn't have is refused with "update +//! Horizon" instead of a linking error, and the registry lists each +//! version's level so the launcher can tell before it installs. + +/// The newest level this Horizon serves. +pub const LEVEL: u32 = 1; + +/// Every function the game offers mods, as `interface.function`, with its +/// level. Level 0 is the contract of Horizon 0.2.67 and 0.2.68. A new +/// function takes the next level and raises [`LEVEL`] (the `api_reference` +/// test fails until it is listed here). +pub const FUNCTIONS: [(&str, u32); 29] = [ + ("log.write", 0), + ("game.get-player", 0), + ("game.get-clock", 0), + ("chat.show", 0), + ("hud.set-panel", 0), + ("hud.clear", 0), + ("storage.get", 0), + ("storage.set", 0), + ("storage.delete", 0), + ("command.run", 0), + ("ui.open-screen", 0), + ("ui.close-screen", 0), + ("ui.set-settings", 0), + ("input.claim-items", 0), + ("input.register-key", 0), + ("input.held", 0), + ("input.poll", 0), + ("input.claim-wheel", 0), + ("input.mapping", 0), + ("input.clicks-per-second", 0), + ("render.set-hud", 0), + ("render.gui-size", 0), + ("render.shake", 0), + ("render.set-corner", 0), + ("render.clear-corner", 0), + ("render.text-width", 0), + ("render.frame-stats", 0), + ("render.set-zoom", 0), + ("render.set-minimap", 1), +]; + +/// A function's level; None for one this Horizon doesn't have. +pub fn level_of(function: &str) -> Option { + FUNCTIONS + .iter() + .find(|(name, _)| *name == function) + .map(|&(_, level)| level) +} + +/// The level a mod needs, from the functions it imports (as [`imports`] +/// names them): its newest function's. A function this Horizon doesn't +/// know comes from a newer one, so it needs more than [`LEVEL`]; that +/// function is returned with it, for the message. +pub fn needed<'a>(imports: impl IntoIterator) -> (u32, Option<&'a str>) { + let mut needed = (0, None); + for name in imports { + match level_of(name) { + Some(level) if level > needed.0 => needed = (level, Some(name)), + Some(_) => {} + None => return (LEVEL + 1, Some(name)), + } + } + needed +} + +/// Why this Horizon can't run a mod that needs `level`, or None when it can. +pub fn too_new(level: u32, function: Option<&str>) -> Option { + (level > LEVEL).then(|| { + let uses = function.map_or(String::new(), |f| format!(" (it uses {f})")); + format!("made for a newer Horizon{uses}: update Horizon to run it") + }) +} + +/// The functions a mod's component imports from Horizon (`horizon:mods/*`), +/// as `interface.function`, in the component's order. +#[cfg(any(feature = "runtime", feature = "index"))] +pub fn imports(wasm: &[u8]) -> Result, String> { + use wasmparser::{ + Parser, Payload, Validator, WasmFeatures, component_types::ComponentEntityType, + }; + let types = Validator::new_with_features(WasmFeatures::all()) + .validate_all(wasm) + .map_err(|e| format!("not a component: {e}"))?; + let types = types.as_ref(); + let mut out = Vec::new(); + for payload in Parser::new(0).parse_all(wasm) { + let Payload::ComponentImportSection(section) = payload.map_err(|e| e.to_string())? else { + continue; + }; + for import in section { + let name = import.map_err(|e| e.to_string())?.name.name; + // `horizon:mods/render@0.1.0` → `render`. + let Some(interface) = name.strip_prefix("horizon:mods/") else { + continue; + }; + let interface = interface.split('@').next().unwrap_or(interface); + let Some(item) = types.component_item_for_import(name) else { + continue; + }; + if let ComponentEntityType::Instance(id) = item.ty { + for (function, export) in &types[id].exports { + if matches!(export.ty, ComponentEntityType::Func(_)) { + out.push(format!("{interface}.{function}")); + } + } + } + } + } + Ok(out) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn levels_are_listed_once_and_up_to_this_horizons() { + for (i, (name, level)) in FUNCTIONS.iter().enumerate() { + assert!(*level <= LEVEL, "{name}"); + assert!( + FUNCTIONS[..i].iter().all(|(other, _)| other != name), + "{name} twice" + ); + } + assert!(FUNCTIONS.iter().any(|&(_, level)| level == LEVEL)); + } + + #[test] + fn a_mod_needs_its_newest_function() { + assert_eq!(needed(["log.write", "hud.set-panel"]), (0, None)); + assert_eq!( + needed(["log.write", "render.set-minimap", "hud.clear"]), + (1, Some("render.set-minimap")) + ); + assert_eq!( + needed(["render.set-minimap", "render.set-sky"]), + (LEVEL + 1, Some("render.set-sky")) + ); + assert_eq!(too_new(LEVEL, None), None); + assert_eq!( + too_new(LEVEL + 1, Some("render.set-sky")).as_deref(), + Some("made for a newer Horizon (it uses render.set-sky): update Horizon to run it") + ); + } +} diff --git a/crates/horizon-mods/src/index.rs b/crates/horizon-mods/src/index.rs index db860fd9f..f7716eefa 100644 --- a/crates/horizon-mods/src/index.rs +++ b/crates/horizon-mods/src/index.rs @@ -137,6 +137,11 @@ pub struct Version { pub side: Option, #[serde(default, skip_serializing_if = "Vec::is_empty")] pub capabilities: Vec, + /// The mod API level a mod's code needs ([`crate::api_level`]), read + /// from its file; none for content and other kinds, and in indexes + /// built before levels. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub api_level: Option, /// The Minecraft version it is for. pub game: String, /// A modpack's mods, as its manifest lists them. @@ -316,6 +321,21 @@ impl Index { Ok(()) } + /// A project's newest version for Minecraft `game` that wasn't taken + /// down and that a Horizon serving mod API `level` can run (an unknown + /// level counts as runnable: the game still checks when it starts it). + pub fn installable<'a>( + &self, + project: &'a Project, + game: &str, + level: u32, + ) -> Option<&'a Version> { + project.versions.iter().find(|v| { + v.game == game + && v.api_level.is_none_or(|l| l <= level) + && self.revoked(&project.id, &v.file.sha256).is_none() + }) + } pub fn project(&self, id: &str) -> Option<&Project> { self.projects.iter().find(|p| p.id == id) } @@ -471,6 +491,8 @@ pub struct Facts { pub side: Option, /// In the manifest's order. pub capabilities: Vec, + /// The mod API level a mod's code needs, from the functions it imports. + pub api_level: Option, /// The Minecraft version, when the file names one (a modpack does). pub game: Option, pub requires: Vec, @@ -487,6 +509,7 @@ impl Facts { || self.api != version.api || self.side != version.side || caps != listed + || version.api_level.is_some() && self.api_level != version.api_level || self.game.as_ref().is_some_and(|g| *g != version.game) || self.requires != version.requires; if !differs { @@ -514,9 +537,17 @@ impl Facts { pub fn inspect(kind: &Kind, path: &Path) -> Result { match kind { Kind::Mod => { - let m = Package::read(path)?.manifest; + let Package { manifest: m, wasm } = Package::read(path)?; crate::Content::read(path, &m)?; + let api_level = match wasm { + Some(wasm) => { + let functions = crate::api_level::imports(&wasm)?; + Some(crate::api_level::needed(functions.iter().map(String::as_str)).0) + } + None => None, + }; Ok(Facts { + api_level, capabilities: m.capabilities, id: Some(m.id), version: Some(m.version), diff --git a/crates/horizon-mods/src/index/registry.rs b/crates/horizon-mods/src/index/registry.rs index 21b5de9fb..90453c621 100644 --- a/crates/horizon-mods/src/index/registry.rs +++ b/crates/horizon-mods/src/index/registry.rs @@ -283,6 +283,7 @@ fn version(entry: &Entry, v: &EntryVersion, src: &Sources) -> Result = package + .worlds + .values() + .flat_map(|&w| resolve.worlds[w].exports.values()) + .filter_map(|item| match item { + WorldItem::Interface { id, .. } => Some(*id), + _ => None, + }) + .collect(); + let mut offered = Vec::new(); + for (name, &id) in &package.interfaces { + if !exported.contains(&id) { + for function in resolve.interfaces[id].functions.keys() { + offered.push(format!("{name}.{function}")); + } + } + } + for f in &offered { + assert!( + horizon_mods::api_level::level_of(f).is_some(), + "{f} has no level in crates/horizon-mods/src/api_level.rs: add it at the next level" + ); + } + for (f, _) in horizon_mods::api_level::FUNCTIONS { + assert!(offered.iter().any(|o| o == f), "{f} isn't in the WIT"); + } +} diff --git a/crates/horizon-mods/tests/index/index-v1.json b/crates/horizon-mods/tests/index/index-v1.json index 215c94667..95ac938b7 100644 --- a/crates/horizon-mods/tests/index/index-v1.json +++ b/crates/horizon-mods/tests/index/index-v1.json @@ -29,6 +29,7 @@ "hud", "chat" ], + "api_level": 0, "game": "26.3", "file": { "name": "coords_hud-0.1.0.hmod", diff --git a/crates/horizon-mods/tests/sandbox.rs b/crates/horizon-mods/tests/sandbox.rs index 0be4fa47d..b7389ca29 100644 --- a/crates/horizon-mods/tests/sandbox.rs +++ b/crates/horizon-mods/tests/sandbox.rs @@ -193,6 +193,65 @@ fn undeclared_capabilities_are_refused() { assert_eq!(mods.entries()[0].status, refused); } +/// A mod calling a function this Horizon doesn't have is refused with +/// "update Horizon", not a linking error; the test mods' levels are read +/// from the functions they import. +#[test] +fn a_mod_for_a_newer_horizon_is_refused() { + use horizon_mods::api_level::{LEVEL, imports, needed}; + use wit_parser::{ManglingAndAbi, Resolve}; + let root = Path::new(env!("CARGO_MANIFEST_DIR")).join("../.."); + let wit = std::fs::read_to_string(root.join("crates/horizon-mod-sdk/wit/horizon.wit")) + .unwrap() + .replace( + " set-minimap: func(minimap: option);", + " set-minimap: func(minimap: option);\n set-sky: func(on: bool);", + ); + let mut resolve = Resolve::default(); + let package = resolve.push_str("horizon.wit", &wit).unwrap(); + let world = resolve + .select_world(&[package], Some("horizon-ui-mod")) + .unwrap(); + let mut module = wit_component::dummy_module(&resolve, world, ManglingAndAbi::Standard32); + wit_component::embed_component_metadata( + &mut module, + &resolve, + world, + wit_component::StringEncoding::UTF8, + ) + .unwrap(); + let wasm = wit_component::ComponentEncoder::default() + .module(&module) + .unwrap() + .encode() + .unwrap(); + let functions = imports(&wasm).unwrap(); + assert!(functions.iter().any(|f| f == "render.set-sky")); + let dir = mods_dir().join("too_new"); + std::fs::create_dir_all(&dir).unwrap(); + let manifest = r#" +id = "too_new" +name = "Too New" +version = "0.1.0" +api = "0.1" +capabilities = ["game-read", "chat", "hud", "storage", "command", "ui", "render", "input"] +experimental = ["ui", "render", "input"] +"#; + std::fs::write(dir.join("horizon-mod.toml"), manifest).unwrap(); + std::fs::write(dir.join("mod.wasm"), wasm).unwrap(); + let mods = Mods::load(&[dir], |_| true, |_| false); + let refused = "made for a newer Horizon (it uses render.set-sky): update Horizon to run it"; + assert_eq!(mods.entries()[0].status, Status::Failed(refused.into())); + + let level = |file: &str| { + let wasm = Package::read(&mods_dir().join(file)).unwrap().wasm.unwrap(); + needed(imports(&wasm).unwrap().iter().map(String::as_str)).0 + }; + assert_eq!(level("coords_hud.hmod"), 0); + // The UI guest shows a minimap (`render.set-minimap`). + assert_eq!(level("horizon_mods_test_ui_guest.hmod"), LEVEL); +} + #[test] fn vanilla_commands_win() { let mods = Mods::load( diff --git a/docs/api/mod-index.md b/docs/api/mod-index.md index 6b807d950..46191198a 100644 --- a/docs/api/mod-index.md +++ b/docs/api/mod-index.md @@ -21,7 +21,7 @@ Level: preview ([stability.md](stability.md)). Schema 1. "license": "MIT", "source": "https://github.com/...", "icon": "https://...png", "key": "RWT...", "versions": [{ "version": "0.1.0", "published": "2026-10-24", "changelog": "", - "api": "0.1", "side": "client", "capabilities": ["game-read", "hud", "chat"], "game": "26.3", + "api": "0.1", "side": "client", "capabilities": ["game-read", "hud", "chat"], "api_level": 0, "game": "26.3", "file": { "name": "coords_hud-0.1.0.hmod", "url": "https://github.com/ludovic111/horizon-mods/releases/download/...", "size": 438, "sha256": "e113...", "signature": "untrusted comment: ...\n...\ntrusted comment: ...\n...\n" } }] @@ -43,6 +43,7 @@ Level: preview ([stability.md](stability.md)). Schema 1. | `versions` | Newest first, at least one. | | `api` | A mod's API line (its manifest's `api`); a modpack's manifest format (`1`). | | `side`, `capabilities` | A mod's, read from its manifest by CI, never typed by hand. | +| `api_level` | The mod API level a mod's code needs ([stability.md](stability.md#mod-api-levels)): its newest imported function's, read from the file by CI. Absent for content-only mods and in indexes built before levels. Installers take the newest version whose level the running game serves. | | `game` | The Minecraft version it is for. | | `requires` | A modpack's mods: `{ id, version, sha256 }`, each a version in this index with that hash. | | `file` | A plain name with the kind's extension (`.hmod`, `.hpack`, `.zip`), an `https://` URL, the size (at most 64 MiB), the lowercase hex SHA-256, and the `.minisig` text when the project has a key. | @@ -57,7 +58,8 @@ changing what one means, makes schema 2. 1. Its size and SHA-256 are the ones the entry lists, and it isn't revoked. 2. With a project key: its signature verifies with that key (minisign's prehashed and legacy signatures both). -3. What the file says matches the entry: a mod's `horizon-mod.toml` (id, version, API, side, capabilities) and its +3. What the file says matches the entry: a mod's `horizon-mod.toml` (id, version, API, side, capabilities), its API + level when the entry lists one, and its content's fence ([mods.md](../mods.md#content-mods-api-02)); a modpack's manifest (id, version, format, game, mods); a resource pack's `pack.mcmeta`. 4. A kind this build can't install is refused with "this Horizon can't install a … yet". diff --git a/docs/api/stability.md b/docs/api/stability.md index 5c1b32362..38df0836f 100644 --- a/docs/api/stability.md +++ b/docs/api/stability.md @@ -34,6 +34,22 @@ Not breaking: a new function, interface, capability, command, endpoint, tool or argument or JSON field (readers must ignore fields they don't know); a new WIT function or type (mods built earlier don't import it); faster, or fixing behaviour to what the reference already says. +### Mod API levels + +A new WIT function doesn't break older mods, but a mod that calls it can't run on a Horizon from before it. So every +function the game offers mods has an **API level**, the one it arrived at (`crates/horizon-mods/src/api_level.rs`): +level 0 is the contract of Horizon 0.2.67 and 0.2.68, level 1 adds `render.set-minimap`. A mod needs the level of +the newest function it imports (a component imports only the functions it calls). The level is read from the file, +never declared: + +- the game refuses a mod that needs a function it doesn't have, with "made for a newer Horizon (it uses + render.set-minimap): update Horizon to run it", instead of a linking error; +- the registry's CI writes each mod version's level into the index (`api_level`), and installers take the newest + version the running game can run. + +A pull request that adds a function lists it in `api_level.rs` at the next level and raises `LEVEL`; the +`api_reference` test fails until it does. + ## Stability levels Every part of an API has one level, shown in its reference and its surface page. diff --git a/docs/mods.md b/docs/mods.md index e13e362e5..f0a29c865 100644 --- a/docs/mods.md +++ b/docs/mods.md @@ -501,6 +501,12 @@ so the same rustc and `Cargo.lock` give the same file. release cycle, so existing mods keep working while authors move. - The manifest's `api` names the line it needs (`0.1`); the game refuses a line it does not serve with a clear message. +- Within a line, each function has an API level, the one it arrived at + ([stability](api/stability.md#mod-api-levels)). A mod needs the level of + the newest function it calls, read from its file: an older Horizon refuses + it with "made for a newer Horizon: update Horizon", and the registry lists + the level so installers take a version the game can run. + `cargo horizon-mod check` prints it ("needs mod API level 1 or newer"). - Horizon follows Minecraft releases; the mod API does not have to. Vanilla concepts mods see (dimensions, block and item ids) are the game's own ids, so a version port changes the data, not the API. diff --git a/launcher/Cargo.lock b/launcher/Cargo.lock index ee0cb882a..157944d55 100644 --- a/launcher/Cargo.lock +++ b/launcher/Cargo.lock @@ -2560,6 +2560,11 @@ name = "hashbrown" version = "0.17.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "ed5909b6e89a2db4456e54cd5f673791d7eca6732202bbf2a9cc504fe2f9b84a" +dependencies = [ + "foldhash 0.2.0", + "serde", + "serde_core", +] [[package]] name = "heck" @@ -2706,6 +2711,7 @@ dependencies = [ "serde_json", "sha2 0.10.9", "toml 1.1.8+spec-1.1.0", + "wasmparser", "zip", ] @@ -6516,6 +6522,19 @@ dependencies = [ "web-sys", ] +[[package]] +name = "wasmparser" +version = "0.254.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c5ff8685b587722894b6f25958fc608d315b93b8d23647bfb567664e7006d757" +dependencies = [ + "bitflags 2.13.2", + "hashbrown 0.17.1", + "indexmap", + "semver", + "serde", +] + [[package]] name = "wayland-backend" version = "0.3.17" From e3e08911ba77eea2fb561c8879f109f00fab9cd1 Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Mon, 26 Oct 2026 10:48:58 +0100 Subject: [PATCH 25/28] parity: run lan_integration only when named and in the nightly audit The harness runs the whole lan_e2e suite: ~40 minutes on a loaded runner, and single checks flake under load (barter, riding, shulker_bullets in one run; cursor, falling in another, all passing on rerun). Selected by --changed it would run on most gameplay pull requests and on parity-main. tools/parity_hosts.json gains a named_only table that every automatic selection (--changed, --failed, the default, --flake-check) leaves out; naming the harness or --all (the nightly audit) still runs it. Co-Authored-By: Claude Opus 5.5 --- docs/parity-workflow.md | 10 +++++++--- tests/test_parity_runner.py | 5 +++++ tools/parity.py | 15 ++++++++++++++- tools/parity_hosts.json | 5 ++++- 4 files changed, 30 insertions(+), 5 deletions(-) diff --git a/docs/parity-workflow.md b/docs/parity-workflow.md index 9153949df..bbb7512df 100644 --- a/docs/parity-workflow.md +++ b/docs/parity-workflow.md @@ -123,9 +123,13 @@ callers. Run Linux games under `xvfb-run -a` when no display is available. Each process gets scratch game, launcher, XDG data and config homes; telemetry, audio and launcher self-update are disabled. -`lan_integration` and `friends_integration` register these suites with the normal -`parity.py` selection used by CI. Their traced imports and Cargo artifacts select -them when the drivers or game implementation change. LAN writes `results.json` +`lan_integration` and `friends_integration` register these suites with `parity.py`. +`friends_integration` (under a minute) is selected like any harness when the +drivers or game implementation change. `lan_integration` is the whole LAN suite +(~40 minutes on a loaded runner, and single checks flake under load), so +`tools/parity_hosts.json` lists it under `named_only`: no automatic selection +(`--changed`, `--failed`, `--flake-check`, CI, parity-main) picks it; it runs +when named and in the nightly audit (`--all`). LAN writes `results.json` with the host mode and each result beside its screenshots and logs. A skipped case is recorded explicitly and does not count as passing coverage. diff --git a/tests/test_parity_runner.py b/tests/test_parity_runner.py index 2d16e7179..a85f1e969 100644 --- a/tests/test_parity_runner.py +++ b/tests/test_parity_runner.py @@ -145,6 +145,11 @@ class ParityRunnerTests(unittest.TestCase): with mock.patch.object(parity.sys, "platform", "darwin"): self.assertEqual(parity.platform_skips(config), {"options": "libm"}) + def test_named_only_harnesses_are_listed_from_the_host_config(self): + self.assertEqual(parity.named_only({"named_only": {"lan_integration": "slow"}}), {"lan_integration": "slow"}) + self.assertEqual(parity.named_only({}), {}) + self.assertIn("lan_integration", parity.named_only(parity.host_config())) + def test_a_pass_from_another_worktree_counts_only_for_the_same_content(self): with tempfile.TemporaryDirectory() as temp: elsewhere, here, shared = Path(temp, "a"), Path(temp, "b"), Path(temp, "shared") diff --git a/tools/parity.py b/tools/parity.py index 3f18b922d..4c2cd5426 100644 --- a/tools/parity.py +++ b/tools/parity.py @@ -11,6 +11,9 @@ python3 tools/parity.py --list # what would run, without running it python3 tools/parity.py --status # last result of every harness +Harnesses in parity_hosts.json's "named_only" run only when named or with --all +(the nightly audit): no automatic selection picks them. + Each harness runs unmodified, in parallel, under a tracer that records what it read: its Python modules, Java oracle sources, other repository files, and the Rust sources of every probe it executed (from Cargo's dep-info). A harness @@ -1285,6 +1288,12 @@ def platform_skips(config): return dict(config.get("linux_only", {})) +def named_only(config): + """Harnesses tools/parity_hosts.json keeps out of every automatic selection (--changed, --failed, the default, + --flake-check): they run only when named or with --all, the nightly audit. {name: reason}""" + return dict(config.get("named_only", {})) + + def finished_run(failed): """Record that this run completed, for tools/gate.py: a crashed runner never writes it.""" STATE_DIR.mkdir(parents=True, exist_ok=True) @@ -1369,9 +1378,13 @@ def main(): for name in [name for name in chosen if base_name(name) in skips and not args.names]: print(f"skipped on {sys.platform}: {name}: {skips[base_name(name)]}", flush=True) chosen.remove(name) + manual = {} if args.names or args.all else named_only(host_config()) + for name in [name for name in chosen if base_name(name) in manual]: + print(f"not selected (runs when named, and nightly): {name}: {manual[base_name(name)]}", flush=True) + chosen.remove(name) rounds = {name: args.repeat for name in chosen} if args.repeat > 1 else {} if args.flake_check: - changed = changed_harnesses(found, records, args.flake_check) + changed = {name for name in changed_harnesses(found, records, args.flake_check) if base_name(name) not in manual} for name in sorted(changed): # A pass counts for a changed harness only if it held over enough runs. if name not in chosen and records.get(name, {}).get("rounds", 1) < args.flake_rounds: diff --git a/tools/parity_hosts.json b/tools/parity_hosts.json index f2ba65c68..164a3ff42 100644 --- a/tools/parity_hosts.json +++ b/tools/parity_hosts.json @@ -36,5 +36,8 @@ "local_only": { "save_roundtrip": "runs the game on a virtual screen (vscreen) with a null ALSA device, or offscreen in the logged-in macOS session" }, - "linux_only": {} + "linux_only": {}, + "named_only": { + "lan_integration": "the whole lan_e2e suite: ~40 min a run on a loaded runner, and single checks flake under load; run it by name, or tools/lan_e2e.py" + } } From 3c22ff084916cf48ebdec3adb51ed9012ff5f0de Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Mon, 26 Oct 2026 11:33:30 +0100 Subject: [PATCH 26/28] Launcher: don't install a mod version the game can't run The game program carries its mod API level in a mark (horizon-mod-api-level:NNNN;), which the launcher reads once per installed version; a program from before the mark (0.2.68 and older) serves level 0. The Horizon browser marks versions above the level of the game the player runs (the selected version, else the newest installed) "needs a newer Horizon than the game you play", and installs the newest version that game can run, or says to update it. Co-Authored-By: Claude Opus 5.5 --- crates/horizon-client/src/main.rs | 6 +++ crates/horizon-mods/src/api_level.rs | 35 +++++++++++++++ launcher/src/backend.rs | 49 +++++++++++++++++++++ launcher/src/browser/horizon.rs | 61 +++++++++++++++++++-------- launcher/src/browser/horizon/pack.rs | 2 +- launcher/src/browser/horizon/tests.rs | 36 ++++++++++++---- 6 files changed, 162 insertions(+), 27 deletions(-) diff --git a/crates/horizon-client/src/main.rs b/crates/horizon-client/src/main.rs index 8004b2fa7..7144a1670 100644 --- a/crates/horizon-client/src/main.rs +++ b/crates/horizon-client/src/main.rs @@ -4,7 +4,13 @@ mod game; use horizon_client::{crash, logging}; +/// The mod API level this game serves, kept in the program for the launcher +/// to read without running it (`horizon_mods::api_level::MARK`). `main` +/// reads it, so the linker keeps it. +static MOD_API_LEVEL: [u8; 27] = horizon_mods::api_level::MARK; + fn main() { + std::hint::black_box(&MOD_API_LEVEL); horizon_client::telemetry::mark_start(); let args: Vec = std::env::args().skip(1).collect(); let game_args = args.iter().take_while(|a| *a != "--dedicated"); diff --git a/crates/horizon-mods/src/api_level.rs b/crates/horizon-mods/src/api_level.rs index a81cf27bc..b8c305436 100644 --- a/crates/horizon-mods/src/api_level.rs +++ b/crates/horizon-mods/src/api_level.rs @@ -45,6 +45,30 @@ pub const FUNCTIONS: [(&str, u32); 29] = [ ("render.set-minimap", 1), ]; +/// What the game's program carries so the launcher can read its level +/// without running it: `horizon-mod-api-level:0001;` (four digits). A +/// program from before the mark serves level 0. +pub const MARK: [u8; 27] = { + let mut mark = *b"horizon-mod-api-level:0000;"; + let mut level = LEVEL; + let mut i = 25; + while level > 0 { + mark[i] = b'0' + (level % 10) as u8; + level /= 10; + i -= 1; + } + mark +}; + +/// The level a program's bytes carry in their [`MARK`], if any. +pub fn read_mark(program: &[u8]) -> Option { + let prefix = &MARK[..22]; + program + .windows(MARK.len()) + .filter(|w| w.starts_with(prefix) && w[26] == b';') + .find_map(|w| std::str::from_utf8(&w[22..26]).ok()?.parse().ok()) +} + /// A function's level; None for one this Horizon doesn't have. pub fn level_of(function: &str) -> Option { FUNCTIONS @@ -131,6 +155,17 @@ mod tests { assert!(FUNCTIONS.iter().any(|&(_, level)| level == LEVEL)); } + #[test] + fn the_mark_carries_the_level() { + assert_eq!(read_mark(&MARK), Some(LEVEL)); + let mut program = b"\0\x7fELF horizon-mod-api-level: horizon-mod-api-level:".to_vec(); + program.extend_from_slice(&MARK); + program.extend_from_slice(b"\0rest"); + assert_eq!(read_mark(&program), Some(LEVEL)); + assert_eq!(read_mark(b"horizon-mod-api-level:12;"), None); + assert_eq!(read_mark(b"no mark"), None); + } + #[test] fn a_mod_needs_its_newest_function() { assert_eq!(needed(["log.write", "hud.set-panel"]), (0, None)); diff --git a/launcher/src/backend.rs b/launcher/src/backend.rs index a2d870a84..dba6bcd25 100644 --- a/launcher/src/backend.rs +++ b/launcher/src/backend.rs @@ -422,6 +422,37 @@ pub fn version_dir(tag: &str) -> PathBuf { const COMPLETE: &str = ".installed"; +/// The mod API level of the game players run: the selected version's, else the newest installed +/// one's. None with no version installed: the launcher doesn't know yet which game will run mods. +pub fn game_mod_api_level() -> Option { + let installed = installed(); + let tag = Settings::load() + .selected + .filter(|s| installed.contains(s)) + .or_else(|| installed.into_iter().next())?; + Some(mod_api_level(&tag)) +} + +/// A game version's mod API level, read once from the mark its program carries +/// (`horizon_mods::api_level::MARK`). A program from before the mark serves level 0, the +/// contract of Horizon 0.2.67 and 0.2.68. +pub fn mod_api_level(tag: &str) -> u32 { + static LEVELS: Mutex> = Mutex::new(Vec::new()); + let mut levels = LEVELS.lock().unwrap_or_else(|e| e.into_inner()); + if let Some(&(_, level)) = levels.iter().find(|(t, _)| t == tag) { + return level; + } + let level = program_mod_api_level(&version_dir(tag).join(CLIENT)); + levels.push((tag.to_owned(), level)); + level +} + +/// The mod API level in the game program at `path`: its mark's, else 0. +fn program_mod_api_level(path: &Path) -> u32 { + let program = fs::read(path).unwrap_or_default(); + horizon_mods::api_level::read_mark(&program).unwrap_or(0) +} + /// Installed versions, newest tag first. pub fn installed() -> Vec { installed_in(&versions_dir()) @@ -2557,6 +2588,24 @@ mod tests { use super::*; use std::cmp::Ordering::*; + /// The game program's mod API level is its mark's; a program from before the mark (0.2.68 + /// and older) or none at all serves level 0. + #[test] + fn a_game_program_says_its_mod_api_level() { + let dir = std::env::temp_dir().join(format!("horizon-api-level-{}", std::process::id())); + fs::create_dir_all(&dir).unwrap(); + let marked = dir.join("marked"); + let mut program = b"\x7fELF code code".to_vec(); + program.extend_from_slice(b"horizon-mod-api-level:0007;"); + fs::write(&marked, &program).unwrap(); + let old = dir.join("old"); + fs::write(&old, b"\x7fELF code without a mark").unwrap(); + assert_eq!(program_mod_api_level(&marked), 7); + assert_eq!(program_mod_api_level(&old), 0); + assert_eq!(program_mod_api_level(&dir.join("missing")), 0); + fs::remove_dir_all(&dir).unwrap(); + } + /// A preparation that reuses the imported game files still reads the assets from the /// launcher that has them: a Prism Launcher instance's are in the launcher root, linked into /// the official layout (jan.sonki on Discord: silent, grey title screen since 0.2.48). diff --git a/launcher/src/browser/horizon.rs b/launcher/src/browser/horizon.rs index 1aad20734..3bf465faf 100644 --- a/launcher/src/browser/horizon.rs +++ b/launcher/src/browser/horizon.rs @@ -168,7 +168,14 @@ fn project_of(p: &index::Project) -> Option { }) } -fn version_of(index: &Index, p: &index::Project, v: &index::Version) -> Version { +/// Version `v` of `p` as the browser shows it; blocked when taken down, or when it needs a newer +/// mod API level than `level`, the game's. +fn version_of( + index: &Index, + p: &index::Project, + v: &index::Version, + level: Option, +) -> Version { Version { id: v.version.clone(), number: v.version.clone(), @@ -187,7 +194,8 @@ fn version_of(index: &Index, p: &index::Project, v: &index::Version) -> Version required: v.requires.iter().map(|r| r.id.clone()).collect(), blocked: index .revoked(&p.id, &v.file.sha256) - .map(|r| format!("taken down: {}", r.reason)), + .map(|r| format!("taken down: {}", r.reason)) + .or_else(|| needs_newer(v, level).then(|| NEEDS_NEWER.to_string())), } } @@ -254,9 +262,10 @@ impl Source for Registry { let p = index .project(&project.id) .ok_or_else(|| format!("{} isn't in Horizon's registry.", project.title))?; + let level = crate::backend::game_mod_api_level(); Ok(p.versions .iter() - .map(|v| version_of(&index, p, v)) + .map(|v| version_of(&index, p, v, level)) .collect()) } @@ -378,20 +387,24 @@ fn relative(kind: Kind, id: &str, file_name: &str) -> Result { } } -/// Installs a registry project into the game folder `home`: its newest version for this game, -/// downloaded into `mod-browser/downloads/`, checked against the index, then moved into place. -/// A mod is `horizon-mods/.hmod`, turned on in `horizon-mods.txt`. +/// Installs a registry project into the game folder `home`: its newest version for this game that +/// the game the player runs can load, downloaded into `mod-browser/downloads/`, checked against +/// the index, then moved into place. A mod is `horizon-mods/.hmod`, turned on in +/// `horizon-mods.txt`. pub fn install( project: &Project, home: &Path, progress: &dyn Fn(&str, f32), ) -> Result, String> { - install_from(&*index()?, local(), project, home, progress) + let level = crate::backend::game_mod_api_level(); + install_from(&*index()?, local(), level, project, home, progress) } +/// [`install`] from `index`, for a game serving mod API `level`. fn install_from( index: &Index, local: bool, + level: Option, project: &Project, home: &Path, progress: &dyn Fn(&str, f32), @@ -399,27 +412,41 @@ fn install_from( let p = index .project(&project.id) .ok_or_else(|| format!("{} isn't in Horizon's registry.", project.title))?; - let v = newest(index, p)?; + let v = newest(index, p, level)?; install_version(index, local, p, v, home, progress).map(|e| vec![e]) } -/// A project's newest version for this game that wasn't taken down. -fn newest<'a>(index: &Index, p: &'a index::Project) -> Result<&'a index::Version, String> { - let mut taken_down = None; +/// A project's newest version for this game that wasn't taken down and that a game serving mod +/// API `level` runs (any, when the level isn't known). +fn newest<'a>( + index: &Index, + p: &'a index::Project, + level: Option, +) -> Result<&'a index::Version, String> { + let (mut taken_down, mut too_new) = (None, false); for v in p.versions.iter().filter(|v| v.game == GAME) { - match index.revoked(&p.id, &v.file.sha256) { - None => return Ok(v), - Some(r) => { - taken_down.get_or_insert(r); - } + if let Some(r) = index.revoked(&p.id, &v.file.sha256) { + taken_down.get_or_insert(r); + } else if needs_newer(v, level) { + too_new = true; + } else { + return Ok(v); } } Err(match taken_down { + _ if too_new => format!("{} {NEEDS_NEWER}: update it first.", p.name), Some(r) => format!("{} was taken down: {}", p.name, r.reason), None => format!("{} has no version for {GAME} to install.", p.name), }) } +const NEEDS_NEWER: &str = "needs a newer Horizon than the game you play"; + +/// Whether version `v` calls mod API functions a game serving `level` doesn't have. +fn needs_newer(v: &index::Version, level: Option) -> bool { + matches!((v.api_level, level), (Some(needed), Some(level)) if needed > level) +} + /// Installs version `v` of the registry's mod, resource pack or shader pack `p` into the game /// folder `home`. fn install_version( @@ -462,7 +489,7 @@ fn install_version( return Err(format!("{relative} is already there: move it away first.")); } let line = format!("{} {}", p.name, v.version); - let file = &version_of(index, p, v).files[0]; + let file = &version_of(index, p, v, None).files[0]; let staging = home.join("mod-browser/downloads"); let path = fetch(file, &staging, local, &|f| progress(&line, f))?; let trust = index::check_file(index, p, v, &path).inspect_err(|_| { diff --git a/launcher/src/browser/horizon/pack.rs b/launcher/src/browser/horizon/pack.rs index 3cb6d7c9b..95235a505 100644 --- a/launcher/src/browser/horizon/pack.rs +++ b/launcher/src/browser/horizon/pack.rs @@ -84,7 +84,7 @@ fn install_in( if p.kind != idx::Kind::Modpack { return Err(format!("{} is a {}, not a modpack.", p.name, p.kind.name())); } - let v = newest(index, p)?; + let v = newest(index, p, None)?; let work = dir.join(&p.id); let fresh = !work.exists(); let result = install_version_in(index, local, p, v, &work, progress); diff --git a/launcher/src/browser/horizon/tests.rs b/launcher/src/browser/horizon/tests.rs index 314be2050..7e1b8f585 100644 --- a/launcher/src/browser/horizon/tests.rs +++ b/launcher/src/browser/horizon/tests.rs @@ -59,7 +59,7 @@ fn installs_checked_turns_on_and_removes() { let index = sample(); let home = scratch("install"); let p = hud(&index); - let done = install_from(&index, true, &p, &home, &|_, _| {}).unwrap(); + let done = install_from(&index, true, None, &p, &home, &|_, _| {}).unwrap(); assert_eq!(done[0].file, "horizon-mods/coords_hud.hmod"); assert_eq!(done[0].verdict.as_deref(), Some("Verified")); assert!(done[0].checksum.starts_with("SHA-256:e1135345")); @@ -73,7 +73,7 @@ fn installs_checked_turns_on_and_removes() { 0 ); // Installed already: nothing to do. - let again = install_from(&index, true, &p, &home, &|_, _| {}).unwrap(); + let again = install_from(&index, true, None, &p, &home, &|_, _| {}).unwrap(); assert_eq!(again, done); let mut revoked = index.clone(); @@ -102,7 +102,7 @@ fn installs_a_shader_pack_into_shaderpacks() { let home = scratch("shader"); let p = project_of(index.project("glow").unwrap()).unwrap(); assert_eq!(p.support(), super::super::Support::Works); - let done = install_from(&index, true, &p, &home, &|_, _| {}).unwrap(); + let done = install_from(&index, true, None, &p, &home, &|_, _| {}).unwrap(); assert_eq!(done[0].file, "shaderpacks/glow-1.0.0.hshader"); assert_eq!(done[0].kind, Kind::Shader); assert!(home.join("shaderpacks/glow-1.0.0.hshader").is_file()); @@ -123,7 +123,7 @@ fn installs_a_shader_pack_into_shaderpacks() { assert!(!home.join("shaderpacks/glow-1.0.0.hshader").exists()); // A file of the same name the registry didn't put there is left alone. fs::write(home.join("shaderpacks/glow-1.0.0.hshader"), b"mine").unwrap(); - let e = install_from(&index, true, &p, &home, &|_, _| {}).unwrap_err(); + let e = install_from(&index, true, None, &p, &home, &|_, _| {}).unwrap_err(); assert_eq!( e, "shaderpacks/glow-1.0.0.hshader is already there: move it away first." @@ -140,15 +140,15 @@ fn refuses_a_changed_file_a_taken_id_and_local_files_from_the_real_registry() { let mut tampered = index.clone(); let cozy = tampered.projects[1].versions[0].file.url.clone(); tampered.projects[0].versions[0].file.url = cozy; - let e = install_from(&tampered, true, &p, &home, &|_, _| {}).unwrap_err(); + let e = install_from(&tampered, true, None, &p, &home, &|_, _| {}).unwrap_err(); assert!(e.contains("larger than its source says"), "{e}"); assert!(!home.join("horizon-mods").exists()); - let e = install_from(&index, false, &p, &home, &|_, _| {}).unwrap_err(); + let e = install_from(&index, false, None, &p, &home, &|_, _| {}).unwrap_err(); assert!(e.contains("file servers"), "{e}"); fs::create_dir_all(home.join("horizon-mods/coords_hud")).unwrap(); - let e = install_from(&index, true, &p, &home, &|_, _| {}).unwrap_err(); + let e = install_from(&index, true, None, &p, &home, &|_, _| {}).unwrap_err(); assert!(e.contains("already in horizon-mods"), "{e}"); let mut taken_down = index.clone(); @@ -158,7 +158,7 @@ fn refuses_a_changed_file_a_taken_id_and_local_files_from_the_real_registry() { reason: "Test.".into(), date: String::new(), }); - let e = install_from(&taken_down, true, &p, &home, &|_, _| {}).unwrap_err(); + let e = install_from(&taken_down, true, None, &p, &home, &|_, _| {}).unwrap_err(); assert_eq!(e, "Coordinates HUD was taken down: Test."); fs::remove_dir_all(&home).unwrap(); } @@ -175,7 +175,7 @@ fn registry_versions_run_when_made_for_this_game() { let versions: Vec = p .versions .iter() - .map(|x| version_of(&index, p, x)) + .map(|x| version_of(&index, p, x, None)) .collect(); assert_eq!(pick(Kind::Mod, &versions, false).unwrap().number, "0.1.0"); } @@ -198,3 +198,21 @@ fn owner_links_only_take_github_logins() { assert!(!github_login(bad), "{bad}"); } } + +/// A version that calls mod API functions the game doesn't have is marked and skipped. +#[test] +fn versions_for_a_newer_horizon_are_not_installed() { + let mut index = sample(); + index.projects[0].versions[0].api_level = Some(1); + let p = index.project("coords_hud").unwrap(); + let e = newest(&index, p, Some(0)).unwrap_err(); + assert_eq!( + e, + "Coordinates HUD needs a newer Horizon than the game you play: update it first." + ); + assert!(newest(&index, p, Some(1)).is_ok()); + assert!(newest(&index, p, None).is_ok()); + let v = version_of(&index, p, &p.versions[0], Some(0)); + assert_eq!(v.blocked.as_deref(), Some(NEEDS_NEWER)); + assert_eq!(version_of(&index, p, &p.versions[0], Some(1)).blocked, None); +} From b12c89650ed0d7d0f02c7e2bf2a475c3b962e9a3 Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Mon, 26 Oct 2026 11:46:27 +0100 Subject: [PATCH 27/28] Mod API levels: server mods' players functions are level 1; the registry's lockfile Main gained players.online, tell and broadcast (#1833) after 0.2.69, so they take level 1 with render.set-minimap. horizon-mod-registry's own Cargo.lock picks up wasmparser. Co-Authored-By: Claude Opus 5.5 --- crates/horizon-mod-registry/Cargo.lock | 24 ++++++++++++++++++++++++ crates/horizon-mods/src/api_level.rs | 7 +++++-- docs/api/stability.md | 2 +- 3 files changed, 30 insertions(+), 3 deletions(-) diff --git a/crates/horizon-mod-registry/Cargo.lock b/crates/horizon-mod-registry/Cargo.lock index e93f5b3b5..f80068fcc 100644 --- a/crates/horizon-mod-registry/Cargo.lock +++ b/crates/horizon-mod-registry/Cargo.lock @@ -401,6 +401,8 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "ed5909b6e89a2db4456e54cd5f673791d7eca6732202bbf2a9cc504fe2f9b84a" dependencies = [ "foldhash", + "serde", + "serde_core", ] [[package]] @@ -442,6 +444,7 @@ dependencies = [ "serde_json", "sha2", "toml", + "wasmparser", "zip", ] @@ -649,6 +652,8 @@ checksum = "cc4e190f5d26ca7051642629da2c52fc03bde85a03197c99408dcd291734c855" dependencies = [ "equivalent", "hashbrown", + "serde", + "serde_core", ] [[package]] @@ -921,6 +926,12 @@ version = "1.2.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "94143f37725109f92c262ed2cf5e59bce7498c01bcc1502d7b9afe439a4e9f49" +[[package]] +name = "semver" +version = "1.0.28" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8a7852d02fc848982e0c167ef163aaff9cd91dc640ba85e263cb1ce46fae51cd" + [[package]] name = "serde" version = "1.0.229" @@ -1326,6 +1337,19 @@ dependencies = [ "wit-bindgen", ] +[[package]] +name = "wasmparser" +version = "0.254.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c5ff8685b587722894b6f25958fc608d315b93b8d23647bfb567664e7006d757" +dependencies = [ + "bitflags", + "hashbrown", + "indexmap", + "semver", + "serde", +] + [[package]] name = "webpki-roots" version = "0.26.11" diff --git a/crates/horizon-mods/src/api_level.rs b/crates/horizon-mods/src/api_level.rs index a81cf27bc..e7b72c20b 100644 --- a/crates/horizon-mods/src/api_level.rs +++ b/crates/horizon-mods/src/api_level.rs @@ -10,10 +10,10 @@ pub const LEVEL: u32 = 1; /// Every function the game offers mods, as `interface.function`, with its -/// level. Level 0 is the contract of Horizon 0.2.67 and 0.2.68. A new +/// level. Level 0 is the contract of Horizon 0.2.67 to 0.2.69. A new /// function takes the next level and raises [`LEVEL`] (the `api_reference` /// test fails until it is listed here). -pub const FUNCTIONS: [(&str, u32); 29] = [ +pub const FUNCTIONS: [(&str, u32); 32] = [ ("log.write", 0), ("game.get-player", 0), ("game.get-clock", 0), @@ -43,6 +43,9 @@ pub const FUNCTIONS: [(&str, u32); 29] = [ ("render.frame-stats", 0), ("render.set-zoom", 0), ("render.set-minimap", 1), + ("players.online", 1), + ("players.tell", 1), + ("players.broadcast", 1), ]; /// A function's level; None for one this Horizon doesn't have. diff --git a/docs/api/stability.md b/docs/api/stability.md index cea3415d7..65cfc0c13 100644 --- a/docs/api/stability.md +++ b/docs/api/stability.md @@ -38,7 +38,7 @@ don't import it); faster, or fixing behaviour to what the reference already says A new WIT function doesn't break older mods, but a mod that calls it can't run on a Horizon from before it. So every function the game offers mods has an **API level**, the one it arrived at (`crates/horizon-mods/src/api_level.rs`): -level 0 is the contract of Horizon 0.2.67 and 0.2.68, level 1 adds `render.set-minimap`. A mod needs the level of +level 0 is the contract of Horizon 0.2.67 to 0.2.69, level 1 adds `render.set-minimap` and server mods' `players`. A mod needs the level of the newest function it imports (a component imports only the functions it calls). The level is read from the file, never declared: From 189b2c6b3cce355b0b2dc527f2579025cc5e4c16 Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Mon, 26 Oct 2026 11:52:09 +0100 Subject: [PATCH 28/28] nightly: pick the 03:07 Paris schedule by offset, not by the clock at start; room for lan_integration GitHub started both 10-26 schedules over an hour late, so the hour check skipped both and no audit ran. lan_integration takes ~2,400 s under load, past the 1,800 s per-harness limit. Co-Authored-By: Claude Opus 5.5 --- .github/workflows/nightly.yml | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml index 60bbbf057..1ea2db6fa 100644 --- a/.github/workflows/nightly.yml +++ b/.github/workflows/nightly.yml @@ -8,7 +8,7 @@ name: nightly audit # gh workflow run "nightly audit" -f dry_run=true # the audit, without touching issues on: schedule: - # GitHub's schedules are in UTC: both, and the first step keeps the one that is 03:00 in Paris. + # GitHub's schedules are in UTC: both, and the first step keeps the one that is 03:07 in Paris today. - cron: '7 1 * * *' - cron: '7 2 * * *' workflow_dispatch: @@ -31,14 +31,19 @@ jobs: audit: # The Mac mini's runners only: the audit compares with the previous one, so it stays on one platform. runs-on: [self-hosted, horizon-game, macOS] - timeout-minutes: 150 + timeout-minutes: 240 # every harness (~80 min) plus lan_integration (~40 min an attempt under load, retried) steps: - - name: 03:00 in Paris + - name: 03:07 in Paris id: when + env: + SCHEDULE: ${{ github.event.schedule }} run: | - hour=$(TZ=Europe/Paris date +%H) - if [[ "${{ github.event_name }}" == schedule && "$hour" != 03 ]]; then - echo "It is ${hour}:00 in Paris: the other schedule runs the audit." + # Which cron is 03:07 in Paris, from Paris's offset today: GitHub can start a schedule hours late, so the + # clock at start time can't tell (on 2026-10-26 both started after 04:00 Paris and both skipped). + offset=$(TZ=Europe/Paris date +%z) + ours=$([ "$offset" = +0200 ] && echo '7 1 * * *' || echo '7 2 * * *') + if [[ "${{ github.event_name }}" == schedule && "$SCHEDULE" != "$ours" ]]; then + echo "Paris is at UTC${offset} today: the '$ours' schedule runs the audit." echo "run=false" >> "$GITHUB_OUTPUT" else echo "run=true" >> "$GITHUB_OUTPUT" @@ -66,7 +71,8 @@ jobs: run: | echo "since=$(date +%Y-%m-%dT%H:%M:%S)" >> "$GITHUB_OUTPUT" set +e - python3 tools/parity.py --all --timeout 1800 2>&1 | tee "$RUNNER_TEMP/audit.log" + # lan_integration (the whole lan_e2e suite) takes ~2,400 s under load, past the usual 1,800. + python3 tools/parity.py --all --timeout 3000 2>&1 | tee "$RUNNER_TEMP/audit.log" echo "exit=${PIPESTATUS[0]}" >> "$GITHUB_OUTPUT" { echo '```'; tail -40 "$RUNNER_TEMP/audit.log"; echo '```'; } >> "$GITHUB_STEP_SUMMARY" - name: Issues for the harnesses that regressed