From 57ee0810381b2d1d271fcfa6678bb8de456c7151 Mon Sep 17 00:00:00 2001 From: levzzz <86072227+levzzz5154@users.noreply.github.com> Date: Sun, 25 Oct 2026 15:56:53 +0500 Subject: [PATCH 01/26] Keep sprint state independent of held sprint keys Let PlayerCommand control the server sprint flag, matching vanilla, so releasing Ctrl cannot leave the client's speed modifier and FOV stuck. Cover the packet sequence and FOV recovery in regression tests. Co-Authored-By: Codex (GPT-6) --- crates/horizon-client/src/game/agent.rs | 3 +- crates/horizon-client/src/lan/hub.rs | 4 +- crates/horizon-client/tests/lan_bot.rs | 59 +++++++++++++++++++++++++ tools/lan_e2e.py | 46 +++++++++++++++++++ 4 files changed, 110 insertions(+), 2 deletions(-) diff --git a/crates/horizon-client/src/game/agent.rs b/crates/horizon-client/src/game/agent.rs index f6b68aa74..57c12da97 100644 --- a/crates/horizon-client/src/game/agent.rs +++ b/crates/horizon-client/src/game/agent.rs @@ -469,7 +469,8 @@ impl Game<'_> { "flying": p.flying, "fall_flying": p.fall_flying, "sneaking": self.keys.contains(&KeyCode::ShiftLeft), - "sprinting": self.keys.contains(&KeyCode::ControlLeft), + "sprinting": p.sprinting, + "fov_modifier": self.view.fov_modifier, "health": p.health.health(), "absorption": p.health.absorption(), // The hurt animation's ticks left (the camera's hurt tilt). diff --git a/crates/horizon-client/src/lan/hub.rs b/crates/horizon-client/src/lan/hub.rs index c2a395899..dd0a32f22 100644 --- a/crates/horizon-client/src/lan/hub.rs +++ b/crates/horizon-client/src/lan/hub.rs @@ -1984,7 +1984,9 @@ impl Hub { S::PlayerInput(p) => { self.guests[i].input = p.flags; self.guests[i].sneaking = p.flags & 32 != 0; - self.guests[i].sprinting = p.flags & 64 != 0 && p.flags & 1 != 0; + // handlePlayerInput only records keys and updates crouching. + // Sprinting persists after the sprint key is released (or + // starts with a double tap); PlayerCommand changes it. } // OPEN_INVENTORY (the ridden mount's inventory) and // START_FALL_FLYING (checked against the guest's chest slot diff --git a/crates/horizon-client/tests/lan_bot.rs b/crates/horizon-client/tests/lan_bot.rs index 6dd1b8258..34e8265a1 100644 --- a/crates/horizon-client/tests/lan_bot.rs +++ b/crates/horizon-client/tests/lan_bot.rs @@ -278,6 +278,65 @@ fn run( handle.join().unwrap().unwrap() } +#[test] +fn sprint_commands_survive_keyboard_input_changes() { + let Some(resources) = resources() else { + return; + }; + let mut s = server(&resources); + let port = s.hub.lan.port; + let _bot = run(&mut s, move || connect(port, "Sprinter", true)); + let deadline = Instant::now() + Duration::from_secs(5); + while s.hub.guests.is_empty() { + s.tick(&[]); + assert!(Instant::now() < deadline, "guest did not join"); + thread::yield_now(); + } + let id = s.hub.guests[0].entity_id; + s.hub.guests[0].loaded = true; + s.hub.guests[0] + .inbox + .push_back(S::PlayerCommand(play::PlayerCommand { + id, + action: 1, + data: 0, + })); + s.tick(&[]); + assert!(s.hub.guests[0].sprinting); + // LocalPlayer keeps sprinting after Ctrl is released while W remains + // down. Double-tap sprint also sends forward without the sprint key. + for flags in [65, 1, 0, 33] { + s.hub.guests[0] + .inbox + .push_back(S::PlayerInput(play::PlayerInput { flags })); + s.tick(&[]); + let g = &s.hub.guests[0]; + assert!( + g.sprinting, + "keyboard input {flags} cleared the sprint flag" + ); + assert_eq!(g.input, flags); + assert_eq!(g.sneaking, flags & 32 != 0); + } + s.hub.guests[0] + .inbox + .push_back(S::PlayerCommand(play::PlayerCommand { + id, + action: 2, + data: 0, + })); + s.tick(&[]); + assert!(!s.hub.guests[0].sprinting); + s.hub.guests[0] + .inbox + .push_back(S::PlayerInput(play::PlayerInput { flags: 65 })); + s.tick(&[]); + assert!( + !s.hub.guests[0].sprinting, + "keyboard input started a sprint" + ); +} + #[test] fn status_and_join() { let Some(resources) = resources() else { diff --git a/tools/lan_e2e.py b/tools/lan_e2e.py index 0c8979f0a..892e393f0 100755 --- a/tools/lan_e2e.py +++ b/tools/lan_e2e.py @@ -6162,5 +6162,51 @@ CHECKS += ['falling'] CHECK_FNS.update(falling=check_falling) +def check_sprint_fov(host, guest, out): + """Releasing Ctrl must preserve a sprint until W is released, then reset FOV. + + PlayerInput reports keys; PlayerCommand starts/stops the sprint. Confusing + them clears the client's sprint flag while leaving its speed modifier on. + """ + seen = {} + for game in (host, guest): + game('command', command='gamemode creative') + game('command', command='effect clear @s') + game.raw('options-set', 'fovEffectScale', '1.0') + x, y, z = map(math.floor, pos_of(game)) + game('command', command=f'fill {x - 2} {y} {z - 2} {x + 2} {y + 3} {z + 20} minecraft:air') + game('command', command=f'fill {x - 2} {y - 1} {z - 2} {x + 2} {y - 1} {z + 20} minecraft:stone') + game('command', command=f'tp @s {x + 0.5} {y} {z + 0.5} 0 0') + game.wait(20) + try: + game.raw('key', 'w', 'down') + game.raw('key', 'ctrl', 'down') + game.wait(10) + started = game('state')['player'] + game.raw('key', 'ctrl', 'up') + game.wait(10) + released_ctrl = game('state')['player'] + game.raw('key', 'w', 'up') + game.wait(20) + stopped = game('state')['player'] + finally: + game.raw('key', 'ctrl', 'up') + game.raw('key', 'w', 'up') + seen[game.name] = states = { + label: {k: p[k] for k in ('sprinting', 'fov_modifier')} + for label, p in [('started', started), ('released_ctrl', released_ctrl), ('stopped', stopped)] + } + for label in ('started', 'released_ctrl'): + assert states[label]['sprinting'], f'{game.name} {label}: {states}' + assert abs(states[label]['fov_modifier'] - 1.15) < 0.002, f'{game.name} {label}: {states}' + assert not stopped['sprinting'], f'{game.name}: {states}' + assert abs(stopped['fov_modifier'] - 1.0) < 0.002, f'{game.name}: {states}' + return seen + + +CHECKS += ['sprint-fov'] +CHECK_FNS['sprint-fov'] = check_sprint_fov + + if __name__ == '__main__': main() From 0bc85843ce0d9672c6990345af6ffd4e4b180993 Mon Sep 17 00:00:00 2001 From: socksprox Date: Sun, 25 Oct 2026 00:19:47 +0200 Subject: [PATCH 02/26] Client: remote players keep their skins instead of falling back MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit skins::unpack discarded a profile's whole textures payload when any one entry lacked "url" or pointed outside the texture services' domains, so a player with e.g. an unusual cape lost their skin too; it now drops only the offending texture. The 32 skin atlas slots evicted past players back to defaults on busy servers — now 128. A dimension reset (join game or respawn onto another world) now also clears the entity-id→profile map so a re-used entity id can't pin the wrong skin or name to a player, and the nametag join falls back to the player-list entry's name. Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com> --- crates/horizon-client/src/game/remote.rs | 12 +++++++++++- crates/horizon-client/src/hud.rs | 4 +++- crates/horizon-client/src/skins.rs | 21 +++++++++++---------- 3 files changed, 25 insertions(+), 12 deletions(-) diff --git a/crates/horizon-client/src/game/remote.rs b/crates/horizon-client/src/game/remote.rs index 5a71b13a8..36122d42a 100644 --- a/crates/horizon-client/src/game/remote.rs +++ b/crates/horizon-client/src/game/remote.rs @@ -1006,6 +1006,9 @@ impl Game<'_> { r.stepped.clear(); r.head_lerps.clear(); r.pending_items.clear(); + // The entity ids are the old world's; the new dimension's + // player entities re-map to their profiles on AddEntity. + r.level_players.clear(); // A new ClientLevel: a new chunk storage, centred on 0, 0. r.chunk_center = (0, 0); } @@ -5065,7 +5068,14 @@ impl Game<'_> { r.level_players .iter() .filter(|(_, uuid)| **uuid != r.profile) - .filter_map(|(id, uuid)| Some((*id as u32, r.players.get(uuid)?.clone()))) + .filter_map(|(id, uuid)| { + let name = r + .players + .get(uuid) + .cloned() + .or_else(|| r.tab_players.get(uuid).map(|t| t.name.clone()))?; + Some((*id as u32, name)) + }) .collect() } /// `ClientClockManager.tick`: the clock moves on by the game time that diff --git a/crates/horizon-client/src/hud.rs b/crates/horizon-client/src/hud.rs index 89d1b1c3c..90a8b346c 100644 --- a/crates/horizon-client/src/hud.rs +++ b/crates/horizon-client/src/hud.rs @@ -78,7 +78,9 @@ pub const MAP_SLOTS: usize = 256; /// The atlas slot the minimap extra draws into. pub const MINIMAP_SPRITE: &str = "horizon/minimap"; /// Atlas slots for downloaded player skins (`skins/`), 64x64 each. -pub const SKIN_SLOTS: usize = 32; +/// Vanilla registers a texture per skin; too few slots evict a busy +/// server's players back to their default skins. +pub const SKIN_SLOTS: usize = 128; /// Reused by the visible rows of the classic world selector. pub const WORLD_ICON_SLOTS: usize = 32; /// Atlas slots for the pack icons on the pack screen, one per icon drawn diff --git a/crates/horizon-client/src/skins.rs b/crates/horizon-client/src/skins.rs index 9014032c4..0cf9cc8a2 100644 --- a/crates/horizon-client/src/skins.rs +++ b/crates/horizon-client/src/skins.rs @@ -92,22 +92,23 @@ pub fn unpack(value: &str, signature: Signature, valid_uris: &[&str]) -> Texture ..empty.clone() }; for (kind, texture) in textures { - let Some(url) = texture.get("url").and_then(|u| u.as_str()) else { - return empty; - }; - let allowed = valid_uris - .iter() - .any(|u| url.starts_with(&u.replace("{textureId}", ""))); - if !allowed { - return empty; - } let slot = match kind.as_str() { "SKIN" => &mut out.skin, "CAPE" => &mut out.cape, "ELYTRA" => &mut out.elytra, _ => continue, }; - *slot = Some(url.to_owned()); + // One bad entry (no `url`, or a URL outside the texture services' + // domains) drops only that texture, not the whole payload. + let Some(url) = texture.get("url").and_then(|u| u.as_str()) else { + continue; + }; + let allowed = valid_uris + .iter() + .any(|u| url.starts_with(&u.replace("{textureId}", ""))); + if allowed { + *slot = Some(url.to_owned()); + } } out } From 3740de5116dbf9322e39d18c3ce0777d087d0401 Mon Sep 17 00:00:00 2001 From: socksprox Date: Sun, 25 Oct 2026 13:40:07 +0100 Subject: [PATCH 03/26] Launcher: pin the macOS title bar to the chosen appearance The launcher's Appearance setting darkened the page but not the window's native chrome: NSWindow keeps the system appearance, so a launcher set to Dark still drew a light title bar on a light desktop. apply_appearance (titlebar.rs) pins the NSWindow's appearance to the choice at startup and when the setting changes; System clears the pin so the chrome follows the computer again. Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com> --- launcher/Cargo.lock | 2 ++ launcher/Cargo.toml | 4 ++++ launcher/src/main.rs | 4 ++++ launcher/src/titlebar.rs | 49 +++++++++++++++++++++++++++++++++++++++- 4 files changed, 58 insertions(+), 1 deletion(-) diff --git a/launcher/Cargo.lock b/launcher/Cargo.lock index 5155420e0..922a92f2f 100644 --- a/launcher/Cargo.lock +++ b/launcher/Cargo.lock @@ -2680,8 +2680,10 @@ dependencies = [ "horizon-theme", "image", "keyring", + "objc2-app-kit", "oo7", "pulldown-cmark", + "raw-window-handle", "self-replace", "serde", "serde_json", diff --git a/launcher/Cargo.toml b/launcher/Cargo.toml index a402d0e28..570e2bd75 100644 --- a/launcher/Cargo.toml +++ b/launcher/Cargo.toml @@ -48,6 +48,10 @@ oo7 = { version = "0.5", default-features = false, features = ["async-std", "nat futures-lite = "2" [target.'cfg(target_os = "macos")'.dependencies] keyring = { version = "3", features = ["apple-native"] } +# Painting the window's title bar dark or light (titlebar::apply_appearance): crates already in +# the lockfile through gpui and wgpu. +objc2-app-kit = { version = "0.3", default-features = false, features = ["NSAppearance", "NSView", "NSWindow"] } +raw-window-handle = "0.6" [target.'cfg(target_os = "windows")'.dependencies] keyring = { version = "3", features = ["windows-native"] } diff --git a/launcher/src/main.rs b/launcher/src/main.rs index 0bcbc4011..ebde171e5 100644 --- a/launcher/src/main.rs +++ b/launcher/src/main.rs @@ -265,6 +265,9 @@ impl Launcher { { settings.selected = installed.first().cloned(); } + // Pin the window's chrome (macOS title bar) to the choice before the theme reads + // `window.appearance()`, so both draw the same look. + titlebar::apply_appearance(window, settings.appearance); let mut this = Self { theme: Theme::for_appearance(settings.appearance, window.appearance()), page: Page::from_env(), @@ -2482,6 +2485,7 @@ impl Launcher { let _ = this.update(cx, |this, cx| { this.settings.appearance = choice; this.settings.save(); + titlebar::apply_appearance(window, choice); this.theme = Theme::for_appearance(choice, window.appearance()); cx.notify(); }); diff --git a/launcher/src/titlebar.rs b/launcher/src/titlebar.rs index 3c2a78ea4..2e6445091 100644 --- a/launcher/src/titlebar.rs +++ b/launcher/src/titlebar.rs @@ -1,6 +1,8 @@ -//! Custom Windows chrome. Other platforms keep their native window decorations. +//! Custom Windows chrome. Other platforms keep their native window decorations; on macOS, +//! `apply_appearance` repaints that chrome (the title bar) to match the chosen look. use crate::theme::Theme; use gpui::{Div, TitlebarOptions, Window}; +use horizon_launcher::backend::Appearance; /// Whether the launcher draws its own title bar (`render`) rather than the system. pub const DRAWN: bool = cfg!(target_os = "windows"); @@ -18,6 +20,51 @@ pub fn render(_theme: &Theme, _window: &Window) -> Option
{ None } +/// macOS keeps the window's appearance on the system setting, so a launcher set to Dark still +/// draws a light title bar on a light desktop. Pin the NSWindow's appearance to the choice +/// instead (`System` clears the pin, handing the chrome back to the system), honouring the same +/// `HORIZON_LAUNCHER_APPEARANCE` override the theme does. Other platforms' chrome already +/// follows the setting (ours is drawn, Windows and Linux follow the system either way). +#[cfg(target_os = "macos")] +pub fn apply_appearance(window: &Window, choice: Appearance) { + use objc2_app_kit::{ + NSAppearance, NSAppearanceCustomization, NSAppearanceName, NSAppearanceNameAqua, + NSAppearanceNameDarkAqua, NSView, + }; + use raw_window_handle::{HasWindowHandle, RawWindowHandle}; + + // Reading AppKit's name constants is unsafe to rustc only (`use of extern static`). + let name: Option<&'static NSAppearanceName> = unsafe { + match std::env::var("HORIZON_LAUNCHER_APPEARANCE").as_deref() { + Ok("light") => Some(NSAppearanceNameAqua), + Ok("dark") => Some(NSAppearanceNameDarkAqua), + _ => match choice { + Appearance::Dark => Some(NSAppearanceNameDarkAqua), + Appearance::Light => Some(NSAppearanceNameAqua), + Appearance::System => None, + }, + } + }; + // The trait, not `Window::window_handle` (which is gpui's own `AnyWindowHandle`). + let Ok(handle) = HasWindowHandle::window_handle(window) else { + return; + }; + let RawWindowHandle::AppKit(appkit) = handle.as_raw() else { + return; + }; + // The handle is the window's content view; its `window` is the NSWindow itself. Both outlive + // this call. + let view = unsafe { appkit.ns_view.cast::().as_ref() }; + let Some(native) = view.window() else { + return; + }; + let appearance = name.and_then(NSAppearance::appearanceNamed); + native.setAppearance(appearance.as_deref()); +} + +#[cfg(not(target_os = "macos"))] +pub fn apply_appearance(_: &Window, _: Appearance) {} + #[cfg(target_os = "windows")] mod windows { use super::*; From 87b3c9aa38e5568733a2678d0332ad33e0e792e3 Mon Sep 17 00:00:00 2001 From: socksprox Date: Sun, 25 Oct 2026 13:51:12 +0100 Subject: [PATCH 04/26] Drop the stale craft grid when a remote menu closes The server's AbstractContainerMenu.removed gives the grid and the carried stack back to the inventory and syncs those slots, but the client kept its copies: a crafting table closed with items inside left ghost stacks in the inventory's 2x2 grid that could not be picked up. Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com> --- crates/horizon-client/src/game/remote.rs | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/crates/horizon-client/src/game/remote.rs b/crates/horizon-client/src/game/remote.rs index 5a71b13a8..d8148f77f 100644 --- a/crates/horizon-client/src/game/remote.rs +++ b/crates/horizon-client/src/game/remote.rs @@ -4783,6 +4783,11 @@ impl Game<'_> { self.mount_menu_reset(); // The client's menu has no level access: what it holds is the server's. self.station = None; + // AbstractContainerMenu.removed: the server gives the grid and the + // carried stack back to the inventory and syncs it; the copies here + // are stale the moment the window closes. + self.craft_grid.fill(None); + self.carried = None; self.craft_size = 2; if let Some(key) = self.container.take() { // Server containers stay renderable but lose their copied slots. From fb1142cd71dba47247f5f897c8ff487362431413 Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Sun, 25 Oct 2026 14:31:41 +0100 Subject: [PATCH 05/26] Skins: keep vanilla's whole-payload rejection, drop the dead name fallback authlib 10.0.77 MinecraftServicesSessionService.unpackTextures returns MinecraftProfileTextures.EMPTY when any texture has no URL or a URL outside the allowed domains, so skins::unpack goes back to main's behaviour. remote_player_names: r.players and r.tab_players are filled from the same ADD_PLAYER entries and emptied by the same PlayerInfoRemove, so the tab-list fallback could never apply. Co-Authored-By: Claude Opus 5.5 --- crates/horizon-client/src/game/remote.rs | 9 +-------- crates/horizon-client/src/hud.rs | 5 +++-- crates/horizon-client/src/skins.rs | 21 ++++++++++----------- 3 files changed, 14 insertions(+), 21 deletions(-) diff --git a/crates/horizon-client/src/game/remote.rs b/crates/horizon-client/src/game/remote.rs index 36122d42a..74850110b 100644 --- a/crates/horizon-client/src/game/remote.rs +++ b/crates/horizon-client/src/game/remote.rs @@ -5068,14 +5068,7 @@ impl Game<'_> { r.level_players .iter() .filter(|(_, uuid)| **uuid != r.profile) - .filter_map(|(id, uuid)| { - let name = r - .players - .get(uuid) - .cloned() - .or_else(|| r.tab_players.get(uuid).map(|t| t.name.clone()))?; - Some((*id as u32, name)) - }) + .filter_map(|(id, uuid)| Some((*id as u32, r.players.get(uuid)?.clone()))) .collect() } /// `ClientClockManager.tick`: the clock moves on by the game time that diff --git a/crates/horizon-client/src/hud.rs b/crates/horizon-client/src/hud.rs index 90a8b346c..617126c2e 100644 --- a/crates/horizon-client/src/hud.rs +++ b/crates/horizon-client/src/hud.rs @@ -78,8 +78,9 @@ pub const MAP_SLOTS: usize = 256; /// The atlas slot the minimap extra draws into. pub const MINIMAP_SPRITE: &str = "horizon/minimap"; /// Atlas slots for downloaded player skins (`skins/`), 64x64 each. -/// Vanilla registers a texture per skin; too few slots evict a busy -/// server's players back to their default skins. +/// Vanilla registers a texture per skin. Here a skin evicted from its slot +/// is not stored again, and its player falls back to the default skin, so +/// the slots must cover a busy server's player list. pub const SKIN_SLOTS: usize = 128; /// Reused by the visible rows of the classic world selector. pub const WORLD_ICON_SLOTS: usize = 32; diff --git a/crates/horizon-client/src/skins.rs b/crates/horizon-client/src/skins.rs index 0cf9cc8a2..9014032c4 100644 --- a/crates/horizon-client/src/skins.rs +++ b/crates/horizon-client/src/skins.rs @@ -92,23 +92,22 @@ pub fn unpack(value: &str, signature: Signature, valid_uris: &[&str]) -> Texture ..empty.clone() }; for (kind, texture) in textures { + let Some(url) = texture.get("url").and_then(|u| u.as_str()) else { + return empty; + }; + let allowed = valid_uris + .iter() + .any(|u| url.starts_with(&u.replace("{textureId}", ""))); + if !allowed { + return empty; + } let slot = match kind.as_str() { "SKIN" => &mut out.skin, "CAPE" => &mut out.cape, "ELYTRA" => &mut out.elytra, _ => continue, }; - // One bad entry (no `url`, or a URL outside the texture services' - // domains) drops only that texture, not the whole payload. - let Some(url) = texture.get("url").and_then(|u| u.as_str()) else { - continue; - }; - let allowed = valid_uris - .iter() - .any(|u| url.starts_with(&u.replace("{textureId}", ""))); - if allowed { - *slot = Some(url.to_owned()); - } + *slot = Some(url.to_owned()); } out } From 56560b467a8fad3ffe02457691bd8486a1a77cb6 Mon Sep 17 00:00:00 2001 From: socksprox Date: Sun, 25 Oct 2026 00:19:47 +0200 Subject: [PATCH 06/26] Multiplayer: answer cookie requests, store cookies, follow transfer packets MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ClientboundCookieRequestPacket in play state decoded as Unknown and was dropped; StoreCookie and Transfer likewise, and the configuration-phase CookieRequest was always answered empty. Proxies (BungeeCord, Velocity) store and read cookies around a server switch and send Transfer to move a player to another address — both ended in a kick. Play-state cookie_request/store_cookie/transfer now have packet types, cookie requests answer from the stored cookies in both configuration and play (ClientCommonPacketListenerImpl.handleRequestCookie), stored cookies land in the session's map (handleStoreCookie), and a transfer reconnects the game to the target address carrying them (handleTransfer → ConnectScreen.startConnecting with TransferState). Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com> --- crates/horizon-client/src/game.rs | 10 +- crates/horizon-client/src/game/remote.rs | 51 +++++++++- .../horizon-client/src/game/startup_menu.rs | 4 +- crates/horizon-client/src/net.rs | 94 +++++++++++++++++-- crates/horizon-protocol/src/packets/play.rs | 9 +- 5 files changed, 153 insertions(+), 15 deletions(-) diff --git a/crates/horizon-client/src/game.rs b/crates/horizon-client/src/game.rs index 699468651..7fcb3be89 100644 --- a/crates/horizon-client/src/game.rs +++ b/crates/horizon-client/src/game.rs @@ -12098,6 +12098,8 @@ enum PendingWorldEntry { Server { address: String, name: String, + /// A transfer's carried-over server cookies (`TransferState`). + cookies: Option, }, } @@ -12172,8 +12174,12 @@ impl Game<'_> { }) => { self.open_world(&folder, name.as_deref(), seed, creative, create.as_deref())?; } - Some(PendingWorldEntry::Server { address, name }) => { - self.connect_server(&address, &name)?; + Some(PendingWorldEntry::Server { + address, + name, + cookies, + }) => { + self.connect_server_with_cookies(&address, &name, cookies)?; } None => {} } diff --git a/crates/horizon-client/src/game/remote.rs b/crates/horizon-client/src/game/remote.rs index 044e43835..c10b64c54 100644 --- a/crates/horizon-client/src/game/remote.rs +++ b/crates/horizon-client/src/game/remote.rs @@ -193,6 +193,9 @@ pub(super) struct Remote { /// the oldest of them first waited (`poll_remote`). backlog: VecDeque, backlog_since: Option, + /// `ClientboundTransferPacket`'s target: when the connection ends the + /// game connects here, the stored cookies carried over (`TransferState`). + transfer: Option, } /// The time a frame spends on chunk packets before it leaves the rest of @@ -257,14 +260,25 @@ fn number_format(f: &play::NumberFormat) -> horizon_client::scoreboard::NumberFo impl Game<'_> { /// Leave the title for a server (ConnectScreen): an empty world fed by the connection. pub(super) fn connect_server(&mut self, address: &str, name: &str) -> Result<()> { + self.connect_server_with_cookies(address, name, None) + } + /// `connect_server` carrying a transfer's stored server cookies + /// (`TransferState`); None on an ordinary join. + pub(super) fn connect_server_with_cookies( + &mut self, + address: &str, + name: &str, + cookies: Option, + ) -> Result<()> { if self.defer_world_entry(super::PendingWorldEntry::Server { address: address.to_owned(), name: name.to_owned(), + cookies: cookies.clone(), })? { return Ok(()); } self.join_world_rest()?; - if let Err(error) = self.join_server(address, name, None) { + if let Err(error) = self.join_server(address, name, None, cookies) { log::warn!("Horizon: could not join server: {error}"); if self.title.is_none() { self.title = Some(horizon_client::title::Title::new( @@ -285,13 +299,14 @@ impl Game<'_> { pipe: horizon_protocol::connection::Pipe, name: &str, ) -> Result<()> { - self.join_server("local", name, Some(pipe)) + self.join_server("local", name, Some(pipe), None) } fn join_server( &mut self, address: &str, name: &str, local: Option, + cookies: Option, ) -> Result<()> { self.perf.world_opening(); let root = self.options.resources.clone(); @@ -323,7 +338,17 @@ impl Game<'_> { Some(pipe) => Session::connect_local(pipe, name, view, lang.clone()), None => { self.extras_connecting(address, name); - Session::connect(address, name, auth.clone(), view, lang.clone()) + match cookies { + Some(cookies) => Session::connect_transferred( + address, + name, + auth.clone(), + view, + lang.clone(), + cookies, + ), + None => Session::connect(address, name, auth.clone(), view, lang.clone()), + } } }; let player_type = super::perspective::player_type(&root); @@ -446,6 +471,7 @@ impl Game<'_> { chunk_center: (0, 0), backlog: VecDeque::new(), backlog_since: None, + transfer: None, }); // The level's TickRateManager follows the server's ticking packets. self.clock = horizon_client::clock::FixedStep::client(); @@ -867,6 +893,11 @@ impl Game<'_> { } } Event::Reconfigured(registries) => self.set_registries(registries), + Event::Transfer { host, port } => { + if let Some(r) = self.remote.as_mut() { + r.transfer = Some(format!("{host}:{port}")); + } + } Event::PackPush(p) => self.handle_pack_push(p), Event::PackPop(id) => self.handle_pack_pop(id), Event::DecodeError(e) => { @@ -882,6 +913,20 @@ impl Game<'_> { from_server, } => { log::info!("Horizon: disconnected: {reason}"); + // ClientboundTransferPacket left a target: connect there + // instead of showing the disconnect, the stored cookies + // carried over (ClientCommonPacketListenerImpl. + // handleTransfer → ConnectScreen.startConnecting). + let transfer = self.remote.as_mut().and_then(|r| { + r.transfer.take().map(|address| { + (address, r.session.name.clone(), r.session.cookies.clone()) + }) + }); + if let Some((address, name, cookies)) = transfer { + self.leave_server(None)?; + self.connect_server_with_cookies(&address, &name, Some(cookies))?; + return Ok(()); + } let retry = self.reconnect_after(&reason, from_server); self.leave_server(Some(reason))?; self.offer_reconnect(retry); diff --git a/crates/horizon-client/src/game/startup_menu.rs b/crates/horizon-client/src/game/startup_menu.rs index 96af99bbc..fe568fe71 100644 --- a/crates/horizon-client/src/game/startup_menu.rs +++ b/crates/horizon-client/src/game/startup_menu.rs @@ -33,6 +33,7 @@ impl StartupMenu { Some(PendingWorldEntry::Server { address: address.clone(), name: options.player_name(), + cookies: None, }) } else { options @@ -125,6 +126,7 @@ impl StartupMenu { Action::Connect { address } => PendingWorldEntry::Server { address, name: player_name, + cookies: None, }, _ => return, }; @@ -762,7 +764,7 @@ mod tests { "Guest".into(), ); assert!( - matches!(menu.pending.take(), Some(PendingWorldEntry::Server { address, name }) + matches!(menu.pending.take(), Some(PendingWorldEntry::Server { address, name, .. }) if address == "localhost:25565" && name == "Guest") ); assert!(menu.pending.take().is_none(), "an entry is consumed once"); diff --git a/crates/horizon-client/src/net.rs b/crates/horizon-client/src/net.rs index 9cce9e1c6..c4e53cef4 100644 --- a/crates/horizon-client/src/net.rs +++ b/crates/horizon-client/src/net.rs @@ -18,6 +18,7 @@ use horizon_protocol::{ text::{Language, plain, translatable}, }; use std::{ + collections::HashMap, sync::{ Arc, Mutex, atomic::{AtomicBool, Ordering}, @@ -27,6 +28,12 @@ use std::{ time::Duration, }; +/// `CommonListenerCookie.serverCookies`: cookies the server asked the client +/// to store (`ClientboundStoreCookiePacket`), answered to +/// `ClientboundCookieRequestPacket`. A `transfer` carries them to the next +/// connection (`TransferState`), so a proxy's backend switch keeps them. +pub type Cookies = Arc>>>; + /// What the network thread reports to the game. pub enum Event { /// Progress text for the connecting screen. @@ -48,6 +55,13 @@ pub enum Event { PackPush(cfg::ResourcePackPush), /// ClientboundResourcePackPopPacket: one pack, or every pack. PackPop(Option), + /// `ClientboundTransferPacket`: the server sent us to another address. + /// The connection ends right after; the game reconnects there with the + /// stored cookies. + Transfer { + host: String, + port: i32, + }, /// The connection ended. `from_server`: the server gave the reason (or /// the connection was refused for good), rather than the connection /// failing (auto-reconnect retries only failures and shutdowns). @@ -67,6 +81,8 @@ pub struct Session { pub address: String, pub name: String, pub counters: Arc>>>, + /// The cookies this server stored on us (`ClientboundStoreCookiePacket`). + pub cookies: Cookies, /// HORIZON_NET_DEBUG=1 logs every packet sent from the game thread. debug: bool, } @@ -79,7 +95,27 @@ impl Session { view_distance: i8, lang: Arc, ) -> Self { - Self::start(address, name, auth, view_distance, lang, None) + Self::start(address, name, auth, view_distance, lang, None, None) + } + /// `ConnectScreen.startConnecting` for a `transfer`: the cookies the + /// server stored carry to the new connection (`TransferState`). + pub fn connect_transferred( + address: &str, + name: &str, + auth: Option>, + view_distance: i8, + lang: Arc, + cookies: Cookies, + ) -> Self { + Self::start( + address, + name, + auth, + view_distance, + lang, + None, + Some(cookies), + ) } /// Join an integrated server through memory (`Connection.connectToLocalServer`). pub fn connect_local( @@ -88,7 +124,7 @@ impl Session { view_distance: i8, lang: Arc, ) -> Self { - Self::start("local", name, None, view_distance, lang, Some(pipe)) + Self::start("local", name, None, view_distance, lang, Some(pipe), None) } fn start( address: &str, @@ -97,12 +133,15 @@ impl Session { view_distance: i8, lang: Arc, local: Option, + cookies: Option, ) -> Self { let (send, events) = channel(); let writer = Arc::new(Mutex::new(None)); let configuring = Arc::new(AtomicBool::new(true)); let counters = Arc::new(Mutex::new(None)); - let (thread_writer, thread_counters) = (writer.clone(), counters.clone()); + let cookies = cookies.unwrap_or_default(); + let (thread_writer, thread_counters, thread_cookies) = + (writer.clone(), counters.clone(), cookies.clone()); let thread_configuring = configuring.clone(); let (address_owned, name_owned) = (address.to_owned(), name.to_owned()); let thread = std::thread::Builder::new() @@ -119,6 +158,7 @@ impl Session { &thread_writer, &thread_configuring, &thread_counters, + &thread_cookies, ); let from_server = result.is_ok(); let reason = result.unwrap_or_else(|e| e); @@ -140,6 +180,7 @@ impl Session { address: address.to_owned(), name: name.to_owned(), counters, + cookies, debug, } } @@ -291,6 +332,7 @@ fn run( shared_writer: &Mutex>, configuring: &AtomicBool, shared_counters: &Mutex>>, + cookies: &Cookies, ) -> Result { let (host, port, mut c) = if let Some(pipe) = local { (address.to_owned(), 0, Connection::local(pipe)) @@ -419,13 +461,13 @@ fn run( .map_err(e)?; let (mut reader, writer) = c.split(); *shared_writer.lock().unwrap() = Some(writer); - let registries = configure(&mut reader, shared_writer, configuring, lang, send)?; + let registries = configure(&mut reader, shared_writer, configuring, lang, send, cookies)?; let _ = send.send(Event::Joined { registries: Arc::new(registries), uuid: profile.uuid, name: profile.name, }); - receive_play(&mut reader, shared_writer, configuring, lang, send) + receive_play(&mut reader, shared_writer, configuring, lang, send, cookies) } fn receive_play( @@ -434,6 +476,7 @@ fn receive_play( configuring: &AtomicBool, lang: &Language, send: &Sender, + cookies: &Cookies, ) -> Result { loop { let (id, payload) = reader.recv().map_err(|e| e.to_string())?; @@ -469,9 +512,31 @@ fn receive_play( let _ = w.send(&play::Serverbound::ConfigurationAcknowledged(Empty).encode()); configuring.store(true, Ordering::Relaxed); } - let registries = configure(reader, shared_writer, configuring, lang, send)?; + let registries = + configure(reader, shared_writer, configuring, lang, send, cookies)?; let _ = send.send(Event::Reconfigured(Arc::new(registries))); } + // ClientCommonPacketListenerImpl.handleRequestCookie: the stored + // cookie (or none) goes straight back. + play::Clientbound::CookieRequest(q) => { + let payload = cookies.lock().unwrap().get(&q.key).cloned(); + reply(play::Serverbound::CookieResponse(cfg::CookieResponse { + key: q.key, + payload, + })); + } + play::Clientbound::StoreCookie(p) => { + cookies.lock().unwrap().insert(p.key, p.payload); + } + // ClientCommonPacketListenerImpl.handleTransfer: the connection + // ends and the game connects to the other address. + play::Clientbound::Transfer(p) => { + let _ = send.send(Event::Transfer { + host: p.host, + port: p.port, + }); + return Ok(tr(lang, "disconnect.transfer")); + } play::Clientbound::Disconnect(d) => return Ok(plain(&d.reason, lang)), play::Clientbound::CustomPayload(p) if p.channel == "minecraft:brand" => { receive_brand(&p, send); @@ -493,6 +558,7 @@ fn configure( configuring: &AtomicBool, lang: &Language, send: &Sender, + cookies: &Cookies, ) -> Result { let mut registries = Dynamic::default(); let reply = |p: cfg::Serverbound| -> Result<(), String> { @@ -525,11 +591,22 @@ fn configure( let _ = send.send(Event::PackPop(p.id)); } cfg::Clientbound::CookieRequest(q) => { + let payload = cookies.lock().unwrap().get(&q.key).cloned(); reply(cfg::Serverbound::CookieResponse(cfg::CookieResponse { key: q.key, - payload: None, + payload, }))? } + cfg::Clientbound::StoreCookie(p) => { + cookies.lock().unwrap().insert(p.key, p.payload); + } + cfg::Clientbound::Transfer(p) => { + let _ = send.send(Event::Transfer { + host: p.host, + port: p.port, + }); + return Err(tr(lang, "disconnect.transfer")); + } cfg::Clientbound::Disconnect(d) => return Err(plain(&d.reason, lang)), cfg::Clientbound::FinishConfiguration(_) => { let mut w = writer.lock().unwrap(); @@ -659,6 +736,7 @@ mod tests { &AtomicBool::new(false), &Language::new(), &send, + &Cookies::default(), ) }); let mut server = Connection::local(server); @@ -708,6 +786,7 @@ mod tests { address: "local".into(), name: "Player".into(), counters: Arc::new(Mutex::new(None)), + cookies: Cookies::default(), debug: false, }; let (thread_writer, thread_configuring) = @@ -719,6 +798,7 @@ mod tests { &thread_configuring, &Language::new(), &send, + &Cookies::default(), ) }); let mut server = Connection::local(server); diff --git a/crates/horizon-protocol/src/packets/play.rs b/crates/horizon-protocol/src/packets/play.rs index 26bb96316..67373cf4b 100644 --- a/crates/horizon-protocol/src/packets/play.rs +++ b/crates/horizon-protocol/src/packets/play.rs @@ -13,8 +13,9 @@ use crate::{ packets::{ Empty, configuration::{ - ClientInformation, CustomPayload, Disconnect, KeepAlive, Ping, ResourcePackPop, - ResourcePackPush, ResourcePackResponse, UpdateTags, + ClientInformation, CookieRequest, CookieResponse, CustomPayload, Disconnect, KeepAlive, + Ping, ResourcePackPop, ResourcePackPush, ResourcePackResponse, StoreCookie, Transfer, + UpdateTags, }, login::Property, }, @@ -1759,6 +1760,7 @@ packet_enum!(Clientbound, crate::ids::play::clientbound { ContainerSetContent(ContainerSetContent) = CONTAINER_SET_CONTENT, ContainerSetData(ContainerSetData) = CONTAINER_SET_DATA, ContainerSetSlot(ContainerSetSlot) = CONTAINER_SET_SLOT, + CookieRequest(CookieRequest) = COOKIE_REQUEST, CustomPayload(CustomPayload) = CUSTOM_PAYLOAD, Disconnect(Disconnect) = DISCONNECT, DisguisedChat(DisguisedChat) = DISGUISED_CHAT, @@ -1836,6 +1838,7 @@ packet_enum!(Clientbound, crate::ids::play::clientbound { SoundEntity(SoundEntity) = SOUND_ENTITY, StopSound(StopSound) = STOP_SOUND, StartConfiguration(Empty) = START_CONFIGURATION, + StoreCookie(StoreCookie) = STORE_COOKIE, SwingAnimation(SwingAnimation) = SWING_ANIMATION, SystemChat(SystemChat) = SYSTEM_CHAT, TabList(TabList) = TAB_LIST, @@ -1843,6 +1846,7 @@ packet_enum!(Clientbound, crate::ids::play::clientbound { TeleportEntity(TeleportEntity) = TELEPORT_ENTITY, TickingState(TickingState) = TICKING_STATE, TickingStep(TickingStep) = TICKING_STEP, + Transfer(Transfer) = TRANSFER, UpdateAdvancements(UpdateAdvancements) = UPDATE_ADVANCEMENTS, UpdateAttributes(UpdateAttributes) = UPDATE_ATTRIBUTES, LevelParticles(LevelParticles) = LEVEL_PARTICLES, @@ -2223,6 +2227,7 @@ packet_enum!(Serverbound, crate::ids::play::serverbound { ContainerButtonClick(ContainerButtonClick) = CONTAINER_BUTTON_CLICK, ContainerClick(ContainerClick) = CONTAINER_CLICK, ContainerClose(ContainerClose) = CONTAINER_CLOSE, + CookieResponse(CookieResponse) = COOKIE_RESPONSE, CustomPayload(CustomPayload) = CUSTOM_PAYLOAD, EditBook(EditBook) = EDIT_BOOK, Interact(Interact) = INTERACT, From 22c3f2bd0f63d88f27e4badd82f8e613c36e9804 Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Sun, 25 Oct 2026 15:13:51 +0100 Subject: [PATCH 07/26] Roadmap: roadmap/roadmap.toml, ROADMAP.md generated from it, and its checks One source of truth for what is being done, what comes next and where to help: roadmap/roadmap.toml, each item said twice (plain words for players, the technical picture for contributors), Now / Next / Later / Help wanted / Shipped, no dates. tools/roadmap.py builds ROADMAP.md from it, checks its rules offline (CI, through tests/test_roadmap.py) and against GitHub (links resolve, no stale Now item), ships items whose pull requests all went out in a release (sync), and keeps a roadmap: label per item (labels). README links it; roadmap/README.md is the maintenance guide. Co-Authored-By: Claude Opus 5.5 --- README.md | 5 + ROADMAP.md | 341 ++++++++++++++++++++++++++ roadmap/README.md | 56 +++++ roadmap/roadmap.toml | 477 ++++++++++++++++++++++++++++++++++++ tests/test_roadmap.py | 207 ++++++++++++++++ tools/pr_ready.py | 6 +- tools/roadmap.py | 551 ++++++++++++++++++++++++++++++++++++++++++ 7 files changed, 1641 insertions(+), 2 deletions(-) create mode 100644 ROADMAP.md create mode 100644 roadmap/README.md create mode 100644 roadmap/roadmap.toml create mode 100644 tests/test_roadmap.py create mode 100644 tools/roadmap.py diff --git a/README.md b/README.md index 6dd192d5d..ceee29249 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,7 @@ Download · Documentation · Release notes · + Roadmap · Project status · Contributing

@@ -109,6 +110,10 @@ Everything prepared lands in the gitignored `.local/`. It is derived from the ga The client starts on the title screen. Command-line options (`--world`, `--seed`, `--creative`, `--render-distance`, `--dedicated`), controls, scripting through `horizon-ctl` and the architecture are described in [the native client guide](docs/native-client.md). The rest of the developer documentation is indexed in [docs/README.md](docs/README.md), including [the parity workflow](docs/parity-workflow.md). +## Roadmap + +What is being done now, what comes next and where you can help, in plain words and in technical detail: [ROADMAP.md](ROADMAP.md). [playhorizon.dev/hub](https://playhorizon.dev/hub) shows it with the work board, the journal of what shipped and how to help. + ## Contributing Issues and pull requests are welcome: see [CONTRIBUTING.md](CONTRIBUTING.md) for how we work (vanilla first, small pull requests, labels), or [the contributing guide](https://playhorizon.dev/docs/contributing) on the site. Questions and ideas: [Discord](https://discord.gg/HcTeMZxe5E). Before opening a pull request, run the self-check and paste the block it prints: diff --git a/ROADMAP.md b/ROADMAP.md new file mode 100644 index 000000000..b433fad3a --- /dev/null +++ b/ROADMAP.md @@ -0,0 +1,341 @@ +# Horizon roadmap + + + +What is being done on Horizon, what comes next and where you can help. There are no dates: things are Now, Next or Later. Each item is said in plain words, with the technical picture folded under it. The same roadmap, with a Simple / Technical switch, the board, the journal and how to help, is on [playhorizon.dev/hub](https://playhorizon.dev/hub). Pull requests carry the `roadmap:` label of their item. + +## At a glance + +Horizon is Minecraft: Java Edition 26.3 rewritten from scratch in Rust, so it runs faster on the same computer. Single player, LAN, servers, resource packs and Horizon's own mods work today, on your own copy of the game. + +**Being done now** + +- **Steady frames at long render distances**: Making Horizon faster than vanilla on every computer, with smooth camera movement even at 32 chunks, by spreading the work better over the processor's cores. +- **Modpacks' world generation, natively**: Making the world-generation mods of popular modpacks (new structures, YUNG's dungeons and mineshafts, packs built on Lithostitched) generate their worlds in Horizon, natively and fast. +- **Playing on servers: everything shows as it should**: When you play on a server, other players, mobs, items and menus look and behave as in vanilla: skins, poses, item names, inventories and server networks. +- **Single player as a server: the last differences**: Single player now runs a small server in the background, as vanilla does. We are fixing what still behaves differently there; every fix also works for LAN and server players. +- **Horizon's mod registry**: One place for mods, modpacks and resource packs made for Horizon: browse them on the website and install them from the launcher in one click. + +**Next**: Microsoft sign-in (coming soon); CurseForge in the mod browser (coming soon); Fresh benchmarks against vanilla; Pistons push players and mobs; Horizon on Intel Macs. + +**How to help**: Play it and tell us what differs from vanilla (Discord or GitHub), run the benchmark on your computer, vote for what you want next, or pick one of the Help wanted items. + +**Developers**: Read CONTRIBUTING.md, pick a Help wanted item or a To do card, check vanilla's code for the behaviour, and paste the block `python3 tools/pr_ready.py` prints in your pull request. + +## Now + +### Performance + +#### Steady frames at long render distances + +Making Horizon faster than vanilla on every computer, with smooth camera movement even at 32 chunks, by spreading the work better over the processor's cores. + +
Technical + +Frame pacing at render distance 32 ([#678](https://github.com/ludovic111/horizon/issues/678)): long frames come from work competing with the render thread. In review: world generation workers build free structure starts instead of queueing them ([#1760](https://github.com/ludovic111/horizon/issues/1760)), the worker pool leaves one core as vanilla does ([#1778](https://github.com/ludovic111/horizon/issues/1778)), and the terrain vertex arena is read as storage where flat draws run ([#1742](https://github.com/ludovic111/horizon/issues/1742)). Still open: far terrain at 48 to 64 chunks ([#718](https://github.com/ludovic111/horizon/issues/718)) and CPU-bound fields of block entities ([#717](https://github.com/ludovic111/horizon/issues/717)). Every change shows before and after numbers from `tools/perf_bench.py` against vanilla 26.3 ([docs/benchmark.md](docs/benchmark.md)). + +
+ +#### Faster block lookups + +Speeding up the code that reads and writes the blocks of the world, which almost everything in the game goes through: generation, lighting, meshing and ticking. + +
Technical + +`PalettedContainer` and `PackedStorage` find an entry's word by multiply and shift instead of an integer division ([#1790](https://github.com/ludovic111/horizon/issues/1790), [#1794](https://github.com/ludovic111/horizon/issues/1794)); meshing looks up baked models by index, not by name ([#1747](https://github.com/ludovic111/horizon/issues/1747)). Each change keeps the paletted storage harnesses identical and shows its microbenchmark ([docs/performance/paletted-container-access-results.md](docs/performance/paletted-container-access-results.md)). + +
+ +### Modpacks + +#### Modpacks' world generation, natively + +Making the world-generation mods of popular modpacks (new structures, YUNG's dungeons and mineshafts, packs built on Lithostitched) generate their worlds in Horizon, natively and fast. + +
Technical + +`horizon-port-pack` carries a pack's data-driven content over; structure mods that need code get a native port: YUNG's worldgen as written ([#1746](https://github.com/ludovic111/horizon/issues/1746)), Lithostitched's limited and guaranteed elements with pool and processor modifiers ([#1777](https://github.com/ludovic111/horizon/issues/1777)), its processors as the game's own types ([#1765](https://github.com/ludovic111/horizon/issues/1765)). Proved by the structure blocks and layout harnesses ([#1753](https://github.com/ludovic111/horizon/issues/1753), [#1757](https://github.com/ludovic111/horizon/issues/1757)). Mods whose Java code does more than world generation don't run ([docs/modpacks.md](docs/modpacks.md)). + +
+ +### Servers and multiplayer + +#### Playing on servers: everything shows as it should + +When you play on a server, other players, mobs, items and menus look and behave as in vanilla: skins, poses, item names, inventories and server networks. + +
Technical + +Client-of-a-server fixes in `game/remote*.rs` and `horizon-protocol`: mobs' aggressive and item-use flags ([#1802](https://github.com/ludovic111/horizon/issues/1802), [#1798](https://github.com/ludovic111/horizon/issues/1798)), ghost items after a remote menu ([#1795](https://github.com/ludovic111/horizon/issues/1795)), skins ([#1652](https://github.com/ludovic111/horizon/issues/1652)), cookies and transfer packets for proxy networks ([#1650](https://github.com/ludovic111/horizon/issues/1650)), firework boosts ([#1671](https://github.com/ludovic111/horizon/issues/1671)), living-entity attributes and simulation distance ([#1731](https://github.com/ludovic111/horizon/issues/1731)), styled item names ([#1702](https://github.com/ludovic111/horizon/issues/1702)), primed TNT between updates ([#1710](https://github.com/ludovic111/horizon/issues/1710)). + +
+ +#### Server dialogs and login screens + +Servers that show dialogs, such as the register and login screens of AuthMe, will work in Horizon. + +
Technical + +26.3's dialog packets and model ([#1720](https://github.com/ludovic111/horizon/issues/1720)), the dialog screen with its buttons and actions ([#1734](https://github.com/ludovic111/horizon/issues/1734)), then text and boolean inputs ([#1735](https://github.com/ludovic111/horizon/issues/1735)). + +
+ +### Mods and API + +#### Horizon's mod registry + +One place for mods, modpacks and resource packs made for Horizon: browse them on the website and install them from the launcher in one click. + +
Technical + +Merged: the registry index (schema 1, `.hpack`, checks before install, [#1634](https://github.com/ludovic111/horizon/issues/1634)), `cargo horizon-mod check` ([#1642](https://github.com/ludovic111/horizon/issues/1642)) and the submission service (`crates/horizon-mod-registry`, [#1659](https://github.com/ludovic111/horizon/issues/1659)). In review: the website's /mods ([#1596](https://github.com/ludovic111/horizon/issues/1596)) and /mods/submit ([#1635](https://github.com/ludovic111/horizon/issues/1635)), and in the launcher the registry as a source ([#1636](https://github.com/ludovic111/horizon/issues/1636)), install, enable and takedowns ([#1637](https://github.com/ludovic111/horizon/issues/1637)), the Mods page ([#1638](https://github.com/ludovic111/horizon/issues/1638)) and modpacks as their own profiles ([#1640](https://github.com/ludovic111/horizon/issues/1640)). + +More: [docs/mods.md](docs/mods.md) + +
+ +### Gameplay parity + +#### Single player as a server: the last differences + +Single player now runs a small server in the background, as vanilla does. We are fixing what still behaves differently there; every fix also works for LAN and server players. + +
Technical + +Since [#1514](https://github.com/ludovic111/horizon/issues/1514) single player runs on the server thread (`game/integrated.rs`) and the window joins it as a client; `--in-frame` keeps the old path. The open `[server-thread]` issues list the gaps. In review: a tool that changes a block ends the click ([#1797](https://github.com/ludovic111/horizon/issues/1797)), potions keep their potion over the connection ([#1796](https://github.com/ludovic111/horizon/issues/1796)), mobs' aggression and arm swings ([#1802](https://github.com/ludovic111/horizon/issues/1802)). [docs/server-levels.md](docs/server-levels.md). + +
+ +#### Play in your language + +Item names, container titles and server messages follow the language you pick, as in vanilla. Today parts of the game stay in English. + +
Technical + +Translatable components resolved through the selected language for items, containers and server text ([#1806](https://github.com/ludovic111/horizon/issues/1806)), on top of the bundled languages the prepared resources carry ([#1594](https://github.com/ludovic111/horizon/issues/1594)). Left: the client's own screens ([#1672](https://github.com/ludovic111/horizon/issues/1672)) and the main menu with zh_cn ([#1774](https://github.com/ludovic111/horizon/issues/1774)). + +
+ +### Rendering + +#### Shader packs, written again from scratch + +Shader packs were removed and are being rebuilt from scratch. They come back, off by default, once the best-known packs draw properly. + +
Technical + +A clean-room rewrite in `horizon-shaderpack`, from the packs' public format documentation only: reading packs, the preprocessor and `.properties` files are merged ([#1584](https://github.com/ludovic111/horizon/issues/1584), [#1585](https://github.com/ludovic111/horizon/issues/1585), [#1586](https://github.com/ludovic111/horizon/issues/1586)); translating programs to WGSL through naga, buffers, uniforms and the terrain, entity, sky, weather and hand stages are in review ([#1698](https://github.com/ludovic111/horizon/issues/1698) to [#1801](https://github.com/ludovic111/horizon/issues/1801)). + +More: [#1561](https://github.com/ludovic111/horizon/issues/1561) · [#1771](https://github.com/ludovic111/horizon/issues/1771) · [#1786](https://github.com/ludovic111/horizon/issues/1786) + +
+ +### Horizon extras + +#### Discord Rich Presence + +Your Discord profile can show that you are playing Horizon, with a switch to turn it off. + +
Technical + +A Discord IPC client on its own thread ([#1787](https://github.com/ludovic111/horizon/issues/1787)) and the presence with its setting ([#1788](https://github.com/ludovic111/horizon/issues/1788)). Merged: it ships with the next release. + +
+ +### Code and tools + +#### A leaner codebase that builds faster + +Cleaning up Horizon's code: removing what nothing uses and making it quicker to build, so fixes and new features land faster. + +
Technical + +A review of the whole tree: dead code and stubs removed ([#1432](https://github.com/ludovic111/horizon/issues/1432), [#1658](https://github.com/ludovic111/horizon/issues/1658)), one probe binary per crate ([#1453](https://github.com/ludovic111/horizon/issues/1453), [#1454](https://github.com/ludovic111/horizon/issues/1454)), shared harness helpers ([#1448](https://github.com/ludovic111/horizon/issues/1448)), clippy clean on the whole tree ([#1707](https://github.com/ludovic111/horizon/issues/1707)). [docs/architecture.md](docs/architecture.md) maps each feature to its files and harnesses. + +
+ +## Next + +### Performance + +#### Fresh benchmarks against vanilla + +New public numbers comparing Horizon with vanilla on many kinds of computers, measured the same way every time, on the website's Benchmarks page. + +
Technical + +Redo the comparison after the current performance work ([#1073](https://github.com/ludovic111/horizon/issues/1073)); reliability, coverage and presentation ([#1346](https://github.com/ludovic111/horizon/issues/1346)); a scene must count as loaded only once its first chunk arrives ([#1749](https://github.com/ludovic111/horizon/issues/1749)). Players' reports come in through `--benchmark` and `horizon-launcher data benchmark` ([docs/benchmark.md](docs/benchmark.md)). + +
+ +### Modpacks + +#### CurseForge in the mod browser (coming soon) + +Coming soon: search and download CurseForge mods and modpacks from the launcher, as you can with Modrinth today. + +
Technical + +The mod browser lists CurseForge as coming soon ([docs/mod-browser.md](docs/mod-browser.md)): it needs CurseForge API access. Meanwhile packs import from a CurseForge zip or instance folder, and jars only CurseForge hosts come from the player's own instance ([docs/modpacks.md](docs/modpacks.md)). + +
+ +### Gameplay parity + +#### Pistons push players and mobs + +Pistons and slime blocks will push players, mobs and items as in vanilla. Today moving blocks pass through them. + +
Technical + +Port `PistonMovingBlockEntity.moveCollidedEntities` and `moveStuckEntities` (honey), the slime bounce and `Entity.limitPistonMovement` for `MoverType.PISTON`, in single player and for a server's players. Issues [#1496](https://github.com/ludovic111/horizon/issues/1496), [#1609](https://github.com/ludovic111/horizon/issues/1609), [#1608](https://github.com/ludovic111/horizon/issues/1608), [#1704](https://github.com/ludovic111/horizon/issues/1704), [#1758](https://github.com/ludovic111/horizon/issues/1758). + +
+ +### Launcher + +#### Microsoft sign-in (coming soon) + +Coming soon: sign in with your Microsoft account to play on online-mode servers. The code is ready; it waits for Microsoft's approval. + +
Technical + +Device-code sign-in in the launcher and online-mode login in the client ([docs/microsoft-account.md](docs/microsoft-account.md)). It is turned on by setting the app's client id once Minecraft API access is approved; until then the launcher shows "Coming soon". + +More: [#1270](https://github.com/ludovic111/horizon/issues/1270) + +
+ +#### Horizon on Intel Macs + +Builds of the game and the launcher for Macs with an Intel processor. + +
Technical + +x86_64 game and launcher builds, picked per processor ([#1171](https://github.com/ludovic111/horizon/issues/1171)). Before it ships it needs a run on a real Intel Mac: Rosetta on Apple Silicon only proves the CPU code. Requests: [#1161](https://github.com/ludovic111/horizon/issues/1161), [#1792](https://github.com/ludovic111/horizon/issues/1792). + +
+ +## Later + +### Gameplay parity + +#### Following new Minecraft versions + +When Mojang releases a new version of the game, Horizon follows it, and every system is checked against the new version again. + +
Technical + +The port pipeline detects a release, diffs its classes against 26.3 and writes a port report ([docs/version-ports.md](docs/version-ports.md)); the harnesses then run against the new version. + +
+ +### Horizon extras + +#### An optional AI teammate + +An AI teammate that plays beside you and that you can talk to. It is off unless you turn it on, and the No AI switch hides it completely. + +
Technical + +Draft pull requests: the companion ([#1068](https://github.com/ludovic111/horizon/issues/1068)), its safety modes and their evaluation ([#1069](https://github.com/ludovic111/horizon/issues/1069)), and a route that finishes the game ([#1070](https://github.com/ludovic111/horizon/issues/1070)). Local models first; it ships only once the safety evaluation passes. + +
+ +## Help wanted + +### Performance + +#### Benchmark your computer + +Run Horizon's built-in benchmark and share the report: every new computer makes the performance work more accurate. No coding needed. + +
Technical + +`horizon-launcher play --arg=--benchmark --arg=standard` writes a JSON report; `horizon-launcher data benchmark ` shows what would be sent and uploads it ([website/docs/performance.md](website/docs/performance.md)). Results from three installs with the same hardware appear on the Benchmarks page. Example: [#1711](https://github.com/ludovic111/horizon/issues/1711). + +
+ +### Gameplay parity + +#### End city banners keep their pattern + +Banners in End cities show as plain magenta instead of with their pattern. + +
Technical + +Compare the banner block entities the End city templates place with vanilla's (`EndCityPieces`, the templates' block entity NBT, `BannerBlockEntity`'s patterns), in `crates/horizon-world/src/worldgen/structure/`. Issue [#1438](https://github.com/ludovic111/horizon/issues/1438); possibly related: [#526](https://github.com/ludovic111/horizon/issues/526). + +
+ +#### Enchanted loot in End cities + +Armour and tools in End city chests should come enchanted, as in vanilla. + +
Technical + +`loot.rs` implements `enchant_with_levels`: find why the End city chest table's rolls come out bare, and compare them with vanilla's for a few seeds. Issues [#1437](https://github.com/ludovic111/horizon/issues/1437), [#1660](https://github.com/ludovic111/horizon/issues/1660). + +
+ +#### 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 + +- **Server resource packs** (v0.2.48): Servers can send you their resource pack: Horizon asks, downloads it and applies it, like vanilla. [#1562](https://github.com/ludovic111/horizon/issues/1562) · [#1569](https://github.com/ludovic111/horizon/issues/1569) · [#1570](https://github.com/ludovic111/horizon/issues/1570) +- **Single player on its own server thread** (v0.2.39): Single player runs on a server thread, as vanilla does, so the world keeps ticking smoothly while the window draws. [#1514](https://github.com/ludovic111/horizon/issues/1514) · [docs/server-levels.md](docs/server-levels.md) +- **GPU occlusion culling on Macs** (v0.2.17): On Macs the GPU now skips terrain hidden behind hills and caves: 8 to 48% more frames per second at 32 chunks on an M4 Pro. [#1434](https://github.com/ludovic111/horizon/issues/1434) +- **Animated textures on the GPU** (v0.2.5): Water, lava and other animated blocks are now animated by the graphics card: 1.7 to 2.4 times better 1% lows on Intel graphics. [#1239](https://github.com/ludovic111/horizon/issues/1239) +- **Far Detail for integrated graphics** (v0.2.5): An optional Reduced setting for far terrain, suggested on integrated graphics, that saves 2 to 4 ms of GPU time per frame. [#1199](https://github.com/ludovic111/horizon/issues/1199) · [#1029](https://github.com/ludovic111/horizon/issues/1029) +- **The launcher's mod browser** (launcher@0.2.0): Search Modrinth for mods, modpacks and resource packs from the launcher; it says before installing what works in Horizon. [#1154](https://github.com/ludovic111/horizon/issues/1154) · [#1242](https://github.com/ludovic111/horizon/issues/1242) · [#1243](https://github.com/ludovic111/horizon/issues/1243) · [#1246](https://github.com/ludovic111/horizon/issues/1246) · [docs/mod-browser.md](docs/mod-browser.md) +- **A blocky, Minecraft-like launcher** (launcher@0.2.0): The launcher got a new blocky look in Horizon's purple, in dark and light. [#1269](https://github.com/ludovic111/horizon/issues/1269) · [docs/design-system.md](docs/design-system.md) +- **Dynamic lights** (v2026.10.22): An optional extra: torches you hold, drop or set on fire light up what is around them. [#1162](https://github.com/ludovic111/horizon/issues/1162) +- **Host a server from the launcher** (launcher-v0.15.0): The launcher's Servers page creates, starts, backs up and updates a Horizon server with buttons, and invites friends. [#1026](https://github.com/ludovic111/horizon/issues/1026) · [docs/hosting.md](docs/hosting.md) diff --git a/roadmap/README.md b/roadmap/README.md new file mode 100644 index 000000000..df44575a5 --- /dev/null +++ b/roadmap/README.md @@ -0,0 +1,56 @@ +# The roadmap + +`roadmap.toml` is the one source of the roadmap. `tools/roadmap.py build` turns it into +[ROADMAP.md](../ROADMAP.md); the website's hub (playhorizon.dev/hub) and Kira read the same items. The work +board stays the task-level view (every issue and pull request); the roadmap is the overview, and each pull +request carries the `roadmap:` label of the item it moves. + +## An item + +```toml +[[item]] +id = "server-dialogs" # lowercase words joined by dashes; never renamed (votes and links use it) +title = "Server dialogs and login screens" +status = "now" # now | next | later | help-wanted | shipped +area = "servers" # one of the [[area]] ids, listed in the order of priority +focus = true # optional: one of the 3 to 5 Now items in the overview +ongoing = true # optional: a workstream that goes on after its pull requests merge +plain = """Servers that show dialogs ... will work in Horizon.""" # players' words, at most 240 characters +dev = """26.3's dialog packets and model (#1720), ...""" # crates, approach, what is left +links = ["#1720", "#1734", "docs/hosting.md"] # #N, a repository path, or https:// +shipped_in = "v0.2.58" # shipped items only: a game tag, launcher@x.y.z, or "website" +post = "..." # optional: the announcement when it ships, if `plain` doesn't read as one +``` + +- **No dates, ever**: Now, Next, Later. The check rejects month names, years, quarters and "next week". + "Coming soon" is the only phrase for something waiting on someone else (Microsoft sign-in, CurseForge). +- **Only what is decided.** Ideas stay in issues and in the suggestion queue until they are. +- **Only what is true in a release** for shipped items: a merged pull request isn't shipped until a release has it. +- `plain` is for players: what they will be able to do, not how. `dev` is for contributors: the code, the + vanilla classes, the pull requests, what is left. Both stay public: no machines, accounts or private notes. +- Help wanted items are good first contributions: a clear vanilla behaviour, an issue with steps, a place to + start in `dev`. + +## Keeping it current + +Whoever moves the work (the orchestrator on each heartbeat, or anyone in their pull request): + +1. `python3 tools/roadmap.py sync`: every item whose linked pull requests all went out in a release, whose + linked issues are all closed and that isn't `ongoing` becomes `shipped`, with that release in + `shipped_in`, on top of the shipped items. It rewrites `roadmap.toml` and ROADMAP.md; open a pull request + with the change (`skip-release`). +2. `python3 tools/roadmap.py check`: the file's rules, then GitHub's state of every link. It fails when a + link is not an issue or pull request, when a Now item has no open pull request and none merged in the last + 14 days (link the new work, or move it to Next or Later), and when every link of a Help wanted item is + closed. It also says which items `sync` will ship once a release has them. +3. When work starts, opens a pull request or is decided: add or move the item, add its links, then + `python3 tools/roadmap.py build`. Keep the overview's focus to the 3 to 5 biggest Now items. +4. `python3 tools/roadmap.py labels` (after the change merges): creates a `roadmap:` label for each new + item, updates their colour (by status) and description, and adds the label to the open pull requests an item + links. Label a new pull request for an item by hand or by linking it and running `labels` again. Labels of + removed items are listed, never deleted. +5. Suggestions from the website and Discord are read and triaged by the maintainers. A good one becomes an + item in a normal pull request; none is published automatically. + +CI runs `tests/test_roadmap.py` (in the Python tests), which fails when ROADMAP.md is not what `build` writes +or when the file breaks a rule; `python3 tools/roadmap.py check --offline` runs the same rules without GitHub. diff --git a/roadmap/roadmap.toml b/roadmap/roadmap.toml new file mode 100644 index 000000000..bb664d3d5 --- /dev/null +++ b/roadmap/roadmap.toml @@ -0,0 +1,477 @@ +# Horizon's roadmap: the one source of truth for ROADMAP.md, playhorizon.dev/roadmap and Kira's answers. +# Edit this file, then run `python3 tools/roadmap.py build`. How to keep it current: roadmap/README.md. +# +# No dates, ever: an item is Now, Next or Later. Each item says the same thing twice: `plain` for players +# (one or two sentences, at most 240 characters, so it fits a post when it ships) and `dev` for contributors +# (crates, approach, what is left). Links are "#123" (an issue or a pull request), a path in the repository, +# or an https URL. Only what is decided goes here; ideas wait in GitHub issues and the suggestion queue. +# `focus = true` puts a Now item in the overview (3 to 5 of them). `ongoing = true` marks a workstream that goes on +# after its linked pull requests merge: `sync` never ships it, so link its new pull requests as they open. + +[overview] +today_plain = """Horizon is Minecraft: Java Edition 26.3 rewritten from scratch in Rust, so it runs faster on the \ +same computer. Single player, LAN, servers, resource packs and Horizon's own mods work today, on your own copy of \ +the game.""" +today_dev = """A native Rust and wgpu reimplementation of Java 26.3: the same saves, rules and terrain, checked \ +against the real game by more than 300 differential harnesses (a Java oracle and a Rust probe on the same inputs). \ +Single player runs on its own server thread, like vanilla's integrated server.""" +help_plain = """Play it and tell us what differs from vanilla (Discord or GitHub), run the benchmark on your \ +computer, vote for what you want next, or pick one of the Help wanted items.""" +help_dev = """Read CONTRIBUTING.md, pick a Help wanted item or a To do card, check vanilla's code for the \ +behaviour, and paste the block `python3 tools/pr_ready.py` prints in your pull request.""" + +# Areas, in the project's order of priority: performance first, then modpacks and servers. +[[area]] +id = "performance" +name = "Performance" + +[[area]] +id = "modpacks" +name = "Modpacks" + +[[area]] +id = "servers" +name = "Servers and multiplayer" + +[[area]] +id = "mods" +name = "Mods and API" + +[[area]] +id = "gameplay" +name = "Gameplay parity" + +[[area]] +id = "rendering" +name = "Rendering" + +[[area]] +id = "launcher" +name = "Launcher" + +[[area]] +id = "extras" +name = "Horizon extras" + +[[area]] +id = "project" +name = "Code and tools" + +# ---------------------------------------------------------------------------------------------------- Now + +[[item]] +id = "smooth-frames" +title = "Steady frames at long render distances" +status = "now" +area = "performance" +focus = true +plain = """Making Horizon faster than vanilla on every computer, with smooth camera movement even at 32 chunks, \ +by spreading the work better over the processor's cores.""" +dev = """Frame pacing at render distance 32 (#678): long frames come from work competing with the render thread. \ +In review: world generation workers build free structure starts instead of queueing them (#1760), the worker pool \ +leaves one core as vanilla does (#1778), and the terrain vertex arena is read as storage where flat draws run \ +(#1742). Still open: far terrain at 48 to 64 chunks (#718) and CPU-bound fields of block entities (#717). Every \ +change shows before and after numbers from `tools/perf_bench.py` against vanilla 26.3 (docs/benchmark.md).""" +links = ["#678", "#1760", "#1778", "#1742", "#718", "#717", "docs/benchmark.md"] + +[[item]] +id = "block-storage" +title = "Faster block lookups" +status = "now" +area = "performance" +plain = """Speeding up the code that reads and writes the blocks of the world, which almost everything in the game \ +goes through: generation, lighting, meshing and ticking.""" +dev = """`PalettedContainer` and `PackedStorage` find an entry's word by multiply and shift instead of an integer \ +division (#1790, #1794); meshing looks up baked models by index, not by name (#1747). Each change keeps the paletted \ +storage harnesses identical and shows its microbenchmark (docs/performance/paletted-container-access-results.md).""" +links = ["#1790", "#1794", "#1747", "docs/performance/paletted-container-access-results.md"] + +[[item]] +id = "modpack-worldgen" +title = "Modpacks' world generation, natively" +status = "now" +area = "modpacks" +focus = true +plain = """Making the world-generation mods of popular modpacks (new structures, YUNG's dungeons and mineshafts, \ +packs built on Lithostitched) generate their worlds in Horizon, natively and fast.""" +dev = """`horizon-port-pack` carries a pack's data-driven content over; structure mods that need code get a native \ +port: YUNG's worldgen as written (#1746), Lithostitched's limited and guaranteed elements with pool and processor \ +modifiers (#1777), its processors as the game's own types (#1765). Proved by the structure blocks and layout \ +harnesses (#1753, #1757). Mods whose Java code does more than world generation don't run (docs/modpacks.md).""" +links = ["#1746", "#1777", "#1765", "#1753", "#1757", "docs/modpacks.md"] + +[[item]] +id = "server-clients" +title = "Playing on servers: everything shows as it should" +status = "now" +ongoing = true +area = "servers" +focus = true +plain = """When you play on a server, other players, mobs, items and menus look and behave as in vanilla: skins, \ +poses, item names, inventories and server networks.""" +dev = """Client-of-a-server fixes in `game/remote*.rs` and `horizon-protocol`: mobs' aggressive and item-use flags \ +(#1802, #1798), ghost items after a remote menu (#1795), skins (#1652), cookies and transfer packets for proxy \ +networks (#1650), firework boosts (#1671), living-entity attributes and simulation distance (#1731), styled item \ +names (#1702), primed TNT between updates (#1710).""" +links = ["#1802", "#1798", "#1795", "#1652", "#1650", "#1671", "#1731", "#1702", "#1710"] + +[[item]] +id = "server-thread" +title = "Single player as a server: the last differences" +status = "now" +ongoing = true +area = "gameplay" +focus = true +plain = """Single player now runs a small server in the background, as vanilla does. We are fixing what still \ +behaves differently there; every fix also works for LAN and server players.""" +dev = """Since #1514 single player runs on the server thread (`game/integrated.rs`) and the window joins it as a \ +client; `--in-frame` keeps the old path. The open `[server-thread]` issues list the gaps. In review: a tool that \ +changes a block ends the click (#1797), potions keep their potion over the connection (#1796), mobs' aggression \ +and arm swings (#1802). docs/server-levels.md.""" +links = ["#1514", "#1797", "#1796", "#1802", "docs/server-levels.md"] + +[[item]] +id = "mod-registry" +title = "Horizon's mod registry" +status = "now" +area = "mods" +focus = true +plain = """One place for mods, modpacks and resource packs made for Horizon: browse them on the website and \ +install them from the launcher in one click.""" +dev = """Merged: the registry index (schema 1, `.hpack`, checks before install, #1634), `cargo horizon-mod check` \ +(#1642) and the submission service (`crates/horizon-mod-registry`, #1659). In review: the website's /mods (#1596) \ +and /mods/submit (#1635), and in the launcher the registry as a source (#1636), install, enable and takedowns \ +(#1637), the Mods page (#1638) and modpacks as their own profiles (#1640).""" +links = ["#1634", "#1642", "#1659", "#1596", "#1635", "#1636", "#1637", "#1638", "#1640", "docs/mods.md"] + +[[item]] +id = "server-dialogs" +title = "Server dialogs and login screens" +status = "now" +area = "servers" +plain = """Servers that show dialogs, such as the register and login screens of AuthMe, will work in Horizon.""" +dev = """26.3's dialog packets and model (#1720), the dialog screen with its buttons and actions (#1734), then text \ +and boolean inputs (#1735).""" +links = ["#1720", "#1734", "#1735"] + +[[item]] +id = "languages" +title = "Play in your language" +status = "now" +area = "gameplay" +plain = """Item names, container titles and server messages follow the language you pick, as in vanilla. Today \ +parts of the game stay in English.""" +dev = """Translatable components resolved through the selected language for items, containers and server text \ +(#1806), on top of the bundled languages the prepared resources carry (#1594). Left: the client's own screens \ +(#1672) and the main menu with zh_cn (#1774).""" +links = ["#1806", "#1594", "#1672", "#1774"] + +[[item]] +id = "shader-packs" +title = "Shader packs, written again from scratch" +status = "now" +ongoing = true +area = "rendering" +plain = """Shader packs were removed and are being rebuilt from scratch. They come back, off by default, once the \ +best-known packs draw properly.""" +dev = """A clean-room rewrite in `horizon-shaderpack`, from the packs' public format documentation only: reading \ +packs, the preprocessor and `.properties` files are merged (#1584, #1585, #1586); translating programs to WGSL \ +through naga, buffers, uniforms and the terrain, entity, sky, weather and hand stages are in review (#1698 to \ +#1801).""" +links = ["#1561", "#1584", "#1586", "#1698", "#1771", "#1786", "#1801"] + +[[item]] +id = "discord-presence" +title = "Discord Rich Presence" +status = "now" +area = "extras" +plain = """Your Discord profile can show that you are playing Horizon, with a switch to turn it off.""" +dev = """A Discord IPC client on its own thread (#1787) and the presence with its setting (#1788). Merged: it ships \ +with the next release.""" +links = ["#1787", "#1788"] + +[[item]] +id = "lean-code" +title = "A leaner codebase that builds faster" +status = "now" +ongoing = true +area = "project" +plain = """Cleaning up Horizon's code: removing what nothing uses and making it quicker to build, so fixes and new \ +features land faster.""" +dev = """A review of the whole tree: dead code and stubs removed (#1432, #1658), one probe binary per crate (#1453, \ +#1454), shared harness helpers (#1448), clippy clean on the whole tree (#1707). docs/architecture.md maps each \ +feature to its files and harnesses.""" +links = ["#1432", "#1658", "#1453", "#1454", "#1448", "#1707", "docs/architecture.md"] + +# ---------------------------------------------------------------------------------------------------- Next + +[[item]] +id = "microsoft-sign-in" +title = "Microsoft sign-in (coming soon)" +status = "next" +area = "launcher" +plain = """Coming soon: sign in with your Microsoft account to play on online-mode servers. The code is ready; it \ +waits for Microsoft's approval.""" +dev = """Device-code sign-in in the launcher and online-mode login in the client (docs/microsoft-account.md). It is \ +turned on by setting the app's client id once Minecraft API access is approved; until then the launcher shows \ +"Coming soon".""" +links = ["docs/microsoft-account.md", "#1270"] + +[[item]] +id = "curseforge" +title = "CurseForge in the mod browser (coming soon)" +status = "next" +area = "modpacks" +plain = """Coming soon: search and download CurseForge mods and modpacks from the launcher, as you can with \ +Modrinth today.""" +dev = """The mod browser lists CurseForge as coming soon (docs/mod-browser.md): it needs CurseForge API access. \ +Meanwhile packs import from a CurseForge zip or instance folder, and jars only CurseForge hosts come from the \ +player's own instance (docs/modpacks.md).""" +links = ["docs/mod-browser.md", "docs/modpacks.md"] + +[[item]] +id = "benchmarks" +title = "Fresh benchmarks against vanilla" +status = "next" +area = "performance" +plain = """New public numbers comparing Horizon with vanilla on many kinds of computers, measured the same way \ +every time, on the website's Benchmarks page.""" +dev = """Redo the comparison after the current performance work (#1073); reliability, coverage and presentation \ +(#1346); a scene must count as loaded only once its first chunk arrives (#1749). Players' reports come in through \ +`--benchmark` and `horizon-launcher data benchmark` (docs/benchmark.md).""" +links = ["#1073", "#1346", "#1749", "docs/benchmark.md"] + +[[item]] +id = "pistons-push" +title = "Pistons push players and mobs" +status = "next" +area = "gameplay" +plain = """Pistons and slime blocks will push players, mobs and items as in vanilla. Today moving blocks pass \ +through them.""" +dev = """Port `PistonMovingBlockEntity.moveCollidedEntities` and `moveStuckEntities` (honey), the slime bounce and \ +`Entity.limitPistonMovement` for `MoverType.PISTON`, in single player and for a server's players. Issues #1496, \ +#1609, #1608, #1704, #1758.""" +links = ["#1496", "#1609", "#1608", "#1704", "#1758"] + +[[item]] +id = "intel-mac" +title = "Horizon on Intel Macs" +status = "next" +area = "launcher" +plain = """Builds of the game and the launcher for Macs with an Intel processor.""" +dev = """x86_64 game and launcher builds, picked per processor (#1171). Before it ships it needs a run on a real \ +Intel Mac: Rosetta on Apple Silicon only proves the CPU code. Requests: #1161, #1792.""" +links = ["#1171", "#1161", "#1792"] + +# ---------------------------------------------------------------------------------------------------- Later + +[[item]] +id = "ai-companion" +title = "An optional AI teammate" +status = "later" +area = "extras" +plain = """An AI teammate that plays beside you and that you can talk to. It is off unless you turn it on, and the \ +No AI switch hides it completely.""" +dev = """Draft pull requests: the companion (#1068), its safety modes and their evaluation (#1069), and a route \ +that finishes the game (#1070). Local models first; it ships only once the safety evaluation passes.""" +links = ["#1068", "#1069", "#1070"] + +[[item]] +id = "new-versions" +title = "Following new Minecraft versions" +status = "later" +area = "gameplay" +plain = """When Mojang releases a new version of the game, Horizon follows it, and every system is checked against \ +the new version again.""" +dev = """The port pipeline detects a release, diffs its classes against 26.3 and writes a port report \ +(docs/version-ports.md); the harnesses then run against the new version.""" +links = ["docs/version-ports.md"] + +# ---------------------------------------------------------------------------------------------------- Help wanted + +[[item]] +id = "benchmark-your-pc" +title = "Benchmark your computer" +status = "help-wanted" +area = "performance" +plain = """Run Horizon's built-in benchmark and share the report: every new computer makes the performance work \ +more accurate. No coding needed.""" +dev = """`horizon-launcher play --arg=--benchmark --arg=standard` writes a JSON report; `horizon-launcher data \ +benchmark ` shows what would be sent and uploads it (website/docs/performance.md). Results from three \ +installs with the same hardware appear on the Benchmarks page. Example: #1711.""" +links = ["website/docs/performance.md", "#1711"] + +[[item]] +id = "end-city-banners" +title = "End city banners keep their pattern" +status = "help-wanted" +area = "gameplay" +plain = """Banners in End cities show as plain magenta instead of with their pattern.""" +dev = """Compare the banner block entities the End city templates place with vanilla's (`EndCityPieces`, the \ +templates' block entity NBT, `BannerBlockEntity`'s patterns), in `crates/horizon-world/src/worldgen/structure/`. \ +Issue #1438; possibly related: #526.""" +links = ["#1438", "#526"] + +[[item]] +id = "end-city-loot" +title = "Enchanted loot in End cities" +status = "help-wanted" +area = "gameplay" +plain = """Armour and tools in End city chests should come enchanted, as in vanilla.""" +dev = """`loot.rs` implements `enchant_with_levels`: find why the End city chest table's rolls come out bare, and \ +compare them with vanilla's for a few seeds. Issues #1437, #1660.""" +links = ["#1437", "#1660"] + +[[item]] +id = "item-cooldowns" +title = "Cooldowns drawn on items" +status = "help-wanted" +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"] + +[[item]] +id = "chat-settings" +title = "Chat settings and team prefixes" +status = "help-wanted" +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"] + +[[item]] +id = "pointer-hand" +title = "A pointing hand over buttons" +status = "help-wanted" +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"] + +[[item]] +id = "text-field-keys" +title = "Ctrl+Backspace and scroll bars in menus" +status = "help-wanted" +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"] + +[[item]] +id = "chicken-flap" +title = "Chickens flap while they fall" +status = "help-wanted" +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"] + +# ---------------------------------------------------------------------------------------------------- Shipped +# Newest first: `tools/roadmap.py sync` adds each newly shipped item on top. + +[[item]] +id = "server-resource-packs" +title = "Server resource packs" +status = "shipped" +shipped_in = "v0.2.48" +area = "servers" +plain = """Servers can send you their resource pack: Horizon asks, downloads it and applies it, like vanilla.""" +dev = """The dedicated server offers server.properties' pack (#1562); the client's pack manager, downloads, prompt \ +and Server Resource Packs setting (#1569, #1570).""" +links = ["#1562", "#1569", "#1570"] + +[[item]] +id = "server-thread-default" +title = "Single player on its own server thread" +status = "shipped" +shipped_in = "v0.2.39" +area = "gameplay" +plain = """Single player runs on a server thread, as vanilla does, so the world keeps ticking smoothly while the \ +window draws.""" +dev = """`game/integrated.rs` runs a second `Game` with one level per dimension; the window joins it through \ +memory like a LAN guest (#1514).""" +links = ["#1514", "docs/server-levels.md"] + +[[item]] +id = "metal-occlusion" +title = "GPU occlusion culling on Macs" +status = "shipped" +shipped_in = "v0.2.17" +area = "performance" +plain = """On Macs the GPU now skips terrain hidden behind hills and caves: 8 to 48% more frames per second at 32 \ +chunks on an M4 Pro.""" +dev = """GPU occlusion culling on Metal (#1434).""" +links = ["#1434"] + +[[item]] +id = "gpu-animated-textures" +title = "Animated textures on the GPU" +status = "shipped" +shipped_in = "v0.2.5" +area = "performance" +plain = """Water, lava and other animated blocks are now animated by the graphics card: 1.7 to 2.4 times better 1% \ +lows on Intel graphics.""" +dev = """Frames uploaded once, no per-tick CPU blend or copy (#1239).""" +links = ["#1239"] + +[[item]] +id = "far-detail" +title = "Far Detail for integrated graphics" +status = "shipped" +shipped_in = "v0.2.5" +area = "performance" +plain = """An optional Reduced setting for far terrain, suggested on integrated graphics, that saves 2 to 4 ms of GPU \ +time per frame.""" +dev = """Opt-in reduced far terrain (#1199), on far-terrain chunk summaries built on the workers (#1029).""" +links = ["#1199", "#1029"] + +[[item]] +id = "mod-browser" +title = "The launcher's mod browser" +status = "shipped" +shipped_in = "launcher@0.2.0" +area = "modpacks" +plain = """Search Modrinth for mods, modpacks and resource packs from the launcher; it says before installing what \ +works in Horizon.""" +dev = """The Mods page (#1154), Java mods checked before install (#1242), project pages, filters and galleries \ +(#1243), modpacks ported in the same step (#1246). docs/mod-browser.md.""" +links = ["#1154", "#1242", "#1243", "#1246", "docs/mod-browser.md"] + +[[item]] +id = "launcher-look" +title = "A blocky, Minecraft-like launcher" +status = "shipped" +shipped_in = "launcher@0.2.0" +area = "launcher" +plain = """The launcher got a new blocky look in Horizon's purple, in dark and light.""" +dev = """The Blocks look (#1269), from `horizon-theme` (docs/design-system.md).""" +links = ["#1269", "docs/design-system.md"] + +[[item]] +id = "dynamic-lights" +title = "Dynamic lights" +status = "shipped" +shipped_in = "v2026.10.22" +area = "extras" +plain = """An optional extra: torches you hold, drop or set on fire light up what is around them.""" +dev = """Held, dropped and burning light sources (#1162), in Horizon Extras, off by default.""" +links = ["#1162"] + +[[item]] +id = "servers-page" +title = "Host a server from the launcher" +status = "shipped" +shipped_in = "launcher-v0.15.0" +area = "servers" +plain = """The launcher's Servers page creates, starts, backs up and updates a Horizon server with buttons, and \ +invites friends.""" +dev = """The launcher's Servers page (#1026) over `horizon-server` (docs/hosting.md).""" +links = ["#1026", "docs/hosting.md"] diff --git a/tests/test_roadmap.py b/tests/test_roadmap.py new file mode 100644 index 000000000..fb4f4e419 --- /dev/null +++ b/tests/test_roadmap.py @@ -0,0 +1,207 @@ +import copy +import datetime +import tomllib +import unittest +from unittest import mock + +from tools import roadmap + +SAMPLE = '''[overview] +today_plain = "a" +today_dev = "b" +help_plain = "c" +help_dev = "d" + +[[area]] +id = "performance" +name = "Performance" + +# ---- Now + +[[item]] +id = "fast" +title = "Fast" +status = "now" +area = "performance" +focus = true +plain = "Faster." +dev = """Multiply, \\ +not divide (#10).""" +links = ["#10"] + +[[item]] +id = "faster" +title = "Faster" +status = "now" +area = "performance" +focus = true +plain = "Even faster." +dev = "More (#11)." +links = ["#11", "#12"] + +[[item]] +id = "fastest" +title = "Fastest" +status = "now" +area = "performance" +focus = true +ongoing = true +plain = "The fastest." +dev = "Most (#13)." +links = ["#13"] + +# ---- Shipped + +[[item]] +id = "old" +title = "Old" +status = "shipped" +shipped_in = "v0.2.1" +area = "performance" +plain = "Done." +dev = "Done (#1)." +links = ["#1"] +''' + + +def pull(state, merged_at=None, paths=("crates/horizon-client/src/game.rs",)): + return {"kind": "PullRequest", "state": state, "merged_at": merged_at, "merge_commit": "abc" if merged_at else None, + "paths": list(paths)} + + +def issue(state): + return {"kind": "Issue", "state": state, "merged_at": None, "merge_commit": None, "paths": []} + + +class RepositoryRoadmap(unittest.TestCase): + def test_the_roadmap_keeps_its_rules(self): + self.assertEqual(roadmap.validate(roadmap.load()), []) + + def test_roadmap_md_is_generated_from_the_toml(self): + self.assertEqual(roadmap.OUTPUT.read_text(), roadmap.render(roadmap.load()), + "ROADMAP.md is out of date: run `python3 tools/roadmap.py build`") + + +class Rules(unittest.TestCase): + def setUp(self): + self.data = tomllib.loads(SAMPLE) + + def problems(self, **changes): + data = copy.deepcopy(self.data) + data["item"][0].update(changes) + return roadmap.validate(data) + + def test_the_sample_is_valid(self): + self.assertEqual(roadmap.validate(self.data), []) + + def test_unknown_status_area_and_key(self): + self.assertTrue(any("status" in p for p in self.problems(status="soon"))) + self.assertTrue(any("area" in p for p in self.problems(area="nowhere"))) + self.assertTrue(any("unknown key" in p for p in self.problems(eta="soon"))) + + def test_plain_fits_a_post(self): + self.assertTrue(any("at most 240" in p for p in self.problems(plain="x" * 241))) + self.assertTrue(any("post" in p for p in self.problems(post="x" * 241))) + + def test_shipped_needs_its_release(self): + self.assertTrue(any("shipped_in" in p for p in self.problems(status="shipped", focus=False))) + self.assertTrue(any("only shipped" in p for p in self.problems(shipped_in="v0.2.3"))) + self.assertTrue(any("not a release" in p for p in self.problems(status="shipped", focus=False, + shipped_in="soon"))) + + def test_links_are_issues_urls_or_repository_paths(self): + self.assertEqual(self.problems(links=["#4", "https://playhorizon.dev", "docs/benchmark.md"]), []) + self.assertTrue(any("link" in p for p in self.problems(links=["docs/nothing-here.md"]))) + self.assertTrue(any("link" in p for p in self.problems(links=["http://example.com"]))) + + def test_three_to_five_items_in_focus(self): + self.assertTrue(any("focus" in p for p in self.problems(focus=False))) + + def test_no_dates(self): + for text in ("Ready in March.", "Before 2027.", "In Q3.", "Next week.", "In 3 weeks.", "By the end of it."): + self.assertTrue(roadmap.dated(text), text) + for text in ("Coming soon.", "Pull request #2026.", "Java 26.3.", "Mobs march on.", "It may land."): + self.assertIsNone(roadmap.dated(text), text) + self.assertTrue(any("date" in p for p in self.problems(plain="Done in October."))) + + +class Render(unittest.TestCase): + def test_sections_links_and_the_overview(self): + text = roadmap.render(tomllib.loads(SAMPLE)) + self.assertIn("## Now", text) + self.assertIn("## Recently shipped", text) + self.assertNotIn("## Later", text) + self.assertIn("- **Fast**: Faster.", text) + self.assertIn("Multiply, not divide ([#10](https://github.com/ludovic111/horizon/issues/10)).", text) + # A link the technical text already gives isn't repeated; the others are listed after it. + self.assertIn("More: [#12](https://github.com/ludovic111/horizon/issues/12)", text) + self.assertIn("- **Old** (v0.2.1): Done.", text) + + +class GitHubState(unittest.TestCase): + now = datetime.datetime(2030, 1, 20, tzinfo=datetime.timezone.utc) + + def test_a_now_item_without_live_pull_requests_is_stale(self): + data = tomllib.loads(SAMPLE) + states = {1: pull("MERGED", "2029-12-01T00:00:00Z"), 10: pull("OPEN"), + 11: pull("MERGED", "2029-11-01T00:00:00Z"), 12: issue("OPEN"), + 13: pull("MERGED", "2030-01-19T00:00:00Z")} + problems, notes = roadmap.online_problems(data, states, self.now) + self.assertEqual(len(problems), 1) + self.assertIn("faster: stale", problems[0]) + self.assertTrue(any("fastest: ongoing" in note for note in notes)) + + def test_missing_numbers_are_reported(self): + problems, _ = roadmap.online_problems(tomllib.loads(SAMPLE), {}, self.now) + self.assertTrue(any("#10 is neither" in p for p in problems)) + + +class Labels(unittest.TestCase): + def test_creates_updates_and_adds_labels(self): + data = tomllib.loads(SAMPLE) + existing = {"roadmap:fast": {"color": "5B3FD6", "description": "Roadmap, now: Fast"}, + "roadmap:faster": {"color": "000000", "description": "old"}, + "roadmap:gone": {"color": "000000", "description": ""}} + states = {10: dict(pull("OPEN"), labels=["roadmap:fast"]), 11: dict(pull("OPEN"), labels=[]), + 13: dict(pull("MERGED", "2030-01-01T00:00:00Z"), labels=[])} + changes, stale = roadmap.label_changes(data, existing, states) + self.assertEqual([(action, target) for action, target, _ in changes], + [("update", "roadmap:faster"), ("add", 11), ("create", "roadmap:fastest"), + ("create", "roadmap:old")]) + self.assertEqual(changes[0][2]["color"], "5b3fd6") + self.assertEqual(stale, ["roadmap:gone"]) + + +class Sync(unittest.TestCase): + def test_family_of_a_change(self): + self.assertEqual(roadmap.family(["launcher/src/main.rs"]), "launcher") + self.assertEqual(roadmap.family(["website/src/main.js"]), "website") + self.assertEqual(roadmap.family(["launcher/src/main.rs", "crates/x/src/lib.rs"]), "game") + + def test_merged_and_released_items_move_to_the_top_of_shipped(self): + data = tomllib.loads(SAMPLE) + states = {10: pull("MERGED", "2030-01-02T00:00:00Z"), 11: pull("MERGED", "2030-01-03T00:00:00Z"), + 12: issue("OPEN"), 13: pull("MERGED", "2030-01-03T00:00:00Z")} + with mock.patch.object(roadmap, "first_release", return_value="v0.2.9") as release: + text, log = roadmap.sync(data, SAMPLE, states) + release.assert_called_once_with("abc", "game") + # "faster" keeps an open issue and "fastest" is ongoing: only "fast" ships. + self.assertEqual(log, ["fast: shipped in v0.2.9"]) + new = tomllib.loads(text) + self.assertEqual([item["id"] for item in new["item"]], ["faster", "fastest", "fast", "old"]) + fast = new["item"][2] + self.assertEqual((fast["status"], fast["shipped_in"]), ("shipped", "v0.2.9")) + self.assertNotIn("focus", fast) + self.assertEqual(fast["dev"], "Multiply, not divide (#10).") + self.assertIn("# ---- Shipped\n\n[[item]]\nid = \"fast\"", text) + + def test_merged_but_unreleased_items_wait(self): + states = {10: pull("MERGED", "2030-01-02T00:00:00Z")} + with mock.patch.object(roadmap, "first_release", return_value=None): + text, log = roadmap.sync(tomllib.loads(SAMPLE), SAMPLE, states) + self.assertEqual(text, SAMPLE) + self.assertEqual(log, ["fast: merged, waiting for a release"]) + + +if __name__ == "__main__": + unittest.main() diff --git a/tools/pr_ready.py b/tools/pr_ready.py index a944e2116..505de28c1 100755 --- a/tools/pr_ready.py +++ b/tools/pr_ready.py @@ -108,7 +108,7 @@ def touched_crates(paths, packages): def area(path): """The part of the project a path belongs to; None for what goes with any change (docs, tests, harnesses).""" - if is_doc(path) or path.startswith(("tests/", "mods/", "docs/")) or path == "research-lock.json" or \ + if is_doc(path) or path.startswith(("tests/", "mods/", "docs/", "roadmap/")) or path == "research-lock.json" or \ (path.startswith("tools/") and not path.startswith("tools/ci/")): return None if path.startswith(("launcher/", "crates/horizon-prepare/")): @@ -288,7 +288,9 @@ def plan(args, base, changed, crates_of, libraries, dependencies): """The checks for these changed files, in the order they run.""" rust = any(workspace_rust(path) for path in changed) launcher = any(launcher_rust(path) for path in changed) - python = any(path.endswith(".py") or path.startswith(("tests/", "tools/")) for path in changed) + # The Python tests also hold ROADMAP.md to roadmap/roadmap.toml (tests/test_roadmap.py). + python = any(path.endswith(".py") or path.startswith(("tests/", "tools/", "roadmap/")) or path == "ROADMAP.md" + for path in changed) crates = touched_crates(changed, crates_of) if rust or TOKENS in changed else [] # An unrecognised Rust path must not silently skip validation. if rust and crates == []: diff --git a/tools/roadmap.py b/tools/roadmap.py new file mode 100644 index 000000000..b1bb13c6d --- /dev/null +++ b/tools/roadmap.py @@ -0,0 +1,551 @@ +#!/usr/bin/env python3 +"""Horizon's roadmap: roadmap/roadmap.toml is the source, ROADMAP.md is generated from it. + + python3 tools/roadmap.py build write ROADMAP.md + python3 tools/roadmap.py build --check fail when ROADMAP.md is out of date (CI) + python3 tools/roadmap.py check --offline the file's own rules (CI) + python3 tools/roadmap.py check the same, then GitHub: links resolve, no stale Now item + python3 tools/roadmap.py sync [--dry-run] items whose pull requests all merged become shipped, + with the release they went out in + python3 tools/roadmap.py labels [--dry-run] a `roadmap:` label per item on GitHub, and on the open + pull requests the item links + +The online commands read GitHub with GITHUB_TOKEN, GH_TOKEN or `gh auth token`. Maintenance: roadmap/README.md. +""" + +import argparse +import datetime +import json +import os +import re +import subprocess +import sys +import tomllib +import urllib.parse +import urllib.request +from pathlib import Path + +ROOT = Path(__file__).resolve().parent.parent +SOURCE = ROOT / "roadmap" / "roadmap.toml" +OUTPUT = ROOT / "ROADMAP.md" +REPO = "ludovic111/horizon" +SITE = "https://playhorizon.dev/hub" + +STATUSES = { + "now": "Now", + "next": "Next", + "later": "Later", + "help-wanted": "Help wanted", + "shipped": "Recently shipped", +} +PLAIN_MAX = 240 # one post's worth, so a shipped item can be announced as written +TITLE_MAX = 70 +FOCUS_RANGE = (3, 5) +STALE_DAYS = 14 # a Now item needs an open pull request, or one merged this recently +LABEL_PREFIX = "roadmap:" +# GitHub label colours by status, from the design system's palette. +LABEL_COLOURS = {"now": "5b3fd6", "next": "9a86ff", "later": "c5c7d1", "help-wanted": "1d7a48", "shipped": "646875"} +ITEM_KEYS = {"id", "title", "status", "area", "plain", "dev", "links", "focus", "ongoing", "shipped_in", "post"} + +ISSUE = re.compile(r"#(\d+)$") +ID = re.compile(r"[a-z0-9]+(-[a-z0-9]+)*$") +RELEASE = re.compile(r"(v\d[\w.]*|launcher@\d[\w.]*|launcher-v\d[\w.]*|website)$") +MONTHS = ("January|February|March|April|June|July|August|September|October|November|December") +# Kira's rule: no dates and no promises of when. "Coming soon" is the one allowed phrase. +DATE = re.compile( + rf"\b(?:{MONTHS})\b|\bMay \d|(? TITLE_MAX: + problems.append(f"{where}: the title is longer than {TITLE_MAX} characters") + for key in ("plain", "post"): + if len(item.get(key, "")) > PLAIN_MAX: + problems.append(f"{where}: {key} is {len(item[key])} characters, at most {PLAIN_MAX}") + for key in ("title", "plain", "dev", "post"): + found = dated(item.get(key, "")) + if found: + problems.append(f"{where}: {key} names a date or a deadline ({found!r}); the roadmap has none") + shipped_in = item.get("shipped_in") + if status == "shipped": + if not shipped_in: + problems.append(f"{where}: a shipped item needs shipped_in (a release tag, or \"website\")") + elif not RELEASE.match(shipped_in): + problems.append(f"{where}: shipped_in {shipped_in!r} is not a release tag or \"website\"") + elif shipped_in: + problems.append(f"{where}: only shipped items have shipped_in") + if item.get("ongoing") and status not in ("now", "next", "later"): + problems.append(f"{where}: only Now, Next and Later items are ongoing") + if item.get("focus") and status != "now": + problems.append(f"{where}: only Now items can be in focus") + links = item.get("links", []) + if not isinstance(links, list): + problems.append(f"{where}: links is a list") + links = [] + if not links and status != "later": + problems.append(f"{where}: needs at least one link (an issue, a pull request or a doc)") + for link in links: + if ISSUE.match(link) or link.startswith("https://"): + continue + if link.startswith(("/", "http:")) or ".." in link or not (root / link).exists(): + problems.append(f"{where}: link {link!r} is neither #N, https:// nor a path in the repository") + focus = sum(1 for item in items if item.get("focus")) + low, high = FOCUS_RANGE + if not low <= focus <= high: + problems.append(f"focus: {focus} items are in focus, the overview wants {low} to {high}") + return problems + + +def areas_in_order(data): + return [(area["id"], area["name"]) for area in data.get("area", [])] + + +def by_area(data, status): + """The items of a status, grouped by area in the areas' order, each group in the file's order.""" + items = [item for item in data.get("item", []) if item.get("status") == status] + return [(name, [item for item in items if item["area"] == key]) + for key, name in areas_in_order(data) if any(item["area"] == key for item in items)] + + +def linkify(text, links=()): + """Markdown links for the text's #N, and for the item's own paths and URLs where the text names them.""" + text = re.sub(r"(?", + "", + "What is being done on Horizon, what comes next and where you can help. There are no dates: things are" + " Now, Next or Later. Each item is said in plain words, with the technical picture folded under it." + f" The same roadmap, with a Simple / Technical switch, the board, the journal and how to help, is on" + f" [playhorizon.dev/hub]({SITE}). Pull requests carry the `roadmap:` label of their item.", + "", + "## At a glance", + "", + overview["today_plain"].strip(), + "", + "**Being done now**", + "", + ] + out += [f"- **{item['title']}**: {item['plain'].strip()}" for item in items if item.get("focus")] + nexts = [item["title"] for item in items if item.get("status") == "next"] + if nexts: + out += ["", "**Next**: " + "; ".join(nexts) + "."] + out += ["", f"**How to help**: {overview['help_plain'].strip()}", "", + f"**Developers**: {overview['help_dev'].strip()}"] + for status, heading in STATUSES.items(): + groups = by_area(data, status) + if not groups: + continue + out += ["", f"## {heading}"] + if status == "shipped": + # Newest first: the file's order, where `sync` puts each newly shipped item on top. + out += [""] + [f"- **{item['title']}** ({item['shipped_in']}): {item['plain'].strip()} " + f"{link_list(item['links'])}" for item in items if item.get("status") == status] + continue + for area, group in groups: + out += ["", f"### {area}"] + for item in group: + out += ["", f"#### {item['title']}", "", item["plain"].strip(), "", + "
Technical", "", linkify(item["dev"].strip(), item.get("links", []))] + more = [link for link in item.get("links", []) if not re.search(rf"{re.escape(link)}\b", item["dev"])] + if more: + out += ["", "More: " + link_list(more)] + out += ["", "
"] + return "\n".join(out) + "\n" + + +# --- GitHub --------------------------------------------------------------------------------------------------- + +def token(): + for name in ("GITHUB_TOKEN", "GH_TOKEN"): + if os.environ.get(name): + return os.environ[name] + try: + return subprocess.run(["gh", "auth", "token"], capture_output=True, text=True, check=True).stdout.strip() + except (OSError, subprocess.CalledProcessError): + sys.exit("roadmap: reading GitHub needs GITHUB_TOKEN, GH_TOKEN or `gh auth login` (or use --offline)") + + +def numbers_in(data): + return sorted({int(ISSUE.match(link)[1]) for item in data.get("item", []) + for link in item.get("links", []) if ISSUE.match(link)}) + + +def github_states(numbers, auth): + """{number: {"kind": "Issue" | "PullRequest", "state", "merged_at", "merge_commit", "paths"}} for those + that exist, in one GraphQL request per hundred numbers.""" + owner, name = REPO.split("/") + states = {} + for start in range(0, len(numbers), 100): + fields = "\n".join( + f"n{n}: issueOrPullRequest(number: {n}) {{ __typename " + "... on Issue { state } " + "... on PullRequest { state mergedAt mergeCommit { oid } files(first: 100) { nodes { path } } " + "labels(first: 50) { nodes { name } } } }" + for n in numbers[start:start + 100]) + query = f'query {{ repository(owner: "{owner}", name: "{name}") {{ {fields} }} }}' + request = urllib.request.Request( + "https://api.github.com/graphql", data=json.dumps({"query": query}).encode(), + headers={"Authorization": f"bearer {auth}", "User-Agent": "horizon-roadmap"}) + with urllib.request.urlopen(request, timeout=30) as response: + answer = json.load(response) + for key, node in (answer.get("data", {}).get("repository") or {}).items(): + if node: + states[int(key[1:])] = { + "kind": node["__typename"], + "state": node["state"], + "merged_at": node.get("mergedAt"), + "merge_commit": (node.get("mergeCommit") or {}).get("oid"), + "paths": [file["path"] for file in ((node.get("files") or {}).get("nodes") or [])], + "labels": [label["name"] for label in ((node.get("labels") or {}).get("nodes") or [])], + } + return states + + +def pull_requests(item, states): + return [states[n] for n in (int(ISSUE.match(link)[1]) for link in item.get("links", []) if ISSUE.match(link)) + if n in states and states[n]["kind"] == "PullRequest"] + + +def open_issues(item, states): + return [n for n in (int(ISSUE.match(link)[1]) for link in item.get("links", []) if ISSUE.match(link)) + if n in states and states[n]["kind"] == "Issue" and states[n]["state"] == "OPEN"] + + +def online_problems(data, states, now): + """What only GitHub can tell: links that don't exist, Now items nobody works on, Help wanted items already + done, items `sync` would ship.""" + problems, notes = [], [] + recent = now - datetime.timedelta(days=STALE_DAYS) + for item in data.get("item", []): + where = f"item {item['id']}" + for link in item.get("links", []): + match = ISSUE.match(link) + if match and int(match[1]) not in states: + problems.append(f"{where}: {link} is neither an issue nor a pull request of {REPO}") + pulls = pull_requests(item, states) + status = item.get("status") + if status == "now": + alive = [p for p in pulls if p["state"] == "OPEN" or + (p["merged_at"] and datetime.datetime.fromisoformat(p["merged_at"]) >= recent)] + if not alive: + problems.append(f"{where}: stale: Now, but no open pull request and none merged in the last " + f"{STALE_DAYS} days (link the work, or move it to Next or Later)") + if status == "help-wanted": + issues = [states[int(ISSUE.match(link)[1])] for link in item.get("links", []) + if ISSUE.match(link) and int(ISSUE.match(link)[1]) in states] + if issues and all(i["state"] != "OPEN" for i in issues): + problems.append(f"{where}: every linked issue and pull request is closed: ship or drop it") + if status != "shipped" and pulls and all(p["state"] == "MERGED" for p in pulls): + if item.get("ongoing"): + notes.append(f"{where}: ongoing, and all its pull requests merged: link the new ones") + elif not open_issues(item, states): + notes.append(f"{where}: all its pull requests merged: `python3 tools/roadmap.py sync` ships it " + "once a release has them") + return problems, notes + + +# --- sync ----------------------------------------------------------------------------------------------------- + +def family(paths): + """Which releases carry a change: the launcher's, the website (deployed from main) or the game's.""" + if paths and all(path.startswith("launcher/") for path in paths): + return "launcher" + if paths and all(path.startswith("website/") for path in paths): + return "website" + return "game" + + +def first_release(commit, kind): + """The oldest release tag of this kind that contains the commit, or None while none does.""" + if kind == "website": + return "website" + tags = subprocess.run(["git", "tag", "--contains", commit, "--sort=creatordate"], cwd=ROOT, + capture_output=True, text=True).stdout.split() + wanted = (lambda tag: tag.startswith(("launcher@", "launcher-v"))) if kind == "launcher" else \ + (lambda tag: re.match(r"v\d", tag)) + return next((tag for tag in tags if wanted(tag)), None) + + +def release_of(pulls): + """The release that shipped the last of these merged pull requests, or None.""" + kinds = {family(p["paths"]) for p in pulls} + kind = "game" if "game" in kinds or len(kinds) > 1 else kinds.pop() + latest = max(pulls, key=lambda p: p["merged_at"]) + return first_release(latest["merge_commit"], kind) if latest["merge_commit"] else None + + +def item_span(lines, ident): + """[start, end) of the item's lines: its [[item]] header to its last key, without the comments that follow.""" + starts = [i for i, line in enumerate(lines) if line.strip() == "[[item]]"] + for position, start in enumerate(starts): + end = starts[position + 1] if position + 1 < len(starts) else len(lines) + if not any(re.match(rf'id\s*=\s*"{re.escape(ident)}"\s*$', line) for line in lines[start:end]): + continue + while end > start and (not lines[end - 1].strip() or re.match(r"#(\s|-|$)", lines[end - 1])): + end -= 1 + return start, end + raise KeyError(ident) + + +def mark_shipped(text, ident, release): + """The TOML with this item shipped in `release`, moved to the top of the shipped items (newest first).""" + lines = text.split("\n") + start, end = item_span(lines, ident) + block = [line for line in lines[start:end] if not line.startswith("shipped_in")] + block = [f'status = "shipped"\nshipped_in = "{release}"' if re.match(r"status\s*=", line) else line + for line in block] + block = [line for line in block if not re.match(r"focus\s*=", line)] + rest = lines[:start] + lines[end:] + # Drop the blank line the block leaves behind. + if start < len(rest) and start > 0 and not rest[start - 1].strip() and not rest[start].strip(): + del rest[start] + shipped = [i for i, line in enumerate(rest) if re.match(r'status\s*=\s*"shipped"', line)] + if shipped: + header = max(i for i in range(shipped[0] + 1) if rest[i].strip() == "[[item]]") + rest[header:header] = block + [""] + else: + rest += [""] + block + return "\n".join(rest) + + +def sync(data, text, states): + """Ship every item whose linked pull requests all went out in a release and whose linked issues are all + closed, unless it is ongoing. Returns the new text and what happened.""" + log = [] + for item in data.get("item", []): + if item.get("status") == "shipped": + continue + pulls = pull_requests(item, states) + # An ongoing item, or one with an open issue, still has work left whatever its pull requests say. + if item.get("ongoing") or open_issues(item, states): + continue + if not pulls or any(p["state"] != "MERGED" for p in pulls): + continue + release = release_of(pulls) + if release is None: + log.append(f"{item['id']}: merged, waiting for a release") + continue + text = mark_shipped(text, item["id"], release) + log.append(f"{item['id']}: shipped in {release}") + return text, log + + +# --- labels --------------------------------------------------------------------------------------------------- + +def label_of(item): + """The GitHub label of an item: its name, colour and description (GitHub allows 100 characters).""" + description = f"Roadmap, {STATUSES[item['status']].lower()}: {item['title']}" + return {"name": LABEL_PREFIX + item["id"], "color": LABEL_COLOURS[item["status"]], "description": description[:100]} + + +def label_changes(data, existing, states): + """What `labels` does: [(action, label or number, payload)] for labels to create or update, and open pull + requests linked from an item that lack its label. existing: {name: {"color", "description"}}; states as + github_states, plus each pull request's "labels".""" + changes = [] + for item in data.get("item", []): + label = label_of(item) + have = existing.get(label["name"]) + if have is None: + changes.append(("create", label["name"], label)) + elif (have.get("color", "").lower(), have.get("description") or "") != (label["color"], label["description"]): + changes.append(("update", label["name"], label)) + for link in item.get("links", []): + match = ISSUE.match(link) + state = states.get(int(match[1])) if match else None + if state and state["kind"] == "PullRequest" and state["state"] == "OPEN" and \ + label["name"] not in state.get("labels", []): + changes.append(("add", int(match[1]), label["name"])) + stale = sorted(set(existing) - {LABEL_PREFIX + item["id"] for item in data.get("item", [])}) + return changes, [name for name in stale if name.startswith(LABEL_PREFIX)] + + +def github_rest(method, path, auth, body=None): + request = urllib.request.Request( + f"https://api.github.com{path}", method=method, data=None if body is None else json.dumps(body).encode(), + headers={"Authorization": f"bearer {auth}", "Accept": "application/vnd.github+json", + "User-Agent": "horizon-roadmap"}) + with urllib.request.urlopen(request, timeout=30) as response: + return json.load(response) if response.status != 204 else None + + +def existing_labels(auth): + labels, page = {}, 1 + while True: + batch = github_rest("GET", f"/repos/{REPO}/labels?per_page=100&page={page}", auth) + labels.update({label["name"]: label for label in batch}) + if len(batch) < 100: + return labels + page += 1 + + +# --- commands ------------------------------------------------------------------------------------------------- + +def report(problems): + for problem in problems: + print(f"roadmap: {problem}", file=sys.stderr) + return 1 if problems else 0 + + +def command_build(args): + data = load() + problems = validate(data) + if problems: + return report(problems) + markdown = render(data) + if args.check: + if not OUTPUT.exists() or OUTPUT.read_text() != markdown: + return report(["ROADMAP.md is out of date: run `python3 tools/roadmap.py build`"]) + return 0 + OUTPUT.write_text(markdown) + print(f"roadmap: wrote {OUTPUT.relative_to(ROOT)}") + return 0 + + +def command_check(args): + data = load() + problems = validate(data) + if not problems and not args.offline: + states = github_states(numbers_in(data), token()) + online, notes = online_problems(data, states, datetime.datetime.now(datetime.timezone.utc)) + problems += online + for note in notes: + print(f"roadmap: {note}") + if not problems: + print(f"roadmap: {len(data.get('item', []))} items, all good") + return report(problems) + + +def command_sync(args): + data = load() + problems = validate(data) + if problems: + return report(problems) + subprocess.run(["git", "fetch", "--quiet", "--tags", "origin"], cwd=ROOT, check=False) + text, log = sync(data, SOURCE.read_text(), github_states(numbers_in(data), token())) + for line in log: + print(f"roadmap: {line}") + if args.dry_run or text == SOURCE.read_text(): + return 0 + new = tomllib.loads(text) + if len(new.get("item", [])) != len(data.get("item", [])) or validate(new): + return report(["sync produced an invalid file; nothing written"] + validate(new)) + SOURCE.write_text(text) + OUTPUT.write_text(render(new)) + print("roadmap: wrote roadmap/roadmap.toml and ROADMAP.md") + return 0 + + +def command_labels(args): + data = load() + problems = validate(data) + if problems: + return report(problems) + auth = token() + changes, stale = label_changes(data, existing_labels(auth), github_states(numbers_in(data), auth)) + for action, target, payload in changes: + print(f"roadmap: {action} {target}" + (f" ({payload})" if action == "add" else "")) + if args.dry_run: + continue + if action == "create": + github_rest("POST", f"/repos/{REPO}/labels", auth, payload) + elif action == "update": + github_rest("PATCH", f"/repos/{REPO}/labels/{urllib.parse.quote(target, safe='')}", auth, + {"color": payload["color"], "description": payload["description"]}) + else: + github_rest("POST", f"/repos/{REPO}/issues/{target}/labels", auth, {"labels": [payload]}) + for name in stale: + print(f"roadmap: {name} names no item any more: rename or delete it by hand (it stays on its pull requests)") + if not changes: + print("roadmap: labels up to date") + return 0 + + +def main(argv=None): + parser = argparse.ArgumentParser(description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter) + commands = parser.add_subparsers(dest="command", required=True) + build = commands.add_parser("build", help="write ROADMAP.md") + build.add_argument("--check", action="store_true", help="fail when ROADMAP.md is out of date") + check = commands.add_parser("check", help="the roadmap's rules, and GitHub's state of its links") + check.add_argument("--offline", action="store_true", help="skip GitHub") + sync_command = commands.add_parser("sync", help="ship the items whose pull requests all merged") + sync_command.add_argument("--dry-run", action="store_true", help="say what would change, write nothing") + labels = commands.add_parser("labels", help="a roadmap: label per item, on its linked open pull requests") + labels.add_argument("--dry-run", action="store_true", help="say what would change, change nothing") + args = parser.parse_args(argv) + return {"build": command_build, "check": command_check, "sync": command_sync, + "labels": command_labels}[args.command](args) + + +if __name__ == "__main__": + sys.exit(main()) From 98bebd26bdc33efaa4483ac5d5cbb07250fc1345 Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Sun, 25 Oct 2026 15:14:48 +0100 Subject: [PATCH 08/26] Launcher: one place reads the pinned appearance (theme::pinned_dark) The title bar and the theme both resolved HORIZON_LAUNCHER_APPEARANCE and the Settings choice; titlebar::apply_appearance now uses the theme's helper. Co-Authored-By: Claude Opus 5.5 --- launcher/src/theme.rs | 39 +++++++++++++++++++++++++-------------- launcher/src/titlebar.rs | 21 +++++++-------------- 2 files changed, 32 insertions(+), 28 deletions(-) diff --git a/launcher/src/theme.rs b/launcher/src/theme.rs index 60b796709..9d495a598 100644 --- a/launcher/src/theme.rs +++ b/launcher/src/theme.rs @@ -74,22 +74,33 @@ fn c(hex: u32) -> Hsla { rgb(hex).into() } +/// Whether the launcher is pinned dark (`Some(true)`) or light, or follows the system (`None`): +/// `HORIZON_LAUNCHER_APPEARANCE=light` or `dark` (for screenshots and tests), else the player's +/// choice in Settings. +pub fn pinned_dark(choice: Appearance) -> Option { + match std::env::var("HORIZON_LAUNCHER_APPEARANCE").as_deref() { + Ok("light") => Some(false), + Ok("dark") => Some(true), + _ => match choice { + Appearance::Dark => Some(true), + Appearance::Light => Some(false), + Appearance::System => None, + }, + } +} + impl Theme { - /// The player's choice in Settings (dark unless they picked another), the system's when they - /// asked to follow it. `HORIZON_LAUNCHER_APPEARANCE=light` or `dark` overrides both (for - /// screenshots and tests). + /// The pinned look (`pinned_dark`: dark unless the player picked another), the system's when + /// they asked to follow it. pub fn for_appearance(choice: Appearance, system: WindowAppearance) -> Self { - match std::env::var("HORIZON_LAUNCHER_APPEARANCE").as_deref() { - Ok("light") => return Self::light(), - Ok("dark") => return Self::dark(), - _ => {} - } - match (choice, system) { - (Appearance::Light, _) => Self::light(), - (Appearance::System, WindowAppearance::Light | WindowAppearance::VibrantLight) => { - Self::light() - } - _ => Self::dark(), + let system_dark = !matches!( + system, + WindowAppearance::Light | WindowAppearance::VibrantLight + ); + if pinned_dark(choice).unwrap_or(system_dark) { + Self::dark() + } else { + Self::light() } } diff --git a/launcher/src/titlebar.rs b/launcher/src/titlebar.rs index 2e6445091..a023f7d7d 100644 --- a/launcher/src/titlebar.rs +++ b/launcher/src/titlebar.rs @@ -22,9 +22,8 @@ pub fn render(_theme: &Theme, _window: &Window) -> Option
{ /// macOS keeps the window's appearance on the system setting, so a launcher set to Dark still /// draws a light title bar on a light desktop. Pin the NSWindow's appearance to the choice -/// instead (`System` clears the pin, handing the chrome back to the system), honouring the same -/// `HORIZON_LAUNCHER_APPEARANCE` override the theme does. Other platforms' chrome already -/// follows the setting (ours is drawn, Windows and Linux follow the system either way). +/// instead (`theme::pinned_dark`: `System` clears the pin, handing the chrome back to the +/// system). Elsewhere the chrome is ours (Windows) or the system's (Linux). #[cfg(target_os = "macos")] pub fn apply_appearance(window: &Window, choice: Appearance) { use objc2_app_kit::{ @@ -33,17 +32,11 @@ pub fn apply_appearance(window: &Window, choice: Appearance) { }; use raw_window_handle::{HasWindowHandle, RawWindowHandle}; - // Reading AppKit's name constants is unsafe to rustc only (`use of extern static`). - let name: Option<&'static NSAppearanceName> = unsafe { - match std::env::var("HORIZON_LAUNCHER_APPEARANCE").as_deref() { - Ok("light") => Some(NSAppearanceNameAqua), - Ok("dark") => Some(NSAppearanceNameDarkAqua), - _ => match choice { - Appearance::Dark => Some(NSAppearanceNameDarkAqua), - Appearance::Light => Some(NSAppearanceNameAqua), - Appearance::System => None, - }, - } + // AppKit's name constants are extern statics: reading them is `unsafe` to rustc only. + let name: Option<&'static NSAppearanceName> = match crate::theme::pinned_dark(choice) { + Some(true) => Some(unsafe { NSAppearanceNameDarkAqua }), + Some(false) => Some(unsafe { NSAppearanceNameAqua }), + None => None, }; // The trait, not `Window::window_handle` (which is gpui's own `AnyWindowHandle`). let Ok(handle) = HasWindowHandle::window_handle(window) else { From 6b97107dc7ed8cc1ce6f5d76fcf932febf8b796d Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Sun, 25 Oct 2026 14:37:02 +0100 Subject: [PATCH 09/26] Transfers: handshake with the TRANSFER intent, answer login cookie requests Vanilla 26.3 reconnects after ClientboundTransferPacket with a TransferState, so Connection.initiateServerboundPlayConnection sends ClientIntent.TRANSFER (3): a target with accepts-transfers=false refuses the player, and the target can ask for the carried cookies during login (ClientHandshakePacketListenerImpl.handleRequestCookie). Both now match. A transfer from single player closes the world instead of connecting elsewhere (handleTransfer: "Cannot transfer to server from singleplayer"). Adds a unit test for the play-state store/request round trip and the Transfer event. Co-Authored-By: Claude Opus 5.5 --- crates/horizon-client/src/game/remote.rs | 6 +- crates/horizon-client/src/net.rs | 78 +++++++++++++++++++++++- 2 files changed, 81 insertions(+), 3 deletions(-) diff --git a/crates/horizon-client/src/game/remote.rs b/crates/horizon-client/src/game/remote.rs index c10b64c54..d70c0a4ae 100644 --- a/crates/horizon-client/src/game/remote.rs +++ b/crates/horizon-client/src/game/remote.rs @@ -893,8 +893,12 @@ impl Game<'_> { } } Event::Reconfigured(registries) => self.set_registries(registries), + // handleTransfer: "Cannot transfer to server from + // singleplayer" (no ServerData), so the world just closes. Event::Transfer { host, port } => { - if let Some(r) = self.remote.as_mut() { + if let Some(r) = self.remote.as_mut() + && r.session.address != "local" + { r.transfer = Some(format!("{host}:{port}")); } } diff --git a/crates/horizon-client/src/net.rs b/crates/horizon-client/src/net.rs index c4e53cef4..18aec0bea 100644 --- a/crates/horizon-client/src/net.rs +++ b/crates/horizon-client/src/net.rs @@ -139,6 +139,9 @@ impl Session { let writer = Arc::new(Mutex::new(None)); let configuring = Arc::new(AtomicBool::new(true)); let counters = Arc::new(Mutex::new(None)); + // Connection.initiateServerboundPlayConnection: a transfer's + // handshake says so (ClientIntent.TRANSFER). + let transferred = cookies.is_some(); let cookies = cookies.unwrap_or_default(); let (thread_writer, thread_counters, thread_cookies) = (writer.clone(), counters.clone(), cookies.clone()); @@ -159,6 +162,7 @@ impl Session { &thread_configuring, &thread_counters, &thread_cookies, + transferred, ); let from_server = result.is_ok(); let reason = result.unwrap_or_else(|e| e); @@ -333,6 +337,7 @@ fn run( configuring: &AtomicBool, shared_counters: &Mutex>>, cookies: &Cookies, + transferred: bool, ) -> Result { let (host, port, mut c) = if let Some(pipe) = local { (address.to_owned(), 0, Connection::local(pipe)) @@ -363,7 +368,11 @@ fn run( protocol: PROTOCOL_VERSION, host: host.clone(), port, - intent: handshake::LOGIN, + intent: if transferred { + handshake::TRANSFER + } else { + handshake::LOGIN + }, }) .encode(), ) @@ -433,11 +442,14 @@ fn run( ) .map_err(e)?; } + // ClientHandshakePacketListenerImpl.handleRequestCookie: the + // cookies a transfer carried over (none on a plain join). login::Clientbound::CookieRequest(q) => { + let payload = cookies.lock().unwrap().get(&q.key).cloned(); c.send( &login::Serverbound::CookieResponse(login::CookieResponse { key: q.key, - payload: None, + payload, }) .encode(), ) @@ -829,6 +841,68 @@ mod tests { assert!(thread.join().unwrap().is_err()); } + #[test] + fn play_answers_cookie_requests_from_stored_cookies_and_follows_transfers() { + let (client, server) = horizon_protocol::connection::Pipe::pair(); + let (mut reader, writer) = Connection::local(client).split(); + let writer = Arc::new(Mutex::new(Some(writer))); + let (send, events) = channel(); + let cookies = Cookies::default(); + let (thread_writer, thread_cookies) = (writer.clone(), cookies.clone()); + let thread = std::thread::spawn(move || { + receive_play( + &mut reader, + &thread_writer, + &AtomicBool::new(false), + &Language::new(), + &send, + &thread_cookies, + ) + }); + let mut server = Connection::local(server); + let ask = |server: &mut Connection, key: &str| { + let request = play::Clientbound::CookieRequest(cfg::CookieRequest { key: key.into() }); + server.send(&request.encode()).unwrap(); + let (id, body) = server.recv().unwrap(); + play::Serverbound::decode(id, &body).unwrap() + }; + // handleRequestCookie answers an unknown key with no payload. + assert_eq!( + ask(&mut server, "proxy:session"), + play::Serverbound::CookieResponse(cfg::CookieResponse { + key: "proxy:session".into(), + payload: None, + }) + ); + let store = play::Clientbound::StoreCookie(cfg::StoreCookie { + key: "proxy:session".into(), + payload: vec![1, 2, 3], + }); + server.send(&store.encode()).unwrap(); + assert_eq!( + ask(&mut server, "proxy:session"), + play::Serverbound::CookieResponse(cfg::CookieResponse { + key: "proxy:session".into(), + payload: Some(vec![1, 2, 3]), + }) + ); + let transfer = play::Clientbound::Transfer(cfg::Transfer { + host: "example.net".into(), + port: 25566, + }); + server.send(&transfer.encode()).unwrap(); + assert!(thread.join().unwrap().is_ok()); + assert!(matches!( + events.try_iter().last(), + Some(Event::Transfer { host, port: 25566 }) if host == "example.net" + )); + // The stored cookie stays for the next connection (TransferState). + assert_eq!( + cookies.lock().unwrap().get("proxy:session"), + Some(&vec![1, 2, 3]) + ); + } + #[test] fn server_brand_payload_is_decoded_and_invalid_or_unrelated_payloads_are_ignored() { let (send, events) = channel(); From 5d40d6a33ea36d07440d4eecf03ab63028eff3f6 Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Sun, 25 Oct 2026 15:54:39 +0100 Subject: [PATCH 10/26] Telemetry server: the hub's votes (POST /hub/vote, GET /hub/votes) A thumbs-up on a roadmap item at playhorizon.dev/hub: one per browser (a random id the page keeps), taken back with "up": false, counts cached a minute. Item ids are checked for shape and capped at 1000 distinct items. Rate limits key their buckets by a keyed hash of the address (key drawn at start, in memory); no address is stored. CORS preflight for the website's JSON posts. Co-Authored-By: Claude Opus 5.5 --- crates/horizon-telemetry-server/README.md | 7 +- crates/horizon-telemetry-server/src/hub.rs | 239 +++++++++++++++++++ crates/horizon-telemetry-server/src/lib.rs | 29 ++- crates/horizon-telemetry-server/src/store.rs | 3 +- crates/horizon-telemetry-server/tests/hub.rs | 116 +++++++++ 5 files changed, 388 insertions(+), 6 deletions(-) create mode 100644 crates/horizon-telemetry-server/src/hub.rs create mode 100644 crates/horizon-telemetry-server/tests/hub.rs diff --git a/crates/horizon-telemetry-server/README.md b/crates/horizon-telemetry-server/README.md index ed54024a1..2b86bf99d 100644 --- a/crates/horizon-telemetry-server/README.md +++ b/crates/horizon-telemetry-server/README.md @@ -1,6 +1,6 @@ # horizon-telemetry-server -This server receives what players choose to send (performance summaries, crash and bug reports, benchmark uploads: [docs/telemetry.md](../../docs/telemetry.md)) and stores it in one SQLite file. It serves anonymous totals to the website. It also keeps the live player count from the games' anonymous "I'm playing" pings, in memory only. It is one small Rust process, about 7 MB of memory when idle. +This server receives what players choose to send (performance summaries, crash and bug reports, benchmark uploads: [docs/telemetry.md](../../docs/telemetry.md)) and stores it in one SQLite file. It serves anonymous totals to the website. It also keeps the live player count from the games' anonymous "I'm playing" pings, in memory only, and the 👍 players give roadmap items on the hub (playhorizon.dev/hub). It is one small Rust process, about 7 MB of memory when idle. cargo run --release # in this folder: its own workspace, like the launcher's PORT=8080 HORIZON_TELEMETRY_DB=/data/telemetry.sqlite3 horizon-telemetry-server @@ -17,6 +17,8 @@ It runs at **https://telemetry.playhorizon.dev** (`DEFAULT_ENDPOINT` in `crates/ | `GET /v1/benchmarks/summary` | Players' benchmark uploads grouped by GPU, CPU, render distance and game, for the website's Benchmarks page (below). Cached 10 minutes, same `Access-Control-Allow-Origin`. | | `POST /v1/live` | A game's "I'm playing" ping (JSON, at most 512 bytes). Returns 204. Returns 400 for a bad ping, 413 for one too large, 429 over the address's limit, 503 when it holds `LIVE_MAX_SESSIONS` already. | | `GET /v1/live` | How many play now, rounded: `playing`, `lan`, `versions`, `platforms`. Made again at most every 15 seconds, with the same `Access-Control-Allow-Origin`. | +| `POST /hub/vote` | `{"item": "", "voter": "", "up": true}`: a 👍 on a roadmap item, one per voter; `"up": false` takes it back. Returns `{"item", "votes"}`. 400 for a bad id, 429 over the address's limit. `OPTIONS` answers the website's preflight. | +| `GET /hub/votes` | `{"votes": {"": n}}`. Made again at most every minute. | | `GET /healthz` | `ok` | The totals are grouped per version, OS, GPU vendor and render distance. Each group has its sessions, install-days, hours played, the 14 frame-time buckets summed, and the mean p50 and p99 frame times. Groups with fewer than 5 install-days are left out. The totals also list crash counts per version. Benchmark uploads are published only through the summary below, never one by one. @@ -56,6 +58,8 @@ The live count is a table in memory: a session ID, when it last pinged, its vers The day stored is the day the server received an item. The sender's IP address is never written down. The per-address rate limit keeps addresses in memory for an hour at most. +A hub vote is stored as an item ID and the browser's random ID. The hub's rate limits key their buckets by a hash of the address with a key drawn at each start, in memory. + Raw rows are deleted after `HORIZON_TELEMETRY_RETENTION_DAYS` (180). The daily totals stay; they hold no install ID. ## Settings @@ -73,6 +77,7 @@ All are environment variables: - `HORIZON_TELEMETRY_LIVE_PER_HOUR` per address, pings and reads (600, bursts of 60: ten players behind one address) - `HORIZON_TELEMETRY_LIVE_WINDOW_SECONDS` (120) - `HORIZON_TELEMETRY_LIVE_MAX_SESSIONS` (200 000) +- `HORIZON_TELEMETRY_HUB_PER_HOUR` votes and vote reads per address (120, bursts of 12) ## Hosting diff --git a/crates/horizon-telemetry-server/src/hub.rs b/crates/horizon-telemetry-server/src/hub.rs new file mode 100644 index 000000000..ebf22610d --- /dev/null +++ b/crates/horizon-telemetry-server/src/hub.rs @@ -0,0 +1,239 @@ +//! The hub's votes: a 👍 on a roadmap item at playhorizon.dev/hub. roadmap/README.md documents them for Kira and the website. +//! +//! - `POST /hub/vote`: a 👍 on a roadmap item, one per browser (`voter`, a random id the page makes and +//! keeps); `"up": false` takes it back. Answers the item's count. +//! - `GET /hub/votes`: every item's count, cached a minute. +//! +//! Stored: an item id and the browser's random id per vote. Never an IP address: the rate limits key their +//! buckets by a hash of it with a key drawn at start, in memory. +use std::collections::HashMap; +use std::hash::BuildHasher; +use std::sync::Arc; +use std::time::{Duration, Instant}; + +use axum::extract::{Request, State}; +use axum::http::{HeaderValue, StatusCode, header}; +use axum::response::Response; +use rusqlite::params; +use serde_json::{Map, Value, json}; + +use crate::store::Store; +use crate::{App, json_response, peer, take}; + +pub const SCHEMA: &str = " +CREATE TABLE IF NOT EXISTS hub_votes (item TEXT NOT NULL, voter TEXT NOT NULL, PRIMARY KEY (item, voter)) WITHOUT ROWID; +"; + +/// Items with votes, at most: a vote for a new id past this is refused (ids are only checked for shape). +const MAX_ITEMS: i64 = 1000; +/// The largest body accepted: a report's fields at their limits, as JSON, fit. +const MAX_BODY: usize = 24 * 1024; +const VOTES_FOR: Duration = Duration::from_secs(60); + +/// The hub's buckets: keyed by a keyed hash of the address, never the address itself. +pub type HashedBuckets = HashMap; + +/// A roadmap item id's shape: lowercase words joined by dashes (tools/roadmap.py), at most 48 characters. +pub fn item_id(id: &str) -> bool { + (1..=48).contains(&id.len()) + && !id.starts_with('-') + && !id.ends_with('-') + && !id.contains("--") + && id + .bytes() + .all(|b| b.is_ascii_lowercase() || b.is_ascii_digit() || b == b'-') +} + +/// A voter id's shape: what `crypto.randomUUID()` and similar make. +fn voter_id(id: &str) -> bool { + (16..=64).contains(&id.len()) + && id + .bytes() + .all(|b| b.is_ascii_alphanumeric() || b == b'-' || b == b'_') +} + +impl Store { + /// Adds or takes back a vote; the item's count after it. None when the item would be one too many. + pub fn vote(&mut self, item: &str, voter: &str, up: bool) -> rusqlite::Result> { + let tx = self.db.transaction()?; + if up { + let known = tx + .prepare("SELECT 1 FROM hub_votes WHERE item = ?1 LIMIT 1")? + .exists([item])?; + let items: i64 = + tx.query_row("SELECT count(DISTINCT item) FROM hub_votes", [], |r| { + r.get(0) + })?; + if !known && items >= MAX_ITEMS { + return Ok(None); + } + tx.execute( + "INSERT OR IGNORE INTO hub_votes (item, voter) VALUES (?1, ?2)", + params![item, voter], + )?; + } else { + tx.execute( + "DELETE FROM hub_votes WHERE item = ?1 AND voter = ?2", + params![item, voter], + )?; + } + let count = tx.query_row( + "SELECT count(*) FROM hub_votes WHERE item = ?1", + [item], + |r| r.get(0), + )?; + tx.commit()?; + Ok(Some(count)) + } + + /// Every item's count. + pub fn votes(&self) -> rusqlite::Result> { + let mut statement = self + .db + .prepare("SELECT item, count(*) FROM hub_votes GROUP BY item ORDER BY item")?; + let rows = + statement.query_map([], |r| Ok((r.get::<_, String>(0)?, r.get::<_, i64>(1)?)))?; + rows.map(|row| row.map(|(item, n)| (item, Value::from(n)))) + .collect() + } +} + +impl App { + pub(crate) fn hashed(&self, req: &Request) -> u64 { + self.hub_key.hash_one(self.client(req.headers(), peer(req))) + } + + /// Takes a token from the address's hub bucket (votes and reads of the counts). + fn allow_hub(&self, req: &Request) -> bool { + take( + &self.hub_buckets, + self.config.hub_per_hour, + self.hashed(req), + ) + } + + /// The hub's share of `maintain`: idle buckets are forgotten. + pub(crate) fn forget_hub_buckets(&self) { + self.hub_buckets + .lock() + .unwrap_or_else(|e| e.into_inner()) + .retain(|_, (_, at)| at.elapsed() < Duration::from_secs(3600)); + } +} + +/// A JSON answer to the website: its origin may read it, nothing caches it. +pub(crate) fn answer(app: &App, code: StatusCode, body: Value) -> Response { + let mut response = json_response(app, body.to_string(), 0); + *response.status_mut() = code; + response + .headers_mut() + .insert(header::CACHE_CONTROL, HeaderValue::from_static("no-store")); + response +} + +pub(crate) fn refuse(app: &App, code: StatusCode, message: &str) -> Response { + answer(app, code, json!({ "error": message })) +} + +/// A browser's preflight for the JSON posts: the website may post them. +pub async fn preflight(State(app): State>) -> Response { + let mut response = answer(&app, StatusCode::NO_CONTENT, Value::Null); + *response.body_mut() = axum::body::Body::empty(); + let headers = response.headers_mut(); + headers.remove(header::CONTENT_TYPE); + headers.insert( + header::ACCESS_CONTROL_ALLOW_METHODS, + HeaderValue::from_static("POST"), + ); + headers.insert( + header::ACCESS_CONTROL_ALLOW_HEADERS, + HeaderValue::from_static("content-type"), + ); + headers.insert( + header::ACCESS_CONTROL_MAX_AGE, + HeaderValue::from_static("86400"), + ); + response +} + +pub(crate) async fn json_body(req: Request) -> Result { + let bytes = axum::body::to_bytes(req.into_body(), MAX_BODY) + .await + .map_err(|_| "too large")?; + serde_json::from_slice(&bytes).map_err(|_| "send JSON") +} + +/// `POST /hub/vote` `{"item", "voter", "up"}`: 200 `{"item", "votes"}`. +pub async fn vote(State(app): State>, req: Request) -> Response { + if !app.allow_hub(&req) { + return refuse(&app, StatusCode::TOO_MANY_REQUESTS, "too many requests"); + } + let body = match json_body(req).await { + Ok(body) => body, + Err(e) => return refuse(&app, StatusCode::BAD_REQUEST, e), + }; + let item = body["item"].as_str().unwrap_or(""); + let voter = body["voter"].as_str().unwrap_or(""); + if !item_id(item) || !voter_id(voter) { + return refuse(&app, StatusCode::BAD_REQUEST, "an item id and a voter id"); + } + let up = body["up"].as_bool().unwrap_or(true); + let counted = app.store().vote(item, voter, up); + match counted { + Ok(Some(votes)) => { + *app.votes_cache.lock().unwrap_or_else(|e| e.into_inner()) = None; + answer( + &app, + StatusCode::OK, + json!({ "item": item, "votes": votes }), + ) + } + Ok(None) => refuse(&app, StatusCode::BAD_REQUEST, "no such item"), + Err(e) => { + eprintln!("horizon-telemetry-server: could not store a vote: {e}"); + refuse(&app, StatusCode::SERVICE_UNAVAILABLE, "try again later") + } + } +} + +/// `GET /hub/votes`: `{"votes": {"": n}}`, made again at most every minute. +pub async fn votes(State(app): State>, req: Request) -> Response { + if !app.allow_hub(&req) { + return refuse(&app, StatusCode::TOO_MANY_REQUESTS, "too many requests"); + } + let json = { + let mut cache = app.votes_cache.lock().unwrap_or_else(|e| e.into_inner()); + match &*cache { + Some((at, json)) if at.elapsed() < VOTES_FOR => json.clone(), + _ => { + let counts = app.store().votes(); + match counts { + Ok(counts) => { + let json = json!({ "votes": counts }).to_string(); + *cache = Some((Instant::now(), json.clone())); + json + } + Err(e) => { + eprintln!("horizon-telemetry-server: could not read the votes: {e}"); + return refuse(&app, StatusCode::SERVICE_UNAVAILABLE, "try again later"); + } + } + } + } + }; + json_response(&app, json, VOTES_FOR.as_secs()) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn ids_are_checked_for_shape() { + assert!(item_id("smooth-frames") && item_id("v2")); + for bad in ["", "-a", "a-", "a--b", "Smooth", "a b", &"a".repeat(49)] { + assert!(!item_id(bad), "{bad}"); + } + assert!(voter_id("0b7c3c9e-3f0a-4d8e-9a39-4c1f5a6b7d21") && !voter_id("short")); + } +} diff --git a/crates/horizon-telemetry-server/src/lib.rs b/crates/horizon-telemetry-server/src/lib.rs index 1a8e750e6..19ba3e1dc 100644 --- a/crates/horizon-telemetry-server/src/lib.rs +++ b/crates/horizon-telemetry-server/src/lib.rs @@ -7,6 +7,7 @@ //! least 3 installs only (`summary`), cached; the website's Benchmarks page reads it. //! - `POST /v1/live`: a game's anonymous "I'm playing" ping (`live`, in memory only). //! - `GET /v1/live`: how many play now, rounded, cached briefly. +//! - `POST /hub/vote`, `GET /hub/votes`: the hub's 👍 on roadmap items (`hub`). //! - `GET /healthz`. //! //! Abuse limits: a token bucket per IP address (kept in memory for an hour, never stored), a @@ -15,6 +16,7 @@ //! rows expire after `retention_days`; the daily totals stay. One small process and one SQLite //! file: see `README.md` for running it. use std::collections::HashMap; +use std::hash::{Hash, RandomState}; use std::net::{IpAddr, SocketAddr}; use std::sync::{Arc, Mutex}; use std::time::{Duration, Instant}; @@ -27,6 +29,7 @@ use axum::routing::{delete, get, post}; use horizon_telemetry::batch; pub mod classes; +pub mod hub; pub mod live; pub mod store; pub mod summary; @@ -56,6 +59,8 @@ pub struct Config { pub live_window: Duration, /// Sessions the live count holds at most; a new one past that is refused. pub live_max_sessions: usize, + /// The hub's votes and reads of their counts an IP address may make an hour. + pub hub_per_hour: f64, } impl Default for Config { @@ -70,6 +75,7 @@ impl Default for Config { live_per_hour: 600.0, live_window: horizon_telemetry::live::WINDOW, live_max_sessions: 200_000, + hub_per_hour: 120.0, } } } @@ -77,7 +83,7 @@ impl Default for Config { impl Config { /// The defaults, with `HORIZON_TELEMETRY_RETENTION_DAYS`, `…_MIN_INSTALL_DAYS`, /// `…_REQUESTS_PER_HOUR`, `…_ITEMS_PER_DAY`, `…_TRUST_PROXY` (1), `…_ALLOW_ORIGIN`, - /// `…_LIVE_PER_HOUR`, `…_LIVE_WINDOW_SECONDS` and `…_LIVE_MAX_SESSIONS`. + /// `…_LIVE_PER_HOUR`, `…_LIVE_WINDOW_SECONDS`, `…_LIVE_MAX_SESSIONS` and `…_HUB_PER_HOUR`. pub fn from_env() -> Self { let var = |k: &str| std::env::var(format!("HORIZON_TELEMETRY_{k}")).ok(); let d = Self::default(); @@ -105,6 +111,9 @@ impl Config { live_max_sessions: var("LIVE_MAX_SESSIONS") .and_then(|v| v.parse().ok()) .unwrap_or(d.live_max_sessions), + hub_per_hour: var("HUB_PER_HOUR") + .and_then(|v| v.parse().ok()) + .unwrap_or(d.hub_per_hour), } } } @@ -126,6 +135,12 @@ pub struct App { summary_cache: Mutex>, /// Today, in days since 1970 (a test moves it). today: Box u32 + Send + Sync>, + /// The key the hub's buckets hash addresses with, drawn at start and never stored. + hub_key: RandomState, + /// The hub's votes and vote counts, per hashed address. + hub_buckets: Mutex, + /// `GET /hub/votes`'s answer and when it was made. + votes_cache: Mutex>, } type Buckets = HashMap; @@ -157,6 +172,9 @@ impl App { cache: Mutex::default(), summary_cache: Mutex::default(), today, + hub_key: RandomState::new(), + hub_buckets: Mutex::default(), + votes_cache: Mutex::default(), }) } @@ -221,6 +239,7 @@ impl App { pub fn maintain(&self) -> rusqlite::Result { let oldest = (self.today)().saturating_sub(self.config.retention_days); let removed = self.store().expire(oldest)?; + self.forget_hub_buckets(); for buckets in [&self.buckets, &self.live_buckets] { buckets .lock() @@ -235,14 +254,14 @@ impl App { } } -/// Takes a token for `ip` from its bucket in `buckets` (`per_hour`, bursts of a tenth of it); +/// Takes a token for `key` from its bucket in `buckets` (`per_hour`, bursts of a tenth of it); /// false when it has none left. -fn take(buckets: &Mutex, per_hour: f64, ip: IpAddr) -> bool { +fn take(buckets: &Mutex>, per_hour: f64, key: K) -> bool { let rate = per_hour / 3600.0; let burst = (per_hour / 10.0).max(1.0); let mut buckets = buckets.lock().unwrap_or_else(|e| e.into_inner()); let now = Instant::now(); - let (tokens, at) = buckets.entry(ip).or_insert((burst, now)); + let (tokens, at) = buckets.entry(key).or_insert((burst, now)); *tokens = (*tokens + now.duration_since(*at).as_secs_f64() * rate).min(burst); *at = now; if *tokens < 1.0 { @@ -482,6 +501,8 @@ pub fn router(app: Arc) -> Router { .route("/v1/installs/{id}", delete(forget)) .route("/v1/aggregate", get(aggregate)) .route("/v1/benchmarks/summary", get(benchmarks)) + .route("/hub/vote", post(hub::vote).options(hub::preflight)) + .route("/hub/votes", get(hub::votes)) .route("/healthz", get(|| async { "ok" })) .with_state(app) } diff --git a/crates/horizon-telemetry-server/src/store.rs b/crates/horizon-telemetry-server/src/store.rs index 02c8803ae..d1137d197 100644 --- a/crates/horizon-telemetry-server/src/store.rs +++ b/crates/horizon-telemetry-server/src/store.rs @@ -123,13 +123,14 @@ pub fn gpu_vendor(gpu: &str) -> &'static str { } pub struct Store { - db: Connection, + pub(crate) db: Connection, } impl Store { pub fn open(path: &str) -> rusqlite::Result { let mut db = Connection::open(path)?; db.execute_batch(SCHEMA)?; + db.execute_batch(crate::hub::SCHEMA)?; migrate(&mut db)?; Ok(Self { db }) } diff --git a/crates/horizon-telemetry-server/tests/hub.rs b/crates/horizon-telemetry-server/tests/hub.rs new file mode 100644 index 000000000..10ddc12c4 --- /dev/null +++ b/crates/horizon-telemetry-server/tests/hub.rs @@ -0,0 +1,116 @@ +//! The hub's votes through the HTTP interface. +use std::sync::Arc; + +use axum::body::Body; +use axum::http::{Request, StatusCode}; +use horizon_telemetry_server::store::Store; +use horizon_telemetry_server::{App, Config, router}; +use http_body_util::BodyExt; +use serde_json::{Value, json}; +use tower::ServiceExt; + +const DAY: u32 = 20_741; +const VOTER: &str = "0b7c3c9e-3f0a-4d8e-9a39-4c1f5a6b7d21"; + +struct Hub { + app: Arc, +} + +fn hub(config: Config) -> Hub { + let app = App::with_clock(Store::open(":memory:").unwrap(), config, Box::new(|| DAY)); + Hub { app } +} + +fn config() -> Config { + Config::default() +} + +impl Hub { + async fn send(&self, req: Request) -> (StatusCode, Value) { + let res = router(self.app.clone()).oneshot(req).await.unwrap(); + let code = res.status(); + let body = res.into_body().collect().await.unwrap().to_bytes(); + (code, serde_json::from_slice(&body).unwrap_or(Value::Null)) + } + + async fn post(&self, path: &str, body: Value) -> (StatusCode, Value) { + self.send( + Request::post(path) + .header("content-type", "application/json") + .body(Body::from(body.to_string())) + .unwrap(), + ) + .await + } + + async fn get(&self, path: &str) -> (StatusCode, Value) { + self.send(Request::get(path).body(Body::empty()).unwrap()) + .await + } +} + +#[tokio::test] +async fn votes_count_once_per_browser_and_can_be_taken_back() { + let hub = hub(config()); + let vote = |up: bool, voter: &str| json!({ "item": "smooth-frames", "voter": voter, "up": up }); + assert_eq!( + hub.post("/hub/vote", vote(true, VOTER)).await, + ( + StatusCode::OK, + json!({ "item": "smooth-frames", "votes": 1 }) + ) + ); + assert_eq!( + hub.post("/hub/vote", vote(true, VOTER)).await.1["votes"], + 1, + "a second vote changes nothing" + ); + let other = "f".repeat(32); + assert_eq!( + hub.post("/hub/vote", vote(true, &other)).await.1["votes"], + 2 + ); + assert_eq!( + hub.get("/hub/votes").await, + (StatusCode::OK, json!({ "votes": { "smooth-frames": 2 } })) + ); + assert_eq!( + hub.post("/hub/vote", vote(false, VOTER)).await.1["votes"], + 1 + ); + assert_eq!( + hub.get("/hub/votes").await.1["votes"]["smooth-frames"], + 1, + "a vote drops the cached counts" + ); + for bad in [ + json!({ "item": "Not An Id", "voter": VOTER }), + json!({ "item": "a", "voter": "short" }), + json!([]), + ] { + assert_eq!(hub.post("/hub/vote", bad).await.0, StatusCode::BAD_REQUEST); + } +} + +#[tokio::test] +async fn the_website_may_post_from_the_browser() { + let hub = hub(config()); + let res = router(hub.app.clone()) + .oneshot( + Request::options("/hub/vote") + .header("origin", "https://playhorizon.dev") + .header("access-control-request-method", "POST") + .body(Body::empty()) + .unwrap(), + ) + .await + .unwrap(); + assert_eq!(res.status(), StatusCode::NO_CONTENT); + let header = |name: &str| res.headers()[name].to_str().unwrap().to_owned(); + assert_eq!( + header("access-control-allow-origin"), + "https://playhorizon.dev" + ); + assert_eq!(header("access-control-allow-methods"), "POST"); + assert_eq!(header("access-control-allow-headers"), "content-type"); +} From a95be8a7f3de4b7bddf525ba71115ada203e68bb Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Sun, 25 Oct 2026 15:57:34 +0100 Subject: [PATCH 11/26] Roadmap: `announce = true` marks items Kira also posts on X when they ship Kira's X poster (kira #12) posts shipped items flagged announce in journal.json. Set on the five whose release is news: modpack world generation, the mod registry, Discord Rich Presence, Microsoft sign-in and CurseForge. Flags must be booleans. Co-Authored-By: Claude Opus 5.5 --- roadmap/README.md | 1 + roadmap/roadmap.toml | 5 +++++ tests/test_roadmap.py | 4 ++++ tools/roadmap.py | 6 +++++- 4 files changed, 15 insertions(+), 1 deletion(-) diff --git a/roadmap/README.md b/roadmap/README.md index df44575a5..656303464 100644 --- a/roadmap/README.md +++ b/roadmap/README.md @@ -20,6 +20,7 @@ dev = """26.3's dialog packets and model (#1720), ...""" # crates, a links = ["#1720", "#1734", "docs/hosting.md"] # #N, a repository path, or https:// shipped_in = "v0.2.58" # shipped items only: a game tag, launcher@x.y.z, or "website" post = "..." # optional: the announcement when it ships, if `plain` doesn't read as one +announce = true # optional: when it ships, Kira also posts it on X (`post`, else `plain`) ``` - **No dates, ever**: Now, Next, Later. The check rejects month names, years, quarters and "next week". diff --git a/roadmap/roadmap.toml b/roadmap/roadmap.toml index bb664d3d5..5ad4d8846 100644 --- a/roadmap/roadmap.toml +++ b/roadmap/roadmap.toml @@ -91,6 +91,7 @@ id = "modpack-worldgen" title = "Modpacks' world generation, natively" status = "now" area = "modpacks" +announce = true focus = true plain = """Making the world-generation mods of popular modpacks (new structures, YUNG's dungeons and mineshafts, \ packs built on Lithostitched) generate their worlds in Horizon, natively and fast.""" @@ -135,6 +136,7 @@ id = "mod-registry" title = "Horizon's mod registry" status = "now" area = "mods" +announce = true focus = true plain = """One place for mods, modpacks and resource packs made for Horizon: browse them on the website and \ install them from the launcher in one click.""" @@ -185,6 +187,7 @@ id = "discord-presence" title = "Discord Rich Presence" status = "now" area = "extras" +announce = true plain = """Your Discord profile can show that you are playing Horizon, with a switch to turn it off.""" dev = """A Discord IPC client on its own thread (#1787) and the presence with its setting (#1788). Merged: it ships \ with the next release.""" @@ -210,6 +213,7 @@ id = "microsoft-sign-in" title = "Microsoft sign-in (coming soon)" status = "next" area = "launcher" +announce = true plain = """Coming soon: sign in with your Microsoft account to play on online-mode servers. The code is ready; it \ waits for Microsoft's approval.""" dev = """Device-code sign-in in the launcher and online-mode login in the client (docs/microsoft-account.md). It is \ @@ -222,6 +226,7 @@ id = "curseforge" title = "CurseForge in the mod browser (coming soon)" status = "next" area = "modpacks" +announce = true plain = """Coming soon: search and download CurseForge mods and modpacks from the launcher, as you can with \ Modrinth today.""" dev = """The mod browser lists CurseForge as coming soon (docs/mod-browser.md): it needs CurseForge API access. \ diff --git a/tests/test_roadmap.py b/tests/test_roadmap.py index fb4f4e419..3b8e15b45 100644 --- a/tests/test_roadmap.py +++ b/tests/test_roadmap.py @@ -114,6 +114,10 @@ class Rules(unittest.TestCase): self.assertTrue(any("link" in p for p in self.problems(links=["docs/nothing-here.md"]))) self.assertTrue(any("link" in p for p in self.problems(links=["http://example.com"]))) + def test_flags_are_true_or_false(self): + self.assertEqual(self.problems(announce=True), []) + self.assertTrue(any("announce is true or false" in p for p in self.problems(announce="yes"))) + def test_three_to_five_items_in_focus(self): self.assertTrue(any("focus" in p for p in self.problems(focus=False))) diff --git a/tools/roadmap.py b/tools/roadmap.py index b1bb13c6d..d80c9692c 100644 --- a/tools/roadmap.py +++ b/tools/roadmap.py @@ -45,7 +45,8 @@ STALE_DAYS = 14 # a Now item needs an open pull request, or one merged this rec LABEL_PREFIX = "roadmap:" # GitHub label colours by status, from the design system's palette. LABEL_COLOURS = {"now": "5b3fd6", "next": "9a86ff", "later": "c5c7d1", "help-wanted": "1d7a48", "shipped": "646875"} -ITEM_KEYS = {"id", "title", "status", "area", "plain", "dev", "links", "focus", "ongoing", "shipped_in", "post"} +ITEM_KEYS = {"id", "title", "status", "area", "plain", "dev", "links", "focus", "ongoing", "shipped_in", "post", + "announce"} ISSUE = re.compile(r"#(\d+)$") ID = re.compile(r"[a-z0-9]+(-[a-z0-9]+)*$") @@ -127,6 +128,9 @@ def validate(data, root=ROOT): problems.append(f"{where}: shipped_in {shipped_in!r} is not a release tag or \"website\"") elif shipped_in: problems.append(f"{where}: only shipped items have shipped_in") + for key in ("focus", "ongoing", "announce"): + if key in item and not isinstance(item[key], bool): + problems.append(f"{where}: {key} is true or false") if item.get("ongoing") and status not in ("now", "next", "later"): problems.append(f"{where}: only Now, Next and Later items are ongoing") if item.get("focus") and status != "now": From e936e412ba04f67d907d4b5abdeb412a8f3e6462 Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Sun, 25 Oct 2026 15:29:37 +0100 Subject: [PATCH 12/26] Website: the hub (/hub) with the roadmap, a Simple / Technical switch and live states playhorizon.dev/hub is the public entry point to what is happening on Horizon. Overview: where Horizon is, the 3 to 5 things in focus, what is next, what shipped last, how to help. Roadmap: Now / Next / Later / Help wanted / Shipped, filtered by area, every item with its issues and pull requests in their GitHub state (baked at build, refreshed in the browser). Contribute: good first tasks, claiming, connecting an agent to Kira, the rules. A Simple / Technical switch swaps every item's plain and dev text and is remembered. /roadmap redirects to the Roadmap tab. tools/roadmap.py build now also writes website/data/roadmap.json, which the site reads and serves at /hub/roadmap.json. Co-Authored-By: Claude Opus 5.5 --- tests/test_roadmap.py | 13 +- tools/roadmap.py | 46 +++- website/Caddyfile | 5 +- website/README.md | 4 + website/build.mjs | 64 ++++- website/data/roadmap.json | 557 ++++++++++++++++++++++++++++++++++++++ website/serve.mjs | 5 + website/src/hub-page.js | 119 ++++++++ website/src/hub.html | 110 ++++++++ website/src/hub.js | 175 ++++++++++++ website/src/hub.test.mjs | 48 ++++ website/src/style.css | 63 ++++- 12 files changed, 1187 insertions(+), 22 deletions(-) create mode 100644 website/data/roadmap.json create mode 100644 website/src/hub-page.js create mode 100644 website/src/hub.html create mode 100644 website/src/hub.js create mode 100644 website/src/hub.test.mjs diff --git a/tests/test_roadmap.py b/tests/test_roadmap.py index 3b8e15b45..641d4e11b 100644 --- a/tests/test_roadmap.py +++ b/tests/test_roadmap.py @@ -1,5 +1,6 @@ import copy import datetime +import json import tomllib import unittest from unittest import mock @@ -77,9 +78,15 @@ class RepositoryRoadmap(unittest.TestCase): def test_the_roadmap_keeps_its_rules(self): self.assertEqual(roadmap.validate(roadmap.load()), []) - def test_roadmap_md_is_generated_from_the_toml(self): - self.assertEqual(roadmap.OUTPUT.read_text(), roadmap.render(roadmap.load()), - "ROADMAP.md is out of date: run `python3 tools/roadmap.py build`") + def test_generated_files_match_the_toml(self): + for path, text in roadmap.outputs(roadmap.load()).items(): + self.assertEqual(path.read_text(), text, f"{path.name} is out of date: run `python3 tools/roadmap.py build`") + + def test_site_data_has_every_item_in_one_line_text(self): + data = json.loads(roadmap.site_data(tomllib.loads(SAMPLE))) + self.assertEqual([item["id"] for item in data["items"]], ["fast", "faster", "fastest", "old"]) + self.assertEqual(data["items"][0]["dev"], "Multiply, not divide (#10).") + self.assertEqual(data["areas"], [{"id": "performance", "name": "Performance"}]) class Rules(unittest.TestCase): diff --git a/tools/roadmap.py b/tools/roadmap.py index d80c9692c..1a4f58136 100644 --- a/tools/roadmap.py +++ b/tools/roadmap.py @@ -1,8 +1,8 @@ #!/usr/bin/env python3 """Horizon's roadmap: roadmap/roadmap.toml is the source, ROADMAP.md is generated from it. - python3 tools/roadmap.py build write ROADMAP.md - python3 tools/roadmap.py build --check fail when ROADMAP.md is out of date (CI) + python3 tools/roadmap.py build write ROADMAP.md and website/data/roadmap.json + python3 tools/roadmap.py build --check fail when either is out of date (CI) python3 tools/roadmap.py check --offline the file's own rules (CI) python3 tools/roadmap.py check the same, then GitHub: links resolve, no stale Now item python3 tools/roadmap.py sync [--dry-run] items whose pull requests all merged become shipped, @@ -28,6 +28,8 @@ from pathlib import Path ROOT = Path(__file__).resolve().parent.parent SOURCE = ROOT / "roadmap" / "roadmap.toml" OUTPUT = ROOT / "ROADMAP.md" +# What the website's hub reads (website/build.mjs), and serves at /hub/roadmap.json for Kira and others. +SITE_DATA = ROOT / "website" / "data" / "roadmap.json" REPO = "ludovic111/horizon" SITE = "https://playhorizon.dev/hub" @@ -227,6 +229,27 @@ def render(data): return "\n".join(out) + "\n" +def site_data(data): + """website/data/roadmap.json: the items as the hub and Kira read them, in the file's order.""" + keys = ("id", "title", "status", "area", "plain", "dev", "links", "focus", "ongoing", "shipped_in", "post") + out = { + "format": "horizon-roadmap", + "version": 1, + "source": "roadmap/roadmap.toml", + "overview": {key: " ".join(value.split()) for key, value in data["overview"].items()}, + "statuses": [{"id": key, "name": name} for key, name in STATUSES.items()], + "areas": [{"id": key, "name": name} for key, name in areas_in_order(data)], + "items": [{key: (" ".join(item[key].split()) if isinstance(item[key], str) else item[key]) + for key in keys if key in item} for item in data.get("item", [])], + } + return json.dumps(out, indent=1, ensure_ascii=False) + "\n" + + +def outputs(data): + """Every generated file and its content.""" + return {OUTPUT: render(data), SITE_DATA: site_data(data)} + + # --- GitHub --------------------------------------------------------------------------------------------------- def token(): @@ -466,13 +489,15 @@ def command_build(args): problems = validate(data) if problems: return report(problems) - markdown = render(data) + files = outputs(data) if args.check: - if not OUTPUT.exists() or OUTPUT.read_text() != markdown: - return report(["ROADMAP.md is out of date: run `python3 tools/roadmap.py build`"]) - return 0 - OUTPUT.write_text(markdown) - print(f"roadmap: wrote {OUTPUT.relative_to(ROOT)}") + stale = [path for path, text in files.items() if not path.exists() or path.read_text() != text] + return report([f"{path.relative_to(ROOT)} is out of date: run `python3 tools/roadmap.py build`" + for path in stale]) + for path, text in files.items(): + path.parent.mkdir(parents=True, exist_ok=True) + path.write_text(text) + print(f"roadmap: wrote {path.relative_to(ROOT)}") return 0 @@ -505,8 +530,9 @@ def command_sync(args): if len(new.get("item", [])) != len(data.get("item", [])) or validate(new): return report(["sync produced an invalid file; nothing written"] + validate(new)) SOURCE.write_text(text) - OUTPUT.write_text(render(new)) - print("roadmap: wrote roadmap/roadmap.toml and ROADMAP.md") + for path, content in outputs(new).items(): + path.write_text(content) + print("roadmap: wrote roadmap/roadmap.toml, ROADMAP.md and website/data/roadmap.json") return 0 diff --git a/website/Caddyfile b/website/Caddyfile index 1571566ad..50ba44381 100644 --- a/website/Caddyfile +++ b/website/Caddyfile @@ -33,9 +33,12 @@ rewrite /privacy /privacy.html rewrite /releases /releases.html rewrite /benchmarks /benchmarks.html + rewrite /hub /hub.html + # The roadmap is the hub's Roadmap tab. + redir /roadmap /hub#roadmap permanent @doc path_regexp doc ^/docs/([a-z-]+)$ rewrite @doc /docs/{re.doc.1}.html - @pages path / /index.html /404.html /privacy.html /releases /releases.html /benchmarks /benchmarks.html /benchmarks.json /docs /docs/* /sitemap.xml + @pages path / /index.html /404.html /privacy.html /releases /releases.html /benchmarks /benchmarks.html /benchmarks.json /hub /hub.html /hub/* /docs /docs/* /sitemap.xml header @pages Cache-Control "no-cache" @legal path /LEGAL.md /fonts/*.txt header @legal Content-Type "text/plain; charset=utf-8" diff --git a/website/README.md b/website/README.md index 9d1f8dc8d..c73683c73 100644 --- a/website/README.md +++ b/website/README.md @@ -25,6 +25,7 @@ src/404.html the not-found page src/privacy.html what the launcher can send when players allow it, retention, deletion (/privacy) src/releases.html every release, newest first, with what it adds and fixes, its notes and downloads (/releases) src/benchmarks.html Horizon against vanilla 26.3 on our machines, the hardware picker, players' results (/benchmarks) +src/hub.html the hub (/hub, /roadmap redirects to its Roadmap tab): Overview, Roadmap, Contribute, a Simple / Technical switch src/docs.html the template of every documentation page (/docs/...), with its left navigation src/tokens.css the design tokens, generated from crates/horizon-theme (do not edit) src/style.css every style, on top of the tokens @@ -39,6 +40,9 @@ src/estimate.js estimates for unmeasured hardware from the nearest measured m src/markdown.js a small Markdown renderer (escapes everything), shared by build and page src/releases.js the home page's "Recently added" and the Releases page's markup, shared by build and page src/contributors.js the contributors' filtering and markup, shared by build and page +src/hub.js the hub's markup from data/roadmap.json and GitHub's issue states, shared by build and page +src/hub-page.js the hub page: tabs by #hash, the Simple / Technical switch (localStorage), the area filter, live states +data/roadmap.json the roadmap, generated by tools/roadmap.py from roadmap/roadmap.toml (do not edit); served at /hub/roadmap.json public/ fonts, screenshots, icons, og.png, robots.txt, benchmarks.json: copied as is (sitemap.xml is written by the build) data/benchmarks/ our raw benchmark reports (tools/perf_bench.py) and fleet.json, the list scripts/benchmarks.mjs reads scripts/benchmarks.mjs benchmark reports -> public/benchmarks.json (ours, and players' groups of 3+ installs) diff --git a/website/build.mjs b/website/build.mjs index 8b0954054..b36e0e103 100644 --- a/website/build.mjs +++ b/website/build.mjs @@ -16,6 +16,7 @@ import { machinesHtml, playersHtml } from "./src/bench.js"; import { CPUS, GPUS, singleThread } from "./src/hardware.js"; import { isGame, isLauncher, launcherVersion, newestFirst } from "./src/versions.js"; import { contributorsFrom, contributorsHtml } from "./src/contributors.js"; +import { areaFilterHtml, helpWantedHtml, overviewHtml, roadmapHtml, slimIssue } from "./src/hub.js"; const site = dirname(fileURLToPath(import.meta.url)); const dist = join(site, "dist"); @@ -77,6 +78,45 @@ try { console.warn(`contributors: ${e.message}; the page will load them itself`); } +// The hub's roadmap (data/roadmap.json, generated from roadmap/roadmap.toml by tools/roadmap.py) and the live state +// of the issues and pull requests its items link: the open ones and those closed lately, then (with a token) the +// older ones in one GraphQL request. Without GitHub the hub shows the links without their state. +const roadmap = JSON.parse(await readFile(join(site, "data", "roadmap.json"), "utf8")); +const linked = new Set(roadmap.items.flatMap((i) => (i.links || []).map((l) => Number((l.match(/^#(\d+)$/) || [])[1])).filter(Boolean))); +let hubLive = []; +try { + const urls = [1, 2, 3].map((p) => `https://api.github.com/repos/${REPO}/issues?state=open&per_page=100&page=${p}`); + urls.push(`https://api.github.com/repos/${REPO}/issues?state=closed&sort=updated&direction=desc&per_page=100`); + for (const url of urls) { + const res = await fetch(url, { headers: githubHeaders, signal: AbortSignal.timeout(15000) }); + if (!res.ok) throw new Error(`${res.status} from GitHub`); + hubLive.push(...(await res.json()).map(slimIssue)); + } + const missing = [...linked].filter((n) => !hubLive.some((i) => i.n === n)); + if (missing.length && process.env.GITHUB_TOKEN) { + const fields = missing.map((n) => `n${n}: issueOrPullRequest(number: ${n}) { ... on Issue { number title state stateReason url } ... on PullRequest { number title state isDraft mergedAt url } }`).join(" "); + const res = await fetch("https://api.github.com/graphql", { + method: "POST", + headers: githubHeaders, + body: JSON.stringify({ query: `query { repository(owner: "ludovic111", name: "horizon") { ${fields} } }` }), + signal: AbortSignal.timeout(15000), + }); + const nodes = Object.values((await res.json()).data?.repository || {}).filter(Boolean); + hubLive.push( + ...nodes.map((x) => + slimIssue({ + number: x.number, title: x.title, html_url: x.url, draft: x.isDraft, + state: x.state === "OPEN" ? "open" : "closed", state_reason: x.stateReason === "NOT_PLANNED" ? "not_planned" : null, + pull_request: "isDraft" in x ? { merged_at: x.mergedAt } : undefined, + }), + ), + ); + } +} catch (e) { + console.warn(`hub: ${e.message}; the page will load the states itself`); +} +const hubLinked = new Map(hubLive.filter((i) => linked.has(i.n)).map((i) => [i.n, i])); + // --- The parity table ------------------------------------------------------------------ const status = section(readme, "Project status") ?? ""; @@ -170,7 +210,7 @@ await writeFile(join(dist, "favicon.ico"), Buffer.concat([ico, png32])); const names = {}; const rewrite = (code) => code.replace(/"\.\/(\w+\.js)"/g, (all, file) => (names[file] ? `"./${names[file]}"` : all)); // Dependencies before what imports them. -const modules = ["markdown.js", "versions.js", "chrome.js", "hardware.js", "estimate.js", "releases.js", "contributors.js", "bench.js", "main.js", "releases-page.js", "benchmarks-page.js", "docs-page.js"]; +const modules = ["markdown.js", "versions.js", "chrome.js", "hardware.js", "estimate.js", "releases.js", "contributors.js", "bench.js", "hub.js", "main.js", "releases-page.js", "benchmarks-page.js", "docs-page.js", "hub-page.js"]; for (const file of modules) { const code = rewrite(await readFile(join(site, "src", file), "utf8")); names[file] = `${file.replace(".js", "")}.${fingerprint(code)}.js`; @@ -203,7 +243,7 @@ const unavailable = `

The release notes could not be loaded here. // One top bar and phone menu for Home, Releases, Benchmarks and every Docs page. const navSections = [["/#about", "About"], ["/#screenshots", "In game"], ["/#parity", "Parity"], ["/#launcher", "Launcher"], ["/#recent", "New", "Recently added"], ["/#community", "Community"]]; -const navPages = [["/releases", "Releases"], ["/benchmarks", "Benchmarks"], ["/docs/", "Docs", "Documentation"]]; +const navPages = [["/hub", "Hub"], ["/releases", "Releases"], ["/benchmarks", "Benchmarks"], ["/docs/", "Docs", "Documentation"]]; const navLink = ([href, label, menuLabel], current, menu = false) => `${menu && menuLabel ? menuLabel : label}`; const siteNav = (current) => `

@@ -58,6 +60,23 @@

The roadmap lives in the repository: ROADMAP.md, generated from roadmap/roadmap.toml. Pull requests carry the roadmap:<id> label of their item.

+
+
+

Every open issue and pull request, placed by its state on GitHub, as on Kira's work board in Discord.

+ +
+
+{{HUB_BOARD}} +
+
+ +
+

Every release with what it changed, grouped by roadmap item in Technical, and a summary of each week. Also as journal.json.

+
+{{HUB_JOURNAL}} +
+
+

Good first tasks

diff --git a/website/src/hub.js b/website/src/hub.js index ecfb4da80..cda3b4e5b 100644 --- a/website/src/hub.js +++ b/website/src/hub.js @@ -4,6 +4,8 @@ // twice: `plain` (.hub-plain) for players and `dev` (.hub-dev) for contributors; the page's Simple / Technical // switch shows one of them. import { escape, inline } from "./markdown.js"; +import { parts, plainItem, sections } from "./releases.js"; +import { isGame, isLauncher } from "./versions.js"; export const REPO = "ludovic111/horizon"; const issueUrl = (n) => `https://github.com/${REPO}/issues/${n}`; @@ -173,3 +175,199 @@ export function helpWantedHtml(roadmap) { }) .join(""); } + +// --- The work board -------------------------------------------------------------------------------------------- + +export const COLUMNS = [ + { id: "todo", name: "To do", about: "Open and free: pick one, and say so with /claim on Discord." }, + { id: "progress", name: "In progress", about: "Claimed, assigned, or a draft pull request." }, + { id: "review", name: "In review", about: "A pull request is ready for review." }, + { id: "done", name: "Done", about: "Closed or merged in the last seven days." }, +]; +const DONE_DAYS = 7; + +// The roadmap item an issue or pull request moves: its roadmap: label, else the item linking it, else (for a +// pull request) the item linking an issue it fixes. +export function itemOf(issue, roadmap) { + const label = issue.labels.find((l) => l.startsWith("roadmap:")); + const ids = new Set(roadmap.items.map((i) => i.id)); + if (label && ids.has(label.slice(8))) return label.slice(8); + const linking = (n) => roadmap.items.find((i) => (i.links || []).includes(`#${n}`))?.id; + return linking(issue.n) || issue.fixes.map(linking).find(Boolean) || null; +} + +// The board from GitHub's open issues and pull requests and those closed lately, placed as Kira's work board places +// them: an issue goes to review when an open, ready pull request fixes it, to progress when a draft one does or it is +// claimed or assigned; a pull request that fixes no open issue is a card of its own. +export function boardFrom(list, roadmap, now = Date.now()) { + const columns = Object.fromEntries(COLUMNS.map((c) => [c.id, []])); + const open = list.filter((i) => i.state === "open"); + const openIssues = new Set(open.filter((i) => i.kind === "issue").map((i) => i.n)); + const fixing = (n) => open.filter((p) => p.kind === "pr" && p.fixes.includes(n)); + const card = (i, prs = []) => ({ n: i.n, kind: i.kind, title: i.title, user: i.user, url: i.url, item: itemOf(i, roadmap) || prs.map((p) => itemOf(p, roadmap)).find(Boolean) || null, prs: prs.map((p) => p.n) }); + for (const i of open) { + if (i.kind === "issue") { + const prs = fixing(i.n); + const claimed = i.assigned || i.labels.some((l) => /^(in progress|claimed)$/i.test(l)); + const column = prs.some((p) => !p.draft) ? "review" : prs.length || claimed ? "progress" : "todo"; + columns[column].push(card(i, prs)); + } else if (!i.fixes.some((n) => openIssues.has(n))) { + columns[i.draft ? "progress" : "review"].push(card(i)); + } + } + const since = now - DONE_DAYS * 864e5; + const seen = new Set(); + for (const i of list) { + if (seen.has(i.n) || !["merged", "closed"].includes(i.state) || !(Date.parse(i.at) >= since)) continue; + seen.add(i.n); + columns.done.push(card(i)); + } + columns.done.sort((a, b) => b.n - a.n); + return columns; +} + +const SHOWN = 20; // cards per column before "Show more" + +function cardHtml(c, roadmap, more) { + const item = c.item && roadmap.items.find((i) => i.id === c.item); + return `
  • ${c.kind === "pr" ? "PR" : "Issue"} #${c.n}${c.prs.length ? ` · ${c.prs.map((n) => `PR #${n}`).join(", ")}` : ""}${escape(c.title)}${item ? `${escape(item.title)}` : ""}${c.user ? `${escape(c.user)}` : ""}
  • `; +} + +export function boardHtml(columns, roadmap) { + return COLUMNS.map(({ id, name, about }) => { + const cards = columns[id]; + return `
    +

    ${escape(name)}${cards.length}

    +

    ${escape(about)}

    +
      ${cards.map((c, i) => cardHtml(c, roadmap, i >= SHOWN)).join("")}
    + ${cards.length > SHOWN ? `` : ""} +
    `; + }).join("\n"); +} + +// The board's roadmap filter: every item that has a card. +export function boardFilterHtml(columns, roadmap) { + const used = new Set(Object.values(columns).flat().map((c) => c.item).filter(Boolean)); + return [``, ``] + .concat(roadmap.items.filter((i) => used.has(i.id)).map((i) => ``)) + .join(""); +} + +// --- The journal ----------------------------------------------------------------------------------------------- + +export const JOURNAL_URL = "https://playhorizon.dev/hub#journal"; +const ENTRIES = 40; + +// The journal, newest first: each release with its changes grouped by roadmap item, the weekly summaries +// (roadmap/journal/), and what merged since the newest game release. releases: GitHub's release objects; list: the +// hub's issues and pull requests (their roadmap: labels place changes the roadmap doesn't link). +export function journalFrom(releases, list, roadmap) { + const prs = new Map(list.filter((i) => i.kind === "pr").map((i) => [i.n, i])); + const placed = (numbers) => { + for (const n of numbers) { + const known = prs.get(n); + const id = known ? itemOf(known, roadmap) : roadmap.items.find((i) => (i.links || []).includes(`#${n}`))?.id; + if (id) return id; + } + return null; + }; + const ours = releases.filter((r) => !r.draft && (isGame(r.tag_name) || isLauncher(r.tag_name))); + const entries = ours.map((r) => { + const changes = sections(r.body) + .filter((x) => /^(new|what's new|fixed)/i.test(x.title)) + .flatMap((x) => x.items.map((text) => ({ section: /^fixed/i.test(x.title) ? "fixed" : "new", text }))) + .map((c) => { + const numbers = [...c.text.matchAll(/#(\d+)/g)].map((m) => Number(m[1])); + return { ...c, text: plainItem(c.text), prs: numbers, item: placed(numbers) }; + }); + return { + id: r.tag_name, + kind: isLauncher(r.tag_name) ? "launcher" : "release", + date: r.published_at || "", + title: r.name || r.tag_name, + plain: parts(r).line, + url: r.html_url, + changes, + shipped: roadmap.items.filter((i) => i.status === "shipped" && i.shipped_in === r.tag_name).map((i) => i.id), + }; + }); + // Merged but in no release's notes yet: a release is cut from main a while after its last merge, so the newest + // releases' notes, not their dates, say what they hold. Pull requests players don't see (skip-release) never are. + const games = ours.filter((r) => isGame(r.tag_name)).map((r) => r.published_at).sort().reverse(); + const since = games[Math.min(4, games.length - 1)] || ""; + const noted = new Set(entries.flatMap((e) => e.changes.flatMap((c) => c.prs))); + const pending = list + .filter((i) => i.kind === "pr" && i.state === "merged" && i.at > since && !noted.has(i.n) && !i.labels.includes("skip-release")) + .sort((a, b) => b.at.localeCompare(a.at)); + if (pending.length) { + entries.push({ + id: "next-release", + kind: "merged", + date: pending[0].at, + title: "Merged, in the next release", + plain: `${pending.length} change${pending.length === 1 ? "" : "s"} merged since the last release.`, + url: `https://github.com/${REPO}/pulls?q=is%3Apr+is%3Amerged`, + changes: pending.map((p) => ({ section: "merged", text: p.title, prs: [p.n], item: itemOf(p, roadmap) })), + shipped: [], + }); + } + for (const w of roadmap.journal || []) { + // A week's summary sits after its last day's releases. + const end = new Date(Date.parse(w.date) + 7 * 864e5 - 1).toISOString(); + entries.push({ id: `week-${w.week}`, kind: "week", date: end, title: w.title, plain: w.plain, dev: w.dev, url: `${JOURNAL_URL.replace("#journal", "")}#week-${w.week}`, changes: [], shipped: [] }); + } + return entries.sort((a, b) => b.date.localeCompare(a.date)).slice(0, ENTRIES); +} + +// /hub/journal.json: the journal for Kira's #updates and posts elsewhere, with each shipped item's short text. +export function journalJson(entries, roadmap, generated = new Date().toISOString()) { + const item = (id) => { + const i = roadmap.items.find((x) => x.id === id); + return i && { id: i.id, title: i.title, plain: i.plain, post: i.post || i.plain }; + }; + return { + format: "horizon-journal", + version: 1, + generated, + url: JOURNAL_URL, + entries: entries.map((e) => ({ ...e, items: [...new Set(e.changes.map((c) => c.item).filter(Boolean))].map(item).filter(Boolean), shipped: e.shipped.map(item).filter(Boolean) })), + }; +} + +const KIND = { release: "Game", launcher: "Launcher", merged: "Merged", week: "This week" }; + +function changesHtml(entry, roadmap) { + if (!entry.changes.length) return ""; + const line = (c) => `
  • ${inline(c.text)}${c.prs.length ? ` ${c.prs.map((n) => `#${n}`).join(" ")}` : ""}
  • `; + // Simple: what is new, then how many fixes. Technical: every change, under the roadmap item it moves. + const added = entry.changes.filter((c) => c.section !== "fixed"); + const fixes = entry.changes.length - added.length; + const simple = `
    ${added.length ? `
      ${added.map((c) => `
    • ${inline(c.text)}
    • `).join("")}
    ` : ""}${fixes ? `

    ${added.length ? "And " : ""}${fixes} fix${fixes === 1 ? "" : "es"}.

    ` : ""}
    `; + const groups = new Map(); + for (const c of entry.changes) groups.set(c.item || "", [...(groups.get(c.item || "") || []), c]); + const order = [...groups.keys()].sort((a, b) => (a === "") - (b === "")); + const dev = `
    ${order + .map((id) => { + const item = roadmap.items.find((i) => i.id === id); + return `

    ${item ? `${escape(item.title)}` : "Other changes"}

      ${groups.get(id).map(line).join("")}
    `; + }) + .join("")}
    `; + return simple + dev; +} + +export function journalHtml(entries, roadmap) { + return entries + .map((e) => { + const shipped = e.shipped.map((id) => roadmap.items.find((i) => i.id === id)).filter(Boolean); + const items = [...new Set(e.changes.map((c) => c.item).filter(Boolean))].map((id) => roadmap.items.find((i) => i.id === id)).filter(Boolean); + return `
    + +

    ${e.url ? `${escape(e.title)}` : escape(e.title)}

    + ${e.kind === "week" ? `

    ${inline(e.plain)}

    ${inline(e.dev.replace(/(^|[^\w[/`])#(\d+)\b/g, (_, b, n) => `${b}[#${n}](${issueUrl(n)})`))}

    ` : ""} + ${shipped.length ? `

    Shipped: ${shipped.map((i) => `${escape(i.title)}`).join(", ")}

    ` : ""} + ${items.length ? `

    ${items.map((i) => `${escape(i.title)}`).join("")}

    ` : ""} + ${changesHtml(e, roadmap)} +
    `; + }) + .join("\n"); +} diff --git a/website/src/hub.test.mjs b/website/src/hub.test.mjs index eb9b8a087..a6337399b 100644 --- a/website/src/hub.test.mjs +++ b/website/src/hub.test.mjs @@ -1,7 +1,7 @@ import { test } from "node:test"; import assert from "node:assert/strict"; import { readFileSync } from "node:fs"; -import { fixesIn, overviewHtml, progress, roadmapHtml, slimIssue } from "./hub.js"; +import { boardFrom, fixesIn, itemOf, journalFrom, journalHtml, journalJson, overviewHtml, progress, roadmapHtml, slimIssue } from "./hub.js"; const roadmap = JSON.parse(readFileSync(new URL("../data/roadmap.json", import.meta.url), "utf8")); @@ -53,3 +53,48 @@ test("the overview lists the focus items and never nests links", () => { for (const item of roadmap.items.filter((i) => i.focus)) assert.ok(html.includes(`href="#${item.id}"`), item.id); for (const row of html.match(/
  • [\s\S]*?<\/li>/g)) assert.equal(row.split(" { + const now = Date.parse("2030-01-10T00:00:00Z"); + const list = [ + issue(1), + issue(2), + issue(3, { assignees: [{ login: "x" }] }), + pr(10, { body: "Fixes #1" }), + pr(11, { body: "Fixes #2", draft: true }), + pr(12, { labels: [{ name: `roadmap:${roadmap.items[0].id}` }] }), + pr(13, { draft: true }), + pr(14, { state: "closed", pull_request: { merged_at: "2030-01-09T00:00:00Z" } }), + pr(15, { state: "closed", pull_request: { merged_at: "2029-12-01T00:00:00Z" } }), + ].map(slimIssue); + const board = boardFrom(list, roadmap, now); + const ids = (column) => board[column].map((c) => c.n); + assert.deepEqual(ids("todo"), []); + assert.deepEqual(ids("progress"), [2, 3, 13]); + assert.deepEqual(ids("review"), [1, 12]); + assert.deepEqual(ids("done"), [14]); + assert.deepEqual(board.review[0].prs, [10]); + assert.equal(board.review[1].item, roadmap.items[0].id); + assert.equal(itemOf(slimIssue(pr(16, { body: "Fixes #1438" })), roadmap), "end-city-banners"); +}); + +test("the journal groups a release's changes by roadmap item and lists what awaits a release", () => { + const releases = [ + { tag_name: "v0.2.2", name: "Horizon 0.2.2: Rich presence", published_at: "2030-01-02T00:00:00Z", html_url: "u2", body: "### New\n- Discord Rich Presence (#1787)\n\n### Fixed\n- A fix (#5, fixes #4)\n" }, + { tag_name: "launcher@0.2.1", name: "Horizon launcher 0.2.1", published_at: "2030-01-01T00:00:00Z", html_url: "u1", body: "### Fixed\n- Window (#6)\n" }, + ]; + const list = [ + pr(1788, { state: "closed", pull_request: { merged_at: "2030-01-03T00:00:00Z" } }), + pr(7, { state: "closed", pull_request: { merged_at: "2030-01-03T00:00:00Z" }, labels: [{ name: "skip-release" }] }), + ].map(slimIssue); + const entries = journalFrom(releases, list, { ...roadmap, journal: [] }); + assert.deepEqual(entries.map((e) => e.id), ["next-release", "v0.2.2", "launcher@0.2.1"]); + assert.deepEqual(entries[0].changes.map((c) => [c.prs, c.item]), [[[1788], "discord-presence"]]); + assert.deepEqual(entries[1].changes.map((c) => [c.section, c.text, c.item]), [["new", "Discord Rich Presence", "discord-presence"], ["fixed", "A fix", null]]); + const json = journalJson(entries, roadmap, "now"); + assert.equal(json.format, "horizon-journal"); + assert.equal(json.entries[1].items[0].post.length <= 240, true); + const html = journalHtml(entries, roadmap); + assert.ok(html.includes('href="#item-discord-presence"')); + assert.ok(html.includes("And 1 fix.")); +}); diff --git a/website/src/style.css b/website/src/style.css index 4ec688812..f32e24a30 100644 --- a/website/src/style.css +++ b/website/src/style.css @@ -783,7 +783,46 @@ code { border-radius: 0; background: var(--well); box-shadow: 0 0 0 1px var(--ou .hub-rules li + li { margin-top: 10px; } .hub-rules li::marker { color: var(--muted); font-family: var(--mono); } .hub-source { margin-top: 40px; max-width: var(--measure); } +.hub-board-head { display: flex; flex-wrap: wrap; align-items: center; justify-content: space-between; gap: 12px 24px; } +.hub-board-head .hub-intro { margin-bottom: 0; } +.hub-select { display: inline-flex; align-items: center; gap: 10px; } +.hub-select select { + height: 32px; max-width: 22rem; padding: 0 10px; font: var(--text-label) / 1 var(--font); color: var(--ink); + background: var(--well); border: 0; box-shadow: 0 0 0 var(--block-outline) var(--outline); +} +.hub-board { display: grid; grid-template-columns: repeat(4, minmax(0, 1fr)); gap: 8px; margin-top: 24px; align-items: start; } +.hub-column { padding: 14px; background: var(--panel); border: var(--block-outline) solid var(--outline); box-shadow: var(--panel-edges); } +.hub-column h3 { display: flex; justify-content: space-between; align-items: baseline; font-size: var(--text-heading); } +.hub-count { font: var(--text-micro) / 1 var(--mono); color: var(--muted); } +.hub-column > .meta { margin: 6px 0 12px; } +.hub-cards-list { display: grid; gap: 6px; } +.js .hub-column:not(.is-open) .hub-card[data-more] { display: none; } +.hub-card a { display: grid; gap: 4px; padding: 10px 12px; background: var(--well); box-shadow: 0 0 0 var(--block-outline) var(--outline); color: var(--ink); } +.hub-card a:hover { box-shadow: 0 0 0 var(--block-outline) var(--accent); } +.hub-card-ref, .hub-card-meta { font: var(--text-micro) / 1.4 var(--mono); letter-spacing: var(--text-micro-tracking); color: var(--muted); } +.hub-card-title { font-size: var(--text-label); line-height: 1.4; overflow-wrap: anywhere; } +.hub-card-meta { display: flex; flex-wrap: wrap; gap: 4px 10px; } +.hub-card-item { color: var(--accent); } +.hub-more { margin-top: 10px; width: 100%; justify-content: center; } +.hub-journal { display: grid; gap: 8px; margin-top: 24px; max-width: 56rem; } +.hub-entry { display: grid; gap: 10px; padding: 18px 20px; background: var(--panel); border: var(--block-outline) solid var(--outline); box-shadow: var(--panel-edges); scroll-margin-top: calc(var(--nav) + 24px); } +.hub-entry-week { background: color-mix(in srgb, var(--accent) 8%, var(--panel)); } +.hub-entry-meta { display: flex; align-items: center; gap: 10px; font: var(--text-micro) / 1 var(--mono); color: var(--muted); } +.hub-entry-meta .badge { margin-right: 0; } +.hub-entry-title { font-size: var(--text-heading); line-height: var(--text-heading-line); } +.hub-entry-title a { color: var(--ink); } +.hub-entry-title a:hover { color: var(--accent); } +.hub-entry .hub-plain, .hub-entry .hub-dev { font-size: var(--text-ui); color: var(--ink-soft); } +.hub-entry-items { display: flex; flex-wrap: wrap; gap: 6px; } +.hub-shipped { font-size: var(--text-ui); color: var(--ink); } +.hub-changes { list-style: square; padding-left: 18px; font-size: var(--text-ui); color: var(--ink-soft); } +.hub-changes li + li { margin-top: 4px; } +.hub-ref { font: var(--text-micro) / 1 var(--mono); } +.hub-group { margin-top: 8px; font: 500 var(--text-label) / 1.4 var(--font); } +.hub-group:first-child { margin-top: 0; } +@media (max-width: 1100px) { .hub-board { grid-template-columns: repeat(2, minmax(0, 1fr)); } } @media (max-width: 720px) { + .hub-board { grid-template-columns: minmax(0, 1fr); } .hub-rows .row > a { grid-template-columns: var(--index) minmax(0, 1fr); } .hub-rows .row-meta { grid-column: 2; text-align: left; } } From e458e3724924360dfad1252358368ff090cc4dae Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Sun, 25 Oct 2026 16:02:36 +0100 Subject: [PATCH 15/26] Hub: journal.json in the flat format Kira reads, at /data/journal.json One entry per merged pull request (with its roadmap item), game or launcher release, shipped roadmap item (post and announce) and weekly summary, newest first, ids stable forever: the feed kira's src/journal.js posts to #updates and X. The journal's item links are hub#; the board's and the journal's ids are reserved too, and the page-wide unique-id test covers every tab. Co-Authored-By: Claude Opus 5.5 --- roadmap/README.md | 36 ++++++++++++------ tools/roadmap.py | 2 +- website/README.md | 2 +- website/build.mjs | 2 +- website/src/hub.html | 2 +- website/src/hub.js | 79 ++++++++++++++++++++++++++++++++-------- website/src/hub.test.mjs | 51 +++++++++++++++++++++++--- 7 files changed, 136 insertions(+), 38 deletions(-) diff --git a/roadmap/README.md b/roadmap/README.md index f16e83f8c..55cf9d09f 100644 --- a/roadmap/README.md +++ b/roadmap/README.md @@ -53,7 +53,7 @@ Whoever moves the work (the orchestrator on each heartbeat, or anyone in their p 5. Once a week, write the week's summary in `roadmap/journal/-.md` (for example `2026-43.md`): `# Title`, a paragraph or two for players, then `## Technical` and the same week for contributors, with its pull requests. `build` puts it into website/data/roadmap.json; the hub's Journal tab - shows it among the releases, and `/hub/journal.json` carries it to Kira's #updates and to posts elsewhere. + shows it among the releases, and `/data/journal.json` carries it to Kira's #updates and to X. 6. Suggestions from the website and Discord are read and triaged by the maintainers. A good one becomes an item in a normal pull request; none is published automatically. @@ -62,18 +62,30 @@ or when the file breaks a rule; `python3 tools/roadmap.py check --offline` runs ## The journal -The hub's Journal tab and `https://playhorizon.dev/hub/journal.json` are built with each deploy of the website -(`website/src/hub.js`, `journalFrom`): every game and launcher release with its notes' changes, each placed under -the roadmap item it moves (the pull request's `roadmap:` label, else the item that links it); the merged pull -requests no release has yet; and the weekly summaries above. Its JSON, newest first: +The hub's Journal tab and `https://playhorizon.dev/data/journal.json` are built with each deploy of the website +(`website/src/hub.js`). The tab shows every game and launcher release with its notes' changes, each placed under +the roadmap item it moves (the pull request's `roadmap:` label, else the item that links it), the merged pull +requests no release has yet, and the weekly summaries above. + +`journal.json` is what Kira reads for `#updates` and its X posts (kira's `src/journal.js`): one flat entry per +merged pull request, release, shipped item and weekly summary, newest first, the latest 300. ```json -{ "format": "horizon-journal", "version": 1, "generated": "…", "url": "https://playhorizon.dev/hub#journal", - "entries": [ { "id": "v0.2.57", "kind": "release | launcher | merged | week", "date": "…", "title": "…", - "plain": "one line for players", "url": "…", "dev": "weeks only", - "changes": [ { "section": "new | fixed | merged", "text": "…", "prs": [1787], "item": "discord-presence" } ], - "items": [ { "id", "title", "plain", "post" } ], // roadmap items the entry moved - "shipped": [ { "id", "title", "plain", "post" } ] } ] } // items that shipped in this release +{ "format": "horizon-journal", "version": 2, "generated": "…", "url": "https://playhorizon.dev/hub#journal", + "entries": [ + { "id": "pr-1788", "kind": "merge", "date": "…", "title": "the pull request's title", "url": "…", + "number": 1788, "item": "discord-presence", "item_title": "Discord Rich Presence" }, + { "id": "release-v0.2.57", "kind": "release", "date": "…", "title": "…", "plain": "one line", "url": "…", + "tag": "v0.2.57" }, + { "id": "shipped-server-resource-packs", "kind": "shipped", "date": "the release's", "title": "…", + "plain": "…", "url": "https://playhorizon.dev/hub#server-resource-packs", "item": "…", "item_title": "…", + "shipped_in": "v0.2.48", "post": "at most 240 characters", "announce": false }, + { "id": "weekly-2026-43", "kind": "weekly", "date": "the week's last second", "title": "…", "plain": "…", + "dev": "…", "url": "https://playhorizon.dev/hub#week-2026-43" } ] } ``` -`post` is at most 240 characters, ready to announce as is. Readers should remember the ids they have posted. +- An `id` never changes: readers post each one once. `merge` entries are the pull requests players see (no + `skip-release` label), plus any that moves a roadmap item; `item` is absent when none does. +- `announce: true` (the item's `announce` key) asks Kira to post the shipped item on X too, with `post`. +- `https://playhorizon.dev/data/roadmap.json` is `roadmap.toml` as JSON (`areas`, `items` with every key above, + `overview`, the weekly summaries); an item's page is `https://playhorizon.dev/hub#`. diff --git a/tools/roadmap.py b/tools/roadmap.py index ab0147e70..fe97285ff 100644 --- a/tools/roadmap.py +++ b/tools/roadmap.py @@ -57,7 +57,7 @@ ISSUE = re.compile(r"#(\d+)$") ID = re.compile(r"[a-z0-9]+(-[a-z0-9]+)*$") # An item is the anchor playhorizon.dev/hub#: it can't take the name of a tab, a section or a heading. RESERVED = {"main", "overview", "roadmap", "board", "journal", "contribute", "hub-data", *STATUSES} -RESERVED_PREFIXES = ("h-", "tab-", "week-") +RESERVED_PREFIXES = ("h-", "tab-", "col-", "week-", "journal-") RELEASE = re.compile(r"(v\d[\w.]*|launcher@\d[\w.]*|launcher-v\d[\w.]*|website)$") MONTHS = ("January|February|March|April|June|July|August|September|October|November|December") # Kira's rule: no dates and no promises of when. "Coming soon" is the one allowed phrase. diff --git a/website/README.md b/website/README.md index 56fa515b9..d17bd0cd1 100644 --- a/website/README.md +++ b/website/README.md @@ -40,7 +40,7 @@ src/estimate.js estimates for unmeasured hardware from the nearest measured m src/markdown.js a small Markdown renderer (escapes everything), shared by build and page src/releases.js the home page's "Recently added" and the Releases page's markup, shared by build and page src/contributors.js the contributors' filtering and markup, shared by build and page -src/hub.js the hub's roadmap, board and journal from data/roadmap.json, GitHub's issues and the releases, shared by build and page; /hub/journal.json +src/hub.js the hub's roadmap, board and journal from data/roadmap.json, GitHub's issues and the releases, shared by build and page; /data/journal.json src/hub-page.js the hub page: tabs by #hash, the Simple / Technical switch (localStorage), the area filter, live states data/roadmap.json the roadmap, generated by tools/roadmap.py from roadmap/roadmap.toml (do not edit); served at /data/roadmap.json public/ fonts, screenshots, icons, og.png, robots.txt, benchmarks.json: copied as is (sitemap.xml is written by the build) diff --git a/website/build.mjs b/website/build.mjs index 17768e5fc..c3203891e 100644 --- a/website/build.mjs +++ b/website/build.mjs @@ -437,7 +437,7 @@ for (const { file, values: own } of docPages) { await mkdir(join(dist, "data"), { recursive: true }); await cp(join(site, "data", "roadmap.json"), join(dist, "data", "roadmap.json")); // The journal for Kira's #updates and its X posts: /data/journal.json, rebuilt with every deploy. -await writeFile(join(dist, "data", "journal.json"), JSON.stringify(journalJson(journal, roadmap), null, 1) + "\n"); +await writeFile(join(dist, "data", "journal.json"), JSON.stringify(journalJson(releases, hubLive, roadmap), null, 1) + "\n"); // The pages' inline scripts (they mark the page as scripted and apply the saved theme before CSS // applies) and the inlined stylesheet: the Content-Security-Policy in the Caddyfile allows them by hash. diff --git a/website/src/hub.html b/website/src/hub.html index a6e146080..d4ba4600c 100644 --- a/website/src/hub.html +++ b/website/src/hub.html @@ -71,7 +71,7 @@
  • -

    Every release with what it changed, grouped by roadmap item in Technical, and a summary of each week. Also as journal.json.

    +

    Every release with what it changed, grouped by roadmap item in Technical, and a summary of each week. Also as journal.json.

    {{HUB_JOURNAL}}
    diff --git a/website/src/hub.js b/website/src/hub.js index cda3b4e5b..d293b7250 100644 --- a/website/src/hub.js +++ b/website/src/hub.js @@ -319,19 +319,66 @@ export function journalFrom(releases, list, roadmap) { return entries.sort((a, b) => b.date.localeCompare(a.date)).slice(0, ENTRIES); } -// /hub/journal.json: the journal for Kira's #updates and posts elsewhere, with each shipped item's short text. -export function journalJson(entries, roadmap, generated = new Date().toISOString()) { - const item = (id) => { - const i = roadmap.items.find((x) => x.id === id); - return i && { id: i.id, title: i.title, plain: i.plain, post: i.post || i.plain }; - }; - return { - format: "horizon-journal", - version: 1, - generated, - url: JOURNAL_URL, - entries: entries.map((e) => ({ ...e, items: [...new Set(e.changes.map((c) => c.item).filter(Boolean))].map(item).filter(Boolean), shipped: e.shipped.map(item).filter(Boolean) })), - }; +const HUB = "https://playhorizon.dev/hub"; +const FEED = 300; + +// /data/journal.json, which Kira reads for #updates and X (kira's src/journal.js): one flat entry per merged pull +// request, release, shipped roadmap item and weekly summary, newest first. An entry's id never changes: Kira posts +// each id once. Shipped items carry `post` (at most 240 characters, tools/roadmap.py checks) and `announce`. +export function journalJson(releases, list, roadmap, generated = new Date().toISOString()) { + const items = new Map(roadmap.items.map((i) => [i.id, i])); + const ours = releases.filter((r) => !r.draft && (isGame(r.tag_name) || isLauncher(r.tag_name))); + const published = new Map(ours.map((r) => [r.tag_name, r.published_at || ""])); + const merges = list + .filter((i) => i.kind === "pr" && i.state === "merged") + .map((pr) => ({ pr, item: itemOf(pr, roadmap) })) + // What players see, and anything that moves a roadmap item. + .filter(({ pr, item }) => item || !pr.labels.includes("skip-release")) + .map(({ pr, item }) => ({ + id: `pr-${pr.n}`, + kind: "merge", + date: pr.at, + title: pr.title, + url: pr.url, + number: pr.n, + ...(item ? { item, item_title: items.get(item)?.title } : {}), + })); + const released = ours.map((r) => ({ + id: `release-${r.tag_name}`, + kind: "release", + date: r.published_at || "", + title: r.name || r.tag_name, + plain: parts(r).line, + url: r.html_url, + tag: r.tag_name, + })); + const shipped = roadmap.items + .filter((i) => i.status === "shipped") + .map((i) => ({ + id: `shipped-${i.id}`, + kind: "shipped", + date: published.get(i.shipped_in) || generated, + title: i.title, + plain: i.plain, + url: `${HUB}#${i.id}`, + item: i.id, + item_title: i.title, + shipped_in: i.shipped_in, + post: i.post || i.plain, + announce: Boolean(i.announce), + })); + // A week's summary is dated at the end of its week, after that week's releases. + const weekly = (roadmap.journal || []).map((w) => ({ + id: `weekly-${w.week}`, + kind: "weekly", + date: new Date(Date.parse(w.date) + 7 * 864e5 - 1000).toISOString(), + title: w.title, + plain: w.plain, + dev: w.dev, + url: `${HUB}#week-${w.week}`, + })); + const entries = [...merges, ...released, ...shipped, ...weekly].sort((a, b) => b.date.localeCompare(a.date) || a.id.localeCompare(b.id)); + return { format: "horizon-journal", version: 2, generated, url: `${HUB}#journal`, entries: entries.slice(0, FEED) }; } const KIND = { release: "Game", launcher: "Launcher", merged: "Merged", week: "This week" }; @@ -349,7 +396,7 @@ function changesHtml(entry, roadmap) { const dev = `
    ${order .map((id) => { const item = roadmap.items.find((i) => i.id === id); - return `

    ${item ? `${escape(item.title)}` : "Other changes"}

      ${groups.get(id).map(line).join("")}
    `; + return `

    ${item ? `${escape(item.title)}` : "Other changes"}

      ${groups.get(id).map(line).join("")}
    `; }) .join("")}
    `; return simple + dev; @@ -364,8 +411,8 @@ export function journalHtml(entries, roadmap) {

    ${e.url ? `${escape(e.title)}` : escape(e.title)}

    ${e.kind === "week" ? `

    ${inline(e.plain)}

    ${inline(e.dev.replace(/(^|[^\w[/`])#(\d+)\b/g, (_, b, n) => `${b}[#${n}](${issueUrl(n)})`))}

    ` : ""} - ${shipped.length ? `

    Shipped: ${shipped.map((i) => `${escape(i.title)}`).join(", ")}

    ` : ""} - ${items.length ? `

    ${items.map((i) => `${escape(i.title)}`).join("")}

    ` : ""} + ${shipped.length ? `

    Shipped: ${shipped.map((i) => `${escape(i.title)}`).join(", ")}

    ` : ""} + ${items.length ? `

    ${items.map((i) => `${escape(i.title)}`).join("")}

    ` : ""} ${changesHtml(e, roadmap)} `; }) diff --git a/website/src/hub.test.mjs b/website/src/hub.test.mjs index a6337399b..d688489e9 100644 --- a/website/src/hub.test.mjs +++ b/website/src/hub.test.mjs @@ -1,7 +1,7 @@ import { test } from "node:test"; import assert from "node:assert/strict"; import { readFileSync } from "node:fs"; -import { boardFrom, fixesIn, itemOf, journalFrom, journalHtml, journalJson, overviewHtml, progress, roadmapHtml, slimIssue } from "./hub.js"; +import { boardFrom, boardHtml, fixesIn, itemOf, journalFrom, journalHtml, journalJson, overviewHtml, progress, roadmapHtml, slimIssue } from "./hub.js"; const roadmap = JSON.parse(readFileSync(new URL("../data/roadmap.json", import.meta.url), "utf8")); @@ -42,7 +42,11 @@ test("the roadmap renders every item once, with both texts, in its status's sect }); test("an item is its own anchor (hub#, as Kira links it) and takes no other id of the page", () => { - const page = readFileSync(new URL("./hub.html", import.meta.url), "utf8") + roadmapHtml(roadmap) + overviewHtml(roadmap); + const week = { week: "2030-01", date: "2029-12-31", title: "A week", plain: "p", dev: "d" }; + const release = { tag_name: "v0.2.2", name: "0.2.2", published_at: "2030-01-02T00:00:00Z", html_url: "u", body: "" }; + const journal = journalHtml(journalFrom([release], [], { ...roadmap, journal: [week] }), roadmap); + const board = boardHtml(boardFrom([], roadmap), roadmap); + const page = readFileSync(new URL("./hub.html", import.meta.url), "utf8") + roadmapHtml(roadmap) + overviewHtml(roadmap) + board + journal; const ids = [...page.matchAll(/ id="([^"]+)"/g)].map((m) => m[1]); assert.deepEqual(ids.filter((id, i) => ids.indexOf(id) !== i), []); for (const item of roadmap.items) assert.ok(ids.includes(item.id), item.id); @@ -91,10 +95,45 @@ test("the journal groups a release's changes by roadmap item and lists what awai assert.deepEqual(entries.map((e) => e.id), ["next-release", "v0.2.2", "launcher@0.2.1"]); assert.deepEqual(entries[0].changes.map((c) => [c.prs, c.item]), [[[1788], "discord-presence"]]); assert.deepEqual(entries[1].changes.map((c) => [c.section, c.text, c.item]), [["new", "Discord Rich Presence", "discord-presence"], ["fixed", "A fix", null]]); - const json = journalJson(entries, roadmap, "now"); - assert.equal(json.format, "horizon-journal"); - assert.equal(json.entries[1].items[0].post.length <= 240, true); const html = journalHtml(entries, roadmap); - assert.ok(html.includes('href="#item-discord-presence"')); + assert.ok(html.includes('href="#discord-presence"')); assert.ok(html.includes("And 1 fix.")); }); + +test("journal.json is the flat feed Kira reads: merges, releases, shipped items, weeks, ids that never change", () => { + const releases = [ + { tag_name: "v0.2.48", name: "Horizon 0.2.48", published_at: "2030-01-02T00:00:00Z", html_url: "https://github.com/ludovic111/horizon/releases/tag/v0.2.48", body: "### New\n- Packs (#1)\n" }, + { tag_name: "nightly-1", name: "Nightly", published_at: "2030-01-03T00:00:00Z", html_url: "u", body: "" }, + ]; + const list = [ + pr(1788, { state: "closed", pull_request: { merged_at: "2030-01-04T00:00:00Z" }, html_url: "https://github.com/ludovic111/horizon/pull/1788" }), + pr(7, { state: "closed", pull_request: { merged_at: "2030-01-04T00:00:00Z" }, labels: [{ name: "skip-release" }] }), + pr(8, { state: "closed", pull_request: { merged_at: "2030-01-04T00:00:00Z" }, labels: [{ name: "skip-release" }, { name: "roadmap:lean-code" }] }), + pr(9), + ].map(slimIssue); + const week = { week: "2030-01", date: "2029-12-31", title: "A week", plain: "p", dev: "d" }; + const feed = journalJson(releases, list, { ...roadmap, journal: [week] }, "2030-01-05T00:00:00Z"); + const byId = new Map(feed.entries.map((e) => [e.id, e])); + // A merged pull request, with its roadmap item; skip-release ones only when they move an item; open ones never. + assert.deepEqual(byId.get("pr-1788"), { id: "pr-1788", kind: "merge", date: "2030-01-04T00:00:00Z", title: "PR 1788", url: "https://github.com/ludovic111/horizon/pull/1788", number: 1788, item: "discord-presence", item_title: "Discord Rich Presence" }); + assert.ok(!byId.has("pr-7") && byId.get("pr-8").item === "lean-code" && !byId.has("pr-9")); + // Game and launcher releases only. + assert.equal(byId.get("release-v0.2.48").tag, "v0.2.48"); + assert.ok(!byId.has("release-nightly-1")); + // Every shipped item, dated by its release when the feed has it, with its post and the announce flag. + const shipped = roadmap.items.filter((i) => i.status === "shipped"); + for (const item of shipped) { + const e = byId.get(`shipped-${item.id}`); + assert.equal(e.kind, "shipped"); + assert.equal(e.url, `https://playhorizon.dev/hub#${item.id}`); + assert.ok(e.post.length <= 240 && typeof e.announce === "boolean", item.id); + } + assert.equal(byId.get("shipped-server-resource-packs").date, "2030-01-02T00:00:00Z"); + assert.equal(byId.get("weekly-2030-01").date, "2030-01-06T23:59:59.000Z"); + // Newest first; every entry has what Kira needs, and links only where Kira shows them. + assert.deepEqual(feed.entries.map((e) => e.date), feed.entries.map((e) => e.date).sort().reverse()); + for (const e of feed.entries) { + assert.ok(e.id && ["merge", "release", "weekly", "shipped"].includes(e.kind) && e.date && e.title, e.id); + assert.match(e.url, /^https:\/\/(github\.com|playhorizon\.dev)\//, e.id); + } +}); From 0eb475152e0040c2623bfa76ec10053fa31059ac Mon Sep 17 00:00:00 2001 From: Ludovic Marie <136255825+ludovic111@users.noreply.github.com> Date: Sun, 25 Oct 2026 16:07:46 +0100 Subject: [PATCH 16/26] Registry: show who publishes a project, linked to their GitHub profile The index already carries each project's owners (the GitHub accounts the registry checked at submission), but neither the website nor the launcher showed them. The project page now says "Published by @login" with the avatar and a link to the profile; the launcher adds an @login link per owner. Only strings that are valid GitHub logins become links. Co-Authored-By: Claude Opus 5.5 --- launcher/src/browser/horizon.rs | 24 ++++++++++++++++++++++-- launcher/src/browser/horizon/tests.rs | 19 +++++++++++++++++++ website/src/mods.js | 15 ++++++++++++++- website/src/mods.test.mjs | 8 ++++++++ website/src/style.css | 3 +++ 5 files changed, 66 insertions(+), 3 deletions(-) diff --git a/launcher/src/browser/horizon.rs b/launcher/src/browser/horizon.rs index 501295c6b..e56f31e09 100644 --- a/launcher/src/browser/horizon.rs +++ b/launcher/src/browser/horizon.rs @@ -190,6 +190,18 @@ fn version_of(index: &Index, p: &index::Project, v: &index::Version) -> Version } } +/// A GitHub login as GitHub allows it (letters, digits, single dashes, at most 39), so an index +/// entry can't turn a link into something else. +fn github_login(login: &str) -> bool { + (1..=39).contains(&login.len()) + && login + .bytes() + .all(|b| b.is_ascii_alphanumeric() || b == b'-') + && !login.starts_with('-') + && !login.ends_with('-') + && !login.contains("--") +} + /// The words of a query found in a project's id, name, summary or authors. fn matches(p: &index::Project, text: &str) -> bool { let hay = format!("{} {} {} {}", p.id, p.name, p.summary, p.authors.join(" ")).to_lowercase(); @@ -277,9 +289,14 @@ impl Source for Registry { body.push_str(&format!("- {} {}{may}\n", m.name, w.version)); } } + // Who publishes it: the GitHub accounts the registry checked at submission. + let owners = p.owners.iter().filter(|o| github_login(o)).map(|o| Link { + label: format!("@{o}"), + url: format!("https://github.com/{o}"), + }); Ok(Details { body, - links: vec![ + links: [ Link { label: "Source".into(), url: p.source.clone(), @@ -292,7 +309,10 @@ impl Source for Registry { label: "Report".into(), url: format!("{REPORT}&title={}", p.id), }, - ], + ] + .into_iter() + .chain(owners) + .collect(), authors: p.authors.clone(), published: p .versions diff --git a/launcher/src/browser/horizon/tests.rs b/launcher/src/browser/horizon/tests.rs index bf98719d7..fb99462e1 100644 --- a/launcher/src/browser/horizon/tests.rs +++ b/launcher/src/browser/horizon/tests.rs @@ -143,3 +143,22 @@ fn registry_versions_run_when_made_for_this_game() { .collect(); assert_eq!(pick(Kind::Mod, &versions, false).unwrap().number, "0.1.0"); } + +#[test] +fn owner_links_only_take_github_logins() { + for ok in ["Stink-O", "ludovic111", "a"] { + assert!(github_login(ok), "{ok}"); + } + for bad in [ + "", + "-x", + "x-", + "a--b", + "bad login", + "a/b", + "x?y=1", + &"a".repeat(40), + ] { + assert!(!github_login(bad), "{bad}"); + } +} diff --git a/website/src/mods.js b/website/src/mods.js index 4819af374..acaee41f0 100644 --- a/website/src/mods.js +++ b/website/src/mods.js @@ -79,6 +79,19 @@ function installHtml(p, v) { `; } +// GitHub's rule for a login: letters, digits and single dashes, at most 39. +const LOGIN = /^(?!-)(?!.*--)[A-Za-z0-9-]{1,39}(? LOGIN.test(o)); + if (!owners.length) return ""; + const links = owners + .map((o) => `@${o}`) + .join(" "); + return `

    Published by ${links}

    `; +} + // One project's page. export function projectHtml(p) { const v = p.versions[0]; @@ -93,7 +106,7 @@ export function projectHtml(p) { .map((x) => `
  • ${escape(x.version)} ${escape(x.published || "")} · for ${escape(x.game)}${x.api ? ` · API ${escape(x.api)}` : ""}${x.changelog ? `
    ${markdown(x.changelog)}
    ` : ""}
  • `) .join(""); return `
    -
    ${icon(p)}

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

    +
    ${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)}` : ""}

    ${p.description ? `
    ${markdown(p.description)}
    ` : ""} diff --git a/website/src/mods.test.mjs b/website/src/mods.test.mjs index 75e3ca4c5..c5ff2e783 100644 --- a/website/src/mods.test.mjs +++ b/website/src/mods.test.mjs @@ -53,3 +53,11 @@ test("the submit form sends what the service reads", () => { assert.equal(entry.icon, undefined); assert.equal(JSON.parse(JSON.stringify(entry)).key, undefined, "an empty key isn't sent"); }); + +test("a project's page links its owners' GitHub profiles, and only valid logins", () => { + const html = projectHtml(project({ owners: ["Stink-O", "bad login", "-x", "a--b", "ok\">