diff --git a/crates/horizon-client/src/extras.rs b/crates/horizon-client/src/extras.rs index c8683bb92..b5b4fb165 100644 --- a/crates/horizon-client/src/extras.rs +++ b/crates/horizon-client/src/extras.rs @@ -1,4 +1,4 @@ -//! Horizon's optional extras (zoom, FPS counter, keystroke overlay): their +//! Horizon's optional extras (minimap, lighting, inventory tools): their //! settings, kept in `horizon-extras.txt` next to `options.txt` so that file //! stays exactly vanilla's, and the logic behind them. Every extra is off by //! default; see `docs/extras.md`. Horizon's own switches outside the Extras page @@ -6,17 +6,8 @@ use std::{collections::VecDeque, fs, path::Path}; pub const FILE: &str = "horizon-extras.txt"; -/// The name the options screen uses while the zoom key waits for a key. -pub const ZOOM_KEY: &str = "horizon.zoom"; -/// The same for the sort key. +/// The name the options screen uses while the sort key waits for a key. pub const SORT_KEY: &str = "horizon.sort"; -/// Zoom levels the default cycles through, and the wheel's limits. -pub const ZOOM_LEVELS: [u8; 6] = [2, 3, 4, 6, 8, 10]; -pub const ZOOM_MIN: f32 = 1.25; -/// `Camera.tickFov` keeps the field-of-view modifier at 0.1 or more. -pub const ZOOM_MAX: f32 = 10.0; -/// Each wheel step multiplies the zoom by this. -const ZOOM_STEP: f32 = 1.25; /// The minimap's sizes in GUI pixels, and its zooms in blocks per pixel. pub const MINIMAP_SIZES: [(u8, &str); 3] = [(64, "Small"), (96, "Medium"), (128, "Large")]; @@ -184,7 +175,7 @@ impl Extras { "zoomKey" if value.starts_with("key.") => e.zoom_key = value.to_owned(), "zoomLevel" => { if let Ok(v) = value.parse::() { - e.zoom_level = v.clamp(2, ZOOM_MAX as u8); + e.zoom_level = v.clamp(2, 10); } } "zoomSmooth" => e.zoom_smooth = flag(e.zoom_smooth), @@ -270,11 +261,10 @@ impl Extras { bool_text(self.discord_presence), ) } - /// Binds the extra key `name` (`ZOOM_KEY`, `SORT_KEY`); false for + /// Binds the extra key `name` (`SORT_KEY`); false for /// another name (a vanilla mapping). pub fn set_key(&mut self, name: &str, value: String) -> bool { match name { - ZOOM_KEY => self.zoom_key = value, SORT_KEY => self.sort_key = value, _ => return false, } @@ -291,87 +281,12 @@ impl Extras { } } -/// The zoom key's state: held or not, and the zoom the wheel has set. -#[derive(Clone, Copy, Debug, PartialEq)] -pub struct Zoom { - held: bool, - factor: f32, -} -impl Default for Zoom { - fn default() -> Self { - Self { - held: false, - factor: 1.0, - } - } -} -impl Zoom { - /// The key went down: start at the default level. - pub fn press(&mut self, level: u8) { - self.held = true; - self.factor = f32::from(level).clamp(ZOOM_MIN, ZOOM_MAX); - } - pub fn release(&mut self) { - self.held = false; - } - /// A press or release of the zoom key. Only a press while `playing` (no - /// screen or text field open) zooms; anywhere else the key belongs to - /// the screen, and the zoom lets go. - pub fn key(&mut self, pressed: bool, repeat: bool, playing: bool, level: u8) { - if !pressed || !playing { - self.release(); - } else if !repeat { - self.press(level); - } - } - pub fn held(&self) -> bool { - self.held - } - /// Wheel steps while held (positive zooms in); false when not zooming. - pub fn scroll(&mut self, steps: f32) -> bool { - if !self.held { - return false; - } - self.factor = (self.factor * ZOOM_STEP.powf(steps)).clamp(ZOOM_MIN, ZOOM_MAX); - true - } - /// The zoom in effect: 1 when the key is up or the spyglass is in use - /// (scoping keeps vanilla's spyglass view). - pub fn factor(&self, scoping: bool) -> f32 { - if self.held && !scoping { - self.factor - } else { - 1.0 - } - } -} -/// Vanilla key mappings bound to the zoom key. The key still reaches them -/// (a key bound twice triggers both, as vanilla's do), so the Extras page -/// says so. -pub fn zoom_key_conflicts(e: &Extras, keys: &crate::keybinds::KeyBinds) -> Vec<&'static str> { - if e.zoom_key == "key.keyboard.unknown" { - return Vec::new(); - } - crate::keybinds::MAPPINGS - .iter() - .map(|m| m.0) - .filter(|name| keys.get(name) == e.zoom_key) - .collect() -} /// The field-of-view modifier target `Camera.tickFov` eases toward: vanilla's -/// (`getFieldOfViewModifier`) divided by the zoom. A zoom of 1 leaves it as is. +/// (`getFieldOfViewModifier`) divided by a mod's zoom (`render.set-zoom`). A +/// zoom of 1 leaves it as is. pub fn fov_target(vanilla: f32, zoom: f32) -> f32 { if zoom == 1.0 { vanilla } else { vanilla / zoom } } -/// The mouse turning scale while zoomed. -pub fn turn_scale(zoom: f32, lower_sensitivity: bool) -> f64 { - if lower_sensitivity && zoom > 1.0 { - 1.0 / f64::from(zoom) - } else { - 1.0 - } -} - /// Frame times over the last few seconds: frames per second, the minimum /// and the 1% low, recomputed twice a second. pub struct FpsCounter { @@ -463,11 +378,6 @@ impl Cps { pub enum Item { Fullbright, DynamicLights, - Zoom, - ZoomKey, - ZoomLevel, - ZoomSmooth, - ZoomSensitivity, Minimap, MinimapCorner, MinimapSize, @@ -492,12 +402,6 @@ pub fn rows() -> Vec> { Err("Lighting"), Ok(Fullbright), Ok(DynamicLights), - Err("Zoom"), - Ok(Zoom), - Ok(ZoomKey), - Ok(ZoomLevel), - Ok(ZoomSmooth), - Ok(ZoomSensitivity), Err("Minimap"), Ok(Minimap), Ok(MinimapCorner), @@ -534,11 +438,6 @@ impl Item { match self { Item::Fullbright => "Fullbright", Item::DynamicLights => "Dynamic lights", - Item::Zoom => "Zoom", - Item::ZoomKey => "Zoom key", - Item::ZoomLevel => "Starting zoom", - Item::ZoomSmooth => "Smooth zoom", - Item::ZoomSensitivity => "Slower turning", Item::MinimapCorner => "Corner", Item::Minimap => "Minimap", Item::MinimapSize => "Size", @@ -559,12 +458,11 @@ impl Item { pub fn parent(self) -> Option { use Item::*; Some(match self { - ZoomKey | ZoomLevel | ZoomSmooth | ZoomSensitivity => Zoom, MinimapCorner | MinimapSize | MinimapShape | MinimapZoom | MinimapRotate => Minimap, MouseTweaksWheel => MouseTweaks, SortKey => Sort, - Fullbright | DynamicLights | Zoom | Minimap | MouseTweaks | Sort | AutoReconnect - | NoAi | AgentControl | DiscordPresence => { + Fullbright | DynamicLights | Minimap | MouseTweaks | Sort | AutoReconnect | NoAi + | AgentControl | DiscordPresence => { return None; } }) @@ -576,11 +474,6 @@ impl Item { Item::DynamicLights => { "Torches and other light sources held, dropped or on fire light the blocks around them." } - Item::Zoom => "Hold the zoom key to zoom; the wheel changes it while held.", - Item::ZoomKey => "Click, then press a key. Escape unbinds it.", - Item::ZoomLevel => "The zoom the key starts at.", - Item::ZoomSmooth => "Eases in and out like the spyglass.", - Item::ZoomSensitivity => "Turns slower the more you zoom in.", Item::MinimapCorner => "Overlays in one corner stack.", Item::Minimap => "A map of the loaded terrain around you, in map colours.", Item::MinimapSize => "How big the map is on screen.", @@ -617,7 +510,7 @@ impl Item { pub fn cost(self) -> Option { use crate::graphics_style::Cost; match self { - Item::Fullbright | Item::Zoom => Some(Cost::None), + Item::Fullbright => Some(Cost::None), Item::Minimap | Item::DynamicLights => Some(Cost::Low), Item::AutoReconnect | Item::MouseTweaks | Item::Sort => Some(Cost::None), _ => None, @@ -628,9 +521,6 @@ impl Item { Some(match self { Item::Fullbright => e.fullbright, Item::DynamicLights => e.dynamic_lights, - Item::Zoom => e.zoom, - Item::ZoomSmooth => e.zoom_smooth, - Item::ZoomSensitivity => e.zoom_sensitivity, Item::Minimap => e.minimap, Item::MinimapRotate => e.minimap_rotate, Item::AutoReconnect => e.auto_reconnect, @@ -646,9 +536,7 @@ impl Item { /// The value of the other items, as their button shows it. pub fn value(self, e: &Extras) -> String { match self { - Item::ZoomKey => crate::keybinds::display_name(&e.zoom_key).plain(), Item::SortKey => crate::keybinds::display_name(&e.sort_key).plain(), - Item::ZoomLevel => format!("{}x", e.zoom_level), Item::MinimapCorner => e.minimap_corner.label().into(), Item::MinimapSize => MINIMAP_SIZES .iter() @@ -663,15 +551,11 @@ impl Item { }, } } - /// A click (`back` for the right button). The zoom key binds instead. + /// A click (`back` for the right button). The sort key binds instead. pub fn cycle(self, e: &mut Extras, back: bool) { match self { Item::Fullbright => e.fullbright = !e.fullbright, Item::DynamicLights => e.dynamic_lights = !e.dynamic_lights, - Item::Zoom => e.zoom = !e.zoom, - Item::ZoomSmooth => e.zoom_smooth = !e.zoom_smooth, - Item::ZoomSensitivity => e.zoom_sensitivity = !e.zoom_sensitivity, - Item::ZoomLevel => e.zoom_level = next(&ZOOM_LEVELS, e.zoom_level, back), Item::Minimap => e.minimap = !e.minimap, Item::MinimapRotate => e.minimap_rotate = !e.minimap_rotate, Item::AutoReconnect => e.auto_reconnect = !e.auto_reconnect, @@ -688,13 +572,12 @@ impl Item { Item::NoAi => e.no_ai = !e.no_ai, Item::AgentControl => e.agent_control = !e.agent_control, Item::DiscordPresence => e.discord_presence = !e.discord_presence, - Item::ZoomKey | Item::SortKey => {} + Item::SortKey => {} } } /// The key name the options screen waits on for a key item. pub fn key_name(self) -> Option<&'static str> { match self { - Item::ZoomKey => Some(ZOOM_KEY), Item::SortKey => Some(SORT_KEY), _ => None, } @@ -752,43 +635,7 @@ mod tests { } #[test] - fn default_zoom_key_is_free_in_vanilla() { - let key = Extras::default().zoom_key; - assert!(crate::keybinds::key_code(&key).is_some()); - assert!( - crate::keybinds::MAPPINGS.iter().all(|m| m.1 != key), - "{key} is a vanilla binding" - ); - } - - #[test] - fn zoom_is_vanilla_unless_held_and_not_scoping() { - let mut z = Zoom::default(); - assert_eq!(z.factor(false), 1.0); - assert_eq!(fov_target(1.1, z.factor(false)), 1.1); - assert!(!z.scroll(1.0), "the wheel is the hotbar's when not zooming"); - z.press(4); - assert_eq!(z.factor(false), 4.0); - assert_eq!(z.factor(true), 1.0, "the spyglass wins"); - assert!((fov_target(1.0, 4.0) - 0.25).abs() < 1e-6); - assert!(z.scroll(1.0)); - assert!((z.factor(false) - 5.0).abs() < 1e-5); - for _ in 0..40 { - z.scroll(1.0); - } - assert_eq!(z.factor(false), ZOOM_MAX); - for _ in 0..80 { - z.scroll(-1.0); - } - assert_eq!(z.factor(false), ZOOM_MIN); - z.release(); - assert_eq!(z.factor(false), 1.0); - z.press(2); - assert_eq!(z.factor(false), 2.0, "each press starts at the default"); - } - - #[test] - fn zoom_target_eases_like_the_spyglass() { + fn a_mods_zoom_eases_like_the_spyglass() { // Camera.tickFov halves the distance to the target each tick. let mut camera = crate::camera::Camera::default(); camera.tick(None, 1.0); @@ -812,55 +659,6 @@ mod tests { assert!((floor - 7.0).abs() < 1e-3, "{floor}"); } - #[test] - fn the_zoom_key_only_zooms_while_playing() { - let mut z = Zoom::default(); - // In chat, a sign, a text field or any screen: no zoom. - z.key(true, false, false, 4); - assert!(!z.held()); - z.key(true, false, true, 4); - assert!(z.held()); - // A screen opening while held lets go (its key presses are the screen's). - z.key(true, true, false, 4); - assert!(!z.held()); - // Key repeats do not restart a zoom the wheel changed. - z.key(true, false, true, 4); - z.scroll(1.0); - z.key(true, true, true, 4); - assert!((z.factor(false) - 5.0).abs() < 1e-5); - z.key(false, false, true, 4); - assert!(!z.held()); - } - - #[test] - fn zoom_key_conflicts_name_the_vanilla_mappings() { - let mut e = Extras::default(); - let mut keys = crate::keybinds::KeyBinds::default(); - assert!(zoom_key_conflicts(&e, &keys).is_empty()); - e.zoom_key = "key.keyboard.c".into(); - assert_eq!( - zoom_key_conflicts(&e, &keys), - [ - "key.saveToolbarActivator", - "key.debug.crash", - "key.debug.copyLocation" - ] - ); - keys.set("key.drop", "key.keyboard.z"); - e.zoom_key = "key.keyboard.z".into(); - assert_eq!(zoom_key_conflicts(&e, &keys), ["key.drop"]); - e.zoom_key = "key.keyboard.unknown".into(); - keys.set("key.smoothCamera", "key.keyboard.unknown"); - assert!(zoom_key_conflicts(&e, &keys).is_empty()); - } - - #[test] - fn sensitivity_scales_with_zoom() { - assert_eq!(turn_scale(1.0, true), 1.0); - assert_eq!(turn_scale(4.0, false), 1.0); - assert_eq!(turn_scale(4.0, true), 0.25); - } - #[test] fn fps_counter_reports_rate_minimum_and_low() { let mut c = FpsCounter::default(); @@ -914,16 +712,8 @@ mod tests { #[test] fn items_cycle_through_their_values() { let mut e = Extras::default(); - Item::ZoomLevel.cycle(&mut e, false); - assert_eq!(e.zoom_level, 6); - Item::ZoomLevel.cycle(&mut e, true); - Item::ZoomLevel.cycle(&mut e, true); - assert_eq!(e.zoom_level, 3); Item::MinimapCorner.cycle(&mut e, true); assert_eq!(e.minimap_corner, Corner::TopLeft); - Item::Zoom.cycle(&mut e, false); - assert_eq!(Item::Zoom.switch(&e), Some(true)); - assert_eq!(Item::ZoomKey.value(&e), "Z"); Item::MinimapZoom.cycle(&mut e, true); assert_eq!(Item::MinimapZoom.value(&e), "½ block per pixel"); Item::MinimapSize.cycle(&mut e, false); diff --git a/crates/horizon-client/src/game.rs b/crates/horizon-client/src/game.rs index 0d0ed183a..495c01dc8 100644 --- a/crates/horizon-client/src/game.rs +++ b/crates/horizon-client/src/game.rs @@ -1511,7 +1511,7 @@ struct Game<'a> { pending_bench: Option<(Instant, std::sync::mpsc::Sender)>, /// Recent frame times for the performance overlay. frame_graph: horizon_client::perf_overlay::FrameGraph, - /// Horizon's extras (zoom, FPS counter, keystrokes): `game/extras.rs`. + /// Horizon's extras (minimap, auto-reconnect; mods' counters): `game/extras.rs`. extras: extras::ExtrasState, /// Horizon mods (`game/mods.rs`), none running unless turned on. mods: mods::ModsState, @@ -11310,7 +11310,6 @@ impl ApplicationHandler for Game<'_> { && self.sleeping.is_none() && self.player.is_some() && !self.mod_wheel(d) - && !self.extras_scroll(d) && let Some((wheel, (_, vertical_steps))) = self.mouse .on_scroll(raw_x, raw_y, discrete, wheel_sensitivity) @@ -11721,7 +11720,6 @@ impl ApplicationHandler for Game<'_> { let PhysicalKey::Code(key) = event.physical_key else { return Ok(()); }; - self.extras_key(key, event.state == ElementState::Pressed, event.repeat); self.mod_key(key, event.state == ElementState::Pressed, event.repeat); // key.smoothCamera toggles the cinematic camera. if self.screen == Screen::Playing diff --git a/crates/horizon-client/src/game/control.rs b/crates/horizon-client/src/game/control.rs index f418b0b83..f9ae9afcb 100644 --- a/crates/horizon-client/src/game/control.rs +++ b/crates/horizon-client/src/game/control.rs @@ -295,13 +295,9 @@ impl Game<'_> { self.debug_key(key, KeyAction::Release); } } - // The zoom extra sees the key as the keyboard hook does. + // Mods' keys (capability `input`) see the key as the keyboard + // hook does. let action = arg(2)?; - self.extras_key(physical, action != "up", action == "repeat"); - if action == "tap" { - self.extras_key(physical, false, false); - } - // So do mods' keys (capability `input`). self.mod_key(physical, action != "up", action == "repeat"); if action == "tap" { self.mod_key(physical, false, false); @@ -379,15 +375,19 @@ impl Game<'_> { match arg(2)? { "down" => { self.extras_mouse(button, true); + self.mod_mouse_key(button, true); self.play_mouse(button, true)? } "up" => { self.extras_mouse(button, false); + self.mod_mouse_key(button, false); self.play_mouse(button, false)? } "click" => { self.extras_mouse(button, true); + self.mod_mouse_key(button, true); self.extras_mouse(button, false); + self.mod_mouse_key(button, false); self.play_mouse(button, true)?; self.play_mouse(button, false)?; } diff --git a/crates/horizon-client/src/game/extras.rs b/crates/horizon-client/src/game/extras.rs index 30073f186..88d962952 100644 --- a/crates/horizon-client/src/game/extras.rs +++ b/crates/horizon-client/src/game/extras.rs @@ -1,24 +1,22 @@ -//! Horizon's extras in the game (`docs/extras.md`): the zoom key and wheel, -//! the minimap's tiles and image, and their HUD; clicks and frame times for -//! mods (`input.clicks-per-second`, `render.frame-stats`). Each hook does -//! nothing while its extra is off and no mod runs. +//! Horizon's extras in the game (`docs/extras.md`): the minimap's tiles and +//! image, and its HUD; a mod's zoom (`render.set-zoom`) on the camera; clicks +//! and frame times for mods (`input.clicks-per-second`, `render.frame-stats`). +//! Each hook does nothing while its extra is off and no mod runs. use super::{Dim, Game, Screen}; use horizon_client::{ - extras::{Corner, Cps, FpsCounter, Zoom, fov_target, turn_scale}, + extras::{Corner, Cps, FpsCounter, fov_target}, extras_hud::{self, Corners}, hud::{HudBatch, MINIMAP_SPRITE}, - keybinds, minimap::{self, Layer, Minimap, View}, multiplayer, reconnect::{Retry, Tracker}, title::Mode, }; use std::time::Duration; -use winit::{event::MouseButton, keyboard::KeyCode}; +use winit::event::MouseButton; #[derive(Default)] pub(super) struct ExtrasState { - zoom: Zoom, fps: FpsCounter, /// Left and right mouse buttons: held, and their clicks. mouse: [bool; 2], @@ -36,34 +34,8 @@ impl Game<'_> { fn extras_now(&self) -> f64 { self.started.elapsed().as_secs_f64() } - fn zoom_key(&self) -> Option { - let e = &self.settings.extras; - e.zoom.then(|| keybinds::key_code(&e.zoom_key)).flatten() - } - /// A key press or release. The zoom key zooms only while playing with - /// no text open; the key itself always goes on to the screen and the key - /// binds, as a vanilla key mapping's would. - pub(super) fn extras_key(&mut self, key: KeyCode, pressed: bool, repeat: bool) { - if self.zoom_key() != Some(key) { - return; - } - let playing = self.screen == Screen::Playing - && self.title.is_none() - && self.sign_edit.is_none() - && self.book.is_none(); - let level = self.settings.extras.zoom_level; - self.extras.zoom.key(pressed, repeat, playing, level); - } - /// Wheel steps while playing; true when zooming took them from the hotbar. - pub(super) fn extras_scroll(&mut self, steps: f32) -> bool { - self.settings.extras.zoom && self.extras.zoom.scroll(steps) - } - /// Mouse buttons while playing, for zoom and the keystroke overlay. + /// Mouse buttons while playing, for mods' clicks. pub(super) fn extras_mouse(&mut self, button: MouseButton, pressed: bool) { - let e = &self.settings.extras; - if e.zoom && e.zoom_key == keybinds::mouse_name(button) { - self.extras.zoom.key(pressed, false, true, e.zoom_level); - } let i = match button { MouseButton::Left => 0, MouseButton::Right => 1, @@ -81,9 +53,6 @@ impl Game<'_> { // Under agent control the window may lack focus without pausing. let focused = self.focused || self.control.is_some(); let playing = self.screen == Screen::Playing && self.title.is_none() && focused; - if !playing || !self.settings.extras.zoom { - self.extras.zoom.release(); - } if !playing { self.extras.mouse = [false; 2]; } @@ -225,24 +194,12 @@ impl Game<'_> { rgba: self.extras.minimap.image.clone(), }); } - /// The zoom in effect (1 unless the key is held). - fn zoom_factor(&self) -> f32 { - self.extras.zoom.factor(self.scoping()) - } - /// The zoom in effect, the extra's or a mod's (`render.set-zoom`), - /// whichever is stronger: (factor, smooth, turning scale). + /// A mod's zoom in effect (`render.set-zoom`): (factor, smooth, turning + /// scale); none is 1. fn zoom_now(&self) -> (f32, bool, f64) { - let factor = self.zoom_factor(); - let e = &self.settings.extras; - let own = ( - factor, - e.zoom_smooth, - turn_scale(factor, e.zoom_sensitivity), - ); - match self.mod_zoom() { - Some(z) if z.factor > factor => (z.factor, z.smooth, f64::from(z.turn)), - _ => own, - } + self.mod_zoom().map_or((1.0, true, 1.0), |z| { + (z.factor, z.smooth, f64::from(z.turn)) + }) } /// The field-of-view modifier target, divided by a smooth zoom. pub(super) fn zoomed_fov_target(&self, vanilla: f32) -> f32 { diff --git a/crates/horizon-client/src/game/moved_extras.rs b/crates/horizon-client/src/game/moved_extras.rs index faeeea541..bd277033e 100644 --- a/crates/horizon-client/src/game/moved_extras.rs +++ b/crates/horizon-client/src/game/moved_extras.rs @@ -82,6 +82,13 @@ mod with_mods { Ok(()) => { self.settings.extras.moved.push(m.id.to_owned()); self.settings.mods.enabled.insert(m.id.to_owned()); + // The install wrote the key to horizon-mods.txt; + // the settings save below must keep it. + let keys = self.settings.mods.keys.entry(m.id.to_owned()).or_default(); + for (name, key) in m.keys(&self.settings.extras) { + keys.entry(name.to_owned()).or_insert(key); + } + self.settings.mods.keys.retain(|_, k| !k.is_empty()); self.mods.moved.notices.push(Text::literal(m.notice())); installed = true; } diff --git a/crates/horizon-client/src/moved_extras.rs b/crates/horizon-client/src/moved_extras.rs index 659592d80..3b5db6fbc 100644 --- a/crates/horizon-client/src/moved_extras.rs +++ b/crates/horizon-client/src/moved_extras.rs @@ -25,7 +25,7 @@ pub struct Moved { pub name: &'static str, } -pub const MOVED: [Moved; 2] = [ +pub const MOVED: [Moved; 3] = [ Moved { id: "fps_overlay", name: "FPS counter", @@ -34,13 +34,18 @@ pub const MOVED: [Moved; 2] = [ id: "keystrokes", name: "Keystrokes", }, + Moved { + id: "zoom", + name: "Zoom", + }, ]; impl Moved { fn was_on(&self, e: &Extras) -> bool { match self.id { "fps_overlay" => e.fps, - _ => e.keystrokes, + "keystrokes" => e.keystrokes, + _ => e.zoom, } } /// The extra's settings as the mod keeps them (its storage keys). @@ -51,10 +56,23 @@ impl Moved { ("corner", e.fps_corner.name().into()), ("lows", flag(e.fps_lows)), ], - _ => vec![ + "keystrokes" => vec![ ("corner", e.keystrokes_corner.name().into()), ("cps", flag(e.keystrokes_cps)), ], + _ => vec![ + ("level", e.zoom_level.to_string()), + ("smooth", flag(e.zoom_smooth)), + ("sensitivity", flag(e.zoom_sensitivity)), + ], + } + } + /// The extra's key as the mod's key (`horizon-mods.txt`), when the + /// player had changed it from the mod's default. + pub fn keys(&self, e: &Extras) -> Vec<(&'static str, String)> { + match self.id { + "zoom" if e.zoom_key != "key.keyboard.z" => vec![("zoom", e.zoom_key.clone())], + _ => Vec::new(), } } /// The line the player reads once it is installed. @@ -171,6 +189,12 @@ pub fn install(index: &Index, m: &Moved, e: &Extras, dir: &Path) -> Result<(), S } let mut list = ModList::load(dir); list.enabled.insert(m.id.to_owned()); + // A key the player already chose for the mod stays. + let keys = list.keys.entry(m.id.to_owned()).or_default(); + for (name, key) in m.keys(e) { + keys.entry(name.to_owned()).or_insert(key); + } + list.keys.retain(|_, k| !k.is_empty()); list.save(dir); Ok(()) } @@ -184,7 +208,7 @@ mod tests { fn only_extras_that_were_on_are_installed_and_each_once() { let mut e = Extras::default(); assert!(pending(&e).is_empty()); - assert_eq!(nothing_to_do(&e).len(), 2); + assert_eq!(nothing_to_do(&e).len(), 3); e.fps = true; e.fps_corner = Corner::BottomRight; e.fps_lows = true; @@ -199,7 +223,23 @@ mod tests { ); e.moved.push("fps_overlay".into()); assert!(pending(&e).is_empty()); - assert_eq!(nothing_to_do(&e), [&MOVED[1]]); + assert_eq!(nothing_to_do(&e), [&MOVED[1], &MOVED[2]]); + // Zoom: its settings, and its key only when the player changed it. + e.zoom = true; + e.zoom_level = 8; + e.zoom_smooth = false; + assert_eq!(pending(&e), [&MOVED[2]]); + assert_eq!( + MOVED[2].settings(&e), + [ + ("level", "8".into()), + ("smooth", "false".into()), + ("sensitivity", "true".into()) + ] + ); + assert!(MOVED[2].keys(&e).is_empty()); + e.zoom_key = "key.mouse.4".into(); + assert_eq!(MOVED[2].keys(&e), [("zoom", "key.mouse.4".into())]); assert_eq!( MOVED[0].notice(), "FPS counter moved to the mod browser: installed for you" diff --git a/crates/horizon-client/src/options_ui.rs b/crates/horizon-client/src/options_ui.rs index 9f91254bd..21436d6cc 100644 --- a/crates/horizon-client/src/options_ui.rs +++ b/crates/horizon-client/src/options_ui.rs @@ -3296,26 +3296,29 @@ mod tests { crate::extras::rows().iter().filter(|r| r.is_ok()).count() ); assert_eq!( - click(&mut ui, &mut s, Act::Extra(crate::extras::Item::Zoom)), + click(&mut ui, &mut s, Act::Extra(crate::extras::Item::Sort)), vec![Event::ButtonClick, Event::Changed] ); - assert!(s.extras.zoom); + assert!(s.extras.sort); assert_eq!( - click(&mut ui, &mut s, Act::Extra(crate::extras::Item::ZoomKey)), + click(&mut ui, &mut s, Act::Extra(crate::extras::Item::SortKey)), vec![Event::ButtonClick] ); - assert_eq!(ui.selected_key, Some(crate::extras::ZOOM_KEY)); + assert_eq!(ui.selected_key, Some(crate::extras::SORT_KEY)); assert_eq!( ui.key(&mut s, &atlas, winit::keyboard::KeyCode::KeyC, None), vec![Event::Changed] ); - assert_eq!(s.extras.zoom_key, "key.keyboard.c"); + assert_eq!(s.extras.sort_key, "key.keyboard.c"); assert_eq!( crate::extras::Extras::parse(&s.extras.serialize()), s.extras ); - ui.scroll(&s, size, -1000.0); - let (_, top, bottom, content) = ui.layout(&s, size.0, size.1); + // In a window too short for the page, the wheel scrolls to its end. + let short = (480.0, 300.0); + ui.scroll(&s, short, -1000.0); + let (_, top, bottom, content) = ui.layout(&s, short.0, short.1); + assert!(content > bottom - top); assert_eq!(ui.scroll, content - (bottom - top)); assert_eq!( ui.key(&mut s, &atlas, winit::keyboard::KeyCode::Escape, None), @@ -3867,7 +3870,7 @@ mod tests { #[test] fn extras_and_vanilla_bindings_accept_mouse_buttons() { - use crate::extras::{Extras, SORT_KEY, ZOOM_KEY}; + use crate::extras::{Extras, SORT_KEY}; use winit::event::MouseButton; for button in [ MouseButton::Left, @@ -3876,7 +3879,7 @@ mod tests { MouseButton::Back, MouseButton::Forward, ] { - for name in [SORT_KEY, ZOOM_KEY, "key.jump"] { + for name in [SORT_KEY, "key.jump"] { let mut ui = OptionsUi::default(); let mut s = Settings::default(); ui.selected_key = Some(name); @@ -3885,7 +3888,6 @@ mod tests { let value = keybinds::mouse_name(button); match name { SORT_KEY => assert_eq!(s.extras.sort_key, value), - ZOOM_KEY => assert_eq!(s.extras.zoom_key, value), _ => assert_eq!(s.keys.get(name), value), } assert_eq!(Extras::parse(&s.extras.serialize()), s.extras); diff --git a/docs/extras.md b/docs/extras.md index 598b29739..aa87c1adf 100644 --- a/docs/extras.md +++ b/docs/extras.md @@ -1,6 +1,6 @@ # Horizon extras -Optional conveniences built into the client: fullbright, dynamic lights, zoom, a minimap, auto-reconnect, +Optional conveniences built into the client: fullbright, dynamic lights, a minimap, auto-reconnect, Mouse Tweaks-style inventory controls and inventory sorting. **Every one is off by default**: a fresh install looks and behaves exactly like vanilla 26.3, and turning an extra off again restores vanilla's behaviour completely. @@ -10,7 +10,7 @@ again restores vanilla's behaviour completely. | Part | Code | |---|---| | Settings, parsing and saving | `crates/horizon-client/src/extras.rs` | -| Zoom curve; FPS and click counters (for mods) | `extras.rs` (pure logic, unit tested) | +| FPS and click counters (for mods) | `extras.rs` (pure logic, unit tested) | | Dynamic lights: item glow, nearest sources | `crates/horizon-client/src/dynamic_light.rs` (unit tested), `game/dynamic_lights.rs`, `terrain.wgsl` and `entity.wgsl` (`dynamic_block_light`) | | HUD drawing (minimap frame, corner stacking) | `crates/horizon-client/src/extras_hud.rs` | | Minimap colours, tiles and image | `crates/horizon-client/src/minimap.rs` | @@ -34,10 +34,9 @@ extras stay out of the way of other input and options work. `horizon-graphics.txt`. `options.txt` is untouched, so a vanilla client can share the folder. Unknown or broken lines fall back to the defaults. -The zoom key is a Horizon setting stored in that file (`zoomKey:key.keyboard.z`) -and bound on the Extras page, not in vanilla's Key Binds screen: Horizon has no -Horizon category in Controls, and adding one would put a non-vanilla mapping into -`options.txt`. +Extras' keys (the sort key) are Horizon settings stored in that file and bound on +the Extras page, not in vanilla's Key Binds screen: Horizon has no Horizon category +in Controls, and adding one would put a non-vanilla mapping into `options.txt`. ## The extras @@ -61,33 +60,13 @@ Horizon category in Controls, and adding one would put a non-vanilla mapping int - Off: nothing is gathered and the shaders' loop runs zero times (the count is 0), so it costs nothing measurable (numbers in the pull request, #814). -### Zoom (`zoom`, default off) -- Hold the zoom key (default **Z**, unused by every vanilla 26.3 key mapping; C - is `key.saveToolbarActivator`) to zoom. The key does nothing while zoom is off. -- It zooms only while playing: in chat, signs, books, text fields and every - other screen the key is typed or handled as usual. The key is never taken - from vanilla's mappings: one bound to the same key still acts (a key bound - twice triggers both, as vanilla's do), and the Extras page marks the zoom key - "Also bound" and names the mapping. -- Starts at the default level (4x, settable 2x to 10x); the scroll wheel changes - it while the key is held (and does not move the hotbar then). -- **Smooth** (default on) goes through vanilla's own FOV easing: the zoom divides - the field-of-view modifier target `Camera.tickFov` eases toward, the path the - spyglass uses (`AbstractClientPlayer.getFieldOfViewModifier` returns 0.1 while - scoping). The modifier keeps vanilla's 0.1 floor, so 10x is the deepest zoom. - Off applies the zoom to the final FOV with no easing. -- While scoping with a spyglass the zoom does nothing: the spyglass view and its - overlay stay exactly vanilla's. -- **Slower turning** (default on) divides mouse turning by the zoom factor. -- With zoom off (or the key up) the FOV target and mouse are vanilla's, bit for - bit; the FOV harness covers this. - ### Moved to the mod browser -The **FPS counter** and **Keystrokes** are official mods now (`mods/official/`, [mods.md](mods.md#horizons-official-mods)), +The **FPS counter**, **Keystrokes** and **Zoom** are official mods now (`mods/official/`, [mods.md](mods.md#horizons-official-mods)), with the same look and options. On the first start after the update, a player who had one on gets the mod installed -from Horizon's registry and turned on, with their corner and options carried over, and reads one line in the chat -("FPS counter moved to the mod browser: installed for you"). The install is checked like the launcher's (size, +from Horizon's registry and turned on, with their corner and options carried over (Zoom's key too, into +`horizon-mods.txt`, when it wasn't Z), and reads one line in the chat ("Zoom moved to the mod browser: installed for +you"). The install is checked like the launcher's (size, SHA-256, signature, manifest); if it fails (offline), the next start tries again. `horizon-extras.txt` keeps the old keys and lists what was done in `movedToMods`. Code: `crates/horizon-client/src/moved_extras.rs`, `game/moved_extras.rs`. diff --git a/website/docs/index.md b/website/docs/index.md index 24f969840..f22994f9c 100644 --- a/website/docs/index.md +++ b/website/docs/index.md @@ -7,7 +7,7 @@ Horizon is Minecraft: Java Edition 26.3 rewritten in Rust. You install it with a - **A new game program, not a mod.** Horizon is written from scratch in Rust. It reads the same worlds, plays by the same rules and generates the same terrain as the Java game. - **Checked against vanilla.** {{HARNESSES}} automated tests ("harnesses") feed the same inputs to Horizon and to the real game, then compare the results. Today every subsystem matches in every harness that compares it. That is {{PERCENT}} of what the harnesses compare, which is not proof that nothing else differs. The [status table](/#parity) lists what is covered. - **Light and fast.** It starts quickly, uses little memory and draws efficiently. See [Performance](/docs/performance) for what is measured and what is not. -- **A few things vanilla doesn't have.** Its own settings, added to vanilla's menus the way mods add theirs, graphics presets, distant terrain, controller support, optional extras such as zoom, a minimap and dynamic lights, an invite code to play your world with friends, and a server you can run without Java. +- **A few things vanilla doesn't have.** Its own settings, added to vanilla's menus the way mods add theirs, graphics presets, distant terrain, controller support, optional extras such as a minimap and dynamic lights, official mods such as zoom, an invite code to play your world with friends, and a server you can run without Java. ## What Horizon is not diff --git a/website/docs/settings.md b/website/docs/settings.md index 29eb0a760..e9b228b4c 100644 --- a/website/docs/settings.md +++ b/website/docs/settings.md @@ -63,7 +63,7 @@ Horizon plays with PlayStation (DualShock 4 and DualSense), Xbox (360, One and S ## Extras -**Options, Horizon Settings, Extras** holds small, optional conveniences. Every one is off by default, so a fresh install behaves like vanilla: fullbright, zoom, a minimap, an FPS counter, a keystroke display, auto-reconnect, Mouse Tweaks-style inventory controls and inventory sorting. One more is **dynamic lights**: a torch, lantern or other light source that you hold, that lies dropped as an item, or a burning mob, lights the blocks around it. It is client-side only, so other players do not see it. +**Options, Horizon Settings, Extras** holds small, optional conveniences. Every one is off by default, so a fresh install behaves like vanilla: fullbright, a minimap, auto-reconnect, Mouse Tweaks-style inventory controls and inventory sorting. The FPS counter, the keystroke display and zoom are official mods now, in **Options, Mods**: if you had one on, the game installed it for you on its first start after the update, with your settings. One more is **dynamic lights**: a torch, lantern or other light source that you hold, that lies dropped as an item, or a burning mob, lights the blocks around it. It is client-side only, so other players do not see it. ## Where your settings are stored