diff --git a/Cargo.lock b/Cargo.lock index 0e93bba0e..809df3a5a 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1368,6 +1368,7 @@ dependencies = [ "horizon-core", "horizon-dualsense", "horizon-friends", + "horizon-hdr", "horizon-mods", "horizon-protocol", "horizon-server-files", @@ -1426,6 +1427,14 @@ dependencies = [ "spake2", ] +[[package]] +name = "horizon-hdr" +version = "0.1.0" +dependencies = [ + "ash", + "wgpu", +] + [[package]] name = "horizon-mod-sdk" version = "0.1.0" diff --git a/Cargo.toml b/Cargo.toml index e4628f962..59bfe5e33 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/horizon-mods/tests/ui_guest", "crates/cargo-horizon-mod", "crates/horizon-port-pack", "crates/horizon-shaders", "crates/horizon-shader-api", "crates/horizon-release-sign", "crates/horizon-mod-sdk/examples/coords-hud", "crates/horizon-mod-sdk/examples/predator-missile", "crates/horizon-mod-sdk/examples/welcome", "mods/official/fps-overlay", "mods/official/keystrokes", "mods/official/minimap", "mods/official/zoom", "xtask"] +members = ["crates/horizon-core", "crates/horizon-dualsense", "crates/horizon-threads", "crates/horizon-hdr", "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/horizon-mods/tests/ui_guest", "crates/cargo-horizon-mod", "crates/horizon-port-pack", "crates/horizon-shaders", "crates/horizon-shader-api", "crates/horizon-release-sign", "crates/horizon-mod-sdk/examples/coords-hud", "crates/horizon-mod-sdk/examples/predator-missile", "crates/horizon-mod-sdk/examples/welcome", "mods/official/fps-overlay", "mods/official/keystrokes", "mods/official/minimap", "mods/official/zoom", "xtask"] resolver = "2" [workspace.package] diff --git a/ROADMAP.md b/ROADMAP.md index a04eca2ce..4a2b90643 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -160,6 +160,66 @@ Translatable components resolved through the selected language for items, contai +#### Cooldowns drawn on items + +After you throw an ender pearl, its slot should show the cooldown sweeping away, as in vanilla. + +
Technical + +Vanilla draws `ItemCooldowns`' percent as a white overlay over the slot (`GuiGraphicsExtractor.itemDecorations` and `itemCooldown`) in the hotbar and in inventories. Issue [#1763](https://github.com/ludovic111/horizon/issues/1763). + +More: [#1933](https://github.com/ludovic111/horizon/issues/1933) + +
+ +#### Chat settings and team prefixes + +The Hidden and Commands Only chat settings should hide chat, and team prefixes should appear before names in chat. + +
Technical + +Vanilla checks `ChatVisiblity` before it delivers chat and system messages ([#1376](https://github.com/ludovic111/horizon/issues/1376)), and chat uses the team-formatted display name ([#1378](https://github.com/ludovic111/horizon/issues/1378)). Both issues have exact steps to reproduce. + +More: [#1932](https://github.com/ludovic111/horizon/issues/1932) · [#1841](https://github.com/ludovic111/horizon/issues/1841) + +
+ +#### A pointing hand over buttons + +The mouse pointer should turn into a pointing hand over menu buttons, as in vanilla 26.3. + +
Technical + +26.3's `AbstractWidget` asks for a cursor from `CursorTypes` when it is hovered; winit's `CursorIcon::Pointer` gives the same shape. Issue [#1347](https://github.com/ludovic111/horizon/issues/1347). + +More: [#1897](https://github.com/ludovic111/horizon/issues/1897) + +
+ +#### Ctrl+Backspace and scroll bars in menus + +Ctrl+Backspace should delete a whole word in the creative search, and every list's scroll bar should be draggable. + +
Technical + +`EditBox` deletes by word with Ctrl ([#1764](https://github.com/ludovic111/horizon/issues/1764)); the Game Rules and Statistics lists' scroll bars can't be dragged ([#1782](https://github.com/ludovic111/horizon/issues/1782), after [#978](https://github.com/ludovic111/horizon/issues/978)). + +More: [#1884](https://github.com/ludovic111/horizon/issues/1884) · [#1931](https://github.com/ludovic111/horizon/issues/1931) + +
+ +#### Chickens flap while they fall + +Chickens should flap their wings while they fall, not stand still in the air. + +
Technical + +Vanilla's `Chicken.aiStep` updates `flap` and `flapSpeed` when the chicken isn't on the ground, and the model's wings follow them. Issue [#1706](https://github.com/ludovic111/horizon/issues/1706). + +More: [#1892](https://github.com/ludovic111/horizon/issues/1892) + +
+ ### Rendering #### Shader packs, written again from scratch @@ -902,56 +962,6 @@ Armour and tools in End city chests should come enchanted, as in vanilla. -#### Cooldowns drawn on items - -After you throw an ender pearl, its slot should show the cooldown sweeping away, as in vanilla. - -
Technical - -Vanilla draws `ItemCooldowns`' percent as a white overlay over the slot (`GuiGraphicsExtractor.itemDecorations` and `itemCooldown`) in the hotbar and in inventories. Issue [#1763](https://github.com/ludovic111/horizon/issues/1763). - -
- -#### Chat settings and team prefixes - -The Hidden and Commands Only chat settings should hide chat, and team prefixes should appear before names in chat. - -
Technical - -Vanilla checks `ChatVisiblity` before it delivers chat and system messages ([#1376](https://github.com/ludovic111/horizon/issues/1376)), and chat uses the team-formatted display name ([#1378](https://github.com/ludovic111/horizon/issues/1378)). Both issues have exact steps to reproduce. - -
- -#### A pointing hand over buttons - -The mouse pointer should turn into a pointing hand over menu buttons, as in vanilla 26.3. - -
Technical - -26.3's `AbstractWidget` asks for a cursor from `CursorTypes` when it is hovered; winit's `CursorIcon::Pointer` gives the same shape. Issue [#1347](https://github.com/ludovic111/horizon/issues/1347). - -
- -#### Ctrl+Backspace and scroll bars in menus - -Ctrl+Backspace should delete a whole word in the creative search, and every list's scroll bar should be draggable. - -
Technical - -`EditBox` deletes by word with Ctrl ([#1764](https://github.com/ludovic111/horizon/issues/1764)); the Game Rules and Statistics lists' scroll bars can't be dragged ([#1782](https://github.com/ludovic111/horizon/issues/1782), after [#978](https://github.com/ludovic111/horizon/issues/978)). - -
- -#### Chickens flap while they fall - -Chickens should flap their wings while they fall, not stand still in the air. - -
Technical - -Vanilla's `Chicken.aiStep` updates `flap` and `flapSpeed` when the chicken isn't on the ground, and the model's wings follow them. Issue [#1706](https://github.com/ludovic111/horizon/issues/1706). - -
- ## Recently shipped - **OpenGL for old computers** (v0.2.63): Horizon now starts on old PCs whose graphics card has no Vulkan or DirectX 12 driver: it switches to OpenGL by itself, and Options > Graphics can pick OpenGL by hand. [#1917](https://github.com/ludovic111/horizon/issues/1917) · [#1920](https://github.com/ludovic111/horizon/issues/1920) · [#1936](https://github.com/ludovic111/horizon/issues/1936) diff --git a/THIRD_PARTY_NOTICES.md b/THIRD_PARTY_NOTICES.md index 63a1f7da3..e83ccd840 100644 --- a/THIRD_PARTY_NOTICES.md +++ b/THIRD_PARTY_NOTICES.md @@ -17,4 +17,5 @@ by The Pixelify Sans Project Authors, licensed under the SIL Open Font License 1 `crates/horizon-theme/icons/pixel/*.svg` are icons from [Pixelarticons](https://github.com/halfmage/pixelarticons) by Gerrit Halfmann, under the MIT -license (`crates/horizon-theme/icons/pixel/LICENSE-pixelarticons.txt`). +license (`crates/horizon-theme/icons/pixel/LICENSE-pixelarticons.txt`). `star.svg` is Horizon's own, drawn on +the same grid. diff --git a/crates/horizon-client/Cargo.toml b/crates/horizon-client/Cargo.toml index d7c6d812b..f1011c534 100644 --- a/crates/horizon-client/Cargo.toml +++ b/crates/horizon-client/Cargo.toml @@ -12,6 +12,7 @@ horizon-assets = { path = "../horizon-assets" } horizon-core = { path = "../horizon-core" } # The server thread ahead of the workers (MinecraftServer.spin's Thread.setPriority). horizon-threads = { path = "../horizon-threads" } +horizon-hdr = { path = "../horizon-hdr" } horizon-world = { path = "../horizon-world" } horizon-protocol = { path = "../horizon-protocol" } # server.properties, eula.txt and the user lists, shared with horizon-server. diff --git a/crates/horizon-client/examples/probe/cushion_placement_probe.rs b/crates/horizon-client/examples/probe/cushion_placement_probe.rs new file mode 100644 index 000000000..45fbdbd72 --- /dev/null +++ b/crates/horizon-client/examples/probe/cushion_placement_probe.rs @@ -0,0 +1,89 @@ +use horizon_client::{ + Result, + cushion::{self, World}, +}; +use horizon_core::geometry::{Aabb, ShapeOp, Vec3, VoxelShape}; +use serde_json::Value; +use std::{ + collections::HashMap, + fs::File, + io::{BufRead, BufReader, BufWriter, Write}, +}; + +struct Cell { + outline: VoxelShape, + collision: VoxelShape, + suffocating: bool, +} +struct Fixture(HashMap<[i32; 3], Cell>); +impl World for Fixture { + fn outline_bounds(&self, p: [i32; 3]) -> Option { + self.0 + .get(&p)? + .outline + .bounds() + .map(|b| b.move_by(Vec3::new(p[0] as f64, p[1] as f64, p[2] as f64))) + } + fn collision_shapes(&self, _: Aabb) -> Vec { + self.0 + .iter() + .map(|(p, c)| { + c.collision + .moved(Vec3::new(p[0] as f64, p[1] as f64, p[2] as f64)) + }) + .collect() + } + fn suffocating(&self, p: [i32; 3]) -> bool { + self.0.get(&p).is_some_and(|c| c.suffocating) + } +} +fn shape(value: &Value) -> Result { + let mut shape = VoxelShape::empty(); + for b in value.as_array().unwrap() { + let f = |i: usize| b[i].as_f64().unwrap(); + shape = shape.join( + &VoxelShape::from_box(Aabb::new( + Vec3::new(f(0), f(1), f(2)), + Vec3::new(f(3), f(4), f(5)), + ))?, + ShapeOp::OR, + )?; + } + Ok(shape) +} +pub fn main() -> Result<()> { + let args: Vec<_> = crate::args().collect(); + let mut out = BufWriter::new(File::create(&args[2])?); + for line in BufReader::new(File::open(&args[1])?).lines() { + let row: Value = serde_json::from_str(&line?)?; + let mut world = Fixture(HashMap::new()); + for c in row["cells"].as_array().unwrap() { + let p = std::array::from_fn(|i| c[i].as_i64().unwrap() as i32); + world.0.insert( + p, + Cell { + outline: shape(&c[3])?, + collision: shape(&c[4])?, + suffocating: c[5].as_bool().unwrap(), + }, + ); + } + let p = &row["pos"]; + let (x, y, z) = ( + p[0].as_f64().unwrap(), + p[1].as_f64().unwrap(), + p[2].as_f64().unwrap(), + ); + let bounds = Aabb::new( + Vec3::new(x - 0.5, y, z - 0.5), + Vec3::new(x + 0.5, y + 0.25, z + 0.5), + ); + writeln!( + out, + "{} {}", + cushion::can_place(&world, bounds), + cushion::survives(&world, bounds) + )?; + } + Ok(()) +} diff --git a/crates/horizon-client/examples/probe/main.rs b/crates/horizon-client/examples/probe/main.rs index e80088fd0..1e1bc04d9 100644 --- a/crates/horizon-client/examples/probe/main.rs +++ b/crates/horizon-client/examples/probe/main.rs @@ -28,6 +28,7 @@ mod cloud_fixture; mod command_parse_fixture; mod container_screen_probe; mod creative_search_fixture; +mod cushion_placement_probe; mod emitter_particles_probe; mod enchanting_fixture; mod entity_anim_fixture; @@ -107,6 +108,7 @@ probes! { block_transform_fixture, breaking_fixture, camera_probe, + cushion_placement_probe, cauldron_fixture, chat_screen_fixture, cloud_fixture, diff --git a/crates/horizon-client/examples/probe/section_mesh_fixture.rs b/crates/horizon-client/examples/probe/section_mesh_fixture.rs index e212a5268..89624b78c 100644 --- a/crates/horizon-client/examples/probe/section_mesh_fixture.rs +++ b/crates/horizon-client/examples/probe/section_mesh_fixture.rs @@ -7,7 +7,7 @@ use horizon_client::{ biome::{BiomeInfo, Biomes, GrassModifier}, blocks::BlockFacts, chunk::{Chunk, Light, MIN_Y, index}, - mesher::{MeshTables, Mesher, OPAQUE_LAYER, TerrainVertex}, + mesher::{EMISSION_BITS, MeshTables, Mesher, OPAQUE_LAYER, TerrainVertex}, models, }; use horizon_core::biome::BiomeZoom; @@ -161,7 +161,15 @@ fn scene( .iter() .map(|v| { let ([x, y, z], [u, w]) = (v.pos, v.uv()); - json!([x, y, z, u, w, argb(v.color), light_coords(v.light)]) + json!([ + x, + y, + z, + u, + w, + argb(v.color | EMISSION_BITS), + light_coords(v.light) + ]) }) .collect(); quads.push(json!({"layer": layer, "sprite": sprite, "vertices": vertices})); diff --git a/crates/horizon-client/src/bundle.rs b/crates/horizon-client/src/bundle.rs index 8658b5815..42473729f 100644 --- a/crates/horizon-client/src/bundle.rs +++ b/crates/horizon-client/src/bundle.rs @@ -166,6 +166,38 @@ impl Contents { Some(stack) } + /// The stacks inside, in display order (the first is the next out). + pub fn items(&self) -> &[ItemStack] { + &self.items + } + + /// `getNumberOfItemsToShow`: a full grid shows 11 and a `+N`, so the last + /// row keeps its fourth cell for the count. + pub fn shown_count(&self) -> usize { + let count = self.items.len(); + let available: usize = if count > 12 { 11 } else { 12 }; + let on_last_row = count % 4; + let empty = if on_last_row == 0 { 0 } else { 4 - on_last_row }; + count.min(available.saturating_sub(empty)) + } + + /// The items the tooltip shows, and how many sit beyond them. + pub fn shown(&self) -> (&[ItemStack], u32) { + let n = self.shown_count(); + let hidden = self.items[n..].iter().map(|s| s.count).sum(); + (&self.items[..n], hidden) + } + + /// The `Fraction` weight as the float the progress bar reads. + pub fn weight_fraction(&self) -> f32 { + self.weight.n as f32 / self.weight.d as f32 + } + + /// `Fraction.ONE`: a full bundle draws the full bar and says so. + pub fn is_full(&self) -> bool { + self.weight.n >= self.weight.d + } + /// `toImmutable`, written back into the bundle's component. pub fn store(self, bundle: &mut ItemStack) { bundle.data_mut().bundle_contents = self.items; @@ -190,3 +222,174 @@ mod tests { assert_eq!(over.how_many(Weight::new(1, 64)), 0); } } + +// ------------------------------------------------------------- the tooltip + +/// `ClientBundleTooltip`'s geometry, relative to the tooltip box's top-left: +/// the 96 pixel column of a 4 wide slot grid and the progress bar under it. +#[derive(Clone, Debug, PartialEq)] +pub struct TooltipLayout { + /// The component's own width (96) and height, the text's excluded. + pub width: f32, + pub height: f32, + /// Each slot's top-left and the stack in it, in reading order. + pub slots: Vec<([f32; 2], ItemStack)>, + /// The `+N` of the items past the grid: its top-left and the count. + pub overflow: Option<([f32; 2], u32)>, + /// The progress bar's top-left, its fill's width out of 94, and whether + /// the weight fills it (the full sprite). + pub bar: [f32; 2], + pub fill: f32, + pub full: bool, + /// `item.minecraft.bundle.empty` / `.full`, centred over the bar. + pub label: Option<&'static str>, + /// An empty bundle's description, wrapped at `width` from here. + pub empty_description: Option<[f32; 2]>, +} + +/// The tooltip of a bundle's contents (`ClientBundleTooltip`), or None when +/// the stack is not a bundle. `x`/`y` are the box's top-left, `box_width` the +/// tooltip's width, which the component is centred in. +pub fn tooltip_layout( + items: &Items, + stack: &ItemStack, + x: f32, + y: f32, + box_width: f32, +) -> Option { + let contents = Contents::of(items, stack)?; + let offset = ((box_width - 96.0) / 2.0).floor(); + if contents.items().is_empty() { + // The description takes the top; the bar follows it. + let description_height = 9.0 * 2.0; + return Some(TooltipLayout { + width: 96.0, + height: description_height + 13.0 + 8.0, + slots: Vec::new(), + overflow: None, + bar: [x + offset, y + description_height + 4.0], + fill: 0.0, + full: false, + label: Some("item.minecraft.bundle.empty"), + empty_description: Some([x + offset, y]), + }); + } + let (shown, hidden) = contents.shown(); + // `gridSizeY` counts `slotCount()` (at most twelve), not the slots the + // overflow count leaves room for. + let rows = contents.items().len().min(12).div_ceil(4).max(1); + let grid_height = rows as f32 * 24.0; + let x_start = x + offset + 96.0; + let y_start = y + grid_height; + let mut slots = Vec::with_capacity(shown.len()); + let mut overflow = None; + // Rows fill bottom-up and columns right-to-left, as vanilla draws them. + let mut slot = 0; + for row in 1..=rows { + for column in 1..=4 { + let at = [x_start - column as f32 * 24.0, y_start - row as f32 * 24.0]; + if hidden > 0 && row == 1 && column == 1 { + overflow = Some((at, hidden)); + } else if let Some(stack) = shown.get(slot) { + slots.push((at, stack.clone())); + slot += 1; + } + } + } + let weight = contents.weight_fraction(); + Some(TooltipLayout { + width: 96.0, + height: grid_height + 13.0 + 8.0, + slots, + overflow, + bar: [x + offset, y + grid_height + 4.0], + // `Mth.mulAndTruncate(weight, 94)`, kept within the bar. + fill: (weight * 94.0).trunc().clamp(0.0, 94.0), + full: contents.is_full(), + label: if contents.is_full() { + Some("item.minecraft.bundle.full") + } else { + None + }, + empty_description: None, + }) +} + +#[cfg(test)] +mod tooltip_tests { + use super::*; + + /// The prepared resources, when they are on this machine: the tooltip + /// asks the item registry whether a stack is a bundle. + fn items() -> Option { + let root = std::path::PathBuf::from(env!("CARGO_MANIFEST_DIR")) + .join("../../.local/horizon-client/26.3"); + if !root.join("items.json").exists() { + return None; + } + let assets = crate::assets::Assets::load(&root).ok()?; + let facts = crate::blocks::BlockFacts::load(&root, assets.registry).ok()?; + Items::load(&root, assets.registry, &facts).ok() + } + + fn bundle_with(counts: &[(&str, u32)]) -> ItemStack { + let mut bundle = ItemStack::new("minecraft:bundle", 1); + bundle.data_mut().bundle_contents = counts + .iter() + .map(|(item, n)| ItemStack::new(item, *n)) + .collect(); + bundle + } + + #[test] + fn a_grid_shows_twelve_stacks_and_counts_the_rest() { + let Some(items) = items() else { return }; + let twelve: Vec<(&str, u32)> = (0..12).map(|_| ("minecraft:stone", 1)).collect(); + let layout = tooltip_layout(&items, &bundle_with(&twelve), 0.0, 0.0, 96.0).unwrap(); + assert_eq!(layout.slots.len(), 12); + assert_eq!(layout.overflow, None); + assert_eq!(layout.height, 3.0 * 24.0 + 13.0 + 8.0); + // Rows fill bottom-up and columns right-to-left: the first item is in + // the bottom-right cell, the twelfth in the top-left. + assert_eq!(layout.slots[0].0, [96.0 - 24.0, 3.0 * 24.0 - 24.0]); + assert_eq!(&*layout.slots[0].1.item, "minecraft:stone"); + assert_eq!(layout.slots[11].0, [0.0, 0.0]); + // A wider tooltip centres the 96 pixel column in it. + let centred = tooltip_layout(&items, &bundle_with(&twelve), 0.0, 0.0, 120.0).unwrap(); + assert_eq!(centred.slots[0].0[0], 12.0 + 96.0 - 24.0); + // Thirteen stacks: `getNumberOfItemsToShow` leaves the last row room + // for the count, so 8 slots show and `+6` (four stones and two dirt) + // takes the first cell. + let mut counts = twelve; + counts.push(("minecraft:dirt", 2)); + let layout = tooltip_layout(&items, &bundle_with(&counts), 0.0, 0.0, 96.0).unwrap(); + assert_eq!(layout.slots.len(), 8); + assert_eq!(layout.overflow, Some(([96.0 - 24.0, 48.0], 6))); + } + + #[test] + fn the_bar_fills_with_the_weight_and_an_empty_bundle_explains_itself() { + let Some(items) = items() else { return }; + let layout = tooltip_layout(&items, &bundle_with(&[]), 4.0, 8.0, 96.0).unwrap(); + assert!(layout.slots.is_empty()); + assert_eq!(layout.fill, 0.0); + assert_eq!(layout.label, Some("item.minecraft.bundle.empty")); + assert_eq!(layout.empty_description, Some([4.0, 8.0])); + assert_eq!(layout.bar, [4.0, 8.0 + 18.0 + 4.0]); + // A bundle holding one 64 stack is full: the whole bar, the full label. + let layout = tooltip_layout( + &items, + &bundle_with(&[("minecraft:stone", 64)]), + 0.0, + 0.0, + 96.0, + ) + .unwrap(); + assert!(layout.full); + assert_eq!(layout.fill, 94.0); + assert_eq!(layout.label, Some("item.minecraft.bundle.full")); + // Something that is not a bundle has no component. + let dirt = ItemStack::new("minecraft:dirt", 1); + assert!(tooltip_layout(&items, &dirt, 0.0, 0.0, 96.0).is_none()); + } +} diff --git a/crates/horizon-client/src/clipboard.rs b/crates/horizon-client/src/clipboard.rs index c21460cdb..76872091c 100644 --- a/crates/horizon-client/src/clipboard.rs +++ b/crates/horizon-client/src/clipboard.rs @@ -346,6 +346,11 @@ mod tests { assert_eq!(filter_text(s, true), "abc\nde\u{80}"); assert_eq!(strip_formatting("§aRed§r §zx§"), "Red §zx§"); assert_eq!(helper_clipboard_contents("§lone\r\ntwo"), "one\ntwo"); + // TextFieldHelper.getClipboardContents runs before insertText's filter. + assert_eq!( + filter_text(&helper_clipboard_contents("§aHello"), false), + "Hello" + ); } struct Field { diff --git a/crates/horizon-client/src/container_screen.rs b/crates/horizon-client/src/container_screen.rs index 2c490861a..77c7ad8aa 100644 --- a/crates/horizon-client/src/container_screen.rs +++ b/crates/horizon-client/src/container_screen.rs @@ -275,4 +275,30 @@ mod tests { Release::Click(Input::QuickMove) ); } + + /// A press whose release never arrives (the pointer left the window, or + /// the screen closed first) leaves `isQuickCrafting` set; the next screen + /// starts with its own state, as `AbstractContainerScreen` does, so the + /// reset the game runs on open/close makes clicks work again. + #[test] + fn a_lost_release_does_not_wedge_the_next_screen() { + let mut clicks = Clicks::default(); + let slot = Target::::Slot(3); + // Pressed with a stack carried: a quick craft drag starts, and its + // release is lost. + assert_eq!(clicks.press(&slot, Button::Left, false, false, false), None); + assert!(clicks.quick_crafting().is_some()); + assert_eq!( + clicks.press(&slot, Button::Left, true, false, false), + None, + "the stuck drag swallows the next press" + ); + // A new screen: fresh state, so the press is a normal click again. + clicks = Clicks::default(); + assert!(clicks.quick_crafting().is_none()); + assert_eq!( + clicks.press(&slot, Button::Left, true, false, false), + Some(Input::Pickup) + ); + } } diff --git a/crates/horizon-client/src/containers.rs b/crates/horizon-client/src/containers.rs index d13c5e45b..00e3f05b8 100644 --- a/crates/horizon-client/src/containers.rs +++ b/crates/horizon-client/src/containers.rs @@ -49,6 +49,17 @@ pub struct Furnace { /// rather than per item, and a save keeps it as the `RecipesUsed` compound. pub recipes_used: HashMap, } +/// The key `recipes_used` keeps a recipe under: its full id, as vanilla's `ResourceKey` +/// writes it in `RecipesUsed`. Horizon's own recipe ids are file names without the namespace, so +/// keeping both forms would write a key twice, and vanilla refuses such a furnace +/// ("Duplicate entry for key"). +pub fn recipe_used_key(id: &str) -> String { + if id.contains(':') { + id.to_owned() + } else { + format!("minecraft:{id}") + } +} /// A hopper's slots: the only plain container with five. pub const HOPPER_SLOTS: usize = 5; @@ -638,7 +649,10 @@ impl Furnace { Some(out) => out.count += recipe.result.count, None => self.items[2] = Some(recipe.result.clone()), } - *self.recipes_used.entry(recipe.id.clone()).or_insert(0) += 1; + *self + .recipes_used + .entry(recipe_used_key(&recipe.id)) + .or_insert(0) += 1; if let Some(i) = self.items[0].as_mut() { i.count -= 1; if i.count == 0 { diff --git a/crates/horizon-client/src/crafting.rs b/crates/horizon-client/src/crafting.rs index 690383963..899ce90d9 100644 --- a/crates/horizon-client/src/crafting.rs +++ b/crates/horizon-client/src/crafting.rs @@ -1612,7 +1612,9 @@ impl Recipes { } /// The `experience` of the cooking recipe with this file name, and 0 for one this data /// pack does not have (a save from another pack can name it). + /// `id` with or without the `minecraft:` namespace (a furnace keeps the full id). pub fn cooking_experience(&self, id: &str) -> f32 { + let id = id.strip_prefix("minecraft:").unwrap_or(id); self.cooking .iter() .find(|c| c.id == id) diff --git a/crates/horizon-client/src/creative.rs b/crates/horizon-client/src/creative.rs index 249e40b11..033b4daec 100644 --- a/crates/horizon-client/src/creative.rs +++ b/crates/horizon-client/src/creative.rs @@ -1,7 +1,7 @@ //! Creative inventory (CreativeModeInventoryScreen): vanilla's tabs and their //! contents as built by the game's own display generators //! (`creative-inventory.json`), a 9x5 scrolling grid and the search tab. -use crate::{Result, items::ItemStack}; +use crate::{Result, items::ItemStack, ui::EditBox}; use serde_json::Value; use std::{collections::HashMap, fs, path::Path}; @@ -35,10 +35,8 @@ pub struct Creative { pub scroll: f32, /// The scrollbar is held (scrolling): dragging moves it. pub scrolling: bool, - pub search: String, - /// When the search box took the focus (`EditBox.setFocused`): its - /// cursor blinks from then. - pub search_focused: std::time::Instant, + /// CreativeModeInventoryScreen's search box: an unbordered `EditBox` of 50. + pub search: EditBox, /// The search tab's stacks, in its display order. search_items: Vec, search_index: Vec, @@ -284,8 +282,13 @@ impl Creative { selected: 0, scroll: 0.0, scrolling: false, - search: String::new(), - search_focused: std::time::Instant::now(), + search: { + let mut search = EditBox::new(0.0, 0.0, 80.0, 9.0); + search.bordered = false; + search.max_length = 50; + search.text_color = u32::MAX; + search + }, search_items, search_index, } @@ -306,12 +309,13 @@ impl Creative { /// selectTab: a different tab empties the search box; the scrollbar goes to the top. pub fn select(&mut self, tab: usize) { if tab != self.selected { - self.search.clear(); + self.search.set_value(""); } self.selected = tab; self.scroll = 0.0; if self.tab().search { - self.search_focused = std::time::Instant::now(); + self.search.focused = true; + self.search.reset_blink(); } } /// The search tab's stacks. @@ -385,7 +389,7 @@ impl Creative { let tab = self.tab(); if tab.search { return self - .search_results(&self.search, names) + .search_results(&self.search.value, names) .into_iter() .map(|i| self.search_items[i].clone()) .collect(); @@ -754,13 +758,13 @@ mod tests { (1, false, true), (2, true, false), ] { - c.search = "anvil".into(); + c.search.set_value("anvil"); c.scroll = 0.5; c.select(selected); assert_eq!(c.selected, selected); assert_eq!(c.tab().inventory, inventory); assert_eq!(c.tab().search, search); - assert!(c.search.is_empty()); + assert!(c.search.value.is_empty()); assert_eq!(c.scroll, 0.0); } } @@ -780,12 +784,12 @@ mod tests { assert_eq!(c.tabs[0].items[0].item.as_ref(), "minecraft:anvil"); let mut c = c; c.select(1); - c.search = "anvil".into(); + c.search.set_value("anvil"); c.scroll = 0.5; c.select(1); - assert_eq!((c.search.as_str(), c.scroll), ("anvil", 0.0)); + assert_eq!((c.search.value.as_str(), c.scroll), ("anvil", 0.0)); c.select(0); - assert_eq!(c.search, ""); + assert_eq!(c.search.value, ""); } #[test] @@ -899,4 +903,25 @@ mod tests { c.scroll = 1.0; assert_eq!(c.scroller_offset(), 95.0); } + + #[test] + fn search_edits_at_its_cursor() { + use winit::keyboard::KeyCode; + let mut c = creative(0); + c.select(1); + c.search.insert_text("hello world"); + for _ in 0..5 { + assert!(c.search.key(KeyCode::ArrowLeft, false, false)); + } + c.search.insert_text("X"); + assert_eq!(c.search.value, "hello Xworld"); + c.search.key(KeyCode::Home, false, true); + c.search.insert_text("Y"); + assert_eq!(c.search.value, "Yworld"); + // Ctrl+Left jumps a word; one step right and Backspace deletes before the cursor. + c.search.key(KeyCode::ArrowLeft, true, false); + c.search.key(KeyCode::ArrowRight, false, false); + c.search.key(KeyCode::Backspace, false, false); + assert_eq!(c.search.value, "world"); + } } diff --git a/crates/horizon-client/src/cushion.rs b/crates/horizon-client/src/cushion.rs new file mode 100644 index 000000000..7610a4aab --- /dev/null +++ b/crates/horizon-client/src/cushion.rs @@ -0,0 +1,59 @@ +//! Cushion placement and support checks (`Cushion.canBePlacedAt`/`wouldSurviveAt`). +use horizon_core::geometry::{Aabb, ShapeOp, Vec3, VoxelShape}; + +pub trait World { + fn outline_bounds(&self, pos: [i32; 3]) -> Option; + fn collision_shapes(&self, bounds: Aabb) -> Vec; + fn suffocating(&self, pos: [i32; 3]) -> bool; +} + +pub fn blocks_in(a: Aabb) -> impl Iterator { + let (lo, hi) = (a.min_position(), a.max_position()); + let (x0, y0, z0) = ( + lo.x.floor() as i32, + lo.y.floor() as i32, + lo.z.floor() as i32, + ); + let (x1, y1, z1) = ( + hi.x.floor() as i32, + hi.y.floor() as i32, + hi.z.floor() as i32, + ); + (y0..=y1).flat_map(move |y| (z0..=z1).flat_map(move |z| (x0..=x1).map(move |x| [x, y, z]))) +} + +pub fn survives(world: &impl World, bounds: Aabb) -> bool { + let (lo, hi) = (bounds.min_position(), bounds.max_position()); + let anchor = Aabb::new( + Vec3::new(lo.x, lo.y - 0.015625, lo.z), + Vec3::new(hi.x.next_down(), lo.y, hi.z.next_down()), + ); + // The extra eighth block expands the scan, not the intersection test. + let supported = blocks_in(anchor.expand_towards(Vec3::new(0.0, -0.125, 0.0))).any(|p| { + world + .outline_bounds(p) + .is_some_and(|shape| shape.intersects(anchor)) + }); + supported && !blocks_in(bounds.next_deflated()).all(|p| world.suffocating(p)) +} + +pub fn can_place(world: &impl World, bounds: Aabb) -> bool { + if !survives(world, bounds) { + return false; + } + let (lo, hi) = (bounds.min_position(), bounds.max_position()); + let slab = Aabb::new(lo, Vec3::new(hi.x, lo.y + 0.015625, hi.z)).next_deflated(); + let Ok(mut remaining) = VoxelShape::from_box(slab) else { + return false; + }; + for shape in world.collision_shapes(slab) { + let Ok(next) = remaining.join(&shape, ShapeOp::ONLY_FIRST) else { + return false; + }; + remaining = next; + if remaining.is_empty() { + return false; + } + } + true +} diff --git a/crates/horizon-client/src/entities.rs b/crates/horizon-client/src/entities.rs index 6e8089e9d..69e053411 100644 --- a/crates/horizon-client/src/entities.rs +++ b/crates/horizon-client/src/entities.rs @@ -591,6 +591,57 @@ impl Painting { ) } } +/// The `DyeColor` ordinal of a colour name (`DyeColor.byName`), white when +/// the name is unknown. +pub fn dye_index(name: &str) -> u8 { + crate::mobs::render::DYE_NAMES + .iter() + .position(|n| *n == name) + .unwrap_or(0) as u8 +} +/// A cushion (`Cushion`, a `BlockAttachedEntity`): a 1 x 0.25 block pillow +/// that seats a player. It sits on the top face of a block, at the clicked +/// height, and is coloured by its `DyeColor`. +#[derive(Clone, Debug)] +pub struct Cushion { + pub id: u32, + /// `Entity.position`: the bottom centre of the cushion. + pub position: Vec3, + /// `BlockAttachedEntity.pos` (the saved `block_pos`). + pub pos: [i32; 3], + pub yaw: f32, + /// `DyeColor` ordinal: white 0, orange 1, ..., black 15. + pub color: u8, + /// BlockAttachedEntity.ticksSinceLastCheck. + pub check_interval: u32, +} +impl Cushion { + /// `Entity.makeBoundingBox`: x and z half a block out, y to y + 0.25. + pub fn bounds(&self) -> ([f64; 3], [f64; 3]) { + let p = self.position; + ( + [p.x - 0.5, p.y, p.z - 0.5], + [p.x + 0.5, p.y + 0.25, p.z + 0.5], + ) + } + /// The `DyeColor` name of the cushion. + pub fn color_name(&self) -> &'static str { + crate::mobs::render::DYE_NAMES[usize::from(self.color.min(15))] + } + /// `Cushion.getCushionItemStackWithData`: the matching coloured item. + pub fn item(&self) -> String { + format!("minecraft:{}_cushion", self.color_name()) + } + /// `Cushion.interact`'s seat: the vehicle's PASSENGER attachment + /// `(0, 0.25, 0)` less the player's `(0, 0.6, 0)`. + pub fn seat(&self) -> Vec3 { + Vec3::new(self.position.x, self.position.y - 0.35, self.position.z) + } + /// `Entity.getDismountLocationForPassenger`: on top of the cushion. + pub fn dismount(&self) -> Vec3 { + Vec3::new(self.position.x, self.position.y + 0.25, self.position.z) + } +} /// An item frame or glow item frame (`ItemFrame`). #[derive(Clone, Debug)] pub struct ItemFrame { diff --git a/crates/horizon-client/src/entity_nbt.rs b/crates/horizon-client/src/entity_nbt.rs index 00576ea02..7f3565067 100644 --- a/crates/horizon-client/src/entity_nbt.rs +++ b/crates/horizon-client/src/entity_nbt.rs @@ -6,7 +6,7 @@ //! survive a Horizon save. use crate::{ arrows::Pickup, - entities::{ArmorStand, ExperienceOrb, ItemEntity, ItemFrame, Painting}, + entities::{ArmorStand, Cushion, ExperienceOrb, ItemEntity, ItemFrame, Painting}, mobs::{Mob, MobType, Who}, projectiles::{Projectile, ProjectileKind}, save::{ @@ -1313,6 +1313,79 @@ pub fn painting_from_nbt(tag: &Tag) -> Option<([i32; 3], u8, String)> { let facing = (number(tag.get("facing")).unwrap_or(0) & 3) as u8; Some((pos, facing, text(tag.get("variant"))?)) } +/// Cushion.addAdditionalSaveData: the block it sits on and its colour. +pub fn cushion_to_nbt(c: &Cushion, uuid: [i32; 4], raw: Option<&Tag>) -> Tag { + let base = Base { + id: "minecraft:cushion", + uuid, + position: c.position, + motion: Vec3::ZERO, + rotation: [c.yaw, 0.0], + on_ground: false, + fall_distance: 0.0, + }; + let mut tag = base.tag(raw); + put(&mut tag, "block_pos", Tag::IntArray(c.pos.to_vec())); + put(&mut tag, "color", string(c.color_name())); + tag +} +/// The position, block position, yaw and colour of a saved cushion. +pub fn cushion_from_nbt(tag: &Tag, id: u32) -> Option { + let position = position(tag)?; + let pos = match tag.get("block_pos") { + Some(Tag::IntArray(v)) if v.len() == 3 => [v[0], v[1], v[2]], + _ => [ + position.x.floor() as i32, + position.y.floor() as i32, + position.z.floor() as i32, + ], + }; + let yaw = match tag.get("Rotation") { + Some(Tag::List(l)) => l + .first() + .and_then(|v| crate::save::float(Some(v))) + .unwrap_or(0.0) as f32, + _ => 0.0, + }; + let color = + crate::entities::dye_index(&text(tag.get("color")).unwrap_or_else(|| "white".into())); + Some(Cushion { + id, + position, + pos, + yaw, + color, + check_interval: 0, + }) +} + +#[cfg(test)] +mod cushion_tests { + use super::*; + + #[test] + fn cushion_save_preserves_color_anchor_rotation_and_unknown_data() { + let cushion = Cushion { + id: 7, + position: Vec3::new(-1.5, 64.5, 3.5), + pos: [-2, 64, 3], + yaw: 270.0, + color: 14, + check_interval: 55, + }; + let raw = Tag::compound([("CustomName", string("Seat"))]); + let tag = cushion_to_nbt(&cushion, [1, 2, 3, 4], Some(&raw)); + assert_eq!(text(tag.get("CustomName")).as_deref(), Some("Seat")); + let loaded = cushion_from_nbt(&tag, 8).unwrap(); + assert_eq!(loaded.id, 8); + assert_eq!(loaded.position, cushion.position); + assert_eq!(loaded.pos, cushion.pos); + assert_eq!(loaded.yaw, cushion.yaw); + assert_eq!(loaded.color_name(), "red"); + assert_eq!(loaded.check_interval, 0); + assert_eq!(loaded.bounds(), cushion.bounds()); + } +} /// ItemFrame.addAdditionalSaveData. pub fn item_frame_to_nbt(f: &ItemFrame, uuid: [i32; 4], raw: Option<&Tag>) -> Tag { let (lo, hi) = f.bounds(); diff --git a/crates/horizon-client/src/game.rs b/crates/horizon-client/src/game.rs index 5760ffbe7..a8ede43a4 100644 --- a/crates/horizon-client/src/game.rs +++ b/crates/horizon-client/src/game.rs @@ -33,6 +33,7 @@ mod copper_golems; mod creaking; mod creatures; mod crossbow; +pub(crate) mod cushions; mod debug_keys; mod decorated_pot; mod dedicated; @@ -80,6 +81,7 @@ mod lan_mobs; mod lan_mount_menu; mod lan_particles; mod lan_pvp; +mod lan_quiet; mod lan_screen; mod lan_stations; mod lan_trading; @@ -147,6 +149,7 @@ mod scoreboard; mod screens; mod sculk; mod sculk_fixture; +mod server_mods; mod server_packs; mod server_travel; mod shader_packs; @@ -1429,6 +1432,8 @@ struct Game<'a> { map_frame_model: frames::FrameModel, glow_map_frame_model: frames::FrameModel, armor_stands: Vec, + /// `Cushion` decoration entities (game/cushions.rs). + cushions: Vec, /// Entities of types Horizon does not simulate. others: Vec, armor_stand_assets: armor_stands::ArmorStandAssets, @@ -1444,6 +1449,8 @@ struct Game<'a> { boat_models: boats::BoatModels, /// EndCrystalModel's baked layer. crystal_model: Option, + /// CushionModel's baked layer. + cushion_model: Option, carts: Vec, /// Songs playing from jukeboxes (tracked sound handles). jukebox_sounds: HashMap<(i32, i32, i32), u64>, @@ -2787,6 +2794,9 @@ impl Game<'_> { pos, data, } => self.consume_teleport_particles([pos.x, pos.y, pos.z], data), + LevelEvent::LevelEvent { id: 2003, pos, .. } => { + self.eye_break_particles([pos.x, pos.y, pos.z]); + } LevelEvent::LevelEvent { id: 2013, pos, @@ -3338,6 +3348,7 @@ impl Game<'_> { self.pad_rumble(horizon_client::gamepad::Rumble::BlockBroken); // ServerPlayerGameMode.destroyBlock. let state = self.world.block(pos[0], pos[1], pos[2]); + let broken = state; let facts = self.res.facts().get(state).clone(); let state = self.crack_mined_pot(pos, state); // Block.playerWillDestroy: mining their gold angers all nearby piglins. @@ -3369,6 +3380,9 @@ impl Game<'_> { creative, ) }); + if removed { + self.mod_block_event(pos, broken, false); + } if removed && !creative { let held = self.held().cloned(); self.mine_block_with_held(&facts.name, facts.hardness); @@ -3477,6 +3491,7 @@ impl Game<'_> { fn interact_entity(&mut self) -> Result { Ok(self.interact_frame() || self.interact_armor_stand() + || self.interact_cushion() || self.interact_boat() || self.interact_cart() || self.interact_mob()? @@ -3663,6 +3678,7 @@ impl Game<'_> { || self.place_painting(hit, &stack) || self.place_item_frame(hit, &stack) || self.place_armor_stand(hit, &stack) + || self.place_cushion(hit, &stack) || self.place_end_crystal(hit, &stack)) { return Ok(true); @@ -3711,6 +3727,7 @@ impl Game<'_> { return Ok(true); }; let target = [pos.x, pos.y, pos.z]; + self.mod_block_event(target, state, true); if let Some(entity) = BlockEntity::for_block(&self.res.facts().get(state).name) { let key = (target[0], target[1], target[2]); self.world.block_entities.insert(key, entity); @@ -4244,6 +4261,7 @@ impl Game<'_> { self.update_totem_ready(); self.tick_command_extras(); self.tick_mods(); + self.tick_server_mods(); let camera_eye = self.camera_eye_height(); let stick = self.pad_move(); if self.riding.is_some() && self.player.is_some() { @@ -4546,6 +4564,7 @@ impl Game<'_> { horizon_client::spans::time("tick_paintings", || self.tick_paintings()); horizon_client::spans::time("tick_item_frames", || self.tick_item_frames()); horizon_client::spans::time("tick_armor_stands", || self.tick_armor_stands()); + horizon_client::spans::time("tick_cushions", || self.tick_cushions()); horizon_client::spans::time("tick_boats", || self.tick_boats()); horizon_client::spans::time("tick_carts", || self.tick_carts()); horizon_client::spans::time("tick_thunder", || self.tick_thunder()); @@ -4754,7 +4773,10 @@ impl Game<'_> { if capture && !self.focused { return; } - if !capture { + if capture { + // The inventory's screens are behind us: no drag survives them. + self.reset_inventory_clicks(); + } else { self.stop_mining(); } // The real pointer takes over from an agent's. @@ -5593,7 +5615,18 @@ impl Game<'_> { self.draw_inventory_effects(batch, (ox, oy), 176); } } + /// `AbstractContainerScreen` keeps `isQuickCrafting` and the drag it + /// belongs to on the screen; Horizon keeps them on the game, so they are + /// dropped when a screen closes. A press whose release never reaches the + /// screen (the pointer left the window, or the screen closed first) would + /// otherwise leave every later press on every later screen swallowed. + pub(super) fn reset_inventory_clicks(&mut self) { + self.inv_clicks = Default::default(); + self.inv_drag = None; + self.last_inv_click = None; + } pub(super) fn close_container(&mut self) { + self.reset_inventory_clicks(); self.close_station(); self.mount_closed(); self.recipe_ui.reset_screen(); @@ -5689,8 +5722,9 @@ impl Game<'_> { if self.creative_screen.tab().search { // CreativeModeInventoryScreen.slotClicked: moveCursorToEnd, then // setHighlightPos(0), so typing replaces the whole query. - let search = &self.creative_screen.search; - self.text_selection.select(("creative.search", 0), search); + let search = &mut self.creative_screen.search; + search.move_cursor_to_end(false); + search.highlight = 0; } let items = self.creative_screen.items(&self.pack.names); let first = self.creative_screen.first_row(&self.pack.names); @@ -6332,6 +6366,13 @@ impl Game<'_> { false, ); if outside { + // AbstractRecipeBookScreen.mouseClicked: the book takes the click + // before the outside test, and its tabs sit left of the strip + // hasClickedOutside counts as the book. + if self.recipe_book_click(right) { + self.inv_clicks.skip_release(); + return; + } // slotId -999: an empty hand throws nothing; a carried stack // starts a drag whose release drops it. match input { @@ -7238,6 +7279,7 @@ impl Game<'_> { self.frame_geometry(camera, &mut out); self.mark_entity(out.len(), "minecraft:armor_stand"); self.armor_stand_geometry(camera, alpha, &mut out); + self.cushion_geometry(camera, &mut out); self.mark_entity(out.len(), "minecraft:oak_boat"); self.boat_geometry(camera, alpha, &mut out); self.mark_entity(out.len(), "minecraft:minecart"); @@ -7534,6 +7576,7 @@ impl Game<'_> { .map_or(0.0, |i| i.attack_damage); if self.attack_frame() || self.attack_armor_stand() + || self.attack_cushion() || self.attack_boat(hand_damage) || self.attack_cart(hand_damage) || self.attack_dragon() @@ -8278,6 +8321,7 @@ impl Game<'_> { self.boats.clear(); self.carts.clear(); self.armor_stands.clear(); + self.cushions.clear(); self.item_frames.clear(); self.paintings.clear(); self.others.clear(); @@ -9813,20 +9857,16 @@ impl Game<'_> { ); } if tab.search { - // The search box: an unbordered EditBox of 80 at (82, 6), white. - let search = &self.creative_screen.search; - horizon_client::ui::append_field( - batch, - atlas, - search, - (ox + 82.0, oy + 6.0, 80.0), - (u32::MAX, true), - clipboard::CREATIVE_SEARCH_CHARS, - self.text_selection - .covers(clipboard::CREATIVE_SEARCH, search), - true, - self.creative_screen.search_focused.elapsed().as_millis(), - ); + // CreativeModeInventoryScreen: an unbordered EditBox of 50 at (82, 6). + let search = &mut self.creative_screen.search; + search.x = ox + 82.0; + search.y = oy + 6.0; + search.width = 80.0; + search.bordered = false; + search.focused = true; + search.text_color = u32::MAX; + search.max_length = clipboard::CREATIVE_SEARCH_CHARS; + search.draw(batch, atlas, None); } let mut hovered: Option = None; if tab.inventory { @@ -9934,8 +9974,7 @@ impl Game<'_> { } else if self.carried.is_none() && let Some(item) = hovered { - let lines = self.stack_tooltip(&item); - self.draw_tooltip_lines(batch, &lines, self.cursor.0, self.cursor.1); + self.draw_stack_tooltip(batch, &item, self.cursor.0, self.cursor.1); } self.draw_inventory_effects(batch, (ox, oy), Creative::WIDTH as i32); } @@ -9988,6 +10027,9 @@ impl Game<'_> { } return; } + if !right && self.creative_search_click(ox, oy) { + return; + } // Holding the scrollbar scrolls as the mouse moves (mouseDragged). if !right && self @@ -10000,6 +10042,24 @@ impl Game<'_> { self.inventory_press(right); } } + /// A click on the search tab's box (`EditBox.onClick`). + fn creative_search_click(&mut self, ox: f32, oy: f32) -> bool { + if !self.creative_screen.tab().search { + return false; + } + let (x, y, w, h) = (ox + 82.0, oy + 6.0, 80.0, 9.0); + let (mx, my) = self.cursor; + if mx < x || my < y || mx >= x + w || my >= y + h { + return false; + } + let shift = self.has_shift_down(); + let search = &mut self.creative_screen.search; + search.x = x; + search.y = y; + search.width = w; + search.click(&self.gui.atlas, mx, shift, false); + true + } /// Copy the live player and world state into the `Level` that gets saved. pub(super) fn sync_level(&mut self) { // Level.write saves the game rules (game_rules.dat) with the rest. @@ -11645,8 +11705,17 @@ impl ApplicationHandler for Game<'_> { // The hovered slot took the key (`ignoreTextInput`). } else if let Some(shortcut) = self.edit_shortcut(&event) { self.creative_search_shortcut(shortcut); - } else if event.physical_key == PhysicalKey::Code(KeyCode::Backspace) { - self.creative_search_backspace(self.has_control_down()); + } else if let PhysicalKey::Code(key) = event.physical_key { + // EditBox.keyPressed: arrows, Home, End, Delete and Backspace. + let before = self.creative_screen.search.value.clone(); + let (ctrl, shift) = (self.has_control_down(), self.has_shift_down()); + if self.creative_screen.search.key(key, ctrl, shift) { + if self.creative_screen.search.value != before { + self.creative_screen.scroll = 0.0; + } + } else { + self.creative_search_edit(event.text.as_deref()); + } } else { self.creative_search_edit(event.text.as_deref()); } @@ -11667,6 +11736,9 @@ impl ApplicationHandler for Game<'_> { // The anvil rename box takes every key but Escape (AnvilScreen.keyPressed). if let Some(shortcut) = self.edit_shortcut(&event) { self.station_shortcut(shortcut); + } else if let PhysicalKey::Code(key) = event.physical_key + && self.station_key(key) + { } else { let backspace = event.physical_key == PhysicalKey::Code(KeyCode::Backspace); self.station_text(event.text.as_deref(), backspace); @@ -12283,6 +12355,7 @@ impl<'a> Game<'a> { map_frame_model: prepared.map_frame_model, glow_map_frame_model: prepared.glow_map_frame_model, armor_stands: Vec::new(), + cushions: Vec::new(), others: Vec::new(), armor_stand_assets: prepared.armor_stand_assets, waypoint_styles: prepared.waypoint_styles, @@ -12292,6 +12365,7 @@ impl<'a> Game<'a> { boats: Vec::new(), boat_models: prepared.boat_models, crystal_model: prepared.crystal_model, + cushion_model: prepared.cushion_model, carts: Vec::new(), jukebox_sounds: HashMap::new(), bolts: Vec::new(), @@ -12430,6 +12504,7 @@ struct GameCpuResources { boat_models: boats::BoatModels, cart_models: minecarts::CartModels, crystal_model: Option, + cushion_model: Option, dragon_model: Option, arrow_model: Option, trident_model: Option, @@ -12450,6 +12525,7 @@ impl GameCpuResources { boat_models: boats::BoatModels::load(document.as_ref()), cart_models: minecarts::CartModels::load(document.as_ref()), crystal_model: model("minecraft:end_crystal#main"), + cushion_model: model("minecraft:cushion#main"), dragon_model: model("minecraft:ender_dragon#main"), arrow_model: model("minecraft:arrow#main"), trident_model: model("minecraft:trident#main"), @@ -13805,7 +13881,7 @@ mod startup_cpu_tests { r#"{ "minecraft:end_crystal#main": {}, "minecraft:ender_dragon#main": {}, "minecraft:arrow#main": {}, "minecraft:trident#main": {}, - "minecraft:armor_stand#main": {} + "minecraft:armor_stand#main": {}, "minecraft:cushion#main": {} }"#, ) .unwrap(); @@ -13825,6 +13901,7 @@ mod startup_cpu_tests { .unwrap(); std::fs::remove_dir_all(&root).unwrap(); assert!(prepared.crystal_model.is_some()); + assert!(prepared.cushion_model.is_some()); assert!(prepared.dragon_model.is_some()); assert!(prepared.arrow_model.is_some()); assert!(prepared.trident_model.is_some()); diff --git a/crates/horizon-client/src/game/beacon.rs b/crates/horizon-client/src/game/beacon.rs index 24ead3a3d..97177f2b9 100644 --- a/crates/horizon-client/src/game/beacon.rs +++ b/crates/horizon-client/src/game/beacon.rs @@ -515,8 +515,7 @@ impl Game<'_> { if self.carried.is_some() { self.draw_carried(batch); } else if let Some(stack) = stack_tip { - let lines = self.stack_tooltip(&stack); - self.draw_tooltip_lines(batch, &lines, self.cursor.0, self.cursor.1); + self.draw_stack_tooltip(batch, &stack, self.cursor.0, self.cursor.1); } else if let Some(key) = tooltip { let text = self.translate(&key, &key); self.draw_tooltip_lines( diff --git a/crates/horizon-client/src/game/boats.rs b/crates/horizon-client/src/game/boats.rs index df7158d9a..40dd1b7eb 100644 --- a/crates/horizon-client/src/game/boats.rs +++ b/crates/horizon-client/src/game/boats.rs @@ -587,6 +587,9 @@ impl Game<'_> { } /// The player's tick while riding: steer, tick the boat, sit in it. pub(super) fn tick_riding(&mut self, keys: Keys) -> horizon_client::Result<()> { + if self.tick_cushion_riding(keys) { + return Ok(()); + } let Some(i) = self.boats.iter().position(|b| Some(b.id) == self.riding) else { if self.tick_cart_riding(keys) || self.tick_mount_riding(keys) { return Ok(()); diff --git a/crates/horizon-client/src/game/books.rs b/crates/horizon-client/src/game/books.rs index 9af1da70c..2f38dffd9 100644 --- a/crates/horizon-client/src/game/books.rs +++ b/crates/horizon-client/src/game/books.rs @@ -17,7 +17,6 @@ use horizon_client::{ use horizon_core::position::BlockPos; use horizon_protocol::packets::play::{self, Clientbound as C, Serverbound as S}; use horizon_world::level::flags as level_flags; -use std::time::Instant; use winit::{ event::{ElementState, KeyEvent}, keyboard::{KeyCode, PhysicalKey}, @@ -27,8 +26,24 @@ const BLACK: u32 = 0xFF00_0000; const PAGE_CHARS: usize = 1024; const MAX_PAGES: usize = 100; const LINES: usize = 14; -/// `BookSignScreen`'s title box. -const BOOK_TITLE: horizon_client::clipboard::FieldId = ("book.title", 0); + +fn book_title_box() -> ui::EditBox { + let mut edit = ui::EditBox::new(0.0, 0.0, 114.0, 9.0); + edit.bordered = false; + edit.max_length = 15; + edit.text_color = BLACK; + edit.focused = true; + edit +} +fn book_page_box() -> ui::EditBox { + let mut edit = ui::EditBox::new(0.0, 0.0, 114.0, 9.0); + edit.bordered = false; + edit.multiline = true; + edit.max_length = PAGE_CHARS; + edit.text_color = BLACK; + edit.focused = true; + edit +} pub(super) enum BookScreen { Edit { @@ -38,7 +53,10 @@ pub(super) enum BookScreen { page: usize, signing: bool, title: String, - opened: Instant, + /// BookSignScreen's title box (`EditBox` of 15). + title_edit: ui::EditBox, + /// BookEditScreen's page (`MultiLineEditBox`). + page_edit: ui::EditBox, }, View { pages: Vec, @@ -84,13 +102,16 @@ impl Game<'_> { if pages.is_empty() { pages.push(String::new()); } + let mut page_edit = book_page_box(); + page_edit.set_value(&pages[0]); BookScreen::Edit { slot: self.held_slot(), pages, page: 0, signing: false, title: String::new(), - opened: Instant::now(), + title_edit: book_title_box(), + page_edit, } } "minecraft:written_book" => BookScreen::View { @@ -239,34 +260,24 @@ impl Game<'_> { Some(KeyCode::PageDown) => self.turn_page(true), _ => {} }, - Some(BookScreen::Edit { - signing: true, - title, - .. - }) => match key { + Some(BookScreen::Edit { signing: true, .. }) => match key { Some(KeyCode::Escape) => { if let Some(BookScreen::Edit { signing, .. }) = self.book.as_mut() { *signing = false; } } - Some(KeyCode::Backspace) => { - if !self.text_selection.take(BOOK_TITLE, title) { - title.pop(); - } - } Some(KeyCode::Enter | KeyCode::NumpadEnter) => { - if !title.trim().is_empty() { + let blank = self.book.as_ref().is_some_and( + |b| matches!(b, BookScreen::Edit { title, .. } if title.trim().is_empty()), + ); + if !blank { self.save_book(true); } } + Some(key) if self.book_title_key(key) => {} _ => { if let Some(typed) = text { - self.text_selection.take(BOOK_TITLE, title); - for c in typed.chars().filter(|c| !c.is_control()) { - if title.chars().count() < 15 { - title.push(c); - } - } + self.book_title_insert(typed); } } }, @@ -274,24 +285,13 @@ impl Game<'_> { Some(KeyCode::Escape) => self.save_book(false), Some(KeyCode::PageUp) => self.turn_page(false), Some(KeyCode::PageDown) => self.turn_page(true), - Some(KeyCode::Backspace) => { - if !self.take_page_selection() { - self.edit_page(|p| { - p.pop(); - }) - } - } - Some(KeyCode::Enter | KeyCode::NumpadEnter) => { - self.take_page_selection(); - self.type_into_page("\n") - } + Some(KeyCode::ArrowUp) => self.book_move_line(-1), + Some(KeyCode::ArrowDown) => self.book_move_line(1), + Some(KeyCode::Enter | KeyCode::NumpadEnter) => self.page_insert("\n"), + Some(key) if self.book_page_key(key) => {} _ => { if let Some(typed) = text { - let typed: String = typed.chars().filter(|c| !c.is_control()).collect(); - if !typed.is_empty() { - self.take_page_selection(); - } - self.type_into_page(&typed); + self.page_insert(typed); } } }, @@ -302,99 +302,258 @@ impl Game<'_> { pub(super) fn book_type(&mut self, text: &str) { let text = text.replace("\\n", "\n"); match self.book.as_mut() { - Some(BookScreen::Edit { - signing: true, - title, - .. - }) => { - for c in text.chars().filter(|c| !c.is_control()) { - if title.chars().count() < 15 { - title.push(c); - } - } - } - Some(BookScreen::Edit { .. }) => self.type_into_page(&text), + Some(BookScreen::Edit { signing: true, .. }) => self.book_title_insert(&text), + Some(BookScreen::Edit { .. }) => self.page_insert(&text), _ => {} } } - /// Before typing on a page: Select All's selection is cleared (true). - fn take_page_selection(&mut self) -> bool { - match self.book.as_mut() { - Some(BookScreen::Edit { pages, page, .. }) => self - .text_selection - .take(("book.page", *page), &mut pages[*page]), - _ => false, + /// `BookSignScreen.keyPressed` on the title box. + fn book_title_key(&mut self, key: KeyCode) -> bool { + let (ctrl, shift) = (self.has_control_down(), self.has_shift_down()); + let Some(BookScreen::Edit { + title, title_edit, .. + }) = self.book.as_mut() + else { + return false; + }; + if !title_edit.key(key, ctrl, shift) { + return false; } + title.clone_from(&title_edit.value); + true } - /// Ctrl+A/C/V/X: the title box (an `EditBox` of 15) while signing, else - /// the page (`MultilineTextField.insertText`: line breaks kept, cut to - /// the 1024 characters left, rejected when it overflows the 14 lines). - pub(super) fn book_shortcut(&mut self, shortcut: horizon_client::clipboard::EditShortcut) { - let font = &self.gui.atlas.font; - match self.book.as_mut() { - Some(BookScreen::Edit { - signing: true, - title, - .. - }) => { - Self::append_shortcut( - &mut self.text_selection, - &mut self.clipboard, - BOOK_TITLE, - title, - shortcut, - 15, - ); - } - Some(BookScreen::Edit { pages, page, .. }) => { - // truncateInsertionText counts the whole value, selection included. - let room = PAGE_CHARS.saturating_sub(pages[*page].chars().count()); - self.text_selection.apply( - ("book.page", *page), - &mut pages[*page], - shortcut, - &mut self.clipboard, - |value, pasted| { - let text: String = horizon_client::clipboard::filter_text(pasted, true) - .chars() - .take(room) - .collect(); - let next = format!("{value}{text}"); - font.split(&Text::literal(&next), 114.0).len() <= LINES && { - *value = next; - true - } - }, - ); - } - _ => {} - } - } - fn edit_page(&mut self, f: impl FnOnce(&mut String)) { - if let Some(BookScreen::Edit { pages, page, .. }) = self.book.as_mut() { - f(&mut pages[*page]); - } - } - /// MultiLineEditBox: characters that keep the page within 14 lines and 1024 characters. - fn type_into_page(&mut self, typed: &str) { - let Some(BookScreen::Edit { pages, page, .. }) = self.book.as_ref() else { + fn book_title_insert(&mut self, text: &str) { + let Some(BookScreen::Edit { + title, title_edit, .. + }) = self.book.as_mut() + else { return; }; - let mut text = pages[*page].clone(); - for c in typed.chars() { - let mut next = text.clone(); - next.push(c); - if next.chars().count() <= PAGE_CHARS && self.book_lines(&next).len() <= LINES { - text = next; + title_edit.insert_text(text); + title.clone_from(&title_edit.value); + } + /// `BookEditScreen.keyPressed` on the page, apart from the line moves. + fn book_page_key(&mut self, key: KeyCode) -> bool { + let (ctrl, shift) = (self.has_control_down(), self.has_shift_down()); + let before = match self.book.as_ref() { + Some(BookScreen::Edit { page_edit, .. }) => Some(( + page_edit.value.clone(), + page_edit.cursor, + page_edit.highlight, + )), + _ => return false, + }; + let handled = if let Some(BookScreen::Edit { page_edit, .. }) = self.book.as_mut() { + page_edit.key(key, ctrl, shift) + } else { + false + }; + if handled { + self.page_keep(before); + } + handled + } + /// One character at a time, so a page stops at the last character that fits. + fn page_insert(&mut self, text: &str) { + for c in text.chars() { + self.page_change(|edit| edit.insert_text(&c.to_string())); + } + } + /// Ctrl+A/C/V/X: the title box while signing, else the page. + pub(super) fn book_shortcut(&mut self, shortcut: horizon_client::clipboard::EditShortcut) { + let signing = matches!(self.book, Some(BookScreen::Edit { signing: true, .. })); + if signing { + if let Some(BookScreen::Edit { + title, title_edit, .. + }) = self.book.as_mut() + { + title_edit.shortcut(shortcut, &mut self.clipboard); + title.clone_from(&title_edit.value); + } + return; + } + let before = match self.book.as_ref() { + Some(BookScreen::Edit { page_edit, .. }) => Some(( + page_edit.value.clone(), + page_edit.cursor, + page_edit.highlight, + )), + _ => None, + }; + if let Some(BookScreen::Edit { page_edit, .. }) = self.book.as_mut() { + page_edit.shortcut(shortcut, &mut self.clipboard); + } + self.page_keep(before); + } + /// Edit the page box, then keep it only within 14 lines and 1024 characters. + fn page_change(&mut self, f: impl FnOnce(&mut ui::EditBox)) -> bool { + let before = match self.book.as_ref() { + Some(BookScreen::Edit { page_edit, .. }) => Some(( + page_edit.value.clone(), + page_edit.cursor, + page_edit.highlight, + )), + _ => return false, + }; + let ran = if let Some(BookScreen::Edit { page_edit, .. }) = self.book.as_mut() { + f(page_edit); + true + } else { + false + }; + ran && self.page_keep(before) + } + /// Write the page, or put the previous text back when it no longer fits. + fn page_keep(&mut self, before: Option<(String, usize, usize)>) -> bool { + let next = match self.book.as_ref() { + Some(BookScreen::Edit { page_edit, .. }) => page_edit.value.clone(), + _ => return false, + }; + let ok = next.chars().count() <= PAGE_CHARS && self.book_lines(&next).len() <= LINES; + let Some(BookScreen::Edit { + pages, + page, + page_edit, + .. + }) = self.book.as_mut() + else { + return false; + }; + if ok { + pages[*page].clone_from(&page_edit.value); + } else if let Some((value, cursor, highlight)) = before { + page_edit.value = value; + page_edit.cursor = cursor; + page_edit.highlight = highlight; + } + ok + } + /// ArrowUp and ArrowDown move a visual line, keeping the column. + fn book_move_line(&mut self, dir: isize) { + let shift = self.has_shift_down(); + let (text, cursor) = match self.book.as_ref() { + Some(BookScreen::Edit { + pages, + page, + page_edit, + .. + }) => (pages[*page].clone(), page_edit.cursor), + _ => return, + }; + let rows = self.page_rows(&text); + let (x, line) = self.caret_on(&text, &rows, cursor); + let next = (line as isize + dir).clamp(0, rows.len() as isize - 1) as usize; + let (start, end) = rows[next]; + let chars: Vec = text.chars().collect(); + let slice: String = chars[start..end].iter().collect(); + let pos = start + self.gui.atlas.font.fit(&slice, x); + if let Some(BookScreen::Edit { page_edit, .. }) = self.book.as_mut() { + page_edit.set_cursor(pos, shift); + } + } + /// Wrapped rows of a page as character ranges, the same breaks as `font.split`. + fn page_rows(&self, page: &str) -> Vec<(usize, usize)> { + let font = &self.gui.atlas.font; + let chars: Vec = page.chars().collect(); + let mut rows = Vec::new(); + let mut start = 0; + while start < chars.len() { + let mut end = chars.len(); + let mut next = chars.len(); + let mut last_space = None; + for i in start..chars.len() { + if chars[i] == '\n' { + end = i; + next = i + 1; + break; + } + if chars[i] == ' ' { + last_space = Some(i); + } + let slice: String = chars[start..=i].iter().collect(); + if font.width(&slice) > 114.0 { + match last_space { + Some(s) if s > start => { + end = s; + next = s + 1; + } + _ => { + end = i.max(start + 1); + next = end; + } + } + break; + } + } + rows.push((start, end)); + start = next; + if start == chars.len() && chars.last() == Some(&'\n') { + rows.push((chars.len(), chars.len())); } } - self.edit_page(|p| *p = text); + if rows.is_empty() { + rows.push((0, 0)); + } + rows + } + /// GUI x of the caret and the row it sits on. + fn caret_on(&self, page: &str, rows: &[(usize, usize)], cursor: usize) -> (f32, usize) { + let chars: Vec = page.chars().collect(); + for (i, &(start, end)) in rows.iter().enumerate() { + if cursor <= end || i + 1 == rows.len() { + let take = cursor.saturating_sub(start).min(end.saturating_sub(start)); + let prefix: String = chars.iter().skip(start).take(take).collect(); + return (self.gui.atlas.font.width(&prefix), i); + } + } + (0.0, 0) + } + fn page_index_at(&self, page: &str, local_x: f32, local_y: f32) -> usize { + let rows = self.page_rows(page); + let line = (local_y / 9.0).floor().max(0.0) as usize; + let line = line.min(rows.len().saturating_sub(1)); + let (start, end) = rows[line]; + let chars: Vec = page.chars().collect(); + let slice: String = chars[start..end].iter().collect(); + start + self.gui.atlas.font.fit(&slice, local_x.max(0.0)) + } + /// A click on the centred title (`EditBox.onClick`). + fn book_title_click(&mut self, field_x: f32, mx: f32) { + let shift = self.has_shift_down(); + let Some(BookScreen::Edit { + title, title_edit, .. + }) = self.book.as_mut() + else { + return; + }; + let tx = field_x + ((114.0 - self.gui.atlas.font.width(title)) / 2.0).floor(); + let rel = (mx - tx).max(0.0); + let pos = self.gui.atlas.font.fit(title, rel); + title_edit.set_cursor(pos, shift); + } + /// A click on the open page. + fn book_page_click(&mut self, origin_x: f32, origin_y: f32, mx: f32, my: f32) { + let shift = self.has_shift_down(); + let text = match self.book.as_ref() { + Some(BookScreen::Edit { pages, page, .. }) => pages[*page].clone(), + _ => return, + }; + let pos = self.page_index_at(&text, mx - origin_x, my - origin_y); + if let Some(BookScreen::Edit { page_edit, .. }) = self.book.as_mut() { + page_edit.set_cursor(pos, shift); + } } /// The page buttons (`pageForward` adds a page while editing). fn turn_page(&mut self, forward: bool) { let mut lectern_page = None; match self.book.as_mut() { - Some(BookScreen::Edit { pages, page, .. }) => { + Some(BookScreen::Edit { + pages, + page, + page_edit, + .. + }) => { + let before = *page; if forward { if *page + 1 >= pages.len() && pages.len() < MAX_PAGES { pages.push(String::new()); @@ -405,6 +564,10 @@ impl Game<'_> { } else if *page > 0 { *page -= 1; } + if *page != before { + let text = pages[*page].clone(); + page_edit.set_value(&text); + } } Some(BookScreen::View { lectern: Some(key), .. @@ -764,6 +927,8 @@ impl Game<'_> { if let Some(BookScreen::Edit { signing, .. }) = self.book.as_mut() { *signing = false; } + } else if inside(left + 36.0, 50.0, 114.0, 9.0) { + self.book_title_click(left + 36.0, mx); } } Some(BookScreen::Edit { page, .. }) => { @@ -780,6 +945,8 @@ impl Game<'_> { } else if inside(w / 2.0 + 2.0, 196.0, 98.0, 20.0) { click(self); self.save_book(false); + } else if inside(left + 36.0, 32.0, 114.0, 14.0 * 9.0) { + self.book_page_click(left + 36.0, 32.0, mx, my); } } Some(BookScreen::View { @@ -865,7 +1032,7 @@ impl Game<'_> { BookScreen::Edit { signing: true, title, - opened, + title_edit, .. } => { let edit = tr("book.editTitle", "Enter Book Title:"); @@ -881,19 +1048,35 @@ impl Game<'_> { // The title box: an unbordered, centred EditBox of 114 with // black text and no shadow; the value alone is centred, the // cursor follows it. + let value = &title_edit.value; let x = left + 36.0; - let tx = x + ((114.0 - HudBatch::text_width(atlas, title)) / 2.0).floor(); - horizon_client::ui::append_field( - batch, - atlas, - title, - (tx, 50.0, x + 114.0 - tx), - (BLACK, false), - 15, - self.text_selection.covers(BOOK_TITLE, title), - true, - opened.elapsed().as_millis(), - ); + let tx = x + ((114.0 - HudBatch::text_width(atlas, value)) / 2.0).floor(); + batch.text(atlas, value, tx, 50.0, BLACK, false); + if title_edit.cursor != title_edit.highlight { + let (a, b) = ( + title_edit.cursor.min(title_edit.highlight), + title_edit.cursor.max(title_edit.highlight), + ); + let pre: String = value.chars().take(a).collect(); + let sel: String = value.chars().skip(a).take(b - a).collect(); + let sx = tx + HudBatch::text_width(atlas, &pre); + batch.text_highlight( + atlas, + (sx, 49.0, HudBatch::text_width(atlas, &sel), 11.0), + true, + ); + } + if title_edit.cursor_visible() { + let pre: String = value.chars().take(title_edit.cursor).collect(); + batch.fill( + atlas, + tx + HudBatch::text_width(atlas, &pre), + 49.0, + 1.0, + 9.0, + BLACK, + ); + } let by = tr("book.byAuthor", "by %1$s").replace("%1$s", super::chat::PLAYER_NAME); let tw = HudBatch::text_width(atlas, &by); batch.text( @@ -941,12 +1124,12 @@ impl Game<'_> { BookScreen::Edit { pages, page, - opened, + page_edit, .. } => { indicator(batch, *page, pages.len()); - let blink = (opened.elapsed().as_millis() / 300) % 2 == 0; - let lines = self.book_lines(&pages[*page]); + let text = &pages[*page]; + let lines = self.book_lines(text); for (i, line) in lines.iter().take(LINES).enumerate() { batch.text_styled( atlas, @@ -957,27 +1140,39 @@ impl Game<'_> { false, ); } - if blink { - // The cursor after the last character. - let last = lines - .last() - .map(|l| atlas.font.width_text(l)) - .unwrap_or(0.0); - let row = lines.len().saturating_sub(1) as f32 - + if pages[*page].ends_with('\n') { - 1.0 - } else { - 0.0 - }; - let x = if pages[*page].ends_with('\n') { - 0.0 - } else { - last - }; + let rows = self.page_rows(text); + let (sel_a, sel_b) = ( + page_edit.cursor.min(page_edit.highlight), + page_edit.cursor.max(page_edit.highlight), + ); + if sel_a != sel_b { + let chars: Vec = text.chars().collect(); + for (i, &(start, end)) in rows.iter().enumerate().take(LINES) { + let from = sel_a.max(start); + let to = sel_b.min(end); + if from >= to { + continue; + } + let pre: String = chars[start..from].iter().collect(); + let sel: String = chars[from..to].iter().collect(); + batch.text_highlight( + atlas, + ( + left + 36.0 + atlas.font.width(&pre), + top + 29.0 + i as f32 * 9.0, + atlas.font.width(&sel), + 9.0, + ), + true, + ); + } + } + if page_edit.cursor_visible() { + let (x, row) = self.caret_on(text, &rows, page_edit.cursor); batch.fill( atlas, left + 36.0 + x, - top + 29.0 + row * 9.0, + top + 29.0 + row as f32 * 9.0, 1.0, 9.0, BLACK, diff --git a/crates/horizon-client/src/game/chat.rs b/crates/horizon-client/src/game/chat.rs index de5bbf116..5b40adf9e 100644 --- a/crates/horizon-client/src/game/chat.rs +++ b/crates/horizon-client/src/game/chat.rs @@ -623,7 +623,10 @@ impl Game<'_> { return; } if let Some(command) = message.strip_prefix('/') { - self.run_command(command); + // A client mod's command first, then a server mod's, as on a server. + if !self.mod_command(command) && !self.local_server_mod_command(command) { + self.run_command(command); + } } else { let line = Text::translate( "chat.type.text", @@ -643,6 +646,7 @@ impl Game<'_> { self.mods_chat(&line); } self.lan_host_chat(message); + self.mod_player_chat(super::server_mods::Who::Local, message); } } pub(super) fn chat_scroll(&mut self, amount: f32) { diff --git a/crates/horizon-client/src/game/clipboard.rs b/crates/horizon-client/src/game/clipboard.rs index c87aa3681..6e81bf3ee 100644 --- a/crates/horizon-client/src/game/clipboard.rs +++ b/crates/horizon-client/src/game/clipboard.rs @@ -63,8 +63,8 @@ impl Game<'_> { } } } - /// Typing or a backspace in a field of the title screens: in the server - /// screens' append-only fields Select All's selection is replaced first. + /// Typing or a backspace in a title-screen field. A field that still only + /// appends replaces a Select All selection before the edit. pub(super) fn title_edit(&mut self, typed: Option<&str>, backspace: bool) { let Some(title) = self.title.as_mut() else { return; @@ -86,42 +86,31 @@ impl Game<'_> { } /// Shortcuts in the creative inventory's search box (an `EditBox` of 50). pub(super) fn creative_search_shortcut(&mut self, shortcut: EditShortcut) { - if Self::append_shortcut( - &mut self.text_selection, - &mut self.clipboard, - CREATIVE_SEARCH, - &mut self.creative_screen.search, - shortcut, - CREATIVE_SEARCH_CHARS, - ) { + if self + .creative_screen + .search + .shortcut(shortcut, &mut self.clipboard) + { self.creative_screen.scroll = 0.0; } } /// A backspace in the creative search box: with Ctrl, the whole word /// before the caret (`EditBox.deleteWords(-1)`), otherwise one character. - /// A Select All selection is what it deletes, as in `EditBox.keyPressed`. + /// A selection is what it deletes, as in `EditBox.keyPressed`. pub(super) fn creative_search_backspace(&mut self, ctrl: bool) { - let search = &mut self.creative_screen.search; - if !self.text_selection.take(CREATIVE_SEARCH, search) { - if ctrl { - horizon_client::ui::delete_words(search, -1); - } else { - search.pop(); - } - } + self.creative_screen + .search + .key(KeyCode::Backspace, ctrl, false); self.creative_screen.scroll = 0.0; } /// Typing in the creative search box. pub(super) fn creative_search_edit(&mut self, typed: Option<&str>) { - let search = &mut self.creative_screen.search; - self.text_selection.take(CREATIVE_SEARCH, search); if let Some(text) = typed { - clipboard::append_limited(search, text, CREATIVE_SEARCH_CHARS); + self.creative_screen.search.insert_text(text); + self.creative_screen.scroll = 0.0; } - self.creative_screen.scroll = 0.0; } } /// `CreativeModeInventoryScreen`'s search box: `setMaxLength(50)`. pub(super) const CREATIVE_SEARCH_CHARS: usize = 50; -pub(super) const CREATIVE_SEARCH: horizon_client::clipboard::FieldId = ("creative.search", 0); diff --git a/crates/horizon-client/src/game/commands.rs b/crates/horizon-client/src/game/commands.rs index f3afdcab6..dbe5d0ada 100644 --- a/crates/horizon-client/src/game/commands.rs +++ b/crates/horizon-client/src/game/commands.rs @@ -85,16 +85,16 @@ fn format_double(v: f64) -> String { impl Game<'_> { /// Commands.performCommand for a line without its slash. - pub(super) fn run_command(&mut self, command: &str) { + pub(super) fn run_command(&mut self, command: &str) -> bool { if self.mod_command(command) { - return; + return true; } let d = vanilla::game_dispatcher(); let parse = d.parse(command, &self.ui.registries); let result = match parse.executable() { Err(e) => { self.syntax_failure(&e, command); - return; + return false; } Ok((ctx, _)) => { let ctx = ctx.clone(); @@ -103,6 +103,7 @@ impl Game<'_> { self.run_chain(&root, &ctx) } }; + let ok = result.is_ok(); if let Err(e) = result { if e.input.is_some() { self.syntax_failure(&e, command); @@ -114,6 +115,20 @@ impl Game<'_> { if self.player.is_some() { self.check_inventory_trigger(); } + ok + } + /// `run_command` with its output suppressed + /// (`CommandSourceStack.withSuppressedOutput`): the player's own source, + /// rights and checks, no feedback and no failure in the chat. + pub(super) fn run_command_quietly(&mut self, command: &str) -> bool { + let quiet = execute::Source { + silent: true, + ..self.player_source() + }; + let outer = self.command_source.replace(quiet); + let ok = self.run_command(command); + self.command_source = outer; + ok } fn syntax_failure(&mut self, e: &CommandError, command: &str) { self.command_failure(e.message.clone()); diff --git a/crates/horizon-client/src/game/creatures.rs b/crates/horizon-client/src/game/creatures.rs index 194256040..ce97fcd52 100644 --- a/crates/horizon-client/src/game/creatures.rs +++ b/crates/horizon-client/src/game/creatures.rs @@ -50,9 +50,9 @@ pub(super) struct Creatures { /// The wandering trader spawner's clock. pub trader: super::wandering_trader::Spawner, } -struct ProjWorld<'a, 'w> { - w: &'a MobWorld<'w>, - targets: Vec<(Who, Aabb)>, +pub(super) struct ProjWorld<'a, 'w> { + pub w: &'a MobWorld<'w>, + pub targets: Vec<(Who, Aabb)>, } impl ProjectileWorld for ProjWorld<'_, '_> { fn clip(&self, from: Vec3, to: Vec3) -> Option<(Vec3, [i32; 3], [i32; 3])> { diff --git a/crates/horizon-client/src/game/cushions.rs b/crates/horizon-client/src/game/cushions.rs new file mode 100644 index 000000000..0847321d6 --- /dev/null +++ b/crates/horizon-client/src/game/cushions.rs @@ -0,0 +1,494 @@ +//! Cushions: `CushionItem.useOn` placement on the top face of a block, +//! `Cushion.canBePlacedAt`/`survives`, `Cushion.interact` (sit), +//! `BlockAttachedEntity.hurtServer` (break, dropping the matching colour), +//! `BlockAttachedEntity.tick` and `CushionRenderer`. +//! +//! A cushion is a `BlockAttachedEntity`, not a block: it has no block state, +//! only an entity whose `Pos` is the click point's height. Placement uses +//! outline bounds, collision shapes and suffocation predicates. +use super::{Game, Hit, view_vector}; +use horizon_client::entities::{Cushion, dye_index}; +use horizon_client::items::ItemStack; +use horizon_client::mobs::anim::Poses; +use horizon_core::geometry::{Aabb, Vec3}; +use winit::keyboard::KeyCode; + +/// `Direction.fromYRot(yaw).toYRot()`: the nearest 90 degree step. +pub(crate) fn snap_yaw(yaw: f32) -> f32 { + (((f64::from(yaw) / 90.0 + 0.5).floor() as i64) & 3) as f32 * 90.0 +} + +fn aabb(bounds: ([f64; 3], [f64; 3])) -> Aabb { + Aabb::new( + Vec3::new(bounds.0[0], bounds.0[1], bounds.0[2]), + Vec3::new(bounds.1[0], bounds.1[1], bounds.1[2]), + ) +} + +fn overlaps(a: Aabb, b: Aabb) -> bool { + a.intersects(b) +} +use horizon_client::cushion::blocks_in; + +struct PlacementWorld<'a, 'r>(&'a Game<'r>); +impl horizon_client::cushion::World for PlacementWorld<'_, '_> { + fn outline_bounds(&self, p: [i32; 3]) -> Option { + let boxes = self.0.outline_boxes(p); + let mut shape = *boxes.first()?; + for b in &boxes[1..] { + for k in 0..3 { + shape[k] = shape[k].min(b[k]); + shape[k + 3] = shape[k + 3].max(b[k + 3]); + } + } + Some(Aabb::new( + Vec3::new(shape[0], shape[1], shape[2]), + Vec3::new(shape[3], shape[4], shape[5]), + )) + } + + fn collision_shapes(&self, bounds: Aabb) -> Vec { + let binding = self.0.res.collision(); + let mut world = horizon_client::collisions::SceneCollisions { + world: &self.0.world, + binding, + subject: None, + }; + // Include neighbour blocks whose collision shape can reach outside their cell. + blocks_in(bounds.inflate(Vec3::new(1.0, 1.0, 1.0))) + .filter_map(|p| { + let state = self.0.world.block(p[0], p[1], p[2]); + binding + .collision_shape(&mut world, state, p) + .ok() + .map(|s| s.moved(Vec3::new(f64::from(p[0]), f64::from(p[1]), f64::from(p[2])))) + }) + .collect() + } + fn suffocating(&self, p: [i32; 3]) -> bool { + let state = self.0.world.block(p[0], p[1], p[2]); + let facts = self.0.res.facts().get(state); + let name = facts.name.as_ref(); + // Blocks' explicit predicates, then the default causes_suffocation/full-shape rule. + match name { + "minecraft:dirt_path" + | "minecraft:farmland" + | "minecraft:mud" + | "minecraft:soul_sand" => true, + "minecraft:piston" | "minecraft:sticky_piston" => self + .0 + .pack + .assets + .registry + .state(state) + .is_some_and(|s| s.properties.get("extended").is_some_and(|p| p == "false")), + "minecraft:mangrove_roots" | "minecraft:moving_piston" => false, + _ if name.ends_with("_leaves") + || name.ends_with("glass") + || name.ends_with("copper_grate") => + { + false + } + // ShulkerBoxBlock: suffocating while closed; a box seen open + // here is rare enough to count as closed. + _ if name.ends_with("shulker_box") => true, + _ => { + facts.full_collision + && self + .0 + .res + .items() + .block_in_tag("minecraft:causes_suffocation", name) + } + } + } +} + +impl Game<'_> { + /// The cushion under the crosshair, its distance and the hit point. + pub(super) fn cushion_hit(&self) -> Option<(usize, f64, [f64; 3])> { + let eye = self.eye_position()?; + let dir = view_vector(self.yaw, self.pitch); + let reach: f64 = if self.creative { 5.0 } else { 3.0 }; + let mut best: Option<(usize, f64, [f64; 3])> = None; + for (i, c) in self.cushions.iter().enumerate() { + let Some(d) = super::ray_box(eye, dir, reach, aabb(c.bounds())) else { + continue; + }; + if best.is_none_or(|b| d < b.1) { + best = Some((i, d, std::array::from_fn(|k| eye[k] + dir[k] * d))); + } + } + best + } + + pub(super) fn cushion_survives(&self, c: &Cushion) -> bool { + horizon_client::cushion::survives(&PlacementWorld(self), aabb(c.bounds())) + } + + /// `Cushion.destroyIfInFire`: a fire-tagged block inside the deflated box. + fn cushion_in_fire(&self, c: &Cushion) -> bool { + let bounds = aabb(c.bounds()).next_deflated(); + blocks_in(bounds).any(|p| { + let facts = self.res.facts().get(self.world.block(p[0], p[1], p[2])); + self.res.items().block_in_tag("minecraft:fire", &facts.name) + }) + } + + /// `CushionItem.useOn`: on the top face only, spawning at the click's + /// height above the clicked block (or the replaceable block itself). + pub(super) fn place_cushion(&mut self, hit: &Hit, stack: &ItemStack) -> bool { + let Some(info) = self.res.items().get(&stack.item).cloned() else { + return false; + }; + let Some(default_color) = info.cushion_color.as_deref() else { + return false; + }; + let color_override = stack + .data() + .and_then(|d| d.other("minecraft:cushion/color")) + .and_then(|tag| match tag { + horizon_world::nbt::Tag::String(s) => Some(s.to_string_lossy()), + _ => None, + }); + let color = dye_index(color_override.as_deref().unwrap_or(default_color)); + // CushionItem.recalculateContextForSpecialCollisionShapes: open containers + // (cauldrons, hoppers and composters) use the collision ray's actual height. + let mut adjusted = Hit { + pos: hit.pos, + face: hit.face, + point: hit.point, + }; + let state = self.world.block(hit.pos[0], hit.pos[1], hit.pos[2]); + if self.res.items().block_in_tag( + "minecraft:cushion_uses_collision_shape", + &self.res.facts().get(state).name, + ) && let Some(eye) = self.eye_position() + { + let start = Vec3::new(eye[0], eye[1], eye[2]); + let point = Vec3::new(hit.point[0], hit.point[1], hit.point[2]); + let end = point.add_vector(point.subtract(start).normalize().scale(0.001)); + let binding = self.res.collision(); + let mut world = horizon_client::collisions::SceneCollisions { + world: &self.world, + binding, + subject: None, + }; + if let Ok(shape) = binding.collision_shape(&mut world, state, hit.pos) + && let Some(result) = shape.clip( + start, + end, + horizon_core::position::BlockPos::new(hit.pos[0], hit.pos[1], hit.pos[2]), + ) + { + adjusted.face = result.direction.normal(); + adjusted.point = [result.location.x, result.location.y, result.location.z]; + } + } + let hit = &adjusted; + if hit.face != [0, 1, 0] { + return false; + } + // BlockPlaceContext: a replaceable clicked block is replaced. + let clicked = self + .res + .facts() + .get(self.world.block(hit.pos[0], hit.pos[1], hit.pos[2])); + let pos = if clicked.replaceable { + hit.pos + } else { + std::array::from_fn(|i| hit.pos[i] + hit.face[i]) + }; + // `Vec3.atCenterOfWithY(clickedPos, clickLocation.y)`. + let y = hit.point[1]; + let position = Vec3::new(f64::from(pos[0]) + 0.5, y, f64::from(pos[2]) + 0.5); + let bounds = aabb(( + [position.x - 0.5, position.y, position.z - 0.5], + [position.x + 0.5, position.y + 0.25, position.z + 0.5], + )); + if !horizon_client::cushion::can_place(&PlacementWorld(self), bounds) { + return false; + } + // `getEntitiesOfClass(Cushion.class, spawnAABB).isEmpty()`. + if self + .cushions + .iter() + .any(|c| overlaps(aabb(c.bounds()), bounds)) + { + return false; + } + self.next_entity += 1; + let id = self.next_entity; + // `BlockAttachedEntity.setPos`: `BlockPos.containing(position)`. + let attached = [ + position.x.floor() as i32, + position.y.floor() as i32, + position.z.floor() as i32, + ]; + self.cushions.push(Cushion { + id, + position, + pos: attached, + yaw: snap_yaw(self.yaw), + color, + check_interval: 0, + }); + self.world + .modified + .insert((attached[0] >> 4, attached[2] >> 4)); + // `destroyIfInFire`: placed into fire, it breaks at once. + let placed = self.cushions.len() - 1; + if self.cushion_in_fire(&self.cushions[placed]) { + self.break_cushion(placed, false); + } + self.audio.play( + "minecraft:entity.cushion.place", + Some([position.x, position.y, position.z]), + 0.75, + 0.8, + ); + let ctx = self.who_context(Some(horizon_client::mobs::Who::Player), None); + self.post_game_event( + "minecraft:entity_place", + [position.x, position.y, position.z], + ctx, + ); + if !self.creative { + self.consume_held(); + } + true + } + + /// `Cushion.interact`: sit down unless sneaking or already occupied. + pub(super) fn interact_cushion(&mut self) -> bool { + let Some((i, d, _)) = self.cushion_hit() else { + return false; + }; + if !self.before_block(d) { + return false; + } + // isSecondaryUseActive. + if self.keys.contains(&KeyCode::ShiftLeft) { + return false; + } + let id = self.cushions[i].id; + let occupied = self.riding == Some(id) + || self + .lan + .as_ref() + .is_some_and(|h| h.hub.guests.iter().any(|g| g.vehicle == Some(id))); + // `Cushion.interact`: an occupied cushion (`isVehicle`) passes. + if occupied { + return false; + } + // `Player.startRiding` gives up the vehicle it already has; the + // client never sends that click, so pass instead. + if self.riding.is_some() { + return false; + } + self.riding = Some(id); + let p = self.cushions[i].position; + self.audio.play( + "minecraft:entity.cushion.sit", + Some([p.x, p.y, p.z]), + 1.0, + 1.0, + ); + self.swing_arm(); + true + } + + /// `Cushion.hurtServer` from a player: killed, then the item dropped. + pub(super) fn attack_cushion(&mut self) -> bool { + let Some((i, d, _)) = self.cushion_hit() else { + return false; + }; + if !self.before_block(d) || self.mob_hit().is_some_and(|m| m.1 < d) { + return false; + } + // `skipAttackInteraction` when `mayInteract` is false. + if !self.may_build() { + return true; + } + self.break_cushion(i, true); + true + } + + /// `Cushion.dropItem`: the break sound and particles, then the coloured + /// item unless drops are off or the breaker has infinite materials. + pub(super) fn break_cushion(&mut self, index: usize, by_player: bool) { + let c = self.cushions.remove(index); + let p = c.position; + self.world.modified.insert((c.pos[0] >> 4, c.pos[2] >> 4)); + if self.riding == Some(c.id) { + self.riding = None; + } + self.audio.play( + "minecraft:entity.cushion.break", + Some([p.x, p.y, p.z]), + 1.0, + 1.0, + ); + self.cushion_break_particles(&c); + if !self.ui.rules.bool("entity_drops") || (by_player && self.creative) { + return; + } + let stack = ItemStack { + item: std::sync::Arc::from(c.item()), + count: 1, + damage: 0, + extra: None, + }; + self.spawn_item(stack, [p.x, p.y, p.z], [0.0; 3], 10); + } + + /// `Cushion.showBreakingParticles`: ten of the matching wool block. + fn cushion_break_particles(&mut self, c: &Cushion) { + let name = format!("minecraft:{}_wool", c.color_name()); + let Some(state) = self.pack.assets.registry.default_state(&name) else { + return; + }; + let at = [ + c.position.x.floor() as i32, + c.position.y.floor() as i32, + c.position.z.floor() as i32, + ]; + let Some((sprite, tint)) = self.particle_sprite(state, at) else { + return; + }; + let options = horizon_client::particles::ParticleOptions::block( + horizon_client::particles::ParticleType::Block, + sprite, + tint, + ); + let p = c.position; + self.particles.send_particles( + &options, + [p.x, p.y + 0.666_666_7, p.z], + [0.25, 0.0625, 0.25], + 0.05, + 10, + ); + } + + /// `BlockAttachedEntity.tick`: survive and burn checks after the post-increment reaches 100. + pub(super) fn tick_cushions(&mut self) { + let ticking = self.entity_ticking_area(); + let mut i = 0; + while i < self.cushions.len() { + let p = self.cushions[i].position; + if !ticking(p.x.floor() as i32, p.z.floor() as i32) { + i += 1; + continue; + } + let previous = self.cushions[i].check_interval; + self.cushions[i].check_interval += 1; + if previous < 100 { + i += 1; + continue; + } + self.cushions[i].check_interval = 0; + let c = self.cushions[i].clone(); + if self.cushion_in_fire(&c) || !self.cushion_survives(&c) { + self.break_cushion(i, false); + continue; + } + i += 1; + } + } + + /// `Player.rideTick` on a cushion: hold the seat, and get up on sneak. + pub(super) fn tick_cushion_riding(&mut self, keys: super::Keys) -> bool { + let Some(c) = self + .cushions + .iter() + .find(|c| Some(c.id) == self.riding) + .cloned() + else { + return false; + }; + if keys.shift { + let at = c.dismount(); + self.riding = None; + if let Some(p) = self.player.as_mut() { + self.previous_position = p.position; + p.position = at; + p.velocity = Vec3::ZERO; + p.fall_distance = 0.0; + } + // `Cushion.removePassenger`: the get-up sound for a rider that + // left rather than one whose cushion was killed. + self.audio.play( + "minecraft:entity.cushion.get_up", + Some([c.position.x, c.position.y, c.position.z]), + 1.0, + 1.0, + ); + return true; + } + let seat = c.seat(); + if let Some(p) = self.player.as_mut() { + self.previous_position = p.position; + p.position = seat; + p.velocity = Vec3::ZERO; + p.fall_distance = 0.0; + } + true + } + + /// `CushionRenderer`: the coloured model, rotated to the nearest + /// direction, with its bottom on the cushion's position. + pub(super) fn cushion_geometry( + &self, + camera: glam::DVec3, + out: &mut Vec, + ) { + let Some(model) = self.cushion_model.as_ref() else { + return; + }; + let sprites = &self.gui.atlas.sprites; + for c in &self.cushions { + let entity_start = out.len(); + let a = aabb(c.bounds()); + let (lo, hi) = (a.min_position(), a.max_position()); + let (lo, hi) = ( + glam::DVec3::new(lo.x, lo.y, lo.z), + glam::DVec3::new(hi.x, hi.y, hi.z), + ); + let range = + super::entity_culling::default_range(hi - lo, self.settings.entity_distance); + if !self.entity_in_view(camera, (lo + hi) / 2.0, range, lo, hi) { + continue; + } + let Some(uv) = sprites + .get(&format!("entity/cushion/{}_cushion", c.color_name())) + .map(|r| [r.u0, r.v0, r.u1, r.v1]) + else { + continue; + }; + let p = glam::DVec3::new(c.position.x, c.position.y, c.position.z) - camera; + let base = glam::Mat4::from_translation(p.as_vec3()) + * glam::Mat4::from_rotation_y((180.0 - snap_yaw(c.yaw)).to_radians()) + * glam::Mat4::from_rotation_x(std::f32::consts::PI) + * glam::Mat4::from_translation(glam::Vec3::new(0.0, -0.25, 0.0)); + // `EntityRenderer.getPackedLightCoords` probes at the eye height. + let l = self.world.light( + c.position.x.floor() as i32, + (c.position.y + 0.2125).floor() as i32, + c.position.z.floor() as i32, + ); + let packed = (u32::from(l >> 4) * 16) | ((u32::from(l & 15) * 16) << 8); + horizon_client::mobs::render::draw( + model, + base, + &Poses::new(model), + uv, + 0xFFFF_FFFF, + packed, + 0, + out, + ); + self.cull_entity_vertices(out, entity_start); + } + } +} diff --git a/crates/horizon-client/src/game/dragon.rs b/crates/horizon-client/src/game/dragon.rs index f28049fd5..e33064531 100644 --- a/crates/horizon-client/src/game/dragon.rs +++ b/crates/horizon-client/src/game/dragon.rs @@ -18,6 +18,7 @@ use horizon_core::{ geometry::{Aabb, Vec3}, random::{LegacyRandom, RandomSource}, }; +use horizon_protocol::entity_data::Value; use horizon_world::nbt::Tag; /// Mob ids from here on are dragon parts (`SPECIAL + part`) and crystals @@ -1692,25 +1693,8 @@ impl Game<'_> { } if d.random.next_int_bound(10).unwrap_or(1) == 0 { let p = d.position; - d.nearest_crystal = self - .crystals - .iter() - .enumerate() - .filter(|(_, c)| { - (c.position.x - p.x).abs() <= 32.0 - && (c.position.y - p.y).abs() <= 32.0 - && (c.position.z - p.z).abs() <= 32.0 - }) - .min_by(|a, b| { - let da = (a.1.position.x - p.x).powi(2) - + (a.1.position.y - p.y).powi(2) - + (a.1.position.z - p.z).powi(2); - let db = (b.1.position.x - p.x).powi(2) - + (b.1.position.y - p.y).powi(2) - + (b.1.position.z - p.z).powi(2); - da.total_cmp(&db) - }) - .map(|(i, _)| i); + let nearest = self.nearest_crystal_to(p); + self.dragon.as_mut().expect("dragon").nearest_crystal = nearest; } let d = self.dragon.as_mut().expect("dragon"); d.yaw = wrap(d.yaw); @@ -3143,6 +3127,204 @@ impl Game<'_> { let _ = self.activate_exit_portal(); self.fight.dirty = true; } + /// `EnderDragon.checkCrystals`' search: the nearest crystal within 32 + /// blocks on each axis. + fn nearest_crystal_to(&self, p: Vec3) -> Option { + self.crystals + .iter() + .enumerate() + .filter(|(_, c)| { + (c.position.x - p.x).abs() <= 32.0 + && (c.position.y - p.y).abs() <= 32.0 + && (c.position.z - p.z).abs() <= 32.0 + }) + .min_by(|a, b| { + let da = (a.1.position.x - p.x).powi(2) + + (a.1.position.y - p.y).powi(2) + + (a.1.position.z - p.z).powi(2); + let db = (b.1.position.x - p.x).powi(2) + + (b.1.position.y - p.y).powi(2) + + (b.1.position.z - p.z).powi(2); + da.total_cmp(&db) + }) + .map(|(i, _)| i) + } +} + +/// The dragon on a server's client (`ClientPacketListener.handleAddEntity` +/// and the client side of `EnderDragon.aiStep`): the server flies it and +/// sends its moves, health and phase; the client flaps its wings, keeps +/// its flight history and places its parts, so it can be drawn and hit. +impl Game<'_> { + /// `handleAddEntity` for `minecraft:ender_dragon`. Its constructor + /// sets the full health and the hovering phase until the server's + /// synched data says otherwise. + pub(super) fn spawn_remote_dragon(&mut self, id: i32, position: [f64; 3], yaw: f32) { + let at = Vec3::new(position[0], position[1], position[2]); + let mut d = Dragon::new(at, yaw, i64::from(id)); + d.id = id as u32; + d.phase = Phase::from_id(10); + self.dragon = Some(d); + self.place_dragon_parts(); + if let Some(d) = self.dragon.as_mut() { + for part in &mut d.parts { + part.1 = part.0; + } + } + } + /// The remote dragon, if `id` is it. + fn remote_dragon_mut(&mut self, id: i32) -> Option<&mut Dragon> { + self.dragon.as_mut().filter(|d| d.id as i32 == id) + } + /// `handleSetEntityData`: LivingEntity.DATA_HEALTH_ID and + /// EnderDragon.DATA_PHASE (`onSyncedDataUpdated` sets the phase). + pub(super) fn remote_dragon_data(&mut self, id: i32, values: &[(u8, i32, Value)]) { + let Some(d) = self.remote_dragon_mut(id) else { + return; + }; + for (index, _, value) in values { + match (index, value) { + (9, Value::Float(health)) => d.health = *health, + (16, Value::Int(phase)) => d.set_phase(Phase::from_id(*phase)), + _ => {} + } + } + } + /// `handleSetEntityMotion`: the velocity its wings flap by. + pub(super) fn remote_dragon_motion(&mut self, id: i32, velocity: [f64; 3]) { + if let Some(d) = self.remote_dragon_mut(id) { + d.velocity = Vec3::new(velocity[0], velocity[1], velocity[2]); + } + } + /// `handleHurtAnimation` and `handleDamageEvent`: the red flash. + pub(super) fn remote_dragon_hurt(&mut self, id: i32) { + if let Some(d) = self.remote_dragon_mut(id) { + d.hurt_time = 10; + } + } + /// `handleRemoveEntities`, or a crystal removed: the healing beam + /// keeps pointing at the same crystal. + pub(super) fn remove_remote_dragon(&mut self, id: i32) { + if self.remote_dragon_mut(id).is_some() { + self.dragon = None; + return; + } + let Some(index) = self.crystals.iter().position(|c| c.id as i32 == id) else { + return; + }; + if let Some(d) = self.dragon.as_mut() { + match d.nearest_crystal { + Some(n) if n == index => d.nearest_crystal = None, + Some(n) if n > index => d.nearest_crystal = Some(n - 1), + _ => {} + } + } + } + /// One client tick of the dragon. `lerp`: the step toward its last + /// sent position and yaw (LivingEntity's interpolation), and the + /// steps left including this one. + pub(super) fn tick_remote_dragon(&mut self, lerp: Option<([f64; 3], Option, u32)>) { + let Some(d) = self.dragon.as_mut() else { + return; + }; + d.previous = d.position; + d.previous_yaw = d.yaw; + d.old_flap = d.flap; + d.ticks += 1; + d.hurt_time = (d.hurt_time - 1).max(0); + for part in &mut d.parts { + part.1 = part.0; + } + if let Some((target, yaw, steps)) = lerp { + let n = f64::from(steps.max(1)); + d.position = Vec3::new( + d.position.x + (target[0] - d.position.x) / n, + d.position.y + (target[1] - d.position.y) / n, + d.position.z + (target[2] - d.position.z) / n, + ); + if let Some(yaw) = yaw { + d.yaw += wrap(yaw - d.yaw) / steps.max(1) as f32; + } + } + if !d.alive() { + // EnderDragon.tickDeath on a client: it rises, and bursts + // from tick 180 to 200; the server removes it. + d.death_time += 1; + let (t, p) = (d.death_time, d.position); + if (180..=200).contains(&t) { + let r = &mut d.random; + let o = [ + f64::from((r.next_float() - 0.5) * 8.0), + f64::from((r.next_float() - 0.5) * 4.0), + f64::from((r.next_float() - 0.5) * 8.0), + ]; + self.particles.add( + &ParticleOptions::simple(ParticleType::ExplosionEmitter), + [p.x + o[0], p.y + 2.0 + o[1], p.z + o[2]], + [0.0; 3], + ); + } + if let Some(d) = self.dragon.as_mut() { + d.position.y += 0.1; + for part in &mut d.parts { + part.0.y += 0.1; + } + } + return; + } + // processFlappingMovement and onFlap: its wing beats, and their sound. + let flap_was = (d.old_flap * std::f32::consts::TAU).cos(); + let v = d.velocity; + let mut flap_speed = 0.2 / ((v.x.hypot(v.z) as f32) * 10.0 + 1.0); + flap_speed *= 2f32.powf(v.y as f32); + d.flap += if d.phase.sitting() { 0.1 } else { flap_speed }; + let flap_now = (d.flap * std::f32::consts::TAU).cos(); + let at = [d.position.x, d.position.y, d.position.z]; + if flap_was <= -0.3 && flap_now >= -0.3 { + let pitch = 0.8 + self.world.random.next_float() * 0.3; + self.audio + .play("minecraft:entity.ender_dragon.flap", Some(at), 5.0, pitch); + } + let d = self.dragon.as_mut().expect("dragon"); + if !d.phase.sitting() { + d.growl -= 1; + if d.growl < 0 { + d.growl = 200 + d.random.next_int_bound(200).unwrap_or(0); + let pitch = 0.8 + self.world.random.next_float() * 0.3; + self.audio + .play("minecraft:entity.ender_dragon.growl", Some(at), 2.5, pitch); + } + } + // checkCrystals' search runs on a client too (the healing beam). + let d = self.dragon.as_mut().expect("dragon"); + if d.random.next_int_bound(10).unwrap_or(1) == 0 { + let p = d.position; + let nearest = self.nearest_crystal_to(p); + self.dragon.as_mut().expect("dragon").nearest_crystal = nearest; + } + let d = self.dragon.as_mut().expect("dragon"); + d.yaw = wrap(d.yaw); + d.record(); + self.place_dragon_parts(); + } + /// The dragon's parts as a server's client attacks them: the server's + /// ids for `EnderDragonPart`s follow the dragon's. + pub(super) fn remote_dragon_part_hit( + &self, + eye: [f64; 3], + dir: [f64; 3], + reach: f64, + ) -> Option<(i32, f64, [f64; 3])> { + let d = self.dragon.as_ref().filter(|d| d.alive() && d.id != 0)?; + (0..8) + .filter_map(|i| { + let b = d.part_box(i); + let p = d.parts[i].0; + super::ray_box(eye, dir, reach, b) + .map(|t| ((d.id + 1 + i as u32) as i32, t, [p.x, p.y, p.z])) + }) + .min_by(|a, b| a.1.total_cmp(&b.1)) + } } #[cfg(test)] diff --git a/crates/horizon-client/src/game/end.rs b/crates/horizon-client/src/game/end.rs index 904c035c5..32d5113b0 100644 --- a/crates/horizon-client/src/game/end.rs +++ b/crates/horizon-client/src/game/end.rs @@ -129,15 +129,32 @@ impl EndState { survive: false, }); } - /// One tick of a server's client: `step` moves each toward where the - /// server put it. - pub(super) fn step_remote_eyes(&mut self, mut step: impl FnMut(u32, [f64; 3]) -> [f64; 3]) { + /// `EyeOfEnder.tick` on a server's client: it moves by its last known + /// motion; only the server steers it. + pub(super) fn step_remote_eyes(&mut self) { for e in &mut self.eyes { e.previous = e.position; e.life += 1; - e.position = glam::DVec3::from_array(step(e.id, e.position.to_array())); + e.position += e.velocity; } } + /// A server's move: an eye has no interpolation handler, so + /// `moveOrInterpolateTo` puts it there at once. False when `id` isn't one. + pub(super) fn move_remote_eye(&mut self, id: u32, at: [f64; 3]) -> bool { + let Some(e) = self.eyes.iter_mut().find(|e| e.id == id) else { + return false; + }; + e.position = glam::DVec3::from_array(at); + true + } + /// `handleSetEntityMotion` for an eye. False when `id` isn't one. + pub(super) fn remote_eye_motion(&mut self, id: u32, velocity: [f64; 3]) -> bool { + let Some(e) = self.eyes.iter_mut().find(|e| e.id == id) else { + return false; + }; + e.velocity = glam::DVec3::from_array(velocity); + true + } pub(super) fn remove_remote_eye(&mut self, id: u32) { self.eyes.retain(|e| e.id != id); } @@ -1099,6 +1116,7 @@ impl Game<'_> { /// EyeOfEnder.tick: fly, then drop (4 in 5) or shatter after 80 ticks. fn tick_eyes(&mut self) { let mut eyes = std::mem::take(&mut self.end.eyes); + let mut shattered = Vec::new(); eyes.retain_mut(|eye| { eye.previous = eye.position; let next = eye.position + eye.velocity; @@ -1122,10 +1140,44 @@ impl Game<'_> { extra: None, }; self.spawn_item(stack, at, [vx, 0.2, vz], 0); + } else { + shattered.push(at.map(|v| v.floor() as i32)); } false }); self.end.eyes = eyes; + for pos in shattered { + self.level_event_at(2003, pos, 0); + } + } + + /// `LevelEventHandler` 2003: a shattered eye's item crumbs and two rings + /// of portal particles drawn in towards it. + pub(super) fn eye_break_particles(&mut self, pos: [i32; 3]) { + let (x, y, z) = ( + f64::from(pos[0]) + 0.5, + f64::from(pos[1]), + f64::from(pos[2]) + 0.5, + ); + let crumbs = self.item_particle(&ItemStack::new("minecraft:ender_eye", 1)); + for _ in 0..8 { + let r = self.particles.random(); + let v = [ + r.next_gaussian() * 0.15, + r.next_double() * 0.2, + r.next_gaussian() * 0.15, + ]; + self.particles.add(&crumbs, [x, y, z], v); + } + let portal = ParticleOptions::simple(ParticleType::Portal); + let mut angle = 0.0f64; + while angle < std::f64::consts::PI * 2.0 { + let (c, s) = (angle.cos(), angle.sin()); + let at = [x + c * 5.0, y - 0.4, z + s * 5.0]; + self.particles.add(&portal, at, [c * -5.0, 0.0, s * -5.0]); + self.particles.add(&portal, at, [c * -7.0, 0.0, s * -7.0]); + angle += std::f64::consts::PI / 20.0; + } } /// `EyeOfEnder.tick` on a client: behind each eye (a quarter of its last diff --git a/crates/horizon-client/src/game/fireworks.rs b/crates/horizon-client/src/game/fireworks.rs index e6b4eb136..fd160a920 100644 --- a/crates/horizon-client/src/game/fireworks.rs +++ b/crates/horizon-client/src/game/fireworks.rs @@ -17,6 +17,8 @@ use horizon_core::{ random::RandomSource, }; +pub(super) const FIREWORK_EXPLODE_EVENT: i8 = 17; + pub(super) struct Rocket { /// The entity id a server tracks it by (0 until it is tracked). pub id: u32, @@ -261,6 +263,14 @@ impl Game<'_> { /// `FireworkRocketEntity.explode` and `dealExplosionDamage`. fn explode_rocket(&mut self, r: &Rocket) { let at = [r.position.x, r.position.y, r.position.z]; + // FireworkRocketEntity.explode broadcasts before discard. Send now: + // tick_lan removes missing tracked entities before flushing effects. + if r.id != 0 + && let Some(host) = &self.lan + { + host.hub + .entity_event(r.id as i32, FIREWORK_EXPLODE_EVENT, at); + } if !r.explosions.is_empty() { let damage = 5.0 + r.explosions.len() as f32 * 2.0; let from = r.position; @@ -322,6 +332,16 @@ impl Game<'_> { self.particles .fireworks(at, v, r.explosions.clone(), camera); } + /// FireworkRocketEntity.handleEntityEvent: use the synchronized item data. + pub(super) fn remote_firework_explosion(&mut self, id: i32) { + let camera = self.eye_position(); + if let Some(r) = self.rockets.iter().find(|r| r.id == id as u32) { + let at = [r.position.x, r.position.y, r.position.z]; + let v = [r.velocity.x, r.velocity.y, r.velocity.z]; + self.particles + .fireworks(at, v, r.explosions.clone(), camera.unwrap_or(at)); + } + } /// `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). diff --git a/crates/horizon-client/src/game/hand.rs b/crates/horizon-client/src/game/hand.rs index a7218ff3c..d91d3b979 100644 --- a/crates/horizon-client/src/game/hand.rs +++ b/crates/horizon-client/src/game/hand.rs @@ -151,6 +151,7 @@ impl Game<'_> { before(self.painting_hit().map(|h| h.1)) || before(self.frame_hit().map(|h| h.1)) || before(self.armor_stand_hit().map(|h| h.1)) + || before(self.cushion_hit().map(|h| h.1)) || before(self.boat_hit().map(|h| h.1)) || before(self.cart_hit().map(|h| h.1)) || before(self.dragon_hit().map(|h| h.1)) diff --git a/crates/horizon-client/src/game/integrated.rs b/crates/horizon-client/src/game/integrated.rs index 14a18caa6..dd1c04e23 100644 --- a/crates/horizon-client/src/game/integrated.rs +++ b/crates/horizon-client/src/game/integrated.rs @@ -222,7 +222,6 @@ impl Game<'_> { options.report = None; options.server = None; options.world = None; - options.dev_mods.clear(); self.join_world_rest()?; let (res, pack, settings) = (self.res.clone(), self.pack.clone(), self.settings.clone()); let flags = Arc::new(Flags::default()); @@ -292,6 +291,9 @@ impl Game<'_> { launch.create.as_ref(), )?)?; let saved = Box::new(self.level.clone()); + // IntegratedServer runs the server mods; the window the client mods. + self.mods.dev = self.options.dev_mods.clone(); + self.start_mods(); // Math.max(2, options.renderDistance): past vanilla's 32 when the // window's render distance is (Horizon's options go to 64). let view_distance = self.settings.render_distance.max(2); diff --git a/crates/horizon-client/src/game/lan.rs b/crates/horizon-client/src/game/lan.rs index 79807fc92..9f468db9f 100644 --- a/crates/horizon-client/src/game/lan.rs +++ b/crates/horizon-client/src/game/lan.rs @@ -71,6 +71,8 @@ pub(super) struct LanHost { /// Guests' commands waiting for the hub to be back in `self.lan`, where /// a command can reach every player (game/lan_actions.rs). pub commands: Vec, + /// Mods' quiet commands waiting to run a few a tick (game/lan_quiet.rs). + pub quiet: std::collections::VecDeque, /// The entities the guests track, described again every tick /// (`lan_entities`) over last tick's states. states: lan::entity::States, @@ -603,6 +605,7 @@ impl Game<'_> { waypoint_dead: Default::default(), border_sent: None, commands: Vec::new(), + quiet: std::collections::VecDeque::new(), states: Default::default(), }); self.audio.capture = Some(Vec::new()); @@ -968,6 +971,9 @@ impl Game<'_> { event @ (HostEvent::Chat { .. } | HostEvent::Warn(_) | HostEvent::Error(_)) => { self.lan_log_event(event); } + HostEvent::PlayerChat { sender, text } => { + self.mod_player_chat(super::server_mods::Who::Uuid(sender), &text); + } HostEvent::Joined(conn) => { self.lan_guest_joined(&mut host, conn, state.as_ref(), entities, spawn); if self.options.dedicated.is_some() @@ -1037,6 +1043,14 @@ impl Game<'_> { } host.states = states; } + if !host.quiet.is_empty() { + self.lan = Some(host); + self.run_quiet_commands(); + host = self + .lan + .take() + .expect("the hub is back after the quiet commands"); + } self.lan_flush_effects(&mut host); if !paused { self.tick_guests(&mut host); diff --git a/crates/horizon-client/src/game/lan_actions.rs b/crates/horizon-client/src/game/lan_actions.rs index bbb0c37c0..e1a13881c 100644 --- a/crates/horizon-client/src/game/lan_actions.rs +++ b/crates/horizon-client/src/game/lan_actions.rs @@ -94,11 +94,14 @@ pub(super) struct GuestPlay { /// A guest's command waiting for the hub (`LanHost::commands`). pub(super) struct GuestCommand { - conn: u32, - command: String, - permission: u8, + pub(super) conn: u32, + pub(super) command: String, + pub(super) permission: u8, /// An integrated server's: no level teleports (yet). - integrated: bool, + pub(super) integrated: bool, + /// A mod's quiet command (game/lan_quiet.rs): its output suppressed, as + /// `CommandSourceStack.withSuppressedOutput` does. + pub(super) quiet: bool, } /// The game's own state while a guest's is swapped in (`enter_guest`), and @@ -1210,6 +1213,9 @@ impl Game<'_> { self.guest_carried_back(host, gi); } S::ChatCommand(c) => self.guest_chat_command(host, conn, &c.command), + S::CustomPayload(p) if p.channel == horizon_protocol::quiet::CHANNEL => { + self.guest_quiet_commands(host, conn, &p.data) + } S::ChatCommandSigned(p) => self.guest_signed_command(host, conn, p), S::ChangeDifficulty(p) if host.hub.guests[gi].permission >= 2 => { if !self.level.difficulty_locked && (0..=3).contains(&p.difficulty) { @@ -1533,6 +1539,10 @@ impl Game<'_> { ); return; } + // A server mod's command, for every player whatever their level. + if self.guest_server_mod_command(host, conn, command.trim_start_matches('/')) { + return; + } // An integrated server runs every player's commands at their own // permission level (`CommandSourceStack.permissions`); a LAN world // follows its Allow Commands, and a dedicated server leaves it to @@ -1559,6 +1569,7 @@ impl Game<'_> { command: command.trim_start_matches('/').to_owned(), permission, integrated, + quiet: false, }); } @@ -1573,41 +1584,54 @@ impl Game<'_> { return; } let c = host.commands.remove(0); - let mut host = self.lan.take().expect("checked above"); - let Some(swap) = self.enter_guest(&mut host, c.conn) else { - self.lan = Some(host); - continue; - }; - self.lan = Some(host); - self.chat_capture = Some(Vec::new()); - let level = std::mem::replace(&mut self.ui.registries.permission, c.permission); - self.run_command(&c.command); - self.ui.registries.permission = level; - let lines = self.chat_capture.take().unwrap_or_default(); - let mut host = self.lan.take().expect("a command puts the hub back"); - self.leave_guest(&mut host, swap); - host.hub.sync_all_effects(); - if !c.integrated { - // A teleport into another level happens before its feedback is sent. - self.run_level_teleports(&mut host); - } - // What the command earned is announced before its feedback. - self.announce_guest_advancements(&mut host); - for line in lines { - host.hub.send_to( - c.conn, - &C::SystemChat(play::SystemChat { - content: horizon_client::lan::data::component_nbt(&line.component()), - overlay: false, - }), - ); - } - // The other operators hear of it; never the player whose command it was. - self.send_admin_feedback(&mut host, Some(c.conn)); - self.lan = Some(host); + self.run_guest_command(c); } } + /// One guest's command as that guest, its feedback sent to them; false + /// when it failed (or the guest is gone). + pub(super) fn run_guest_command(&mut self, c: GuestCommand) -> bool { + let Some(mut host) = self.lan.take() else { + return false; + }; + let Some(swap) = self.enter_guest(&mut host, c.conn) else { + self.lan = Some(host); + return false; + }; + self.lan = Some(host); + self.chat_capture = Some(Vec::new()); + let level = std::mem::replace(&mut self.ui.registries.permission, c.permission); + let ok = if c.quiet { + self.run_command_quietly(&c.command) + } else { + self.run_command(&c.command) + }; + self.ui.registries.permission = level; + let lines = self.chat_capture.take().unwrap_or_default(); + let mut host = self.lan.take().expect("a command puts the hub back"); + self.leave_guest(&mut host, swap); + host.hub.sync_all_effects(); + if !c.integrated { + // A teleport into another level happens before its feedback is sent. + self.run_level_teleports(&mut host); + } + // What the command earned is announced before its feedback. + self.announce_guest_advancements(&mut host); + for line in lines { + host.hub.send_to( + c.conn, + &C::SystemChat(play::SystemChat { + content: horizon_client::lan::data::component_nbt(&line.component()), + overlay: false, + }), + ); + } + // The other operators hear of it; never the player whose command it was. + self.send_admin_feedback(&mut host, Some(c.conn)); + self.lan = Some(host); + ok + } + /// The `broadcastToAdmins` lines a command queued (`source`: the guest /// whose it was; none for the host's or the console's): every other /// operator gets them, and the console logs them as the server's own diff --git a/crates/horizon-client/src/game/lan_chat.rs b/crates/horizon-client/src/game/lan_chat.rs index f678480ab..621955967 100644 --- a/crates/horizon-client/src/game/lan_chat.rs +++ b/crates/horizon-client/src/game/lan_chat.rs @@ -28,7 +28,11 @@ impl Game<'_> { /// SignableCommand.of: the command's message arguments, by name, with /// their text, not past a redirect to the root (`execute ... run`). - fn signable_arguments(&mut self, permission: u8, command: &str) -> Vec<(String, String)> { + pub(super) fn signable_arguments( + &mut self, + permission: u8, + command: &str, + ) -> Vec<(String, String)> { let parse = self.parse_as(permission, command); let nodes = &vanilla::game_dispatcher().nodes; let root = parse.context.root; diff --git a/crates/horizon-client/src/game/lan_entities.rs b/crates/horizon-client/src/game/lan_entities.rs index a389e6a99..c18bdb8f8 100644 --- a/crates/horizon-client/src/game/lan_entities.rs +++ b/crates/horizon-client/src/game/lan_entities.rs @@ -245,6 +245,16 @@ impl Game<'_> { } out.push(e); } + for c in &self.cushions { + let p = c.position; + let mut e = state(c.id, "minecraft:cushion", [p.x, p.y, p.z], c.yaw, false); + // Cushion.DATA_COLOR, set unless it is the default white. + if c.color != 0 { + e.meta + .push((8, serializer::DYE_COLOR, Value::Id(i32::from(c.color)))); + } + out.push(e); + } self.lan_projectile_states(host_entity, hub, out); for o in &self.others { let p = o.position; diff --git a/crates/horizon-client/src/game/lan_quiet.rs b/crates/horizon-client/src/game/lan_quiet.rs new file mode 100644 index 000000000..63d382c02 --- /dev/null +++ b/crates/horizon-client/src/game/lan_quiet.rs @@ -0,0 +1,165 @@ +//! Quiet commands (`horizon_protocol::quiet`): a Horizon client's mod sends a +//! batch of command lines in one payload, and the server runs each exactly as +//! that player typing it would (`guest_command`'s checks, the player's own +//! permission level, at the time it runs) with its output suppressed, as +//! vanilla's functions run (`CommandSourceStack.withSuppressedOutput`): no +//! feedback and no failure in anyone's chat. A batch waits in a queue and runs +//! [`PER_TICK`] lines a player a tick, so a mod can't flood a server; each +//! finished batch is one line in the server's log. +use super::{Game, lan::LanHost, lan_actions::GuestCommand}; +use horizon_protocol::quiet; +use std::collections::{HashMap, VecDeque}; + +/// Lines a player may have waiting at most; a batch past it loses the rest. +pub(super) const PENDING: usize = 4096; +/// Lines run a player a tick at most. +pub(super) const PER_TICK: usize = 64; + +/// A batch waiting to run. +pub(super) struct QuietBatch { + conn: u32, + mod_id: String, + lines: VecDeque, + ran: usize, + failed: usize, + /// Lines past [`PENDING`], never run. + dropped: usize, +} + +impl Game<'_> { + /// A `horizon:quiet_commands` payload from `conn`: queued (or logged as + /// refused when it breaks the payload's caps). + pub(super) fn guest_quiet_commands(&mut self, host: &mut LanHost, conn: u32, data: &[u8]) { + let Some(name) = host.hub.guest(conn).map(|g| g.name.clone()) else { + return; + }; + let batch = match quiet::decode(data) { + Ok(b) => b, + Err(e) => { + super::dedicated::log( + "WARN", + &format!("{name} sent quiet commands that were refused: {e}"), + ); + return; + } + }; + let waiting: usize = host + .quiet + .iter() + .filter(|b| b.conn == conn) + .map(|b| b.lines.len()) + .sum(); + let room = PENDING.saturating_sub(waiting); + let dropped = batch.lines.len().saturating_sub(room); + host.quiet.push_back(QuietBatch { + conn, + mod_id: batch.mod_id, + lines: batch.lines.into_iter().take(room).collect(), + ran: 0, + failed: 0, + dropped, + }); + } + + /// The waiting batches, [`PER_TICK`] lines a player this tick, in order. + pub(super) fn run_quiet_commands(&mut self) { + let mut left: HashMap = HashMap::new(); + let mut i = 0; + loop { + let Some(host) = self.lan.as_mut() else { + return; + }; + let Some(batch) = host.quiet.get_mut(i) else { + return; + }; + let conn = batch.conn; + let budget = left.entry(conn).or_insert(PER_TICK); + let gone = host.hub.guest(conn).is_none(); + if gone || batch.lines.is_empty() { + let batch = host.quiet.remove(i).expect("got it above"); + if !gone { + let name = host + .hub + .guest(conn) + .map_or(String::new(), |g| g.name.clone()); + super::dedicated::log("INFO", &summary(&name, &batch)); + } + continue; + } + if *budget == 0 { + i += 1; + continue; + } + *budget -= 1; + let line = batch.lines.pop_front().expect("not empty"); + let ok = self.run_quiet_line(conn, &line); + if let Some(batch) = self.lan.as_mut().and_then(|h| h.quiet.get_mut(i)) { + batch.ran += 1; + batch.failed += usize::from(!ok); + } + } + } + + /// One line as `guest_command` would run it for `conn`, quietly. False + /// when it is refused or fails. A command that carries a chat message + /// (`say`, `msg`...) is refused: it would need the player's signature. + fn run_quiet_line(&mut self, conn: u32, line: &str) -> bool { + let allowed = self.options.dedicated.is_some() || self.allow_commands(); + let Some(host) = self.lan.as_ref() else { + return false; + }; + let integrated = host.hub.config.integrated; + if !integrated && (!host.settings.guest_commands || !allowed) { + return false; + } + let Some(permission) = host.hub.guest(conn).map(|g| g.permission) else { + return false; + }; + let command = line.trim_start_matches('/'); + if !self.signable_arguments(permission, command).is_empty() { + return false; + } + self.run_guest_command(GuestCommand { + conn, + command: command.to_owned(), + permission, + integrated, + quiet: true, + }) + } +} + +/// The batch's line in the server's log. +fn summary(name: &str, b: &QuietBatch) -> String { + let mut line = format!( + "{name} ran {} quiet command(s) from mod {}: {} failed", + b.ran, b.mod_id, b.failed + ); + if b.dropped > 0 { + line += &format!(", {} dropped (more than {PENDING} waiting)", b.dropped); + } + line +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn the_log_line_counts_the_batch() { + let b = QuietBatch { + conn: 1, + mod_id: "orbital".into(), + lines: VecDeque::new(), + ran: 12, + failed: 3, + dropped: 0, + }; + assert_eq!( + summary("Alex", &b), + "Alex ran 12 quiet command(s) from mod orbital: 3 failed" + ); + let b = QuietBatch { dropped: 5, ..b }; + assert!(summary("Alex", &b).ends_with(", 5 dropped (more than 4096 waiting)")); + } +} diff --git a/crates/horizon-client/src/game/lan_vehicles.rs b/crates/horizon-client/src/game/lan_vehicles.rs index f16a1e37d..00795aa62 100644 --- a/crates/horizon-client/src/game/lan_vehicles.rs +++ b/crates/horizon-client/src/game/lan_vehicles.rs @@ -56,6 +56,13 @@ impl Game<'_> { let (lo, hi) = corners(a.bounds()); return Some((lo, hi, at(a.position))); } + if let Some(c) = self.cushions.iter().find(|c| c.id == id) { + let (lo, hi) = corners(Aabb::new( + Vec3::new(c.position.x - 0.5, c.position.y, c.position.z - 0.5), + Vec3::new(c.position.x + 0.5, c.position.y + 0.25, c.position.z + 0.5), + )); + return Some((lo, hi, at(c.position))); + } if let Some(f) = self.item_frames.iter().find(|f| f.id == id) { let (lo, hi) = f.bounds(); return Some((lo, hi, centre(f.pos))); @@ -98,9 +105,10 @@ impl Game<'_> { let boat = self.boats.iter().position(|b| b.id == vehicle); let cart = self.carts.iter().any(|c| c.id == vehicle); let mount = self.mobs.iter().any(|m| m.id == vehicle); + let cushion = self.cushions.iter().any(|c| c.id == vehicle); // The vehicle is gone (broken, in another level) or the rider died: // its client drops it with the entity or the death screen. - if dead || (boat.is_none() && !cart && !mount) { + if dead || (boat.is_none() && !cart && !mount && !cushion) { let g = &mut host.hub.guests[gi]; (g.vehicle, g.vehicle_good) = (None, None); return; @@ -115,6 +123,17 @@ impl Game<'_> { // Getting out goes through leave_guest, which tells the client and // teleports it (ServerPlayer.dismountTo). let seat = self.as_guest(host, conn, |game| { + // A cushion does not move: the rider sits on it until it sneaks + // (`Cushion.removePassenger` plays the get-up sound). + if game.cushions.iter().any(|c| Some(c.id) == game.riding) { + if keys.shift { + game.tick_cushion_riding(keys); + return None; + } + let c = game.cushions.iter().find(|c| Some(c.id) == game.riding)?; + let p = c.seat(); + return Some([p.x, p.y, p.z]); + } if let Some(i) = game.boats.iter().position(|b| Some(b.id) == game.riding) { if keys.shift { game.dismount(i); @@ -168,6 +187,12 @@ impl Game<'_> { .iter() .find(|c| c.id == vehicle) .map(|c| (c.position, c.position.add_vector(Vec3::new(0.0, SEAT, 0.0)))) + }) + .or_else(|| { + self.cushions + .iter() + .find(|c| c.id == vehicle) + .map(|c| (c.position, c.seat())) }); if let Some((p, seat)) = at { let g = &mut host.hub.guests[gi]; diff --git a/crates/horizon-client/src/game/levels.rs b/crates/horizon-client/src/game/levels.rs index bfc739cee..9137a26d1 100644 --- a/crates/horizon-client/src/game/levels.rs +++ b/crates/horizon-client/src/game/levels.rs @@ -50,6 +50,7 @@ pub(super) struct Parked { paintings: Vec, item_frames: Vec, armor_stands: Vec, + cushions: Vec, others: Vec, boats: Vec, carts: Vec, @@ -136,6 +137,7 @@ impl Game<'_> { paintings: Vec::new(), item_frames: Vec::new(), armor_stands: Vec::new(), + cushions: Vec::new(), others: Vec::new(), boats: Vec::new(), carts: Vec::new(), @@ -187,6 +189,7 @@ impl Game<'_> { swap(&mut self.paintings, &mut p.paintings); swap(&mut self.item_frames, &mut p.item_frames); swap(&mut self.armor_stands, &mut p.armor_stands); + swap(&mut self.cushions, &mut p.cushions); swap(&mut self.others, &mut p.others); swap(&mut self.boats, &mut p.boats); swap(&mut self.carts, &mut p.carts); diff --git a/crates/horizon-client/src/game/mods.rs b/crates/horizon-client/src/game/mods.rs index 1752dec91..e2df267f4 100644 --- a/crates/horizon-client/src/game/mods.rs +++ b/crates/horizon-client/src/game/mods.rs @@ -17,6 +17,7 @@ use std::{path::PathBuf, time::Duration}; #[cfg(feature = "mods")] use { super::Screen, + super::{execution_role::ExecutionRole, lan::LanHost, server_mods::ModEvent}, horizon_client::{ extras::Corner, extras_hud, @@ -28,7 +29,8 @@ use { ui, }, horizon_mods::{ - Clock, ModKey, Mods, Output, Player, Runs, Snapshot, Status, UiScreen, UiWidget, + Clock, ModKey, Mods, Output, Player, Runs, ServerPlayer, Snapshot, Status, UiScreen, + UiWidget, }, std::time::Instant, winit::{event::MouseButton, keyboard::KeyCode}, @@ -52,6 +54,15 @@ pub(super) struct ModsState { /// The chat's command tree while a running mod owns commands. #[cfg(feature = "mods")] tree: Option, + /// A server mod runs here: what players do is queued for it. + #[cfg(feature = "mods")] + pub(super) server: bool, + /// The players server mods saw last tick, for joins and leaves. + #[cfg(feature = "mods")] + pub(super) players: Vec, + /// What players did this tick, for server mods at its end. + #[cfg(feature = "mods")] + pub(super) events: Vec, /// `command.run` lines for this window's own world, run on the next tick: /// run at once, their chat lines would reach the mods while their output /// is still being shown, and a mod answering its own lines would recurse. @@ -272,7 +283,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_for(Runs::Client, &paths, on, vanilla_command); + let mods = Mods::load_for(self.mod_runs(), &paths, on, vanilla_command); self.mods.mods = mods; let chosen = &self.settings.mods; self.mods.mods.set_bindings(|id| chosen.keys_of(id)); @@ -282,8 +293,18 @@ impl Game<'_> { self.sync_mod_commands(); self.show_mod_output(); } + /// Which mods this game runs: a server the server mods, the window + /// client mods, and both when it simulates the world itself (in-frame). + fn mod_runs(&self) -> Runs { + match self.options.execution_role { + ExecutionRole::IntegratedServer | ExecutionRole::DedicatedServer => Runs::Server, + ExecutionRole::Client if self.options.server_thread => Runs::Client, + ExecutionRole::Client => Runs::Both, + } + } /// The Mods page's rows, from what loaded. fn list_mods(&mut self) { + self.mods.server = self.mods.mods.runs_server(); let dev = &self.mods.dev; self.settings.mods.installed = self .mods @@ -369,8 +390,18 @@ impl Game<'_> { self.start_mods(); } } - /// What mods read this tick (or frame, for mods with a `frame` hook). + /// What mods read this tick (or frame, for mods with a `frame` hook): the + /// server's players as they were at the last tick's end. fn mod_snapshot(&mut self) -> Snapshot { + let players = if self.mods.server { + self.mods.players.clone() + } else { + Vec::new() + }; + self.mod_snapshot_with(players) + } + /// What mods read, with these players on the server. + pub(super) fn mod_snapshot_with(&mut self, players: Vec) -> Snapshot { let player = self.player.as_ref().map(|p| Player { x: p.position.x, y: p.position.y, @@ -414,7 +445,7 @@ impl Game<'_> { mappings, cps, font_widths: self.mods.font_widths.clone(), - players: Vec::new(), + players, view_hit: self.mod_view_hit(), } } @@ -490,23 +521,32 @@ impl Game<'_> { self.mods.mods.tick(self.ticks); self.show_mod_output(); } - /// Once per frame: the frame hook, and dev mods' rebuilds. - pub(super) fn mods_frame(&mut self, elapsed: Duration) { - if !self.mods.dev.is_empty() - && self + /// Restarts the dev mods rebuilt since the last check, once a second. + pub(super) fn reload_dev_mods(&mut self) { + if self.mods.dev.is_empty() + || self .mods .checked - .is_none_or(|t| t.elapsed() >= RELOAD_CHECK) + .is_some_and(|t| t.elapsed() < RELOAD_CHECK) { - self.mods.checked = Some(Instant::now()); - if self.mods.mods.reload_changed(vanilla_command) { - let chosen = &self.settings.mods; - self.mods.mods.set_bindings(|id| chosen.keys_of(id)); - self.list_mods(); - self.sync_mod_commands(); + return; + } + self.mods.checked = Some(Instant::now()); + if self.mods.mods.reload_changed(vanilla_command) { + let chosen = &self.settings.mods; + self.mods.mods.set_bindings(|id| chosen.keys_of(id)); + self.list_mods(); + self.sync_mod_commands(); + if self.options.execution_role.is_client() { self.system_message(Text::literal("Mods reloaded").with_color(text::GRAY)); + } else { + log::info!("Horizon: mods reloaded"); } } + } + /// Once per frame: the frame hook, and dev mods' rebuilds. + pub(super) fn mods_frame(&mut self, elapsed: Duration) { + self.reload_dev_mods(); if !self.mods.mods.is_running() { return; } @@ -537,8 +577,13 @@ impl Game<'_> { self.mods.mods.chat(line); self.show_mod_output(); } - /// Chat lines, command feedback and stopped mods, into the chat. - fn show_mod_output(&mut self) { + /// What mods showed: client mods' lines into the chat, server mods' + /// to their players. + pub(super) fn show_mod_output(&mut self) { + self.route_mod_output(None); + } + /// [`Game::show_mod_output`], with the hub when it is out of `self.lan`. + pub(super) fn route_mod_output(&mut self, mut host: Option<&mut LanHost>) { for output in self.mods.mods.drain() { let line = match output { Output::Chat { name, text } => { @@ -566,7 +611,16 @@ impl Game<'_> { // `mod_ui_view` finds no widgets and the screen closes. self.list_mods(); self.sync_mod_commands(); - Text::literal(format!("Mod {name} stopped: {reason}")).with_color(text::RED) + let line = format!("Mod {name} stopped: {reason}"); + if self.options.dedicated.is_some() { + super::dedicated::log("WARN", &line); + } + Text::literal(line).with_color(text::RED) + } + server + @ (Output::Tell { .. } | Output::Broadcast { .. } | Output::Reply { .. }) => { + self.route_server_output(host.as_deref_mut(), server); + continue; } Output::OpenScreen { owner } => { self.open_mod_screen(owner, false); @@ -582,20 +636,8 @@ impl Game<'_> { } continue; } - // 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. - // Written by this client, so the Chat option doesn't hide it. - let focused = self.screen == Screen::Chat; - self.ui.chat.add( - &self.gui.atlas, - line, - None, - horizon_client::chat::ChatSource::Client, - self.ticks, - focused, - ); + self.add_mod_chat_line(line); } // A mod may set or clear its settings page in any call, not only // while loading: its row's Settings button follows. @@ -604,6 +646,20 @@ impl Game<'_> { row.has_settings = e.has_ui_settings(); } } + /// A mod's line in the window's chat; not through system_message: a mod + /// must not hear its own lines. + /// Written by this client, so the Chat option doesn't hide it. + pub(super) fn add_mod_chat_line(&mut self, line: Text) { + let focused = self.screen == Screen::Chat; + self.ui.chat.add( + &self.gui.atlas, + line, + None, + horizon_client::chat::ChatSource::Client, + self.ticks, + focused, + ); + } /// The mods' HUD panels, stacked with the extras in their corners. pub(super) fn draw_mod_panels(&self, batch: &mut HudBatch, corners: &mut Corners) { for panel in self.mods.mods.panels() { diff --git a/crates/horizon-client/src/game/net_harness.rs b/crates/horizon-client/src/game/net_harness.rs index 1ec573e7c..468f1db71 100644 --- a/crates/horizon-client/src/game/net_harness.rs +++ b/crates/horizon-client/src/game/net_harness.rs @@ -3,7 +3,10 @@ //! window, waits until it stands in the world with the chunks around it, //! sends a chat message and `/list`, collects the chat it is shown, leaves //! and writes a JSON report (position, chunks, chat lines, whether the -//! server kept it connected throughout). +//! server kept it connected throughout). With `HORIZON_NET_QUIET` (lines +//! split by `;`) it then sends them as one batch of a mod's quiet commands +//! (`horizon_protocol::quiet`, `tools/quiet_commands_e2e.py`) and waits two +//! seconds for any chat they bring. use super::Game; use horizon_client::Result; use serde_json::json; @@ -23,6 +26,9 @@ impl Game<'_> { let mut step_at = Instant::now(); let mut chat_at = 0; let mut position = None; + let quiet: Vec = std::env::var("HORIZON_NET_QUIET") + .map(|v| v.split(';').map(str::to_owned).collect()) + .unwrap_or_default(); let mut chunks = 0; let mut error = None; while Instant::now() < deadline { @@ -71,6 +77,22 @@ impl Game<'_> { step_at = now; chat_at = shown; } + 2 if answered && !quiet.is_empty() => { + for data in horizon_protocol::quiet::encode("net_harness", &quiet) { + self.send(horizon_protocol::packets::play::Serverbound::CustomPayload( + horizon_protocol::packets::configuration::CustomPayload { + channel: horizon_protocol::quiet::CHANNEL.into(), + data, + }, + )); + } + step = 4; + step_at = now; + } + 4 if now - step_at > Duration::from_secs(2) => { + step = 3; + break; + } 2 if answered => { step = 3; break; diff --git a/crates/horizon-client/src/game/options.rs b/crates/horizon-client/src/game/options.rs index 243eced5c..73548c7a6 100644 --- a/crates/horizon-client/src/game/options.rs +++ b/crates/horizon-client/src/game/options.rs @@ -268,6 +268,11 @@ impl Game<'_> { r.animated_textures = s.horizon.animated_textures; r.set_mipmap_levels(s.mipmap_levels.max(0) as u32); r.set_world_post(s.horizon.resolution_scale as f32 / 100.0, s.horizon.fxaa); + r.set_hdr( + s.horizon.hdr, + s.horizon.hdr_paper_white as f32, + s.horizon.hdr_peak as f32, + ); } // Window.updateFullscreenIfChanged: only a changed option asks the // window to change, so applying settings never undoes a fullscreen diff --git a/crates/horizon-client/src/game/persist.rs b/crates/horizon-client/src/game/persist.rs index 45ef8801f..0c053d34e 100644 --- a/crates/horizon-client/src/game/persist.rs +++ b/crates/horizon-client/src/game/persist.rs @@ -314,6 +314,13 @@ impl Game<'_> { self.item_frames.push(f); } } + "minecraft:cushion" => { + self.next_entity += 1; + if let Some(c) = entity_nbt::cushion_from_nbt(&tag, self.next_entity) { + self.remember(c.id, uuid, tag); + self.cushions.push(c); + } + } "minecraft:painting" => { if let Some((pos, facing, variant)) = entity_nbt::painting_from_nbt(&tag) && let Some(v) = self.painting_variants.get(&variant).cloned() @@ -776,6 +783,18 @@ impl Game<'_> { out.entry(chunk_of(at)).or_default().push(tag); } } + for c in &self.cushions { + if keys.contains(&chunk_of(c.position)) { + let uuid = self + .persist + .uuids + .get(&c.id) + .copied() + .unwrap_or_else(random_uuid); + let tag = entity_nbt::cushion_to_nbt(c, uuid, self.persist.raw.get(&c.id)); + out.entry(chunk_of(c.position)).or_default().push(tag); + } + } for p in &self.paintings { let at = painting_center(p); if keys.contains(&chunk_of(at)) { @@ -868,6 +887,13 @@ impl Game<'_> { } keep }); + self.cushions.retain(|c| { + let keep = !gone(c.position); + if !keep { + removed.push(c.id); + } + keep + }); // Riders leave with their root vehicle, a boat's with the boat. let leaving: HashSet = (0..self.mobs.len()) .filter(|&i| { @@ -934,6 +960,7 @@ impl Game<'_> { .chain(self.boats.iter().map(|e| e.id)) .chain(self.carts.iter().map(|e| e.id)) .chain(self.armor_stands.iter().map(|e| e.id)) + .chain(self.cushions.iter().map(|e| e.id)) .chain(self.item_frames.iter().map(|e| e.id)) .chain(self.paintings.iter().map(|e| e.id)) .chain(self.others.iter().map(|e| e.id)) diff --git a/crates/horizon-client/src/game/potions.rs b/crates/horizon-client/src/game/potions.rs index b28c2fb4d..0b14db314 100644 --- a/crates/horizon-client/src/game/potions.rs +++ b/crates/horizon-client/src/game/potions.rs @@ -141,14 +141,22 @@ impl PotionState { t.stack = stack; } } - /// One tick of a server's client: `step` moves each toward where the - /// server put it. - pub(super) fn step_remote_thrown(&mut self, mut step: impl FnMut(u32, Vec3) -> Vec3) { - for t in &mut self.thrown { - t.previous = t.position; - t.age += 1; - t.position = step(t.id, t.position); - } + /// A server's move: thrown potions have no interpolation handler, so + /// `moveOrInterpolateTo` puts them there at once. False when `id` isn't one. + pub(super) fn move_remote_thrown(&mut self, id: u32, at: Vec3) -> bool { + let Some(t) = self.thrown.iter_mut().find(|t| t.id == id) else { + return false; + }; + t.position = at; + true + } + /// `handleSetEntityMotion` for a thrown potion. False when `id` isn't one. + pub(super) fn remote_thrown_motion(&mut self, id: u32, velocity: Vec3) -> bool { + let Some(t) = self.thrown.iter_mut().find(|t| t.id == id) else { + return false; + }; + t.velocity = velocity; + true } pub(super) fn remove_remote_thrown(&mut self, id: u32) { self.thrown.retain(|t| t.id != id); @@ -484,6 +492,7 @@ impl Game<'_> { thrown.retain_mut(|t| { t.age += 1; t.previous = t.position; + self.thrown_potion_motion(t); let next = Vec3::new( t.position.x + t.velocity.x, t.position.y + t.velocity.y, @@ -520,18 +529,6 @@ impl Game<'_> { return false; } t.position = next; - // ThrowableItemProjectile: drag 0.99 then gravity 0.05. - // ThrownExperienceBottle.getDefaultGravity is 0.07. - let gravity = if &*t.stack.item == "minecraft:experience_bottle" { - 0.07 - } else { - 0.05 - }; - t.velocity = Vec3::new( - t.velocity.x * 0.99, - t.velocity.y * 0.99 - gravity, - t.velocity.z * 0.99, - ); t.age < 1200 && t.position.y > -128.0 }); self.potions.thrown = thrown; @@ -539,6 +536,60 @@ impl Game<'_> { self.splash(&stack, at); } } + /// `ThrowableProjectile.tick`'s `applyGravity` and `applyInertia`, which + /// come before the move: gravity 0.05 (0.07 for an experience bottle), + /// then drag 0.99 (0.8 in water). + fn thrown_potion_motion(&self, t: &mut ThrownPotion) { + let gravity = if &*t.stack.item == "minecraft:experience_bottle" { + 0.07 + } else { + 0.05 + }; + let at = t.position; + let water = self + .res + .facts() + .get(self.world.block( + at.x.floor() as i32, + at.y.floor() as i32, + at.z.floor() as i32, + )) + .fluid + == horizon_client::blocks::Fluid::Water; + let inertia = if water { 0.8 } else { 0.99 }; + t.velocity = Vec3::new( + t.velocity.x * inertia, + (t.velocity.y - gravity) * inertia, + t.velocity.z * inertia, + ); + } + /// `ThrowableProjectile.tick` on a server's client: it falls and moves + /// by itself between the server's updates and stops at a block; only + /// the server breaks it. + pub(super) fn step_remote_thrown(&mut self) { + let mut thrown = std::mem::take(&mut self.potions.thrown); + for t in &mut thrown { + t.previous = t.position; + t.age += 1; + self.thrown_potion_motion(t); + let next = Vec3::new( + t.position.x + t.velocity.x, + t.position.y + t.velocity.y, + t.position.z + t.velocity.z, + ); + let state = self.world.block( + next.x.floor() as i32, + next.y.floor() as i32, + next.z.floor() as i32, + ); + if self.res.facts().get(state).full_collision { + t.velocity = Vec3::ZERO; + } else { + t.position = next; + } + } + self.potions.thrown = thrown; + } /// `ThrownItemRenderer` for thrown splash and lingering potions and /// experience bottles: the item (GROUND) facing the camera at scale 1, /// lit at the light probe (the eye, 0.85 of the 0.25 height). diff --git a/crates/horizon-client/src/game/remote.rs b/crates/horizon-client/src/game/remote.rs index e9f3fbbde..bbda6acc3 100644 --- a/crates/horizon-client/src/game/remote.rs +++ b/crates/horizon-client/src/game/remote.rs @@ -839,7 +839,10 @@ impl Game<'_> { remote.brand = brand; } } - Event::Reconfigured(registries) => self.set_registries(registries), + Event::Reconfigured(registries) => { + self.boss_overlay.reset(); + self.set_registries(registries); + } // handleTransfer: "Cannot transfer to server from // singleplayer" (no ServerData), so the world just closes. Event::Transfer { host, port } => { @@ -1258,6 +1261,9 @@ impl Game<'_> { } else { self.res.mob_types().get(kind).cloned() }; + if kind == "minecraft:ender_dragon" { + self.spawn_remote_dragon(id, position, yaw); + } if kind == "minecraft:experience_orb" { // Its value (ExperienceOrb.DATA_VALUE) follows in SetEntityData. self.orbs.retain(|o| o.id != id as u32); @@ -1364,13 +1370,17 @@ impl Game<'_> { m.on_ground = on_ground; return; } - if let Some(p) = self.creatures.projectiles.iter_mut().find(|p| { - p.id == id as u32 - && matches!( - p.kind, - horizon_client::projectiles::ProjectileKind::LargeFireball { .. } - ) - }) { + // Projectiles keep Entity's NO_OP InterpolationHandler too: the + // server's position replaces theirs at once and their own tick + // flies them on (`tick_remote_projectiles`). Eased towards it + // instead, they only moved when an update came, every 10 to 20 + // ticks. + if let Some(p) = self + .creatures + .projectiles + .iter_mut() + .find(|p| p.id == id as u32) + { if path.is_some() { p.position = Vec3::new(position[0], position[1], position[2]); } @@ -1380,6 +1390,14 @@ impl Game<'_> { } return; } + if path.is_some() + && (self.potions.move_remote_thrown( + id as u32, + Vec3::new(position[0], position[1], position[2]), + ) || self.end.move_remote_eye(id as u32, position)) + { + return; + } if let Some(p) = r.pending_items.get_mut(&id) { p.0 = position; } @@ -1426,6 +1444,8 @@ impl Game<'_> { self.mobs.retain(|m| m.id != id as u32); self.orbs.retain(|o| o.id != id as u32); self.dropped.retain(|d| d.id != id as u32); + // Before the crystals go: the dragon's beam index follows them. + self.remove_remote_dragon(id); self.remove_remote_object(id as u32); self.remove_remote_projectile(id as u32); if let Some(r) = self.remote.as_mut() { @@ -1958,6 +1978,7 @@ impl Game<'_> { } self.remote_object_data(p.id, &p.values); self.remote_projectile_data(p.id, &p.values); + self.remote_dragon_data(p.id, &p.values); } // ClientPacketListener.handleSetEquipment: what a mob or another // player holds and wears (EquipmentSlot ordinals). @@ -2039,6 +2060,8 @@ impl Game<'_> { } else if let Some(m) = self.mobs.iter_mut().find(|m| m.id == p.id as u32) { m.limb_speed = 1.5; m.hurt_time = 10; + } else { + self.remote_dragon_hurt(p.id); } } C::HurtAnimation(p) => { @@ -2048,9 +2071,14 @@ impl Game<'_> { } } else if let Some(m) = self.mobs.iter_mut().find(|m| m.id == p.id as u32) { m.hurt_time = 10; + } else { + self.remote_dragon_hurt(p.id); } } C::EntityEvent(p) => { + if p.event == super::fireworks::FIREWORK_EXPLODE_EVENT { + self.remote_firework_explosion(p.id); + } self.remote_fangs_event(p.id as u32, p.event); // LocalPlayer.setPermissions also refreshes an open World Options screen. if (24..=28).contains(&p.event) @@ -2937,6 +2965,7 @@ impl Game<'_> { /// entities whose own tick moves them on a client: dropped items, falling /// blocks and primed TNT. fn remote_motion(&mut self, id: i32, velocity: [f64; 3]) { + self.remote_dragon_motion(id, velocity); let v = Vec3::new(velocity[0], velocity[1], velocity[2]); if let Some(d) = self.dropped.iter_mut().find(|d| d.id == id as u32) { d.velocity = v; @@ -2957,6 +2986,8 @@ impl Game<'_> { .and_then(|r| r.pending_items.get_mut(&id)) { p.1 = v; + } else if !self.potions.remote_thrown_motion(id as u32, v) { + self.end.remote_eye_motion(id as u32, velocity); } } fn apply_remote_health(&mut self) { @@ -3530,6 +3561,18 @@ impl Game<'_> { self.remote_player_eating(&item, ticks, at, eye, pitch, yaw); } if running { + // The dragon: LivingEntity's interpolation, inside its aiStep. + let dragon_lerp = self + .dragon + .as_ref() + .and_then(|d| lerps.get_mut(&(d.id as i32))) + .filter(|l| l.steps > 0) + .map(|l| { + let steps = l.steps; + l.steps -= 1; + (l.target, l.rotation.map(|r| r.0), steps) + }); + self.tick_remote_dragon(dragon_lerp); // Boats, minecarts, armor stands, projectiles and the rest // interpolate like mobs. let mut step = |id: u32, at: Vec3| match lerps.get_mut(&(id as i32)) { diff --git a/crates/horizon-client/src/game/remote_objects.rs b/crates/horizon-client/src/game/remote_objects.rs index 251d277f3..05b1a2b9e 100644 --- a/crates/horizon-client/src/game/remote_objects.rs +++ b/crates/horizon-client/src/game/remote_objects.rs @@ -3,7 +3,7 @@ //! `handleSetEquipment`): the server simulates them, the client places them //! where it says and interpolates their moves like a mob's. use super::Game; -use horizon_client::entities::{ArmorStand, ItemFrame, Painting}; +use horizon_client::entities::{ArmorStand, Cushion, ItemFrame, Painting}; use horizon_core::geometry::Vec3; use horizon_protocol::entity_data::Value; use std::sync::Arc; @@ -57,6 +57,16 @@ impl Game<'_> { invisible: false, check_interval: 0, }); + } else if kind == "minecraft:cushion" { + // BlockAttachedEntity.pos: `BlockPos.containing` of the spawn. + self.cushions.push(Cushion { + id, + position: at, + pos: block, + yaw: super::cushions::snap_yaw(yaw), + color: 0, + check_interval: 0, + }); } else if kind == "minecraft:lightning_bolt" { self.spawn_remote_bolt(id, position); } else if kind == "minecraft:painting" { @@ -152,6 +162,11 @@ impl Game<'_> { } _ => {} } + } else if let Some(c) = self.cushions.iter_mut().find(|c| c.id == id) { + // Cushion.DATA_COLOR (DyeColor, a byte-backed id). + if let (8, Value::Id(color)) = (index, value) { + c.color = (*color).clamp(0, 15) as u8; + } } else if let Some(b) = self.boats.iter_mut().find(|b| b.id == id) { // VehicleEntity's hurt, direction and damage; the paddles. match (index, value) { @@ -267,6 +282,12 @@ impl Game<'_> { out.push(json!({"id": a.id, "kind": "minecraft:armor_stand", "position": at(a.position), "yaw": a.yaw, "small": a.small, "arms": a.show_arms, "no_base_plate": a.no_base_plate, "equipment": items})); } + for c in &self.cushions { + out.push( + json!({"id": c.id, "kind": "minecraft:cushion", "position": at(c.position), + "yaw": c.yaw, "color": c.color_name()}), + ); + } for f in &self.item_frames { out.push( json!({"id": f.id, "kind": f.kind(), "position": f.pos, "facing": f.facing, @@ -286,6 +307,7 @@ impl Game<'_> { self.carts.clear(); self.boats.clear(); self.armor_stands.clear(); + self.cushions.clear(); self.item_frames.clear(); self.paintings.clear(); } @@ -295,6 +317,7 @@ impl Game<'_> { self.carts.retain(|c| c.id != id); self.boats.retain(|b| b.id != id); self.armor_stands.retain(|a| a.id != id); + self.cushions.retain(|c| c.id != id); self.item_frames.retain(|f| f.id != id); self.paintings.retain(|p| p.id != id); self.bolts.retain(|b| b.id != id); diff --git a/crates/horizon-client/src/game/remote_projectiles.rs b/crates/horizon-client/src/game/remote_projectiles.rs index 3120808cb..568fab2c5 100644 --- a/crates/horizon-client/src/game/remote_projectiles.rs +++ b/crates/horizon-client/src/game/remote_projectiles.rs @@ -3,7 +3,7 @@ //! and `handleSetEntityData`): the server simulates them, the client draws //! them where it says and interpolates their moves. use super::{FallStep, FallingBlock, Game, fireworks::fireworks_of, view_vector}; -use horizon_client::projectiles::{Projectile, ProjectileKind}; +use horizon_client::projectiles::{Hit, Projectile, ProjectileKind, ProjectileWorld}; use horizon_core::{geometry::Vec3, position::BlockPos}; use horizon_protocol::entity_data::Value; use horizon_world::registry::BlockStateId; @@ -37,6 +37,32 @@ fn projectile_kind(kind: &str) -> Option { }) } +/// `AbstractArrow.tick` on a client: water drag before the move, air drag +/// after it, then gravity; a block it reaches holds it (`inGround`). +fn remote_arrow_tick(p: &mut Projectile, w: &impl ProjectileWorld) { + p.previous = p.position; + p.age += 1; + if p.stuck { + return; + } + let water = w.in_water(p.position); + if water { + p.velocity = p.velocity.scale(0.6); + } + let to = p.position.add_vector(p.velocity); + if let Some((at, _, _)) = w.clip(p.position, to) { + p.position = at; + p.velocity = Vec3::ZERO; + p.stuck = true; + return; + } + p.position = to; + if !water { + p.velocity = p.velocity.scale(0.99); + } + p.velocity.y -= 0.05; +} + impl Game<'_> { /// `handleAddEntity` for these types; false when `kind` isn't one. pub(super) fn spawn_remote_projectile( @@ -248,29 +274,34 @@ impl Game<'_> { } } self.falling = falling; - for p in &mut self.creatures.projectiles { - p.previous = p.position; - p.age += 1; - if matches!(p.kind, ProjectileKind::LargeFireball { .. }) { - // AbstractHurtingProjectile.tick advances on the client between - // the tracker updates (ten ticks apart for a ghast's fireball). - let at = p.position; - let water = self - .res - .facts() - .get(self.world.block( - at.x.floor() as i32, - at.y.floor() as i32, - at.z.floor() as i32, - )) - .fluid - == horizon_client::blocks::Fluid::Water; - p.apply_hurting_inertia(water); - p.position = p.position.add_vector(p.velocity); - } else { - p.position = step(p.id, p.position); + // Projectiles tick on the client too and fly on between the tracker's + // updates (10 to 20 ticks apart); a block stops them there, and only + // the server decides what they hit. + let mut projectiles = std::mem::take(&mut self.creatures.projectiles); + { + let w = self.mob_world_base(&[]); + let world = super::creatures::ProjWorld { + w: &w, + targets: Vec::new(), + }; + for p in &mut projectiles { + match p.kind { + ProjectileKind::Arrow { .. } => remote_arrow_tick(p, &world), + // ShulkerBullet.tick: only the server steers it. + ProjectileKind::ShulkerBullet { .. } => { + p.previous = p.position; + p.age += 1; + p.position = p.position.add_vector(p.velocity); + } + _ => { + if !matches!(p.tick(&world).1, Hit::None) { + p.velocity = Vec3::ZERO; + } + } + } } } + self.creatures.projectiles = projectiles; for t in &mut self.tridents { let id = t.id; t.remote_step(|at| step(id, at)); @@ -304,12 +335,9 @@ impl Game<'_> { c.time += 1; c.position = step(c.id, c.position); } - self.potions.step_remote_thrown(&mut step); + self.step_remote_thrown(); self.step_remote_hooks(&mut step); - self.end.step_remote_eyes(|id, at| { - let at = step(id, Vec3::new(at[0], at[1], at[2])); - [at.x, at.y, at.z] - }); + self.end.step_remote_eyes(); } pub(super) fn remove_remote_projectile(&mut self, id: u32) { @@ -334,6 +362,8 @@ impl Game<'_> { self.tridents.clear(); self.rockets.clear(); self.crystals.clear(); + // The dragon a server sent goes with its crystals. + self.dragon = None; self.potions.clear_thrown(); self.end.clear_remote_eyes(); self.clear_remote_hooks(); diff --git a/crates/horizon-client/src/game/remote_vehicles.rs b/crates/horizon-client/src/game/remote_vehicles.rs index 620aff97c..877ed66e6 100644 --- a/crates/horizon-client/src/game/remote_vehicles.rs +++ b/crates/horizon-client/src/game/remote_vehicles.rs @@ -56,6 +56,11 @@ impl Game<'_> { let p = a.position; hits.push((a.id as i32, d, [p.x, p.y, p.z])); } + if let Some((i, d, _)) = self.cushion_hit() { + let c = &self.cushions[i]; + let p = c.position; + hits.push((c.id as i32, d, [p.x, p.y, p.z])); + } if let Some((i, d)) = self.boat_hit() { let p = self.boats[i].position; hits.push((self.boats[i].id as i32, d, [p.x, p.y, p.z])); @@ -79,6 +84,8 @@ impl Game<'_> { hits.push((c.id as i32, d, [p.x, p.y, p.z])); } } + // EnderDragonPart.isPickable: the server's dragon hurts by part. + hits.extend(self.remote_dragon_part_hit(eye, dir, reach)); } let (id, distance, origin) = hits.into_iter().min_by(|a, b| a.1.total_cmp(&b.1))?; let point = at(distance); @@ -138,7 +145,10 @@ impl Game<'_> { self.position_rider(); return true; } - let seat = if let Some(i) = self.boats.iter().position(|b| b.id == id) { + let seat = if let Some(c) = self.cushions.iter().find(|c| c.id == id) { + // The seat does not move; the rider sits on the cushion. + Some(c.seat()) + } else if let Some(i) = self.boats.iter().position(|b| b.id == id) { // AbstractBoat.tick on the controlling client: steer and move. let mut b = self.boats[i].clone(); b.input = [keys.left, keys.right, keys.forward, keys.backward]; diff --git a/crates/horizon-client/src/game/server_mods.rs b/crates/horizon-client/src/game/server_mods.rs new file mode 100644 index 000000000..db88639eb --- /dev/null +++ b/crates/horizon-client/src/game/server_mods.rs @@ -0,0 +1,356 @@ +//! Server mods in the game (`docs/mods.md`, "Server mods"): the game that +//! simulates the world (in-frame single player, the server thread, a LAN +//! host, the dedicated server) runs them. At the end of each tick it tells +//! them who joined and left, then what players said, broke and placed since +//! the last one, then ticks them; a player's command reaches them at once. +//! Their lines go to the players they name. With no server mod on, each hook +//! here is one check. +use super::{Game, lan::LanHost}; +#[cfg(not(feature = "mods"))] +use horizon_world::registry::BlockStateId; + +/// Who did something a server mod hears about, resolved at the tick's end. +#[cfg_attr(not(feature = "mods"), allow(dead_code))] +pub(super) enum Who { + /// The window's own player, in-frame. + Local, + /// A connection's player (the server thread's owner is one). + Conn(u32), + Uuid(u128), +} + +/// What players did during a tick, for the server mods at its end. +#[cfg_attr(not(feature = "mods"), allow(dead_code))] +pub(super) enum ModEvent { + Chat(Who, String), + Block { + who: Who, + pos: [i32; 3], + state: String, + placed: bool, + }, +} + +#[cfg(not(feature = "mods"))] +impl Game<'_> { + pub(super) fn tick_server_mods(&mut self) {} + pub(super) fn mod_block_event(&mut self, _pos: [i32; 3], _state: BlockStateId, _placed: bool) {} + pub(super) fn mod_player_chat(&mut self, _who: Who, _text: &str) {} + pub(super) fn local_server_mod_command(&mut self, _line: &str) -> bool { + false + } + pub(super) fn guest_server_mod_command( + &mut self, + _host: &mut LanHost, + _conn: u32, + _line: &str, + ) -> bool { + false + } +} + +#[cfg(feature = "mods")] +mod run { + use super::{Game, LanHost, ModEvent, Who}; + use horizon_client::{ + command::args::GameMode as Mode, + lan::data::component_nbt, + text::{self, Text}, + }; + use horizon_mods::{BlockPos, GameMode, Output, ServerPlayer}; + use horizon_protocol::packets::play::{self, Clientbound as C}; + use horizon_world::registry::BlockStateId; + + /// `UUID.toString()`. + fn uuid_string(u: u128) -> String { + let h = format!("{u:032x}"); + format!( + "{}-{}-{}-{}-{}", + &h[..8], + &h[8..12], + &h[12..16], + &h[16..20], + &h[20..] + ) + } + + fn mode(id: i32) -> GameMode { + match id { + 1 => GameMode::Creative, + 2 => GameMode::Adventure, + 3 => GameMode::Spectator, + _ => GameMode::Survival, + } + } + + impl Game<'_> { + /// The players on this game's server: the window's own player + /// in-frame, then every connection's. `host` is the hub when it is + /// out of `self.lan`. + pub(in crate::game) fn server_players(&self, host: Option<&LanHost>) -> Vec { + let mut out = Vec::new(); + if self.options.execution_role.is_client() + && self.remote.is_none() + && let Some(p) = &self.player + { + out.push(ServerPlayer { + id: self.player_uuid_string(), + name: crate::game::chat::PLAYER_NAME.to_owned(), + x: p.position.x, + y: p.position.y, + z: p.position.z, + dimension: self.dim.id().to_owned(), + game_mode: match self.mode { + Mode::Survival => GameMode::Survival, + Mode::Creative => GameMode::Creative, + Mode::Adventure => GameMode::Adventure, + Mode::Spectator => GameMode::Spectator, + }, + health: p.health.health(), + }); + } + let guests = host + .or(self.lan.as_ref()) + .into_iter() + .flat_map(|h| &h.hub.guests); + out.extend(guests.filter(|g| g.placed).map(|g| ServerPlayer { + id: uuid_string(g.uuid), + name: g.name.clone(), + x: g.position[0], + y: g.position[1], + z: g.position[2], + dimension: g.dimension.clone(), + game_mode: mode(g.game_mode), + health: g.health, + })); + out + } + + /// Whether what players do now reaches server mods: one is running + /// and this game simulates the world. + fn hears_players(&self) -> bool { + self.mods.server && self.remote.is_none() + } + + /// The tick's end: joins and leaves, the tick's events, the tick hook. + pub(in crate::game) fn tick_server_mods(&mut self) { + if !self.options.execution_role.is_client() { + // A server has no frames to check its dev mods in. + self.reload_dev_mods(); + } + if !self.mods.server { + return; + } + let players = self.server_players(None); + let snapshot = self.mod_snapshot_with(players.clone()); + self.mods.mods.set_snapshot(snapshot); + let before = std::mem::take(&mut self.mods.players); + for p in before + .iter() + .filter(|p| !players.iter().any(|q| q.id == p.id)) + { + self.mods.mods.player_left(p); + } + for p in players + .iter() + .filter(|p| !before.iter().any(|q| q.id == p.id)) + { + self.mods.mods.player_joined(p); + } + for event in std::mem::take(&mut self.mods.events) { + let who = |w: &Who| { + let id = match w { + Who::Local => self.player_uuid_string(), + Who::Uuid(u) => uuid_string(*u), + Who::Conn(c) => { + let guests = self.lan.iter().flat_map(|h| &h.hub.guests); + let g = guests.into_iter().find(|g| g.conn == *c); + g.map_or_else(String::new, |g| uuid_string(g.uuid)) + } + }; + players.iter().chain(&before).find(|p| p.id == id).cloned() + }; + match event { + ModEvent::Chat(w, text) => { + if let Some(p) = who(&w) { + self.mods.mods.player_chat(&p, &text); + } + } + ModEvent::Block { + who: w, + pos, + state, + placed, + } => { + let Some(p) = who(&w) else { continue }; + let pos = BlockPos { + x: pos[0], + y: pos[1], + z: pos[2], + }; + if placed { + self.mods.mods.block_placed(&p, pos, &state); + } else { + self.mods.mods.block_broken(&p, pos, &state); + } + } + } + } + self.mods.mods.server_tick(self.ticks); + self.mods.players = players; + self.show_mod_output(); + } + + /// A player broke (or placed) `state` at `pos`: the player acting now. + pub(in crate::game) fn mod_block_event( + &mut self, + pos: [i32; 3], + state: BlockStateId, + placed: bool, + ) { + if !self.hears_players() { + return; + } + let who = self.lan_acting.map_or(Who::Local, Who::Conn); + let state = self.state_string(state); + self.mods.events.push(ModEvent::Block { + who, + pos, + state, + placed, + }); + } + + /// A chat message a player sent. + pub(in crate::game) fn mod_player_chat(&mut self, who: Who, text: &str) { + if self.hears_players() { + self.mods.events.push(ModEvent::Chat(who, text.to_owned())); + } + } + + /// `/line` typed by the window's own player in-frame: true when a + /// server mod owns it. + pub(in crate::game) fn local_server_mod_command(&mut self, line: &str) -> bool { + if !self.hears_players() { + return false; + } + let players = self.server_players(None); + let Some(me) = players.first().cloned() else { + return false; + }; + let snapshot = self.mod_snapshot_with(players); + self.mods.mods.set_snapshot(snapshot); + let owned = self.mods.mods.server_command(&me, line); + self.show_mod_output(); + owned + } + + /// `/line` typed by a connection's player: true when a server mod + /// owns it, whatever the player's permission level. + pub(in crate::game) fn guest_server_mod_command( + &mut self, + host: &mut LanHost, + conn: u32, + line: &str, + ) -> bool { + if !self.hears_players() { + return false; + } + let Some(g) = host.hub.guest(conn) else { + return false; + }; + let id = uuid_string(g.uuid); + let players = self.server_players(Some(host)); + let Some(me) = players.iter().find(|p| p.id == id).cloned() else { + return false; + }; + let snapshot = self.mod_snapshot_with(players); + self.mods.mods.set_snapshot(snapshot); + if !self.mods.mods.server_command(&me, line) { + return false; + } + self.route_mod_output(Some(host)); + true + } + + /// Sends a server mod's line to the player with this id: the + /// window's own chat for the local player, a system message for a + /// connection's. `host` is the hub when it is out of `self.lan`. + pub(in crate::game) fn tell_server_player( + &mut self, + host: Option<&mut LanHost>, + id: &str, + line: Text, + ) { + let local = self.options.execution_role.is_client() + && self.remote.is_none() + && self.player.is_some(); + if local && self.player_uuid_string() == id { + self.add_mod_chat_line(line); + return; + } + let Some(host) = host.or(self.lan.as_mut()) else { + return; + }; + let to = host + .hub + .guests + .iter() + .find(|g| g.placed && uuid_string(g.uuid) == id); + if let Some(conn) = to.map(|g| g.conn) { + host.hub.send_to( + conn, + &C::SystemChat(play::SystemChat { + content: component_nbt(&line.component()), + overlay: false, + }), + ); + } + } + + /// Routes a server mod's output: `Tell` and `Reply` to their player, + /// `Broadcast` to everyone and the log. + pub(in crate::game) fn route_server_output( + &mut self, + mut host: Option<&mut LanHost>, + output: Output, + ) { + let named = |name: &str, text: String| { + let mut line = Text::literal(format!("[{name}] ")).with_color(text::GRAY); + line.push(Text::literal(text)); + line + }; + match output { + Output::Tell { name, player, text } => { + self.tell_server_player(host, &player, named(&name, text)); + } + Output::Reply { + player, + text, + error, + } => { + let line = Text::literal(text); + let line = if error { + line.with_color(text::RED) + } else { + line + }; + self.tell_server_player(host, &player, line); + } + Output::Broadcast { name, text } => { + let plain = format!("[{name}] {text}"); + if self.options.dedicated.is_some() { + super::super::dedicated::log("INFO", &plain); + } else { + log::info!("{plain}"); + } + for p in self.server_players(host.as_deref()) { + let line = named(&name, text.clone()); + self.tell_server_player(host.as_deref_mut(), &p.id, line); + } + } + _ => {} + } + } + } +} diff --git a/crates/horizon-client/src/game/sign_edit.rs b/crates/horizon-client/src/game/sign_edit.rs index 2f50ad9ab..2d010f1f5 100644 --- a/crates/horizon-client/src/game/sign_edit.rs +++ b/crates/horizon-client/src/game/sign_edit.rs @@ -6,9 +6,9 @@ use horizon_client::{ containers::BlockEntity, hud::{HudBatch, rgba}, signs::wood_type, + ui::EditBox, }; use horizon_protocol::packets::play::{self, Clientbound as C, Serverbound as S}; -use std::time::Instant; use winit::{ event::{ElementState, KeyEvent}, keyboard::{KeyCode, PhysicalKey}, @@ -18,7 +18,16 @@ pub(super) struct SignEditor { pub pos: (i32, i32, i32), pub front: bool, pub line: usize, - pub opened: Instant, + /// The line being edited (`AbstractSignEditScreen`'s text field). + edit: EditBox, +} + +fn sign_box() -> EditBox { + let mut edit = EditBox::new(0.0, 0.0, 90.0, 9.0); + edit.bordered = false; + edit.max_length = 384; + edit.focused = true; + edit } impl Game<'_> { @@ -28,8 +37,9 @@ impl Game<'_> { pos, front, line: 0, - opened: Instant::now(), + edit: sign_box(), }); + self.sign_load(); self.keys.clear(); self.right = false; self.capture(false); @@ -140,97 +150,154 @@ impl Game<'_> { /// A key and the text it typed on the sign being edited (the keyboard, /// or a controller's on-screen keyboard). pub(super) fn sign_input(&mut self, key: Option, typed: Option<&str>) { - let Some(edit) = self.sign_edit.as_mut() else { + if self.sign_edit.is_none() { return; - }; - let front = edit.front; - let id = sign_line_id(front, edit.line); + } match key { Some(KeyCode::Escape) => self.close_sign_editor(), - Some(KeyCode::ArrowUp) => edit.line = (edit.line + 3) & 3, + Some(KeyCode::ArrowUp) => self.sign_move_line(3), Some(KeyCode::ArrowDown | KeyCode::Enter | KeyCode::NumpadEnter) => { - edit.line = (edit.line + 1) & 3 + self.sign_move_line(1) } - Some(KeyCode::Backspace) => { - let (line, key) = (edit.line, edit.pos); - if let Some(BlockEntity::Sign(sign)) = self.world.block_entities.get_mut(&key) { - let text = if front { - &mut sign.front - } else { - &mut sign.back - }; - let value = &mut text.lines[line]; - if !self.text_selection.take(id, value) { - value.pop(); - } - } + Some( + key @ (KeyCode::ArrowLeft + | KeyCode::ArrowRight + | KeyCode::Home + | KeyCode::End + | KeyCode::Backspace + | KeyCode::Delete), + ) => { + let (ctrl, shift) = (self.has_control_down(), self.has_shift_down()); + self.sign_change(|edit| { + edit.key(key, ctrl, shift); + }); } _ => { let Some(typed) = typed else { return; }; - let line = edit.line; - let atlas = &self.gui.atlas; - let width = |s: &str| HudBatch::text_width(atlas, s); - let Some(key) = self.sign_edit.as_ref().map(|e| e.pos) else { - return; - }; - if let Some(BlockEntity::Sign(sign)) = self.world.block_entities.get_mut(&key) { - let max = sign.max_line_width(); - let text = if front { - &mut sign.front - } else { - &mut sign.back - }; - self.text_selection.take(id, &mut text.lines[line]); - for ch in typed.chars().filter(|c| !c.is_control()) { - let mut next = text.lines[line].clone(); - next.push(ch); - // TextFieldHelper filter: font.width(s) <= maxTextLineWidth. - if width(&next) <= max { - text.lines[line] = next; - } - } - } + self.sign_change(|edit| edit.insert_text(typed)); } } } - /// `TextFieldHelper.keyPressed`'s shortcuts on the edited line: a paste - /// (formatting and carriage returns removed) is taken whole or not at - /// all, as the line must stay within the sign's width. - fn sign_shortcut(&mut self, shortcut: horizon_client::clipboard::EditShortcut) { + /// Up or down a line: the box writes the line it leaves and loads the next. + fn sign_move_line(&mut self, by: usize) { + self.sign_write(); + if let Some(edit) = self.sign_edit.as_mut() { + edit.line = (edit.line + by) & 3; + } + self.sign_load(); + } + /// The edited line's text. + fn sign_current(&self) -> Option { + let edit = self.sign_edit.as_ref()?; + let BlockEntity::Sign(sign) = self.world.block_entities.get(&edit.pos)? else { + return None; + }; + let side = if edit.front { &sign.front } else { &sign.back }; + Some(side.lines[edit.line].clone()) + } + /// `EditBox.setValue` from the line now being edited. + fn sign_load(&mut self) { + let Some(text) = self.sign_current() else { + return; + }; + if let Some(edit) = self.sign_edit.as_mut() { + edit.edit.set_value(&text); + } + } + /// The box's text onto the sign, when it still fits the line. + fn sign_write(&mut self) { let Some(edit) = self.sign_edit.as_ref() else { return; }; - let (key, front, line) = (edit.pos, edit.front, edit.line); - let Some(BlockEntity::Sign(sign)) = self.world.block_entities.get_mut(&key) else { + let (pos, front, line, value) = (edit.pos, edit.front, edit.line, edit.edit.value.clone()); + if !self.sign_fits(&value) { + return; + } + let Some(BlockEntity::Sign(sign)) = self.world.block_entities.get_mut(&pos) else { return; }; - let max = sign.max_line_width(); - let text = if front { + let side = if front { &mut sign.front } else { &mut sign.back }; - let atlas = &self.gui.atlas; - self.text_selection.apply( - sign_line_id(front, line), - &mut text.lines[line], - shortcut, - &mut self.clipboard, - |value, pasted| { - let next = format!( - "{value}{}", - horizon_client::clipboard::helper_clipboard_contents(pasted) - ); - HudBatch::text_width(atlas, &next) <= max && { - *value = next; - true - } - }, - ); + side.lines[line] = value; } - /// Done button (`this.width / 2 - 100, this.height / 4 + 144`, 200x20). + /// TextFieldHelper: `font.width(s) <= maxTextLineWidth`. + fn sign_fits(&self, value: &str) -> bool { + let Some(edit) = self.sign_edit.as_ref() else { + return false; + }; + let Some(BlockEntity::Sign(sign)) = self.world.block_entities.get(&edit.pos) else { + return false; + }; + HudBatch::text_width(&self.gui.atlas, value) <= sign.max_line_width() + } + /// Edit the line, then keep the result only when it still fits. + fn sign_change(&mut self, f: impl FnOnce(&mut EditBox)) { + let before = self + .sign_edit + .as_ref() + .map(|e| (e.edit.value.clone(), e.edit.cursor, e.edit.highlight)); + if let Some(edit) = self.sign_edit.as_mut() { + f(&mut edit.edit); + let clean = horizon_client::clipboard::strip_formatting(&edit.edit.value); + if clean != edit.edit.value { + let n = horizon_client::ui::char_len(&clean); + edit.edit.value = clean; + edit.edit.cursor = edit.edit.cursor.min(n); + edit.edit.highlight = edit.edit.highlight.min(n); + } + } + self.sign_keep(before); + } + /// Write the box when the line still fits; otherwise put the old text back. + fn sign_keep(&mut self, before: Option<(String, usize, usize)>) { + let value = self + .sign_edit + .as_ref() + .map(|e| e.edit.value.clone()) + .unwrap_or_default(); + if self.sign_fits(&value) { + self.sign_write(); + } else if let (Some(edit), Some((value, cursor, highlight))) = + (self.sign_edit.as_mut(), before) + { + edit.edit.value = value; + edit.edit.cursor = cursor; + edit.edit.highlight = highlight; + } + } + /// `TextFieldHelper.keyPressed`'s shortcuts on the edited line. Paste + /// reads `getClipboardContents` before `insertText`. A paste that would + /// pass the sign's width is refused whole. + fn sign_shortcut(&mut self, shortcut: horizon_client::clipboard::EditShortcut) { + if shortcut == horizon_client::clipboard::EditShortcut::Paste { + let raw = horizon_client::clipboard::Clipboard::get(&mut self.clipboard); + let text = horizon_client::clipboard::helper_clipboard_contents(&raw); + self.sign_change(|edit| edit.insert_text(&text)); + return; + } + let before = self + .sign_edit + .as_ref() + .map(|e| (e.edit.value.clone(), e.edit.cursor, e.edit.highlight)); + if let Some(edit) = self.sign_edit.as_mut() { + edit.edit.shortcut(shortcut, &mut self.clipboard); + let clean = horizon_client::clipboard::strip_formatting(&edit.edit.value); + if clean != edit.edit.value { + let n = horizon_client::ui::char_len(&clean); + edit.edit.value = clean; + edit.edit.cursor = edit.edit.cursor.min(n); + edit.edit.highlight = edit.edit.highlight.min(n); + } + } + self.sign_keep(before); + } + /// Done button (`this.width / 2 - 100, this.height / 4 + 144`, 200x20), + /// or a click on a line (`EditBox.onClick`). pub(super) fn sign_edit_click(&mut self, size: [u32; 2]) { let b = HudBatch::new(size); let (x, y) = (b.width / 2.0 - 100.0, b.height / 4.0 + 144.0); @@ -238,7 +305,56 @@ impl Game<'_> { if mx >= x && mx < x + 200.0 && my >= y && my < y + 20.0 { self.audio.play_button_click(); self.close_sign_editor(); + return; } + let Some((cx, top, line_height, max_width, lines)) = self.sign_lines(b.width) else { + return; + }; + let shift = self.has_shift_down(); + for i in 0..lines.len() { + let ly = top + i as f32 * line_height; + let left = cx - max_width / 2.0; + if mx < left || mx >= left + max_width || my < ly || my >= ly + line_height { + continue; + } + let current = self.sign_edit.as_ref().map(|e| e.line); + if current != Some(i) { + self.sign_move_line((i + 4 - current.unwrap_or(0)) & 3); + } + let value = self + .sign_edit + .as_ref() + .map(|e| e.edit.value.clone()) + .unwrap_or_default(); + let lw = HudBatch::text_width(&self.gui.atlas, &value); + let text_x = cx - (lw as i32 / 2) as f32; + if let Some(edit) = self.sign_edit.as_mut() { + edit.edit.x = text_x; + edit.edit.y = ly; + edit.edit.width = max_width; + edit.edit.click(&self.gui.atlas, mx, shift, false); + } + self.sign_write(); + return; + } + } + /// Centre x, the first line's y, the line height, the width limit and the four lines. + fn sign_lines(&self, width: f32) -> Option<(f32, f32, f32, f32, Vec)> { + let edit = self.sign_edit.as_ref()?; + let BlockEntity::Sign(sign) = self.world.block_entities.get(&edit.pos)? else { + return None; + }; + let text = if edit.front { &sign.front } else { &sign.back }; + let line_height = sign.line_height(); + let y = if sign.hanging { 125.0 } else { 90.0 }; + let top = y - (4.0 * line_height / 2.0).floor(); + Some(( + width / 2.0, + top, + line_height, + sign.max_line_width(), + text.lines.to_vec(), + )) } pub(super) fn draw_sign_editor(&self, batch: &mut HudBatch) { let Some(edit) = &self.sign_edit else { return }; @@ -304,23 +420,48 @@ impl Game<'_> { let color = rgba((color >> 16) as u8, (color >> 8) as u8, color as u8, 255); let line_height = sign.line_height(); let midpoint = (4.0 * line_height / 2.0).floor(); - let blink = (edit.opened.elapsed().as_millis() / 300) % 2 == 0; for (i, line) in text.lines.iter().enumerate() { - let lw = HudBatch::text_width(atlas, line); + let shown = if i == edit.line { + edit.edit.value.as_str() + } else { + line.as_str() + }; + let lw = HudBatch::text_width(atlas, shown); let x = cx - (lw as i32 / 2) as f32; let ly = y + i as f32 * line_height - midpoint; - batch.text(atlas, line, x, ly, color, false); - if i == edit.line - && self - .text_selection - .covers(sign_line_id(edit.front, i), line) - { - // AbstractSignEditScreen: the selection from its start to its end. - batch.text_highlight(atlas, (x, ly, lw, line_height), true); + batch.text(atlas, shown, x, ly, color, false); + if i != edit.line { + continue; } - if i == edit.line && blink { - // TextCursorUtils.extractAppendCursor: an underscore after the text. - batch.text(atlas, "_", x + lw, ly, color, false); + let value = &edit.edit.value; + if edit.edit.cursor != edit.edit.highlight { + let (a, b) = ( + edit.edit.cursor.min(edit.edit.highlight), + edit.edit.cursor.max(edit.edit.highlight), + ); + let pre: String = value.chars().take(a).collect(); + let sel: String = value.chars().skip(a).take(b - a).collect(); + batch.text_highlight( + atlas, + ( + x + HudBatch::text_width(atlas, &pre), + ly, + HudBatch::text_width(atlas, &sel), + line_height, + ), + true, + ); + } + if edit.edit.cursor_visible() { + let pre: String = value.chars().take(edit.edit.cursor).collect(); + batch.fill( + atlas, + x + HudBatch::text_width(atlas, &pre), + ly, + 1.0, + line_height, + color, + ); } } let (bx, by) = (w / 2.0 - 100.0, h / 4.0 + 144.0); @@ -344,8 +485,3 @@ impl Game<'_> { ); } } - -/// The sign line being edited, for Select All. -fn sign_line_id(front: bool, line: usize) -> horizon_client::clipboard::FieldId { - (if front { "sign.front" } else { "sign.back" }, line) -} diff --git a/crates/horizon-client/src/game/stations.rs b/crates/horizon-client/src/game/stations.rs index f7f05e1c4..2b51a81a1 100644 --- a/crates/horizon-client/src/game/stations.rs +++ b/crates/horizon-client/src/game/stations.rs @@ -135,8 +135,10 @@ pub(super) struct Station { pub(super) offers: EnchantOffers, bookcases: i32, pub(super) anvil: AnvilResult, - /// Anvil rename box text. + /// Anvil rename box text (`AnvilMenu.itemName`). pub(super) name: String, + /// The box itself (`AnvilScreen`'s `EditBox` of 50, unbordered). + pub(super) rename: horizon_client::ui::EditBox, /// Stonecutter: the menu's recipe list (horizon_client::menu), its /// `selectedRecipeIndex` and the screen's first shown index. pub(super) stone: horizon_client::menu::Stonecutter, @@ -146,8 +148,6 @@ pub(super) struct Station { anvil_last: Option, /// Anvil on a server: the name last sent (the client menu's `itemName`). pub(super) anvil_sent: Option, - /// When the screen opened: the rename box has the focus from then. - opened: std::time::Instant, pub(super) last_sound: u64, /// Villager trading state. pub(super) merchant: Option>, @@ -169,12 +169,12 @@ impl Station { bookcases: 0, anvil: AnvilResult::default(), name: String::new(), + rename: anvil_box(), stone: Default::default(), selected: None, start: 0, anvil_last: None, anvil_sent: None, - opened: std::time::Instant::now(), last_sound: 0, merchant: None, beacon: [None; 2], @@ -868,6 +868,9 @@ impl Game<'_> { if kind == Kind::Stonecutter && self.stonecutter_click(local) { return true; } + if kind == Kind::Anvil && !right && self.anvil_name_click(ox, oy) { + return true; + } } let Some(slot) = self.slot_at(&batch, self.cursor.0, self.cursor.1) else { return true; @@ -894,6 +897,8 @@ impl Game<'_> { .as_ref() .map(|i| stations::hover_name(&|id| self.pack.names.display_item(id), i)) .unwrap_or_default(); + let name = s.name.clone(); + s.rename.set_value(&name); } self.station_changed(); } @@ -960,21 +965,29 @@ impl Game<'_> { let Some(s) = self.station.as_mut() else { return; }; - let cleared = self.text_selection.take(ANVIL_NAME, &mut s.name); if backspace { - if !cleared { - s.name.pop(); - } + s.rename.delete_chars(-1); } else if let Some(t) = text { - for c in t.chars().filter(|c| !c.is_control()) { - if s.name.chars().count() < ANVIL_NAME_CHARS { - s.name.push(c); - } - } + s.rename.insert_text(t); } + s.name.clone_from(&s.rename.value); self.station_changed(); self.remote_anvil_rename(); } + /// `AnvilScreen.keyPressed`: the rename box handles the key. + pub(super) fn station_key(&mut self, key: winit::keyboard::KeyCode) -> bool { + let (ctrl, shift) = (self.has_control_down(), self.has_shift_down()); + let Some(s) = self.station.as_mut() else { + return false; + }; + if !s.rename.key(key, ctrl, shift) { + return false; + } + s.name.clone_from(&s.rename.value); + self.station_changed(); + self.remote_anvil_rename(); + true + } /// Ctrl+A/C/V/X in the anvil's rename box (an `EditBox` of 50) or the /// recipe book's search box. pub(super) fn station_shortcut(&mut self, shortcut: horizon_client::clipboard::EditShortcut) { @@ -985,18 +998,52 @@ impl Game<'_> { let Some(s) = self.station.as_mut() else { return; }; - if Self::append_shortcut( - &mut self.text_selection, - &mut self.clipboard, - ANVIL_NAME, - &mut s.name, - shortcut, - ANVIL_NAME_CHARS, - ) { + if s.rename.shortcut(shortcut, &mut self.clipboard) { + s.name.clone_from(&s.rename.value); self.station_changed(); self.remote_anvil_rename(); } } + /// A click in the anvil's name box (`EditBox.onClick`). + fn anvil_name_click(&mut self, ox: f32, oy: f32) -> bool { + let open = self + .station + .as_ref() + .is_some_and(|s| s.kind == Kind::Anvil && s.inputs[0].is_some()); + if !open { + return false; + } + let (x, y, w, h) = (ox + 62.0, oy + 24.0, 103.0, 12.0); + let (mx, my) = self.cursor; + if mx < x || my < y || mx >= x + w || my >= y + h { + return false; + } + let shift = self.has_shift_down(); + let Some(s) = self.station.as_mut() else { + return false; + }; + s.rename.x = x; + s.rename.y = y; + s.rename.width = w; + s.rename.click(&self.gui.atlas, mx, shift, false); + true + } + /// AnvilScreen's name box, drawn after the station picture. + fn draw_anvil_name(&mut self, batch: &mut HudBatch, ox: f32, oy: f32) { + let Some(s) = self.station.as_mut() else { + return; + }; + let edit = &mut s.rename; + edit.x = ox + 62.0; + edit.y = oy + 24.0; + edit.width = 103.0; + edit.height = 12.0; + edit.bordered = false; + edit.focused = true; + edit.text_color = u32::MAX; + edit.max_length = ANVIL_NAME_CHARS; + edit.draw(batch, &self.gui.atlas, None); + } // ---------------------------------------------------------------- drawing @@ -1094,6 +1141,10 @@ impl Game<'_> { let (ox, oy) = self.inventory_origin(batch); let local = (self.cursor.0 - ox, self.cursor.1 - oy); let mut tooltip: Option> = None; + let mut anvil_name = false; + // Keep item tooltips as stacks until drawing: text alone loses the + // bundle contents component (including in the player's inventory). + let mut tooltip_stack: Option = None; { let atlas = &self.gui.atlas; batch.fill( @@ -1428,18 +1479,8 @@ impl Game<'_> { ); } if s.inputs[0].is_some() { - // AnvilScreen's name box: white, 103 wide, no inverted highlight. - horizon_client::ui::append_field( - batch, - atlas, - &s.name, - (ox + 62.0, oy + 24.0, 103.0), - (u32::MAX, true), - ANVIL_NAME_CHARS, - self.text_selection.covers(ANVIL_NAME, &s.name), - false, - s.opened.elapsed().as_millis(), - ); + // Drawn once this borrow of the station ends. + anvil_name = true; } let cost = s.anvil.cost; if cost > 0 { @@ -1579,13 +1620,16 @@ impl Game<'_> { ); self.draw_item(batch, &result, ox + x, oy + y); if hover { - tooltip = Some(self.stack_tooltip(&result)); + tooltip_stack = Some(result); } } } } } } + if anvil_name { + self.draw_anvil_name(batch, ox, oy); + } let drag = self.drag_view(); for i in self.station_slots().unwrap_or_default() { let Some((sx, sy)) = self.slot_position_any(i) else { @@ -1606,13 +1650,16 @@ impl Game<'_> { ); if self.carried.is_none() && tooltip.is_none() + && tooltip_stack.is_none() && let Some(stack) = self.slot_mut(slot).clone() { - tooltip = Some(self.stack_tooltip(&stack)); + tooltip_stack = Some(stack); } } if self.carried.is_some() { self.draw_carried(batch); + } else if let Some(stack) = tooltip_stack { + self.draw_stack_tooltip(batch, &stack, self.cursor.0, self.cursor.1); } else if let Some(lines) = tooltip { self.draw_tooltip_lines(batch, &lines, self.cursor.0, self.cursor.1); } @@ -1907,32 +1954,65 @@ impl Game<'_> { if lines.is_empty() { return; } - let lines: Vec<_> = lines + let lines = Self::resolved(lines); + let atlas = &self.gui.atlas; + let (x, y, w, h) = + Self::tooltip_geometry(atlas, &lines, (x, y), (batch.width, batch.height), 0.0); + Self::tooltip_box(batch, atlas, x, y, w, h); + Self::tooltip_text(batch, atlas, &lines, x, y); + } + /// A tooltip's lines with their legacy codes resolved and their colours. + fn resolved>( + lines: &[(T, u32)], + ) -> Vec<(horizon_client::text::Text, u32)> { + lines .iter() .map(|(text, color)| { let text: horizon_client::text::Text = text.clone().into(); (text.resolve_legacy(), *color) }) - .collect(); - let atlas = &self.gui.atlas; + .collect() + } + /// The tooltip's text's top-left corner and the box's size: beside the + /// cursor, kept on screen, `extra` pixels taller than the text. + fn tooltip_geometry( + atlas: &horizon_client::hud::HudAtlas, + lines: &[(horizon_client::text::Text, u32)], + (x, y): (f32, f32), + (width, height): (f32, f32), + extra: f32, + ) -> (f32, f32, f32, f32) { let w = lines .iter() .map(|(t, _)| atlas.font.width_text(t)) - .fold(0.0, f32::max); - let h = if lines.len() == 1 { + .fold(0.0, f32::max) + .max(if extra > 0.0 { 96.0 } else { 0.0 }); + let text_h = if lines.len() == 1 { 8.0 } else { 8.0 + 2.0 + (lines.len() - 1) as f32 * 10.0 }; + let h = text_h + extra; let mut x = x + 12.0; let mut y = y - 12.0; - if x + w > batch.width - 4.0 { + if x + w > width - 4.0 { x = (x - 28.0 - w).max(4.0); } - if y + h + 3.0 > batch.height { - y = batch.height - h - 3.0; + if y + h + 3.0 > height { + y = height - h - 3.0; } y = y.max(4.0); + (x, y, w, h) + } + /// The box and its frame sprites. + fn tooltip_box( + batch: &mut HudBatch, + atlas: &horizon_client::hud::HudAtlas, + x: f32, + y: f32, + w: f32, + h: f32, + ) { batch.fill(atlas, x - 3.0, y - 4.0, w + 6.0, 1.0, rgba(16, 0, 16, 240)); batch.fill( atlas, @@ -1968,12 +2048,137 @@ impl Game<'_> { h + 4.0, rgba(60, 0, 190, 80), ); + } + fn tooltip_text( + batch: &mut HudBatch, + atlas: &horizon_client::hud::HudAtlas, + lines: &[(horizon_client::text::Text, u32)], + x: f32, + y: f32, + ) { let mut ty = y; for (i, (text, color)) in lines.iter().enumerate() { batch.text_styled(atlas, text, x, ty, *color, true); ty += if i == 0 { 12.0 } else { 10.0 }; } } + /// A stack's tooltip: its lines, and under them a bundle's contents + /// (`ClientBundleTooltip`: the 4 wide grid, the `+N` of what it leaves + /// out, and the weight bar). + pub(super) fn draw_stack_tooltip( + &mut self, + batch: &mut HudBatch, + stack: &ItemStack, + x: f32, + y: f32, + ) { + let lines = Self::resolved(&self.stack_tooltip(stack)); + if lines.is_empty() { + return; + } + // The component's height does not depend on where it is drawn, so a + // probe at the origin gives the box its extra height. + let probe = horizon_client::bundle::tooltip_layout(self.res.items(), stack, 0.0, 0.0, 96.0); + let extra = probe.as_ref().map_or(0.0, |l| l.height + 2.0); + let atlas = &self.gui.atlas; + let (x, y, w, h) = + Self::tooltip_geometry(atlas, &lines, (x, y), (batch.width, batch.height), extra); + Self::tooltip_box(batch, atlas, x, y, w, h); + let text_h = h - extra; + Self::tooltip_text(batch, atlas, &lines, x, y); + let Some(layout) = + horizon_client::bundle::tooltip_layout(self.res.items(), stack, x, y + text_h + 2.0, w) + else { + return; + }; + self.draw_bundle_tooltip(batch, &layout); + } + /// `ClientBundleTooltip.extractImage`: the slots, the count past them and + /// the progress bar. + fn draw_bundle_tooltip( + &mut self, + batch: &mut HudBatch, + layout: &horizon_client::bundle::TooltipLayout, + ) { + for (at, stack) in &layout.slots { + // Each draw takes the atlas on its own: the item's needs `&mut self`. + horizon_client::ui::nine_slice( + batch, + &self.gui.atlas, + "gui/sprites/container/bundle/slot_background", + at[0], + at[1], + 24.0, + 24.0, + u32::MAX, + ); + let stack = stack.clone(); + let [x, y] = *at; + self.draw_item(batch, &stack, x + 4.0, y + 4.0); + } + let atlas = &self.gui.atlas; + if let Some((at, hidden)) = layout.overflow { + let label = horizon_client::text::Text::literal(format!("+{hidden}")); + let w = atlas.font.width_text(&label); + batch.text_styled( + atlas, + &label, + at[0] + 12.0 - (w / 2.0).floor(), + at[1] + 10.0, + u32::MAX, + true, + ); + } + if let Some((at, description)) = layout + .empty_description + .zip(Some("item.minecraft.bundle.empty.description")) + { + let text = horizon_client::text::Text::translate(description, &[]); + let mut ty = at[1]; + for line in atlas.font.split_lines(&text, layout.width) { + batch.text_styled(atlas, &line.0, at[0], ty, 0xFFAA_AAAA, false); + ty += 9.0; + } + } + let [bx, by] = layout.bar; + let fill_sprite = if layout.full { + "gui/sprites/container/bundle/bundle_progressbar_full" + } else { + "gui/sprites/container/bundle/bundle_progressbar_fill" + }; + horizon_client::ui::nine_slice( + batch, + atlas, + fill_sprite, + bx + 1.0, + by, + layout.fill, + 13.0, + u32::MAX, + ); + horizon_client::ui::nine_slice( + batch, + atlas, + "gui/sprites/container/bundle/bundle_progressbar_border", + bx, + by, + 96.0, + 13.0, + u32::MAX, + ); + if let Some(key) = layout.label { + let label = horizon_client::text::Text::translate(key, &[]); + let w = atlas.font.width_text(&label); + batch.text_styled( + atlas, + &label, + bx + 48.0 - (w / 2.0).floor(), + by + 3.0, + u32::MAX, + true, + ); + } + } /// Hovered-slot tooltip on the plain inventory, crafting and container screens. pub(super) fn draw_slot_tooltip(&mut self, batch: &mut HudBatch) { if self.carried.is_some() { @@ -1984,8 +2189,7 @@ impl Game<'_> { }; let stack = self.slot_view(slot); if let Some(stack) = stack { - let lines = self.stack_tooltip(&stack); - self.draw_tooltip_lines(batch, &lines, self.cursor.0, self.cursor.1); + self.draw_stack_tooltip(batch, &stack, self.cursor.0, self.cursor.1); } else if let Some(text) = self.crafter_tooltip(slot) { self.draw_tooltip_lines( batch, @@ -2041,5 +2245,13 @@ impl Game<'_> { } /// The anvil's rename box (`AnvilScreen`: `setMaxLength(50)`). -const ANVIL_NAME: horizon_client::clipboard::FieldId = ("anvil.name", 0); const ANVIL_NAME_CHARS: usize = 50; + +fn anvil_box() -> horizon_client::ui::EditBox { + let mut edit = horizon_client::ui::EditBox::new(0.0, 0.0, 103.0, 12.0); + edit.bordered = false; + edit.max_length = ANVIL_NAME_CHARS; + edit.text_color = u32::MAX; + edit.focused = true; + edit +} diff --git a/crates/horizon-client/src/game/trading.rs b/crates/horizon-client/src/game/trading.rs index 87e0c18c6..6986d8baa 100644 --- a/crates/horizon-client/src/game/trading.rs +++ b/crates/horizon-client/src/game/trading.rs @@ -803,8 +803,7 @@ impl Game<'_> { text.split('\n').map(|l| (l.to_owned(), u32::MAX)).collect(); self.draw_tooltip_lines(batch, &lines, self.cursor.0, self.cursor.1); } else if let Some(stack) = tooltip { - let lines = self.stack_tooltip(&stack); - self.draw_tooltip_lines(batch, &lines, self.cursor.0, self.cursor.1); + self.draw_stack_tooltip(batch, &stack, self.cursor.0, self.cursor.1); } true } diff --git a/crates/horizon-client/src/gfx.rs b/crates/horizon-client/src/gfx.rs index ca308060b..904370c04 100644 --- a/crates/horizon-client/src/gfx.rs +++ b/crates/horizon-client/src/gfx.rs @@ -65,6 +65,7 @@ mod arena; mod cull; mod end_sky; mod flat; +mod hdr; pub mod lightning; mod lod; mod native_material; @@ -504,6 +505,10 @@ pub struct Renderer { occlusion: occlusion::Occlusion, /// Resolution scale and FXAA (Horizon settings). world_post: world_post::Post, + /// HDR output (Horizon setting): `Some` while the swapchain is scRGB. + hdr: Option, + /// Whether the window's surface can present scRGB. + hdr_capable: bool, /// The shader pack's post-processing, and the dimension (legacy id) it was loaded for. pack_post: Option<(i32, Option)>, /// The post passes of one of Horizon's own shader packs; never beside `pack_post`'s. @@ -910,15 +915,24 @@ async fn open_device( limits.max_storage_buffer_binding_size, limits.max_texture_array_layers, )); - match adapter - .request_device(&wgpu::DeviceDescriptor { - label: Some("Horizon device"), - required_features: features, - required_limits: limits, - ..Default::default() - }) - .await - { + let desc = wgpu::DeviceDescriptor { + label: Some("Horizon device"), + required_features: features, + required_limits: limits, + ..Default::default() + }; + #[cfg(not(target_os = "macos"))] + let opened = match info.backend { + wgpu::Backend::Vulkan => horizon_hdr::open_vulkan_device(&adapter, &desc), + _ => None, + }; + #[cfg(target_os = "macos")] + let opened = None; + let opened = match opened { + Some(opened) => opened, + None => adapter.request_device(&desc).await, + }; + match opened { Ok((device, queue)) => { return Ok(Opened { instance, @@ -1043,7 +1057,7 @@ impl Renderer { let info = adapter.get_info(); crate::graphics::suggest_reduced_far_detail(crate::graphics::lod_capped(&info)); let size = window.inner_size(); - let (config, present_modes) = if let Some(surface) = &surface { + let (config, present_modes, hdr_capable) = if let Some(surface) = &surface { let mut config = surface .get_default_config(&adapter, size.width.max(1), size.height.max(1)) .ok_or("surface has no supported configuration")?; @@ -1071,7 +1085,7 @@ impl Renderer { )); } surface.configure(&device, &config); - (config, caps.present_modes.clone()) + (config, caps.present_modes.clone(), hdr::supported(&caps)) } else { let format = wgpu::TextureFormat::Bgra8Unorm; let config = wgpu::SurfaceConfiguration { @@ -1085,7 +1099,7 @@ impl Renderer { view_formats: vec![format], color_space: wgpu::SurfaceColorSpace::default(), }; - (config, Vec::new()) + (config, Vec::new(), false) }; let offscreen = surface .is_none() @@ -1929,14 +1943,20 @@ impl Renderer { compilation_options: Default::default(), targets: &[Some(wgpu::ColorTargetState { format: config.format.remove_srgb_suffix(), - // RenderPipelines.CELESTIAL: additive (src alpha, one). + // RenderPipelines.CELESTIAL: additive (src alpha, one). The + // alpha goes to 0: HDR output (hdr.wgsl) lets the sun and + // moon shine; nothing else reads the frame's alpha. blend: Some(wgpu::BlendState { color: wgpu::BlendComponent { src_factor: wgpu::BlendFactor::SrcAlpha, dst_factor: wgpu::BlendFactor::One, operation: wgpu::BlendOperation::Add, }, - alpha: wgpu::BlendComponent::OVER, + alpha: wgpu::BlendComponent { + src_factor: wgpu::BlendFactor::Zero, + dst_factor: wgpu::BlendFactor::Zero, + operation: wgpu::BlendOperation::Add, + }, }), write_mask: wgpu::ColorWrites::ALL, })], @@ -2420,6 +2440,8 @@ impl Renderer { block_entity_revision: next_block_entity_revision(), occlusion: occlusion::Occlusion::new(crate::chunk::MIN_Y, crate::chunk::HEIGHT / 16), world_post, + hdr: None, + hdr_capable, pack_post: None, native: None, pass_timing: pack_timing::PassTiming::logging(), @@ -2489,7 +2511,12 @@ impl Renderer { // Wayland allows only one tearing-control object per window surface. self.release_surface(); let surface = self.instance.create_surface(self.window.clone())?; - surface.configure(&self.device, &self.config); + Self::configure( + &self.device, + &surface, + &self.surface_config(), + self.hdr.as_ref(), + ); self.surface = Some(surface); Ok(()) } @@ -2552,7 +2579,12 @@ impl Renderer { && let Some(surface) = &self.surface { self.config.present_mode = mode; - surface.configure(&self.device, &self.config); + Self::configure( + &self.device, + surface, + &self.surface_config(), + self.hdr.as_ref(), + ); } } pub fn resize(&mut self, width: u32, height: u32) { @@ -2563,7 +2595,12 @@ impl Renderer { self.config.width = width; self.config.height = height; if let Some(surface) = &self.surface { - surface.configure(&self.device, &self.config); + Self::configure( + &self.device, + surface, + &self.surface_config(), + self.hdr.as_ref(), + ); } else { self.offscreen = Some(Self::offscreen_target(&self.device, &self.config)); } @@ -2895,6 +2932,63 @@ impl Renderer { ); } /// Horizon's resolution scale (world pixels per window pixel) and FXAA. + /// Configures `surface` and, while HDR output is on, sends its HDR metadata + /// again: a new swapchain starts without it. + fn configure( + device: &wgpu::Device, + surface: &wgpu::Surface<'_>, + config: &wgpu::SurfaceConfiguration, + hdr: Option<&hdr::Hdr>, + ) { + surface.configure(device, config); + if let Some(hdr) = hdr { + horizon_hdr::set_metadata(device, surface, hdr.paper_white, hdr.peak); + } + } + fn configure_surface(&self) { + if let Some(surface) = &self.surface { + Self::configure( + &self.device, + surface, + &self.surface_config(), + self.hdr.as_ref(), + ); + } + } + fn send_hdr_metadata(&self) { + if let (Some(surface), Some(hdr)) = (&self.surface, &self.hdr) { + horizon_hdr::set_metadata(&self.device, surface, hdr.paper_white, hdr.peak); + } + } + /// The swapchain's configuration: `config` (what every pipeline draws in), or + /// scRGB while HDR output is on. + fn surface_config(&self) -> wgpu::SurfaceConfiguration { + let mut config = self.config.clone(); + if self.hdr.is_some() { + config.format = hdr::FORMAT; + config.view_formats = vec![hdr::FORMAT]; + config.color_space = hdr::COLOR_SPACE; + config.usage = wgpu::TextureUsages::RENDER_ATTACHMENT; + } + config + } + /// HDR output (Horizon setting): scRGB at `paper_white` nits, the world's + /// highlights expanded up to `peak` nits. Off where the surface can't present it. + pub fn set_hdr(&mut self, on: bool, paper_white: f32, peak: f32) { + let on = on && self.hdr_capable && self.surface.is_some(); + if on != self.hdr.is_some() { + self.hdr = + on.then(|| hdr::Hdr::new(&self.device, self.config.format.remove_srgb_suffix())); + self.configure_surface(); + } + if let Some(hdr) = &mut self.hdr + && (hdr.paper_white, hdr.peak) != (paper_white, peak) + { + hdr.paper_white = paper_white; + hdr.peak = peak; + self.send_hdr_metadata(); + } + } pub fn set_world_post(&mut self, scale: f32, antialias: bool) { self.world_post.scale = scale.clamp(0.25, 2.0); self.world_post.antialias = antialias; @@ -3230,7 +3324,12 @@ impl Renderer { } Some(wgpu::CurrentSurfaceTexture::Outdated) => { if let Some(surface) = &self.surface { - surface.configure(&self.device, &self.config); + Self::configure( + &self.device, + surface, + &self.surface_config(), + self.hdr.as_ref(), + ); } return Ok(false); } @@ -3242,9 +3341,11 @@ impl Renderer { return Err("surface acquisition failed validation".into()); } }; - let target_texture = match &surface_frame { - Some(f) => f.texture.clone(), - None => self.offscreen.clone().ok_or("no offscreen target")?, + let size = [self.config.width, self.config.height]; + let target_texture = match (&surface_frame, &mut self.hdr) { + (Some(_), Some(hdr)) => hdr.frame(&self.device, size), + (Some(f), None) => f.texture.clone(), + (None, _) => self.offscreen.clone().ok_or("no offscreen target")?, }; // One command buffer for the frame, after the section copies staged // since the last one: Metal commits every command buffer wgpu-core @@ -4642,6 +4743,9 @@ impl Renderer { } else if scaled.is_some() { self.world_post.finish(&mut encoder, &view_target); } + if let Some(hdr) = &self.hdr { + hdr.keep_world(&mut encoder); + } if hand_quads > 0 && !pack_draws_hand { let attachments = [Some(wgpu::RenderPassColorAttachment { view: &view_target, @@ -4796,6 +4900,9 @@ impl Renderer { self.section_copy_bytes = 0; self.section_uploads.finish(&encoder); } + if let (Some(hdr), Some(f)) = (&self.hdr, &surface_frame) { + hdr.present(&self.queue, &mut encoder, &f.texture, !frame.title); + } let commands = crate::spans::time("encode", || encoder.finish()); let first_frame = self.first_frame == FirstFrame::Submit; if first_frame { @@ -4832,7 +4939,12 @@ impl Renderer { } self.queue.present(surface_frame); if reconfigure && let Some(surface) = &self.surface { - surface.configure(&self.device, &self.config); + Self::configure( + &self.device, + surface, + &self.surface_config(), + self.hdr.as_ref(), + ); } } else { // No swapchain paces offscreen frames: keep two on the GPU at most. diff --git a/crates/horizon-client/src/gfx/hdr.rs b/crates/horizon-client/src/gfx/hdr.rs new file mode 100644 index 000000000..11deed546 --- /dev/null +++ b/crates/horizon-client/src/gfx/hdr.rs @@ -0,0 +1,222 @@ +//! HDR output (Horizon setting, off by default): the frame renders exactly as +//! without it, into an 8-bit target in vanilla's gamma space, and one pass +//! (`hdr.wgsl`) writes it to an scRGB swapchain at the player's paper white, +//! expanding the world's highlights towards their peak brightness. The world +//! is copied aside before the hand and HUD so only it is expanded. + +/// The swapchain format and colour space HDR output presents in. +pub const FORMAT: wgpu::TextureFormat = wgpu::TextureFormat::Rgba16Float; +pub const COLOR_SPACE: wgpu::SurfaceColorSpace = wgpu::SurfaceColorSpace::ExtendedSrgbLinear; + +/// Whether `caps` can present scRGB. +pub fn supported(caps: &wgpu::SurfaceCapabilities) -> bool { + caps.color_spaces(FORMAT) + .contains(wgpu::SurfaceColorSpaces::EXTENDED_SRGB_LINEAR) +} + +struct Targets { + size: [u32; 2], + frame: wgpu::Texture, + world: wgpu::Texture, + group: wgpu::BindGroup, +} + +pub struct Hdr { + layout: wgpu::BindGroupLayout, + pipeline: wgpu::RenderPipeline, + params: wgpu::Buffer, + /// The frame's format: what every other pipeline draws in. + format: wgpu::TextureFormat, + targets: Option, + /// `HORIZON_HDR_DEBUG=1`: paint expanded pixels magenta. + debug: bool, + /// Paper white and peak brightness, in nits. + pub paper_white: f32, + pub peak: f32, +} + +impl Hdr { + pub fn new(device: &wgpu::Device, format: wgpu::TextureFormat) -> Self { + let shader = device.create_shader_module(wgpu::ShaderModuleDescriptor { + label: Some("Horizon HDR"), + source: wgpu::ShaderSource::Wgsl(include_str!("../hdr.wgsl").into()), + }); + let texture = |binding| wgpu::BindGroupLayoutEntry { + binding, + visibility: wgpu::ShaderStages::FRAGMENT, + ty: wgpu::BindingType::Texture { + sample_type: wgpu::TextureSampleType::Float { filterable: false }, + view_dimension: wgpu::TextureViewDimension::D2, + multisampled: false, + }, + count: None, + }; + let layout = device.create_bind_group_layout(&wgpu::BindGroupLayoutDescriptor { + label: Some("Horizon HDR bindings"), + entries: &[ + texture(0), + texture(1), + wgpu::BindGroupLayoutEntry { + binding: 2, + visibility: wgpu::ShaderStages::FRAGMENT, + ty: wgpu::BindingType::Buffer { + ty: wgpu::BufferBindingType::Uniform, + has_dynamic_offset: false, + min_binding_size: None, + }, + count: None, + }, + ], + }); + let pipeline_layout = device.create_pipeline_layout(&wgpu::PipelineLayoutDescriptor { + label: Some("Horizon HDR"), + bind_group_layouts: &[Some(&layout)], + ..Default::default() + }); + let pipeline = device.create_render_pipeline(&wgpu::RenderPipelineDescriptor { + label: Some("Horizon HDR"), + layout: Some(&pipeline_layout), + vertex: wgpu::VertexState { + module: &shader, + entry_point: Some("vs_hdr"), + compilation_options: Default::default(), + buffers: &[], + }, + primitive: Default::default(), + depth_stencil: None, + multisample: Default::default(), + fragment: Some(wgpu::FragmentState { + module: &shader, + entry_point: Some("fs_hdr"), + compilation_options: Default::default(), + targets: &[Some(wgpu::ColorTargetState { + format: FORMAT, + blend: None, + write_mask: wgpu::ColorWrites::ALL, + })], + }), + multiview_mask: None, + cache: None, + }); + let params = device.create_buffer(&wgpu::BufferDescriptor { + label: Some("Horizon HDR parameters"), + size: 16, + usage: wgpu::BufferUsages::UNIFORM | wgpu::BufferUsages::COPY_DST, + mapped_at_creation: false, + }); + Self { + layout, + pipeline, + params, + format, + targets: None, + debug: std::env::var_os("HORIZON_HDR_DEBUG").is_some_and(|v| v == "1"), + paper_white: 200.0, + peak: 1000.0, + } + } + + /// The 8-bit frame every pass draws into this frame, sized like the window. + pub fn frame(&mut self, device: &wgpu::Device, size: [u32; 2]) -> wgpu::Texture { + if self.targets.as_ref().is_none_or(|t| t.size != size) { + let texture = |label, usage| { + device.create_texture(&wgpu::TextureDescriptor { + label: Some(label), + size: wgpu::Extent3d { + width: size[0].max(1), + height: size[1].max(1), + depth_or_array_layers: 1, + }, + mip_level_count: 1, + sample_count: 1, + dimension: wgpu::TextureDimension::D2, + format: self.format, + usage: usage | wgpu::TextureUsages::TEXTURE_BINDING, + view_formats: &[], + }) + }; + let frame = texture( + "Horizon HDR frame", + wgpu::TextureUsages::RENDER_ATTACHMENT | wgpu::TextureUsages::COPY_SRC, + ); + let world = texture("Horizon HDR world", wgpu::TextureUsages::COPY_DST); + let view = |t: &wgpu::Texture| t.create_view(&Default::default()); + let group = device.create_bind_group(&wgpu::BindGroupDescriptor { + label: Some("Horizon HDR bindings"), + layout: &self.layout, + entries: &[ + wgpu::BindGroupEntry { + binding: 0, + resource: wgpu::BindingResource::TextureView(&view(&frame)), + }, + wgpu::BindGroupEntry { + binding: 1, + resource: wgpu::BindingResource::TextureView(&view(&world)), + }, + wgpu::BindGroupEntry { + binding: 2, + resource: self.params.as_entire_binding(), + }, + ], + }); + self.targets = Some(Targets { + size, + frame, + world, + group, + }); + } + self.targets.as_ref().unwrap().frame.clone() + } + + /// Keeps the world as drawn so far, before the hand and HUD cover it. + pub fn keep_world(&self, encoder: &mut wgpu::CommandEncoder) { + let Some(t) = &self.targets else { + return; + }; + encoder.copy_texture_to_texture( + t.frame.as_image_copy(), + t.world.as_image_copy(), + t.frame.size(), + ); + } + + /// Writes the finished frame to the swapchain image `target`. + pub fn present( + &self, + queue: &wgpu::Queue, + encoder: &mut wgpu::CommandEncoder, + target: &wgpu::Texture, + world: bool, + ) { + let Some(t) = &self.targets else { + return; + }; + let paper = self.paper_white.max(1.0); + let params = [ + paper / 80.0, + (self.peak / paper).max(1.0), + f32::from(u8::from(world)), + f32::from(u8::from(self.debug)), + ]; + queue.write_buffer(&self.params, 0, bytemuck::cast_slice(¶ms)); + let view = target.create_view(&Default::default()); + let attachments = [Some(wgpu::RenderPassColorAttachment { + view: &view, + resolve_target: None, + depth_slice: None, + ops: wgpu::Operations { + load: wgpu::LoadOp::Clear(wgpu::Color::BLACK), + store: wgpu::StoreOp::Store, + }, + })]; + let mut pass = encoder.begin_render_pass(&wgpu::RenderPassDescriptor { + label: Some("Horizon HDR"), + color_attachments: &attachments, + ..Default::default() + }); + pass.set_pipeline(&self.pipeline); + pass.set_bind_group(0, &t.group, &[]); + pass.draw(0..3, 0..1); + } +} diff --git a/crates/horizon-client/src/gfx/native_material.rs b/crates/horizon-client/src/gfx/native_material.rs index 8e54caf12..e7f8f7bf2 100644 --- a/crates/horizon-client/src/gfx/native_material.rs +++ b/crates/horizon-client/src/gfx/native_material.rs @@ -36,7 +36,7 @@ fn horizon_material_vertex(position: vec3, uv: vec2, layer: u32, color out.clip = horizon_terrain_globals.view_proj * vec4(pos, 1.0); out.uv = uv; out.layer = layer; - out.tint = color; + out.tint = vec4(color.rgb, 1.0); let block = max(f32(light.y), horizon_terrain_dynamic_block_light(pos)); let sky = f32(light.x); // 16 per level, 15 levels. diff --git a/crates/horizon-client/src/gfx/pack_atlas.rs b/crates/horizon-client/src/gfx/pack_atlas.rs index 42a2abee1..c7a67a50b 100644 --- a/crates/horizon-client/src/gfx/pack_atlas.rs +++ b/crates/horizon-client/src/gfx/pack_atlas.rs @@ -169,6 +169,7 @@ impl PackAtlas { ]; let columns = self.columns; // UVs past a sprite (models up to 2, distant tiles) cannot repeat in an atlas: clamped. + // The colour's alpha holds HDR's emission level (`mesher::EMISSION_BITS`): packs get 1. let body = format!( " vec4 hz_origin = {origin};\n \ uint hz_layer = hz_v_layer & 32767u;\n \ @@ -178,7 +179,7 @@ impl PackAtlas { hz_MultiTexCoord0 = vec4((hz_cell + clamp(vec2(hz_v_uv) * hz_origin.w, 0.0, 1.0)) * hz_scale, 0.0, 1.0);\n \ hz_MultiTexCoord1 = vec4(float(hz_v_light.y), float(hz_v_light.x), 0.0, 1.0);\n \ hz_MultiTexCoord2 = hz_MultiTexCoord1;\n \ - hz_Color = hz_v_color;\n \ + hz_Color = vec4(hz_v_color.rgb, 1.0);\n \ hz_Normal = vec3(0.0, 1.0, 0.0);\n \ hz_tangent = vec4(1.0, 0.0, 0.0, 1.0);\n", scale[0], scale[1], diff --git a/crates/horizon-client/src/graphics.rs b/crates/horizon-client/src/graphics.rs index b34b55288..4f6f04bc0 100644 --- a/crates/horizon-client/src/graphics.rs +++ b/crates/horizon-client/src/graphics.rs @@ -255,6 +255,12 @@ pub struct Graphics { pub resolution_scale: u32, /// FXAA over the world. pub fxaa: bool, + /// HDR output (scRGB), where the display path offers it. + pub hdr: bool, + /// HDR paper white (where SDR white sits), in nits. + pub hdr_paper_white: u32, + /// HDR peak brightness the world's highlights reach, in nits. + pub hdr_peak: u32, /// Battery mode: at most 60 frames per second in a world and 30 in menus /// or behind other windows, and half the worker threads. Off by default; /// it changes when frames are drawn, never what they show or the ticks. @@ -286,6 +292,9 @@ impl Default for Graphics { overlay: Overlay::Off, resolution_scale: 100, fxaa: false, + hdr: false, + hdr_paper_white: 200, + hdr_peak: 1000, battery: false, api: GraphicsApi::Auto, shader_pack: String::new(), @@ -337,6 +346,9 @@ impl Graphics { "workers" => g.workers = number(g.workers).min(64), "resolutionScale" => g.resolution_scale = number(g.resolution_scale).clamp(50, 200), "fxaa" => g.fxaa = flag(g.fxaa), + "hdr" => g.hdr = flag(g.hdr), + "hdrPaperWhite" => g.hdr_paper_white = number(g.hdr_paper_white).clamp(80, 480), + "hdrPeak" => g.hdr_peak = number(g.hdr_peak).clamp(200, 2000), "batteryMode" => g.battery = flag(g.battery), "graphicsApi" => g.api = GraphicsApi::from_name(value).unwrap_or_default(), "pickedShaderPack" => g.shader_pack = value.to_owned(), @@ -354,7 +366,7 @@ impl Graphics { } pub fn serialize(&self) -> String { format!( - "preset:{}\nlodDistance:{}\nfarDetail:{}\ncaveCulling:{}\nentityCulling:{}\nchunkUpdates:{}\nuploadBudgetKiB:{}\nsky:{}\nfog:{}\nweather:{}\nanimatedTextures:{}\npresentMode:{}\nframePacing:{}\nworkers:{}\noverlay:{}\nresolutionScale:{}\nfxaa:{}\nbatteryMode:{}\ngraphicsApi:{}\npickedShaderPack:{}\n", + "preset:{}\nlodDistance:{}\nfarDetail:{}\ncaveCulling:{}\nentityCulling:{}\nchunkUpdates:{}\nuploadBudgetKiB:{}\nsky:{}\nfog:{}\nweather:{}\nanimatedTextures:{}\npresentMode:{}\nframePacing:{}\nworkers:{}\noverlay:{}\nresolutionScale:{}\nfxaa:{}\nhdr:{}\nhdrPaperWhite:{}\nhdrPeak:{}\nbatteryMode:{}\ngraphicsApi:{}\npickedShaderPack:{}\n", self.preset.name(), self.lod_distance, self.far_detail.name(), @@ -379,6 +391,9 @@ impl Graphics { }, self.resolution_scale, bool_text(self.fxaa), + bool_text(self.hdr), + self.hdr_paper_white, + self.hdr_peak, bool_text(self.battery), self.api.name(), self.shader_pack, @@ -476,6 +491,9 @@ mod tests { overlay: Overlay::Graph, resolution_scale: 75, fxaa: true, + hdr: true, + hdr_paper_white: 240, + hdr_peak: 1400, battery: true, api: GraphicsApi::Dx12, shader_pack: "Golden Hour".into(), diff --git a/crates/horizon-client/src/graphics_ui.rs b/crates/horizon-client/src/graphics_ui.rs index ba99f89a8..3c7a40e02 100644 --- a/crates/horizon-client/src/graphics_ui.rs +++ b/crates/horizon-client/src/graphics_ui.rs @@ -37,6 +37,9 @@ pub enum H { Overlay, ResolutionScale, Antialiasing, + Hdr, + HdrPaperWhite, + HdrPeak, BatteryMode, GraphicsApi, } @@ -221,6 +224,21 @@ pub fn rows(level: Level) -> Vec { Medium, "FXAA smooths jagged edges of the world; slightly softer image.", ), + h( + H::Hdr, + None, + "HDR output on an HDR display: lava, fire and sunlight shine brighter.", + ), + h( + H::HdrPaperWhite, + None, + "HDR: how bright white paper and menus look. Match your desktop.", + ), + h( + H::HdrPeak, + None, + "HDR: how bright the brightest highlights get. Your display's peak.", + ), h( H::PresentMode, None, @@ -324,6 +342,8 @@ impl H { } H::Workers => Some(g.workers as f32 / max_workers() as f32), H::ResolutionScale => Some((g.resolution_scale as f32 - 50.0) / 150.0), + H::HdrPaperWhite => Some((g.hdr_paper_white as f32 - 80.0) / 400.0), + H::HdrPeak => Some((g.hdr_peak as f32 - 200.0) / 1800.0), _ => None, } } @@ -365,6 +385,9 @@ impl H { }, H::ResolutionScale => labelled("Resolution Scale", format!("{}%", g.resolution_scale)), H::Antialiasing => labelled("Anti-aliasing", if g.fxaa { "FXAA" } else { "Off" }), + H::Hdr => labelled("HDR", on_off(g.hdr)), + H::HdrPaperWhite => labelled("Paper White", format!("{} nits", g.hdr_paper_white)), + H::HdrPeak => labelled("Peak Brightness", format!("{} nits", g.hdr_peak)), H::BatteryMode => labelled("Battery Mode", on_off(g.battery)), H::GraphicsApi => labelled("Graphics API", g.api.label()), H::Overlay => labelled( @@ -387,6 +410,8 @@ impl H { } H::Workers => g.workers = (v * max_workers() as f32).round() as u32, H::ResolutionScale => g.resolution_scale = (50.0 + (v * 30.0).round() * 5.0) as u32, + H::HdrPaperWhite => g.hdr_paper_white = (80.0 + (v * 40.0).round() * 10.0) as u32, + H::HdrPeak => g.hdr_peak = (200.0 + (v * 36.0).round() * 50.0) as u32, _ => {} } } @@ -418,6 +443,7 @@ impl H { H::AnimatedTextures => g.animated_textures = !g.animated_textures, H::PresentMode => g.present_mode = step(&PresentMode::ALL, g.present_mode, back), H::Antialiasing => g.fxaa = !g.fxaa, + H::Hdr => g.hdr = !g.hdr, H::BatteryMode => g.battery = !g.battery, H::GraphicsApi => g.api = step(&GraphicsApi::ALL, g.api, back), H::Pacing => { @@ -453,6 +479,7 @@ impl Item { Item::Horizon(H::Weather) => g.weather, Item::Horizon(H::AnimatedTextures) => g.animated_textures, Item::Horizon(H::Antialiasing) => g.fxaa, + Item::Horizon(H::Hdr) => g.hdr, Item::Horizon(H::BatteryMode) => g.battery, Item::Vanilla(Opt::ViewBobbing) => s.view_bobbing, Item::Vanilla(Opt::Vsync) => s.vsync, diff --git a/crates/horizon-client/src/hdr.wgsl b/crates/horizon-client/src/hdr.wgsl new file mode 100644 index 000000000..bf6c27cca --- /dev/null +++ b/crates/horizon-client/src/hdr.wgsl @@ -0,0 +1,69 @@ +// Horizon's HDR output pass: the frame, drawn as without HDR in vanilla's gamma +// space, decoded to linear light at the paper white and written to the scRGB +// swapchain (1.0 = 80 nits). Bright pixels of light sources that still show the +// world as it was before the hand and HUD are expanded towards the peak. +@group(0) @binding(0) var frame: texture_2d; +@group(0) @binding(1) var world: texture_2d; + +struct Params { + // Paper white in scRGB units (nits / 80). + paper: f32, + // Peak brightness relative to paper white; 1 expands nothing. + peak: f32, + // 1 when this frame drew a world. + world: f32, + // 1 paints expanded pixels magenta (HORIZON_HDR_DEBUG=1). + debug: f32, +}; +@group(0) @binding(2) var params: Params; + +// Light sources are lifted evenly rather than by a highlight curve: vanilla's +// textures were drawn for SDR, so a curve on their brightest pixels blows out +// near-white spots (glowstone) and leaves the rest (lava, a jack o'lantern's +// face) nearly as it was. Pixels brighter than LIFT_FULL get STRENGTH of the +// headroom, dimmer ones less down to none at LIFT_START (lava's crust, a +// lantern's metal), and no channel goes past the peak. Brightness is the mean +// of luminance and the brightest channel, so saturated light counts as bright. +const LIFT_START: f32 = 0.18; +const LIFT_FULL: f32 = 0.42; +const STRENGTH: f32 = 0.7; + +// Whether `c` still shows the world pixel `w`: the same, or darkened evenly +// across its channels, as the vignette and other screen-wide tints darken it. +// The hand, HUD and text replace pixels instead, so they never pass. +fn shows_world(c: vec3, w: vec3) -> bool { + if all(c == w) { + return true; + } + let k = c / max(w, vec3(1.0 / 255.0)); + let mean = (k.r + k.g + k.b) / 3.0; + return mean <= 1.01 && mean > 0.5 && all(abs(k - vec3(mean)) < vec3(0.03)); +} + +@vertex fn vs_hdr(@builtin(vertex_index) i: u32) -> @builtin(position) vec4 { + let p = vec2(f32((i << 1u) & 2u), f32(i & 2u)); + return vec4(p * 2.0 - 1.0, 0.0, 1.0); +} + +@fragment fn fs_hdr(@builtin(position) pos: vec4) -> @location(0) vec4 { + let at = vec2(pos.xy); + let c = textureLoad(frame, at, 0).rgb; + // Gamma 2.2, as SDR displays and the compositors' SDR paths decode it. + var light = pow(max(c, vec3(0.0)), vec3(2.2)); + let w = textureLoad(world, at, 0); + // The world's alpha is 0 on light-emitting blocks, the sun and the moon + // (terrain.wgsl, the celestial pipeline): only those shine. + if params.world > 0.5 && params.peak > 1.0 && w.a < 0.75 && shows_world(c, w.rgb) { + let y = 0.5 * (dot(light, vec3(0.2126, 0.7152, 0.0722)) + max(light.r, max(light.g, light.b))); + let lift = smoothstep(LIFT_START, LIFT_FULL, y); + if lift > 0.0 { + let top = max(light.r, max(light.g, light.b)); + let gain = min(1.0 + (params.peak - 1.0) * STRENGTH * lift, params.peak / max(top, 1e-4)); + light *= max(gain, 1.0); + if params.debug > 0.5 { + light = mix(light, vec3(gain, 0.0, gain), 0.6); + } + } + } + return vec4(light * params.paper, 1.0); +} diff --git a/crates/horizon-client/src/item_sync.rs b/crates/horizon-client/src/item_sync.rs index 930304ec4..d18ed3af5 100644 --- a/crates/horizon-client/src/item_sync.rs +++ b/crates/horizon-client/src/item_sync.rs @@ -238,6 +238,46 @@ mod tests { use super::*; use horizon_protocol::registry::Ids; + /// A bundle's contents cross the wire, so a server's client can draw + /// its tooltip (BundleContents' stream codec: a list of templates). + #[test] + fn a_bundle_keeps_its_contents_across_the_wire() { + let mut components = vec![String::new(); 60]; + components[component::BUNDLE_CONTENTS as usize] = "minecraft:bundle_contents".into(); + let items = ["minecraft:air", "minecraft:bundle", "minecraft:stone"]; + let builtin = Builtin { + registries: [ + ( + "minecraft:item".to_owned(), + Ids::from_names(items.iter().map(|s| s.to_string()).collect()), + ), + ( + "minecraft:data_component_type".to_owned(), + Ids::from_names(components), + ), + ] + .into(), + }; + let dynamic = Dynamic { + registries: Default::default(), + }; + let mut bundle = ItemStack::new("minecraft:bundle", 1); + bundle.data_mut().bundle_contents = vec![ItemStack::new("minecraft:stone", 32)]; + let wire = crate::lan::guest::stack_to_network( + |name| items.iter().position(|i| *i == name).unwrap_or(0) as i32, + |_, _| None, + &Some(bundle), + ) + .unwrap(); + let back = from_network(&wire, &builtin, &dynamic); + let contents = &back.data().expect("components").bundle_contents; + assert_eq!(contents.len(), 1); + assert_eq!( + (&*contents[0].item, contents[0].count), + ("minecraft:stone", 32) + ); + } + /// What a creative client sends (`stack_to_network`) comes back whole on /// the server: damage, both enchantment lists, repair cost, name, trim. #[test] diff --git a/crates/horizon-client/src/items.rs b/crates/horizon-client/src/items.rs index 8ac450bcb..e34471966 100644 --- a/crates/horizon-client/src/items.rs +++ b/crates/horizon-client/src/items.rs @@ -120,6 +120,8 @@ pub struct ItemInfo { pub crafting_remainder: Option, /// `dye`: the dye colour name (dyes, and anything else with the component). pub dye: Option, + /// `cushion/color`: the DyeColor name of a cushion item. + pub cushion_color: Option, /// `block_transformer`: the registry entry an axe, hoe or shovel uses on blocks. pub block_transformer: Option, /// Has a default `bundle_contents` (the bundles, `BundleItem`). @@ -251,6 +253,10 @@ pub struct Items { loot: HashMap, /// The `jukebox_song` registry. pub songs: HashMap, + /// The enchantment registry: loot functions enchant the items they roll + /// (`EnchantWithLevelsFunction`, `EnchantRandomlyFunction`), and the + /// station menus share this copy. + pub enchantments: Arc, } /// A `JukeboxSong`. #[derive(Clone, Debug)] @@ -599,6 +605,7 @@ impl Items { .map(str::to_owned), jukebox_song: c["minecraft:jukebox_playable"].as_str().map(str::to_owned), dye: c["minecraft:dye"].as_str().map(str::to_owned), + cushion_color: c["minecraft:cushion/color"].as_str().map(str::to_owned), block_transformer: c["minecraft:block_transformer"].as_str().map(str::to_owned), bundle: c.get("minecraft:bundle_contents").is_some(), crafting_remainder: CRAFT_REMAINDERS @@ -701,12 +708,15 @@ impl Items { item_tag_order: load_tag_lists(root, "item")?, loot, songs: load_songs(root), + enchantments: Arc::new(crate::enchant::Enchantments::load(root)), }) } pub fn get(&self, id: &str) -> Option<&ItemInfo> { self.items.get(id) } - /// Only the block and item tags, for tools that need tag membership. + /// Only the block and item tags (and the enchantment registry, which the + /// station rules and loot functions are built from), for tools that need + /// tag membership. pub fn tags_only(root: &Path) -> Result { Ok(Self { items: HashMap::new(), @@ -717,6 +727,7 @@ impl Items { item_tag_order: load_tag_lists(root, "item")?, loot: HashMap::new(), songs: HashMap::new(), + enchantments: Arc::new(crate::enchant::Enchantments::load(root)), }) } /// An item table with only tags, for unit tests of item rules. @@ -734,6 +745,7 @@ impl Items { item_tags, loot: HashMap::new(), songs: HashMap::new(), + enchantments: Arc::new(crate::enchant::Enchantments::default()), } } /// Whether `block` is in the block tag `tag` (`minecraft:fire`, no `#`). @@ -1371,6 +1383,16 @@ impl LootContext<'_> { self.modifiers(&modifiers, &mut stack, random); produced.push(stack); } + /// An enchantment function's `options` (`HolderSet`): a tag, a list or + /// one id; every enchantment when absent (`registryAccess().listElements`). + fn enchant_pool(e: &crate::enchant::Enchantments, options: &Value) -> Vec> { + match options { + Value::String(s) if s.starts_with('#') => e.tag(s).to_vec(), + Value::String(s) => vec![Arc::from(s.as_str())], + Value::Array(a) => a.iter().filter_map(|x| x.as_str().map(Arc::from)).collect(), + _ => e.list.iter().map(|x| Arc::clone(&x.id)).collect(), + } + } fn modifiers(&self, m: &Value, stack: &mut ItemStack, random: &mut R) { let list: Vec<&Value> = match m { Value::Array(a) => a.iter().collect(), @@ -1449,6 +1471,54 @@ impl LootContext<'_> { .with_potion(id); } } + // EnchantWithLevelsFunction: EnchantmentHelper.enchantItem on + // the context's random (the End cities' gear). + "minecraft:enchant_with_levels" => { + let cost = Self::int_number(&f["levels"], random); + let e = &self.items.enchantments; + let pool = Self::enchant_pool(e, &f["options"]); + let chosen = e.select(self.items, random, &stack.item, cost, &pool); + // EnchantmentHelper.enchantItem: a book becomes one + // enchanted book (the fresh stack's count). + if &*stack.item == "minecraft:book" { + *stack = ItemStack::new("minecraft:enchanted_book", 1); + } + for (id, level) in chosen { + stack.enchant(&id, level); + } + } + // EnchantRandomlyFunction: one enchantment the item accepts, + // at a level between its min and max. + "minecraft:enchant_randomly" => { + let e = &self.items.enchantments; + let book = &*stack.item == "minecraft:book"; + let only_compatible = f["only_compatible"].as_bool().unwrap_or(true); + let options: Vec> = Self::enchant_pool(e, &f["options"]) + .into_iter() + .filter(|id| { + book || !only_compatible || e.can_enchant(self.items, id, &stack.item) + }) + .collect(); + if options.is_empty() { + continue; + } + let id = options + [random.next_int_bound(options.len() as i32).unwrap_or(0) as usize] + .clone(); + let max = e.get(&id).map_or(1, |d| d.max_level).max(1); + // `Mth.nextInt(random, 1, max)`: a single-level + // enchantment (Mending) returns 1 without drawing, so the + // rolls after this one keep vanilla's sequence. + let level = if max <= 1 { + 1 + } else { + 1 + random.next_int_bound(max as i32).unwrap_or(0) as u32 + }; + if book { + *stack = ItemStack::new("minecraft:enchanted_book", 1); + } + stack.enchant(&id, level); + } "minecraft:limit_count" => { let limit = &f["limit"]; if let Some(min) = limit["min"].as_i64() { @@ -1658,6 +1728,102 @@ mod tests { assert_eq!(drops[0].potion(), Some("minecraft:fire_resistance")); } + /// `/loot give` and every other table this dispatcher rolls: the two + /// enchantment functions (`EnchantWithLevelsFunction`, + /// `EnchantRandomlyFunction`) put their enchantments on the stack. + #[test] + fn loot_enchant_functions_enchant_the_rolled_item() { + let root = std::path::PathBuf::from(env!("CARGO_MANIFEST_DIR")) + .join("../../.local/horizon-client/26.3"); + if !root.join("items.json").exists() { + return; + } + let assets = crate::assets::Assets::load(&root).unwrap(); + let facts = crate::blocks::BlockFacts::load(&root, assets.registry).unwrap(); + let items = Items::load(&root, assets.registry, &facts).unwrap(); + let props = BTreeMap::new(); + let mut random = LegacyRandom::new(11); + // A sword at levels 20..39 comes out enchanted, as in an End city. + let levels = json!({"pools":[{"rolls":1,"entries":[{"type":"minecraft:item", + "name":"minecraft:diamond_sword","modifier":[ + {"type":"minecraft:enchant_with_levels","levels":{"type":"minecraft:uniform","min":20.0,"max":39.0}}]}]}]}); + let mut enchanted = 0; + for _ in 0..40 { + let drops = ctx(&items, None, &props, "").evaluate(&levels, &mut random); + if drops[0].enchantments().is_empty() { + continue; + } + enchanted += 1; + assert_eq!(&*drops[0].item, "minecraft:diamond_sword"); + // Levels stay within the enchantment's range. + for (id, level) in drops[0].enchantments() { + let max = items + .enchantments + .get(id) + .expect("a known enchantment") + .max_level; + assert!((1..=max).contains(level), "{id} at {level}"); + } + } + assert!( + enchanted > 30, + "only {enchanted} of 40 rolls were enchanted" + ); + // `enchant_randomly` on a book makes one enchanted book, its levels + // stored; the pool is the enchantment tag it names. + let book = json!({"pools":[{"rolls":1,"entries":[{"type":"minecraft:item", + "name":"minecraft:book","modifier":[ + {"type":"minecraft:enchant_randomly","options":"#minecraft:on_random_loot"}]}]}]}); + let drops = ctx(&items, None, &props, "").evaluate(&book, &mut random); + assert_eq!(&*drops[0].item, "minecraft:enchanted_book"); + assert_eq!(drops[0].count, 1); + assert!(drops[0].enchantments().is_empty()); + let stored = drops[0].stored_enchantments(); + assert_eq!(stored.len(), 1, "{stored:?}"); + assert!( + items + .enchantments + .in_tag("minecraft:on_random_loot", &stored[0].0) + ); + // An item no enchantment accepts keeps none of them. + let dirt = json!({"pools":[{"rolls":1,"entries":[{"type":"minecraft:item", + "name":"minecraft:dirt","modifier":[ + {"type":"minecraft:enchant_with_levels","levels":{"type":"minecraft:constant","value":30.0}}]}]}]}); + let drops = ctx(&items, None, &props, "").evaluate(&dirt, &mut random); + assert!(drops[0].enchantments().is_empty()); + } + + /// `Mth.nextInt(random, 1, max)` returns `1` without drawing when the + /// enchantment has one level (`EnchantRandomlyFunction.enchantItem`), so + /// the rolls after it must not shift. Vanilla with `LegacyRandom(11)`: a + /// Mending book, then `set_count` uniform 1..64, is 46. + #[test] + fn a_single_level_enchantment_draws_no_level() { + let root = std::path::PathBuf::from(env!("CARGO_MANIFEST_DIR")) + .join("../../.local/horizon-client/26.3"); + if !root.join("items.json").exists() { + return; + } + let assets = crate::assets::Assets::load(&root).unwrap(); + let facts = crate::blocks::BlockFacts::load(&root, assets.registry).unwrap(); + let items = Items::load(&root, assets.registry, &facts).unwrap(); + let props = BTreeMap::new(); + let table = json!({"pools":[{"rolls":1,"entries":[{"type":"minecraft:item", + "name":"minecraft:book","modifier":[ + {"type":"minecraft:enchant_randomly","options":"minecraft:mending"}, + {"type":"minecraft:set_count","count":{"type":"minecraft:uniform","min":1.0,"max":64.0}}]}]}]}); + let drops = ctx(&items, None, &props, "").evaluate(&table, &mut LegacyRandom::new(11)); + assert_eq!(drops.len(), 1); + assert_eq!(&*drops[0].item, "minecraft:enchanted_book"); + assert_eq!( + drops[0].stored_enchantments(), + [("minecraft:mending".to_owned().into(), 1)], + "the book keeps its single-level enchantment" + ); + // 46 is vanilla's count for this seed; an extra level draw gives 28. + assert_eq!(drops[0].count, 46); + } + #[test] fn always_edible_and_consume_effects_loaded() { let root = std::path::PathBuf::from(env!("CARGO_MANIFEST_DIR")) diff --git a/crates/horizon-client/src/lan/conn.rs b/crates/horizon-client/src/lan/conn.rs index fb91f3006..f2dcf701d 100644 --- a/crates/horizon-client/src/lan/conn.rs +++ b/crates/horizon-client/src/lan/conn.rs @@ -823,6 +823,17 @@ fn login_and_configure( _ => {} } }; + // A Horizon client hears that this server runs its mods' quiet commands + // (horizon_protocol::quiet); a vanilla one is told nothing. + if brand == "horizon" { + send( + c, + cfg::Clientbound::CustomPayload(cfg::CustomPayload { + channel: horizon_protocol::quiet::CHANNEL.into(), + data: Vec::new(), + }), + )?; + } for packet in sync.registry_packets(known_pack) { send(c, cfg::Clientbound::RegistryData(packet))?; } diff --git a/crates/horizon-client/src/lan/guest.rs b/crates/horizon-client/src/lan/guest.rs index aa1994257..9224d3711 100644 --- a/crates/horizon-client/src/lan/guest.rs +++ b/crates/horizon-client/src/lan/guest.rs @@ -601,6 +601,18 @@ fn network_stack( horizon_protocol::item::Component::Stacks(charged), )); } + // What a bundle holds, for its tooltip (ClientBundleTooltip). + if !d.bundle_contents.is_empty() { + let contents = d + .bundle_contents + .iter() + .filter_map(|c| network_stack(item_id, synced_id, &Some(c.clone()))) + .collect(); + stack.added.push(( + horizon_protocol::item::component::BUNDLE_CONTENTS, + horizon_protocol::item::Component::Stacks(contents), + )); + } // The books a lectern shows and a guest reads. if !d.writable_pages.is_empty() { stack.added.push(( diff --git a/crates/horizon-client/src/lan/hub.rs b/crates/horizon-client/src/lan/hub.rs index 910911d80..b1a8cbc62 100644 --- a/crates/horizon-client/src/lan/hub.rs +++ b/crates/horizon-client/src/lan/hub.rs @@ -128,6 +128,11 @@ pub enum HostEvent { line: String, secure: bool, }, + /// A chat message a player sent (after it was broadcast), for server mods. + PlayerChat { + sender: u128, + text: String, + }, /// A server log warning (ServerGamePacketListenerImpl's LOGGER.warn). Warn(String), /// A server log error (LOGGER.error). @@ -371,9 +376,21 @@ impl Hub { id } pub fn stack(&mut self, s: &Option) -> Option { - let id = s.as_ref().map(|s| self.item_id(&s.item))?; + let item = s.as_ref()?.item.clone(); + let id = self.item_id(&item); let sync = self.sync.clone(); - stack_to_network(|_| id, |registry, name| sync.id(registry, name), s) + // The stacks inside it (a bundle's contents, a crossbow's projectiles) + // have ids of their own. + let item_id = |name: &str| { + if name == &*item { + return id; + } + sync.builtin + .get("minecraft:item") + .and_then(|i| i.id(name)) + .unwrap_or(0) + }; + stack_to_network(item_id, |registry, name| sync.id(registry, name), s) } pub fn broadcast(&self, packet: &C) { diff --git a/crates/horizon-client/src/lan/hub/chat.rs b/crates/horizon-client/src/lan/hub/chat.rs index bdc7c3fb2..591c0dfc5 100644 --- a/crates/horizon-client/src/lan/hub/chat.rs +++ b/crates/horizon-client/src/lan/hub/chat.rs @@ -219,6 +219,10 @@ impl Hub { }; let line = format!("<{name}> {}", message.content); self.broadcast_chat(&message, &bound, line, events); + events.push(HostEvent::PlayerChat { + sender: uuid, + text: message.content, + }); } /// handleChatSessionUpdate: a new profile key, validated against the diff --git a/crates/horizon-client/src/lib.rs b/crates/horizon-client/src/lib.rs index 6bf40d1f0..ebfbdea58 100644 --- a/crates/horizon-client/src/lib.rs +++ b/crates/horizon-client/src/lib.rs @@ -50,6 +50,7 @@ pub mod cooldowns; pub mod crafting; pub mod crash; pub mod creative; +pub mod cushion; pub mod data_cmd; pub mod datapack; pub mod debug_chart; diff --git a/crates/horizon-client/src/mesher.rs b/crates/horizon-client/src/mesher.rs index fff3c6aa0..48d2f08bd 100644 --- a/crates/horizon-client/src/mesher.rs +++ b/crates/horizon-client/src/mesher.rs @@ -113,6 +113,14 @@ mod vertex_tests { assert!((a - b).abs() <= 0.5 / 32768.0, "{a} {b}"); } } + #[test] + fn emission_keeps_the_colour_and_the_free_bits() { + let rgb = super::pack_rgb([0x12, 0x34, 0x56]); + assert_eq!(super::emitting(rgb, 0), rgb); + assert_eq!(super::emitting(rgb, 9), 0xF656_3412); + assert_eq!(super::emitting(rgb, 15), 0xF056_3412); + assert_eq!(super::emitting(rgb, 15) | super::EMISSION_BITS, rgb); + } } pub struct SectionMesh { pub solid: Vec, @@ -566,6 +574,14 @@ impl Padded { } /// Set on a terrain vertex's sprite layer when its texture alpha must be ignored. pub const OPAQUE_LAYER: u16 = 1 << 15; +/// The bits of `TerrainVertex::color`'s alpha byte that hold the light its face emits, for +/// HDR output's highlights (`gfx/hdr.rs`): 15 minus the level, so the usual 0xFF means none. +/// The byte's other four bits stay set. +pub const EMISSION_BITS: u32 = 0x0F00_0000; +/// `color` marked as emitting light `level` (0 to 15). +pub fn emitting(color: u32, level: u8) -> u32 { + color & !EMISSION_BITS | u32::from(15 - level.min(15)) << 24 +} const UNSET: u32 = u32::MAX; const NO_BIOME: u16 = u16::MAX; /// The `ColorResolver`s `ClientLevel` caches block tints for. @@ -880,7 +896,7 @@ impl Mesher<'_> { } else { face.layer as u16 }, - pack_rgb(rgb), + emitting(pack_rgb(rgb), state.emission.max(q.light_emission)), pack_coords(lighting::with_emission(coords[i], q.light_emission)), )); } diff --git a/crates/horizon-client/src/mesher/fluid.rs b/crates/horizon-client/src/mesher/fluid.rs index 6e42685ba..d30b914a4 100644 --- a/crates/horizon-client/src/mesher/fluid.rs +++ b/crates/horizon-client/src/mesher/fluid.rs @@ -227,8 +227,11 @@ pub(super) fn tesselate( } else { 0xFF_FFFF }; + // Lava emits light level 15. + let emission = if water { 0 } else { 15 }; let color = |by: f32| { - pack_rgb([16, 8, 0].map(|shift| lighting::scale((tint >> shift & 255) as i32, by) as u32)) + let rgb = [16, 8, 0].map(|shift| lighting::scale((tint >> shift & 255) as i32, by) as u32); + crate::mesher::emitting(pack_rgb(rgb), emission) }; let height = |p: [i32; 3]| -> f32 { let s = at(p); diff --git a/crates/horizon-client/src/multiplayer.rs b/crates/horizon-client/src/multiplayer.rs index f13ffde0a..39ea26502 100644 --- a/crates/horizon-client/src/multiplayer.rs +++ b/crates/horizon-client/src/multiplayer.rs @@ -11,9 +11,15 @@ use std::{ collections::HashMap, path::{Path, PathBuf}, sync::{Arc, Mutex}, - time::Duration, + time::{Duration, Instant}, }; +const SERVER_NAME: crate::clipboard::FieldId = ("server.name", 0); +const SERVER_ADDRESS: crate::clipboard::FieldId = ("server.address", 0); +const SERVER_DIRECT: crate::clipboard::FieldId = ("server.direct", 0); +const FRIEND_CODE: crate::clipboard::FieldId = ("friend.code", 0); +const FRIEND_RELAY: crate::clipboard::FieldId = ("friend.relay", 0); + /// The result of pinging one address. #[derive(Clone, Debug)] pub enum Ping { @@ -587,18 +593,21 @@ impl Screen { } } /// An EditBox and its label: the label at `label_y` (one pixel in, in - /// 0xA0A0A0), the 200x20 box at `box_y`. + /// 0xA0A0A0), the 200x20 box at `box_y`. The box is the same `EditBox` + /// the world screens edit (`Caret`): cursor, selection and scrolling. fn field( atlas: &HudAtlas, batch: &mut HudBatch, + caret: &mut crate::ui::Caret, + focused_at: Instant, label: &str, value: &str, + id: crate::clipboard::FieldId, + max: usize, (label_y, box_y): (f32, f32), focused: bool, - blink: bool, ) { let x = (batch.width.ceil() / 2.0).floor() - 100.0; - crate::widgets::target_as([x, box_y, 200.0, 20.0], crate::widgets::Kind::Field); batch.text( atlas, label, @@ -607,35 +616,25 @@ impl Screen { rgba(160, 160, 160, 255), true, ); - batch.fill( + caret.draw( + batch, atlas, - x, - box_y, - 200.0, - 20.0, - if focused { - u32::MAX - } else { - rgba(160, 160, 160, 255) - }, - ); - batch.fill(atlas, x + 1.0, box_y + 1.0, 198.0, 18.0, rgba(0, 0, 0, 255)); - let shown = if focused && blink { - format!("{value}_") - } else { - value.to_owned() - }; - batch.text( - atlas, - &shown, - x + 4.0, - box_y + 6.0, - rgba(224, 224, 224, 255), - true, + (id, value, max), + [x, box_y, 200.0, 20.0], + focused, + focused_at, ); } - pub fn draw(&self, atlas: &HudAtlas, batch: &mut HudBatch, blink: bool, cursor: (f32, f32)) { + pub fn draw( + &self, + atlas: &HudAtlas, + batch: &mut HudBatch, + caret: &mut crate::ui::Caret, + focused_at: Instant, + cursor: (f32, f32), + ) { let (w, h) = (batch.width, batch.height); + let max = self.max_length(); crate::ui::menu_background(batch, atlas, 0.0, 0.0, w, h, false); let centered = |batch: &mut HudBatch, text: &str, y: f32, color: u32| { let tw = HudBatch::text_width(atlas, text); @@ -888,20 +887,26 @@ impl Screen { Self::field( atlas, batch, + caret, + focused_at, &crate::lang::get_or("manageServer.enterName", "Server Name"), name, + SERVER_NAME, + max, (53.0, 66.0), *focus == 0, - blink, ); Self::field( atlas, batch, + caret, + focused_at, &crate::lang::get_or("manageServer.enterIp", "Server Address"), address, + SERVER_ADDRESS, + max, (94.0, 106.0), *focus == 1, - blink, ); } Self::Direct { address } => { @@ -916,11 +921,14 @@ impl Screen { Self::field( atlas, batch, + caret, + focused_at, &crate::lang::get_or("manageServer.enterIp", "Server Address"), address, + SERVER_DIRECT, + max, (100.0, 116.0), true, - blink, ); } Self::ConfirmDelete { name, lines, .. } => { @@ -954,20 +962,26 @@ impl Screen { Self::field( atlas, batch, + caret, + focused_at, "Invite Code", code, + FRIEND_CODE, + max, (53.0, 64.0), *focus == 0, - blink, ); Self::field( atlas, batch, + caret, + focused_at, "Relay (optional)", relay, + FRIEND_RELAY, + max, (94.0, 105.0), *focus == 1, - blink, ); } Self::Disconnected { reason, retry } => { @@ -1261,6 +1275,19 @@ impl Screen { scroll.release(); } } + /// The focused box, in GUI pixels: name at 66, address at 106 + /// (`ManageServerScreen`), direct address at 116, friend fields at 64 and 105. + pub fn focused_box(&self, (w, _h): (f32, f32)) -> Option<[f32; 4]> { + let y = match self { + Self::Edit { focus: 0, .. } => 66.0, + Self::Edit { .. } => 106.0, + Self::Direct { .. } => 116.0, + Self::Friend { focus: 0, .. } => 64.0, + Self::Friend { .. } => 105.0, + _ => return None, + }; + Some([(w / 2.0).floor() - 100.0, y, 200.0, 20.0]) + } fn focused_field(&mut self) -> Option<&mut String> { match self { Self::Edit { @@ -1297,11 +1324,11 @@ impl Screen { /// The focused text field, its id and maximum length (copy and paste). pub fn focused_text(&mut self) -> Option<(crate::clipboard::FieldId, &mut String, usize)> { let id = match self { - Self::Edit { focus: 0, .. } => ("server.name", 0), - Self::Edit { .. } => ("server.address", 0), - Self::Direct { .. } => ("server.direct", 0), - Self::Friend { focus: 0, .. } => ("friend.code", 0), - Self::Friend { .. } => ("friend.relay", 0), + Self::Edit { focus: 0, .. } => SERVER_NAME, + Self::Edit { .. } => SERVER_ADDRESS, + Self::Direct { .. } => SERVER_DIRECT, + Self::Friend { focus: 0, .. } => FRIEND_CODE, + Self::Friend { .. } => FRIEND_RELAY, _ => return None, }; let max = self.max_length(); @@ -1315,21 +1342,6 @@ impl Screen { 128 } } - pub fn type_text(&mut self, text: &str) { - let max = self.max_length(); - if let Some(field) = self.focused_field() { - for c in text.chars().filter(|c| !c.is_control()) { - if field.chars().count() < max { - field.push(c); - } - } - } - } - pub fn backspace(&mut self) { - if let Some(field) = self.focused_field() { - field.pop(); - } - } pub fn tab(&mut self) { if let Self::Edit { focus, .. } | Self::Friend { focus, .. } = self { *focus = (*focus + 1) % 2; diff --git a/crates/horizon-client/src/save.rs b/crates/horizon-client/src/save.rs index 0c353bb38..830198174 100644 --- a/crates/horizon-client/src/save.rs +++ b/crates/horizon-client/src/save.rs @@ -676,8 +676,10 @@ pub fn decode_block_entity(tag: &Tag) -> Option<((i32, i32, i32), crate::contain Tag::Int(n) => *n, _ => continue, }; - f.recipes_used - .insert(id.to_string_lossy(), count.max(0) as u32); + // Saves from before the key was namespaced hold both forms of an id. + *f.recipes_used + .entry(crate::containers::recipe_used_key(&id.to_string_lossy())) + .or_insert(0) += count.max(0) as u32; } } } @@ -4382,4 +4384,28 @@ mod tests { }; assert_eq!(back.recipes_used.get("minecraft:cooked_porkchop"), Some(&3)); } + + /// A save written before the key was namespaced holds an id twice, once bare: vanilla + /// refuses such a furnace, so a load merges them under the full id. + #[test] + fn a_furnaces_recipes_used_merges_bare_and_full_ids() { + use crate::containers::BlockEntity; + let Some(BlockEntity::Furnace(mut f)) = BlockEntity::for_block("minecraft:furnace") else { + panic!("a furnace"); + }; + f.recipes_used + .insert("iron_ingot_from_smelting_iron_ore".to_owned(), 2); + f.recipes_used + .insert("minecraft:iron_ingot_from_smelting_iron_ore".to_owned(), 3); + let tag = encode_block_entity((1, 64, 2), &BlockEntity::Furnace(f), "minecraft:furnace"); + let Some((_, BlockEntity::Furnace(back))) = decode_block_entity(&tag) else { + panic!("a furnace back"); + }; + assert_eq!(back.recipes_used.len(), 1); + assert_eq!( + back.recipes_used + .get("minecraft:iron_ingot_from_smelting_iron_ore"), + Some(&5) + ); + } } diff --git a/crates/horizon-client/src/sprint.rs b/crates/horizon-client/src/sprint.rs index c2099306c..872667b55 100644 --- a/crates/horizon-client/src/sprint.rs +++ b/crates/horizon-client/src/sprint.rs @@ -134,3 +134,76 @@ impl SprintState { Ok(()) } } + +#[cfg(test)] +mod tests { + use super::*; + + fn standing() -> Conditions { + Conditions { + enough_food: true, + on_ground: true, + ..Conditions::default() + } + } + + fn step(state: &mut SprintState, keys: Keys, sprinting: &mut bool) { + let current = *sprinting; + let mut next = current; + state + .tick( + keys, + Conditions { + sprinting: current, + ..standing() + }, + 7, + |value| { + next = value; + Ok::<(), ()>(()) + }, + ) + .unwrap(); + *sprinting = next; + } + + /// Vanilla sprint is a state. Releasing the sprint key, including on the + /// jump tick, keeps it while forward is held; releasing forward stops it. + #[test] + fn sprint_survives_releasing_the_key_through_a_jump() { + let mut state = SprintState::default(); + let mut sprinting = false; + step( + &mut state, + Keys { + forward: true, + sprint: true, + ..Keys::default() + }, + &mut sprinting, + ); + assert!(sprinting); + step( + &mut state, + Keys { + forward: true, + jump: true, + ..Keys::default() + }, + &mut sprinting, + ); + assert!( + sprinting, + "a jump after the sprint key comes up must stay a sprint" + ); + step( + &mut state, + Keys { + jump: true, + ..Keys::default() + }, + &mut sprinting, + ); + assert!(!sprinting); + } +} diff --git a/crates/horizon-client/src/stations.rs b/crates/horizon-client/src/stations.rs index 715c2663e..c24d8b39f 100644 --- a/crates/horizon-client/src/stations.rs +++ b/crates/horizon-client/src/stations.rs @@ -14,7 +14,8 @@ use std::{fs, path::Path, sync::Arc}; /// Everything the workstation menus read, loaded once with the resources. pub struct StationData { - pub enchantments: Enchantments, + /// The same registry `Items` carries (`Items::enchantments`). + pub enchantments: std::sync::Arc, pub recipes: StationRecipes, pub brewing: crate::brewing::Brewing, pub trades: crate::merchant::Trades, @@ -25,7 +26,7 @@ pub struct StationData { impl StationData { pub fn load(root: &Path, items: &Items) -> Self { Self { - enchantments: Enchantments::load(root), + enchantments: std::sync::Arc::clone(&items.enchantments), recipes: StationRecipes::load(root, items), brewing: crate::brewing::Brewing::load(root, items), trades: crate::merchant::Trades::load(root), diff --git a/crates/horizon-client/src/terrain.wgsl b/crates/horizon-client/src/terrain.wgsl index 711a2fce7..c0cf44bb5 100644 --- a/crates/horizon-client/src/terrain.wgsl +++ b/crates/horizon-client/src/terrain.wgsl @@ -69,6 +69,8 @@ struct TerrainOut { @location(2) color: vec4, @location(3) spherical: f32, @location(4) cylindrical: f32, + // The light the face emits, 0 to 15 (mesher.rs's `EMISSION_BITS`). + @location(5) @interpolate(flat) emission: u32, } // Horizon Extras' dynamic lights (dynamic_light.rs): the block light, in the vertex's units // (16 per level), a vertex at camera-relative `pos` gets from the frame's light sources, one @@ -121,7 +123,8 @@ fn terrain_vertex(position: vec3, uv: vec2, layer: u32, color: vec4, spherical: f32, cylindrical: f32) -> vec4 { // Bit 15 of the layer marks opaque leaves (forceOpaque): no alpha cutout. let color = sprite(in.uv, in.layer & 0x7fffu) * in.color; if color.a < 0.5 && (in.layer & 0x8000u) == 0u { discard; } - return apply_fog(vec4(color.rgb, 1.0), in.spherical, in.cylindrical); + // Alpha 0 tells HDR output (hdr.wgsl) a light-emitting block's bright pixels + // may shine. Nothing else reads the frame's alpha. + let emissive = select(1.0, 0.0, in.emission > 0u); + return apply_fog(vec4(color.rgb, emissive), in.spherical, in.cylindrical); } @fragment fn fs_translucent(in: TerrainOut) -> @location(0) vec4 { let color = sprite(in.uv, in.layer & 0x7fffu) * in.color; diff --git a/crates/horizon-client/src/title.rs b/crates/horizon-client/src/title.rs index 6ecaced9c..87bd05fd0 100644 --- a/crates/horizon-client/src/title.rs +++ b/crates/horizon-client/src/title.rs @@ -1119,7 +1119,8 @@ impl Title { Mode::Multiplayer(screen) => screen.draw( atlas, batch, - (self.started.elapsed().as_millis() / 300).is_multiple_of(2), + &mut self.caret.borrow_mut(), + self.started, cursor, ), } @@ -1414,8 +1415,7 @@ impl Title { mode => caret_field(mode, self.search_focused, &mut self.search), } } - /// Whether the focused field edits at its cursor (every field but the - /// server screens', which still append). + /// Whether the focused field edits at its cursor. pub fn has_caret_field(&mut self) -> bool { caret_field(&mut self.mode, self.search_focused, &mut self.search).is_some() } @@ -1435,15 +1435,9 @@ impl Title { } /// EditBox.charTyped / insertText at the cursor. pub fn type_text(&mut self, text: &str) { - if let Mode::Multiplayer(screen) = &mut self.mode { - return screen.type_text(text); - } self.edit_field(|edit| edit.insert_text(text)); } pub fn backspace(&mut self) { - if let Mode::Multiplayer(screen) = &mut self.mode { - return screen.backspace(); - } self.field_key(winit::keyboard::KeyCode::Backspace, false, false); } /// EditBox.keyPressed: moving and deleting in the focused field. @@ -1471,6 +1465,7 @@ impl Title { Mode::Create { focus, options, .. } => create_world::field_rect(w, h, options.tab) .filter(|(id, _)| id == focus) .map(|(_, rect)| rect), + Mode::Multiplayer(screen) => screen.focused_box((w, h)), _ => None, } } @@ -1623,8 +1618,9 @@ const SEARCH: crate::clipboard::FieldId = ("world.search", 0); const EDIT_NAME: crate::clipboard::FieldId = ("world.edit-name", 0); const WORLD_NAME: crate::clipboard::FieldId = ("world.name", 0); const WORLD_SEED: crate::clipboard::FieldId = ("world.seed", 0); -/// The focused field of the world screens: the list's search, the world -/// name being edited, or Create New World's name or seed. +/// The focused field of the world screens and the server screens: the list's +/// search, a world name or seed, or Add Server, Direct Connection and Join a +/// Friend. fn caret_field<'a>( mode: &'a mut Mode, search_focused: bool, @@ -1644,6 +1640,7 @@ fn caret_field<'a>( 1 => Some((WORLD_SEED, seed, 32)), _ => None, }, + Mode::Multiplayer(screen) => screen.focused_text(), _ => None, } } diff --git a/crates/horizon-client/src/title/tests.rs b/crates/horizon-client/src/title/tests.rs index 572be2ef2..fcaf68225 100644 --- a/crates/horizon-client/src/title/tests.rs +++ b/crates/horizon-client/src/title/tests.rs @@ -824,3 +824,50 @@ fn world_fields_edit_at_their_cursor() { f.title.field_key(KeyCode::Backspace, false, false); assert_eq!(f.title.search, "world"); } + +#[test] +fn server_fields_edit_at_their_cursor() { + use winit::keyboard::KeyCode; + let mut f = Fixture::new(); + f.title.mode = Mode::Multiplayer(crate::multiplayer::Screen::Edit { + index: None, + name: "Minecraft Server".into(), + address: String::new(), + focus: 1, + packs: None, + }); + f.title.type_text("localhost"); + for _ in 0..4 { + assert!(f.title.field_key(KeyCode::ArrowLeft, false, false)); + } + f.title.type_text("X"); + let Mode::Multiplayer(crate::multiplayer::Screen::Edit { address, .. }) = &f.title.mode else { + panic!("add server"); + }; + assert_eq!(address, "localXhost"); + // Shift+Home selects back to the start; typing replaces the selection. + f.title.field_key(KeyCode::Home, false, true); + f.title.type_text("Y"); + let Mode::Multiplayer(crate::multiplayer::Screen::Edit { address, .. }) = &f.title.mode else { + panic!("add server"); + }; + assert_eq!(address, "Yhost"); + // Tab moves to the name, which edits at its own cursor. + f.title.tab(); + f.title.field_key(KeyCode::ArrowLeft, false, false); + f.title.type_text("X"); + let Mode::Multiplayer(crate::multiplayer::Screen::Edit { name, .. }) = &f.title.mode else { + panic!("add server"); + }; + assert_eq!(name, "Minecraft ServeXr"); + f.title.mode = Mode::Multiplayer(crate::multiplayer::Screen::Direct { + address: String::new(), + }); + f.title.type_text("one two"); + // Ctrl+Backspace deletes the word before the caret. + f.title.field_key(KeyCode::Backspace, true, false); + let Mode::Multiplayer(crate::multiplayer::Screen::Direct { address }) = &f.title.mode else { + panic!("direct"); + }; + assert_eq!(address, "one "); +} diff --git a/crates/horizon-client/src/ui.rs b/crates/horizon-client/src/ui.rs index 1954a29dc..e034f2b39 100644 --- a/crates/horizon-client/src/ui.rs +++ b/crates/horizon-client/src/ui.rs @@ -658,6 +658,8 @@ pub struct EditBox { display: usize, pub max_length: usize, pub bordered: bool, + /// `MultiLineEditBox`: a book page keeps line breaks. A single-line box strips them. + pub multiline: bool, pub x: f32, pub y: f32, pub width: f32, @@ -669,7 +671,7 @@ pub struct EditBox { pub text_color: u32, } /// The focused text field of a screen that keeps its values as `String`s -/// (the world list's search, world names, seeds): the `EditBox` state that +/// (the world list's search, world names, seeds, and the server screens): the `EditBox` state that /// outlives a frame, its cursor, selection and scroll. #[derive(Clone, Debug)] pub struct Caret { @@ -853,6 +855,38 @@ pub fn word_position(value: &str, dir: isize, from: usize) -> usize { } pos } +/// `MultilineTextField.getPreviousWord` / `getNextWord`'s `beginIndex` (a book page): any +/// whitespace, line breaks included, separates words, and the search starts from the cursor +/// clamped to the last character, as vanilla's does. +pub fn multiline_word_position(value: &str, dir: isize, from: usize) -> usize { + let chars: Vec = value.chars().collect(); + if chars.is_empty() { + return 0; + } + let mut pos = from.min(chars.len() - 1); + if dir < 0 { + while pos > 0 && java_whitespace(chars[pos - 1]) { + pos -= 1; + } + while pos > 0 && !java_whitespace(chars[pos - 1]) { + pos -= 1; + } + } else { + while pos < chars.len() && !java_whitespace(chars[pos]) { + pos += 1; + } + while pos < chars.len() && java_whitespace(chars[pos]) { + pos += 1; + } + } + pos +} +/// `Character.isWhitespace`: Unicode spaces and line breaks but not the no-break spaces, plus +/// the ASCII separators U+001C to U+001F. +fn java_whitespace(c: char) -> bool { + (c.is_whitespace() && !matches!(c, '\u{85}' | '\u{a0}' | '\u{2007}' | '\u{202f}')) + || ('\u{1c}'..='\u{1f}').contains(&c) +} /// `EditBox.deleteWords(dir)` for an append-only field, whose caret is at the /// end: removes the word in that direction. True when the value changed. pub fn delete_words(value: &mut String, dir: isize) -> bool { @@ -887,6 +921,7 @@ impl EditBox { display: 0, max_length: 32, bordered: true, + multiline: false, x, y, width, @@ -917,6 +952,10 @@ impl EditBox { pub fn reset_blink(&mut self) { self.focused_at = Instant::now(); } + /// The caret is showing (`EditBox`'s blink, on for 300 ms of every 600). + pub fn cursor_visible(&self) -> bool { + self.focused && (self.focused_at.elapsed().as_millis() / 300).is_multiple_of(2) + } pub fn set_value(&mut self, value: &str) { self.value = value.chars().take(self.max_length).collect(); self.move_cursor_to_end(false); @@ -934,7 +973,7 @@ impl EditBox { /// EditBox.insertText: replace the selection, respecting the maximum length. pub fn insert_text(&mut self, text: &str) { let (a, b) = self.selected(); - let filtered = crate::clipboard::filter_text(text, false); + let filtered = crate::clipboard::filter_text(text, self.multiline); let room = self .max_length .saturating_sub(char_len(&self.value) - (b - a)); @@ -960,9 +999,13 @@ impl EditBox { pub fn word_position(&self, dir: isize) -> usize { self.word_position_from(dir, self.cursor) } - /// EditBox.getWordPosition(dir, from). + /// EditBox.getWordPosition(dir, from), or MultilineTextField's word for a book page. fn word_position_from(&self, dir: isize, from: usize) -> usize { - word_position(&self.value, dir, from) + if self.multiline { + multiline_word_position(&self.value, dir, from) + } else { + word_position(&self.value, dir, from) + } } pub fn set_cursor(&mut self, pos: usize, select: bool) { self.cursor = pos.min(char_len(&self.value)); @@ -1492,6 +1535,17 @@ mod tests { assert_eq!(word_position("hi", 1, 99), 2); } #[test] + fn multiline_words_split_at_any_whitespace() { + // Ctrl+Backspace at the end of `one\ntwo` deletes `two` only. + assert_eq!(multiline_word_position("one\ntwo", -1, 7), 4); + // From the end the search starts at the last character, as vanilla's does. + assert_eq!(multiline_word_position("one\n", -1, 4), 0); + assert_eq!(multiline_word_position("a b", -1, 3), 0); + assert_eq!(multiline_word_position("one\n\ntwo", 1, 0), 5); + assert_eq!(multiline_word_position("one\u{a0}two", 1, 0), 7); + assert_eq!(multiline_word_position("", -1, 0), 0); + } + #[test] fn delete_words_removes_the_word_before_the_end() { let mut v = "stone bricks".to_string(); assert!(delete_words(&mut v, -1)); diff --git a/crates/horizon-client/src/world_post.wgsl b/crates/horizon-client/src/world_post.wgsl index 7332213c5..ed1a7a094 100644 --- a/crates/horizon-client/src/world_post.wgsl +++ b/crates/horizon-client/src/world_post.wgsl @@ -18,7 +18,8 @@ struct PostOut { } @fragment fn fs_copy(in: PostOut) -> @location(0) vec4 { - return vec4(textureSampleLevel(world, world_sampler, in.uv, 0.0).rgb, 1.0); + // The alpha carries the emissive mark through to HDR output (hdr.wgsl). + return textureSampleLevel(world, world_sampler, in.uv, 0.0); } fn luma(c: vec3) -> f32 { @@ -28,7 +29,8 @@ fn luma(c: vec3) -> f32 { // FXAA 3.11 (console quality): blend along the local edge direction. @fragment fn fs_fxaa(in: PostOut) -> @location(0) vec4 { let texel = 1.0 / vec2(textureDimensions(world)); - let rgb_m = textureSampleLevel(world, world_sampler, in.uv, 0.0).rgb; + let centre = textureSampleLevel(world, world_sampler, in.uv, 0.0); + let rgb_m = centre.rgb; let nw = luma(textureSampleLevel(world, world_sampler, in.uv + vec2(-0.5, -0.5) * texel, 0.0).rgb); let ne = luma(textureSampleLevel(world, world_sampler, in.uv + vec2(0.5, -0.5) * texel, 0.0).rgb); let sw = luma(textureSampleLevel(world, world_sampler, in.uv + vec2(-0.5, 0.5) * texel, 0.0).rgb); @@ -37,7 +39,7 @@ fn luma(c: vec3) -> f32 { let lo = min(m, min(min(nw, ne), min(sw, se))); let hi = max(m, max(max(nw, ne), max(sw, se))); if hi - lo < max(0.0312, hi * 0.125) { - return vec4(rgb_m, 1.0); + return centre; } var dir = vec2(-((nw + ne) - (sw + se)), (nw + sw) - (ne + se)); let reduce = max((nw + ne + sw + se) * 0.25 * 0.125, 1.0 / 128.0); @@ -49,7 +51,7 @@ fn luma(c: vec3) -> f32 { + textureSampleLevel(world, world_sampler, in.uv + dir * 0.5, 0.0).rgb); let lb = luma(b); if lb < lo || lb > hi { - return vec4(a, 1.0); + return vec4(a, centre.a); } - return vec4(b, 1.0); + return vec4(b, centre.a); } diff --git a/crates/horizon-hdr/Cargo.toml b/crates/horizon-hdr/Cargo.toml new file mode 100644 index 000000000..e83e590e8 --- /dev/null +++ b/crates/horizon-hdr/Cargo.toml @@ -0,0 +1,17 @@ +[package] +name = "horizon-hdr" +version = "0.1.0" +edition.workspace = true +license.workspace = true +rust-version = "1.85" +description = "HDR metadata for the swapchain: the Vulkan calls the crates that forbid unsafe code can't make" + +[dependencies] +wgpu = { version = "30.0.1", default-features = false, features = ["vulkan"] } + +[target.'cfg(not(target_os = "macos"))'.dependencies] +# The version wgpu-hal already uses. +ash = { version = "0.38", default-features = false } + +[lints] +workspace = true diff --git a/crates/horizon-hdr/src/lib.rs b/crates/horizon-hdr/src/lib.rs new file mode 100644 index 000000000..cda61868e --- /dev/null +++ b/crates/horizon-hdr/src/lib.rs @@ -0,0 +1,95 @@ +//! HDR metadata for the swapchain: the Vulkan calls the game crate, which +//! forbids unsafe code, can't make itself. wgpu sets no HDR metadata, and +//! without it a compositor may clip or tone-map everything above 1.0 (80 nits) +//! of an scRGB swapchain. + +/// Opens a Vulkan device with `VK_EXT_hdr_metadata` too, when the GPU offers +/// it, so [`set_metadata`] can tell the compositor the real peak brightness. +/// `None` leaves opening to wgpu. +#[cfg(not(target_os = "macos"))] +pub fn open_vulkan_device( + adapter: &wgpu::Adapter, + desc: &wgpu::DeviceDescriptor<'_>, +) -> Option> { + use wgpu::hal::api::Vulkan; + let open = { + // Safety: only read and opened from here; dropped before wgpu takes it back. + let hal = unsafe { adapter.as_hal::() }?; + let instance = hal.shared_instance().raw_instance(); + // Safety: the adapter's own physical device on its own instance. + let offered = + unsafe { instance.enumerate_device_extension_properties(hal.raw_physical_device()) } + .ok()? + .iter() + .any(|e| e.extension_name_as_c_str() == Ok(ash::ext::hdr_metadata::NAME)); + if !offered { + return None; + } + // Safety: what wgpu's own request_device does, with one more extension. + unsafe { + hal.open_with_callback( + desc.required_features, + &desc.required_limits, + &desc.memory_hints, + Some(Box::new( + |args: wgpu::hal::vulkan::CreateDeviceCallbackArgs| { + args.extensions.push(ash::ext::hdr_metadata::NAME); + }, + )), + ) + } + .ok()? + }; + // Safety: opened from this adapter with exactly `desc`'s features. + Some(unsafe { adapter.create_device_from_hal(open, desc) }) +} + +/// Tells the compositor, through `VK_EXT_hdr_metadata`, that the swapchain's +/// content is BT.709 and peaks at `peak` nits. Needs a device from +/// `open_vulkan_device` and a configured surface; does nothing otherwise. +pub fn set_metadata( + device: &wgpu::Device, + surface: &wgpu::Surface<'_>, + paper_white: f32, + peak: f32, +) { + #[cfg(not(target_os = "macos"))] + { + use wgpu::hal::api::Vulkan; + // Safety: read-only access to handles wgpu keeps alive while these guards live. + let (Some(hal_device), Some(hal_surface)) = + (unsafe { device.as_hal::() }, unsafe { + surface.as_hal::() + }) + else { + return; + }; + if !hal_device + .enabled_device_extensions() + .contains(&ash::ext::hdr_metadata::NAME) + { + return; + } + let Some(swapchain) = hal_surface.raw_native_swapchain() else { + return; + }; + let xy = |x, y| ash::vk::XYColorEXT { x, y }; + let metadata = ash::vk::HdrMetadataEXT::default() + .display_primary_red(xy(0.64, 0.33)) + .display_primary_green(xy(0.30, 0.60)) + .display_primary_blue(xy(0.15, 0.06)) + .white_point(xy(0.3127, 0.3290)) + .max_luminance(peak) + .min_luminance(0.0) + .max_content_light_level(peak) + .max_frame_average_light_level(paper_white.min(peak)); + let loader = ash::ext::hdr_metadata::Device::new( + hal_device.shared_instance().raw_instance(), + hal_device.raw_device(), + ); + // Safety: a live swapchain of this device, one metadata entry for it. + unsafe { loader.set_hdr_metadata(&[swapchain], &[metadata]) }; + } + #[cfg(target_os = "macos")] + let _ = (device, surface, paper_white, peak); +} diff --git a/crates/horizon-mods/src/index.rs b/crates/horizon-mods/src/index.rs index 544c52980..4ef292a23 100644 --- a/crates/horizon-mods/src/index.rs +++ b/crates/horizon-mods/src/index.rs @@ -122,6 +122,14 @@ pub struct Project { pub key: Option, /// Newest first. pub versions: Vec, + /// Its files' downloads from their releases, all versions together: + /// GitHub's counts, added by the registry's publish job (hourly). + #[serde(default, skip_serializing_if = "is_zero")] + pub downloads: u64, +} + +fn is_zero(n: &u64) -> bool { + *n == 0 } #[derive(Clone, Debug, PartialEq, Serialize, Deserialize)] diff --git a/crates/horizon-mods/src/index/registry.rs b/crates/horizon-mods/src/index/registry.rs index 90453c621..05fff7f14 100644 --- a/crates/horizon-mods/src/index/registry.rs +++ b/crates/horizon-mods/src/index/registry.rs @@ -231,6 +231,7 @@ pub fn project(entry: &Entry, src: &Sources) -> Result> { icon, key: entry.key.as_ref().map(|k| k.trim().to_owned()), versions, + downloads: 0, }) } diff --git a/crates/horizon-mods/src/index/tests.rs b/crates/horizon-mods/src/index/tests.rs index ef0299ad9..486704b7d 100644 --- a/crates/horizon-mods/src/index/tests.rs +++ b/crates/horizon-mods/src/index/tests.rs @@ -34,8 +34,14 @@ fn reads_the_sample_and_keeps_unknown_kinds() { [Capability::GameRead, Capability::Hud, Capability::Chat] ); // What CI writes reads back the same. - let again = Index::parse(&serde_json::to_string(&index).unwrap()).unwrap(); + let text = serde_json::to_string(&index).unwrap(); + let again = Index::parse(&text).unwrap(); assert_eq!(again, index); + // Download counts: the publish job adds them; none is left out. + assert_eq!(hud.downloads, 0); + assert!(!text.contains("downloads")); + let counted = text.replacen("\"versions\"", "\"downloads\":12345,\"versions\"", 1); + assert_eq!(Index::parse(&counted).unwrap().projects[0].downloads, 12345); } #[test] diff --git a/crates/horizon-port-pack/src/fetch.rs b/crates/horizon-port-pack/src/fetch.rs index f2803baa2..82c1ea794 100644 --- a/crates/horizon-port-pack/src/fetch.rs +++ b/crates/horizon-port-pack/src/fetch.rs @@ -143,7 +143,9 @@ pub fn fetch( if let Some((dest, url)) = crate::worldgen::loader_jar(work, &pack.loader, &pack.loader_version) .filter(|(dest, _)| !dest.exists()) { - let sha1 = ureq::get(&format!("{url}.sha1")) + let checksum = format!("{url}.sha1"); + let sha1 = crate::net::agent(&checksum) + .get(&checksum) .set("User-Agent", modrinth::AGENT) .call() .ok() @@ -201,7 +203,8 @@ pub fn url_of(file: &PackFile, cache: &Cache) -> Option { /// Downloads `url` to `dest`, kept only if its SHA-1 is `sha1`. fn download(url: &str, sha1: Option<&str>, dest: &Path) -> Result<(), String> { - let response = ureq::get(url) + let response = crate::net::agent(url) + .get(url) .set("User-Agent", modrinth::AGENT) .call() .map_err(|e| format!("{url}: {e}"))?; diff --git a/crates/horizon-port-pack/src/lib.rs b/crates/horizon-port-pack/src/lib.rs index b47c93754..3b77aec63 100644 --- a/crates/horizon-port-pack/src/lib.rs +++ b/crates/horizon-port-pack/src/lib.rs @@ -16,6 +16,7 @@ pub mod jar; pub(crate) mod legacy_structure_mods; mod lithostitched; pub mod modrinth; +pub mod net; pub mod oracle; pub mod pipeline; pub mod processors; diff --git a/crates/horizon-port-pack/src/modrinth.rs b/crates/horizon-port-pack/src/modrinth.rs index 4e90c871a..17d6b3222 100644 --- a/crates/horizon-port-pack/src/modrinth.rs +++ b/crates/horizon-port-pack/src/modrinth.rs @@ -79,7 +79,8 @@ impl Cache { } fn post(url: &str, body: &Value) -> Result { - let response = ureq::post(url) + let response = crate::net::agent(url) + .post(url) .set("User-Agent", AGENT) .set("Content-Type", "application/json") .send_string(&body.to_string()) @@ -88,7 +89,8 @@ fn post(url: &str, body: &Value) -> Result { } fn get(url: &str) -> Result { - let response = ureq::get(url) + let response = crate::net::agent(url) + .get(url) .set("User-Agent", AGENT) .call() .map_err(|e| format!("{url}: {e}"))?; diff --git a/crates/horizon-port-pack/src/net.rs b/crates/horizon-port-pack/src/net.rs new file mode 100644 index 000000000..d829d1357 --- /dev/null +++ b/crates/horizon-port-pack/src/net.rs @@ -0,0 +1,352 @@ +//! The agents port-pack's downloads go through: the jars of an imported modpack come from the same +//! places as everything else, so they take the same proxy — and leave the same hosts alone. +//! +//! The launcher hands its own setting over (`set_proxy`, from `proxy.rs`); a run of the +//! `horizon-port-pack` command reads `HTTPS_PROXY`, `HTTP_PROXY` and `ALL_PROXY` instead (`env_for`), +//! taking the one that matches the address's scheme the way the launcher does. Either way a host in +//! `NO_PROXY`, or on this computer, is reached directly: a host that only answers without the proxy +//! would otherwise fail here while the launcher's own downloads worked. +//! +//! Which hosts those are is decided here and nowhere else. The launcher asks `direct`, `env_for`, +//! `host_of`, `scheme_of`, `socks` and `parse` for its own traffic, and keeps its agents here too +//! (`keep`), so the two agree whatever the player set — and there is one copy of the rules to +//! change when they need it. +use std::collections::HashMap; +use std::sync::atomic::{AtomicBool, Ordering}; +use std::sync::{Mutex, MutexGuard}; + +/// What the launcher set, when it did. +static PROXY: Mutex> = Mutex::new(None); + +/// Agents kept for reuse, named by the part that asked and the proxy they use: a fresh `Agent` +/// starts a new connection pool, so building one per request costs a handshake per file. +static KEPT: Mutex>> = Mutex::new(None); + +/// The proxy to use from now on: the launcher's setting, or None to fall back to the environment. +/// The agents built so far are dropped when it changes, since they hold the address it replaces. +pub fn set_proxy(spec: Option) { + let spec = spec.map(|s| s.trim().to_owned()).filter(|s| !s.is_empty()); + let mut proxy = lock(&PROXY); + if *proxy == spec { + return; + } + *proxy = spec; + drop(proxy); + *lock(&KEPT) = None; +} + +/// The proxy address `url` is fetched through: what the launcher set, else the environment's for +/// its scheme, unless `url` is a host that must be reached directly. +fn spec_for(url: &str) -> Option { + if direct(url) { + return None; + } + lock(&PROXY) + .clone() + .or_else(|| env_for(scheme_of(url).unwrap_or("https"))) +} + +/// An agent for downloading `url`: through the proxy when one is set, unless `url` is a host that +/// must be reached directly. +pub fn agent(url: &str) -> ureq::Agent { + keep("port-pack", spec_for(url).as_deref(), |proxy| { + let builder = ureq::AgentBuilder::new(); + match proxy { + Some(proxy) => builder.proxy(proxy).build(), + None => builder.build(), + } + }) +} + +/// The agent `url` is fetched with, built by `build` and then kept for the next request that names +/// the same `slot` and proxy: a fresh `Agent` starts a new connection pool, so building one per +/// request is a handshake per file, and a modpack's jars are fetched one after another. +pub fn keep( + slot: &str, + spec: Option<&str>, + build: impl FnOnce(Option) -> ureq::Agent, +) -> ureq::Agent { + let proxy = spec.and_then(parse); + // An address that isn't a proxy is used as none, and remembered as none. + let key = format!( + "{slot} {}", + if proxy.is_some() { + spec.unwrap_or_default() + } else { + "" + } + ); + if let Some(agent) = lock(&KEPT).as_ref().and_then(|kept| kept.get(&key)) { + return agent.clone(); + } + let agent = build(proxy); + lock(&KEPT) + .get_or_insert_with(HashMap::new) + .insert(key, agent.clone()); + agent +} + +/// `spec` as a proxy, when it is one. An address that can't be used is said once: a download left +/// to go direct would otherwise fail with nothing pointing at the proxy. +pub fn parse(spec: &str) -> Option { + if socks(spec) { + say(&format!( + "{spec} is a SOCKS proxy; downloads go without one. Write the http:// address your \ + proxy app listens on as well." + )); + return None; + } + match ureq::Proxy::new(spec) { + Ok(proxy) => Some(proxy), + Err(e) => { + say(&format!( + "The proxy address {spec} can't be used ({e}); downloads go without one." + )); + None + } + } +} + +/// Whether `spec` names a SOCKS proxy, which these downloads don't go through: `ureq` reads a +/// SOCKS address happily and only fails when it connects through it. +pub fn socks(spec: &str) -> bool { + matches!( + spec.split_once("://") + .map(|(s, _)| s.to_ascii_lowercase()) + .as_deref(), + Some("socks" | "socks4" | "socks4a" | "socks5" | "socks5h") + ) +} + +/// Whether `url` is reached without the proxy: a local address, or a host `NO_PROXY` names. The +/// launcher asks this of its own requests, so both reach the same hosts directly. +pub fn direct(url: &str) -> bool { + host_of(url).is_some_and(|host| local(host) || excluded(host, &no_proxy())) +} + +/// `HTTPS_PROXY` (`HTTP_PROXY` for an http address), then `ALL_PROXY`, in the upper-case spelling +/// first and the lower-case one after, as the tools that write them do. +pub fn env_for(scheme: &str) -> Option { + let names: &[&str] = if scheme.eq_ignore_ascii_case("http") { + &["HTTP_PROXY", "http_proxy", "ALL_PROXY", "all_proxy"] + } else { + &["HTTPS_PROXY", "https_proxy", "ALL_PROXY", "all_proxy"] + }; + names.iter().find_map(|name| { + std::env::var(name) + .ok() + .map(|v| v.trim().to_owned()) + .filter(|v| !v.is_empty()) + }) +} + +/// `NO_PROXY`'s list: the hosts reached directly whatever the proxy is. +fn no_proxy() -> String { + ["NO_PROXY", "no_proxy"] + .iter() + .find_map(|name| std::env::var(name).ok()) + .unwrap_or_default() +} + +/// The host part of a URL (`https://user@host:port/path` is `host`). +pub fn host_of(url: &str) -> Option<&str> { + let rest = url.split_once("://").map_or(url, |(_, rest)| rest); + let rest = rest.split(['/', '?', '#']).next()?; + let rest = rest.rsplit_once('@').map_or(rest, |(_, host)| host); + Some(match rest.rfind(':') { + // A port follows the last colon; an IPv6 literal keeps the colons inside its brackets. + Some(at) if !rest[at..].contains(']') => &rest[..at], + _ => rest, + }) +} + +/// `https` in `https://…`, or None for anything that isn't an absolute address. +pub fn scheme_of(url: &str) -> Option<&str> { + url.split_once("://").map(|(scheme, _)| scheme) +} + +/// Whether `host` is this computer: the game's own API and a server on the same machine. +fn local(host: &str) -> bool { + let host = bare(host); + host == "localhost" + || host.ends_with(".localhost") + || host == "::1" + || host == "0.0.0.0" + || host.starts_with("127.") +} + +/// Whether `host` is in `NO_PROXY`: `*`, `host`, `.domain`, `*.domain` and `host:port` entries. +fn excluded(host: &str, no_proxy: &str) -> bool { + let host = bare(host); + no_proxy + .split(',') + .map(str::trim) + .filter(|e| !e.is_empty()) + .any(|entry| { + if entry == "*" { + return true; + } + let entry = entry.trim_start_matches('*').trim_start_matches('.'); + let entry = match entry.rfind(':') { + Some(at) if !entry[at..].contains(']') => &entry[..at], + _ => entry, + }; + let entry = bare(entry); + !entry.is_empty() && (host == entry || host.ends_with(&format!(".{entry}"))) + }) +} + +/// A host without the brackets an IPv6 literal wears, lower case. +fn bare(host: &str) -> String { + host.trim().trim_matches(['[', ']']).to_ascii_lowercase() +} + +/// Said once, however many downloads follow: a wrong address is one thing to report, not one +/// report per file. +fn say(what: &str) { + static SAID: AtomicBool = AtomicBool::new(false); + if !SAID.swap(true, Ordering::Relaxed) { + eprintln!("{what}"); + } +} + +/// The lock, even after a thread panicked while holding it: an address lost to a panic is worse +/// than an old one kept. +fn lock(m: &Mutex) -> MutexGuard<'_, T> { + m.lock().unwrap_or_else(|e| e.into_inner()) +} + +#[cfg(test)] +mod tests { + use super::*; + + /// What the tests below share, since the address and the agents are one of each for the whole + /// process: they take it in turn. + fn alone() -> MutexGuard<'static, ()> { + static TURN: Mutex<()> = Mutex::new(()); + lock(&TURN) + } + + #[test] + fn a_proxy_the_launcher_sets_is_trimmed_and_kept() { + let _turn = alone(); + set_proxy(Some(" http://127.0.0.1:7890 ".into())); + assert_eq!( + PROXY.lock().unwrap().as_deref(), + Some("http://127.0.0.1:7890") + ); + set_proxy(Some(" ".into())); + assert!(PROXY.lock().unwrap().is_none()); + } + + /// An address on this computer is reached directly whatever `NO_PROXY` says: what an import + /// needs when the launcher's own requests to it go direct. + #[test] + fn a_local_address_is_reached_directly() { + assert!(direct("http://127.0.0.1:8130/api/v1/status")); + assert!(direct("http://localhost/api/v1/status")); + assert!(direct("https://[::1]:25565/")); + } + + #[test] + fn a_host_is_read_out_of_the_address() { + assert_eq!( + host_of("https://cdn.modrinth.com/v2/x.jar"), + Some("cdn.modrinth.com") + ); + assert_eq!( + host_of("https://user:pass@piston-meta.mojang.com:8443/a"), + Some("piston-meta.mojang.com") + ); + assert_eq!( + host_of("http://127.0.0.1:8130/api/v1/status"), + Some("127.0.0.1") + ); + assert_eq!(host_of("https://[::1]:25565/"), Some("[::1]")); + assert_eq!(host_of("https://example.com?x=1"), Some("example.com")); + assert_eq!(host_of("https://example.com#top"), Some("example.com")); + } + + #[test] + fn only_absolute_addresses_have_a_scheme() { + assert_eq!(scheme_of("https://a.b"), Some("https")); + assert_eq!(scheme_of("http://a.b"), Some("http")); + assert_eq!(scheme_of("a.b/c"), None); + } + + #[test] + fn this_computer_is_never_proxied() { + for host in [ + "localhost", + "LOCALHOST", + "[::1]", + "::1", + "127.0.0.1", + "127.1.2.3", + ] { + assert!(local(host), "{host}"); + } + for host in ["playhorizon.dev", "api.minecraftservices.com", "10.0.0.1"] { + assert!(!local(host), "{host}"); + } + } + + /// What an import with `NO_PROXY=modrinth.com` needs: the launcher's own requests to it go + /// direct, so the jars fetched for it must too. + #[test] + fn no_proxy_lists_hosts_and_their_subdomains() { + assert!(excluded("anything.at.all", "*")); + assert!(excluded("cdn.modrinth.com", "modrinth.com")); + assert!(excluded("api.modrinth.com", "modrinth.com")); + assert!(excluded("piston-meta.mojang.com", "mojang.com")); + assert!(excluded( + "wiki.corp.example", + " .corp.example , other.host " + )); + assert!(excluded("github.com", "github.com:443")); + assert!(!excluded("notmodrinth.com", "modrinth.com")); + assert!(!excluded("modrinth.com", " .corp.example , mojang.com ")); + assert!(!excluded("edge.forgecdn.net", "modrinth.com")); + assert!(!excluded("modrinth.com", "")); + } + + #[test] + fn an_address_that_cant_be_used_becomes_no_proxy() { + assert!(parse("http://127.0.0.1:7890").is_some()); + assert!(parse("127.0.0.1:7890").is_some()); + // `ureq` reads a SOCKS address and only fails once it connects through it. + assert!(socks("socks5://127.0.0.1:7891")); + assert!(parse("socks5://127.0.0.1:7891").is_none()); + assert!(!socks("http://127.0.0.1:7890")); + } + + /// The agent a second request gets is the one the first built: one connection pool, not one + /// handshake per jar. + #[test] + fn an_agent_is_kept_for_the_next_request() { + let _turn = alone(); + set_proxy(None); + let mut built = 0; + for _ in 0..3 { + keep("kept", None, |_| { + built += 1; + ureq::AgentBuilder::new().build() + }); + } + assert_eq!(built, 1, "three requests, one agent"); + // Another address is another agent, and a new setting drops the ones before it. + keep("kept", Some("http://127.0.0.1:7890"), |proxy| { + assert!(proxy.is_some()); + built += 1; + ureq::AgentBuilder::new().build() + }); + assert_eq!(built, 2, "a second address needs a second agent"); + set_proxy(Some("http://127.0.0.1:7891".into())); + keep("kept", Some("http://127.0.0.1:7891"), |_| { + built += 1; + ureq::AgentBuilder::new().build() + }); + assert_eq!(built, 3, "a new setting drops the agents kept before it"); + set_proxy(None); + } +} diff --git a/crates/horizon-protocol/src/item.rs b/crates/horizon-protocol/src/item.rs index abc530278..259aeb2d1 100644 --- a/crates/horizon-protocol/src/item.rs +++ b/crates/horizon-protocol/src/item.rs @@ -35,6 +35,7 @@ pub mod component { pub const MAP_ID: i32 = 48; pub const MAP_POST_PROCESSING: i32 = 50; pub const CHARGED_PROJECTILES: i32 = 51; + pub const BUNDLE_CONTENTS: i32 = 52; pub const POTION_CONTENTS: i32 = 53; pub const WRITABLE_BOOK_CONTENT: i32 = 56; pub const WRITTEN_BOOK_CONTENT: i32 = 57; @@ -192,7 +193,7 @@ impl Component { resolved: r.bool()?, }) } - CHARGED_PROJECTILES => { + CHARGED_PROJECTILES | BUNDLE_CONTENTS => { let n = r.count(1024)?; Self::Stacks((0..n).map(|_| Template::read(r)).collect::>()?) } @@ -784,6 +785,21 @@ mod tests { assert_eq!(w.data, bytes); } + #[test] + fn bundle_contents_are_item_stack_templates() { + // A bundle (id 7) holding 32 of item 9: BundleContents is a list of + // ItemStackTemplate, as ChargedProjectiles is. + let bytes = [1, 7, 1, 0, 52, 1, 9, 32, 0, 0]; + let stack = Slot::read(&mut Reader::new(&bytes)).unwrap().unwrap(); + assert_eq!( + stack.component(component::BUNDLE_CONTENTS), + Some(&Component::Stacks(vec![Stack::new(9, 32)])) + ); + let mut w = Writer::new(); + Slot::write(&Some(stack), &mut w); + assert_eq!(w.data, bytes); + } + #[test] fn filtered_book_pages_are_read_and_dropped() { // A writable book with one page "hi" and its filtered "**". diff --git a/crates/horizon-protocol/src/lib.rs b/crates/horizon-protocol/src/lib.rs index f0bea2ca2..299688560 100644 --- a/crates/horizon-protocol/src/lib.rs +++ b/crates/horizon-protocol/src/lib.rs @@ -11,6 +11,7 @@ pub mod frame; pub mod ids; pub mod item; pub mod packets; +pub mod quiet; pub mod registry; mod resolver; pub mod rsa; diff --git a/crates/horizon-protocol/src/quiet.rs b/crates/horizon-protocol/src/quiet.rs new file mode 100644 index 000000000..dcf48dbee --- /dev/null +++ b/crates/horizon-protocol/src/quiet.rs @@ -0,0 +1,166 @@ +//! Quiet commands: a client mod's batch of commands that a Horizon server runs +//! as the player who sent them, at that player's own permission level, with +//! no feedback in the chat (docs/mods.md, `command.run-quiet`). +//! +//! The server announces it understands them with an empty [`CHANNEL`] payload +//! in the configuration phase (a vanilla client ignores it); a client that +//! hears it sends each batch as a serverbound [`CHANNEL`] payload, and falls +//! back to chat commands on any other server. A payload is the mod's id, then +//! the lines without their slash. +use crate::{ + Error, Result, + buf::{Reader, Writer}, +}; + +/// The custom payload channel, both ways. +pub const CHANNEL: &str = "horizon:quiet_commands"; +/// Lines in one payload at most; a payload with more is refused whole. +pub const MAX_LINES: usize = 256; +/// Characters in a line at most (a chat command's limit). +pub const MAX_LINE: usize = 256; +/// Characters in a mod id at most. +pub const MAX_MOD_ID: usize = 64; +/// Bytes of a serverbound custom payload's data at most +/// (ServerboundCustomPayloadPacket.MAX_PAYLOAD_SIZE). +pub const MAX_PAYLOAD: usize = 32767; + +/// A batch as the server reads it. +#[derive(Clone, Debug, PartialEq)] +pub struct Batch { + pub mod_id: String, + pub lines: Vec, +} + +/// `lines` as few payloads as fit [`MAX_PAYLOAD`] and [`MAX_LINES`], in +/// order. Lines longer than [`MAX_LINE`] are cut, as a chat command's are. +pub fn encode(mod_id: &str, lines: &[String]) -> Vec> { + let mod_id: String = mod_id.chars().take(MAX_MOD_ID).collect(); + let mut payloads = Vec::new(); + let mut rest = lines + .iter() + .map(|l| -> String { l.chars().take(MAX_LINE).collect() }); + let mut next = rest.next(); + while next.is_some() { + let mut batch = Vec::new(); + // The id, the count (a varint of at most 2 bytes for 256). + let mut size = string_size(&mod_id) + 2; + while let Some(line) = next.take() { + let more = string_size(&line); + if !batch.is_empty() && (batch.len() == MAX_LINES || size + more > MAX_PAYLOAD) { + next = Some(line); + break; + } + size += more; + batch.push(line); + next = rest.next(); + } + let mut w = Writer::new(); + w.string(&mod_id); + w.varint(batch.len() as i32); + for line in &batch { + w.string(line); + } + payloads.push(w.data); + } + payloads +} + +fn string_size(s: &str) -> usize { + crate::buf::varint_size(s.len() as i32) + s.len() +} + +/// A payload's batch; an error for one that breaks a cap. +pub fn decode(data: &[u8]) -> Result { + if data.len() > MAX_PAYLOAD { + return Err(Error::new("quiet commands: payload too big")); + } + let mut r = Reader::new(data); + let mod_id = r.string(MAX_MOD_ID)?; + let count = r.varint()?; + if !(0..=MAX_LINES as i32).contains(&count) { + return Err(Error::new(format!("quiet commands: {count} lines"))); + } + let lines = (0..count) + .map(|_| r.string(MAX_LINE)) + .collect::>>()?; + if r.remaining() > 0 { + return Err(Error::new("quiet commands: trailing bytes")); + } + Ok(Batch { mod_id, lines }) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn a_batch_round_trips() { + let lines = vec!["fill 0 0 0 1 1 1 stone".to_string(), "say hi".to_string()]; + let payloads = encode("orbital", &lines); + assert_eq!(payloads.len(), 1); + assert_eq!( + decode(&payloads[0]).unwrap(), + Batch { + mod_id: "orbital".into(), + lines + } + ); + } + + #[test] + fn big_batches_split_by_lines_and_bytes() { + let lines: Vec = (0..600) + .map(|i| format!("setblock {i} 0 0 stone")) + .collect(); + let payloads = encode("m", &lines); + let decoded: Vec = payloads.iter().map(|p| decode(p).unwrap()).collect(); + assert_eq!( + decoded.iter().map(|b| b.lines.len()).collect::>(), + [256, 256, 88] + ); + assert_eq!( + decoded + .into_iter() + .flat_map(|b| b.lines) + .collect::>(), + lines + ); + let long: Vec = (0..256).map(|_| "x".repeat(300)).collect(); + for p in encode("m", &long) { + assert!(p.len() <= MAX_PAYLOAD); + assert!( + decode(&p) + .unwrap() + .lines + .iter() + .all(|l| l.len() == MAX_LINE) + ); + } + } + + #[test] + fn payloads_over_the_caps_are_refused() { + let mut w = Writer::new(); + w.string("m"); + w.varint(MAX_LINES as i32 + 1); + for _ in 0..=MAX_LINES { + w.string("say"); + } + assert!(decode(&w.data).is_err()); + let mut w = Writer::new(); + w.string("m"); + w.varint(1); + w.string(&"x".repeat(MAX_LINE + 1)); + assert!(decode(&w.data).is_err()); + let mut w = Writer::new(); + w.string("m"); + w.varint(-1); + assert!(decode(&w.data).is_err()); + assert!(decode(&[0xFF]).is_err()); + let mut w = Writer::new(); + w.string("m"); + w.varint(0); + w.u8(1); + assert!(decode(&w.data).is_err()); + } +} diff --git a/crates/horizon-theme/icons/pixel/star.svg b/crates/horizon-theme/icons/pixel/star.svg new file mode 100644 index 000000000..a27348730 --- /dev/null +++ b/crates/horizon-theme/icons/pixel/star.svg @@ -0,0 +1,3 @@ + + + diff --git a/crates/horizon-theme/src/lib.rs b/crates/horizon-theme/src/lib.rs index dac5bf8d2..ca4704ead 100644 --- a/crates/horizon-theme/src/lib.rs +++ b/crates/horizon-theme/src/lib.rs @@ -67,6 +67,8 @@ pub mod icons { "search", "server", "sliders", + // Not Pixelarticons': drawn for Horizon's ratings, in the same 2-unit grid. + "star", "terminal", "trash", "user", diff --git a/crates/horizon-world/src/living_motion.rs b/crates/horizon-world/src/living_motion.rs index b44da8b7b..9c496ed63 100644 --- a/crates/horizon-world/src/living_motion.rs +++ b/crates/horizon-world/src/living_motion.rs @@ -122,3 +122,119 @@ pub fn air_drag(world: &mut W) -> Result { }; Ok(modified_friction(drag, world.air_drag_modifier()? as f32)) } + +#[cfg(test)] +mod tests { + use super::*; + use horizon_core::geometry::{Vec3, trig}; + + struct Jumper { + velocity: Vec3, + sprinting: bool, + yaw: f32, + synced: bool, + } + impl LivingMotionWorld for Jumper { + type Error = (); + fn velocity(&self) -> Vec3 { + self.velocity + } + fn set_velocity(&mut self, velocity: Vec3) -> Result<(), ()> { + self.velocity = velocity; + Ok(()) + } + fn jump_strength(&mut self) -> Result { + Ok(0.42) + } + fn block_jump_factor(&mut self) -> Result { + Ok(1.0) + } + fn has_jump_boost(&mut self) -> Result { + Ok(false) + } + fn jump_boost_amplifier(&mut self) -> Result { + Ok(0) + } + fn sprinting(&mut self) -> Result { + Ok(self.sprinting) + } + fn yaw(&mut self) -> Result { + Ok(self.yaw) + } + fn mark_needs_sync(&mut self) { + self.synced = true; + } + fn no_gravity(&mut self) -> Result { + Ok(false) + } + fn gravity_attribute(&mut self) -> Result { + Ok(0.08) + } + fn has_slow_falling(&mut self) -> Result { + Ok(false) + } + fn controlling_passenger_is_player(&mut self) -> Result { + Ok(false) + } + fn speed(&mut self) -> Result { + Ok(0.1) + } + fn omnidirectional_air_mover(&mut self) -> Result { + Ok(false) + } + fn air_drag_modifier(&mut self) -> Result { + Ok(0.0) + } + } + + fn impulse(yaw: f32) -> (f64, f64) { + let angle = f64::from(yaw * trig::DEG_TO_RAD); + ( + f64::from(-trig::sin(angle)) * 0.2, + f64::from(trig::cos(angle)) * 0.2, + ) + } + + /// LivingEntity.jumpFromGround: a sprint adds ~0.2 along look; a walk does not. + #[test] + fn sprint_jump_adds_look_direction_impulse() { + for yaw in [0.0, 45.0, 90.0, 180.0, 270.0, 300.0] { + let before = Vec3::new(0.13, -0.08, -0.05); + let mut sprinting = Jumper { + velocity: before, + sprinting: true, + yaw, + synced: false, + }; + jump_from_ground(&mut sprinting).unwrap(); + let (dx, dz) = impulse(yaw); + let horizontal = ((dx * dx) + (dz * dz)).sqrt(); + assert!( + (horizontal - 0.2).abs() < 1.0e-4, + "yaw {yaw}: impulse length {horizontal}" + ); + assert!( + (sprinting.velocity.x - (before.x + dx)).abs() < 1.0e-9, + "yaw {yaw}: x {:?} expected {}", + sprinting.velocity, + before.x + dx + ); + assert!((sprinting.velocity.z - (before.z + dz)).abs() < 1.0e-9); + // jump_power narrows the 0.42 strength through float, as vanilla does. + let jump_y = f64::from(0.42_f32); + assert!((sprinting.velocity.y - jump_y).abs() < 1.0e-9); + assert!(sprinting.synced); + + let mut walking = Jumper { + velocity: before, + sprinting: false, + yaw, + synced: false, + }; + jump_from_ground(&mut walking).unwrap(); + assert_eq!(walking.velocity.x, before.x); + assert_eq!(walking.velocity.z, before.z); + assert!((walking.velocity.y - jump_y).abs() < 1.0e-9); + } + } +} diff --git a/docs/api/mod-index.md b/docs/api/mod-index.md index e8476cdf0..ea605fbc7 100644 --- a/docs/api/mod-index.md +++ b/docs/api/mod-index.md @@ -18,7 +18,7 @@ Level: preview ([stability.md](stability.md)). Schema 1. "projects": [{ "id": "coords_hud", "kind": "mod", "name": "Coordinates HUD", "summary": "One line.", "description": "Markdown.", "authors": ["Horizon"], "owners": ["ludovic111"], - "license": "MIT", "source": "https://github.com/...", "icon": "https://...png", "key": "RWT...", + "license": "MIT", "source": "https://github.com/...", "icon": "https://...png", "key": "RWT...", "downloads": 1234, "versions": [{ "version": "0.1.0", "published": "2026-10-24", "changelog": "", "api": "0.1", "side": "client", "capabilities": ["game-read", "hud", "chat"], "api_level": 0, "game": "26.3", @@ -41,6 +41,7 @@ Level: preview ([stability.md](stability.md)). Schema 1. | `icon` | `https://`, optional. | | `key` | The author's [minisign](https://jedisct1.github.io/minisign/) public key. When set, every version must be signed with it; an update signed with another key is refused. Absent: the project is unsigned and the launcher says so. | | `versions` | Newest first, at least one. | +| `downloads` | How many times its files were downloaded, every version together: GitHub's count of each release asset, summed by the publish job, which runs every hour. Absent until a file is downloaded. Read-only: never in an entry. | | `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. | @@ -167,6 +168,7 @@ opens. ## Changelog +- 2026-10-26: `projects[].downloads`, GitHub's download counts of a project's files, refreshed every hour. - 2026-10-26: the launcher installs `shader` files into `shaderpacks/`; the sample index lists one (`glow`). - 2026-10-25: `shader` opens, checked by `horizon_shader_api::check`; its files are `.hshader`. - Schema 1 (2026-10-24): kinds `mod`, `modpack`, `resourcepack`, `shader`; `.hpack` format 1. diff --git a/docs/api/mods.md b/docs/api/mods.md index 59f4221a3..1fc7a834e 100644 --- a/docs/api/mods.md +++ b/docs/api/mods.md @@ -1,7 +1,7 @@ # Mod API -Mods are Rust crates compiled to sandboxed WebAssembly components. They run in the player's game and, once server -mods land, wherever a world is simulated. Design and the runtime: [mods.md](../mods.md). +Mods are Rust crates compiled to sandboxed WebAssembly components. Client mods run in the player's game; server mods +(experimental) run wherever a world is simulated: single player, a LAN host, the dedicated server. Design and the runtime: [mods.md](../mods.md). ## Overview @@ -87,9 +87,10 @@ release. What real mods need next, in the order modpacks and servers need it: -- **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. +- **More for server mods** (`api = "0.3"`, [Server mods](../mods.md#server-mods-api-03-experimental)): they run + on the server thread, a LAN host and the dedicated server today, with joins, chat, commands and players' block + breaking and placing; next entity events, game rules, server commands with typed arguments sent to clients' + command trees. - **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. @@ -105,6 +106,7 @@ What real mods need next, in the order modpacks and servers need it: ## Changelog +- Server mods run in the game: single player (server thread and in-frame), LAN hosts, the dedicated server. - 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. diff --git a/docs/design-system.md b/docs/design-system.md index e1417f749..66767c0b7 100644 --- a/docs/design-system.md +++ b/docs/design-system.md @@ -168,6 +168,11 @@ of the main action. The game's menus keep `LIGHT` and `DARK`. ships no third-party pictures. The Horizon instance shows a grass block drawn from the player's own prepared Minecraft textures. Sources are named in text ("from Modrinth"): Modrinth's logo is all rights reserved, so it is not shown. +- **Partner banner**: the one exception to shipping no third-party pictures. Sculk, a server host, + sponsors Horizon: its banner (`launcher/assets/sculk-banner.webp`, `launcher/src/partner.rs`) sits + under a muted mono "Partner" label at the end of the Servers page and of Home, below Play, and opens + Sculk's page in the browser. The website shows the same banner the same way on Home and the hosting + docs, as a `rel="sponsored"` link. - **Pixel art drawn in code.** The stone behind the pages is close shades of the page colour (`TILE_SHADES`), never Minecraft's stone; the landscape is a banded sky, a sun cut in slices like the mark, hills and square trees (a sunset in dark, a dawn in light). The launcher bakes them in diff --git a/docs/graphics.md b/docs/graphics.md index d4261df81..dcba29773 100644 --- a/docs/graphics.md +++ b/docs/graphics.md @@ -21,14 +21,16 @@ Every row has a one-line description and its cost in frame time (none, low, medi | Quality | smooth lighting, mipmap levels, biome blend, clouds, cloud distance, weather radius, particles, entity shadows, cutout leaves | `options.txt` | | | sky, fog, weather, animated textures | `horizon-graphics.txt` | | Display | FOV, max framerate, VSync, fullscreen, GUI scale | `options.txt` | -| | resolution scale, anti-aliasing (FXAA), present mode, frame pacing | `horizon-graphics.txt` | +| | resolution scale, anti-aliasing (FXAA), HDR, paper white, peak brightness, present mode, frame pacing | `horizon-graphics.txt` | | Performance | battery mode, worker threads, upload budget per frame | `horizon-graphics.txt` | | Overlay | performance overlay: FPS, frame/CPU/GPU times, frame-time graph | `horizon-graphics.txt` | -`options.txt` keeps exactly vanilla's keys and values, so the options harness still compares it with vanilla; Horizon's settings live in `horizon-graphics.txt` beside it. Their defaults render as vanilla does: cave culling on, no upload budgets, sky, fog and weather on, 100% resolution, no FXAA, the present mode following VSync. VSync on always waits for the display (Fifo), in a window and in fullscreen, as in vanilla; the present mode setting chooses how frames are shown only while VSync is off. Frame pacing defaults to Efficient: the limiter sleeps through the last half millisecond where vanilla spins, which changes timing, not pixels. +`options.txt` keeps exactly vanilla's keys and values, so the options harness still compares it with vanilla; Horizon's settings live in `horizon-graphics.txt` beside it. Their defaults render as vanilla does: cave culling on, no upload budgets, sky, fog and weather on, 100% resolution, no FXAA, HDR off, the present mode following VSync. VSync on always waits for the display (Fifo), in a window and in fullscreen, as in vanilla; the present mode setting chooses how frames are shown only while VSync is off. Frame pacing defaults to Efficient: the limiter sleeps through the last half millisecond where vanilla spins, which changes timing, not pixels. **Battery mode** (Performance, off by default) is for laptops and handhelds: at most 60 frames per second in a world, 30 in menus without a world or while another window has focus, and half the automatic worker threads (chunks load slower). It changes only when frames are drawn: what they show and the game's 20 ticks per second stay as they are. +**HDR** (Display, off by default) presents to an scRGB swapchain (`Rgba16Float`, extended linear sRGB) on displays and compositors that offer it. The frame is drawn exactly as in SDR, in vanilla's gamma space, and a last pass (`hdr.wgsl`) decodes it to linear light at the **Paper White** and lifts light sources (blocks that emit light, lava, the sun and the moon) towards the **Peak Brightness**; everything else stays as in SDR. The mesher puts the light a block's face emits in its vertex colour's alpha (`EMISSION_BITS`), the frame's alpha carries the mark, and only pixels that still show the world before the hand and HUD are lifted. On Vulkan, `horizon-hdr` sends HDR metadata (MaxCLL, mastering luminance), which wgpu doesn't: without it a compositor may clip everything above SDR white. KWin maps the content's reference white onto the desktop's SDR brightness, so on Linux the default Paper White matches SDR mode. `HORIZON_HDR_DEBUG=1` paints lifted pixels magenta. Not lifted yet: glowing particles, distant LOD terrain. + Which settings each screen shows, their descriptions and costs are in `crates/horizon-client/src/graphics_ui.rs` (`rows`); `graphics_style.rs` draws them. ## Distant terrain diff --git a/docs/launcher-commands.md b/docs/launcher-commands.md index f3ef37977..1e9fb7722 100644 --- a/docs/launcher-commands.md +++ b/docs/launcher-commands.md @@ -132,11 +132,11 @@ MCP: `account_offline`. ## `horizon-launcher settings` -Show the launcher's settings, or set one (the Settings page): selected-version TAG, minecraft-dir PATH, server-dir PATH ("default" resets a folder), install-new-versions on|off, opening-animation on|off. +Show the launcher's settings, or set one (the Settings page): selected-version TAG, minecraft-dir PATH, server-dir PATH ("default" resets a folder), install-new-versions on|off, opening-animation on|off, proxy http://host:port ("default" removes it). horizon-launcher settings [KEY] [VALUE] -- `KEY` (selected-version, minecraft-dir, server-dir, install-new-versions, opening-animation) +- `KEY` (selected-version, minecraft-dir, server-dir, install-new-versions, opening-animation, proxy) - `VALUE`: The new value (with KEY) MCP: `settings`. diff --git a/docs/mods.md b/docs/mods.md index 0d26978dc..755508e05 100644 --- a/docs/mods.md +++ b/docs/mods.md @@ -491,10 +491,40 @@ its component targets the WIT world `horizon-server-mod` instead of 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. +[`welcome`](../crates/horizon-mod-sdk/examples/welcome/src/lib.rs). + +**Where they run.** The game that simulates the world starts the server mods +that are on, and only that one: + +| Mode | Runs server mods | Players they see | +|---|---|---| +| Single player (default) | the server thread | the window's player, a connection like any other | +| Single player `--in-frame` | the window's own game, beside its client mods | the window's player | +| Open to LAN, Play with Friends | the host's server thread (or its window, in-frame) | the host and every guest | +| Dedicated server (`--dedicated`, `horizon-server`) | the server | every connected player | + +A window that is a client of a server (single player's window, a LAN guest, +any multiplayer server) never runs them; its Mods page lists a server mod with +the others, and its switch takes effect the next time a world opens. The mods +live in `horizon-mods/` of the game folder, or of the server's folder on a +dedicated server, and are turned on as client mods are: Options > Mods, or +`mod.:true` in `horizon-mods.txt`. `--dev-mod ` runs one always +on and reloads it when its file changes, on a server too. + +**When hooks run.** At the end of each server tick the game tells the server +mods who joined and who left since the last one, then what players said, +broke and placed, in order, then calls `tick`. A command a player types +reaches its mod at once, whatever the player's permission level, and its +answer goes to that player. `tell` reaches one player, the window's own +chat for the in-frame player and a system message for a connection; +`broadcast` reaches every player and the server's log. With no server mod +on, each of these points costs one branch (measured in the PR that added +them). + +**Not yet.** Clients aren't sent server mods' commands with vanilla's +command tree, so a player's chat box doesn't complete or colour them; typing +them works. Block events are a player's own breaking and placing, not +explosions, pistons or other mods. ## Publish your mod @@ -515,6 +545,10 @@ published. Players find them at [playhorizon.dev/mods](https://playhorizon.dev/m 5. A reviewer merges it: within minutes the file is a release of horizon-mods, and the project is on the site and in the launcher. +Once it is published, its page and its card in the launcher show its downloads (GitHub's counts of its files, +refreshed every hour) and its rating: players signed in with GitHub on its page give it 1 to 5 stars, one rating per +account, which they can change. Its owners can't rate it, and nobody sees who rated. + An update is the same form with a new version; only the project's `owners` can publish one, signed with its key if it has one. A published file never changes. Without the form, open the pull request by hand (the repository's README says how). The formats: [api/mod-index.md](api/mod-index.md). @@ -561,10 +595,10 @@ so the same rustc and `Cargo.lock` give the same file. in single player and on any server, vanilla or Horizon. They see only what the client already knows (the snapshot), like F3 does, and act only on the local screen and chat. A server cannot see them. -- **Server mods** (`side = "server"`) will run where the world is simulated: - Horizon's integrated server in single player and LAN, and the dedicated - server. Vanilla clients can join if the mod only uses vanilla content - (rules, commands, events). +- **Server mods** (`side = "server"`, API 0.3) run where the world is + simulated: single player's server thread (or the window, in-frame), a LAN + host and the dedicated server ([Server mods](#server-mods-api-03-experimental)). + They use only vanilla messages, so any client, vanilla or Horizon, can join. - **Both** (`side = "both"`): a server mod with a client half (new blocks, their textures, a custom screen). On join the Horizon server announces its mods (id, version, SHA-256) on a `horizon:mods` custom payload channel; a diff --git a/docs/release-flow.md b/docs/release-flow.md index 7bb64d21e..ce7934824 100644 --- a/docs/release-flow.md +++ b/docs/release-flow.md @@ -28,12 +28,12 @@ The job is `.github/workflows/parity.yml`, a reusable workflow: `checks` calls i repository, `run-parity.yml` for a fork's pull request a maintainer labels `run-parity`. Horizon never downloads the game, so harnesses that compare with vanilla run only where the maintainer's own -copy is: the Mac mini and his Linux desktop. Their runners run as the maintainer's account and keep their checkout +copy is: the Mac mini, his Linux desktop and playhorizon (below). Their runners run as the maintainer's account and keep their checkout between runs (`clean: false`), so the probes build incrementally into `.local/parity-target` and earlier passes stand. 1. `tools/ci/runner-env.sh` puts the machine's Python 3.13 and the JDK `research-lock.json` pins on the PATH - (Homebrew and `java_home` on the Mac; on NixOS what `linux-runner.sh` pinned, else nixpkgs), and sccache when + (Homebrew and `java_home` on the Mac; on Linux what `linux-runner.sh` pinned, else nixpkgs), and sccache when the machine has it. 2. `tools/ci/vanilla-data.sh` links `.local/` to the runner's copy of the vanilla data, cloned once from `~/code/horizon-parity/shared-local` into `~/.actions-runners/horizon/_work/horizon/shared-local`, and @@ -94,6 +94,15 @@ same. The nightly audit and parity-main stay on the Mac mini's runners: the audi so it stays on one platform, and a parity-main job slowed down on the desktop because he came back could time out, and its failures bisect and comment on merges. +**playhorizon's runner.** `playhorizon-horizon` runs on a server a hosting partner lends the project (Ubuntu, 8 +AMD EPYC threads, 30 GB, in Detroit; reachable only through the maintainer's tailnet). Nobody sits at it, so the +watcher never pauses it except by hand, and it gets the machine: `RUNNER_CPUS=7 RUNNER_MEMORY=24 RUNNER_JOBS=6`. +Without Nix, `linux-runner.sh` takes the build libraries, the JDK, sccache, Xvfb and Mesa's software Vulkan +(lavapipe; there is no GPU) from apt, and Python 3.13 from uv. The partner can reach the machine, so gh is not +logged in there: the registration token comes from another machine (`RUNNER_TOKEN`), and no job with secrets may +run there (parity has none). It is also a parity host (`playhorizon` in `tools/parity_hosts.json`, 6 jobs). Like +the desktop's, it gets the `horizon-game` label only once a full trial has passed there. + ## Merging Pull requests merge with a merge commit. The orchestrator sessions review a pull request, then turn on diff --git a/launcher/README.md b/launcher/README.md index 1c0ea5522..9c6f3a9d9 100644 --- a/launcher/README.md +++ b/launcher/README.md @@ -79,7 +79,8 @@ page `servers.json` (the list), `servers//` (the servers created there) an - **Settings**: install new Horizon versions automatically (on unless you turn it off; the selected version only moves to the new one if you were on the newest), the opening animation, - the game's extra command-line arguments, and the launcher's own version and update state. + the game's extra command-line arguments, an HTTP proxy for downloads, and the launcher's own + version and update state. - **Updates**: there is one channel. Every release is published as the release, GitHub's latest, once its smoke test passed (docs/release-flow.md), and the launcher installs it. The game pre-releases of the old Alpha channel (v0.2.1 on) stay on the Versions page to install @@ -90,6 +91,15 @@ page `servers.json` (the list), `servers//` (the servers created there) an launcher's own arguments, kept as `game_args` in `settings.json`, and apply the next time the game starts. `horizon-launcher game-args ""` sets them too, and `play --arg ` passes one for a single run. +- **Proxy**: when the internet here needs one (a school's, an office's, a country where a host is + unreachable), Settings' Proxy takes the `http://host:port` address your proxy app listens on, and + every download goes through it: Horizon's releases and the launcher's own update, Minecraft's + files and Java from Mojang, Modrinth, CurseForge, Horizon's mod registry, pictures, Microsoft + sign-in, and the jars a modpack import fetches. It is kept as `proxy` in `settings.json`, and + `horizon-launcher settings proxy http://127.0.0.1:7890` sets it too ("default" removes it). + Without one, `HTTPS_PROXY` and `HTTP_PROXY` are used when the launcher is started with them, and + `NO_PROXY` names the hosts to reach directly, a modpack import's jars included. A server on this + computer never goes through it. - **Links**: the Discord invite, the Sponsors page and the website come from `launcher/links.json` on main (`{"discord": "...", "sponsor": "...", "website": "..."}`), so they change without a launcher release. Offline, the launcher uses the same values built in; an empty address hides its button. diff --git a/launcher/assets/sculk-banner.webp b/launcher/assets/sculk-banner.webp new file mode 100644 index 000000000..3ed947276 Binary files /dev/null and b/launcher/assets/sculk-banner.webp differ diff --git a/launcher/src/account.rs b/launcher/src/account.rs index 8958fb3d4..1416424ce 100644 --- a/launcher/src/account.rs +++ b/launcher/src/account.rs @@ -60,11 +60,17 @@ impl Endpoints { } } -fn agent() -> ureq::Agent { - ureq::AgentBuilder::new() - .timeout(Duration::from_secs(20)) - .user_agent(&format!("horizon-launcher/{}", crate::backend::VERSION)) - .build() +/// A request to `url`: the launcher's user agent, a 20 s timeout, and the player's proxy when one +/// is set (`proxy`), since a sign-in has to get out the way downloads do. +fn request_to(method: &str, url: &str) -> ureq::Request { + crate::proxy::agent( + ureq::AgentBuilder::new() + .timeout(Duration::from_secs(20)) + .user_agent(&format!("horizon-launcher/{}", crate::backend::VERSION)), + url, + ) + .build() + .request(method, url) } /// One request's result: the status and the JSON body (empty when there is none). Transport @@ -147,7 +153,7 @@ pub enum Poll { pub fn device_code(ep: &Endpoints, client_id: &str) -> Result { let (status, v) = send( - agent().post(&format!("{}/devicecode", ep.microsoft)), + request_to("POST", &format!("{}/devicecode", ep.microsoft)), Some(Body::Form(vec![("client_id", client_id), ("scope", SCOPE)])), "Microsoft", )?; @@ -190,7 +196,7 @@ fn oauth_error(v: &Value) -> String { /// One poll of the token endpoint while the player signs in. pub fn poll(ep: &Endpoints, client_id: &str, code: &DeviceCode) -> Result { let (status, v) = send( - agent().post(&format!("{}/token", ep.microsoft)), + request_to("POST", &format!("{}/token", ep.microsoft)), Some(Body::Form(vec![ ("grant_type", "urn:ietf:params:oauth:grant-type:device_code"), ("client_id", client_id), @@ -247,7 +253,7 @@ pub fn wait_for_sign_in( fn refresh_ms(ep: &Endpoints, client_id: &str, refresh: &str) -> Result { let (status, v) = send( - agent().post(&format!("{}/token", ep.microsoft)), + request_to("POST", &format!("{}/token", ep.microsoft)), Some(Body::Form(vec![ ("grant_type", "refresh_token"), ("client_id", client_id), @@ -281,7 +287,7 @@ struct Minecraft { fn minecraft_login(ep: &Endpoints, ms_access: &str) -> Result { let (status, xbl) = send( - agent().post(&ep.xbox_user), + request_to("POST", &ep.xbox_user), Some(Body::Json(json!({ "Properties": { "AuthMethod": "RPS", @@ -297,7 +303,7 @@ fn minecraft_login(ep: &Endpoints, ms_access: &str) -> Result .filter(|_| status == 200) .ok_or("Xbox Live refused the sign-in.")?; let (status, xsts) = send( - agent().post(&ep.xsts), + request_to("POST", &ep.xsts), Some(Body::Json(json!({ "Properties": { "SandboxId": "RETAIL", "UserTokens": [xbl_token] }, "RelyingParty": "rp://api.minecraftservices.com/", @@ -317,7 +323,10 @@ fn minecraft_login(ep: &Endpoints, ms_access: &str) -> Result }; let xuid = claims.and_then(|c| str_field(c, "xid")); let (status, mc) = send( - agent().post(&format!("{}/authentication/login_with_xbox", ep.minecraft)), + request_to( + "POST", + &format!("{}/authentication/login_with_xbox", ep.minecraft), + ), Some(Body::Json( json!({ "identityToken": format!("XBL3.0 x={uhs};{xsts_token}") }), )), @@ -350,7 +359,7 @@ fn bearer(request: ureq::Request, token: &str) -> ureq::Request { fn owns_game(ep: &Endpoints, token: &str) -> Result { let (status, v) = send( bearer( - agent().get(&format!("{}/entitlements/mcstore", ep.minecraft)), + request_to("GET", &format!("{}/entitlements/mcstore", ep.minecraft)), token, ), None, @@ -387,7 +396,7 @@ pub struct Account { fn profile(ep: &Endpoints, token: &str) -> Result { let (status, v) = send( bearer( - agent().get(&format!("{}/minecraft/profile", ep.minecraft)), + request_to("GET", &format!("{}/minecraft/profile", ep.minecraft)), token, ), None, diff --git a/launcher/src/backend.rs b/launcher/src/backend.rs index dba6bcd25..c4601f3d6 100644 --- a/launcher/src/backend.rs +++ b/launcher/src/backend.rs @@ -80,14 +80,18 @@ const CLIENT: &str = if cfg!(windows) { "horizon-client" }; -fn agent() -> ureq::Agent { - ureq::AgentBuilder::new() - .user_agent(&format!("horizon-launcher/{VERSION}")) - .build() +/// The agent `url` is fetched with: the launcher's own user agent, through the player's proxy when +/// one is set (`proxy`). +fn agent(url: &str) -> ureq::Agent { + crate::proxy::agent( + ureq::AgentBuilder::new().user_agent(&format!("horizon-launcher/{VERSION}")), + url, + ) + .build() } fn get(url: &str) -> Result { - let mut request = agent().get(url); + let mut request = agent(url).get(url); // CI runners share addresses and hit GitHub's anonymous rate limit; they pass their own token. if let Some(token) = std::env::var("HORIZON_GITHUB_TOKEN") .ok() @@ -2530,6 +2534,10 @@ pub struct Settings { /// default. Appended after the launcher's own arguments, so they can add to or override them. #[serde(default, skip_serializing_if = "String::is_empty")] pub game_args: String, + /// The HTTP proxy every download goes through (`proxy`), such as `http://127.0.0.1:7890`. + /// Unset means none: the environment's `HTTPS_PROXY` and `HTTP_PROXY` apply instead. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub proxy: Option, /// Dark, Light, or the system's: the launcher's look. Dark by default. #[serde(default)] pub appearance: Appearance, diff --git a/launcher/src/browser/curseforge.rs b/launcher/src/browser/curseforge.rs index 1db533a93..56d73777a 100644 --- a/launcher/src/browser/curseforge.rs +++ b/launcher/src/browser/curseforge.rs @@ -55,7 +55,7 @@ impl CurseForge { } fn get(&self, url: &str) -> Result { - let response = super::download::agent() + let response = super::download::agent(url) .get(url) .set("x-api-key", &self.key) .set("Accept", "application/json") diff --git a/launcher/src/browser/download.rs b/launcher/src/browser/download.rs index 593273245..f370234f8 100644 --- a/launcher/src/browser/download.rs +++ b/launcher/src/browser/download.rs @@ -17,16 +17,26 @@ const HOSTS: [&str; 4] = [ /// Bigger than any pack these sources serve (Modrinth caps uploads at 500 MiB). const MAX: u64 = 1 << 30; -/// The HTTP agent the sources share. Modrinth asks for a user agent that names the project. -pub(super) fn agent() -> ureq::Agent { - ureq::AgentBuilder::new() - .user_agent(&format!( - "ludovic111/horizon horizon-launcher/{} (github.com/ludovic111/horizon)", - crate::backend::VERSION - )) - .timeout_connect(std::time::Duration::from_secs(15)) - .timeout_read(std::time::Duration::from_secs(60)) - .build() +/// The HTTP agent the sources share, reaching `url` through the player's proxy when one is set +/// (`proxy`). Modrinth asks for a user agent that names the project. +/// +/// It is kept between downloads: a fresh agent starts a new connection pool, so one per file would +/// be a handshake per file, and a modpack brings hundreds. +pub(super) fn agent(url: &str) -> ureq::Agent { + let spec = crate::proxy::spec_for(url); + horizon_port_pack::net::keep("browser", spec.as_deref(), |proxy| { + let builder = ureq::AgentBuilder::new() + .user_agent(&format!( + "ludovic111/horizon horizon-launcher/{} (github.com/ludovic111/horizon)", + crate::backend::VERSION + )) + .timeout_connect(std::time::Duration::from_secs(15)) + .timeout_read(std::time::Duration::from_secs(60)); + match proxy { + Some(proxy) => builder.proxy(proxy).build(), + None => builder.build(), + } + }) } /// Why a file can't be downloaded at all, before any byte is read. @@ -159,9 +169,12 @@ pub fn fetch(file: &FileRef, folder: &Path, progress: &dyn Fn(f32)) -> Result format!("{} answered {code}.", file.url), - ureq::Error::Transport(t) => format!("No connection: {t}"), - })?; + let response = agent(&file.url) + .get(&file.url) + .call() + .map_err(|e| match e { + ureq::Error::Status(code, _) => format!("{} answered {code}.", file.url), + ureq::Error::Transport(t) => format!("No connection: {t}"), + })?; save(file, response.into_reader(), folder, progress) } diff --git a/launcher/src/browser/horizon.rs b/launcher/src/browser/horizon.rs index 3bf465faf..a34ab52fb 100644 --- a/launcher/src/browser/horizon.rs +++ b/launcher/src/browser/horizon.rs @@ -8,6 +8,7 @@ use super::{ download, installed, java, FileRef, Kind, Project, Query, Source, SourceId, Version, GAME, }; use horizon_mods::index::{self, Index, Trust}; +use std::collections::HashMap; use std::fs; use std::path::{Path, PathBuf}; use std::sync::{Arc, Mutex}; @@ -27,6 +28,11 @@ const FRESH: Duration = Duration::from_secs(600); const MAX_INDEX: u64 = 16 << 20; /// The last index fetched, kept in the game folder for when the registry can't be reached. const CACHE: &str = "mod-browser/horizon-index.json"; +/// Players' ratings of every project (the registry service, crates/horizon-mod-registry). +const RATINGS_URL: &str = "https://playhorizon.dev/api/mods/ratings"; +/// Where a player rates a project: the site's GitHub sign-in, which comes back to its page. +/// The launcher has no GitHub account of its own. +const RATE: &str = "https://playhorizon.dev/api/mods/auth/login?back=/mods/"; /// Where the index comes from: `HORIZON_MOD_INDEX` (a file or an `https://` address, for a /// test registry), else [`INDEX_URL`]. @@ -89,7 +95,7 @@ fn fetch_index() -> Result<(Index, String), String> { use std::io::Read; let at = location(); let text = if at.starts_with("https://") { - let response = download::agent().get(&at).call().map_err(|e| match e { + let response = download::agent(&at).get(&at).call().map_err(|e| match e { ureq::Error::Status(code, _) => format!("The mod registry answered {code}."), ureq::Error::Transport(t) => format!("The mod registry can't be reached: {t}"), })?; @@ -110,6 +116,92 @@ fn fetch_index() -> Result<(Index, String), String> { Ok((index, text)) } +/// A project's ratings: 1 to 5 stars, their mean and how many. +#[derive(Clone, Copy, Debug, PartialEq)] +pub struct Rating { + pub average: f32, + pub count: u64, +} + +/// When the ratings were fetched last, and every rated project's [`Rating`] (None: that failed). +type Ratings = Option>>; +static RATINGS: Mutex> = Mutex::new(None); + +/// A project's rating as fetched last, without asking the network: None when the ratings +/// aren't known (not fetched, or the service didn't answer), `Some(None)` when it has none. +pub fn rating(id: &str) -> Option> { + let ratings = RATINGS.lock().unwrap(); + let known = ratings.as_ref()?.1.as_ref()?; + Some(known.get(id).copied()) +} + +/// The page that signs the player in with GitHub on the site and lets them rate `id`. +pub fn rate_url(id: &str) -> String { + format!("{RATE}{id}") +} + +/// Fetches the ratings again when the last try is ten minutes old: from `HORIZON_MOD_RATINGS` +/// (a file or an `https://` address, for a test registry), else [`RATINGS_URL`]; a local test +/// registry has none unless given. After a failure the browser shows downloads only. +fn refresh_ratings() { + if RATINGS + .lock() + .unwrap() + .as_ref() + .is_some_and(|(at, _)| at.elapsed() < FRESH) + { + return; + } + let given = std::env::var("HORIZON_MOD_RATINGS") + .ok() + .filter(|v| !v.is_empty()); + if given.is_none() && local() { + return; + } + let at = given.unwrap_or_else(|| RATINGS_URL.to_owned()); + let text = if at.starts_with("https://") { + download::agent().get(&at).call().ok().and_then(|r| { + use std::io::Read; + let mut text = String::new(); + r.into_reader() + .take(MAX_INDEX) + .read_to_string(&mut text) + .ok() + .map(|_| text) + }) + } else { + fs::read_to_string(&at).ok() + }; + let fetched = text.map(|t| Arc::new(parse_ratings(&t))); + *RATINGS.lock().unwrap() = Some((Instant::now(), fetched)); +} + +/// `{"projects": {"": {"average", "count"}}}`, keeping only well-formed entries. +fn parse_ratings(text: &str) -> HashMap { + let Ok(json) = serde_json::from_str::(text) else { + return HashMap::new(); + }; + let Some(projects) = json["projects"].as_object() else { + return HashMap::new(); + }; + projects + .iter() + .filter_map(|(id, r)| { + let average = r["average"].as_f64().filter(|a| (1.0..=5.0).contains(a))?; + let count = r["count"].as_u64().filter(|&c| c > 0)?; + index::valid_id(id).then(|| { + ( + id.clone(), + Rating { + average: average as f32, + count, + }, + ) + }) + }) + .collect() +} + /// The browser's kind for a registry kind; None for one the launcher doesn't install yet /// (kinds newer than this launcher). fn kind_of(kind: &index::Kind) -> Option { @@ -158,7 +250,7 @@ fn project_of(p: &index::Project) -> Option { title: p.name.clone(), summary: p.summary.clone(), author: p.authors.join(", "), - downloads: 0, + downloads: p.downloads, page: format!("{SITE}/{}", p.id), icon: p.icon.clone(), license: p.license.clone(), @@ -218,14 +310,19 @@ fn matches(p: &index::Project, text: &str) -> bool { .all(|word| hay.contains(&word.to_lowercase())) } -/// The projects of the query's kind whose words match, for this game unless `everything`. +/// The projects of the query's kind whose words match, for this game unless `everything`: the +/// most downloaded first. fn search(index: &Index, query: &Query) -> Vec { - index + let mut found: Vec = index .projects .iter() .filter(|p| kind_of(&p.kind) == Some(query.kind) && matches(p, &query.text)) .filter(|p| query.everything || p.versions.iter().any(|v| v.game == GAME)) .filter_map(project_of) + .collect(); + found.sort_by_key(|p| std::cmp::Reverse(p.downloads)); + found + .into_iter() .skip(query.offset) .take(query.limit) .collect() @@ -240,7 +337,9 @@ impl Source for Registry { } fn search(&self, query: &Query) -> Result, String> { - Ok(search(&*index()?, query)) + let found = search(&*index()?, query); + refresh_ratings(); + Ok(found) } fn project(&self, id: &str) -> Result { @@ -270,6 +369,7 @@ impl Source for Registry { } fn details(&self, project: &Project) -> Result { + refresh_ratings(); let index = index()?; let p = index .project(&project.id) diff --git a/launcher/src/browser/horizon/tests.rs b/launcher/src/browser/horizon/tests.rs index 7e1b8f585..dd80d0b1d 100644 --- a/launcher/src/browser/horizon/tests.rs +++ b/launcher/src/browser/horizon/tests.rs @@ -49,6 +49,18 @@ fn searches_by_kind_and_words() { assert_eq!(found("", Kind::Modpack), ["cozy"]); assert!(found("skyblock", Kind::ResourcePack).is_empty()); assert_eq!(found("", Kind::Shader), ["glow"]); + // The index's download counts, most downloaded first. + let mut counted = index.clone(); + counted.projects.push(index::Project { + id: "zoom".into(), + name: "Zoom".into(), + downloads: 12_345, + ..index.project("coords_hud").unwrap().clone() + }); + counted.projects[0].downloads = 80; + let first = search(&counted, &Query::new("", Kind::Mod)); + let order: Vec<(&str, u64)> = first.iter().map(|p| (p.id.as_str(), p.downloads)).collect(); + assert_eq!(order, [("zoom", 12_345), ("coords_hud", 80)]); let p = hud(&index); assert_eq!(p.support(), super::super::Support::Works); assert_eq!(p.page, "https://playhorizon.dev/mods/coords_hud"); @@ -216,3 +228,31 @@ fn versions_for_a_newer_horizon_are_not_installed() { assert_eq!(v.blocked.as_deref(), Some(NEEDS_NEWER)); assert_eq!(version_of(&index, p, &p.versions[0], Some(1)).blocked, None); } + +#[test] +fn ratings_keep_only_what_is_well_formed() { + let text = r#"{"projects": { + "zoom": {"average": 4.25, "count": 12}, + "minimap": {"average": 9, "count": 3}, + "keystrokes": {"average": 3, "count": 0}, + "Bad Id": {"average": 4, "count": 1}, + "fps_overlay": {"average": "5", "count": 1} + }}"#; + let ratings = parse_ratings(text); + assert_eq!( + ratings.into_iter().collect::>(), + [( + "zoom".to_owned(), + Rating { + average: 4.25, + count: 12 + } + )] + ); + assert!(parse_ratings("not json").is_empty()); + assert!(parse_ratings(r#"{"projects": []}"#).is_empty()); + assert_eq!( + rate_url("zoom"), + "https://playhorizon.dev/api/mods/auth/login?back=/mods/zoom" + ); +} diff --git a/launcher/src/browser/images.rs b/launcher/src/browser/images.rs index f5029a7af..240adae99 100644 --- a/launcher/src/browser/images.rs +++ b/launcher/src/browser/images.rs @@ -63,7 +63,7 @@ pub fn fetch(home: &Path, url: &str, size: u32) -> Result { if let Some(why) = refuse(url) { return Err(format!("{url}: {why}")); } - let response = super::download::agent() + let response = super::download::agent(url) .get(url) .call() .map_err(|e| format!("{url}: {e}"))?; diff --git a/launcher/src/browser/modrinth.rs b/launcher/src/browser/modrinth.rs index dabd9a604..fb71d0391 100644 --- a/launcher/src/browser/modrinth.rs +++ b/launcher/src/browser/modrinth.rs @@ -227,7 +227,7 @@ impl Source for Modrinth { } fn get(url: &str) -> Result { - let response = super::download::agent() + let response = super::download::agent(url) .get(url) .call() .map_err(|e| match e { diff --git a/launcher/src/cli.rs b/launcher/src/cli.rs index 64ddb1bd2..7d6ff7514 100644 --- a/launcher/src/cli.rs +++ b/launcher/src/cli.rs @@ -297,7 +297,7 @@ enum Cmd { }, /// Show the launcher's settings, or set one (the Settings page): selected-version TAG, /// minecraft-dir PATH, server-dir PATH ("default" resets a folder), install-new-versions - /// on|off, opening-animation on|off + /// on|off, opening-animation on|off, proxy http://host:port ("default" removes it) Settings { #[arg(value_parser = SETTING_KEYS)] key: Option, @@ -399,12 +399,13 @@ pub fn command() -> clap::Command { pub const AI_COMMANDS: [&str; 2] = ["mcp", "agent-config"]; /// The keys `settings` sets. -const SETTING_KEYS: [&str; 5] = [ +const SETTING_KEYS: [&str; 6] = [ "selected-version", "minecraft-dir", "server-dir", "install-new-versions", "opening-animation", + "proxy", ]; fn on_off(value: &str) -> Result { @@ -423,6 +424,15 @@ fn set_setting(s: &mut backend::Settings, key: &str, value: &str) -> Result<(), "server-dir" => s.server_dir = folder(value), "install-new-versions" => s.install_new_versions = Some(on_off(value)?), "opening-animation" => s.skip_opening = !on_off(value)?, + "proxy" => { + if value == "default" || value.is_empty() { + s.proxy = None; + } else if let Some(why) = horizon_launcher::proxy::refuse(value) { + return Err(why); + } else { + s.proxy = Some(value.trim().to_string()); + } + } _ => return Err(format!("No setting {key}.")), } Ok(()) @@ -437,6 +447,7 @@ fn settings_json(s: &backend::Settings) -> serde_json::Value { "install_new_versions": s.install_new_versions.unwrap_or(true), "opening_animation": !s.skip_opening, "game_args": s.game_args, + "proxy": s.proxy, "desktop_entry": s.desktop_entry.unwrap_or(true), "no_ai": backend::no_ai(), }) @@ -722,6 +733,7 @@ fn execute(command: Cmd, as_json: bool) -> Result<(), String> { let value = value.ok_or("settings KEY VALUE: the value is missing")?; set_setting(&mut settings, &key, &value)?; settings.save(); + horizon_launcher::proxy::announce(settings.proxy.clone()); } let all = settings_json(&settings); if as_json { diff --git a/launcher/src/lib.rs b/launcher/src/lib.rs index 4b5c164fd..3cba3ed10 100644 --- a/launcher/src/lib.rs +++ b/launcher/src/lib.rs @@ -10,6 +10,7 @@ pub mod heads; pub mod modpacks; pub mod mojang; pub mod process; +pub mod proxy; pub mod servers; pub mod signed; pub mod sources; diff --git a/launcher/src/main.rs b/launcher/src/main.rs index 7d778b6b9..50e62756d 100644 --- a/launcher/src/main.rs +++ b/launcher/src/main.rs @@ -18,6 +18,7 @@ mod mcp; mod modpacks_page; mod mods_page; mod mods_project; +mod partner; mod perf; mod scrollbar; mod servers_page; @@ -186,6 +187,10 @@ struct Launcher { args_input: String, args_focused: bool, args_focus: FocusHandle, + /// Settings' Proxy field, the same way (`proxy`). + proxy_input: String, + proxy_focused: bool, + proxy_focus: FocusHandle, /// Opt-in data collection: the player's answer and Settings' section (`collection`). collection: collection::Collection, /// Settings' "Connect an AI agent" (`agents_page`). @@ -301,6 +306,9 @@ impl Launcher { args_input: settings.game_args.clone(), args_focused: false, args_focus: cx.focus_handle(), + proxy_input: settings.proxy.clone().unwrap_or_default(), + proxy_focused: false, + proxy_focus: cx.focus_handle(), settings, links: backend::Links::default(), preparing: false, @@ -2123,7 +2131,8 @@ impl Launcher { if let Some(crash) = self.crash.clone() { page = page.child(self.crash_notice(crash, cx)); } - page + // Below everything the player needs to start, so it never moves Play. + page.child(partner::banner("partner-home", 560., &t)) } /// "Horizon crashed": the report and the logs, and where to report it. @@ -2539,28 +2548,30 @@ impl Launcher { Some(opening.into_any_element()), &t, )) + .child(group("Network", "globe")) + .child(self.proxy_row(n + 4, cx)) .child(group("Game", "gamepad")) - .child(self.game_args_row(n + 4, cx)) + .child(self.game_args_row(n + 5, cx)) .child(group("AI", "terminal")) - .child(self.no_ai_row(n + 4, cx)) + .child(self.no_ai_row(n + 6, cx)) .child(group("About", "info-box")) - .child(index_row(n + 5, "Horizon", Some(plain(&horizon)), horizon_action, &t)) + .child(index_row(n + 7, "Horizon", Some(plain(&horizon)), horizon_action, &t)) .child(index_row( - n + 6, + n + 8, "Launcher", Some(plain(&launcher)), launcher_action, &t, )) .child(index_row( - n + 7, + n + 9, "Data folder", Some(mono(short(&backend::data_dir()))), None, &t, )) .child(index_row( - n + 8, + n + 10, "Logs", Some(mono(format!( "{} · crash reports beside it", @@ -2579,7 +2590,7 @@ impl Launcher { )) .when(cfg!(target_os = "linux"), |d| { d.child(index_row( - n + 9, + n + 11, "Applications menu", Some(plain(if self.settings.desktop_entry() { "Horizon and its icon are in your desktop's menu." @@ -2668,6 +2679,93 @@ impl Launcher { ) } + /// Settings' Proxy row: the HTTP proxy every download and sign-in goes through, kept in + /// `settings.json` and read back by `proxy.rs` on each request. + fn proxy_row(&self, n: usize, cx: &mut Context) -> Div { + let t = self.theme; + let focused = self.proxy_focused; + let field = div() + .id("proxy") + .track_focus(&self.proxy_focus) + .flex() + .items_center() + .w(px(300.)) + .h(px(30.)) + .px(px(12.)) + .overflow_hidden() + .border_2() + .border_color(if focused { t.accent } else { t.outline }) + .bg(t.well) + .font_family(theme::MONO) + .text_size(px(12.)) + .cursor_text() + .child(if self.proxy_input.is_empty() && !focused { + div() + .text_color(t.muted) + .child("For example http://127.0.0.1:7890") + } else { + // The end of a long line stays in view while typing. + let chars: Vec = self.proxy_input.chars().collect(); + let shown: String = chars[chars.len().saturating_sub(44)..].iter().collect(); + div().text_color(t.ink).child(shown) + }) + .when(focused, |d| d.child(div().w(px(1.)).h(px(14.)).bg(t.ink))) + .on_click(cx.listener(|this, _: &ClickEvent, window, cx| { + window.focus(&this.proxy_focus); + cx.notify(); + })) + .on_key_down(cx.listener(|this, ev: &KeyDownEvent, _, cx| { + let k = &ev.keystroke; + let paste = k.key == "v" && (k.modifiers.control || k.modifiers.platform); + match k.key.as_str() { + "backspace" => { + this.proxy_input.pop(); + } + _ if paste => { + if let Some(text) = cx.read_from_clipboard().and_then(|c| c.text()) { + // A copied line, not a copied page: the field takes one address. + let line = text.lines().next().unwrap_or(&text); + this.proxy_input.push_str(line.trim()); + } + } + _ if !k.modifiers.control && !k.modifiers.platform => { + if let Some(ch) = &k.key_char { + this.proxy_input.push_str(ch); + } + } + _ => return, + } + // `truncate` counts bytes, and a cut inside a character panics: count characters. + if this.proxy_input.chars().count() > 256 { + this.proxy_input = this.proxy_input.chars().take(256).collect(); + } + this.save_proxy(); + cx.stop_propagation(); + cx.notify(); + })); + // A half-typed address is no reason to complain; one left behind is. + let detail = match (focused, horizon_launcher::proxy::refuse(&self.proxy_input)) { + (false, Some(why)) => div().text_color(t.danger).child(why).into_any_element(), + _ => div() + .child( + "Downloads, sign-ins and updates go through this HTTP proxy \ + (http://host:port). Empty means none: HTTPS_PROXY is used instead when the \ + launcher was started with one.", + ) + .into_any_element(), + }; + index_row(n, "Proxy", Some(detail), Some(field.into_any_element()), &t) + } + + /// Keeps the Proxy field in `settings.json`, and tells the parts that build their own agents + /// (`horizon-port-pack`) which proxy to use. + fn save_proxy(&mut self) { + let value = self.proxy_input.trim().to_owned(); + self.settings.proxy = (!value.is_empty()).then_some(value); + self.settings.save(); + horizon_launcher::proxy::announce(self.settings.proxy.clone()); + } + /// Settings' Microsoft accounts: who is signed in and plays, the sign-in with its code. The /// rows are numbered from 01; returns them and how many there are. fn account_rows(&mut self, cx: &mut Context) -> (Div, usize) { @@ -3317,6 +3415,7 @@ impl Render for Launcher { self.friend_focused = self.friend_focus.is_focused(window); self.mods.note_focus(window); self.args_focused = self.args_focus.is_focused(window); + self.proxy_focused = self.proxy_focus.is_focused(window); let size = window.viewport_size(); let banner_width = f32::from(size.width) - theme::SIDEBAR - scrollbar::GUTTER; let content = match self.page { @@ -3578,6 +3677,9 @@ fn main() { } perf::process_started(); backend::exe_path(); + // What the launcher downloads goes through the player's proxy, if they set one: the parts + // that build their own agents (`horizon-port-pack`) are told before anything starts. + horizon_launcher::proxy::announce(horizon_launcher::backend::Settings::load().proxy); if let Some(code) = cli::run() { std::process::exit(code); } diff --git a/launcher/src/mods_page.rs b/launcher/src/mods_page.rs index e6ebedc5b..f74fc73c1 100644 --- a/launcher/src/mods_page.rs +++ b/launcher/src/mods_page.rs @@ -175,6 +175,34 @@ fn count(n: u64) -> String { } } +/// A registry project's rating: five pixel stars, the mean's nearest whole number of them lit, the +/// mean and how many; None while the ratings aren't known. +pub(super) fn stars(id: &str, t: &theme::Theme) -> Option
{ + let row = div().flex().items_center().gap(px(2.)); + Some(match horizon::rating(id)? { + None => row.text_color(t.muted).child("No ratings yet"), + Some(r) => { + let lit = r.average.round() as usize; + row.children((0..5).map(|i| { + blocks::icon( + "star", + 12., + if i < lit { + t.warn + } else { + t.muted.opacity(0.6) + }, + ) + })) + .child(div().ml(px(4.)).child(format!( + "{:.1} ({})", + r.average, + count(r.count) + ))) + } + }) +} + /// A checksum as the page shows it: the algorithm and the first and last hex digits. fn short_sum(checksum: &str) -> String { let (algo, hex) = checksum.split_once(':').unwrap_or(("", checksum)); @@ -968,9 +996,7 @@ impl Launcher { if !p.author.is_empty() { by.push(format!("by {}", p.author)); } - if p.source != SourceId::Horizon { - by.push(format!("{} downloads", count(p.downloads))); - } + by.push(format!("{} downloads", count(p.downloads))); by.push(format!("from {}", p.source.label())); if !p.license.is_empty() { by.push(p.license.clone()); @@ -980,6 +1006,11 @@ impl Launcher { .flex_col() .child(div().truncate().child(p.summary.clone())) .child(by.join(" · ")) + .children( + (p.source == SourceId::Horizon) + .then(|| stars(&p.id, &t)) + .flatten(), + ) .children( support .reason() diff --git a/launcher/src/mods_project.rs b/launcher/src/mods_project.rs index 97d23e0aa..72a95b142 100644 --- a/launcher/src/mods_project.rs +++ b/launcher/src/mods_project.rs @@ -491,6 +491,21 @@ impl Launcher { .gap(px(24.)) .child(div().flex().child(back)) .child(head); + // Registry projects are rated on the site, signed in with GitHub (one rating per account). + if p.source == SourceId::Horizon { + let url = browser::horizon::rate_url(&p.id); + page = page.child( + div() + .flex() + .items_center() + .gap(px(16.)) + .children(super::mods_page::stars(&p.id, &t).map(|s| text(theme::UI).child(s))) + .child( + button("mods-rate", "Sign in with GitHub to rate", Kind::Ghost, &t) + .on_click(move |_, _, cx| cx.open_url(&url)), + ), + ); + } if let Some(why) = support.reason() { page = page.child( text(theme::UI) diff --git a/launcher/src/partner.rs b/launcher/src/partner.rs new file mode 100644 index 000000000..eea1a3524 --- /dev/null +++ b/launcher/src/partner.rs @@ -0,0 +1,64 @@ +//! Sculk's banner: a server host that sponsors Horizon (Ludovic, 2026-10-26), on the Servers page +//! and under Home's rows. The picture is in the binary, never fetched; a click opens Sculk's page in +//! the browser. A "Partner" label above it says it is an ad. +use crate::theme::Theme; +use gpui::{div, img, prelude::*, px, ClickEvent, Div, Image, ImageFormat, Stateful}; +use std::sync::{Arc, LazyLock}; + +pub const URL: &str = "https://my.sculkhosting.com/ref/horizon"; + +/// 1200×441: twice the widest it is shown at, for Retina screens. Its transparent edges let the +/// characters stand out of the card. +const WIDTH: f32 = 1200.; +const HEIGHT: f32 = 441.; +static BANNER: LazyLock> = LazyLock::new(|| { + Arc::new(Image::from_bytes( + ImageFormat::Webp, + include_bytes!("../assets/sculk-banner.webp").to_vec(), + )) +}); + +/// The banner `width` logical pixels wide, under its label. Hovering lifts it a little and turns the +/// label to ink. The narrowest window (960) leaves the page 648 pixels, so it always fits. +pub fn banner(id: &'static str, width: f32, t: &Theme) -> Stateful
{ + let t = *t; + let el = div() + .id(id) + .group(id) + .flex() + .flex_col() + .gap(px(8.)) + .w(px(width)) + .cursor_pointer() + .child( + crate::text(crate::theme::MICRO) + .text_color(t.muted) + .group_hover(id, move |s| s.text_color(t.ink)) + .child("PARTNER"), + ) + .child( + div().relative().group_hover(id, |s| s.top(px(-2.))).child( + img(BANNER.clone()) + .w(px(width)) + .h(px(width * HEIGHT / WIDTH)), + ), + ) + .on_click(|_: &ClickEvent, _, cx| cx.open_url(URL)); + crate::keyboard(el, &t) +} + +#[cfg(test)] +mod tests { + use super::{HEIGHT, WIDTH}; + + #[test] + fn the_bundled_banner_decodes() { + let bytes = include_bytes!("../assets/sculk-banner.webp"); + let banner = image::load_from_memory_with_format(bytes, image::ImageFormat::WebP) + .expect("the banner is a WebP"); + assert_eq!( + (banner.width(), banner.height()), + (WIDTH as u32, HEIGHT as u32) + ); + } +} diff --git a/launcher/src/proxy.rs b/launcher/src/proxy.rs new file mode 100644 index 000000000..8d6493456 --- /dev/null +++ b/launcher/src/proxy.rs @@ -0,0 +1,140 @@ +//! The proxy every download and request goes through, when the player needs one: a school's or an +//! office's, or a country where a host is unreachable. The Settings page's Proxy row (kept as +//! `proxy` in `settings.json`) wins; without it the usual `HTTPS_PROXY`, `HTTP_PROXY`, `ALL_PROXY` +//! and `NO_PROXY` variables apply, so a launcher started from a shell that has them needs nothing. +//! +//! What goes through it: Horizon's releases and the launcher's own update, Minecraft's files and +//! Java from Mojang, Modrinth, CurseForge, Horizon's mod registry, pictures, Microsoft sign-in, +//! Tailscale's API, and the jars a modpack import downloads. A local address never does, and the +//! Servers page's calls to a game server's API (`servers.rs`) build their agent without it: they +//! are on loopback and asked every second. +//! +//! Which hosts are reached directly, and how an address is read, are `horizon-port-pack`'s rules +//! (`crates/horizon-port-pack/src/net.rs`): the jars an import fetches are downloaded there, and +//! the same hosts have to be left alone on both sides. This module adds what is the launcher's +//! own — the setting in `settings.json`, kept in memory so a request doesn't read the file — and +//! hands the address to the parts that build their agents. +use crate::backend::Settings; +use std::sync::Mutex; + +/// The launcher's setting, as `announce` last read it, or None before it has: a request shouldn't +/// read `settings.json` every time, and an import fetches hundreds of jars. +static SET: Mutex>> = Mutex::new(None); + +/// The proxy address to reach `url` through: the launcher's setting, else the environment's, unless +/// `url` is a local address or `NO_PROXY` names its host. +pub fn spec_for(url: &str) -> Option { + let scheme = horizon_port_pack::net::scheme_of(url)?; + if horizon_port_pack::net::direct(url) { + return None; + } + setting().or_else(|| horizon_port_pack::net::env_for(scheme)) +} + +/// The proxy to reach `url` through: `spec_for`'s address, read as one. +pub fn for_url(url: &str) -> Option { + spec_for(url).and_then(|spec| horizon_port_pack::net::parse(&spec)) +} + +/// `builder`, reaching `url` through the proxy when one is set. For the parts that ask for a few +/// addresses; the ones that fetch file after file keep their agent instead (`keep`). +pub fn agent(builder: ureq::AgentBuilder, url: &str) -> ureq::AgentBuilder { + match for_url(url) { + Some(proxy) => builder.proxy(proxy), + None => builder, + } +} + +/// Why `spec` can't be used as a proxy, or None when it can (empty means none). +pub fn refuse(spec: &str) -> Option { + let spec = spec.trim(); + if spec.is_empty() { + return None; + } + if horizon_port_pack::net::socks(spec) { + return Some(format!( + "{spec} is a SOCKS proxy; Horizon downloads through an HTTP proxy, such as the \ + http:// address your proxy app also listens on." + )); + } + // `ureq` takes `http://` without a host, which would leave a download failing with nothing + // said about the proxy. + if horizon_port_pack::net::parse(spec).is_none() + || horizon_port_pack::net::host_of(spec).is_none_or(str::is_empty) + { + return Some(format!( + "{spec} isn't a proxy address. Write it as http://host:port." + )); + } + None +} + +/// Tells the parts that build their own agents (`horizon-port-pack`) which proxy to use, and keeps +/// the setting for the launcher's own requests. Called with what `settings.json` holds: at start, +/// and whenever the player changes the setting. +/// +/// The environment's is left to them: they read it per address (`HTTPS_PROXY` for an https jar, +/// `HTTP_PROXY` for an http one), the way the launcher does for its own. +pub fn announce(setting: Option) { + let spec = setting + .map(|p| p.trim().to_owned()) + .filter(|p| !p.is_empty()); + *held() = Some(spec.clone()); + horizon_port_pack::net::set_proxy(spec); +} + +/// The launcher's setting: read from `settings.json` the first time it is needed and kept after +/// that, so a download doesn't read the file once per file. +fn setting() -> Option { + let mut set = held(); + match set.clone() { + Some(kept) => kept, + None => { + let read = written(); + *set = Some(read.clone()); + read + } + } +} + +/// The launcher's setting as it is written down, or None when there is none. +fn written() -> Option { + Settings::load() + .proxy + .map(|p| p.trim().to_owned()) + .filter(|p| !p.is_empty()) +} + +/// The setting's lock, even after a thread panicked while holding it: an address lost to a panic +/// is worse than an old one kept. +fn held() -> std::sync::MutexGuard<'static, Option>> { + SET.lock().unwrap_or_else(|e| e.into_inner()) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn a_local_address_takes_no_proxy() { + assert_eq!(spec_for("http://127.0.0.1:8130/api/v1/status"), None); + assert_eq!(spec_for("http://localhost/api/v1/status"), None); + } + + /// An address the launcher knows nothing about is one nothing is written for either. + #[test] + fn a_relative_address_has_no_scheme_to_read_a_proxy_for() { + assert_eq!(spec_for("data/a.jar"), None); + } + + #[test] + fn a_proxy_address_is_checked_before_it_is_kept() { + assert_eq!(refuse(""), None); + assert_eq!(refuse(" "), None); + assert_eq!(refuse("http://127.0.0.1:7890"), None); + assert_eq!(refuse("127.0.0.1:7890"), None); + assert_eq!(refuse("http://user:pass@proxy.local:3128"), None); + assert!(refuse("http://").is_some()); + assert!(refuse("socks5://127.0.0.1:7891").is_some()); + } +} diff --git a/launcher/src/servers.rs b/launcher/src/servers.rs index 264ccb149..09961ce3b 100644 --- a/launcher/src/servers.rs +++ b/launcher/src/servers.rs @@ -813,6 +813,8 @@ impl Api { } pub fn call(&self, method: &str, path: &str, body: Option) -> Result { + // No proxy here on purpose: the server is on this computer, and this is asked every + // second (`proxy` never sends a loopback address through one either). let agent = ureq::AgentBuilder::new() .timeout(Duration::from_secs(10)) .build(); diff --git a/launcher/src/servers_page.rs b/launcher/src/servers_page.rs index b1e7eb775..0a5618768 100644 --- a/launcher/src/servers_page.rs +++ b/launcher/src/servers_page.rs @@ -1167,12 +1167,15 @@ impl Launcher { { page = page.child(self.problem_notice(p, cx)); } + let partner = super::partner::banner("partner-servers", 600., &t); if self.servers.list.is_empty() { - return page.child(centered( - "No server yet. Create one: it takes a few seconds, and with the defaults (tick \ - the EULA, press Create) you get a friends-only survival world.", - &t, - )); + return page + .child(centered( + "No server yet. Create one: it takes a few seconds, and with the defaults \ + (tick the EULA, press Create) you get a friends-only survival world.", + &t, + )) + .child(partner); } let mut list = div().flex().flex_col().border_t_1().border_color(t.rule); for (i, e) in self.servers.list.clone().into_iter().enumerate() { @@ -1213,7 +1216,7 @@ impl Launcher { &t, )); } - page.child(list) + page.child(list).child(partner) } fn add_server_folder(&mut self, cx: &mut Context) { diff --git a/launcher/src/tailscale.rs b/launcher/src/tailscale.rs index b0c20d3bc..c78be54a5 100644 --- a/launcher/src/tailscale.rs +++ b/launcher/src/tailscale.rs @@ -260,11 +260,14 @@ impl Api { body: Option<&Value>, if_match: Option<&str>, ) -> Result<(Value, Option), String> { - let agent = ureq::AgentBuilder::new() - .timeout(Duration::from_secs(20)) - .build(); + let url = format!("{}/api/v2{path}", self.base); + let agent = crate::proxy::agent( + ureq::AgentBuilder::new().timeout(Duration::from_secs(20)), + &url, + ) + .build(); let mut request = agent - .request(method, &format!("{}/api/v2{path}", self.base)) + .request(method, &url) .set("Authorization", &format!("Bearer {}", self.token)) .set("Accept", "application/json"); if let Some(etag) = if_match { diff --git a/mods/horizon/src/test/java/dev/horizonlab/parity/VanillaCushionPlacementOracle.java b/mods/horizon/src/test/java/dev/horizonlab/parity/VanillaCushionPlacementOracle.java new file mode 100644 index 000000000..212a415c1 --- /dev/null +++ b/mods/horizon/src/test/java/dev/horizonlab/parity/VanillaCushionPlacementOracle.java @@ -0,0 +1,91 @@ +package dev.horizonlab.parity; + +import com.google.gson.*; +import java.io.PrintWriter; +import java.nio.file.*; +import java.util.*; +import java.util.function.*; +import net.minecraft.client.multiplayer.ClientLevel; +import net.minecraft.core.BlockPos; +import net.minecraft.core.registries.Registries; +import net.minecraft.resources.*; +import net.minecraft.util.Continuation; +import net.minecraft.world.entity.Entity; +import net.minecraft.world.entity.decoration.Cushion; +import net.minecraft.world.level.BlockGetter; +import net.minecraft.world.level.block.Block; +import net.minecraft.world.level.block.state.*; +import net.minecraft.world.level.blockscan.*; +import net.minecraft.world.phys.*; +import net.minecraft.world.phys.shapes.*; + +public final class VanillaCushionPlacementOracle { + record Cell(VoxelShape outline, VoxelShape collision, boolean suffocating) {} + static final Cell AIR = new Cell(Shapes.empty(), Shapes.empty(), false); + static final class FixtureBlock extends Block { + FixtureBlock() { super(BlockBehaviour.Properties.of().dynamicShape() + .setId(ResourceKey.create(Registries.BLOCK, Identifier.parse("horizon:cushion_fixture"))) + .isSuffocating((s, w, p) -> ((World)w).cell(p).suffocating())); } + @Override protected VoxelShape getShape(BlockState s, BlockGetter w, BlockPos p, CollisionContext c) { + return w instanceof World f ? f.cell(p).outline() : Shapes.empty(); + } + } + static BlockState state; + static final class World extends ClientLevel { + Map cells; + World() { super(null, null, null, null, 0, 0, null, false, 0, 0); } + Cell cell(BlockPos p) { return cells.getOrDefault(p, AIR); } + @Override public BlockState getBlockState(BlockPos p) { return state; } + @Override public Iterable getBlockCollisions(Entity e, AABB b) { + var result = new ArrayList(); + cells.forEach((p, c) -> result.add(c.collision().move(p))); + return result; + } + @Override public BlockMatcher findBlocksIn(AABB bounds) { + return new BlockMatcher(this) { + @Override public boolean atLeastMatched(int n) { throw new AssertionError(); } + @Override protected boolean anyMatched(Predicate p) { throw new AssertionError(); } + @Override public void forEach(BiConsumer c) { throw new AssertionError(); } + @Override public boolean forEachUntil(BlockStateConsumer consumer) { + for (var p : BlockPos.betweenClosed(bounds)) { + if (consumer.apply(p, state) == Continuation.ABORT) return true; + } + return false; + } + }; + } + } + static VoxelShape shape(JsonElement v) { + var result = Shapes.empty(); + for (var e : v.getAsJsonArray()) { + var b = e.getAsJsonArray(); + result = Shapes.or(result, Shapes.box(b.get(0).getAsDouble(), b.get(1).getAsDouble(), b.get(2).getAsDouble(), b.get(3).getAsDouble(), b.get(4).getAsDouble(), b.get(5).getAsDouble())); + } + return result; + } + public static void main(String[] args) throws Exception { + net.minecraft.SharedConstants.tryDetectVersion(); net.minecraft.server.Bootstrap.bootStrap(); + // Supply one unregistered fixture block without changing the checks under test. + var registry = net.minecraft.core.registries.BuiltInRegistries.BLOCK; + var holders = net.minecraft.core.MappedRegistry.class.getDeclaredField("unregisteredIntrusiveHolders"); + holders.setAccessible(true); holders.set(registry, new IdentityHashMap<>()); + var frozen = net.minecraft.core.MappedRegistry.class.getDeclaredField("frozen"); + frozen.setAccessible(true); frozen.setBoolean(registry, false); + state = new FixtureBlock().defaultBlockState(); + var u = Class.forName("sun.misc.Unsafe"); var f = u.getDeclaredField("theUnsafe"); f.setAccessible(true); + var unsafe = f.get(null); var allocate = u.getMethod("allocateInstance", Class.class); + try (var out = new PrintWriter(Files.newBufferedWriter(Path.of(args[1]))); var lines = Files.lines(Path.of(args[0]))) { + for (var line : (Iterable)lines::iterator) { + var row = JsonParser.parseString(line).getAsJsonObject(); + var world = (World)allocate.invoke(unsafe, World.class); world.cells = new HashMap<>(); + for (var e : row.getAsJsonArray("cells")) { + var c = e.getAsJsonArray(); + world.cells.put(new BlockPos(c.get(0).getAsInt(), c.get(1).getAsInt(), c.get(2).getAsInt()), new Cell(shape(c.get(3)), shape(c.get(4)), c.get(5).getAsBoolean())); + } + var p = row.getAsJsonArray("pos"); double x=p.get(0).getAsDouble(), y=p.get(1).getAsDouble(), z=p.get(2).getAsDouble(); + var bounds = new AABB(x-.5, y, z-.5, x+.5, y+.25, z+.5); + out.println(Cushion.canBePlacedAt(world, bounds) + " " + Cushion.wouldSurviveAt(world, bounds)); + } + } + } +} diff --git a/roadmap/roadmap.toml b/roadmap/roadmap.toml index 669596fba..1dbed9c37 100644 --- a/roadmap/roadmap.toml +++ b/roadmap/roadmap.toml @@ -1039,54 +1039,54 @@ links = ["#1437", "#1660"] [[item]] id = "item-cooldowns" title = "Cooldowns drawn on items" -status = "help-wanted" +status = "now" area = "gameplay" plain = """After you throw an ender pearl, its slot should show the cooldown sweeping away, as in vanilla.""" dev = """Vanilla draws `ItemCooldowns`' percent as a white overlay over the slot \ (`GuiGraphicsExtractor.itemDecorations` and `itemCooldown`) in the hotbar and in inventories. Issue #1763.""" -links = ["#1763"] +links = ["#1763", "#1933"] [[item]] id = "chat-settings" title = "Chat settings and team prefixes" -status = "help-wanted" +status = "now" area = "gameplay" plain = """The Hidden and Commands Only chat settings should hide chat, and team prefixes should appear before \ names in chat.""" dev = """Vanilla checks `ChatVisiblity` before it delivers chat and system messages (#1376), and chat uses the \ team-formatted display name (#1378). Both issues have exact steps to reproduce.""" -links = ["#1376", "#1378"] +links = ["#1376", "#1378", "#1932", "#1841"] [[item]] id = "pointer-hand" title = "A pointing hand over buttons" -status = "help-wanted" +status = "now" area = "gameplay" plain = """The mouse pointer should turn into a pointing hand over menu buttons, as in vanilla 26.3.""" dev = """26.3's `AbstractWidget` asks for a cursor from `CursorTypes` when it is hovered; winit's \ `CursorIcon::Pointer` gives the same shape. Issue #1347.""" -links = ["#1347"] +links = ["#1347", "#1897"] [[item]] id = "text-field-keys" title = "Ctrl+Backspace and scroll bars in menus" -status = "help-wanted" +status = "now" area = "gameplay" plain = """Ctrl+Backspace should delete a whole word in the creative search, and every list's scroll bar should be \ draggable.""" dev = """`EditBox` deletes by word with Ctrl (#1764); the Game Rules and Statistics lists' scroll bars can't be \ dragged (#1782, after #978).""" -links = ["#1764", "#1782"] +links = ["#1764", "#1782", "#1884", "#1931"] [[item]] id = "chicken-flap" title = "Chickens flap while they fall" -status = "help-wanted" +status = "now" area = "gameplay" plain = """Chickens should flap their wings while they fall, not stand still in the air.""" dev = """Vanilla's `Chicken.aiStep` updates `flap` and `flapSpeed` when the chicken isn't on the ground, and the \ model's wings follow them. Issue #1706.""" -links = ["#1706"] +links = ["#1706", "#1892"] # ---------------------------------------------------------------------------------------------------- Shipped # Newest first: `tools/roadmap.py sync` adds each newly shipped item on top. diff --git a/tests/test_world_input_capture.py b/tests/test_world_input_capture.py index df91e3153..5607c3684 100644 --- a/tests/test_world_input_capture.py +++ b/tests/test_world_input_capture.py @@ -101,6 +101,7 @@ impl Default for Game { } impl Game { fn stop_mining(&mut self) { self.mining = false; } + fn reset_inventory_clicks(&mut self) {} METHODS } fn main() { diff --git a/tools/bundle_tooltip_e2e.py b/tools/bundle_tooltip_e2e.py new file mode 100644 index 000000000..759cde88c --- /dev/null +++ b/tools/bundle_tooltip_e2e.py @@ -0,0 +1,115 @@ +#!/usr/bin/env python3 +"""Render regression: bundle component tooltips in anvil and brewing screens. + +Requires prepared 26.3 resources, a built horizon-client/horizon-ctl and Pillow. +Runs an isolated offscreen game; never opens existing player data. A name-only +bundle tooltip is narrower than the component's 96 GUI-pixel minimum, so its +purple frame cannot pass the image assertion. Screenshots are kept as evidence. +""" +import argparse +import json +from pathlib import Path +import subprocess +import tempfile +import time + +from PIL import Image +import lab + +ROOT = Path(__file__).resolve().parents[1] + + +def longest_tooltip_border(image): + """Longest horizontal purple tooltip-frame run (physical pixels).""" + rgb = image.convert("RGB") + longest = 0 + pixels = rgb.load() + for y in range(rgb.height): + run = 0 + for x in range(rgb.width): + r, g, b = pixels[x, y] + if g < 25 and r < 100 and b >= r + 15: + run += 1 + longest = max(longest, run) + else: + run = 0 + return longest + + +def main(): + parser = argparse.ArgumentParser(description=__doc__) + parser.add_argument("--game", type=Path, default=ROOT / "target/fast/horizon-client") + parser.add_argument("--ctl", type=Path, default=ROOT / "target/fast/horizon-ctl") + parser.add_argument("--resources", type=Path, default=ROOT / ".local/horizon-client/26.3") + parser.add_argument("--output", type=Path) + parser.add_argument("--in-frame", action="store_true") + args = parser.parse_args() + output = args.output or Path(tempfile.mkdtemp(prefix="bundle-tooltip-")) + output.mkdir(parents=True, exist_ok=True) + output = output.resolve() + homes = {} + for key in ("HORIZON_HOME", "HORIZON_LAUNCHER_HOME", "XDG_DATA_HOME", "XDG_CONFIG_HOME"): + directory = output / key + directory.mkdir(exist_ok=True) + homes[key] = directory + env = lab.game_env(**homes) + socket = output / "ctl.sock" + + def ctl(*commands, timeout=45): + result = subprocess.run( + [str(args.ctl.resolve()), "--socket", str(socket), *map(str, commands)], + env=env, cwd=output, capture_output=True, text=True, timeout=timeout, + ) + data = json.loads(result.stdout) + if result.returncode or data.get("error"): + raise RuntimeError(f"{commands}: {data}; {result.stderr}") + return data + + results = [] + try: + ctl("launch", "--game", args.game.resolve(), "--world", output / "world", + "--creative", "--offscreen", "--wait", "--resources", args.resources.resolve(), + *(["--in-frame"] if args.in_frame else []), timeout=120) + state = ctl("state") + px, _, pz = state["player"]["block_pos"] + x, z = (px // 16) * 16 + 8, (pz // 16) * 16 + 8 + ctl("command", f"fill {x-3} 99 {z-3} {x+3} 99 {z+3} minecraft:stone") + ctl("command", f"fill {x-3} 100 {z-3} {x+3} 105 {z+3} minecraft:air") + ctl("tp", x + 0.5, 100, z + 0.5) + ctl("command", 'item replace entity @s hotbar.0 with minecraft:bundle[' + 'minecraft:bundle_contents=[{id:"minecraft:stone",count:32}]]') + for station in ("anvil", "brewing_stand"): + ctl("command", f"setblock {x} 100 {z+2} minecraft:{station}") + ctl("wait", 5) + ctl("look-at-block", x, 100, z+2, "north") + ctl("interact", x, 100, z+2, "north") + time.sleep(0.3) + ui = ctl("ui") + slot = next(w for w in ui["widgets"] if w["id"] == "slot-0") + assert slot["stack"]["item"] == "minecraft:bundle", slot + sx, sy, sw, sh = slot["bounds"] + ctl("scroll-at", sx + sw / 2, sy + sh / 2, 0) + screenshot = output / f"{station}.png" + ctl("screenshot", screenshot) + with Image.open(screenshot) as image: + scale = image.width / ui["gui_size"][0] + longest = longest_tooltip_border(image) + # The component reserves 96 GUI pixels; allow its border/integer rounding. + required = int(90 * scale) + results.append({"station": station, "border_pixels": longest, + "required_pixels": required, "pass": longest >= required, + "screenshot": str(screenshot)}) + ctl("close") + finally: + try: + ctl("quit") + except (RuntimeError, subprocess.TimeoutExpired, json.JSONDecodeError): + pass + report = {"mode": "in-frame" if args.in_frame else "server-thread", "results": results} + (output / "results.json").write_text(json.dumps(report, indent=2) + "\n") + print(json.dumps(report, indent=2)) + assert len(results) == 2 and all(r["pass"] for r in results), "Missing bundle component tooltip" + + +if __name__ == "__main__": + main() diff --git a/tools/ci/linux-runner.sh b/tools/ci/linux-runner.sh index 699742bf1..5a5e72697 100755 --- a/tools/ci/linux-runner.sh +++ b/tools/ci/linux-runner.sh @@ -1,7 +1,8 @@ #!/usr/bin/env bash # A Horizon CI runner (labels self-hosted, Linux, X64, horizon-game and the host's name) on a Linux machine of the -# maintainer's (NixOS: ludodesktop, ludothinkpad), as a systemd user service of the account that holds his -# Minecraft files, like the Mac mini's runners (docs/release-flow.md). Run it on that machine, as that user: +# maintainer's (NixOS: ludodesktop, ludothinkpad; Ubuntu: playhorizon, a partner's server), as a systemd user service +# of the account that holds his Minecraft files, like the Mac mini's runners (docs/release-flow.md). Run it on that +# machine, as that user: # # bash tools/ci/linux-runner.sh install # register (gh login), install, start; again to update the scripts # bash tools/ci/linux-runner.sh status # the services, the runner's state, the pause watcher's last lines @@ -12,10 +13,16 @@ # never runs as the service). horizon-runner-pause.service (runner_pause.py) starts the runner only while nobody # uses the machine (screen locked or untouched for 15 min, no game), and stops it otherwise. The runner runs nice, # in horizon-ci.slice (low CPU and I/O weight, memory capped), on its own virtual screen: vscreen (a headless sway) -# where it is installed, else Xvfb from nixpkgs with Mesa's Vulkan drivers. +# where it is installed, else Xvfb with Mesa's Vulkan drivers (from nixpkgs on NixOS, from the system elsewhere). # HORIZON_SHARED_SOURCE: the imported vanilla data (default ~/horizon-local/shared-local, else # ~/code/horizon/.local); RUNNER_JOBS: cargo jobs and harnesses at once (default a third of the threads, at most 8: # ludodesktop froze under ~7 cold cargo builds on 2026-10-14, and it is the maintainer's own machine). +# RUNNER_CPUS and RUNNER_MEMORY (GB): the slice's CPU quota and memory cap (default half the threads, two thirds of +# the memory), for a machine that does nothing else. RUNNER_TOKEN: the registration (or, for uninstall, removal) +# token, made with gh on another machine, where gh must not be logged in (a machine someone else also runs): +# RUNNER_TOKEN=$(gh api -X POST repos/ludovic111/horizon/actions/runners/registration-token --jq .token) +# Without Nix (Debian, Ubuntu), the packages come from apt (the list in system_packages) and python3.13 from the +# PATH (uv python install 3.13, linked into ~/.local/bin). set -euo pipefail repo=ludovic111/horizon dir=$HOME/.actions-runners/horizon @@ -27,9 +34,16 @@ here=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd) # Nix packages the jobs need, kept alive by GC roots in $dir/nix. nix-build prints the store path; the root's name # gets the output's suffix (alsa-dev-dev for alsa-lib.dev), so it is not read back from the link. nix_out() { nix-build '' -A "$1" -o "$dir/nix/$2" | tail -1; } +nixos() { [ -d /run/current-system/sw ]; } +system_packages="build-essential pkg-config cmake libasound2-dev libudev-dev sccache mesa-vulkan-drivers libvulkan1 xvfb + libx11-6 libxcursor1 libxrandr2 libxi6 libxinerama1 libxkbcommon0 libxkbcommon-x11-0 libgl1 libegl1 rsync git curl" # The runner is a .NET program: on NixOS its native libraries (libstdc++, ICU, OpenSSL) come from nix-ld. -export LD_LIBRARY_PATH=/run/current-system/sw/share/nix-ld/lib${LD_LIBRARY_PATH:+:$LD_LIBRARY_PATH} +if nixos; then export LD_LIBRARY_PATH=/run/current-system/sw/share/nix-ld/lib${LD_LIBRARY_PATH:+:$LD_LIBRARY_PATH}; fi + +token() { + if [ -n "${RUNNER_TOKEN:-}" ]; then echo "$RUNNER_TOKEN"; else gh api -X POST "repos/$repo/actions/runners/$1" --jq .token; fi +} # NixOS has no /bin/bash: the runner's scripts (again after each of its self-updates) get a portable one. fix_shebangs() { sed -i '1s|^#!/bin/bash|#!/usr/bin/env bash|' "$dir"/*.sh "$dir"/bin/*.sh; } @@ -77,32 +91,59 @@ install() { fi tar xzf "$cache" -C "$dir" fix_shebangs - gh api -X POST "repos/$repo/actions/runners/registration-token" --jq .token | + token registration-token | (cd "$dir" && bash ./config.sh --unattended --replace --url "https://github.com/$repo" --token "$(cat)" \ --name "$name" --labels "${RUNNER_LABELS:-horizon-game,$(hostname)}" --work _work > /dev/null) fi # Libraries for building (pkg-config) and running (dlopen) the game, the JDK pinned by research-lock.json, sccache. - local alsa udev java - alsa=$(nix_out alsa-lib.dev alsa-dev) - udev=$(nix_out systemd.dev systemd-dev) - java=$(nix_out "jdk$(sed -n 's/.*"java_major": *\([0-9]*\).*/\1/p' "$here/../../research-lock.json" | head -1)_headless" jdk)/lib/openjdk - nix_out sccache sccache > /dev/null # on the PATH below: runner-env.sh hands it to cargo - local libs=/run/opengl-driver/lib:/run/current-system/sw/share/nix-ld/lib - if ! command -v vscreen > /dev/null; then - local mesa x - mesa=$(nix_out mesa mesa) - x=$(nix_out xvfb-run xvfb-run) - for lib in libx11 libxcursor libxrandr libxi libxext libxinerama libxrender libxxf86vm libxcb libxkbcommon \ - vulkan-loader libGL; do - libs=$libs:$(nix_out "$lib" "$lib")/lib - done - libs=$mesa/lib:$libs - echo "VK_DRIVER_FILES=$mesa/share/vulkan/icd.d/intel_icd.x86_64.json:$mesa/share/vulkan/icd.d/lvp_icd.x86_64.json" \ - > "$dir/.env.display" - echo "$x/bin" > "$dir/.path.display" + local major java platform_env path + major=$(sed -n 's/.*"java_major": *\([0-9]*\).*/\1/p' "$here/../../research-lock.json" | head -1) + if nixos; then + local alsa udev libs=/run/opengl-driver/lib:/run/current-system/sw/share/nix-ld/lib display_path="" + alsa=$(nix_out alsa-lib.dev alsa-dev) + udev=$(nix_out systemd.dev systemd-dev) + java=$(nix_out "jdk${major}_headless" jdk)/lib/openjdk + nix_out sccache sccache > /dev/null # on the PATH below: runner-env.sh hands it to cargo + platform_env="PKG_CONFIG_PATH=$alsa/lib/pkgconfig:$udev/lib/pkgconfig +C_INCLUDE_PATH=$udev/include +NIX_LD=/run/current-system/sw/share/nix-ld/lib/ld.so +NIX_LD_LIBRARY_PATH=/run/current-system/sw/share/nix-ld/lib" + if ! command -v vscreen > /dev/null; then + local mesa x + mesa=$(nix_out mesa mesa) + x=$(nix_out xvfb-run xvfb-run) + for lib in libx11 libxcursor libxrandr libxi libxext libxinerama libxrender libxxf86vm libxcb libxkbcommon \ + vulkan-loader libGL; do + libs=$libs:$(nix_out "$lib" "$lib")/lib + done + libs=$mesa/lib:$libs + platform_env="$platform_env +VK_DRIVER_FILES=$mesa/share/vulkan/icd.d/intel_icd.x86_64.json:$mesa/share/vulkan/icd.d/lvp_icd.x86_64.json" + display_path=$x/bin: + fi + platform_env="$platform_env +LD_LIBRARY_PATH=$libs" + path="$dir/cargo/bin:$display_path$dir/nix/sccache/bin:$java/bin:$HOME/.local/bin:/run/wrappers/bin:/etc/profiles/per-user/$USER/bin:/run/current-system/sw/bin" + else + # apt's packages (installed here when sudo needs no password), its JDK, and Mesa's software Vulkan (lavapipe): + # a server has no GPU. + local missing + missing=$(dpkg-query -W -f='${Package} ${Status}\n' $system_packages "openjdk-$major-jdk-headless" 2>&1 | + awk '/^dpkg-query: no packages found matching/ {print $NF; next} !/ installed$/ {print $1}' | tr '\n' ' ') + if [ -n "${missing// /}" ]; then + sudo -n env DEBIAN_FRONTEND=noninteractive apt-get install -y -qq $missing > /dev/null || + { echo "Install first: sudo apt-get install $missing"; exit 1; } + fi + command -v python3.13 > /dev/null || [ -x "$HOME/.local/bin/python3.13" ] || + { echo "No python3.13: uv python install 3.13, then link it into ~/.local/bin"; exit 1; } + java=$(ls -d /usr/lib/jvm/java-"$major"-openjdk-* | head -1) + platform_env="" + command -v vscreen > /dev/null || platform_env="VK_DRIVER_FILES=$(ls /usr/share/vulkan/icd.d/lvp_icd*.json | head -1)" + path="$dir/cargo/bin:$java/bin:$HOME/.local/bin:/usr/local/bin:/usr/bin:/bin" fi - cat > "$dir/.env" <> "$dir/.env"; else echo "VSCREEN=ci-horizon" >> "$dir/.env"; fi - echo "$dir/cargo/bin:$(cat "$dir/.path.display" 2>/dev/null || true)${dir}/nix/sccache/bin:$java/bin:$HOME/.local/bin:/run/wrappers/bin:/etc/profiles/per-user/$USER/bin:/run/current-system/sw/bin" \ - | sed 's/::/:/g' > "$dir/.path" + [ -n "$platform_env" ] && echo "$platform_env" + command -v vscreen > /dev/null && echo "VSCREEN=ci-horizon" + true + } > "$dir/.env" + echo "$path" > "$dir/.path" + rm -f "$dir/.env.display" "$dir/.path.display" # written by older versions of this script + local memory cpus + memory=${RUNNER_MEMORY:-$(( $(awk '/MemTotal/ {print int($2 / 1048576)}' /proc/meminfo) * 2 / 3 ))} + cpus=${RUNNER_CPUS:-$(( threads / 2 > 1 ? threads / 2 : 1 ))} cat > "$units/horizon-ci.slice" < "$units/horizon-runner.service" </dev/null || true - gh api -X POST "repos/$repo/actions/runners/remove-token" --jq .token | + token remove-token | (cd "$dir" && bash ./config.sh remove --token "$(cat)") rm -f "$units/horizon-runner.service" "$units/horizon-runner-pause.service" "$units/horizon-ci.slice" systemctl --user daemon-reload diff --git a/tools/ci/runner-env.sh b/tools/ci/runner-env.sh index 39828b7d7..14e9e6762 100755 --- a/tools/ci/runner-env.sh +++ b/tools/ci/runner-env.sh @@ -1,6 +1,6 @@ #!/usr/bin/env bash # The tools the vanilla harnesses need, on a self-hosted runner (label horizon-game): the Mac mini's, whose service -# starts with a bare PATH, and the Linux ones (tools/ci/linux-runner.sh, NixOS). Python 3.13 and the JDK pinned by +# starts with a bare PATH, and the Linux ones (tools/ci/linux-runner.sh: NixOS, Ubuntu). Python 3.13 and the JDK pinned by # research-lock.json come from the machine, never from a download. Writes them to $GITHUB_PATH and $GITHUB_ENV for # the next steps. set -euo pipefail diff --git a/tools/lan_e2e.py b/tools/lan_e2e.py index 1b2a7219b..a2d294d45 100755 --- a/tools/lan_e2e.py +++ b/tools/lan_e2e.py @@ -290,7 +290,15 @@ ROOT = Path(__file__).resolve().parents[1] GUEST_NAME = 'Guest' # 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'] +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', 'fireworks'] class Game: @@ -2898,6 +2906,55 @@ def sparked(player, other, kinds, act, ticks=20): return seen +def check_fireworks(host, guest, out): + """Event 17 must arrive before removal, with the item's colored, trailing explosion (#1478). + + FireworkRocketEntity.explode / handleEntityEvent; run with and without --server-thread. + The flash proves a configured explosion reached both clients; red pixels in later screenshots + check that its sparks keep rendering after the tracked rocket disappears. + """ + x, y, z = (int(v // 1) for v in pos_of(host)) + at = (x, y - 1, z + 3) + host('command', command=f'fill {x - 5} {y - 1} {z - 2} {x + 5} {y - 1} {z + 8} minecraft:stone') + host('command', command=f'fill {x - 5} {y} {z - 2} {x + 5} {y + 4} {z + 8} minecraft:air') + host('command', command=f'fill {x - 2} {y + 2} {z + 1} {x + 2} {y + 2} {z + 5} minecraft:stone') + for game, dx in ((host, -2), (guest, 2)): + game('command', command='gamemode creative') + game('command', command=f'tp @s {x + dx + 0.5} {y} {z + 0.5}') + game.raw('look-at', x + 0.5, y + 1.5, z + 3.5) + + def red(path): + rows, bpp = png_rows(path) + # Exclude the hotbar and chat at the bottom of the view. + return sum(row[i] > 80 and row[i] > 2 * row[i + 1] and row[i] > 2 * row[i + 2] + for row in rows[:len(rows) * 3 // 4] for i in range(0, len(row), bpp)) + + baseline = {g.name: red(g.shot(out, 'fireworks-before')) for g in (host, guest)} + before = {g.name: made(g, 'flash') for g in (host, guest)} + host('command', command='item replace entity @s weapon.mainhand with minecraft:firework_rocket' + '[fireworks={flight_duration:0,explosions:[{shape:"large_ball",colors:[I;16711680],has_trail:true}]}]') + host.raw('interact', *at) + # The held item's red texture must not count as a burst or a later spark. + host('command', command='item replace entity @s weapon.mainhand with minecraft:air') + for _ in range(30): + host.wait(2) + if all(made(g, 'flash') > before[g.name] for g in (host, guest)): + break + flashes = {g.name: made(g, 'flash') - before[g.name] for g in (host, guest)} + assert all(n == 1 for n in flashes.values()), f'configured burst missing or duplicated: {flashes}' + # Capture both views before decoding PNGs: decoding must not consume the sparks' lifetime. + burst_shots = {g.name: g.shot(out, 'fireworks-burst') for g in (host, guest)} + host.wait(16) + trail_shots = {g.name: g.shot(out, 'fireworks-trail-fade') for g in (host, guest)} + burst = {name: red(path) - baseline[name] for name, path in burst_shots.items()} + trails = {name: red(path) - baseline[name] for name, path in trail_shots.items()} + rockets = {g.name: g('status')['rockets'] for g in (host, guest)} + assert not any(rockets.values()), f'exploded rocket remains: {rockets}' + assert all(n > 20 for n in burst.values()), f'no red burst: {burst}' + assert all(n > 20 for n in trails.values()), f'no later red trail/fade: {trails}' + return {'flashes': flashes, 'red_burst': burst, 'red_trail_fade': trails, 'rockets': rockets} + + def check_sparks(host, guest, out): spots = apart(host, guest) result = {} @@ -4631,7 +4688,7 @@ CHECK_FNS = {'tab': check_tab, 'self': check_self, 'armour': check_armour, 'hud': check_hud, 'sidebar': check_sidebar, 'border': check_border, - 'particles': check_particles} + 'particles': check_particles, 'fireworks': check_fireworks} def run(ctl, out, resources, checks): @@ -7039,5 +7096,51 @@ CHECKS += ['sonic'] CHECK_FNS['sonic'] = check_sonic +def check_cushions(host, guest, out): + """#1935: place a colored cushion, consume it, track it, sit, dismount and break it.""" + seen = {} + for label, player, color in (('host', host, 'red'), ('guest', guest, 'blue')): + x, y, z = (int(v // 1) for v in pos_of(player)) + at = (x + 0.5, y, z + 2.5) + host('command', command=f'fill {x - 1} {y} {z + 1} {x + 1} {y + 3} {z + 3} minecraft:air') + host('command', command=f'setblock {x} {y - 1} {z + 2} minecraft:stone') + player('command', command='gamemode survival') + player('command', command=f'item replace entity @s weapon.mainhand with minecraft:{color}_cushion') + player.wait(10) + player.raw('look-at', *at) + player.raw('mouse', 'right', 'click') + player.wait(15) + def cushions(game): + return [o for o in game('status')['objects'] if o['kind'] == 'minecraft:cushion' + and abs(o['position'][0] - at[0]) < .1 and abs(o['position'][2] - at[2]) < .1] + server, client = cushions(host), cushions(player) + seen[label] = {'server': server, 'client': client, + 'remaining': player('inventory')['counts'].get(f'minecraft:{color}_cushion', 0)} + assert len(server) == len(client) == 1, seen + assert server[0]['color'] == client[0]['color'] == color, seen + assert seen[label]['remaining'] == 0, seen + player.shot(out, 'cushion-placed') + player.raw('look-at', at[0], at[1] + .125, at[2]) + player.raw('mouse', 'right', 'click') + player.wait(10) + seen[label]['riding'] = player('status').get('riding') + assert seen[label]['riding'] == server[0]['id'], seen + player.raw('key', 'shift', 'down') + player.wait(5) + player.raw('key', 'shift', 'up') + player.wait(5) + assert player('status').get('riding') is None, seen + player('command', command='gamemode creative') + player.raw('look-at', at[0], at[1] + .125, at[2]) + player.raw('mouse', 'left', 'click') + player.wait(10) + assert not cushions(host) and not cushions(player), seen + return seen + + +CHECKS += ['cushions'] +CHECK_FNS['cushions'] = check_cushions + + if __name__ == '__main__': main() diff --git a/tools/parity_hosts.json b/tools/parity_hosts.json index 164a3ff42..b98091f4f 100644 --- a/tools/parity_hosts.json +++ b/tools/parity_hosts.json @@ -20,6 +20,16 @@ "nice": 19, "note": "ludodesktop, the maintainer's own machine: only while nobody uses it (tools/ci/runner_pause.py: screen locked or untouched for 15 min, no game; a paused desktop refuses workers and stops the running ones, whose harnesses then run here); 8 jobs at most, in the CI runner's environment and slice" }, + "playhorizon": { + "ssh": "ludovic@playhorizon", + "root": ".actions-runners/horizon/parity-host", + "shell": "systemd-run --user --scope --quiet --slice=horizon-ci.slice --unit=horizon-parity-worker-$$ bash -c", + "setup": "test ! -e ~/.actions-runners/horizon/paused && set -a && . ~/.actions-runners/horizon/.env && set +a && export PATH=$(cat ~/.actions-runners/horizon/.path) && unset WAYLAND_DISPLAY && export DISPLAY=:$(cat ~/.actions-runners/horizon/display)", + "python": "python3.13", + "jobs": 6, + "nice": 10, + "note": "a partner's server (Ubuntu, 8 EPYC threads, 30 GB, Detroit; tailnet only), used by nothing else: 6 jobs, in the CI runner's environment, slice and Xvfb screen (tools/ci/linux-runner.sh); the light Linux checks that used to go to the ThinkPad go here" + }, "thinkpad": { "ssh": "thinkpad", "root": "code/horizon-parity", diff --git a/tools/quiet_commands_e2e.py b/tools/quiet_commands_e2e.py new file mode 100644 index 000000000..f7008bbd6 --- /dev/null +++ b/tools/quiet_commands_e2e.py @@ -0,0 +1,135 @@ +#!/usr/bin/env python3 +"""Mods' quiet commands on Horizon's dedicated server, end to end (horizon_protocol::quiet). + +Horizon's dedicated server (a flat world) and Horizon's headless client (`HORIZON_NET_REPORT`, the net +harness), which joins, then sends a batch of quiet commands as a mod would (`HORIZON_NET_QUIET`): + +- as a player who isn't an operator: `setblock` is refused (the block stays air), as it would be typed; +- as an operator: `setblock` runs, a `fill` that changes nothing fails, and `say` is refused (a chat + message needs the player's signature); +- either way the player's chat gets nothing of them, and the server logs one line per batch: the player, + the mod, how many ran and how many failed. + + python3 tools/quiet_commands_e2e.py --bin-dir target/fast + +The client runs with fresh HORIZON_HOME, launcher and XDG folders and without audio; the logs go to --out. +""" +import argparse +import json +import os +import shutil +import subprocess +import sys +import tempfile +import time +from pathlib import Path + +sys.path.insert(0, str(Path(__file__).resolve().parent)) +import lab # noqa: E402 +from integration_env import run_game # noqa: E402 +from test_dedicated_server_parity import Server # noqa: E402 + +ROOT = Path(__file__).resolve().parents[1] +PLAYER = 'Tester' +PROPERTIES = { + 'online-mode': 'false', + 'white-list': 'false', + 'level-type': 'minecraft\\:flat', + 'generate-structures': 'false', + 'spawn-protection': '0', + 'view-distance': '3', + 'simulation-distance': '3', + 'pause-when-empty-seconds': '-1', +} +BLOCK = '2 -55 2' +# What a player would see of these commands, were they typed. +FEEDBACK = ['Changed the block', 'No blocks were filled', 'Unknown or incomplete command', 'hi from a mod', + 'Could not set the block'] + + +def join(binary, port, out, label, lines): + """The headless client joins, sends `lines` as one quiet batch and leaves: its report.""" + home = Path(tempfile.mkdtemp(prefix=f'quiet-{label}-')) + report = out / f'{label}-report.json' + # run_game gives the game fresh home, launcher and XDG folders. + env = dict(HORIZON_NET_REPORT=str(report), HORIZON_NET_QUIET=';'.join(lines)) + with (out / f'{label}-client.log').open('w') as log: + run_game([str(binary), '--resources', str(lab.RESOURCES), '--render-distance', '2', + '--server', f'127.0.0.1:{port}', '--name', PLAYER], + cwd=home, env=dict(os.environ, **env), stdout=log, stderr=subprocess.STDOUT, timeout=300, + check=True) + shutil.rmtree(home, ignore_errors=True) + return json.loads(report.read_text()) + + +def main(): + parser = argparse.ArgumentParser(description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter) + parser.add_argument('--bin-dir', help='a prebuilt horizon-client (default: build it with the fast profile)') + parser.add_argument('--out', default=str(ROOT / '.local/quiet-commands-e2e'), help='logs go here') + args = parser.parse_args() + out = Path(args.out) + shutil.rmtree(out, ignore_errors=True) + out.mkdir(parents=True) + if args.bin_dir: + binary = Path(args.bin_dir) / 'horizon-client' + else: + subprocess.run(['cargo', 'build', '--profile', 'fast', '-p', 'horizon-client', '--bin', 'horizon-client'], + cwd=ROOT, check=True) + binary = Path(lab.cargo_target()) / 'fast' / 'horizon-client' + port = lab.free_port() + directory = out / 'server' + directory.mkdir() + props = dict(PROPERTIES, **{'server-port': str(port)}) + (directory / 'server.properties').write_text(''.join(f'{k}={v}\n' for k, v in props.items()), + encoding='iso-8859-1') + (directory / 'eula.txt').write_text('eula=true\n') + server = Server([binary, '--resources', lab.RESOURCES, '--dedicated', '--nogui'], directory, 'server') + failures = [] + + def check(what, ok, detail=''): + print(('PASS ' if ok else 'FAIL ') + what + ('' if ok else f': {detail}')) + if not ok: + failures.append(what) + + def test_block(want): + """The console's `execute if block`: 'Test passed' when the block is `want`.""" + before = len(server.lines) + server.console(f'execute if block {BLOCK} {want}') + deadline = time.time() + 30 + while time.time() < deadline: + answer = [l for l in server.lines[before:] if 'Test passed' in l or 'Test failed' in l] + if answer: + return 'Test passed' in answer[0] + time.sleep(0.2) + raise AssertionError('the console never answered execute if block') + + try: + server.wait_for(r'Done \(') + # Not an operator: the setblock is refused, as typed. + got = join(binary, port, out, 'not-op', [f'setblock {BLOCK} minecraft:gold_block']) + server.wait_for(rf'{PLAYER} ran 1 quiet command\(s\) from mod net_harness: 1 failed', timeout=30) + check('not an operator: connected throughout', got['error'] is None, got['error']) + check("not an operator: a quiet setblock is refused", not test_block('minecraft:gold_block')) + heard = [c for c in got['chat'] if any(f in c for f in FEEDBACK)] + check('not an operator: nothing in the chat', not heard, heard) + server.wait_for(rf'{PLAYER} left the game', timeout=60) + # An operator: it runs, quietly. + server.console(f'op {PLAYER}') + server.wait_for(rf'Made {PLAYER} a server operator', timeout=30) + got = join(binary, port, out, 'op', [f'setblock {BLOCK} minecraft:gold_block', + f'fill {BLOCK} {BLOCK} minecraft:gold_block', 'say hi from a mod']) + server.wait_for(rf'{PLAYER} ran 3 quiet command\(s\) from mod net_harness: 2 failed', timeout=30) + check('operator: connected throughout', got['error'] is None, got['error']) + check('operator: the quiet setblock ran', test_block('minecraft:gold_block')) + heard = [c for c in got['chat'] if any(f in c for f in FEEDBACK)] + check('operator: nothing in the chat (no feedback, no failure, no say)', not heard, heard) + said = [l for l in server.lines if 'hi from a mod' in l] + check('operator: say is refused', not said, said) + finally: + server.stop() + print(f'logs: {out}') + sys.exit(1 if failures else 0) + + +if __name__ == '__main__': + main() diff --git a/tools/test_cushion_placement_parity.py b/tools/test_cushion_placement_parity.py new file mode 100644 index 000000000..6b9d5ae0a --- /dev/null +++ b/tools/test_cushion_placement_parity.py @@ -0,0 +1,51 @@ +#!/usr/bin/env python3 +"""Compare cushion support, burial and coverage against vanilla's real checks.""" +import json +import random + +try: + from . import lab, oracle_harness as harness +except ImportError: + import lab, oracle_harness as harness + + +def make_input(build): + full = [[0, 0, 0, 1, 1, 1]] + shapes = [[], full, [[0, 0, 0, 1, .5, 1]], [[0, .5, 0, 1, 1, 1]], + [[.375, 0, .375, .625, 1.5, .625]], [[0, 0, 0, .5, 1, 1]], + [[0, 0, 0, .5, 1, 1], [.5, 0, 0, 1, 1, 1]]] + rows = [] + for x, z in ((0, 0), (-2, -3), (17, 31)): + for y in (0, .125, .5, .875, 1, 1.00000001, 1.015625, 1.125): + for outline in shapes: + for collision in shapes: + for suffocating in (False, True): + rows.append(dict(pos=[x + .5, y, z + .5], + cells=[[x, 0, z, outline, collision, suffocating]])) + rng = random.Random(1935) + for _ in range(500): + cells = [] + for y in (-1, 0, 1): + for x in (-1, 0, 1): + for z in (-1, 0, 1): + if rng.random() < .3: + cells.append([x, y, z, rng.choice(shapes), rng.choice(shapes), bool(rng.randrange(2))]) + rows.append(dict(pos=[rng.choice((0, .5, 1)), rng.choice((0, .5, 1, 1.125)), rng.choice((0, .5, 1))], cells=cells)) + path = build / 'inputs.jsonl' + path.write_text(''.join(json.dumps(row) + '\n' for row in rows)) + return path, len(rows) + + +def main(): + harness.differential( + 'rust-cushion-placement-parity', 'VanillaCushionPlacementOracle', + 'cushion_placement_probe', make_input, + 'Actual Cushion.canBePlacedAt and wouldSurviveAt, with controlled outline, collision ' + 'and suffocation queries. Includes partial supports, burial, complete coverage, ' + 'overhanging outlines, negative coordinates and boundary heights. Item use, ' + 'entity tracking, interaction and persistence are checked separately.', + sources=[lab.ROOT / 'crates/horizon-client/src/cushion.rs']) + + +if __name__ == '__main__': + main() diff --git a/tools/test_mob_ai_parity.py b/tools/test_mob_ai_parity.py index 2ce6541e8..133deca2d 100644 --- a/tools/test_mob_ai_parity.py +++ b/tools/test_mob_ai_parity.py @@ -519,7 +519,9 @@ def main(): # The oracle's server world: cleared before each run, never left in /tmp. world = build / 'world' shutil.rmtree(world, ignore_errors=True) - oracle_harness.run_logged(['java', '-Xmx3g', '-Djava.awt.headless=true', '-cp', str(classes) + os.pathsep + dependencies, + # Each scenario forces 9x9 chunks 512 blocks past the last one, so a run generates ~80 chunks per scenario; + # 3g ran out of heap in PoiManager.tick on a busy runner (#2160's CI, 143 scenarios). + oracle_harness.run_logged(['java', '-Xmx4g', '-Djava.awt.headless=true', '-cp', str(classes) + os.pathsep + dependencies, 'dev.horizonlab.parity.VanillaMobAiOracle', inputs, build / 'vanilla.txt', world], build, 'vanilla', timeout=3600) if not args.java_only: diff --git a/tools/test_remote_fireworks_parity.py b/tools/test_remote_fireworks_parity.py new file mode 100644 index 000000000..51440731e --- /dev/null +++ b/tools/test_remote_fireworks_parity.py @@ -0,0 +1,34 @@ +#!/usr/bin/env python3 +"""FireworkRocketEntity event 17 renders the configured burst before tracked removal. + +Exercise both hosting paths and subsequent trail/fade frames through real clients. +""" +import json +import subprocess + +import lab +import lan_e2e as lan + + +def main(): + subprocess.run(['cargo', 'build', '--locked', '--profile', 'fast', '-p', 'horizon-client', + '--bin', 'horizon-client', '--bin', 'horizon-ctl'], cwd=lab.ROOT, check=True) + metadata = json.loads(subprocess.check_output( + ['cargo', 'metadata', '--format-version', '1', '--no-deps'], cwd=lab.ROOT, text=True)) + ctl = lab.ROOT / metadata['target_directory'] / 'fast' / 'horizon-ctl' + # CI supplies the display; each game still gets fresh scratch homes. + lan.game_env = lambda _screen, home: lab.game_env( + HORIZON_HOME=home, HORIZON_TELEMETRY_URL='off') + reports = {} + for threaded in (True, False): + lan.SERVER_THREAD = threaded + mode = 'server-thread' if threaded else 'in-frame' + out = lab.LOCAL / 'remote-fireworks-parity' / mode + out.mkdir(parents=True, exist_ok=True) + reports[mode] = lan.run(ctl, out, lab.RESOURCES.resolve(), ['fireworks']) + lab.write_json(lab.LOCAL / 'remote-fireworks-parity' / 'report.json', reports) + assert all(r['pass'] for mode in reports.values() for r in mode.values()), reports + + +if __name__ == '__main__': + main() diff --git a/website/build.mjs b/website/build.mjs index b979f83f8..8e93c82b4 100644 --- a/website/build.mjs +++ b/website/build.mjs @@ -18,7 +18,7 @@ import { CPUS, GPUS, singleThread } from "./src/hardware.js"; import { isGame, isLauncher, launcherVersion, newestFirst } from "./src/versions.js"; import { contributorsFrom, contributorsHtml } from "./src/contributors.js"; import { areaFilterHtml, boardFilterHtml, boardFrom, boardHtml, creditFrom, creditHtml, helpWantedHtml, journalFrom, journalHtml, journalJson, overviewHtml, roadmapHtml, slimIssue, suggestItemsHtml } from "./src/hub.js"; -import { INDEX_URL, KINDS, SUBMIT, listHtml, projectHtml, readIndex, submitHtml } from "./src/mods.js"; +import { INDEX_URL, KINDS, SORTS, SUBMIT, listHtml, projectHtml, readIndex, sorted, submitHtml } from "./src/mods.js"; const site = dirname(fileURLToPath(import.meta.url)); const dist = join(site, "dist"); @@ -484,10 +484,11 @@ const modsList = `

ModsMade for Horizon, r ${KINDS.map(([k, label]) => ` `).join("\n")}

+

${modProjects.length} of ${modProjects.length}

-${listHtml(modProjects)} +${listHtml(sorted(modProjects, "downloads"))}
`; const modPages = [ { file: "mods.html", path: "/mods", title: "Mods", description: "Mods, modpacks and resource packs made for Horizon, reviewed, each with what it may do and how to install it.", main: modsList }, diff --git a/website/data/roadmap.json b/website/data/roadmap.json index 58d697257..050b89394 100644 --- a/website/data/roadmap.json +++ b/website/data/roadmap.json @@ -1034,58 +1034,65 @@ { "id": "item-cooldowns", "title": "Cooldowns drawn on items", - "status": "help-wanted", + "status": "now", "area": "gameplay", "plain": "After you throw an ender pearl, its slot should show the cooldown sweeping away, as in vanilla.", "dev": "Vanilla draws `ItemCooldowns`' percent as a white overlay over the slot (`GuiGraphicsExtractor.itemDecorations` and `itemCooldown`) in the hotbar and in inventories. Issue #1763.", "links": [ - "#1763" + "#1763", + "#1933" ] }, { "id": "chat-settings", "title": "Chat settings and team prefixes", - "status": "help-wanted", + "status": "now", "area": "gameplay", "plain": "The Hidden and Commands Only chat settings should hide chat, and team prefixes should appear before names in chat.", "dev": "Vanilla checks `ChatVisiblity` before it delivers chat and system messages (#1376), and chat uses the team-formatted display name (#1378). Both issues have exact steps to reproduce.", "links": [ "#1376", - "#1378" + "#1378", + "#1932", + "#1841" ] }, { "id": "pointer-hand", "title": "A pointing hand over buttons", - "status": "help-wanted", + "status": "now", "area": "gameplay", "plain": "The mouse pointer should turn into a pointing hand over menu buttons, as in vanilla 26.3.", "dev": "26.3's `AbstractWidget` asks for a cursor from `CursorTypes` when it is hovered; winit's `CursorIcon::Pointer` gives the same shape. Issue #1347.", "links": [ - "#1347" + "#1347", + "#1897" ] }, { "id": "text-field-keys", "title": "Ctrl+Backspace and scroll bars in menus", - "status": "help-wanted", + "status": "now", "area": "gameplay", "plain": "Ctrl+Backspace should delete a whole word in the creative search, and every list's scroll bar should be draggable.", "dev": "`EditBox` deletes by word with Ctrl (#1764); the Game Rules and Statistics lists' scroll bars can't be dragged (#1782, after #978).", "links": [ "#1764", - "#1782" + "#1782", + "#1884", + "#1931" ] }, { "id": "chicken-flap", "title": "Chickens flap while they fall", - "status": "help-wanted", + "status": "now", "area": "gameplay", "plain": "Chickens should flap their wings while they fall, not stand still in the air.", "dev": "Vanilla's `Chicken.aiStep` updates `flap` and `flapSpeed` when the chicken isn't on the ground, and the model's wings follow them. Issue #1706.", "links": [ - "#1706" + "#1706", + "#1892" ] }, { diff --git a/website/src/mods-page.js b/website/src/mods-page.js index 121ba8067..335e863bd 100644 --- a/website/src/mods-page.js +++ b/website/src/mods-page.js @@ -1,32 +1,47 @@ -// /mods and /mods/: the registry's list (kind filter, search) and a project's page. The pages are baked from -// the index at build time; this fetches the published index again so a project merged since shows at once. -import { INDEX_URL, KINDS, listHtml, matches, projectHtml, readIndex } from "./mods.js"; +// /mods and /mods/: the registry's list (kind filter, search, order) and a project's page. The pages are baked +// from the index at build time; this fetches the published index again so a project merged since shows at once, +// the ratings (crates/horizon-mod-registry), and on a project's page the signed-in player's own rating to change. +import { API, INDEX_URL, KINDS, RATINGS, SORTS, listHtml, matches, projectHtml, rateHtml, ratingOf, readIndex, sorted, starsHtml } from "./mods.js"; import { cached, setUpMenu, setUpTheme } from "./chrome.js"; +import { escape } from "./markdown.js"; const root = document.getElementById("mods"); const baked = readIndex(JSON.parse(document.getElementById("mods-index").textContent || "null")) || []; let projects = baked; +// Every project's ratings, once the service answered. +let ratings = null; let kind = "all"; let text = ""; +let order = "downloads"; +// On a project's page: the signed-in account ({login, csrf}) or null, and its own rating of the project. +let me; +let mine = null; const id = (location.pathname.match(/^\/mods\/([a-z0-9_]+)\/?$/) || [])[1]; function showList() { const list = root.querySelector("#mod-list"); if (!list) return; - const shown = projects.filter((p) => matches(p, kind, text)); - list.innerHTML = listHtml(shown); + const shown = sorted(projects.filter((p) => matches(p, kind, text)), order, ratings); + list.innerHTML = listHtml(shown, ratings); root.querySelector("[data-mod-count]").textContent = `${shown.length} of ${projects.length}`; root.querySelectorAll("[data-kind-filter]").forEach((b) => b.setAttribute("aria-pressed", String(b.dataset.kindFilter === kind))); } +function showRate(p, message = "") { + const rate = root.querySelector("#mod-rate"); + if (!rate || me === undefined) return; + rate.innerHTML = rateHtml(p, me, mine) + (message ? `

${escape(message)}

` : ""); +} + function showProject() { const p = projects.find((x) => x.id === id); const page = root.querySelector(".mod-page, .mod-missing"); if (!page) return; if (p) { - page.outerHTML = projectHtml(p); + page.outerHTML = projectHtml(p, ratings ? ratingOf(ratings, p.id) : undefined); document.title = `${p.name} · Horizon`; + showRate(p); } else { page.outerHTML = `

Not in the registry

No project is called ${id} here. It may not be published yet, or it was taken down.

Every mod
`; } @@ -37,7 +52,56 @@ function render() { else showList(); } -if (!id) { +// The signed-in account and its own rating, for the page's rating control. +async function signIn() { + try { + const r = await fetch(`${API}/me`, { credentials: "same-origin" }); + me = r.ok ? await r.json() : null; + if (me) { + const own = await fetch(`${API}/${id}/rating`, { credentials: "same-origin" }); + mine = own.ok ? (await own.json()).stars : null; + } + } catch { + me = null; + } + const p = projects.find((x) => x.id === id); + if (p) showRate(p); +} + +async function rate(stars) { + const p = projects.find((x) => x.id === id); + if (!p || !me) return; + root.querySelectorAll(".mod-star").forEach((b) => (b.disabled = true)); + let message = ""; + try { + const r = await fetch(`${API}/${id}/rating`, { + method: "POST", + credentials: "same-origin", + headers: { "Content-Type": "application/json", "X-CSRF-Token": me.csrf }, + body: JSON.stringify({ stars }), + }); + const json = await r.json().catch(() => ({})); + if (r.ok) { + mine = json.stars; + ratings = { ...ratings, [id]: { average: json.average, count: json.count } }; + const line = root.querySelector("[data-mod-rating]"); + if (line) line.innerHTML = `${starsHtml(ratingOf(ratings, id))} · `; + } else { + message = json.error || `The service answered ${r.status}.`; + } + } catch { + message = "The service didn't answer. Try again in a minute."; + } + showRate(p, message); +} + +if (id) { + root.addEventListener("click", (e) => { + const star = e.target.closest?.("[data-stars]"); + if (star) rate(Number(star.dataset.stars)); + }); + signIn(); +} else { root.querySelectorAll("[data-kind-filter]").forEach((b) => b.addEventListener("click", () => { kind = b.dataset.kindFilter; @@ -48,8 +112,15 @@ if (!id) { text = e.target.value; showList(); }); - const wanted = new URLSearchParams(location.search).get("kind"); - if (KINDS.some(([k]) => k === wanted)) kind = wanted; + root.querySelector("#mod-sort")?.addEventListener("change", (e) => { + order = e.target.value; + showList(); + }); + const query = new URLSearchParams(location.search); + if (KINDS.some(([k]) => k === query.get("kind"))) kind = query.get("kind"); + if (SORTS.some(([k]) => k === query.get("sort"))) order = query.get("sort"); + const select = root.querySelector("#mod-sort"); + if (select) select.value = order; } setUpTheme(); @@ -64,3 +135,12 @@ cached("horizon:mod-index", () => fetch(INDEX_URL).then((r) => (r.ok ? r.json() } }) .catch(() => {}); +fetch(RATINGS) + .then((r) => (r.ok ? r.json() : Promise.reject(new Error(`${r.status}`)))) + .then((json) => { + if (json && typeof json.projects === "object") { + ratings = json.projects; + render(); + } + }) + .catch(() => {}); diff --git a/website/src/mods.js b/website/src/mods.js index 414db7396..28c31b9fe 100644 --- a/website/src/mods.js +++ b/website/src/mods.js @@ -8,6 +8,8 @@ const REGISTRY = "https://github.com/ludovic111/horizon-mods"; export const SUBMIT = "/mods/submit"; // The submission form's service (crates/horizon-mod-registry), behind the site's own address. export const API = "/api/mods"; +// Every project's ratings: {projects: {: {average, count}}}. +export const RATINGS = `${API}/ratings`; export const SCHEMA = 1; // The kinds the site shows, in the filter's order. Kinds a newer index adds are left out until the site knows them. @@ -43,21 +45,66 @@ const initial = (p) => escape((p.name || p.id).trim().charAt(0).toUpperCase()); const icon = (p) => https(p.icon) ? `` : ``; +// A count as the launcher writes it: 999, 12.3k, 4.1M. +export function count(n) { + if (n < 1000) return String(n); + if (n < 1e6) return `${(n / 1e3).toFixed(1)}k`; + return `${(n / 1e6).toFixed(1)}M`; +} + +const downloads = (p) => { + const n = Number.isSafeInteger(p.downloads) && p.downloads > 0 ? p.downloads : 0; + return `${count(n)} download${n === 1 ? "" : "s"}`; +}; + +// A project's ratings from the service's answer, or null when it has none. +export function ratingOf(ratings, id) { + const r = ratings?.[id]; + return r && Number.isFinite(r.average) && Number.isSafeInteger(r.count) && r.count > 0 ? r : null; +} + +// Five stars, the mean's nearest whole number of them filled, and the mean and count beside. +export function starsHtml(r) { + if (!r) return `No ratings yet`; + const on = Math.min(5, Math.max(0, Math.round(r.average))); + const mean = r.average.toFixed(1); + return `Rated ${mean} out of 5 ${mean} (${count(r.count)})`; +} + +// The list's orders: the most downloaded first (the default), the best rated, or by name. +export const SORTS = [ + ["downloads", "Most downloaded"], + ["rating", "Best rated"], + ["name", "Name"], +]; + +export function sorted(projects, by, ratings) { + const avg = (p) => ratingOf(ratings, p.id)?.average || 0; + const votes = (p) => ratingOf(ratings, p.id)?.count || 0; + const name = (a, b) => a.name.localeCompare(b.name); + const order = { + downloads: (a, b) => (b.downloads || 0) - (a.downloads || 0) || name(a, b), + rating: (a, b) => avg(b) - avg(a) || votes(b) - votes(a) || name(a, b), + name, + }[by] || (() => 0); + return [...projects].sort(order); +} + export function matches(p, kind, text) { if (kind !== "all" && p.kind !== kind) return false; const hay = `${p.id} ${p.name} ${p.summary} ${(p.authors || []).join(" ")}`.toLowerCase(); return text.toLowerCase().split(/\s+/).filter(Boolean).every((w) => hay.includes(w)); } -// The list: a row per project, newest version and kind on the right. -export function listHtml(projects) { +// The list: a row per project; its kind, ratings (once `ratings` is known), downloads and newest version on the right. +export function listHtml(projects, ratings = null) { if (!projects.length) return `

Nothing here yet. Submit yours.

`; return projects .map( (p) => ` ${icon(p)} ${escape(p.name)}${escape(p.summary || "")} - ${escape(KIND_NAMES[p.kind] || p.kind)}${escape(p.versions[0].version)} · ${escape((p.authors || []).join(", "))} + ${escape(KIND_NAMES[p.kind] || p.kind)}${ratings ? `${starsHtml(ratingOf(ratings, p.id))} · ` : ""}${downloads(p)}${escape(p.versions[0].version)} · ${escape((p.authors || []).join(", "))} `, ) .join("\n"); @@ -92,8 +139,19 @@ export function ownersHtml(p) { return `

Published by ${links}

`; } -// One project's page. -export function projectHtml(p) { +// The rating control under a project's ratings: five stars to press when signed in (`mine`, the account's own +// rating, pressed), a sign-in link when not, a note for the project's owners. +export function rateHtml(p, me, mine) { + if (!me) return `Sign in with GitHub to rate`; + if ((p.owners || []).some((o) => o.toLowerCase() === String(me.login).toLowerCase())) return `

You publish it: players rate it.

`; + const stars = [1, 2, 3, 4, 5] + .map((n) => ``) + .join(""); + return `${mine ? "Your rating" : "Rate it"}${stars}`; +} + +// One project's page; `rating` is its ratings (null: none yet), left out when they aren't known. +export function projectHtml(p, rating) { const v = p.versions[0]; const caps = v.capabilities || []; const capsHtml = caps.length @@ -108,7 +166,9 @@ export function projectHtml(p) { return `
${icon(p)}

${escape(KIND_NAMES[p.kind] || p.kind)}${escape((p.authors || []).join(", "))}

${ownersHtml(p)}

${escape(p.name)}

${escape(p.summary || "")}

-

${trust(p)} ${escape(p.license)} ${escape(v.version)}${v.side ? ` ${escape(v.side)}` : ""}

+

${trust(p)} ${escape(p.license)} ${escape(v.version)}${v.side ? ` ${escape(v.side)}` : ""}

+

${rating === undefined ? "" : `${starsHtml(rating)} · `}${downloads(p)}

+
${p.description ? `
${markdown(p.description)}
` : ""} ${p.kind === "mod" ? `

What it may do

${capsHtml}

Mods run in a sandbox with no file, network or clock access. The game refuses a mod whose code uses more than this list.

` : ""} ${requires} diff --git a/website/src/mods.test.mjs b/website/src/mods.test.mjs index c5ff2e783..d94cc3e07 100644 --- a/website/src/mods.test.mjs +++ b/website/src/mods.test.mjs @@ -1,6 +1,6 @@ import { test } from "node:test"; import assert from "node:assert/strict"; -import { CAPABILITIES, entryFrom, listHtml, matches, projectHtml, readIndex, submitHtml } from "./mods.js"; +import { CAPABILITIES, count, entryFrom, listHtml, matches, projectHtml, rateHtml, ratingOf, readIndex, sorted, starsHtml, submitHtml } from "./mods.js"; const project = (over = {}) => ({ id: "coords_hud", kind: "mod", name: "Coordinates HUD", summary: "Where you are.", authors: ["Horizon"], @@ -61,3 +61,50 @@ test("a project's page links its owners' GitHub profiles, and only valid logins" for (const bad of ["bad login", "github.com/-x", "a--b", "