diff --git a/.dockerignore b/.dockerignore index 417a1867c..458330c93 100644 --- a/.dockerignore +++ b/.dockerignore @@ -2,7 +2,6 @@ target/ .local/ **/node_modules/ -website/ benchmarks/ packs/ mods/ diff --git a/.gitattributes b/.gitattributes index 358aeae7a..f9e1922d7 100644 --- a/.gitattributes +++ b/.gitattributes @@ -2,5 +2,5 @@ # where Git for Windows' core.autocrlf would check them out with CRLF. docs/launcher-commands.md text eol=lf docs/horizon-ctl-commands.md text eol=lf -website/src/tokens.css text eol=lf +crates/horizon-theme/tokens.css text eol=lf docs/api/*-reference.md text eol=lf diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml index 60bbbf057..1ea2db6fa 100644 --- a/.github/workflows/nightly.yml +++ b/.github/workflows/nightly.yml @@ -8,7 +8,7 @@ name: nightly audit # gh workflow run "nightly audit" -f dry_run=true # the audit, without touching issues on: schedule: - # GitHub's schedules are in UTC: both, and the first step keeps the one that is 03:00 in Paris. + # GitHub's schedules are in UTC: both, and the first step keeps the one that is 03:07 in Paris today. - cron: '7 1 * * *' - cron: '7 2 * * *' workflow_dispatch: @@ -31,14 +31,19 @@ jobs: audit: # The Mac mini's runners only: the audit compares with the previous one, so it stays on one platform. runs-on: [self-hosted, horizon-game, macOS] - timeout-minutes: 150 + timeout-minutes: 240 # every harness (~80 min) plus lan_integration (~40 min an attempt under load, retried) steps: - - name: 03:00 in Paris + - name: 03:07 in Paris id: when + env: + SCHEDULE: ${{ github.event.schedule }} run: | - hour=$(TZ=Europe/Paris date +%H) - if [[ "${{ github.event_name }}" == schedule && "$hour" != 03 ]]; then - echo "It is ${hour}:00 in Paris: the other schedule runs the audit." + # Which cron is 03:07 in Paris, from Paris's offset today: GitHub can start a schedule hours late, so the + # clock at start time can't tell (on 2026-10-26 both started after 04:00 Paris and both skipped). + offset=$(TZ=Europe/Paris date +%z) + ours=$([ "$offset" = +0200 ] && echo '7 1 * * *' || echo '7 2 * * *') + if [[ "${{ github.event_name }}" == schedule && "$SCHEDULE" != "$ours" ]]; then + echo "Paris is at UTC${offset} today: the '$ours' schedule runs the audit." echo "run=false" >> "$GITHUB_OUTPUT" else echo "run=true" >> "$GITHUB_OUTPUT" @@ -66,7 +71,8 @@ jobs: run: | echo "since=$(date +%Y-%m-%dT%H:%M:%S)" >> "$GITHUB_OUTPUT" set +e - python3 tools/parity.py --all --timeout 1800 2>&1 | tee "$RUNNER_TEMP/audit.log" + # lan_integration (the whole lan_e2e suite) takes ~2,400 s under load, past the usual 1,800. + python3 tools/parity.py --all --timeout 3000 2>&1 | tee "$RUNNER_TEMP/audit.log" echo "exit=${PIPESTATUS[0]}" >> "$GITHUB_OUTPUT" { echo '```'; tail -40 "$RUNNER_TEMP/audit.log"; echo '```'; } >> "$GITHUB_STEP_SUMMARY" - name: Issues for the harnesses that regressed diff --git a/.github/workflows/parity-main.yml b/.github/workflows/parity-main.yml index c47005ab0..70fb33796 100644 --- a/.github/workflows/parity-main.yml +++ b/.github/workflows/parity-main.yml @@ -48,6 +48,9 @@ jobs: GH_TOKEN: ${{ github.token }} run: echo "sha=$(python3 tools/parity_main.py base)" >> "$GITHUB_OUTPUT" - name: The harnesses the merges since then can affect + id: harnesses + # A failure here is judged by the next step: the run passes when every failed harness passes again at HEAD. + continue-on-error: true env: PARITY_HOSTS: '' BASE_SHA: ${{ steps.base.outputs.sha }} @@ -55,8 +58,8 @@ jobs: echo "Merges since ${BASE_SHA}:" git log --first-parent --format=' %h %s' "$BASE_SHA..HEAD" python3 tools/parity.py --changed "$BASE_SHA" --timeout 2400 - - name: The merge that broke them - if: failure() + - name: A flake, or the merge that broke them + if: steps.harnesses.outcome == 'failure' env: GH_TOKEN: ${{ github.token }} PARITY_HOSTS: '' @@ -65,7 +68,7 @@ jobs: rm -rf .local/parity-main-logs && cp -R .local/parity-runner/logs .local/parity-main-logs 2>/dev/null || true python3 tools/parity_main.py bisect "$BASE_SHA" --comment - name: Logs of the failed harnesses - if: failure() + if: steps.harnesses.outcome == 'failure' uses: actions/upload-artifact@v4 with: name: parity-main-logs diff --git a/AGENTS.md b/AGENTS.md index 549fa5c7f..e1fa9e7fe 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -54,7 +54,8 @@ Game workspace (root `Cargo.toml`); `launcher/` and `crates/horizon-telemetry-se Other top-level folders: `tools/` (harnesses and dev scripts), `tests/` (Python unit tests: `python3 -m unittest discover -s tests`), `mods/horizon/src/test/java/dev/horizonlab/parity/` (Java oracles), -`website/` (playhorizon.dev; its paths are relative to `website/`), `docs/`, `.github/workflows/`. +`docs/`, `.github/workflows/`. The website (playhorizon.dev) is the private ludovic111/horizon-site: its build +reads `README.md`, `launcher/links.json`, `docs/api/`, `roadmap/roadmap.json` and `crates/horizon-theme/tokens.css` from main. ## Build and test fast @@ -66,7 +67,7 @@ cargo build --profile fast -p horizon-client # optimized, quick to link: python3 tools/parity.py --changed origin/main # the harnesses your branch can affect (CI's parity job) python3 tools/parity.py --changed-files paths.txt --list # which harnesses cover these files, without running them python3 tools/parity.py mob_ai sculk # named harnesses -python3 tools/lan_e2e.py --check chest # two real games over LAN (host in-frame); --server-thread for the host on its server thread +python3 tools/lan_e2e.py --check chest # two real games over LAN (server-thread host); --in-frame compares the fallback python3 tools/agent_control_e2e.py # horizon-ctl / MCP end to end ``` @@ -156,7 +157,7 @@ python3 tools/agent_control_e2e.py # horizon-ctl / MCP end to end exactly as a LAN guest or a dedicated server's player does. This is what players run. Open `[server-thread]` issues list the gaps left. 2. **In-frame (`--in-frame`, `--no-server-thread` or `HORIZON_SERVER_THREAD=0`):** the window's `Game` ticks - the world itself, one level that follows the player (`fn enter_dimension`). Most harnesses test this path. + the world itself, one level that follows the player (`fn enter_dimension`). Deterministic rule fixtures still use this path; player-facing integration uses the default server thread. LAN guests and dedicated servers always use the server code, so a fix there serves both. Test both paths when you touch player-facing gameplay: @@ -164,8 +165,8 @@ when you touch player-facing gameplay: ```sh cargo run --profile fast -p horizon-client -- --resources .local/horizon-client/26.3 --world T # server thread cargo run --profile fast -p horizon-client -- --resources .local/horizon-client/26.3 --world T --in-frame # in-frame -python3 tools/lan_e2e.py --check # host in-frame, guest is a server client -python3 tools/lan_e2e.py --server-thread --check # host on its server thread (portals, levels, distance, lava need it) +python3 tools/lan_e2e.py --check # host on its server thread, guest is a server client +python3 tools/lan_e2e.py --in-frame --check # comparison (portals, levels, distance, lava need server-thread mode) python3 tools/parity.py dedicated_server server_entities server_player_damage ``` diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 21951c083..03f3bd97b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,8 +4,8 @@ Thanks for helping. Horizon is Minecraft: Java Edition 26.3 rewritten in Rust, a everything is that **it plays exactly like vanilla**. This page is the short version of how we work; questions are welcome on [Discord](https://discord.gg/HcTeMZxe5E). -This repository holds the game, the launcher and the website, plus the tools, tests and docs that build, check and -release them. Anything else (videos, Discord and other community material) lives elsewhere. +This repository holds the game and the launcher, plus the tools, tests and docs that build, check and release them. +The website (playhorizon.dev) is built in a separate repository from this one's README, `docs/api/` and roadmap. Anything else (videos, Discord and other community material) lives elsewhere. **Where to start: [playhorizon.dev/hub](https://playhorizon.dev/hub).** It shows what is being done now and next ([ROADMAP.md](ROADMAP.md) in the repository), the work board, good first tasks, and the forms to report a bug or diff --git a/Cargo.lock b/Cargo.lock index 1a2aad855..809df3a5a 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1368,6 +1368,7 @@ dependencies = [ "horizon-core", "horizon-dualsense", "horizon-friends", + "horizon-hdr", "horizon-mods", "horizon-protocol", "horizon-server-files", @@ -1426,6 +1427,14 @@ dependencies = [ "spake2", ] +[[package]] +name = "horizon-hdr" +version = "0.1.0" +dependencies = [ + "ash", + "wgpu", +] + [[package]] name = "horizon-mod-sdk" version = "0.1.0" @@ -1437,12 +1446,14 @@ dependencies = [ name = "horizon-mods" version = "0.1.0" dependencies = [ + "horizon-shader-api", "log", "minisign-verify", "serde", "serde_json", "sha2", "toml", + "wasmparser", "wasmtime", "wit-component", "wit-parser", @@ -2082,6 +2093,13 @@ dependencies = [ "libc", ] +[[package]] +name = "minimap" +version = "1.0.0" +dependencies = [ + "horizon-mod-sdk", +] + [[package]] name = "minisign-verify" version = "0.3.0" @@ -4140,6 +4158,28 @@ dependencies = [ "wit-parser", ] +[[package]] +name = "wast" +version = "254.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "febc59cde513fc8f39b8ffd487893723c555fdd024e2e3dc7d165181e6397ea0" +dependencies = [ + "bumpalo", + "leb128fmt", + "memchr", + "unicode-width", + "wasm-encoder", +] + +[[package]] +name = "wat" +version = "1.254.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7db96351e51a3a1bbe6812f029e1100b4d9a5e02161fb63104bd2271fc847e7e" +dependencies = [ + "wast", +] + [[package]] name = "wayland-backend" version = "0.3.17" @@ -4287,6 +4327,13 @@ dependencies = [ "rustls-pki-types", ] +[[package]] +name = "welcome" +version = "0.1.0" +dependencies = [ + "horizon-mod-sdk", +] + [[package]] name = "wgpu" version = "30.0.1" @@ -4998,6 +5045,7 @@ dependencies = [ "wasm-encoder", "wasm-metadata", "wasmparser", + "wat", "wit-parser", ] diff --git a/Cargo.toml b/Cargo.toml index 259734b98..59bfe5e33 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [workspace] exclude = ["launcher", "crates/horizon-telemetry-server", "crates/horizon-mod-registry", "third_party/wgpu-hal"] -members = ["crates/horizon-core", "crates/horizon-dualsense", "crates/horizon-threads", "crates/horizon-world", "crates/horizon-client", "crates/horizon-server-files", "crates/horizon-server", "crates/horizon-bots", "crates/horizon-assets", "crates/horizon-protocol", "crates/horizon-theme", "crates/horizon-prepare", "crates/horizon-telemetry", "crates/horizon-bench", "crates/horizon-friends", "crates/horizon-relay", "crates/horizon-mod-sdk", "crates/horizon-mods", "crates/horizon-mods/tests/guest", "crates/horizon-mods/tests/ui_guest", "crates/cargo-horizon-mod", "crates/horizon-port-pack", "crates/horizon-shaders", "crates/horizon-shader-api", "crates/horizon-release-sign", "crates/horizon-mod-sdk/examples/coords-hud", "crates/horizon-mod-sdk/examples/predator-missile", "mods/official/fps-overlay", "mods/official/keystrokes", "mods/official/zoom", "xtask"] +members = ["crates/horizon-core", "crates/horizon-dualsense", "crates/horizon-threads", "crates/horizon-hdr", "crates/horizon-world", "crates/horizon-client", "crates/horizon-server-files", "crates/horizon-server", "crates/horizon-bots", "crates/horizon-assets", "crates/horizon-protocol", "crates/horizon-theme", "crates/horizon-prepare", "crates/horizon-telemetry", "crates/horizon-bench", "crates/horizon-friends", "crates/horizon-relay", "crates/horizon-mod-sdk", "crates/horizon-mods", "crates/horizon-mods/tests/guest", "crates/horizon-mods/tests/ui_guest", "crates/cargo-horizon-mod", "crates/horizon-port-pack", "crates/horizon-shaders", "crates/horizon-shader-api", "crates/horizon-release-sign", "crates/horizon-mod-sdk/examples/coords-hud", "crates/horizon-mod-sdk/examples/predator-missile", "crates/horizon-mod-sdk/examples/welcome", "mods/official/fps-overlay", "mods/official/keystrokes", "mods/official/minimap", "mods/official/zoom", "xtask"] resolver = "2" [workspace.package] diff --git a/ROADMAP.md b/ROADMAP.md index a04eca2ce..9b82f4fac 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -134,7 +134,7 @@ Better tools for mod makers: a test runner that needs no game window, templates `cargo horizon-mod test` runs a mod's test scripts against a fake game snapshot ([#1816](https://github.com/ludovic111/horizon/issues/1816)) and, for server mods, scripted server events ([#1837](https://github.com/ludovic111/horizon/issues/1837)); the content template and the guides are merged ([#1859](https://github.com/ludovic111/horizon/issues/1859), [#1810](https://github.com/ludovic111/horizon/issues/1810), [docs/api/stability.md](docs/api/stability.md)). Left: templates for hud, server and machine mods, typed wrappers in the SDK, a frozen 0.1 compatibility mod that every runtime must load, a CI check that fails when a stable reference entry is removed without a new major version, and the SDK on crates.io once the API is stable. -More: [website/docs/test-a-mod.md](website/docs/test-a-mod.md) +More: [https://playhorizon.dev/docs/test-a-mod](https://playhorizon.dev/docs/test-a-mod) @@ -160,6 +160,66 @@ Translatable components resolved through the selected language for items, contai +#### Cooldowns drawn on items + +After you throw an ender pearl, its slot should show the cooldown sweeping away, as in vanilla. + +
Technical + +Vanilla draws `ItemCooldowns`' percent as a white overlay over the slot (`GuiGraphicsExtractor.itemDecorations` and `itemCooldown`) in the hotbar and in inventories. Issue [#1763](https://github.com/ludovic111/horizon/issues/1763). + +More: [#1933](https://github.com/ludovic111/horizon/issues/1933) + +
+ +#### Chat settings and team prefixes + +The Hidden and Commands Only chat settings should hide chat, and team prefixes should appear before names in chat. + +
Technical + +Vanilla checks `ChatVisiblity` before it delivers chat and system messages ([#1376](https://github.com/ludovic111/horizon/issues/1376)), and chat uses the team-formatted display name ([#1378](https://github.com/ludovic111/horizon/issues/1378)). Both issues have exact steps to reproduce. + +More: [#1932](https://github.com/ludovic111/horizon/issues/1932) · [#1841](https://github.com/ludovic111/horizon/issues/1841) + +
+ +#### A pointing hand over buttons + +The mouse pointer should turn into a pointing hand over menu buttons, as in vanilla 26.3. + +
Technical + +26.3's `AbstractWidget` asks for a cursor from `CursorTypes` when it is hovered; winit's `CursorIcon::Pointer` gives the same shape. Issue [#1347](https://github.com/ludovic111/horizon/issues/1347). + +More: [#1897](https://github.com/ludovic111/horizon/issues/1897) + +
+ +#### Ctrl+Backspace and scroll bars in menus + +Ctrl+Backspace should delete a whole word in the creative search, and every list's scroll bar should be draggable. + +
Technical + +`EditBox` deletes by word with Ctrl ([#1764](https://github.com/ludovic111/horizon/issues/1764)); the Game Rules and Statistics lists' scroll bars can't be dragged ([#1782](https://github.com/ludovic111/horizon/issues/1782), after [#978](https://github.com/ludovic111/horizon/issues/978)). + +More: [#1884](https://github.com/ludovic111/horizon/issues/1884) · [#1931](https://github.com/ludovic111/horizon/issues/1931) + +
+ +#### Chickens flap while they fall + +Chickens should flap their wings while they fall, not stand still in the air. + +
Technical + +Vanilla's `Chicken.aiStep` updates `flap` and `flapSpeed` when the chicken isn't on the ground, and the model's wings follow them. Issue [#1706](https://github.com/ludovic111/horizon/issues/1706). + +More: [#1892](https://github.com/ludovic111/horizon/issues/1892) + +
+ ### Rendering #### Shader packs, written again from scratch @@ -250,7 +310,7 @@ Horizon should run well on small machines: integrated graphics, the Steam Deck, Partly done: an opt-in 60 FPS cap with fewer workers on battery, Far Detail Reduced for integrated GPUs and animated textures on the GPU (both shipped). Left: measured targets and fixes per class of machine (memory use, worker counts, startup) on a Steam Deck, old Intel and Apple Silicon Macs and 8 GB computers, reported on the Benchmarks page. -More: [docs/benchmark.md](docs/benchmark.md) · [website/docs/performance.md](website/docs/performance.md) +More: [docs/benchmark.md](docs/benchmark.md) · [https://playhorizon.dev/docs/performance](https://playhorizon.dev/docs/performance) @@ -540,7 +600,9 @@ You can port a mod to Horizon with your own AI agent on your own computer. Horiz
Technical -A player runs their own agent locally with `horizon-ctl` and the MCP servers ([docs/agent-control.md](docs/agent-control.md)), `cargo horizon-mod`, `horizon-port-pack` and the parity harnesses as the check. Horizon writes the guide ([website/docs/agents.md](website/docs/agents.md), [docs/modpacks.md](docs/modpacks.md)) and runs no agents, accounts or keys for players. The No AI switch turns all of it off. +A player runs their own agent locally with `horizon-ctl` and the MCP servers ([docs/agent-control.md](docs/agent-control.md)), `cargo horizon-mod`, `horizon-port-pack` and the parity harnesses as the check. Horizon writes the guide (playhorizon.dev/docs/agents, [docs/modpacks.md](docs/modpacks.md)) and runs no agents, accounts or keys for players. The No AI switch turns all of it off. + +More: [https://playhorizon.dev/docs/agents](https://playhorizon.dev/docs/agents)
@@ -876,7 +938,9 @@ Run Horizon's built-in benchmark and share the report: every new computer makes
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). +`horizon-launcher play --arg=--benchmark --arg=standard` writes a JSON report; `horizon-launcher data benchmark ` shows what would be sent and uploads it (playhorizon.dev/docs/performance). Results from three installs with the same hardware appear on the Benchmarks page. Example: [#1711](https://github.com/ludovic111/horizon/issues/1711). + +More: [https://playhorizon.dev/docs/performance](https://playhorizon.dev/docs/performance)
@@ -902,56 +966,6 @@ Armour and tools in End city chests should come enchanted, as in vanilla. -#### Cooldowns drawn on items - -After you throw an ender pearl, its slot should show the cooldown sweeping away, as in vanilla. - -
Technical - -Vanilla draws `ItemCooldowns`' percent as a white overlay over the slot (`GuiGraphicsExtractor.itemDecorations` and `itemCooldown`) in the hotbar and in inventories. Issue [#1763](https://github.com/ludovic111/horizon/issues/1763). - -
- -#### Chat settings and team prefixes - -The Hidden and Commands Only chat settings should hide chat, and team prefixes should appear before names in chat. - -
Technical - -Vanilla checks `ChatVisiblity` before it delivers chat and system messages ([#1376](https://github.com/ludovic111/horizon/issues/1376)), and chat uses the team-formatted display name ([#1378](https://github.com/ludovic111/horizon/issues/1378)). Both issues have exact steps to reproduce. - -
- -#### A pointing hand over buttons - -The mouse pointer should turn into a pointing hand over menu buttons, as in vanilla 26.3. - -
Technical - -26.3's `AbstractWidget` asks for a cursor from `CursorTypes` when it is hovered; winit's `CursorIcon::Pointer` gives the same shape. Issue [#1347](https://github.com/ludovic111/horizon/issues/1347). - -
- -#### Ctrl+Backspace and scroll bars in menus - -Ctrl+Backspace should delete a whole word in the creative search, and every list's scroll bar should be draggable. - -
Technical - -`EditBox` deletes by word with Ctrl ([#1764](https://github.com/ludovic111/horizon/issues/1764)); the Game Rules and Statistics lists' scroll bars can't be dragged ([#1782](https://github.com/ludovic111/horizon/issues/1782), after [#978](https://github.com/ludovic111/horizon/issues/978)). - -
- -#### Chickens flap while they fall - -Chickens should flap their wings while they fall, not stand still in the air. - -
Technical - -Vanilla's `Chicken.aiStep` updates `flap` and `flapSpeed` when the chicken isn't on the ground, and the model's wings follow them. Issue [#1706](https://github.com/ludovic111/horizon/issues/1706). - -
- ## Recently shipped - **OpenGL for old computers** (v0.2.63): Horizon now starts on old PCs whose graphics card has no Vulkan or DirectX 12 driver: it switches to OpenGL by itself, and Options > Graphics can pick OpenGL by hand. [#1917](https://github.com/ludovic111/horizon/issues/1917) · [#1920](https://github.com/ludovic111/horizon/issues/1920) · [#1936](https://github.com/ludovic111/horizon/issues/1936) diff --git a/THIRD_PARTY_NOTICES.md b/THIRD_PARTY_NOTICES.md index 63a1f7da3..e83ccd840 100644 --- a/THIRD_PARTY_NOTICES.md +++ b/THIRD_PARTY_NOTICES.md @@ -17,4 +17,5 @@ by The Pixelify Sans Project Authors, licensed under the SIL Open Font License 1 `crates/horizon-theme/icons/pixel/*.svg` are icons from [Pixelarticons](https://github.com/halfmage/pixelarticons) by Gerrit Halfmann, under the MIT -license (`crates/horizon-theme/icons/pixel/LICENSE-pixelarticons.txt`). +license (`crates/horizon-theme/icons/pixel/LICENSE-pixelarticons.txt`). `star.svg` is Horizon's own, drawn on +the same grid. diff --git a/crates/cargo-horizon-mod/src/check.rs b/crates/cargo-horizon-mod/src/check.rs index cf2968858..f42674da8 100644 --- a/crates/cargo-horizon-mod/src/check.rs +++ b/crates/cargo-horizon-mod/src/check.rs @@ -1,10 +1,11 @@ //! `cargo horizon-mod check `: what the registry checks of a submission, //! run anywhere: its kind's own checks (docs/api/mod-index.md), its signature //! when given a key, and for a mod a trial run in the sandbox: it must start, -//! survive ticks, frames, a chat line and each of its commands, and import -//! no more than its capabilities. +//! survive ticks, frames, a chat line and each of its commands (a server mod: +//! a player joining, chatting, typing them and leaving), and import no more +//! than its capabilities. use horizon_mods::{ - Clock, Mods, Output, Package, Player, Snapshot, Status, + Clock, GameMode, Mods, Output, Package, Player, ServerPlayer, Snapshot, Status, index::{self, Facts, Kind}, manifest::component_imports, }; @@ -46,6 +47,7 @@ impl Report { "api": self.facts.api, "side": self.facts.side, "capabilities": self.facts.capabilities, + "api_level": self.facts.api_level, "game": self.facts.game, "requires": requires, "sha256": self.sha256, @@ -69,6 +71,8 @@ impl Report { if let Some(side) = f.side { let side = serde_json::to_value(side).unwrap_or_default(); out += &format!(", API {}, {}", f.api, side.as_str().unwrap_or("?")); + } else if self.kind == Kind::Shader { + out += &format!(", shader API {}", f.api); } else if !f.api.is_empty() { out += &format!(", format {}", f.api); } @@ -84,6 +88,9 @@ impl Report { ")\n {} bytes, SHA-256 {}, {signed}\n", self.size, self.sha256 ); + if let Some(level) = f.api_level { + out += &format!(" needs mod API level {level} or newer\n"); + } for c in &f.capabilities { out += &format!(" may {}\n", c.describe()); } @@ -113,6 +120,7 @@ pub fn kind_of(path: &Path) -> Option { "hmod" => Some(Kind::Mod), "hpack" => Some(Kind::Modpack), "zip" => Some(Kind::ResourcePack), + "hshader" => Some(Kind::Shader), _ => None, } } @@ -191,40 +199,66 @@ fn play(path: &Path, report: &mut Report) -> Result<(), String> { if let Some(reason) = failed(&mods) { return Err(format!("it didn't start: {reason}")); } - report.commands = mods.commands().map(str::to_owned).collect(); + let client: Vec = mods.commands().map(str::to_owned).collect(); + let server: Vec = mods.server_commands().map(str::to_owned).collect(); + report.commands = [client.clone(), server.clone()].concat(); + // A server mod plays with one player on, who joins, chats and leaves. + let steve = ServerPlayer { + id: "00000000-0000-4000-8000-000000000001".into(), + name: "Steve".into(), + x: 0.5, + y: 64.0, + z: 0.5, + dimension: "minecraft:overworld".into(), + game_mode: GameMode::Survival, + health: 20.0, + }; + let snapshot = |t: u64| Snapshot { + player: Some(Player { + x: 0.5 + t as f64 * 0.1, + y: 64.0, + z: 0.5, + yaw: 90.0, + pitch: 0.0, + health: 20.0, + food: 20, + dimension: "minecraft:overworld".into(), + }), + clock: Some(Clock { + game_time: t, + day_time: 1000 + t, + }), + players: vec![steve.clone()], + // The GUI of a 1280 x 720 window at scale 3. + gui_size: (427.0, 240.0), + ..Snapshot::default() + }; + mods.set_snapshot(snapshot(0)); + mods.player_joined(&steve); for t in 0..TICKS { - mods.set_snapshot(Snapshot { - player: Some(Player { - x: 0.5 + t as f64 * 0.1, - y: 64.0, - z: 0.5, - yaw: 90.0, - pitch: 0.0, - health: 20.0, - food: 20, - dimension: "minecraft:overworld".into(), - }), - clock: Some(Clock { - game_time: t, - day_time: 1000 + t, - }), - // The GUI of a 1280 x 720 window at scale 3. - gui_size: (427.0, 240.0), - ..Snapshot::default() - }); + mods.set_snapshot(snapshot(t)); mods.tick(t); + mods.server_tick(t); for _ in 0..FRAMES_PER_TICK { mods.frame(1.0 / 60.0); } } mods.chat(" hello"); - for name in report.commands.clone() { - mods.command(&name); + mods.player_chat(&steve, "hello"); + for name in &client { + mods.command(name); } + for name in &server { + mods.server_command(&steve, name); + } + mods.set_snapshot(Snapshot::default()); + mods.player_left(&steve); for out in mods.drain() { report.output.push(match out { Output::Chat { text, .. } => format!("chat: {text}"), - Output::Feedback { text, error } => { + Output::Tell { text, .. } => format!("tell: {text}"), + Output::Broadcast { text, .. } => format!("broadcast: {text}"), + Output::Feedback { text, error } | Output::Reply { text, error, .. } => { format!("{}: {text}", if error { "error" } else { "feedback" }) } Output::Command { line } => format!("command: /{line}"), @@ -285,7 +319,7 @@ mod tests { .unwrap(); assert!(e.contains("signature"), "{e}"); let e = check(&pack, Kind::Shader, None, None).err().unwrap(); - assert!(e.contains("shader packs open"), "{e}"); + assert!(e.contains("horizon-shaders.toml"), "{e}"); assert!(check(&pack, Kind::Mod, None, None).is_err()); } } diff --git a/crates/horizon-client/Cargo.toml b/crates/horizon-client/Cargo.toml index d7c6d812b..f1011c534 100644 --- a/crates/horizon-client/Cargo.toml +++ b/crates/horizon-client/Cargo.toml @@ -12,6 +12,7 @@ horizon-assets = { path = "../horizon-assets" } horizon-core = { path = "../horizon-core" } # The server thread ahead of the workers (MinecraftServer.spin's Thread.setPriority). horizon-threads = { path = "../horizon-threads" } +horizon-hdr = { path = "../horizon-hdr" } horizon-world = { path = "../horizon-world" } horizon-protocol = { path = "../horizon-protocol" } # server.properties, eula.txt and the user lists, shared with horizon-server. diff --git a/crates/horizon-client/examples/probe/cushion_placement_probe.rs b/crates/horizon-client/examples/probe/cushion_placement_probe.rs new file mode 100644 index 000000000..45fbdbd72 --- /dev/null +++ b/crates/horizon-client/examples/probe/cushion_placement_probe.rs @@ -0,0 +1,89 @@ +use horizon_client::{ + Result, + cushion::{self, World}, +}; +use horizon_core::geometry::{Aabb, ShapeOp, Vec3, VoxelShape}; +use serde_json::Value; +use std::{ + collections::HashMap, + fs::File, + io::{BufRead, BufReader, BufWriter, Write}, +}; + +struct Cell { + outline: VoxelShape, + collision: VoxelShape, + suffocating: bool, +} +struct Fixture(HashMap<[i32; 3], Cell>); +impl World for Fixture { + fn outline_bounds(&self, p: [i32; 3]) -> Option { + self.0 + .get(&p)? + .outline + .bounds() + .map(|b| b.move_by(Vec3::new(p[0] as f64, p[1] as f64, p[2] as f64))) + } + fn collision_shapes(&self, _: Aabb) -> Vec { + self.0 + .iter() + .map(|(p, c)| { + c.collision + .moved(Vec3::new(p[0] as f64, p[1] as f64, p[2] as f64)) + }) + .collect() + } + fn suffocating(&self, p: [i32; 3]) -> bool { + self.0.get(&p).is_some_and(|c| c.suffocating) + } +} +fn shape(value: &Value) -> Result { + let mut shape = VoxelShape::empty(); + for b in value.as_array().unwrap() { + let f = |i: usize| b[i].as_f64().unwrap(); + shape = shape.join( + &VoxelShape::from_box(Aabb::new( + Vec3::new(f(0), f(1), f(2)), + Vec3::new(f(3), f(4), f(5)), + ))?, + ShapeOp::OR, + )?; + } + Ok(shape) +} +pub fn main() -> Result<()> { + let args: Vec<_> = crate::args().collect(); + let mut out = BufWriter::new(File::create(&args[2])?); + for line in BufReader::new(File::open(&args[1])?).lines() { + let row: Value = serde_json::from_str(&line?)?; + let mut world = Fixture(HashMap::new()); + for c in row["cells"].as_array().unwrap() { + let p = std::array::from_fn(|i| c[i].as_i64().unwrap() as i32); + world.0.insert( + p, + Cell { + outline: shape(&c[3])?, + collision: shape(&c[4])?, + suffocating: c[5].as_bool().unwrap(), + }, + ); + } + let p = &row["pos"]; + let (x, y, z) = ( + p[0].as_f64().unwrap(), + p[1].as_f64().unwrap(), + p[2].as_f64().unwrap(), + ); + let bounds = Aabb::new( + Vec3::new(x - 0.5, y, z - 0.5), + Vec3::new(x + 0.5, y + 0.25, z + 0.5), + ); + writeln!( + out, + "{} {}", + cushion::can_place(&world, bounds), + cushion::survives(&world, bounds) + )?; + } + Ok(()) +} diff --git a/crates/horizon-client/examples/probe/entity_anim_fixture.rs b/crates/horizon-client/examples/probe/entity_anim_fixture.rs index 0a2e2951f..4aceb9f6f 100644 --- a/crates/horizon-client/examples/probe/entity_anim_fixture.rs +++ b/crates/horizon-client/examples/probe/entity_anim_fixture.rs @@ -9,7 +9,7 @@ use horizon_client::mesher::Vertex; use horizon_client::mobs::{ Mob, MobData, MobTypes, Part, Species, allay, anim::{self, Poses, State}, - aquatic, body_anim as b_anim, equine, guardian, + aquatic, bat, body_anim as b_anim, equine, guardian, keyframes::AnimationState, render, shulker, sniffer, species, tame, }; @@ -108,6 +108,22 @@ fn entity_state(mob: &mut Mob, species: Species, case: &Value) { let flag = |k: &str| case[k].as_bool().unwrap_or(false); let num = |k: &str| case[k].as_f64().unwrap_or(0.0) as f32; match species { + Species::Bat => { + mob.extra.flag = flag("isResting"); + mob.anim.states[0].started = case["flyAnimationState"].as_f64().map(|v| v as f32); + mob.anim.states[1].started = case["restAnimationState"].as_f64().map(|v| v as f32); + if let Some(ticks) = case["@batTicks"].as_array() { + for (i, flags) in ticks.iter().enumerate() { + mob.age = i as u32 + 1; + bat::set_resting(mob, flags.as_i64().unwrap_or(0) & 1 != 0); + if flag("@batInFrame") { + bat::tick(mob); + } else { + bat::setup_animation_states(mob); + } + } + } + } Species::Sheep => mob.extra.anim_ticks = num("eatTick") as i32, Species::Guardian | Species::ElderGuardian => { mob.anim.v[guardian::TAIL] = num("tailAnimation"); @@ -377,7 +393,7 @@ pub fn main() -> horizon_client::Result<()> { mob.extra.age = -24000; } mob.age = f("ageInTicks") as u32; - let state = State { + let mut state = State { pos: f("walkAnimationPos"), speed: f("walkAnimationSpeed"), age: f("ageInTicks"), @@ -389,6 +405,20 @@ pub fn main() -> horizon_client::Result<()> { }; let mut poses = Poses::new(&model); entity_state(&mut mob, def.species, case); + if let Some(ticks) = case["@walkTicks"].as_array() { + for speed in ticks { + mob.previous_limb_speed = mob.limb_speed; + mob.limb_speed += (speed.as_f64().unwrap() as f32 - mob.limb_speed) * 0.4; + mob.limb_position += mob.limb_speed; + } + if !case["@alive"].as_bool().unwrap() { + mob.health = 0.0; + } + let extracted = anim::state(&mob, f("@partial")); + state.pos = extracted.pos; + state.speed = extracted.speed; + } + let flag = |k: &str| case[k].as_bool().unwrap_or(false); let num = |k: &str| case[k].as_f64().unwrap_or(0.0) as f32; let started = |k: &str| AnimationState { @@ -456,14 +486,6 @@ pub fn main() -> horizon_client::Result<()> { roll_amount: num("rollAmount"), }, ), - Species::Bat => b_anim::bat( - p, - s, - flag("isResting"), - &started("flyAnimationState"), - &started("restAnimationState"), - &animations, - ), Species::Armadillo => b_anim::armadillo( p, s, @@ -590,7 +612,11 @@ pub fn main() -> horizon_client::Result<()> { } _ => anim::setup(&mob, s, p, &animations), } - out.push_str(&format!("{}\n", emit(&model, &mut poses, case, layer))); + let mut result = emit(&model, &mut poses, case, layer); + if case["@walkTicks"].is_array() { + result["walk"] = json!([state.pos, state.speed]); + } + out.push_str(&format!("{result}\n")); } fs::write(&args[2], out)?; Ok(()) diff --git a/crates/horizon-client/examples/probe/main.rs b/crates/horizon-client/examples/probe/main.rs index e80088fd0..1e1bc04d9 100644 --- a/crates/horizon-client/examples/probe/main.rs +++ b/crates/horizon-client/examples/probe/main.rs @@ -28,6 +28,7 @@ mod cloud_fixture; mod command_parse_fixture; mod container_screen_probe; mod creative_search_fixture; +mod cushion_placement_probe; mod emitter_particles_probe; mod enchanting_fixture; mod entity_anim_fixture; @@ -107,6 +108,7 @@ probes! { block_transform_fixture, breaking_fixture, camera_probe, + cushion_placement_probe, cauldron_fixture, chat_screen_fixture, cloud_fixture, diff --git a/crates/horizon-client/examples/probe/mob_ai_probe.rs b/crates/horizon-client/examples/probe/mob_ai_probe.rs index 49f56c250..ecdf02901 100644 --- a/crates/horizon-client/examples/probe/mob_ai_probe.rs +++ b/crates/horizon-client/examples/probe/mob_ai_probe.rs @@ -49,6 +49,7 @@ struct Scenario { name: String, ticks: i32, time: i64, + difficulty: u8, rain: bool, thunder: bool, origin: [i32; 2], @@ -85,11 +86,13 @@ fn parse(text: &str) -> Vec { "scenario" => { s.name = f[1].to_owned(); s.time = 6000; + s.difficulty = 2; for kv in &f[2..] { let (k, v) = kv.split_once('=').unwrap_or((kv, "")); match k { "ticks" => s.ticks = v.parse().unwrap(), "time" => s.time = v.parse().unwrap(), + "difficulty" => s.difficulty = v.parse().unwrap(), "rain" => s.rain = true, "thunder" => s.thunder = true, "levelseed" => {} @@ -954,6 +957,10 @@ pub fn main() -> horizon_client::Result<()> { for flag in &spec.flags { match flag.as_str() { "persistent" => m.persistent = true, + "named" => { + m.custom_name = Some("Peaceful regression".into()); + m.persistent = true; + } "ridden" => { m.extra.head = Some("minecraft:red_harness".into()); m.rider = Some(horizon_client::mobs::equine::Rider::default()); @@ -1090,7 +1097,7 @@ pub fn main() -> horizon_client::Result<()> { block_tags: &items.block_tags, biomes: &biomes, mob_griefing: true, - difficulty: LocalDifficulty::new(2, world.day_time, 0, 0.0), + difficulty: LocalDifficulty::new(s.difficulty, world.day_time, 0, 0.0), end: false, world_seed: 0, // FlatLevelSource.getSeaLevel. diff --git a/crates/horizon-client/examples/probe/section_mesh_fixture.rs b/crates/horizon-client/examples/probe/section_mesh_fixture.rs index e212a5268..89624b78c 100644 --- a/crates/horizon-client/examples/probe/section_mesh_fixture.rs +++ b/crates/horizon-client/examples/probe/section_mesh_fixture.rs @@ -7,7 +7,7 @@ use horizon_client::{ biome::{BiomeInfo, Biomes, GrassModifier}, blocks::BlockFacts, chunk::{Chunk, Light, MIN_Y, index}, - mesher::{MeshTables, Mesher, OPAQUE_LAYER, TerrainVertex}, + mesher::{EMISSION_BITS, MeshTables, Mesher, OPAQUE_LAYER, TerrainVertex}, models, }; use horizon_core::biome::BiomeZoom; @@ -161,7 +161,15 @@ fn scene( .iter() .map(|v| { let ([x, y, z], [u, w]) = (v.pos, v.uv()); - json!([x, y, z, u, w, argb(v.color), light_coords(v.light)]) + json!([ + x, + y, + z, + u, + w, + argb(v.color | EMISSION_BITS), + light_coords(v.light) + ]) }) .collect(); quads.push(json!({"layer": layer, "sprite": sprite, "vertices": vertices})); diff --git a/crates/horizon-client/src/animate_tick.rs b/crates/horizon-client/src/animate_tick.rs index 48e8f16f4..b3a587114 100644 --- a/crates/horizon-client/src/animate_tick.rs +++ b/crates/horizon-client/src/animate_tick.rs @@ -58,7 +58,10 @@ enum Animate { BubbleColumn { drag: bool, }, - Fire, + /// `BaseFireBlock` (`SoulFireBlock.canBurn` is always true). + Fire { + soul: bool, + }, /// An active sculk sensor. SculkSensor, /// Potent sulfur that is not dry. @@ -140,7 +143,8 @@ fn classify(name: &str, prop: &dyn Fn(&str) -> Option) -> Animate { "bubble_column" => Animate::BubbleColumn { drag: prop("drag").as_deref() == Some("true"), }, - "fire" | "soul_fire" => Animate::Fire, + "fire" => Animate::Fire { soul: false }, + "soul_fire" => Animate::Fire { soul: true }, "dried_ghast" => Animate::DriedGhast { waterlogged: prop("waterlogged").as_deref() == Some("true"), }, @@ -190,6 +194,8 @@ pub struct AnimateTables { power_transmitter: Vec, /// `#triggers_ambient_dried_ghast_block_sounds` (soul sand, soul soil). dried_ghast_sounds: Vec, + /// `FireBlock.canBurn`: states with ignite odds above zero (none waterlogged). + burnable: Vec, /// Biome id -> ambient particles and probabilities (`minecraft:visual/ambient_particles`). ambient: Vec>, } @@ -220,6 +226,21 @@ impl AnimateTables { }) .collect() }; + let behaviour: serde_json::Value = + serde_json::from_slice(&std::fs::read(root.join("block-behaviours.json"))?)?; + let ignite_odds = behaviour["fire"]["igniteOdds"].as_object(); + let burnable = (0..registry.len() as u32) + .map(|id| { + // FireBlock.getIgniteOdds: a waterlogged state never burns. + registry.state(BlockStateId(id)).is_some_and(|s| { + s.properties.get("waterlogged").map(String::as_str) != Some("true") + && ignite_odds + .and_then(|m| m.get(s.name.as_str())) + .and_then(serde_json::Value::as_i64) + .is_some_and(|odds| odds > 0) + }) + }) + .collect(); let mut ambient = vec![Vec::new(); biomes.list.len()]; for (name, &id) in &biomes.index { let path = root.join(format!( @@ -248,6 +269,7 @@ impl AnimateTables { power_provider: by_state("minecraft:enchantment_power_provider"), power_transmitter: by_state("minecraft:enchantment_power_transmitter"), dried_ghast_sounds: by_state("minecraft:triggers_ambient_dried_ghast_block_sounds"), + burnable, ambient, }) } @@ -1103,7 +1125,7 @@ fn block_animate_tick( } } } - Animate::Fire => { + Animate::Fire { soul } => { let r = engine.random(); if next_int(r, 24) == 0 { let (volume, pitch) = (1.0 + r.next_float(), r.next_float() * 0.7 + 0.3); @@ -1115,6 +1137,55 @@ fn block_animate_tick( pitch, ); } + // BaseFireBlock.animateTick: three large smoke above the fire, or + // two at each burnable neighbour's face when nothing burnable or + // sturdy supports it (SoulFireBlock.canBurn is always true). + let can_burn = |p: [i32; 3]| { + soul || tables + .burnable + .get(ctx.state(p).0 as usize) + .copied() + .unwrap_or(false) + }; + let below = [pos[0], pos[1] - 1, pos[2]]; + let sturdy = ctx.facts.get(ctx.state(below)).sturdy_full & (1 << 1) != 0; + if !can_burn(below) && !sturdy { + // (neighbour, coordinate axis, face at the axis' high end): the + // west, east, north, south and above faces, in vanilla order. + for (at, axis, high) in [ + ([pos[0] - 1, pos[1], pos[2]], 0usize, false), + ([pos[0] + 1, pos[1], pos[2]], 0, true), + ([pos[0], pos[1], pos[2] - 1], 2, false), + ([pos[0], pos[1], pos[2] + 1], 2, true), + ([pos[0], pos[1] + 1, pos[2]], 1, true), + ] { + if !can_burn(at) { + continue; + } + for _ in 0..2 { + let r = engine.random(); + let d = [r.next_double(), r.next_double(), r.next_double()]; + let mut p = [fx + d[0], fy + d[1], fz + d[2]]; + // The face coordinate hugs the edge: `* 0.1F` (float). + p[axis] = if high { + f64::from(pos[axis]) + 1.0 - d[axis] * f64::from(0.1f32) + } else { + f64::from(pos[axis]) + d[axis] * f64::from(0.1f32) + }; + add(engine, T::LargeSmoke, p, [0.0; 3]); + } + } + } else { + for _ in 0..3 { + let r = engine.random(); + let p = [ + fx + r.next_double(), + fy + r.next_double() * 0.5 + 0.5, + fz + r.next_double(), + ]; + add(engine, T::LargeSmoke, p, [0.0; 3]); + } + } } } } diff --git a/crates/horizon-client/src/benchmark.rs b/crates/horizon-client/src/benchmark.rs index bcb94589c..12e38e78a 100644 --- a/crates/horizon-client/src/benchmark.rs +++ b/crates/horizon-client/src/benchmark.rs @@ -323,10 +323,15 @@ const QUIET_MESHES_PER_S: f64 = 100.0; /// happened (`tools/perf_bench.py`'s `wait_loaded`). With `status.streaming`, the sections are /// drawn once no stage has held work for half a second: blocks changing after the load (fluids /// settling, random ticks) only remesh in bursts. Without it, meshing has to go quiet. +/// +/// Right after a teleport (and at spawn) the game reports nothing queued and steady counts for over +/// a second before it starts loading: the counts must change once, or stay full for 5 s, and the +/// resident chunks reach [`view_chunks`], before "steady" means loaded. fn wait_loaded(control: &Control, near: impl Fn(&Value) -> bool) -> Result { let deadline = Instant::now() + LOAD_LIMIT; let (mut last, mut changed, mut meshing) = (None, Instant::now(), Instant::now()); let mut previous: Option<(Instant, f64)> = None; + let (mut first, mut moved, began) = (None, false, Instant::now()); while Instant::now() < deadline { let s = control.status(); let now = Instant::now(); @@ -339,6 +344,19 @@ fn wait_loaded(control: &Control, near: impl Fn(&Value) -> bool) -> Result 0 + && resident >= min_chunks + && now - began > Duration::from_secs(5)); + if min_chunks > 0 && (!moved || resident < min_chunks) { + (last, changed, previous, meshing) = (None, now, None, now); + thread::sleep(Duration::from_millis(50)); + continue; + } if last != Some(counts) { (last, changed) = (Some(counts), now); } @@ -370,6 +388,12 @@ fn wait_loaded(control: &Control, near: impl Fn(&Value) -> bool) -> Result u64 { + (0.8 * std::f64::consts::PI * (distance * distance) as f64) as u64 +} + /// Vanilla's yaw facing from `start` to `end`. fn yaw(start: [f64; 3], end: [f64; 3]) -> f64 { (-(end[0] - start[0])).atan2(end[2] - start[2]).to_degrees() @@ -420,6 +444,13 @@ mod tests { assert!(scenes("nether").is_none()); } + #[test] + fn view_chunks_matches_perf_bench() { + assert_eq!(view_chunks(12), 361); + assert_eq!(view_chunks(32), 2573); + assert_eq!(view_chunks(0), 0); + } + #[test] fn yaw_matches_vanilla() { // South (+Z) is 0, west (-X) 90, east (+X) -90. diff --git a/crates/horizon-client/src/bin/horizon-ctl/main.rs b/crates/horizon-client/src/bin/horizon-ctl/main.rs index 402808e81..33ea1f870 100644 --- a/crates/horizon-client/src/bin/horizon-ctl/main.rs +++ b/crates/horizon-client/src/bin/horizon-ctl/main.rs @@ -610,12 +610,17 @@ mod tests { #[test] fn unreachable_games_fail_with_status_3() { - let mut s = Session::new(std::env::temp_dir().join("horizon-ctl-nobody.sock"), None); + let home = + std::env::temp_dir().join(format!("horizon-ctl-unreachable-{}", std::process::id())); + std::fs::create_dir_all(&home).unwrap(); + let mut s = Session::new(home.join("nobody.sock"), None); + s.home = home.clone(); let f = s.run(&["state".to_owned()]).unwrap_err(); assert_eq!(f.status, UNREACHABLE); assert_eq!(f.reply["kind"], "connection"); let f = s.run(&["sleep".to_owned(), "x".to_owned()]).unwrap_err(); assert_eq!(f.status, USAGE); + std::fs::remove_dir_all(home).unwrap(); } #[test] diff --git a/crates/horizon-client/src/block_entity_nbt.rs b/crates/horizon-client/src/block_entity_nbt.rs index 54d230eb4..a4c02ba3b 100644 --- a/crates/horizon-client/src/block_entity_nbt.rs +++ b/crates/horizon-client/src/block_entity_nbt.rs @@ -664,7 +664,9 @@ pub fn canonical(tag: &Tag) -> Option { } "minecraft:trial_spawner" => { // `TrialSpawnerStateData.Packed` and `FullConfig`: every key is optional - // and defaulted by vanilla; they are kept as loaded. + // and defaulted by vanilla; they are kept as loaded. No `spawn_data` is + // added: an absent one loads as Optional.empty and is not stored, and + // an empty entity would keep the spawner from ever picking a mob. if let Tag::Compound(c) = tag { for (k, v) in c { let key = k.to_string_lossy(); @@ -676,12 +678,6 @@ pub fn canonical(tag: &Tag) -> Option { } } } - if !f.out.contains_key(&"spawn_data".into()) { - f.put( - "spawn_data", - Tag::compound([("entity", Tag::Compound(Compound::new()))]), - ); - } } "minecraft:vault" => { // `VaultConfig.DEFAULT` (when the config is absent): the trial key and the @@ -827,6 +823,21 @@ mod tests { canonical(&snbt(s)).expect("known type") } + #[test] + fn a_trial_spawner_without_spawn_data_saves_none() { + let fresh = canon( + r#"{id:"minecraft:trial_spawner",x:1,y:2,z:3,normal_config:"minecraft:trial_chamber/ranged/skeleton/normal"}"#, + ); + assert_eq!(fresh.get("spawn_data"), None); + let picked = canon( + r#"{id:"minecraft:trial_spawner",x:1,y:2,z:3,spawn_data:{entity:{id:"minecraft:skeleton"}}}"#, + ); + assert_eq!( + picked.get("spawn_data"), + Some(&snbt(r#"{entity:{id:"minecraft:skeleton"}}"#)) + ); + } + #[test] fn every_type_has_defaults() { for id in TYPES.iter().chain(NEWEST.iter()) { diff --git a/crates/horizon-client/src/block_entity_render.rs b/crates/horizon-client/src/block_entity_render.rs index 10c5e2509..28a876d80 100644 --- a/crates/horizon-client/src/block_entity_render.rs +++ b/crates/horizon-client/src/block_entity_render.rs @@ -558,12 +558,11 @@ fn frac(x: f32) -> f32 { /// `StringSplitter.splitLines(...).get(0)` for plain text: the first line, /// wrapped at the last space that fits or mid-word when none does. fn first_line(line: &str, max_width: f32, advance: &dyn Fn(char) -> f32) -> String { - let chars: Vec = line.chars().collect(); let mut width = 0.0; let mut last_space = None; - for (i, &c) in chars.iter().enumerate() { + for (i, c) in line.char_indices() { if c == '\n' { - return chars[..i].iter().collect(); + return line[..i].to_owned(); } if c == ' ' { last_space = Some(i); @@ -572,9 +571,11 @@ fn first_line(line: &str, max_width: f32, advance: &dyn Fn(char) -> f32) -> Stri if width > max_width { let end = match last_space { Some(s) if s > 0 => s, - _ => i.max(1), + _ if i > 0 => i, + // The first char alone is too wide: take that one char. + _ => c.len_utf8(), }; - return chars[..end].iter().collect(); + return line[..end].to_owned(); } } line.to_owned() @@ -2098,4 +2099,13 @@ mod tests { assert_eq!(out[1].pos, [2.0, 0.0, 0.0]); assert_eq!(out[2].uv, [0.5, 0.5]); } + + #[test] + fn first_line_wraps_on_bytes_without_splitting_a_char() { + let advance = |c: char| if c == ' ' { 4.0 } else { 6.0 }; + assert_eq!(first_line("ab cd ef", 13.0, &advance), "ab"); + assert_eq!(first_line("abcdef", 13.0, &advance), "ab"); + assert_eq!(first_line("\u{6771}", 3.0, &advance), "\u{6771}"); + assert_eq!(first_line("ab\ncd", 100.0, &advance), "ab"); + } } diff --git a/crates/horizon-client/src/bundle.rs b/crates/horizon-client/src/bundle.rs index 8658b5815..42473729f 100644 --- a/crates/horizon-client/src/bundle.rs +++ b/crates/horizon-client/src/bundle.rs @@ -166,6 +166,38 @@ impl Contents { Some(stack) } + /// The stacks inside, in display order (the first is the next out). + pub fn items(&self) -> &[ItemStack] { + &self.items + } + + /// `getNumberOfItemsToShow`: a full grid shows 11 and a `+N`, so the last + /// row keeps its fourth cell for the count. + pub fn shown_count(&self) -> usize { + let count = self.items.len(); + let available: usize = if count > 12 { 11 } else { 12 }; + let on_last_row = count % 4; + let empty = if on_last_row == 0 { 0 } else { 4 - on_last_row }; + count.min(available.saturating_sub(empty)) + } + + /// The items the tooltip shows, and how many sit beyond them. + pub fn shown(&self) -> (&[ItemStack], u32) { + let n = self.shown_count(); + let hidden = self.items[n..].iter().map(|s| s.count).sum(); + (&self.items[..n], hidden) + } + + /// The `Fraction` weight as the float the progress bar reads. + pub fn weight_fraction(&self) -> f32 { + self.weight.n as f32 / self.weight.d as f32 + } + + /// `Fraction.ONE`: a full bundle draws the full bar and says so. + pub fn is_full(&self) -> bool { + self.weight.n >= self.weight.d + } + /// `toImmutable`, written back into the bundle's component. pub fn store(self, bundle: &mut ItemStack) { bundle.data_mut().bundle_contents = self.items; @@ -190,3 +222,174 @@ mod tests { assert_eq!(over.how_many(Weight::new(1, 64)), 0); } } + +// ------------------------------------------------------------- the tooltip + +/// `ClientBundleTooltip`'s geometry, relative to the tooltip box's top-left: +/// the 96 pixel column of a 4 wide slot grid and the progress bar under it. +#[derive(Clone, Debug, PartialEq)] +pub struct TooltipLayout { + /// The component's own width (96) and height, the text's excluded. + pub width: f32, + pub height: f32, + /// Each slot's top-left and the stack in it, in reading order. + pub slots: Vec<([f32; 2], ItemStack)>, + /// The `+N` of the items past the grid: its top-left and the count. + pub overflow: Option<([f32; 2], u32)>, + /// The progress bar's top-left, its fill's width out of 94, and whether + /// the weight fills it (the full sprite). + pub bar: [f32; 2], + pub fill: f32, + pub full: bool, + /// `item.minecraft.bundle.empty` / `.full`, centred over the bar. + pub label: Option<&'static str>, + /// An empty bundle's description, wrapped at `width` from here. + pub empty_description: Option<[f32; 2]>, +} + +/// The tooltip of a bundle's contents (`ClientBundleTooltip`), or None when +/// the stack is not a bundle. `x`/`y` are the box's top-left, `box_width` the +/// tooltip's width, which the component is centred in. +pub fn tooltip_layout( + items: &Items, + stack: &ItemStack, + x: f32, + y: f32, + box_width: f32, +) -> Option { + let contents = Contents::of(items, stack)?; + let offset = ((box_width - 96.0) / 2.0).floor(); + if contents.items().is_empty() { + // The description takes the top; the bar follows it. + let description_height = 9.0 * 2.0; + return Some(TooltipLayout { + width: 96.0, + height: description_height + 13.0 + 8.0, + slots: Vec::new(), + overflow: None, + bar: [x + offset, y + description_height + 4.0], + fill: 0.0, + full: false, + label: Some("item.minecraft.bundle.empty"), + empty_description: Some([x + offset, y]), + }); + } + let (shown, hidden) = contents.shown(); + // `gridSizeY` counts `slotCount()` (at most twelve), not the slots the + // overflow count leaves room for. + let rows = contents.items().len().min(12).div_ceil(4).max(1); + let grid_height = rows as f32 * 24.0; + let x_start = x + offset + 96.0; + let y_start = y + grid_height; + let mut slots = Vec::with_capacity(shown.len()); + let mut overflow = None; + // Rows fill bottom-up and columns right-to-left, as vanilla draws them. + let mut slot = 0; + for row in 1..=rows { + for column in 1..=4 { + let at = [x_start - column as f32 * 24.0, y_start - row as f32 * 24.0]; + if hidden > 0 && row == 1 && column == 1 { + overflow = Some((at, hidden)); + } else if let Some(stack) = shown.get(slot) { + slots.push((at, stack.clone())); + slot += 1; + } + } + } + let weight = contents.weight_fraction(); + Some(TooltipLayout { + width: 96.0, + height: grid_height + 13.0 + 8.0, + slots, + overflow, + bar: [x + offset, y + grid_height + 4.0], + // `Mth.mulAndTruncate(weight, 94)`, kept within the bar. + fill: (weight * 94.0).trunc().clamp(0.0, 94.0), + full: contents.is_full(), + label: if contents.is_full() { + Some("item.minecraft.bundle.full") + } else { + None + }, + empty_description: None, + }) +} + +#[cfg(test)] +mod tooltip_tests { + use super::*; + + /// The prepared resources, when they are on this machine: the tooltip + /// asks the item registry whether a stack is a bundle. + fn items() -> Option { + let root = std::path::PathBuf::from(env!("CARGO_MANIFEST_DIR")) + .join("../../.local/horizon-client/26.3"); + if !root.join("items.json").exists() { + return None; + } + let assets = crate::assets::Assets::load(&root).ok()?; + let facts = crate::blocks::BlockFacts::load(&root, assets.registry).ok()?; + Items::load(&root, assets.registry, &facts).ok() + } + + fn bundle_with(counts: &[(&str, u32)]) -> ItemStack { + let mut bundle = ItemStack::new("minecraft:bundle", 1); + bundle.data_mut().bundle_contents = counts + .iter() + .map(|(item, n)| ItemStack::new(item, *n)) + .collect(); + bundle + } + + #[test] + fn a_grid_shows_twelve_stacks_and_counts_the_rest() { + let Some(items) = items() else { return }; + let twelve: Vec<(&str, u32)> = (0..12).map(|_| ("minecraft:stone", 1)).collect(); + let layout = tooltip_layout(&items, &bundle_with(&twelve), 0.0, 0.0, 96.0).unwrap(); + assert_eq!(layout.slots.len(), 12); + assert_eq!(layout.overflow, None); + assert_eq!(layout.height, 3.0 * 24.0 + 13.0 + 8.0); + // Rows fill bottom-up and columns right-to-left: the first item is in + // the bottom-right cell, the twelfth in the top-left. + assert_eq!(layout.slots[0].0, [96.0 - 24.0, 3.0 * 24.0 - 24.0]); + assert_eq!(&*layout.slots[0].1.item, "minecraft:stone"); + assert_eq!(layout.slots[11].0, [0.0, 0.0]); + // A wider tooltip centres the 96 pixel column in it. + let centred = tooltip_layout(&items, &bundle_with(&twelve), 0.0, 0.0, 120.0).unwrap(); + assert_eq!(centred.slots[0].0[0], 12.0 + 96.0 - 24.0); + // Thirteen stacks: `getNumberOfItemsToShow` leaves the last row room + // for the count, so 8 slots show and `+6` (four stones and two dirt) + // takes the first cell. + let mut counts = twelve; + counts.push(("minecraft:dirt", 2)); + let layout = tooltip_layout(&items, &bundle_with(&counts), 0.0, 0.0, 96.0).unwrap(); + assert_eq!(layout.slots.len(), 8); + assert_eq!(layout.overflow, Some(([96.0 - 24.0, 48.0], 6))); + } + + #[test] + fn the_bar_fills_with_the_weight_and_an_empty_bundle_explains_itself() { + let Some(items) = items() else { return }; + let layout = tooltip_layout(&items, &bundle_with(&[]), 4.0, 8.0, 96.0).unwrap(); + assert!(layout.slots.is_empty()); + assert_eq!(layout.fill, 0.0); + assert_eq!(layout.label, Some("item.minecraft.bundle.empty")); + assert_eq!(layout.empty_description, Some([4.0, 8.0])); + assert_eq!(layout.bar, [4.0, 8.0 + 18.0 + 4.0]); + // A bundle holding one 64 stack is full: the whole bar, the full label. + let layout = tooltip_layout( + &items, + &bundle_with(&[("minecraft:stone", 64)]), + 0.0, + 0.0, + 96.0, + ) + .unwrap(); + assert!(layout.full); + assert_eq!(layout.fill, 94.0); + assert_eq!(layout.label, Some("item.minecraft.bundle.full")); + // Something that is not a bundle has no component. + let dirt = ItemStack::new("minecraft:dirt", 1); + assert!(tooltip_layout(&items, &dirt, 0.0, 0.0, 96.0).is_none()); + } +} diff --git a/crates/horizon-client/src/chat_tests.rs b/crates/horizon-client/src/chat_tests.rs index 6b058c0fb..beec6cd81 100644 --- a/crates/horizon-client/src/chat_tests.rs +++ b/crates/horizon-client/src/chat_tests.rs @@ -436,3 +436,34 @@ fn the_chat_option_filters_the_lines_both_ways() { chat.set_abilities(&font, ChatAbilities::new(ChatVisibility::Full)); assert_eq!(shown(&chat), ["client", "server", "player"]); } + +/// The in-frame LAN host's chat: a guest's line is a player message, so the +/// Chat option's player-message permission hides it at Commands Only and +/// Hidden; command feedback (`/list`, `/tp`) is a system message and stays +/// at Commands Only. +#[test] +fn a_guests_line_follows_the_player_message_permission() { + let font = font(); + let shown = |visibility, source| { + let mut chat = Chat::default(); + chat.set_abilities(&font, ChatAbilities::new(visibility)); + chat.add_message(&font, Text::literal("line"), None, source, 0, false); + chat.messages.len() + }; + for (visibility, player, system) in [ + (ChatVisibility::Full, 1, 1), + (ChatVisibility::System, 0, 1), + (ChatVisibility::Hidden, 0, 0), + ] { + assert_eq!( + shown(visibility, ChatSource::Player), + player, + "{visibility:?}" + ); + assert_eq!( + shown(visibility, ChatSource::Server), + system, + "{visibility:?}" + ); + } +} diff --git a/crates/horizon-client/src/chunk.rs b/crates/horizon-client/src/chunk.rs index 41330df5f..7cd375343 100644 --- a/crates/horizon-client/src/chunk.rs +++ b/crates/horizon-client/src/chunk.rs @@ -24,6 +24,20 @@ pub fn block_strategy() -> Strategy { Strategy::blocks(BLOCK_BITS.load(std::sync::atomic::Ordering::Relaxed)) } +/// Frees `columns` (`count` of them) on a short-lived thread of its own +/// when there are many: a teleport or a dimension change drops a few +/// thousand columns at once, and freeing their sections took the frame +/// 15-20 ms. A few are freed here. +pub fn free_columns(columns: T, count: usize) { + if count < 64 { + return; + } + // Should the thread not start, the closure drops `columns` here. + let _ = std::thread::Builder::new() + .name("Chunk freeing".into()) + .spawn(move || drop(columns)); +} + /// Sizes the block states' global palette for a registry of `states`. pub fn set_block_states(states: usize) { let bits = horizon_core::paletted::ceil_log2(states).max(16); @@ -147,6 +161,9 @@ pub struct Chunk { /// Structure starts reaching into this chunk (`structures.References`): /// structure id and the start's chunk. pub structure_refs: Vec<(Arc, (i32, i32))>, + /// The starts generation made in this chunk (`structures.starts`), saved + /// with the state their placement has reached by then. + pub structure_starts: Vec>, } impl Chunk { pub fn empty(x: i32, z: i32) -> Self { @@ -164,6 +181,7 @@ impl Chunk { block_entities: Vec::new(), block_names: Vec::new(), structure_refs: Vec::new(), + structure_starts: Vec::new(), postprocess: Vec::new(), saved: None, entities: Vec::new(), diff --git a/crates/horizon-client/src/clipboard.rs b/crates/horizon-client/src/clipboard.rs index c21460cdb..76872091c 100644 --- a/crates/horizon-client/src/clipboard.rs +++ b/crates/horizon-client/src/clipboard.rs @@ -346,6 +346,11 @@ mod tests { assert_eq!(filter_text(s, true), "abc\nde\u{80}"); assert_eq!(strip_formatting("§aRed§r §zx§"), "Red §zx§"); assert_eq!(helper_clipboard_contents("§lone\r\ntwo"), "one\ntwo"); + // TextFieldHelper.getClipboardContents runs before insertText's filter. + assert_eq!( + filter_text(&helper_clipboard_contents("§aHello"), false), + "Hello" + ); } struct Field { diff --git a/crates/horizon-client/src/container_screen.rs b/crates/horizon-client/src/container_screen.rs index 2c490861a..77c7ad8aa 100644 --- a/crates/horizon-client/src/container_screen.rs +++ b/crates/horizon-client/src/container_screen.rs @@ -275,4 +275,30 @@ mod tests { Release::Click(Input::QuickMove) ); } + + /// A press whose release never arrives (the pointer left the window, or + /// the screen closed first) leaves `isQuickCrafting` set; the next screen + /// starts with its own state, as `AbstractContainerScreen` does, so the + /// reset the game runs on open/close makes clicks work again. + #[test] + fn a_lost_release_does_not_wedge_the_next_screen() { + let mut clicks = Clicks::default(); + let slot = Target::::Slot(3); + // Pressed with a stack carried: a quick craft drag starts, and its + // release is lost. + assert_eq!(clicks.press(&slot, Button::Left, false, false, false), None); + assert!(clicks.quick_crafting().is_some()); + assert_eq!( + clicks.press(&slot, Button::Left, true, false, false), + None, + "the stuck drag swallows the next press" + ); + // A new screen: fresh state, so the press is a normal click again. + clicks = Clicks::default(); + assert!(clicks.quick_crafting().is_none()); + assert_eq!( + clicks.press(&slot, Button::Left, true, false, false), + Some(Input::Pickup) + ); + } } diff --git a/crates/horizon-client/src/containers.rs b/crates/horizon-client/src/containers.rs index d13c5e45b..6aba0970e 100644 --- a/crates/horizon-client/src/containers.rs +++ b/crates/horizon-client/src/containers.rs @@ -49,6 +49,17 @@ pub struct Furnace { /// rather than per item, and a save keeps it as the `RecipesUsed` compound. pub recipes_used: HashMap, } +/// The key `recipes_used` keeps a recipe under: its full id, as vanilla's `ResourceKey` +/// writes it in `RecipesUsed`. Horizon's own recipe ids are file names without the namespace, so +/// keeping both forms would write a key twice, and vanilla refuses such a furnace +/// ("Duplicate entry for key"). +pub fn recipe_used_key(id: &str) -> String { + if id.contains(':') { + id.to_owned() + } else { + format!("minecraft:{id}") + } +} /// A hopper's slots: the only plain container with five. pub const HOPPER_SLOTS: usize = 5; @@ -83,9 +94,66 @@ pub enum BlockEntity { Beehive(Box), /// `CommandBlockEntity` of the three command blocks (`crate::command_block`). CommandBlock(Box), + /// `CampfireBlockEntity` of campfires and soul campfires. + Campfire(Box), /// `SkullBlockEntity` of every skull and head block. Skull(Skull), } +/// `CampfireBlockEntity`: four cooking slots, each with its +/// `cookingProgress` and `cookingTime` (the recipe's). +#[derive(Clone, Debug, Default, PartialEq)] +pub struct Campfire { + pub items: [Option; 4], + pub progress: [i32; 4], + pub total: [i32; 4], +} +impl Campfire { + /// `placeFood`'s slot: the first empty one, given the item's + /// `campfire_cooking` time; it takes one item of `held`. + pub fn place_food(&mut self, held: &mut ItemStack, cooking_time: i32) -> bool { + let Some(slot) = self.items.iter().position(Option::is_none) else { + return false; + }; + self.total[slot] = cooking_time; + self.progress[slot] = 0; + self.items[slot] = Some(ItemStack { + count: 1, + ..held.clone() + }); + held.count = held.count.saturating_sub(1); + true + } + /// `cookTick` (lit): each item's progress rises by one; the slots whose + /// progress reached their cooking time give up their item (the caller + /// drops its result). + pub fn cook_tick(&mut self) -> Vec<(usize, ItemStack)> { + let mut done = Vec::new(); + for i in 0..4 { + if self.items[i].is_none() { + continue; + } + self.progress[i] += 1; + if self.progress[i] >= self.total[i] + && let Some(item) = self.items[i].take() + { + done.push((i, item)); + } + } + done + } + /// `cooldownTick` (unlit): the progress falls by two, no lower than 0. + /// Whether anything changed (`setChanged`). + pub fn cooldown_tick(&mut self) -> bool { + let mut changed = false; + for i in 0..4 { + if self.progress[i] > 0 { + changed = true; + self.progress[i] = (self.progress[i] - 2).clamp(0, self.total[i]); + } + } + changed + } +} /// `SkullBlockEntity`: the player profile the head shows (kept as loaded: /// a compound, or a string when it names a player only), the note block /// sound and `custom_name`. @@ -304,6 +372,9 @@ impl BlockEntity { if name == "minecraft:brewing_stand" { return Some(Self::Brewing(Box::new(crate::brewing::BrewingStand::new()))); } + if name == "minecraft:campfire" || name == "minecraft:soul_campfire" { + return Some(Self::Campfire(Box::default())); + } let size = match name { "minecraft:chest" | "minecraft:trapped_chest" | "minecraft:barrel" => 27, n if n.ends_with("copper_chest") => 27, @@ -341,6 +412,7 @@ impl BlockEntity { Self::Beehive(_) => "minecraft:beehive", Self::CommandBlock(_) => "minecraft:command_block", Self::Skull(_) => "minecraft:skull", + Self::Campfire(_) => "minecraft:campfire", } } pub fn contents(&self) -> Vec { @@ -362,6 +434,7 @@ impl BlockEntity { Self::Sculk(_) => Vec::new(), Self::Banner(_) => Vec::new(), Self::Crafter(c) => c.items.iter().flatten().cloned().collect(), + Self::Campfire(c) => c.items.iter().flatten().cloned().collect(), } } pub fn slots(&self) -> &[Option] { @@ -382,7 +455,9 @@ impl BlockEntity { | Self::TrialSpawner(_) | Self::Vault(_) | Self::Beehive(_) - | Self::CommandBlock(_) => &[], + | Self::CommandBlock(_) + // Not a Container (only Clearable): hoppers don't reach in. + | Self::Campfire(_) => &[], } } pub fn slots_mut(&mut self) -> &mut [Option] { @@ -403,7 +478,8 @@ impl BlockEntity { | Self::TrialSpawner(_) | Self::Vault(_) | Self::Beehive(_) - | Self::CommandBlock(_) => &mut [], + | Self::CommandBlock(_) + | Self::Campfire(_) => &mut [], } } } @@ -638,7 +714,10 @@ impl Furnace { Some(out) => out.count += recipe.result.count, None => self.items[2] = Some(recipe.result.clone()), } - *self.recipes_used.entry(recipe.id.clone()).or_insert(0) += 1; + *self + .recipes_used + .entry(recipe_used_key(&recipe.id)) + .or_insert(0) += 1; if let Some(i) = self.items[0].as_mut() { i.count -= 1; if i.count == 0 { @@ -692,6 +771,41 @@ mod tests { use super::*; use horizon_core::random::{LegacyRandom, RandomSource}; + #[test] + fn campfire_slots_take_food_cook_it_and_cool_down() { + let mut c = Campfire::default(); + let mut beef = ItemStack::new("minecraft:beef", 2); + // placeFood: the first free slot, one item, its recipe's time. + assert!(c.place_food(&mut beef, 600)); + assert_eq!(beef.count, 1); + assert_eq!(c.items[0].as_ref().map(|s| s.count), Some(1)); + assert_eq!((c.progress[0], c.total[0]), (0, 600)); + let mut fish = ItemStack::new("minecraft:cod", 1); + assert!(c.place_food(&mut fish, 3)); + assert_eq!(c.items[1].as_ref().map(|s| &*s.item), Some("minecraft:cod")); + // cookTick: the cod is done on its third tick, the beef keeps cooking. + assert!(c.cook_tick().is_empty()); + assert!(c.cook_tick().is_empty()); + let done = c.cook_tick(); + assert_eq!(done.len(), 1); + assert_eq!((done[0].0, &*done[0].1.item), (1, "minecraft:cod")); + assert!(c.items[1].is_none()); + assert_eq!(c.progress[0], 3); + // cooldownTick: two a tick, never below zero. + assert!(c.cooldown_tick()); + assert_eq!(c.progress[0], 1); + assert!(c.cooldown_tick()); + assert_eq!(c.progress[0], 0); + // Full: four slots, no fifth. + for _ in 0..3 { + let mut more = ItemStack::new("minecraft:potato", 1); + assert!(c.place_food(&mut more, 600)); + } + let mut fifth = ItemStack::new("minecraft:potato", 1); + assert!(!c.place_food(&mut fifth, 600)); + assert_eq!(fifth.count, 1); + } + /// A whole amount pays itself without a draw; a fraction is a chance of one more. #[test] fn create_experience_rounds_the_fraction_by_chance() { diff --git a/crates/horizon-client/src/crafting.rs b/crates/horizon-client/src/crafting.rs index 690383963..899ce90d9 100644 --- a/crates/horizon-client/src/crafting.rs +++ b/crates/horizon-client/src/crafting.rs @@ -1612,7 +1612,9 @@ impl Recipes { } /// The `experience` of the cooking recipe with this file name, and 0 for one this data /// pack does not have (a save from another pack can name it). + /// `id` with or without the `minecraft:` namespace (a furnace keeps the full id). pub fn cooking_experience(&self, id: &str) -> f32 { + let id = id.strip_prefix("minecraft:").unwrap_or(id); self.cooking .iter() .find(|c| c.id == id) diff --git a/crates/horizon-client/src/creative.rs b/crates/horizon-client/src/creative.rs index 249e40b11..033b4daec 100644 --- a/crates/horizon-client/src/creative.rs +++ b/crates/horizon-client/src/creative.rs @@ -1,7 +1,7 @@ //! Creative inventory (CreativeModeInventoryScreen): vanilla's tabs and their //! contents as built by the game's own display generators //! (`creative-inventory.json`), a 9x5 scrolling grid and the search tab. -use crate::{Result, items::ItemStack}; +use crate::{Result, items::ItemStack, ui::EditBox}; use serde_json::Value; use std::{collections::HashMap, fs, path::Path}; @@ -35,10 +35,8 @@ pub struct Creative { pub scroll: f32, /// The scrollbar is held (scrolling): dragging moves it. pub scrolling: bool, - pub search: String, - /// When the search box took the focus (`EditBox.setFocused`): its - /// cursor blinks from then. - pub search_focused: std::time::Instant, + /// CreativeModeInventoryScreen's search box: an unbordered `EditBox` of 50. + pub search: EditBox, /// The search tab's stacks, in its display order. search_items: Vec, search_index: Vec, @@ -284,8 +282,13 @@ impl Creative { selected: 0, scroll: 0.0, scrolling: false, - search: String::new(), - search_focused: std::time::Instant::now(), + search: { + let mut search = EditBox::new(0.0, 0.0, 80.0, 9.0); + search.bordered = false; + search.max_length = 50; + search.text_color = u32::MAX; + search + }, search_items, search_index, } @@ -306,12 +309,13 @@ impl Creative { /// selectTab: a different tab empties the search box; the scrollbar goes to the top. pub fn select(&mut self, tab: usize) { if tab != self.selected { - self.search.clear(); + self.search.set_value(""); } self.selected = tab; self.scroll = 0.0; if self.tab().search { - self.search_focused = std::time::Instant::now(); + self.search.focused = true; + self.search.reset_blink(); } } /// The search tab's stacks. @@ -385,7 +389,7 @@ impl Creative { let tab = self.tab(); if tab.search { return self - .search_results(&self.search, names) + .search_results(&self.search.value, names) .into_iter() .map(|i| self.search_items[i].clone()) .collect(); @@ -754,13 +758,13 @@ mod tests { (1, false, true), (2, true, false), ] { - c.search = "anvil".into(); + c.search.set_value("anvil"); c.scroll = 0.5; c.select(selected); assert_eq!(c.selected, selected); assert_eq!(c.tab().inventory, inventory); assert_eq!(c.tab().search, search); - assert!(c.search.is_empty()); + assert!(c.search.value.is_empty()); assert_eq!(c.scroll, 0.0); } } @@ -780,12 +784,12 @@ mod tests { assert_eq!(c.tabs[0].items[0].item.as_ref(), "minecraft:anvil"); let mut c = c; c.select(1); - c.search = "anvil".into(); + c.search.set_value("anvil"); c.scroll = 0.5; c.select(1); - assert_eq!((c.search.as_str(), c.scroll), ("anvil", 0.0)); + assert_eq!((c.search.value.as_str(), c.scroll), ("anvil", 0.0)); c.select(0); - assert_eq!(c.search, ""); + assert_eq!(c.search.value, ""); } #[test] @@ -899,4 +903,25 @@ mod tests { c.scroll = 1.0; assert_eq!(c.scroller_offset(), 95.0); } + + #[test] + fn search_edits_at_its_cursor() { + use winit::keyboard::KeyCode; + let mut c = creative(0); + c.select(1); + c.search.insert_text("hello world"); + for _ in 0..5 { + assert!(c.search.key(KeyCode::ArrowLeft, false, false)); + } + c.search.insert_text("X"); + assert_eq!(c.search.value, "hello Xworld"); + c.search.key(KeyCode::Home, false, true); + c.search.insert_text("Y"); + assert_eq!(c.search.value, "Yworld"); + // Ctrl+Left jumps a word; one step right and Backspace deletes before the cursor. + c.search.key(KeyCode::ArrowLeft, true, false); + c.search.key(KeyCode::ArrowRight, false, false); + c.search.key(KeyCode::Backspace, false, false); + assert_eq!(c.search.value, "world"); + } } diff --git a/crates/horizon-client/src/cushion.rs b/crates/horizon-client/src/cushion.rs new file mode 100644 index 000000000..7610a4aab --- /dev/null +++ b/crates/horizon-client/src/cushion.rs @@ -0,0 +1,59 @@ +//! Cushion placement and support checks (`Cushion.canBePlacedAt`/`wouldSurviveAt`). +use horizon_core::geometry::{Aabb, ShapeOp, Vec3, VoxelShape}; + +pub trait World { + fn outline_bounds(&self, pos: [i32; 3]) -> Option; + fn collision_shapes(&self, bounds: Aabb) -> Vec; + fn suffocating(&self, pos: [i32; 3]) -> bool; +} + +pub fn blocks_in(a: Aabb) -> impl Iterator { + let (lo, hi) = (a.min_position(), a.max_position()); + let (x0, y0, z0) = ( + lo.x.floor() as i32, + lo.y.floor() as i32, + lo.z.floor() as i32, + ); + let (x1, y1, z1) = ( + hi.x.floor() as i32, + hi.y.floor() as i32, + hi.z.floor() as i32, + ); + (y0..=y1).flat_map(move |y| (z0..=z1).flat_map(move |z| (x0..=x1).map(move |x| [x, y, z]))) +} + +pub fn survives(world: &impl World, bounds: Aabb) -> bool { + let (lo, hi) = (bounds.min_position(), bounds.max_position()); + let anchor = Aabb::new( + Vec3::new(lo.x, lo.y - 0.015625, lo.z), + Vec3::new(hi.x.next_down(), lo.y, hi.z.next_down()), + ); + // The extra eighth block expands the scan, not the intersection test. + let supported = blocks_in(anchor.expand_towards(Vec3::new(0.0, -0.125, 0.0))).any(|p| { + world + .outline_bounds(p) + .is_some_and(|shape| shape.intersects(anchor)) + }); + supported && !blocks_in(bounds.next_deflated()).all(|p| world.suffocating(p)) +} + +pub fn can_place(world: &impl World, bounds: Aabb) -> bool { + if !survives(world, bounds) { + return false; + } + let (lo, hi) = (bounds.min_position(), bounds.max_position()); + let slab = Aabb::new(lo, Vec3::new(hi.x, lo.y + 0.015625, hi.z)).next_deflated(); + let Ok(mut remaining) = VoxelShape::from_box(slab) else { + return false; + }; + for shape in world.collision_shapes(slab) { + let Ok(next) = remaining.join(&shape, ShapeOp::ONLY_FIRST) else { + return false; + }; + remaining = next; + if remaining.is_empty() { + return false; + } + } + true +} diff --git a/crates/horizon-client/src/debug_overlay.rs b/crates/horizon-client/src/debug_overlay.rs index 7140905a8..f55d4ee6e 100644 --- a/crates/horizon-client/src/debug_overlay.rs +++ b/crates/horizon-client/src/debug_overlay.rs @@ -221,18 +221,17 @@ pub fn scale( pub fn draw(font: &Font, columns: [&[String]; 2], scale: f32, width: i32) -> Vec { let mut out = vec![GuiDraw::Push(vec![PoseOp::Scale(scale, scale)])]; for (lines, align_left) in [(columns[0], true), (columns[1], false)] { - let placed: Vec<(&String, i32, i32)> = lines + let placed: Vec<(&String, i32, i32, i32)> = lines .iter() .enumerate() .filter(|(_, l)| !l.is_empty()) .map(|(i, l)| { let w = font.width(l) as i32; let left = if align_left { 2 } else { width - 2 - w }; - (l, left, 2 + LINE_HEIGHT * i as i32) + (l, left, 2 + LINE_HEIGHT * i as i32, w) }) .collect(); - for (line, left, top) in &placed { - let w = font.width(line) as i32; + for (_, left, top, w) in &placed { out.push(fill( left - 1, top - 1, @@ -241,7 +240,7 @@ pub fn draw(font: &Font, columns: [&[String]; 2], scale: f32, width: i32) -> Vec BACKGROUND, )); } - for (line, left, top) in placed { + for (line, left, top, _) in placed { out.push(GuiDraw::Text { text: Text::literal(line.clone()), x: left, diff --git a/crates/horizon-client/src/entities.rs b/crates/horizon-client/src/entities.rs index 65536d710..69e053411 100644 --- a/crates/horizon-client/src/entities.rs +++ b/crates/horizon-client/src/entities.rs @@ -10,6 +10,8 @@ use crate::{ use horizon_core::geometry::{Aabb, Vec3}; use horizon_world::block_collision::BlockCollisionRegistry; +mod fluids; + #[derive(Clone, Debug)] pub struct ItemEntity { pub health: i32, @@ -165,18 +167,16 @@ impl ItemEntity { facts: &BlockFacts, collision: &BlockCollisionRegistry<'_>, no_physics: bool, + fluids: &crate::motion::FluidResources, ) -> bool { self.ticks += 1; self.previous = self.position; if self.pickup_delay > 0 && self.pickup_delay != u32::MAX { self.pickup_delay -= 1; } - let eye = world.block( - self.position.x.floor() as i32, - (self.position.y + 0.1).floor() as i32, - self.position.z.floor() as i32, - ); - let in_water = facts.get(eye).fluid == Fluid::Water; + // Entity.baseTick pushes before ItemEntity applies buoyancy and moves. + let (water_height, lava_height) = self.update_fluids(world, fluids); + let in_water = water_height > f64::from(0.1f32); if in_water { // ItemEntity.setUnderwaterMovement self.velocity = Vec3::new( @@ -184,7 +184,7 @@ impl ItemEntity { self.velocity.y + if self.velocity.y < 0.06 { 5.0e-4 } else { 0.0 }, self.velocity.z * 0.99, ); - } else if facts.get(eye).fluid == Fluid::Lava { + } else if lava_height > f64::from(0.1f32) { self.velocity = Vec3::new( self.velocity.x * 0.95, self.velocity.y + if self.velocity.y < 0.06 { 5.0e-4 } else { 0.0 }, @@ -245,6 +245,8 @@ impl ItemEntity { } } self.age += 1; + // ItemEntity.tick refreshes immersion and pushes again after moving. + self.update_fluids(world, fluids); self.age < 6000 && self.position.y > -128.0 } /// `ItemEntity.isMergable` at `age`: a stack below its size whose pickup @@ -589,6 +591,57 @@ impl Painting { ) } } +/// The `DyeColor` ordinal of a colour name (`DyeColor.byName`), white when +/// the name is unknown. +pub fn dye_index(name: &str) -> u8 { + crate::mobs::render::DYE_NAMES + .iter() + .position(|n| *n == name) + .unwrap_or(0) as u8 +} +/// A cushion (`Cushion`, a `BlockAttachedEntity`): a 1 x 0.25 block pillow +/// that seats a player. It sits on the top face of a block, at the clicked +/// height, and is coloured by its `DyeColor`. +#[derive(Clone, Debug)] +pub struct Cushion { + pub id: u32, + /// `Entity.position`: the bottom centre of the cushion. + pub position: Vec3, + /// `BlockAttachedEntity.pos` (the saved `block_pos`). + pub pos: [i32; 3], + pub yaw: f32, + /// `DyeColor` ordinal: white 0, orange 1, ..., black 15. + pub color: u8, + /// BlockAttachedEntity.ticksSinceLastCheck. + pub check_interval: u32, +} +impl Cushion { + /// `Entity.makeBoundingBox`: x and z half a block out, y to y + 0.25. + pub fn bounds(&self) -> ([f64; 3], [f64; 3]) { + let p = self.position; + ( + [p.x - 0.5, p.y, p.z - 0.5], + [p.x + 0.5, p.y + 0.25, p.z + 0.5], + ) + } + /// The `DyeColor` name of the cushion. + pub fn color_name(&self) -> &'static str { + crate::mobs::render::DYE_NAMES[usize::from(self.color.min(15))] + } + /// `Cushion.getCushionItemStackWithData`: the matching coloured item. + pub fn item(&self) -> String { + format!("minecraft:{}_cushion", self.color_name()) + } + /// `Cushion.interact`'s seat: the vehicle's PASSENGER attachment + /// `(0, 0.25, 0)` less the player's `(0, 0.6, 0)`. + pub fn seat(&self) -> Vec3 { + Vec3::new(self.position.x, self.position.y - 0.35, self.position.z) + } + /// `Entity.getDismountLocationForPassenger`: on top of the cushion. + pub fn dismount(&self) -> Vec3 { + Vec3::new(self.position.x, self.position.y + 0.25, self.position.z) + } +} /// An item frame or glow item frame (`ItemFrame`). #[derive(Clone, Debug)] pub struct ItemFrame { diff --git a/crates/horizon-client/src/entities/fluids.rs b/crates/horizon-client/src/entities/fluids.rs new file mode 100644 index 000000000..fffa0ae2b --- /dev/null +++ b/crates/horizon-client/src/entities/fluids.rs @@ -0,0 +1,216 @@ +//! Dropped-item immersion and currents through the shared vanilla fluid helpers. +use super::ItemEntity; +use crate::{ + motion::{FluidResources, FluidTags, LAVA, WATER}, + world::World, +}; +use horizon_core::{ + geometry::{Aabb, Direction, Vec3}, + position::BlockPos, +}; +use horizon_world::{ + entity_fluid::{ + CurrentTarget, EntityFluidInteraction, FluidInteractionWorld, FluidMembership, + FluidSections, FluidTagId, + }, + fluid::{FluidHeightWorld, FluidKind, FluidState}, + fluid_flow::{FluidFlowWorld, flow_at}, + registry::BlockStateId, +}; +type Error = std::convert::Infallible; +struct ItemFluidWorld<'a> { + item: &'a mut ItemEntity, + world: &'a World, + fluids: &'a FluidResources, +} +impl ItemEntity { + pub(super) fn update_fluids(&mut self, world: &World, fluids: &FluidResources) -> (f64, f64) { + let mut interaction = EntityFluidInteraction::new([WATER, LAVA]); + let mut scene = ItemFluidWorld { + item: self, + world, + fluids, + }; + if interaction.update(&mut scene, false, 4096).is_err() { + return (0.0, 0.0); + } + let water_height = interaction.fluid_height(&scene, WATER); + let lava_height = interaction.fluid_height(&scene, LAVA); + let _ = interaction.apply_current(&mut scene, WATER, 0.014); + let _ = interaction.apply_current( + &mut scene, + LAVA, + if world.fast_lava { + 0.007 + } else { + 0.0023333333333333335 + }, + ); + (water_height, lava_height) + } +} +impl FluidMembership for ItemFluidWorld<'_> { + fn fluid_in_tag(&self, kind: FluidKind, tag: FluidTagId) -> bool { + FluidTags.fluid_in_tag(kind, tag) + } +} +impl CurrentTarget for ItemFluidWorld<'_> { + type Error = Error; + fn is_player_class(&self) -> bool { + false + } + fn velocity(&mut self) -> Result { + Ok(self.item.velocity) + } + fn add_delta_movement(&mut self, delta: Vec3) -> Result<(), Error> { + let v = self.item.velocity; + let sum = Vec3::new(v.x + delta.x, v.y + delta.y, v.z + delta.z); + if delta.is_finite() && sum.is_finite() { + self.item.velocity = sum; + } + Ok(()) + } +} +impl FluidInteractionWorld for ItemFluidWorld<'_> { + type Error = Error; + type Chunk = (); + fn interaction_box(&mut self) -> Result, Error> { + Ok(Some( + self.item.bounds().deflate(Vec3::new(0.001, 0.001, 0.001)), + )) + } + fn loaded_chunk(&mut self, x: i32, z: i32) -> Result, Error> { + Ok(self.world.chunks.contains_key(&(x, z)).then_some(())) + } + fn chunk_sections(&mut self, _: ()) -> Result, Error> { + static SECTIONS: [bool; crate::chunk::SECTIONS] = [true; crate::chunk::SECTIONS]; + Ok(FluidSections { + minimum_section_y: crate::chunk::MIN_Y >> 4, + has_fluid: &SECTIONS, + }) + } + fn bounding_box_min_y(&self) -> f64 { + self.item.position.y + } + fn block_x(&self) -> i32 { + self.item.position.x.floor() as i32 + } + fn eye_y(&mut self) -> Result { + Ok(self.item.position.y + f64::from(0.2125f32)) + } + fn block_z(&self) -> i32 { + self.item.position.z.floor() as i32 + } + fn fluid_state(&mut self, p: BlockPos) -> Result { + Ok(self.fluids.fluid(self.world.block(p.x, p.y, p.z))) + } + fn fluid_height(&mut self, f: FluidState, p: BlockPos) -> Result { + f.height_at(self, [p.x, p.y, p.z]) + } + fn camera_height(&mut self, f: FluidState, p: BlockPos) -> Result { + f.camera_height_at(self, [p.x, p.y, p.z]) + } + fn flow(&mut self, f: FluidState, p: BlockPos) -> Result { + flow_at(self, f, p) + } +} +impl FluidHeightWorld for ItemFluidWorld<'_> { + type Error = Error; + fn fluid(&mut self, p: [i32; 3]) -> Result { + Ok(self.fluids.fluid(self.world.block(p[0], p[1], p[2]))) + } + fn sturdy_down(&mut self, p: [i32; 3]) -> Result { + let state = self.world.block(p[0], p[1], p[2]); + Ok(self.fluids.sturdy(state, Direction::Down)) + } +} +impl FluidFlowWorld for ItemFluidWorld<'_> { + type Error = Error; + type Block = BlockStateId; + fn fluid(&mut self, p: BlockPos) -> Result { + Ok(self.fluids.fluid(self.world.block(p.x, p.y, p.z))) + } + fn block(&mut self, p: BlockPos) -> Result { + Ok(self.world.block(p.x, p.y, p.z)) + } + fn blocks_fluid_flow(&self, s: BlockStateId) -> bool { + self.fluids.blocks_flow(s) + } + fn is_ice_class(&self, s: BlockStateId) -> bool { + self.fluids.ice(s) + } + fn is_face_sturdy( + &mut self, + s: BlockStateId, + _: BlockPos, + d: Direction, + ) -> Result { + Ok(self.fluids.sturdy(s, d)) + } +} + +#[cfg(test)] +mod tests { + use super::*; + #[test] + fn items_follow_flowing_water_but_still_water_has_no_horizontal_push() { + let root = std::path::Path::new(env!("CARGO_MANIFEST_DIR")) + .join("../../.local/horizon-client") + .join(horizon_core::VANILLA_VERSION); + if !root.join("movement-properties.nbt").exists() { + return; + } + let assets = crate::assets::Assets::load(&root).unwrap(); + let render = assets.reload(&root).unwrap(); + let facts = crate::blocks::BlockFacts::load(&root, assets.registry).unwrap(); + let fluids = FluidResources::new(&assets, &facts).unwrap(); + let collision = crate::collisions::load(&root, assets.registry).unwrap(); + let mut world = World::test_scene(&assets, &render, 3).unwrap(); + let stone = assets.registry.default_state("minecraft:stone").unwrap(); + let water = assets.registry.default_state("minecraft:water").unwrap(); + let mut state = assets.registry.state(water).unwrap().clone(); + state.properties.insert("level".into(), "1".into()); + let flowing = assets.registry.resolve(&state).unwrap(); + for x in 19..=21 { + for z in 19..=21 { + world.set(x, 3, z, stone).unwrap(); + world.set(x, 4, z, water).unwrap(); + } + } + let at = Vec3::new(20.5, 4.0, 20.5); + let item = ItemEntity { + id: 1, + health: 5, + fire_ticks: 0, + stack: crate::items::ItemStack { + item: "minecraft:sugar_cane".into(), + count: 1, + damage: 0, + extra: None, + }, + thrower: None, + position: at, + previous: at, + velocity: Vec3::ZERO, + on_ground: false, + age: 0, + pickup_delay: 0, + bob_offset: 0.0, + ticks: 0, + }; + let mut still = item.clone(); + assert!(still.tick(&world, &facts, &collision, false, &fluids)); + assert_eq!(still.position.x, at.x); + assert_eq!(still.velocity.x, 0.0); + world.set(21, 4, 20, flowing).unwrap(); + let mut carried = item; + assert!(carried.tick(&world, &facts, &collision, false, &fluids)); + // First push is damped by buoyancy before motion, second follows drag. + assert!((carried.position.x - at.x - 0.014 * 0.99).abs() < 1e-12); + assert!((carried.velocity.x - (0.014 * 0.99 * 0.98 + 0.014)).abs() < 1e-12); + for _ in 0..20 { + carried.tick(&world, &facts, &collision, false, &fluids); + } + assert!(carried.position.x > at.x + 0.5); + } +} diff --git a/crates/horizon-client/src/entity_nbt.rs b/crates/horizon-client/src/entity_nbt.rs index 00576ea02..7f3565067 100644 --- a/crates/horizon-client/src/entity_nbt.rs +++ b/crates/horizon-client/src/entity_nbt.rs @@ -6,7 +6,7 @@ //! survive a Horizon save. use crate::{ arrows::Pickup, - entities::{ArmorStand, ExperienceOrb, ItemEntity, ItemFrame, Painting}, + entities::{ArmorStand, Cushion, ExperienceOrb, ItemEntity, ItemFrame, Painting}, mobs::{Mob, MobType, Who}, projectiles::{Projectile, ProjectileKind}, save::{ @@ -1313,6 +1313,79 @@ pub fn painting_from_nbt(tag: &Tag) -> Option<([i32; 3], u8, String)> { let facing = (number(tag.get("facing")).unwrap_or(0) & 3) as u8; Some((pos, facing, text(tag.get("variant"))?)) } +/// Cushion.addAdditionalSaveData: the block it sits on and its colour. +pub fn cushion_to_nbt(c: &Cushion, uuid: [i32; 4], raw: Option<&Tag>) -> Tag { + let base = Base { + id: "minecraft:cushion", + uuid, + position: c.position, + motion: Vec3::ZERO, + rotation: [c.yaw, 0.0], + on_ground: false, + fall_distance: 0.0, + }; + let mut tag = base.tag(raw); + put(&mut tag, "block_pos", Tag::IntArray(c.pos.to_vec())); + put(&mut tag, "color", string(c.color_name())); + tag +} +/// The position, block position, yaw and colour of a saved cushion. +pub fn cushion_from_nbt(tag: &Tag, id: u32) -> Option { + let position = position(tag)?; + let pos = match tag.get("block_pos") { + Some(Tag::IntArray(v)) if v.len() == 3 => [v[0], v[1], v[2]], + _ => [ + position.x.floor() as i32, + position.y.floor() as i32, + position.z.floor() as i32, + ], + }; + let yaw = match tag.get("Rotation") { + Some(Tag::List(l)) => l + .first() + .and_then(|v| crate::save::float(Some(v))) + .unwrap_or(0.0) as f32, + _ => 0.0, + }; + let color = + crate::entities::dye_index(&text(tag.get("color")).unwrap_or_else(|| "white".into())); + Some(Cushion { + id, + position, + pos, + yaw, + color, + check_interval: 0, + }) +} + +#[cfg(test)] +mod cushion_tests { + use super::*; + + #[test] + fn cushion_save_preserves_color_anchor_rotation_and_unknown_data() { + let cushion = Cushion { + id: 7, + position: Vec3::new(-1.5, 64.5, 3.5), + pos: [-2, 64, 3], + yaw: 270.0, + color: 14, + check_interval: 55, + }; + let raw = Tag::compound([("CustomName", string("Seat"))]); + let tag = cushion_to_nbt(&cushion, [1, 2, 3, 4], Some(&raw)); + assert_eq!(text(tag.get("CustomName")).as_deref(), Some("Seat")); + let loaded = cushion_from_nbt(&tag, 8).unwrap(); + assert_eq!(loaded.id, 8); + assert_eq!(loaded.position, cushion.position); + assert_eq!(loaded.pos, cushion.pos); + assert_eq!(loaded.yaw, cushion.yaw); + assert_eq!(loaded.color_name(), "red"); + assert_eq!(loaded.check_interval, 0); + assert_eq!(loaded.bounds(), cushion.bounds()); + } +} /// ItemFrame.addAdditionalSaveData. pub fn item_frame_to_nbt(f: &ItemFrame, uuid: [i32; 4], raw: Option<&Tag>) -> Tag { let (lo, hi) = f.bounds(); diff --git a/crates/horizon-client/src/extras.rs b/crates/horizon-client/src/extras.rs index b5b4fb165..d2f0b4e9d 100644 --- a/crates/horizon-client/src/extras.rs +++ b/crates/horizon-client/src/extras.rs @@ -378,12 +378,6 @@ impl Cps { pub enum Item { Fullbright, DynamicLights, - Minimap, - MinimapCorner, - MinimapSize, - MinimapShape, - MinimapZoom, - MinimapRotate, AutoReconnect, MouseTweaks, MouseTweaksWheel, @@ -402,13 +396,6 @@ pub fn rows() -> Vec> { Err("Lighting"), Ok(Fullbright), Ok(DynamicLights), - Err("Minimap"), - Ok(Minimap), - Ok(MinimapCorner), - Ok(MinimapSize), - Ok(MinimapShape), - Ok(MinimapZoom), - Ok(MinimapRotate), Err("Inventory"), Ok(MouseTweaks), Ok(MouseTweaksWheel), @@ -418,32 +405,11 @@ pub fn rows() -> Vec> { Ok(AutoReconnect), ] } -/// "1 block", "2 blocks", "½ block". -fn block_count(n: f32) -> String { - if n < 1.0 { - "½ block".into() - } else if n == 1.0 { - "1 block".into() - } else { - format!("{n} blocks") - } -} -fn next(all: &[T], current: T, back: bool) -> T { - let i = all.iter().position(|v| *v == current).unwrap_or(0); - let n = all.len(); - all[if back { (i + n - 1) % n } else { (i + 1) % n }] -} impl Item { pub fn caption(self) -> &'static str { match self { Item::Fullbright => "Fullbright", Item::DynamicLights => "Dynamic lights", - Item::MinimapCorner => "Corner", - Item::Minimap => "Minimap", - Item::MinimapSize => "Size", - Item::MinimapShape => "Shape", - Item::MinimapZoom => "Zoom", - Item::MinimapRotate => "Turn with the player", Item::AutoReconnect => "Auto-reconnect", Item::MouseTweaks => "Mouse Tweaks controls", Item::MouseTweaksWheel => "Scroll wheel moves items", @@ -458,10 +424,9 @@ impl Item { pub fn parent(self) -> Option { use Item::*; Some(match self { - MinimapCorner | MinimapSize | MinimapShape | MinimapZoom | MinimapRotate => Minimap, MouseTweaksWheel => MouseTweaks, SortKey => Sort, - Fullbright | DynamicLights | Minimap | MouseTweaks | Sort | AutoReconnect | NoAi + Fullbright | DynamicLights | MouseTweaks | Sort | AutoReconnect | NoAi | AgentControl | DiscordPresence => { return None; } @@ -474,12 +439,6 @@ impl Item { Item::DynamicLights => { "Torches and other light sources held, dropped or on fire light the blocks around them." } - 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.", - Item::MinimapShape => "Square or round.", - Item::MinimapZoom => "Blocks per pixel: smaller shows more detail, larger more land.", - Item::MinimapRotate => "Forward is up; off keeps north up.", Item::AutoReconnect => { "Rejoins a server after a lost connection or a restart, never after a kick or ban." } @@ -511,7 +470,7 @@ impl Item { use crate::graphics_style::Cost; match self { Item::Fullbright => Some(Cost::None), - Item::Minimap | Item::DynamicLights => Some(Cost::Low), + Item::DynamicLights => Some(Cost::Low), Item::AutoReconnect | Item::MouseTweaks | Item::Sort => Some(Cost::None), _ => None, } @@ -521,8 +480,6 @@ impl Item { Some(match self { Item::Fullbright => e.fullbright, Item::DynamicLights => e.dynamic_lights, - Item::Minimap => e.minimap, - Item::MinimapRotate => e.minimap_rotate, Item::AutoReconnect => e.auto_reconnect, Item::MouseTweaks => e.mouse_tweaks, Item::MouseTweaksWheel => e.mouse_tweaks_wheel, @@ -537,38 +494,22 @@ impl Item { pub fn value(self, e: &Extras) -> String { match self { Item::SortKey => crate::keybinds::display_name(&e.sort_key).plain(), - Item::MinimapCorner => e.minimap_corner.label().into(), - Item::MinimapSize => MINIMAP_SIZES - .iter() - .find(|s| s.0 == e.minimap_size) - .map_or("Medium", |s| s.1) - .into(), - Item::MinimapShape => if e.minimap_round { "Round" } else { "Square" }.into(), - Item::MinimapZoom => format!("{} per pixel", block_count(e.minimap_zoom)), other => match other.switch(e) { Some(true) => "On".into(), _ => "Off".into(), }, } } - /// A click (`back` for the right button). The sort key binds instead. - pub fn cycle(self, e: &mut Extras, back: bool) { + /// A click (`_back` for the right button: every item left is a switch, + /// so both flip it). 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::Minimap => e.minimap = !e.minimap, - Item::MinimapRotate => e.minimap_rotate = !e.minimap_rotate, Item::AutoReconnect => e.auto_reconnect = !e.auto_reconnect, Item::MouseTweaks => e.mouse_tweaks = !e.mouse_tweaks, Item::MouseTweaksWheel => e.mouse_tweaks_wheel = !e.mouse_tweaks_wheel, Item::Sort => e.sort = !e.sort, - Item::MinimapCorner => e.minimap_corner = next(&Corner::ALL, e.minimap_corner, back), - Item::MinimapSize => { - let sizes: Vec = MINIMAP_SIZES.iter().map(|s| s.0).collect(); - e.minimap_size = next(&sizes, e.minimap_size, back); - } - Item::MinimapShape => e.minimap_round = !e.minimap_round, - Item::MinimapZoom => e.minimap_zoom = next(&MINIMAP_ZOOMS, e.minimap_zoom, back), Item::NoAi => e.no_ai = !e.no_ai, Item::AgentControl => e.agent_control = !e.agent_control, Item::DiscordPresence => e.discord_presence = !e.discord_presence, @@ -712,12 +653,9 @@ mod tests { #[test] fn items_cycle_through_their_values() { let mut e = Extras::default(); - Item::MinimapCorner.cycle(&mut e, true); - assert_eq!(e.minimap_corner, Corner::TopLeft); - Item::MinimapZoom.cycle(&mut e, true); - assert_eq!(Item::MinimapZoom.value(&e), "½ block per pixel"); - Item::MinimapSize.cycle(&mut e, false); - assert_eq!(Item::MinimapSize.value(&e), "Large"); + Item::Sort.cycle(&mut e, true); + assert_eq!(Item::Sort.value(&e), "On"); + // The minimap's old keys still parse, for the move to its mod. assert_eq!( Extras::parse("minimapSize:7\nminimapZoom:3").minimap_zoom, 1.0 diff --git a/crates/horizon-client/src/font.rs b/crates/horizon-client/src/font.rs index 1903cab7e..d0e8c8499 100644 --- a/crates/horizon-client/src/font.rs +++ b/crates/horizon-client/src/font.rs @@ -1201,6 +1201,31 @@ mod tests { assert!(!font.take_patches().is_empty()); } + /// A renderer rebuilt over the same font (the loading screen's handoff) + /// makes its atlas texture from the textures alone, so the glyphs it had + /// rasterized into the previous texture must be placed into the new one. + #[test] + fn a_rebuilt_atlas_gets_its_glyphs_again() { + let sheet = png(16, 8, |x, _| x < 2 || (8..14).contains(&x)); + let default = br#"{"providers":[{"type":"bitmap","file":"minecraft:font/a.png","ascent":7,"chars":["ab"]}]}"#; + let root = root( + "rebuild", + &[ + ("assets/minecraft/font/default.json", default), + ("assets/minecraft/textures/font/a.png", &sheet), + ], + ); + let font = load(&root); + let _ = std::fs::remove_dir_all(&root); + let first = font.glyph('a'); + assert_eq!(font.take_patches().len(), 1); + font.reset_cache(); + // Nothing is left over: drawing the character again places its pixels. + assert!(font.take_patches().is_empty()); + assert_eq!(font.glyph('a').advance, first.advance); + assert_eq!(font.take_patches().len(), 1); + } + #[test] fn provider_filters_follow_the_font_options() { let sheet = png(8, 8, |x, _| x < 4); diff --git a/crates/horizon-client/src/game.rs b/crates/horizon-client/src/game.rs index 495c01dc8..b0f1662b1 100644 --- a/crates/horizon-client/src/game.rs +++ b/crates/horizon-client/src/game.rs @@ -18,6 +18,7 @@ mod boats; mod books; mod bossbars; mod breezes; +mod campfire; mod cartography; mod chat; mod client_ambient; @@ -33,6 +34,7 @@ mod copper_golems; mod creaking; mod creatures; mod crossbow; +pub(crate) mod cushions; mod debug_keys; mod decorated_pot; mod dedicated; @@ -80,6 +82,7 @@ mod lan_mobs; mod lan_mount_menu; mod lan_particles; mod lan_pvp; +mod lan_quiet; mod lan_screen; mod lan_stations; mod lan_trading; @@ -131,6 +134,7 @@ mod pumpkin; mod raids; mod recipe_book; mod remote; +mod remote_chunks; mod remote_mob_data; mod remote_mob_use; mod remote_objects; @@ -146,6 +150,7 @@ mod scoreboard; mod screens; mod sculk; mod sculk_fixture; +mod server_mods; mod server_packs; mod server_travel; mod shader_packs; @@ -1428,6 +1433,8 @@ struct Game<'a> { map_frame_model: frames::FrameModel, glow_map_frame_model: frames::FrameModel, armor_stands: Vec, + /// `Cushion` decoration entities (game/cushions.rs). + cushions: Vec, /// Entities of types Horizon does not simulate. others: Vec, armor_stand_assets: armor_stands::ArmorStandAssets, @@ -1443,6 +1450,8 @@ struct Game<'a> { boat_models: boats::BoatModels, /// EndCrystalModel's baked layer. crystal_model: Option, + /// CushionModel's baked layer. + cushion_model: Option, carts: Vec, /// Songs playing from jukeboxes (tracked sound handles). jukebox_sounds: HashMap<(i32, i32, i32), u64>, @@ -1579,6 +1588,8 @@ struct Game<'a> { /// position) for the guests. lan_block_events: Vec<([i32; 3], i32, i32, u32)>, lan_entity_events: Vec<(i32, i8, [f64; 3])>, + /// Successful crits (attacking guest, hit entity), queued while the hub is taken. + lan_critical_hits: Vec<(Option, i32)>, /// Global level events for every guest (`ServerLevel.globalLevelEvent`). lan_global_events: Vec<(i32, [i32; 3], i32)>, /// `ContainerOpenersCounter`: how many players (the host and the guests) @@ -2271,7 +2282,13 @@ impl Game<'_> { let speed = self.world.random.next_float() * 0.2 + 0.1; item.move_towards_closest_space(&self.world, self.res.facts(), speed); } - let alive = item.tick(&self.world, self.res.facts(), self.collision, no_physics); + let alive = item.tick( + &self.world, + self.res.facts(), + self.collision, + no_physics, + &self.res.motion().fluids, + ); cells.moved(i, item.previous, item.position); // ItemEntity.tick: merge every 2 ticks while moving between // blocks, every 40 otherwise, before the lifetime check. @@ -2778,6 +2795,9 @@ impl Game<'_> { pos, data, } => self.consume_teleport_particles([pos.x, pos.y, pos.z], data), + LevelEvent::LevelEvent { id: 2003, pos, .. } => { + self.eye_break_particles([pos.x, pos.y, pos.z]); + } LevelEvent::LevelEvent { id: 2013, pos, @@ -3329,6 +3349,7 @@ impl Game<'_> { self.pad_rumble(horizon_client::gamepad::Rumble::BlockBroken); // ServerPlayerGameMode.destroyBlock. let state = self.world.block(pos[0], pos[1], pos[2]); + let broken = state; let facts = self.res.facts().get(state).clone(); let state = self.crack_mined_pot(pos, state); // Block.playerWillDestroy: mining their gold angers all nearby piglins. @@ -3360,6 +3381,9 @@ impl Game<'_> { creative, ) }); + if removed { + self.mod_block_event(pos, broken, false); + } if removed && !creative { let held = self.held().cloned(); self.mine_block_with_held(&facts.name, facts.hardness); @@ -3468,6 +3492,7 @@ impl Game<'_> { fn interact_entity(&mut self) -> Result { Ok(self.interact_frame() || self.interact_armor_stand() + || self.interact_cushion() || self.interact_boat() || self.interact_cart() || self.interact_mob()? @@ -3654,6 +3679,7 @@ impl Game<'_> { || self.place_painting(hit, &stack) || self.place_item_frame(hit, &stack) || self.place_armor_stand(hit, &stack) + || self.place_cushion(hit, &stack) || self.place_end_crystal(hit, &stack)) { return Ok(true); @@ -3702,6 +3728,7 @@ impl Game<'_> { return Ok(true); }; let target = [pos.x, pos.y, pos.z]; + self.mod_block_event(target, state, true); if let Some(entity) = BlockEntity::for_block(&self.res.facts().get(state).name) { let key = (target[0], target[1], target[2]); self.world.block_entities.insert(key, entity); @@ -4193,6 +4220,9 @@ impl Game<'_> { self.with_level(|b, level, ticks| b.notify_written(level, ticks, position, flags)); } fn tick(&mut self) -> Result<()> { + if self.agent.hold_server { + return Ok(()); + } self.tick_debug_keys()?; self.tick_debug_charts(); if self.remote.is_some() { @@ -4232,6 +4262,7 @@ impl Game<'_> { self.update_totem_ready(); self.tick_command_extras(); self.tick_mods(); + self.tick_server_mods(); let camera_eye = self.camera_eye_height(); let stick = self.pad_move(); if self.riding.is_some() && self.player.is_some() { @@ -4534,6 +4565,7 @@ impl Game<'_> { horizon_client::spans::time("tick_paintings", || self.tick_paintings()); horizon_client::spans::time("tick_item_frames", || self.tick_item_frames()); horizon_client::spans::time("tick_armor_stands", || self.tick_armor_stands()); + horizon_client::spans::time("tick_cushions", || self.tick_cushions()); horizon_client::spans::time("tick_boats", || self.tick_boats()); horizon_client::spans::time("tick_carts", || self.tick_carts()); horizon_client::spans::time("tick_thunder", || self.tick_thunder()); @@ -4742,7 +4774,10 @@ impl Game<'_> { if capture && !self.focused { return; } - if !capture { + if capture { + // The inventory's screens are behind us: no drag survives them. + self.reset_inventory_clicks(); + } else { self.stop_mining(); } // The real pointer takes over from an agent's. @@ -5268,7 +5303,8 @@ impl Game<'_> { | BlockEntity::Vault(_) | BlockEntity::Beehive(_) | BlockEntity::CommandBlock(_) - | BlockEntity::Skull(_), + | BlockEntity::Skull(_) + | BlockEntity::Campfire(_), ) => {} None => { v.extend((0..self.craft_size * self.craft_size).map(|i| 100 + i)); @@ -5538,7 +5574,8 @@ impl Game<'_> { | BlockEntity::Vault(_) | BlockEntity::Beehive(_) | BlockEntity::CommandBlock(_) - | BlockEntity::Skull(_), + | BlockEntity::Skull(_) + | BlockEntity::Campfire(_), ) => {} None if self.mount_active() => self.draw_mount_background(batch, ox, oy), None => { @@ -5581,7 +5618,18 @@ impl Game<'_> { self.draw_inventory_effects(batch, (ox, oy), 176); } } + /// `AbstractContainerScreen` keeps `isQuickCrafting` and the drag it + /// belongs to on the screen; Horizon keeps them on the game, so they are + /// dropped when a screen closes. A press whose release never reaches the + /// screen (the pointer left the window, or the screen closed first) would + /// otherwise leave every later press on every later screen swallowed. + pub(super) fn reset_inventory_clicks(&mut self) { + self.inv_clicks = Default::default(); + self.inv_drag = None; + self.last_inv_click = None; + } pub(super) fn close_container(&mut self) { + self.reset_inventory_clicks(); self.close_station(); self.mount_closed(); self.recipe_ui.reset_screen(); @@ -5600,6 +5648,8 @@ impl Game<'_> { self.craft_size = 2; self.craft_table = None; if let Some(key) = self.container.take() { + // A cart's or chest boat's items go back to it. + self.close_cart_container(key); self.container_opener_event(key, false); self.post_block_game_event( "minecraft:container_close", @@ -5639,7 +5689,6 @@ impl Game<'_> { self.world.modified.insert((key.0 >> 4, key.2 >> 4)); } self.close_ender_chest(); - self.close_cart_container(); } /// `quickMoveStack` of the open plain menu for a shift-click. fn inventory_quick_move(&mut self, slot: usize) -> bool { @@ -5676,8 +5725,9 @@ impl Game<'_> { if self.creative_screen.tab().search { // CreativeModeInventoryScreen.slotClicked: moveCursorToEnd, then // setHighlightPos(0), so typing replaces the whole query. - let search = &self.creative_screen.search; - self.text_selection.select(("creative.search", 0), search); + let search = &mut self.creative_screen.search; + search.move_cursor_to_end(false); + search.highlight = 0; } let items = self.creative_screen.items(&self.pack.names); let first = self.creative_screen.first_row(&self.pack.names); @@ -6319,6 +6369,13 @@ impl Game<'_> { false, ); if outside { + // AbstractRecipeBookScreen.mouseClicked: the book takes the click + // before the outside test, and its tabs sit left of the strip + // hasClickedOutside counts as the book. + if self.recipe_book_click(right) { + self.inv_clicks.skip_release(); + return; + } // slotId -999: an empty hand throws nothing; a carried stack // starts a drag whose release drops it. match input { @@ -6884,6 +6941,9 @@ impl Game<'_> { self.prepare_entity_culling(camera); self.prepare_trims(); self.mark_entity(out.len(), "minecraft:entity_flame"); + // One scan for both passes that draw them (block entities below and the + // overlay near the end of this function). + let cracks = self.cracks(camera); let fire_yaw = if self.camera_type == perspective::CameraType::ThirdPersonFront { self.yaw + 180.0 } else { @@ -6980,6 +7040,9 @@ impl Game<'_> { // `VaultRenderer`. self.mark_entity(out.len(), ""); self.vault_geometry(camera, alpha, &mut out); + // `CampfireRenderer`. + self.mark_entity(out.len(), ""); + self.campfire_geometry(camera, &mut out); self.mark_entity(out.len(), "minecraft:ominous_item_spawner"); self.ominous_item_spawner_geometry(camera, alpha, &mut out); // Mobs and their projectiles (a span each). @@ -7109,7 +7172,7 @@ impl Game<'_> { .render(&scene, visible, &mut out); } self.mark_stage(out.len(), "DESTROY"); - for (pos, stage) in self.cracks(camera) { + for &(pos, stage) in &cracks { let state = self.world.block(pos[0], pos[1], pos[2]); self.res .block_entity_render() @@ -7222,6 +7285,7 @@ impl Game<'_> { self.frame_geometry(camera, &mut out); self.mark_entity(out.len(), "minecraft:armor_stand"); self.armor_stand_geometry(camera, alpha, &mut out); + self.cushion_geometry(camera, &mut out); self.mark_entity(out.len(), "minecraft:oak_boat"); self.boat_geometry(camera, alpha, &mut out); self.mark_entity(out.len(), "minecraft:minecart"); @@ -7252,7 +7316,7 @@ impl Game<'_> { ); // Breaking progress overlays (destroy_stage_0..9): ours and the other players'. self.mark_stage(out.len(), "DESTROY"); - for (pos, stage) in self.cracks(camera) { + for &(pos, stage) in &cracks { let o = (glam::DVec3::new(f64::from(pos[0]), f64::from(pos[1]), f64::from(pos[2])) - camera) .as_vec3(); @@ -7300,6 +7364,20 @@ impl Game<'_> { /// other players' (`renderBlockDestroyAnimation`: within 32 blocks of the camera, the /// furthest progress on each block). fn cracks(&self, camera: glam::DVec3) -> Vec<([i32; 3], [f32; 2])> { + // `destroy_stage_0` .. `destroy_stage_9`: the sprite name by stage, so the + // lookup does not format a string per crack. + const DESTROY_STAGES: [&str; 10] = [ + "block/destroy_stage_0", + "block/destroy_stage_1", + "block/destroy_stage_2", + "block/destroy_stage_3", + "block/destroy_stage_4", + "block/destroy_stage_5", + "block/destroy_stage_6", + "block/destroy_stage_7", + "block/destroy_stage_8", + "block/destroy_stage_9", + ]; let mut stages: Vec<([i32; 3], u32)> = Vec::new(); let mut add = |pos: [i32; 3], stage: u32| match stages.iter_mut().find(|c| c.0 == pos) { Some(c) => c.1 = c.1.max(stage), @@ -7325,11 +7403,8 @@ impl Game<'_> { d.length_squared() <= 1024.0 }) .filter_map(|(pos, stage)| { - let r = self - .gui - .atlas - .sprites - .get(&format!("block/destroy_stage_{stage}"))?; + let name = DESTROY_STAGES.get(stage as usize)?; + let r = self.gui.atlas.sprites.get(*name)?; Some((pos, [r.u0, r.v0])) }) .collect() @@ -7507,6 +7582,7 @@ impl Game<'_> { .map_or(0.0, |i| i.attack_damage); if self.attack_frame() || self.attack_armor_stand() + || self.attack_cushion() || self.attack_boat(hand_damage) || self.attack_cart(hand_damage) || self.attack_dragon() @@ -7594,10 +7670,9 @@ impl Game<'_> { self.stats .custom("damage_dealt", (actual * 10.0).round() as i32); if crit { - self.particles.tracking_emitter( - horizon_client::particles::ParticleOptions::simple( - horizon_client::particles::ParticleType::Crit, - ), + self.critical_hit( + self.lan_acting, + self.mobs[index].id as i32, feet, width, height, @@ -8252,6 +8327,7 @@ impl Game<'_> { self.boats.clear(); self.carts.clear(); self.armor_stands.clear(); + self.cushions.clear(); self.item_frames.clear(); self.paintings.clear(); self.others.clear(); @@ -8670,6 +8746,13 @@ impl Game<'_> { { return Ok(UseResult::Success { swing: true }); } + if allow_block_actions + && let Some(hit) = self.pick() + && let Some(placed) = self.use_on_campfire(hit.pos)? + { + // SUCCESS_SERVER swings; a full campfire's CONSUME does not. + return Ok(UseResult::Success { swing: placed }); + } // BucketItem has no useOn: a guest's UseItemOn leaves it to UseItem. let bucket = horizon_client::items::bucket_contents(&stack.item); if matches!(self.guest_use, Some(GuestUse::OnBlock(_))) @@ -9787,20 +9870,16 @@ impl Game<'_> { ); } if tab.search { - // The search box: an unbordered EditBox of 80 at (82, 6), white. - let search = &self.creative_screen.search; - horizon_client::ui::append_field( - batch, - atlas, - search, - (ox + 82.0, oy + 6.0, 80.0), - (u32::MAX, true), - clipboard::CREATIVE_SEARCH_CHARS, - self.text_selection - .covers(clipboard::CREATIVE_SEARCH, search), - true, - self.creative_screen.search_focused.elapsed().as_millis(), - ); + // CreativeModeInventoryScreen: an unbordered EditBox of 50 at (82, 6). + let search = &mut self.creative_screen.search; + search.x = ox + 82.0; + search.y = oy + 6.0; + search.width = 80.0; + search.bordered = false; + search.focused = true; + search.text_color = u32::MAX; + search.max_length = clipboard::CREATIVE_SEARCH_CHARS; + search.draw(batch, atlas, None); } let mut hovered: Option = None; if tab.inventory { @@ -9908,8 +9987,7 @@ impl Game<'_> { } else if self.carried.is_none() && let Some(item) = hovered { - let lines = self.stack_tooltip(&item); - self.draw_tooltip_lines(batch, &lines, self.cursor.0, self.cursor.1); + self.draw_stack_tooltip(batch, &item, self.cursor.0, self.cursor.1); } self.draw_inventory_effects(batch, (ox, oy), Creative::WIDTH as i32); } @@ -9962,6 +10040,9 @@ impl Game<'_> { } return; } + if !right && self.creative_search_click(ox, oy) { + return; + } // Holding the scrollbar scrolls as the mouse moves (mouseDragged). if !right && self @@ -9974,6 +10055,24 @@ impl Game<'_> { self.inventory_press(right); } } + /// A click on the search tab's box (`EditBox.onClick`). + fn creative_search_click(&mut self, ox: f32, oy: f32) -> bool { + if !self.creative_screen.tab().search { + return false; + } + let (x, y, w, h) = (ox + 82.0, oy + 6.0, 80.0, 9.0); + let (mx, my) = self.cursor; + if mx < x || my < y || mx >= x + w || my >= y + h { + return false; + } + let shift = self.has_shift_down(); + let search = &mut self.creative_screen.search; + search.x = x; + search.y = y; + search.width = w; + search.click(&self.gui.atlas, mx, shift, false); + true + } /// Copy the live player and world state into the `Level` that gets saved. pub(super) fn sync_level(&mut self) { // Level.write saves the game rules (game_rules.dat) with the rest. @@ -10292,8 +10391,6 @@ impl Game<'_> { Vec::new() }; let mut hud = horizon_client::spans::time("hud", || self.hud(size)); - // Map textures changed since the last drawn frame (game/maps.rs). - hud.patches.append(&mut self.map_patches); // LevelLoadingScreen (Reason.OTHER) draws the title's panorama. let title = self.title.is_some() || self.loading_reason() == Some(horizon_client::level_loading::Reason::Other); @@ -10395,6 +10492,10 @@ impl Game<'_> { } else { self.shader_pack_inputs(camera, alpha as f32) }; + // Map textures and font glyphs changed while building this frame's + // geometry (game/maps.rs, world text) upload with this batch; draining + // map_patches any earlier leaves them a frame behind. + hud.patches.append(&mut self.map_patches); let entity_spans = std::mem::take(self.entity_spans.get_mut()); let frame = Frame { weather: &weather, @@ -11010,11 +11111,7 @@ impl Game<'_> { bytes += size; } } - for c in unloaded { - for sy in 0..(HEIGHT / 16) { - renderer.remove((c.x, sy, c.z)); - } - } + renderer.remove_columns(unloaded.iter().map(|c| (c.x, c.z))); if let (Some(lod), Some(player)) = (&mut self.lod, &self.player) { let lod_distance = self.settings.horizon.lod_distance_on(&renderer.info); lod.set_near_loading(self.streaming.busy()); @@ -11621,8 +11718,17 @@ impl ApplicationHandler for Game<'_> { // The hovered slot took the key (`ignoreTextInput`). } else if let Some(shortcut) = self.edit_shortcut(&event) { self.creative_search_shortcut(shortcut); - } else if event.physical_key == PhysicalKey::Code(KeyCode::Backspace) { - self.creative_search_backspace(self.has_control_down()); + } else if let PhysicalKey::Code(key) = event.physical_key { + // EditBox.keyPressed: arrows, Home, End, Delete and Backspace. + let before = self.creative_screen.search.value.clone(); + let (ctrl, shift) = (self.has_control_down(), self.has_shift_down()); + if self.creative_screen.search.key(key, ctrl, shift) { + if self.creative_screen.search.value != before { + self.creative_screen.scroll = 0.0; + } + } else { + self.creative_search_edit(event.text.as_deref()); + } } else { self.creative_search_edit(event.text.as_deref()); } @@ -11643,6 +11749,9 @@ impl ApplicationHandler for Game<'_> { // The anvil rename box takes every key but Escape (AnvilScreen.keyPressed). if let Some(shortcut) = self.edit_shortcut(&event) { self.station_shortcut(shortcut); + } else if let PhysicalKey::Code(key) = event.physical_key + && self.station_key(key) + { } else { let backspace = event.physical_key == PhysicalKey::Code(KeyCode::Backspace); self.station_text(event.text.as_deref(), backspace); @@ -12259,6 +12368,7 @@ impl<'a> Game<'a> { map_frame_model: prepared.map_frame_model, glow_map_frame_model: prepared.glow_map_frame_model, armor_stands: Vec::new(), + cushions: Vec::new(), others: Vec::new(), armor_stand_assets: prepared.armor_stand_assets, waypoint_styles: prepared.waypoint_styles, @@ -12268,6 +12378,7 @@ impl<'a> Game<'a> { boats: Vec::new(), boat_models: prepared.boat_models, crystal_model: prepared.crystal_model, + cushion_model: prepared.cushion_model, carts: Vec::new(), jukebox_sounds: HashMap::new(), bolts: Vec::new(), @@ -12354,6 +12465,7 @@ impl<'a> Game<'a> { lan_events: Vec::new(), lan_block_events: Vec::new(), lan_entity_events: Vec::new(), + lan_critical_hits: Vec::new(), lan_global_events: Vec::new(), lid_openers: HashMap::new(), lan_acting: None, @@ -12405,6 +12517,7 @@ struct GameCpuResources { boat_models: boats::BoatModels, cart_models: minecarts::CartModels, crystal_model: Option, + cushion_model: Option, dragon_model: Option, arrow_model: Option, trident_model: Option, @@ -12425,6 +12538,7 @@ impl GameCpuResources { boat_models: boats::BoatModels::load(document.as_ref()), cart_models: minecarts::CartModels::load(document.as_ref()), crystal_model: model("minecraft:end_crystal#main"), + cushion_model: model("minecraft:cushion#main"), dragon_model: model("minecraft:ender_dragon#main"), arrow_model: model("minecraft:arrow#main"), trident_model: model("minecraft:trident#main"), @@ -12984,6 +13098,14 @@ fn build_renderer( ) -> Result { let assets = &pack.render; let atlas = &gui.atlas; + // The new renderer's atlas texture starts from `HudAtlas.pixels`, which + // holds the textures but never a glyph rasterized at run time. The font's + // cache still answers with the rects it drew into the previous renderer's + // texture, so forget them: the glyphs that are drawn again are placed into + // this texture (as `ui_theme` does when its atlas changes). Without this, + // Chinese and Japanese menu labels go blank when the loading screen hands + // over to the game. + atlas.font.reset_cache(); let mut renderer = pollster::block_on(Renderer::new( window, offscreen, @@ -13030,6 +13152,12 @@ fn loading_renderer( Some(atlas) => (atlas.pixels.as_slice(), atlas.width, atlas.height), None => (EMPTY_HUD.as_slice(), 1, 1), }; + // A glyph rasterized into an earlier texture is not in these pixels; the + // new texture gets it again when the character is drawn (see + // `build_renderer`). + if let Some(atlas) = atlas { + atlas.font.reset_cache(); + } let mut renderer = pollster::block_on(Renderer::new( window, offscreen, @@ -13766,7 +13894,7 @@ mod startup_cpu_tests { r#"{ "minecraft:end_crystal#main": {}, "minecraft:ender_dragon#main": {}, "minecraft:arrow#main": {}, "minecraft:trident#main": {}, - "minecraft:armor_stand#main": {} + "minecraft:armor_stand#main": {}, "minecraft:cushion#main": {} }"#, ) .unwrap(); @@ -13786,6 +13914,7 @@ mod startup_cpu_tests { .unwrap(); std::fs::remove_dir_all(&root).unwrap(); assert!(prepared.crystal_model.is_some()); + assert!(prepared.cushion_model.is_some()); assert!(prepared.dragon_model.is_some()); assert!(prepared.arrow_model.is_some()); assert!(prepared.trident_model.is_some()); diff --git a/crates/horizon-client/src/game/agent.rs b/crates/horizon-client/src/game/agent.rs index 2686b85fd..fa9dbf3c6 100644 --- a/crates/horizon-client/src/game/agent.rs +++ b/crates/horizon-client/src/game/agent.rs @@ -300,6 +300,8 @@ struct Glide { pub(super) struct Agent { task: Option, glide: Option, + /// Control-fixture barrier: hold simulation and packet handling, not transport threads. + pub hold_server: bool, } pub(super) enum Handled { @@ -479,6 +481,8 @@ impl Game<'_> { "absorption": p.health.absorption(), // The hurt animation's ticks left (the camera's hurt tilt). "hurt_time": p.health.hurt_animation_time, + // LivingEntity.deathTime while dead (the camera's death roll). + "death_time": self.death_time(), "air": p.air, "food": p.health.food.food, "saturation": p.health.food.saturation, @@ -667,6 +671,7 @@ impl Game<'_> { }); if let Some(chat) = &self.ui.chat_screen { v["chat_input"] = json!(chat.input.value); + v["chat_suggestions"] = json!(chat.suggestions_visible()); } if self.title.is_some() { v["menu"] = self.title_value(); diff --git a/crates/horizon-client/src/game/beacon.rs b/crates/horizon-client/src/game/beacon.rs index 24ead3a3d..97177f2b9 100644 --- a/crates/horizon-client/src/game/beacon.rs +++ b/crates/horizon-client/src/game/beacon.rs @@ -515,8 +515,7 @@ impl Game<'_> { if self.carried.is_some() { self.draw_carried(batch); } else if let Some(stack) = stack_tip { - let lines = self.stack_tooltip(&stack); - self.draw_tooltip_lines(batch, &lines, self.cursor.0, self.cursor.1); + self.draw_stack_tooltip(batch, &stack, self.cursor.0, self.cursor.1); } else if let Some(key) = tooltip { let text = self.translate(&key, &key); self.draw_tooltip_lines( diff --git a/crates/horizon-client/src/game/block_entity_anims.rs b/crates/horizon-client/src/game/block_entity_anims.rs index 56f571bee..3d452596e 100644 --- a/crates/horizon-client/src/game/block_entity_anims.rs +++ b/crates/horizon-client/src/game/block_entity_anims.rs @@ -219,6 +219,11 @@ impl Game<'_> { /// client tick (`ClientLevel.tickBlockEntities`). pub(super) fn tick_block_entity_anims(&mut self) { let Some(r) = &self.renderer else { + // A server has no window, but its gateways still run their + // server ticker. + if self.remote.is_none() { + self.tick_gateway_servers(); + } return; }; // Sorted by position: the order they tick in, and a quick lookup. @@ -378,6 +383,31 @@ impl Game<'_> { } self.be_anims.present = positions; } + /// `TheEndGatewayBlockEntity.portalTick` (the server ticker) of the + /// gateways a server keeps a copy of, in block-ticking chunks + /// (`Level.tickBlockEntities`): the cooldown an entry started runs out, + /// and every 2400 ticks `triggerCooldown` sends its block event. + fn tick_gateway_servers(&mut self) { + let levels = self.tickets.levels(); + let mut positions: Vec<[i32; 3]> = self + .be_anims + .gateway_servers + .keys() + .copied() + .filter(|p| levels.block_ticking_at(p[0], p[2])) + .collect(); + positions.sort_unstable(); + for pos in positions { + let triggered = self + .be_anims + .gateway_servers + .get_mut(&pos) + .is_some_and(EndGateway::portal_tick); + if triggered { + self.block_entity_event(pos, 1, 0); + } + } + } /// `EndGatewayBlock.entityInside` on the server: whether the gateway at /// `pos` let the entity in (`triggerCooldown`, with its block event). pub(super) fn gateway_enter(&mut self, pos: [i32; 3]) -> bool { diff --git a/crates/horizon-client/src/game/block_entity_ticks.rs b/crates/horizon-client/src/game/block_entity_ticks.rs index e48c8f398..e0798b4cb 100644 --- a/crates/horizon-client/src/game/block_entity_ticks.rs +++ b/crates/horizon-client/src/game/block_entity_ticks.rs @@ -56,6 +56,7 @@ impl Game<'_> { Some(BlockEntity::Beehive(_)) => self.tick_beehive(pos), Some(BlockEntity::Furnace(_)) => self.tick_furnace(pos)?, Some(BlockEntity::Brewing(_)) => self.tick_brewing_stand(pos)?, + Some(BlockEntity::Campfire(_)) => self.tick_campfire(pos)?, _ => {} } } @@ -92,7 +93,10 @@ impl Game<'_> { | "minecraft:vault" | "minecraft:beehive" | "minecraft:bee_nest" - | "minecraft:brewing_stand" => Ticking::Yes, + | "minecraft:brewing_stand" + // Lit, cookTick; unlit, cooldownTick. + | "minecraft:campfire" + | "minecraft:soul_campfire" => Ticking::Yes, "minecraft:jukebox" => { let record = registry .state(state) diff --git a/crates/horizon-client/src/game/boats.rs b/crates/horizon-client/src/game/boats.rs index df7158d9a..06dfab22d 100644 --- a/crates/horizon-client/src/game/boats.rs +++ b/crates/horizon-client/src/game/boats.rs @@ -55,7 +55,7 @@ pub(super) struct Boat { /// `ChestBoat.CONTAINER_SIZE`. pub(super) const CHEST_SLOTS: usize = 27; pub(super) const WIDTH: f64 = 1.375; -const HEIGHT: f64 = 0.5625; +pub(super) const HEIGHT: f64 = 0.5625; impl Boat { pub fn new(id: u32, wood: Arc, position: Vec3, yaw: f32) -> Self { Self { @@ -587,6 +587,9 @@ impl Game<'_> { } /// The player's tick while riding: steer, tick the boat, sit in it. pub(super) fn tick_riding(&mut self, keys: Keys) -> horizon_client::Result<()> { + if self.tick_cushion_riding(keys) { + return Ok(()); + } let Some(i) = self.boats.iter().position(|b| Some(b.id) == self.riding) else { if self.tick_cart_riding(keys) || self.tick_mount_riding(keys) { return Ok(()); diff --git a/crates/horizon-client/src/game/books.rs b/crates/horizon-client/src/game/books.rs index 9af1da70c..2f38dffd9 100644 --- a/crates/horizon-client/src/game/books.rs +++ b/crates/horizon-client/src/game/books.rs @@ -17,7 +17,6 @@ use horizon_client::{ use horizon_core::position::BlockPos; use horizon_protocol::packets::play::{self, Clientbound as C, Serverbound as S}; use horizon_world::level::flags as level_flags; -use std::time::Instant; use winit::{ event::{ElementState, KeyEvent}, keyboard::{KeyCode, PhysicalKey}, @@ -27,8 +26,24 @@ const BLACK: u32 = 0xFF00_0000; const PAGE_CHARS: usize = 1024; const MAX_PAGES: usize = 100; const LINES: usize = 14; -/// `BookSignScreen`'s title box. -const BOOK_TITLE: horizon_client::clipboard::FieldId = ("book.title", 0); + +fn book_title_box() -> ui::EditBox { + let mut edit = ui::EditBox::new(0.0, 0.0, 114.0, 9.0); + edit.bordered = false; + edit.max_length = 15; + edit.text_color = BLACK; + edit.focused = true; + edit +} +fn book_page_box() -> ui::EditBox { + let mut edit = ui::EditBox::new(0.0, 0.0, 114.0, 9.0); + edit.bordered = false; + edit.multiline = true; + edit.max_length = PAGE_CHARS; + edit.text_color = BLACK; + edit.focused = true; + edit +} pub(super) enum BookScreen { Edit { @@ -38,7 +53,10 @@ pub(super) enum BookScreen { page: usize, signing: bool, title: String, - opened: Instant, + /// BookSignScreen's title box (`EditBox` of 15). + title_edit: ui::EditBox, + /// BookEditScreen's page (`MultiLineEditBox`). + page_edit: ui::EditBox, }, View { pages: Vec, @@ -84,13 +102,16 @@ impl Game<'_> { if pages.is_empty() { pages.push(String::new()); } + let mut page_edit = book_page_box(); + page_edit.set_value(&pages[0]); BookScreen::Edit { slot: self.held_slot(), pages, page: 0, signing: false, title: String::new(), - opened: Instant::now(), + title_edit: book_title_box(), + page_edit, } } "minecraft:written_book" => BookScreen::View { @@ -239,34 +260,24 @@ impl Game<'_> { Some(KeyCode::PageDown) => self.turn_page(true), _ => {} }, - Some(BookScreen::Edit { - signing: true, - title, - .. - }) => match key { + Some(BookScreen::Edit { signing: true, .. }) => match key { Some(KeyCode::Escape) => { if let Some(BookScreen::Edit { signing, .. }) = self.book.as_mut() { *signing = false; } } - Some(KeyCode::Backspace) => { - if !self.text_selection.take(BOOK_TITLE, title) { - title.pop(); - } - } Some(KeyCode::Enter | KeyCode::NumpadEnter) => { - if !title.trim().is_empty() { + let blank = self.book.as_ref().is_some_and( + |b| matches!(b, BookScreen::Edit { title, .. } if title.trim().is_empty()), + ); + if !blank { self.save_book(true); } } + Some(key) if self.book_title_key(key) => {} _ => { if let Some(typed) = text { - self.text_selection.take(BOOK_TITLE, title); - for c in typed.chars().filter(|c| !c.is_control()) { - if title.chars().count() < 15 { - title.push(c); - } - } + self.book_title_insert(typed); } } }, @@ -274,24 +285,13 @@ impl Game<'_> { Some(KeyCode::Escape) => self.save_book(false), Some(KeyCode::PageUp) => self.turn_page(false), Some(KeyCode::PageDown) => self.turn_page(true), - Some(KeyCode::Backspace) => { - if !self.take_page_selection() { - self.edit_page(|p| { - p.pop(); - }) - } - } - Some(KeyCode::Enter | KeyCode::NumpadEnter) => { - self.take_page_selection(); - self.type_into_page("\n") - } + Some(KeyCode::ArrowUp) => self.book_move_line(-1), + Some(KeyCode::ArrowDown) => self.book_move_line(1), + Some(KeyCode::Enter | KeyCode::NumpadEnter) => self.page_insert("\n"), + Some(key) if self.book_page_key(key) => {} _ => { if let Some(typed) = text { - let typed: String = typed.chars().filter(|c| !c.is_control()).collect(); - if !typed.is_empty() { - self.take_page_selection(); - } - self.type_into_page(&typed); + self.page_insert(typed); } } }, @@ -302,99 +302,258 @@ impl Game<'_> { pub(super) fn book_type(&mut self, text: &str) { let text = text.replace("\\n", "\n"); match self.book.as_mut() { - Some(BookScreen::Edit { - signing: true, - title, - .. - }) => { - for c in text.chars().filter(|c| !c.is_control()) { - if title.chars().count() < 15 { - title.push(c); - } - } - } - Some(BookScreen::Edit { .. }) => self.type_into_page(&text), + Some(BookScreen::Edit { signing: true, .. }) => self.book_title_insert(&text), + Some(BookScreen::Edit { .. }) => self.page_insert(&text), _ => {} } } - /// Before typing on a page: Select All's selection is cleared (true). - fn take_page_selection(&mut self) -> bool { - match self.book.as_mut() { - Some(BookScreen::Edit { pages, page, .. }) => self - .text_selection - .take(("book.page", *page), &mut pages[*page]), - _ => false, + /// `BookSignScreen.keyPressed` on the title box. + fn book_title_key(&mut self, key: KeyCode) -> bool { + let (ctrl, shift) = (self.has_control_down(), self.has_shift_down()); + let Some(BookScreen::Edit { + title, title_edit, .. + }) = self.book.as_mut() + else { + return false; + }; + if !title_edit.key(key, ctrl, shift) { + return false; } + title.clone_from(&title_edit.value); + true } - /// Ctrl+A/C/V/X: the title box (an `EditBox` of 15) while signing, else - /// the page (`MultilineTextField.insertText`: line breaks kept, cut to - /// the 1024 characters left, rejected when it overflows the 14 lines). - pub(super) fn book_shortcut(&mut self, shortcut: horizon_client::clipboard::EditShortcut) { - let font = &self.gui.atlas.font; - match self.book.as_mut() { - Some(BookScreen::Edit { - signing: true, - title, - .. - }) => { - Self::append_shortcut( - &mut self.text_selection, - &mut self.clipboard, - BOOK_TITLE, - title, - shortcut, - 15, - ); - } - Some(BookScreen::Edit { pages, page, .. }) => { - // truncateInsertionText counts the whole value, selection included. - let room = PAGE_CHARS.saturating_sub(pages[*page].chars().count()); - self.text_selection.apply( - ("book.page", *page), - &mut pages[*page], - shortcut, - &mut self.clipboard, - |value, pasted| { - let text: String = horizon_client::clipboard::filter_text(pasted, true) - .chars() - .take(room) - .collect(); - let next = format!("{value}{text}"); - font.split(&Text::literal(&next), 114.0).len() <= LINES && { - *value = next; - true - } - }, - ); - } - _ => {} - } - } - fn edit_page(&mut self, f: impl FnOnce(&mut String)) { - if let Some(BookScreen::Edit { pages, page, .. }) = self.book.as_mut() { - f(&mut pages[*page]); - } - } - /// MultiLineEditBox: characters that keep the page within 14 lines and 1024 characters. - fn type_into_page(&mut self, typed: &str) { - let Some(BookScreen::Edit { pages, page, .. }) = self.book.as_ref() else { + fn book_title_insert(&mut self, text: &str) { + let Some(BookScreen::Edit { + title, title_edit, .. + }) = self.book.as_mut() + else { return; }; - let mut text = pages[*page].clone(); - for c in typed.chars() { - let mut next = text.clone(); - next.push(c); - if next.chars().count() <= PAGE_CHARS && self.book_lines(&next).len() <= LINES { - text = next; + title_edit.insert_text(text); + title.clone_from(&title_edit.value); + } + /// `BookEditScreen.keyPressed` on the page, apart from the line moves. + fn book_page_key(&mut self, key: KeyCode) -> bool { + let (ctrl, shift) = (self.has_control_down(), self.has_shift_down()); + let before = match self.book.as_ref() { + Some(BookScreen::Edit { page_edit, .. }) => Some(( + page_edit.value.clone(), + page_edit.cursor, + page_edit.highlight, + )), + _ => return false, + }; + let handled = if let Some(BookScreen::Edit { page_edit, .. }) = self.book.as_mut() { + page_edit.key(key, ctrl, shift) + } else { + false + }; + if handled { + self.page_keep(before); + } + handled + } + /// One character at a time, so a page stops at the last character that fits. + fn page_insert(&mut self, text: &str) { + for c in text.chars() { + self.page_change(|edit| edit.insert_text(&c.to_string())); + } + } + /// Ctrl+A/C/V/X: the title box while signing, else the page. + pub(super) fn book_shortcut(&mut self, shortcut: horizon_client::clipboard::EditShortcut) { + let signing = matches!(self.book, Some(BookScreen::Edit { signing: true, .. })); + if signing { + if let Some(BookScreen::Edit { + title, title_edit, .. + }) = self.book.as_mut() + { + title_edit.shortcut(shortcut, &mut self.clipboard); + title.clone_from(&title_edit.value); + } + return; + } + let before = match self.book.as_ref() { + Some(BookScreen::Edit { page_edit, .. }) => Some(( + page_edit.value.clone(), + page_edit.cursor, + page_edit.highlight, + )), + _ => None, + }; + if let Some(BookScreen::Edit { page_edit, .. }) = self.book.as_mut() { + page_edit.shortcut(shortcut, &mut self.clipboard); + } + self.page_keep(before); + } + /// Edit the page box, then keep it only within 14 lines and 1024 characters. + fn page_change(&mut self, f: impl FnOnce(&mut ui::EditBox)) -> bool { + let before = match self.book.as_ref() { + Some(BookScreen::Edit { page_edit, .. }) => Some(( + page_edit.value.clone(), + page_edit.cursor, + page_edit.highlight, + )), + _ => return false, + }; + let ran = if let Some(BookScreen::Edit { page_edit, .. }) = self.book.as_mut() { + f(page_edit); + true + } else { + false + }; + ran && self.page_keep(before) + } + /// Write the page, or put the previous text back when it no longer fits. + fn page_keep(&mut self, before: Option<(String, usize, usize)>) -> bool { + let next = match self.book.as_ref() { + Some(BookScreen::Edit { page_edit, .. }) => page_edit.value.clone(), + _ => return false, + }; + let ok = next.chars().count() <= PAGE_CHARS && self.book_lines(&next).len() <= LINES; + let Some(BookScreen::Edit { + pages, + page, + page_edit, + .. + }) = self.book.as_mut() + else { + return false; + }; + if ok { + pages[*page].clone_from(&page_edit.value); + } else if let Some((value, cursor, highlight)) = before { + page_edit.value = value; + page_edit.cursor = cursor; + page_edit.highlight = highlight; + } + ok + } + /// ArrowUp and ArrowDown move a visual line, keeping the column. + fn book_move_line(&mut self, dir: isize) { + let shift = self.has_shift_down(); + let (text, cursor) = match self.book.as_ref() { + Some(BookScreen::Edit { + pages, + page, + page_edit, + .. + }) => (pages[*page].clone(), page_edit.cursor), + _ => return, + }; + let rows = self.page_rows(&text); + let (x, line) = self.caret_on(&text, &rows, cursor); + let next = (line as isize + dir).clamp(0, rows.len() as isize - 1) as usize; + let (start, end) = rows[next]; + let chars: Vec = text.chars().collect(); + let slice: String = chars[start..end].iter().collect(); + let pos = start + self.gui.atlas.font.fit(&slice, x); + if let Some(BookScreen::Edit { page_edit, .. }) = self.book.as_mut() { + page_edit.set_cursor(pos, shift); + } + } + /// Wrapped rows of a page as character ranges, the same breaks as `font.split`. + fn page_rows(&self, page: &str) -> Vec<(usize, usize)> { + let font = &self.gui.atlas.font; + let chars: Vec = page.chars().collect(); + let mut rows = Vec::new(); + let mut start = 0; + while start < chars.len() { + let mut end = chars.len(); + let mut next = chars.len(); + let mut last_space = None; + for i in start..chars.len() { + if chars[i] == '\n' { + end = i; + next = i + 1; + break; + } + if chars[i] == ' ' { + last_space = Some(i); + } + let slice: String = chars[start..=i].iter().collect(); + if font.width(&slice) > 114.0 { + match last_space { + Some(s) if s > start => { + end = s; + next = s + 1; + } + _ => { + end = i.max(start + 1); + next = end; + } + } + break; + } + } + rows.push((start, end)); + start = next; + if start == chars.len() && chars.last() == Some(&'\n') { + rows.push((chars.len(), chars.len())); } } - self.edit_page(|p| *p = text); + if rows.is_empty() { + rows.push((0, 0)); + } + rows + } + /// GUI x of the caret and the row it sits on. + fn caret_on(&self, page: &str, rows: &[(usize, usize)], cursor: usize) -> (f32, usize) { + let chars: Vec = page.chars().collect(); + for (i, &(start, end)) in rows.iter().enumerate() { + if cursor <= end || i + 1 == rows.len() { + let take = cursor.saturating_sub(start).min(end.saturating_sub(start)); + let prefix: String = chars.iter().skip(start).take(take).collect(); + return (self.gui.atlas.font.width(&prefix), i); + } + } + (0.0, 0) + } + fn page_index_at(&self, page: &str, local_x: f32, local_y: f32) -> usize { + let rows = self.page_rows(page); + let line = (local_y / 9.0).floor().max(0.0) as usize; + let line = line.min(rows.len().saturating_sub(1)); + let (start, end) = rows[line]; + let chars: Vec = page.chars().collect(); + let slice: String = chars[start..end].iter().collect(); + start + self.gui.atlas.font.fit(&slice, local_x.max(0.0)) + } + /// A click on the centred title (`EditBox.onClick`). + fn book_title_click(&mut self, field_x: f32, mx: f32) { + let shift = self.has_shift_down(); + let Some(BookScreen::Edit { + title, title_edit, .. + }) = self.book.as_mut() + else { + return; + }; + let tx = field_x + ((114.0 - self.gui.atlas.font.width(title)) / 2.0).floor(); + let rel = (mx - tx).max(0.0); + let pos = self.gui.atlas.font.fit(title, rel); + title_edit.set_cursor(pos, shift); + } + /// A click on the open page. + fn book_page_click(&mut self, origin_x: f32, origin_y: f32, mx: f32, my: f32) { + let shift = self.has_shift_down(); + let text = match self.book.as_ref() { + Some(BookScreen::Edit { pages, page, .. }) => pages[*page].clone(), + _ => return, + }; + let pos = self.page_index_at(&text, mx - origin_x, my - origin_y); + if let Some(BookScreen::Edit { page_edit, .. }) = self.book.as_mut() { + page_edit.set_cursor(pos, shift); + } } /// The page buttons (`pageForward` adds a page while editing). fn turn_page(&mut self, forward: bool) { let mut lectern_page = None; match self.book.as_mut() { - Some(BookScreen::Edit { pages, page, .. }) => { + Some(BookScreen::Edit { + pages, + page, + page_edit, + .. + }) => { + let before = *page; if forward { if *page + 1 >= pages.len() && pages.len() < MAX_PAGES { pages.push(String::new()); @@ -405,6 +564,10 @@ impl Game<'_> { } else if *page > 0 { *page -= 1; } + if *page != before { + let text = pages[*page].clone(); + page_edit.set_value(&text); + } } Some(BookScreen::View { lectern: Some(key), .. @@ -764,6 +927,8 @@ impl Game<'_> { if let Some(BookScreen::Edit { signing, .. }) = self.book.as_mut() { *signing = false; } + } else if inside(left + 36.0, 50.0, 114.0, 9.0) { + self.book_title_click(left + 36.0, mx); } } Some(BookScreen::Edit { page, .. }) => { @@ -780,6 +945,8 @@ impl Game<'_> { } else if inside(w / 2.0 + 2.0, 196.0, 98.0, 20.0) { click(self); self.save_book(false); + } else if inside(left + 36.0, 32.0, 114.0, 14.0 * 9.0) { + self.book_page_click(left + 36.0, 32.0, mx, my); } } Some(BookScreen::View { @@ -865,7 +1032,7 @@ impl Game<'_> { BookScreen::Edit { signing: true, title, - opened, + title_edit, .. } => { let edit = tr("book.editTitle", "Enter Book Title:"); @@ -881,19 +1048,35 @@ impl Game<'_> { // The title box: an unbordered, centred EditBox of 114 with // black text and no shadow; the value alone is centred, the // cursor follows it. + let value = &title_edit.value; let x = left + 36.0; - let tx = x + ((114.0 - HudBatch::text_width(atlas, title)) / 2.0).floor(); - horizon_client::ui::append_field( - batch, - atlas, - title, - (tx, 50.0, x + 114.0 - tx), - (BLACK, false), - 15, - self.text_selection.covers(BOOK_TITLE, title), - true, - opened.elapsed().as_millis(), - ); + let tx = x + ((114.0 - HudBatch::text_width(atlas, value)) / 2.0).floor(); + batch.text(atlas, value, tx, 50.0, BLACK, false); + if title_edit.cursor != title_edit.highlight { + let (a, b) = ( + title_edit.cursor.min(title_edit.highlight), + title_edit.cursor.max(title_edit.highlight), + ); + let pre: String = value.chars().take(a).collect(); + let sel: String = value.chars().skip(a).take(b - a).collect(); + let sx = tx + HudBatch::text_width(atlas, &pre); + batch.text_highlight( + atlas, + (sx, 49.0, HudBatch::text_width(atlas, &sel), 11.0), + true, + ); + } + if title_edit.cursor_visible() { + let pre: String = value.chars().take(title_edit.cursor).collect(); + batch.fill( + atlas, + tx + HudBatch::text_width(atlas, &pre), + 49.0, + 1.0, + 9.0, + BLACK, + ); + } let by = tr("book.byAuthor", "by %1$s").replace("%1$s", super::chat::PLAYER_NAME); let tw = HudBatch::text_width(atlas, &by); batch.text( @@ -941,12 +1124,12 @@ impl Game<'_> { BookScreen::Edit { pages, page, - opened, + page_edit, .. } => { indicator(batch, *page, pages.len()); - let blink = (opened.elapsed().as_millis() / 300) % 2 == 0; - let lines = self.book_lines(&pages[*page]); + let text = &pages[*page]; + let lines = self.book_lines(text); for (i, line) in lines.iter().take(LINES).enumerate() { batch.text_styled( atlas, @@ -957,27 +1140,39 @@ impl Game<'_> { false, ); } - if blink { - // The cursor after the last character. - let last = lines - .last() - .map(|l| atlas.font.width_text(l)) - .unwrap_or(0.0); - let row = lines.len().saturating_sub(1) as f32 - + if pages[*page].ends_with('\n') { - 1.0 - } else { - 0.0 - }; - let x = if pages[*page].ends_with('\n') { - 0.0 - } else { - last - }; + let rows = self.page_rows(text); + let (sel_a, sel_b) = ( + page_edit.cursor.min(page_edit.highlight), + page_edit.cursor.max(page_edit.highlight), + ); + if sel_a != sel_b { + let chars: Vec = text.chars().collect(); + for (i, &(start, end)) in rows.iter().enumerate().take(LINES) { + let from = sel_a.max(start); + let to = sel_b.min(end); + if from >= to { + continue; + } + let pre: String = chars[start..from].iter().collect(); + let sel: String = chars[from..to].iter().collect(); + batch.text_highlight( + atlas, + ( + left + 36.0 + atlas.font.width(&pre), + top + 29.0 + i as f32 * 9.0, + atlas.font.width(&sel), + 9.0, + ), + true, + ); + } + } + if page_edit.cursor_visible() { + let (x, row) = self.caret_on(text, &rows, page_edit.cursor); batch.fill( atlas, left + 36.0 + x, - top + 29.0 + row * 9.0, + top + 29.0 + row as f32 * 9.0, 1.0, 9.0, BLACK, diff --git a/crates/horizon-client/src/game/campfire.rs b/crates/horizon-client/src/game/campfire.rs new file mode 100644 index 000000000..c388b7561 --- /dev/null +++ b/crates/horizon-client/src/game/campfire.rs @@ -0,0 +1,190 @@ +//! Campfires' cooking: `CampfireBlock.useItemOn` (`CampfireBlockEntity.placeFood`) +//! and the block entity's `cookTick` (lit) and `cooldownTick` (unlit). The +//! items drawn on the fire are `campfire_geometry`'s; a server's clients get +//! them through the block entity's update tag (`lan::chunks::entity_tag`). +use super::Game; +use horizon_assets::item_model::DisplayContext; +use horizon_client::{ + Result, block_entities::Pos, block_entity_render::vertex_light, containers::BlockEntity, + items::ItemStack, mesher::Vertex, mobs::Who, +}; +use horizon_core::position::BlockPos; + +/// The `campfire_cooking` recipe kind (`RecipeType.CAMPFIRE_COOKING`). +const KIND: &str = "minecraft:campfire_cooking"; + +fn is_campfire(name: &str) -> bool { + name == "minecraft:campfire" || name == "minecraft:soul_campfire" +} + +impl Game<'_> { + /// `CampfireBlock.useItemOn` with a held item that is a campfire recipe's + /// input (`RecipePropertySet.CAMPFIRE_INPUT`): on a server level the food + /// goes into the first free slot (`placeFood`), and the use is consumed + /// whether or not there was room. A client of a server leaves the placing + /// to the server. Whether the food went in; None when this isn't a + /// campfire use, so the item's own use runs. + pub(super) fn use_on_campfire(&mut self, pos: [i32; 3]) -> Result> { + let state = self.world.block(pos[0], pos[1], pos[2]); + if !is_campfire(&self.res.facts().get(state).name) { + return Ok(None); + } + let Some(held) = self.held().cloned() else { + return Ok(None); + }; + let Some(time) = self.res.recipes().cook(KIND, &held).map(|r| r.time as i32) else { + return Ok(None); + }; + // A client of a server predicts the placing; the server decides. + if self.remote.is_some() { + return Ok(Some(true)); + } + let key = (pos[0], pos[1], pos[2]); + let placed = match self.world.block_entities.get_mut(&key) { + Some(BlockEntity::Campfire(c)) => { + let mut one = held.clone(); + c.place_food(&mut one, time) + } + _ => false, + }; + if placed { + // ItemStack.consumeAndReturn: creative keeps the item. + self.consume_held(); + self.stats.custom("interact_with_campfire", 1); + self.post_block_game_event( + "minecraft:block_change", + pos, + Some(Who::Player), + Some(state), + ); + self.mark_block_entity_updated(key); + } + Ok(Some(placed)) + } + + /// `CampfireBlockEntity.cookTick` of a lit campfire, `cooldownTick` of an + /// unlit one. A finished item's result (the recipe's, or the item itself + /// when no recipe takes it any more) drops at the block's corner + /// (`Containers.dropItemStack` at its integer position), then the clients + /// see the slot empty and a `block_change` goes out. + pub(super) fn tick_campfire(&mut self, pos: Pos) -> Result<()> { + let state = self.world.block(pos.0, pos.1, pos.2); + let lit = self + .pack + .assets + .registry + .state(state) + .and_then(|s| s.properties.get("lit")) + .is_some_and(|v| v == "true"); + let Some(BlockEntity::Campfire(c)) = self.world.block_entities.get_mut(&pos) else { + return Ok(()); + }; + // BlockEntity.setChanged: a timer that moved is saved with the + // chunk (no update to the clients, who don't see the timers). + let changed = if lit { + c.items.iter().any(Option::is_some) + } else { + c.cooldown_tick() + }; + if changed { + self.world.modified.insert((pos.0 >> 4, pos.2 >> 4)); + } + if !lit { + return Ok(()); + } + let Some(BlockEntity::Campfire(c)) = self.world.block_entities.get_mut(&pos) else { + return Ok(()); + }; + let done = c.cook_tick(); + for (_, item) in done { + let result = self + .res + .recipes() + .cook(KIND, &item) + .map_or_else(|| item.clone(), |r| r.result.clone()); + self.campfire_drop(pos, result); + self.mark_block_entity_updated(pos); + self.post_block_game_event( + "minecraft:block_change", + [pos.0, pos.1, pos.2], + None, + Some(state), + ); + } + Ok(()) + } + + /// `CampfireRenderer`: each cooking item lies on the fire, slot `i` + /// turned to `Direction.from2DDataValue((i + facing) % 4)`, laid flat + /// (90° about X), at a corner and three eighths of its size, drawn as a + /// FIXED item seeded by the block's position plus the slot. + pub(super) fn campfire_geometry(&self, camera: glam::DVec3, out: &mut Vec) { + for (key, entity) in &self.world.block_entities { + let BlockEntity::Campfire(c) = entity else { + continue; + }; + if c.items.iter().all(Option::is_none) { + continue; + } + let at = glam::DVec3::new(f64::from(key.0), f64::from(key.1), f64::from(key.2)); + if at.distance_squared(camera) >= 64.0 * 64.0 { + continue; + } + // Direction.get2DDataValue: south 0, west 1, north 2, east 3. + let state = self.world.block(key.0, key.1, key.2); + let facing = match self + .pack + .assets + .registry + .state(state) + .and_then(|s| s.properties.get("facing")) + .map(String::as_str) + { + Some("west") => 1, + Some("north") => 2, + Some("east") => 3, + _ => 0, + }; + let light = vertex_light(self.world.light(key.0, key.1, key.2)); + let packed = BlockPos::new(key.0, key.1, key.2).pack(); + for (i, stack) in c.items.iter().enumerate() { + let Some(stack) = stack else { + continue; + }; + let seed = (packed as i32).wrapping_add(i as i32); + let item = self.resolve_item(stack, DisplayContext::Fixed, None, seed); + if item.is_empty() { + continue; + } + // Direction.toYRot: 90° per 2D step from south. + let yaw = -(((i + facing) % 4) as f32 * 90.0); + let pose = glam::Mat4::from_translation( + (at - camera).as_vec3() + glam::Vec3::new(0.5, 0.449_218_75, 0.5), + ) * glam::Mat4::from_rotation_y(yaw.to_radians()) + * glam::Mat4::from_rotation_x(90f32.to_radians()) + * glam::Mat4::from_translation(glam::Vec3::new(-0.3125, -0.3125, 0.0)) + * glam::Mat4::from_scale(glam::Vec3::splat(0.375)); + self.submit_item_world(&item, pose, light, out); + } + } + } + + /// `Containers.dropItemStack(level, x, y, z, stack)` at the block's + /// integer position. + fn campfire_drop(&mut self, pos: Pos, stack: ItemStack) { + let at = BlockPos::new(pos.0, pos.1, pos.2); + for piece in + horizon_world::level::removal::drop_item_stack(&mut self.world.random, at, stack.count) + { + self.spawn_item( + ItemStack { + count: piece.count, + ..stack.clone() + }, + piece.pos, + piece.motion, + 0, + ); + } + } +} diff --git a/crates/horizon-client/src/game/chat.rs b/crates/horizon-client/src/game/chat.rs index 5d3919c8b..5b40adf9e 100644 --- a/crates/horizon-client/src/game/chat.rs +++ b/crates/horizon-client/src/game/chat.rs @@ -464,7 +464,28 @@ impl Game<'_> { return; } // The Chat option's Hidden level takes the server's messages too. - if !self.ui.chat.shows(ChatSource::Server) { + self.local_chat_line(text, Some(SYSTEM_INDICATOR), ChatSource::Server); + } + /// A player's chat line on the window's own chat: a LAN guest's message + /// while the host runs in-frame (`HostEvent::Chat`). `ChatListener` + /// checks `canReceivePlayerMessages` for these, so Commands Only and + /// Hidden drop them; command feedback (`/list`, `/tp`) is a system + /// message and takes the system-message permission instead. + pub(super) fn player_message(&mut self, text: Text) { + if let Some(capture) = self.chat_capture.as_mut() { + capture.push(text); + return; + } + // A server's client receives the line as a packet (PlayerChat or + // DisguisedChat) and filters it there. + if self.remote.is_none() { + self.local_chat_line(text, None, ChatSource::Player); + } + } + /// A line on the window's own chat when the Chat option lets `source` + /// through; running mods hear it. + fn local_chat_line(&mut self, text: Text, indicator: Option, source: ChatSource) { + if !self.ui.chat.shows(source) { return; } let focused = self.screen == Screen::Chat; @@ -472,8 +493,8 @@ impl Game<'_> { self.ui.chat.add( &self.gui.atlas, text, - Some(SYSTEM_INDICATOR), - ChatSource::Server, + indicator, + source, self.ticks, focused, ); @@ -602,7 +623,10 @@ impl Game<'_> { return; } if let Some(command) = message.strip_prefix('/') { - self.run_command(command); + // A client mod's command first, then a server mod's, as on a server. + if !self.mod_command(command) && !self.local_server_mod_command(command) { + self.run_command(command); + } } else { let line = Text::translate( "chat.type.text", @@ -622,6 +646,7 @@ impl Game<'_> { self.mods_chat(&line); } self.lan_host_chat(message); + self.mod_player_chat(super::server_mods::Who::Local, message); } } pub(super) fn chat_scroll(&mut self, amount: f32) { diff --git a/crates/horizon-client/src/game/clipboard.rs b/crates/horizon-client/src/game/clipboard.rs index c87aa3681..6e81bf3ee 100644 --- a/crates/horizon-client/src/game/clipboard.rs +++ b/crates/horizon-client/src/game/clipboard.rs @@ -63,8 +63,8 @@ impl Game<'_> { } } } - /// Typing or a backspace in a field of the title screens: in the server - /// screens' append-only fields Select All's selection is replaced first. + /// Typing or a backspace in a title-screen field. A field that still only + /// appends replaces a Select All selection before the edit. pub(super) fn title_edit(&mut self, typed: Option<&str>, backspace: bool) { let Some(title) = self.title.as_mut() else { return; @@ -86,42 +86,31 @@ impl Game<'_> { } /// Shortcuts in the creative inventory's search box (an `EditBox` of 50). pub(super) fn creative_search_shortcut(&mut self, shortcut: EditShortcut) { - if Self::append_shortcut( - &mut self.text_selection, - &mut self.clipboard, - CREATIVE_SEARCH, - &mut self.creative_screen.search, - shortcut, - CREATIVE_SEARCH_CHARS, - ) { + if self + .creative_screen + .search + .shortcut(shortcut, &mut self.clipboard) + { self.creative_screen.scroll = 0.0; } } /// A backspace in the creative search box: with Ctrl, the whole word /// before the caret (`EditBox.deleteWords(-1)`), otherwise one character. - /// A Select All selection is what it deletes, as in `EditBox.keyPressed`. + /// A selection is what it deletes, as in `EditBox.keyPressed`. pub(super) fn creative_search_backspace(&mut self, ctrl: bool) { - let search = &mut self.creative_screen.search; - if !self.text_selection.take(CREATIVE_SEARCH, search) { - if ctrl { - horizon_client::ui::delete_words(search, -1); - } else { - search.pop(); - } - } + self.creative_screen + .search + .key(KeyCode::Backspace, ctrl, false); self.creative_screen.scroll = 0.0; } /// Typing in the creative search box. pub(super) fn creative_search_edit(&mut self, typed: Option<&str>) { - let search = &mut self.creative_screen.search; - self.text_selection.take(CREATIVE_SEARCH, search); if let Some(text) = typed { - clipboard::append_limited(search, text, CREATIVE_SEARCH_CHARS); + self.creative_screen.search.insert_text(text); + self.creative_screen.scroll = 0.0; } - self.creative_screen.scroll = 0.0; } } /// `CreativeModeInventoryScreen`'s search box: `setMaxLength(50)`. pub(super) const CREATIVE_SEARCH_CHARS: usize = 50; -pub(super) const CREATIVE_SEARCH: horizon_client::clipboard::FieldId = ("creative.search", 0); diff --git a/crates/horizon-client/src/game/combat.rs b/crates/horizon-client/src/game/combat.rs index 227aa0332..106e0e1a1 100644 --- a/crates/horizon-client/src/game/combat.rs +++ b/crates/horizon-client/src/game/combat.rs @@ -52,11 +52,16 @@ impl Game<'_> { /// Remember who deals the next `damage_type` damage to the player. pub(super) fn note_attacker(&mut self, damage_type: &str, mob: u32) { if let Some(name) = self.mob_display_name(mob) { - self.combat - .pending - .push((damage_type.to_owned(), (mob, name))); + self.note_named_attacker(damage_type, mob, name); } } + /// `note_attacker` for an entity that is not one of `self.mobs` (the + /// ender dragon). + pub(super) fn note_named_attacker(&mut self, damage_type: &str, id: u32, name: Text) { + self.combat + .pending + .push((damage_type.to_owned(), (id, name))); + } /// `LivingEntity.handleDamageEvent` for the player: the hurt sound of the /// source's `DamageEffects` (`Player.getHurtSound`). pub(super) fn player_hurt_sound(&mut self, sound: &str, at: [f64; 3]) { diff --git a/crates/horizon-client/src/game/commands.rs b/crates/horizon-client/src/game/commands.rs index 7ed8f9658..38a5cddd3 100644 --- a/crates/horizon-client/src/game/commands.rs +++ b/crates/horizon-client/src/game/commands.rs @@ -85,16 +85,16 @@ fn format_double(v: f64) -> String { impl Game<'_> { /// Commands.performCommand for a line without its slash. - pub(super) fn run_command(&mut self, command: &str) { + pub(super) fn run_command(&mut self, command: &str) -> bool { if self.mod_command(command) { - return; + return true; } let d = vanilla::game_dispatcher(); let parse = d.parse(command, &self.ui.registries); let result = match parse.executable() { Err(e) => { self.syntax_failure(&e, command); - return; + return false; } Ok((ctx, _)) => { let ctx = ctx.clone(); @@ -103,6 +103,7 @@ impl Game<'_> { self.run_chain(&root, &ctx) } }; + let ok = result.is_ok(); if let Err(e) = result { if e.input.is_some() { self.syntax_failure(&e, command); @@ -114,6 +115,20 @@ impl Game<'_> { if self.player.is_some() { self.check_inventory_trigger(); } + ok + } + /// `run_command` with its output suppressed + /// (`CommandSourceStack.withSuppressedOutput`): the player's own source, + /// rights and checks, no feedback and no failure in the chat. + pub(super) fn run_command_quietly(&mut self, command: &str) -> bool { + let quiet = execute::Source { + silent: true, + ..self.player_source() + }; + let outer = self.command_source.replace(quiet); + let ok = self.run_command(command); + self.command_source = outer; + ok } fn syntax_failure(&mut self, e: &CommandError, command: &str) { self.command_failure(e.message.clone()); @@ -1097,6 +1112,12 @@ impl Game<'_> { Target::Player => { // ServerPlayer.teleport: removeVehicle before placing the player. self.stop_riding(); + // A server's player teleported within their level is placed + // there at once: the arrival they were waiting for elsewhere + // in it (whose chunks lose their tickets) is abandoned. + if let Some(conn) = self.lan_acting { + self.server_trips.retain(|trip| !trip.is(conn)); + } if let Some(p) = self.player.as_mut() { p.position = v; p.velocity = Vec3::new(0.0, 0.0, 0.0); diff --git a/crates/horizon-client/src/game/control.rs b/crates/horizon-client/src/game/control.rs index 7a632e308..3202b23f4 100644 --- a/crates/horizon-client/src/game/control.rs +++ b/crates/horizon-client/src/game/control.rs @@ -11,6 +11,9 @@ use winit::{event::MouseButton, event_loop::ActiveEventLoop, keyboard::KeyCode}; const HELP: &[&str] = &[ "status game, player, streaming and renderer state", + "simulation authoritative projectiles in the owner's level", + "server-hold on|off hold simulation and player packets at a control-fixture barrier", + "stall MILLISECONDS stall the window thread (0..5000), leaving transport alive", "key KEY down|up|tap|repeat press, release or auto-repeat a key (w a s d space shift ctrl e q esc f3 1-9 arrows ...)", "release release every key and mouse button", "mouse left|right|middle down|up|click", @@ -238,6 +241,47 @@ impl Game<'_> { } "sculk" => Ok(Some(self.sculk_command(&words)?)), "status" => Ok(Some(self.control_status())), + "stall" => { + let millis: u64 = arg(1)?.parse()?; + if millis > 5000 { + return Err("stall is limited to 5000 milliseconds".into()); + } + std::thread::sleep(Duration::from_millis(millis)); + ok() + } + "simulation" => { + self.require_world()?; + let value = if let Some(server) = &self.integrated { + server + .call(|g| { + g.in_owner_level(|g| { + json!({ "game_time": g.world.game_time, "projectiles": g.projectiles_status() }) + }) + }) + .ok_or("the integrated server stopped")? + } else { + json!({ "game_time": self.world.game_time, "projectiles": self.projectiles_status() }) + }; + Ok(Some(value)) + } + "server-hold" => { + self.require_world()?; + let held = match arg(1)? { + "on" => true, + "off" => false, + _ => return Err("server-hold on|off".into()), + }; + if let Some(server) = &self.integrated { + server + .call(move |g| g.agent.hold_server = held) + .ok_or("the integrated server stopped")?; + } else if self.remote.is_some() { + return Err("server-hold requires the world's host".into()); + } else { + self.agent.hold_server = held; + } + ok() + } "pad" => Ok(Some(self.pad_command(&words)?)), "key" => { let key = key_code(arg(1)?).ok_or_else(|| format!("unknown key {}", words[1]))?; @@ -508,10 +552,23 @@ impl Game<'_> { "mobs" => { self.require_world()?; let radius: f64 = words.get(1).map_or(Ok(64.0), |r| r.parse())?; + if let Some(server) = &self.integrated { + let center = self.player.as_ref().map_or(Vec3::ZERO, |p| p.position); + let value = server + .call(move |g| g.in_owner_level(|g| g.control_mobs_at(radius, center))) + .ok_or("the integrated server stopped")?; + return Ok(Some(value)); + } Ok(Some(self.control_mobs(radius))) } "hurtlog" => { self.require_world()?; + if let Some(server) = &self.integrated { + let value = server + .call(|g| g.control_hurt_log()) + .ok_or("the integrated server stopped")?; + return Ok(Some(value)); + } Ok(Some(self.control_hurt_log())) } "resume" => { diff --git a/crates/horizon-client/src/game/creatures.rs b/crates/horizon-client/src/game/creatures.rs index be7923037..6602055ea 100644 --- a/crates/horizon-client/src/game/creatures.rs +++ b/crates/horizon-client/src/game/creatures.rs @@ -50,9 +50,9 @@ pub(super) struct Creatures { /// The wandering trader spawner's clock. pub trader: super::wandering_trader::Spawner, } -struct ProjWorld<'a, 'w> { - w: &'a MobWorld<'w>, - targets: Vec<(Who, Aabb)>, +pub(super) struct ProjWorld<'a, 'w> { + pub w: &'a MobWorld<'w>, + pub targets: Vec<(Who, Aabb)>, } impl ProjectileWorld for ProjWorld<'_, '_> { fn clip(&self, from: Vec3, to: Vec3) -> Option<(Vec3, [i32; 3], [i32; 3])> { @@ -312,6 +312,9 @@ impl Game<'_> { /// The `mobs` command: nearby mobs with position, health and running goals. pub(super) fn control_mobs(&self, radius: f64) -> serde_json::Value { let center = self.player.as_ref().map_or(Vec3::ZERO, |p| p.position); + self.control_mobs_at(radius, center) + } + pub(super) fn control_mobs_at(&self, radius: f64, center: Vec3) -> serde_json::Value { let list: Vec = self .mobs .iter() @@ -370,6 +373,7 @@ impl Game<'_> { // Drawn seated (Entity.isPassenger); set apart because the // json! above is at the macro recursion limit. state["passenger"] = m.extra.passenger.into(); + state["guardian_beam"] = serde_json::json!(horizon_client::mobs::guardian::beam(m, 0.0)); state }) .collect(); @@ -388,6 +392,9 @@ impl Game<'_> { } pub(super) fn mob_world_base<'s>(&'s self, others: &'s [Seen]) -> MobWorld<'s> { let (rain, thunder) = self.world.weather.levels(1.0); + // Level.canHaveWeather: only the overworld's rain and thunder levels + // ever rise, so nothing rains or thunders in the Nether or the End. + let weather = self.dim == Dim::Overworld; let player = self.player_view(); MobWorld { world: &self.world, @@ -404,8 +411,8 @@ impl Game<'_> { daylight: self.dim != Dim::Nether && self.sky_darken() < 4, game_time: self.world.game_time, day_time: self.world.day_time, - raining: rain > 0.2, - thundering: thunder > 0.9, + raining: weather && rain > 0.2, + thundering: weather && thunder > 0.9, nether: self.dim == Dim::Nether, block_tags: &self.res.items().block_tags, biomes: self.res.biomes(), @@ -504,6 +511,17 @@ impl Game<'_> { Some(host) if !guests.is_empty() => std::mem::take(&mut host.mob_players), _ => Default::default(), }; + // The guests' entity ids by connection, for the shulker bullets fired + // at the guest a mob sees. + let guest_ids: Vec<(u32, u32)> = match self.lan.as_ref() { + Some(host) if !guests.is_empty() => host + .hub + .guests + .iter() + .map(|g| (g.conn, g.entity_id as u32)) + .collect(), + _ => Vec::new(), + }; let mut guest_events = Vec::new(); let level_random; { @@ -578,6 +596,19 @@ impl Game<'_> { let kept = m.tick(&w, &mut scratch, &mut events); horizon_client::mobs::take_mob_pushes(&mut events, from, &mut pushes); if let Some(conn) = seen_guest { + // ShulkerBullet.finalTarget is the guest's entity: the + // bullet homes on it while the projectiles tick, where + // `Who::Player` is the host's own player. + if let Some(&(_, id)) = guest_ids.iter().find(|g| g.0 == conn) { + for e in &mut events[from..] { + if let MobEvent::Projectile(p) = e + && let ProjectileKind::ShulkerBullet { target, .. } = &mut p.kind + && *target == Who::Player + { + *target = Who::Mob(id); + } + } + } let mut k = from; while k < events.len() { if super::lan_mobs::acts_on_player(&events[k]) { @@ -1035,7 +1066,10 @@ impl Game<'_> { } MobEvent::BreakBlock { pos, drop } => { let old = self.world.block(pos[0], pos[1], pos[2]); - self.destroy_particles(pos, old); + // Block.spawnDestroyParticles: fire breaks leave nothing. + if !self.res.facts().get(old).has_class("BaseFireBlock") { + self.destroy_particles(pos, old); + } if drop { let drops = self.res.items().block_drops_in( self.pack.assets.registry, @@ -1057,6 +1091,9 @@ impl Game<'_> { self.ensure_item_particle_sprites(); } let options = horizon_client::particles::ParticleOptions::simple(ty); + if ty == horizon_client::particles::ParticleType::SonicBoom { + self.lan_sonic_boom(&options, at); + } // Count 0: one particle exactly there, at rest. if count == 0 { self.particles.add(&options, at, [0.0; 3]); diff --git a/crates/horizon-client/src/game/cushions.rs b/crates/horizon-client/src/game/cushions.rs new file mode 100644 index 000000000..0847321d6 --- /dev/null +++ b/crates/horizon-client/src/game/cushions.rs @@ -0,0 +1,494 @@ +//! Cushions: `CushionItem.useOn` placement on the top face of a block, +//! `Cushion.canBePlacedAt`/`survives`, `Cushion.interact` (sit), +//! `BlockAttachedEntity.hurtServer` (break, dropping the matching colour), +//! `BlockAttachedEntity.tick` and `CushionRenderer`. +//! +//! A cushion is a `BlockAttachedEntity`, not a block: it has no block state, +//! only an entity whose `Pos` is the click point's height. Placement uses +//! outline bounds, collision shapes and suffocation predicates. +use super::{Game, Hit, view_vector}; +use horizon_client::entities::{Cushion, dye_index}; +use horizon_client::items::ItemStack; +use horizon_client::mobs::anim::Poses; +use horizon_core::geometry::{Aabb, Vec3}; +use winit::keyboard::KeyCode; + +/// `Direction.fromYRot(yaw).toYRot()`: the nearest 90 degree step. +pub(crate) fn snap_yaw(yaw: f32) -> f32 { + (((f64::from(yaw) / 90.0 + 0.5).floor() as i64) & 3) as f32 * 90.0 +} + +fn aabb(bounds: ([f64; 3], [f64; 3])) -> Aabb { + Aabb::new( + Vec3::new(bounds.0[0], bounds.0[1], bounds.0[2]), + Vec3::new(bounds.1[0], bounds.1[1], bounds.1[2]), + ) +} + +fn overlaps(a: Aabb, b: Aabb) -> bool { + a.intersects(b) +} +use horizon_client::cushion::blocks_in; + +struct PlacementWorld<'a, 'r>(&'a Game<'r>); +impl horizon_client::cushion::World for PlacementWorld<'_, '_> { + fn outline_bounds(&self, p: [i32; 3]) -> Option { + let boxes = self.0.outline_boxes(p); + let mut shape = *boxes.first()?; + for b in &boxes[1..] { + for k in 0..3 { + shape[k] = shape[k].min(b[k]); + shape[k + 3] = shape[k + 3].max(b[k + 3]); + } + } + Some(Aabb::new( + Vec3::new(shape[0], shape[1], shape[2]), + Vec3::new(shape[3], shape[4], shape[5]), + )) + } + + fn collision_shapes(&self, bounds: Aabb) -> Vec { + let binding = self.0.res.collision(); + let mut world = horizon_client::collisions::SceneCollisions { + world: &self.0.world, + binding, + subject: None, + }; + // Include neighbour blocks whose collision shape can reach outside their cell. + blocks_in(bounds.inflate(Vec3::new(1.0, 1.0, 1.0))) + .filter_map(|p| { + let state = self.0.world.block(p[0], p[1], p[2]); + binding + .collision_shape(&mut world, state, p) + .ok() + .map(|s| s.moved(Vec3::new(f64::from(p[0]), f64::from(p[1]), f64::from(p[2])))) + }) + .collect() + } + fn suffocating(&self, p: [i32; 3]) -> bool { + let state = self.0.world.block(p[0], p[1], p[2]); + let facts = self.0.res.facts().get(state); + let name = facts.name.as_ref(); + // Blocks' explicit predicates, then the default causes_suffocation/full-shape rule. + match name { + "minecraft:dirt_path" + | "minecraft:farmland" + | "minecraft:mud" + | "minecraft:soul_sand" => true, + "minecraft:piston" | "minecraft:sticky_piston" => self + .0 + .pack + .assets + .registry + .state(state) + .is_some_and(|s| s.properties.get("extended").is_some_and(|p| p == "false")), + "minecraft:mangrove_roots" | "minecraft:moving_piston" => false, + _ if name.ends_with("_leaves") + || name.ends_with("glass") + || name.ends_with("copper_grate") => + { + false + } + // ShulkerBoxBlock: suffocating while closed; a box seen open + // here is rare enough to count as closed. + _ if name.ends_with("shulker_box") => true, + _ => { + facts.full_collision + && self + .0 + .res + .items() + .block_in_tag("minecraft:causes_suffocation", name) + } + } + } +} + +impl Game<'_> { + /// The cushion under the crosshair, its distance and the hit point. + pub(super) fn cushion_hit(&self) -> Option<(usize, f64, [f64; 3])> { + let eye = self.eye_position()?; + let dir = view_vector(self.yaw, self.pitch); + let reach: f64 = if self.creative { 5.0 } else { 3.0 }; + let mut best: Option<(usize, f64, [f64; 3])> = None; + for (i, c) in self.cushions.iter().enumerate() { + let Some(d) = super::ray_box(eye, dir, reach, aabb(c.bounds())) else { + continue; + }; + if best.is_none_or(|b| d < b.1) { + best = Some((i, d, std::array::from_fn(|k| eye[k] + dir[k] * d))); + } + } + best + } + + pub(super) fn cushion_survives(&self, c: &Cushion) -> bool { + horizon_client::cushion::survives(&PlacementWorld(self), aabb(c.bounds())) + } + + /// `Cushion.destroyIfInFire`: a fire-tagged block inside the deflated box. + fn cushion_in_fire(&self, c: &Cushion) -> bool { + let bounds = aabb(c.bounds()).next_deflated(); + blocks_in(bounds).any(|p| { + let facts = self.res.facts().get(self.world.block(p[0], p[1], p[2])); + self.res.items().block_in_tag("minecraft:fire", &facts.name) + }) + } + + /// `CushionItem.useOn`: on the top face only, spawning at the click's + /// height above the clicked block (or the replaceable block itself). + pub(super) fn place_cushion(&mut self, hit: &Hit, stack: &ItemStack) -> bool { + let Some(info) = self.res.items().get(&stack.item).cloned() else { + return false; + }; + let Some(default_color) = info.cushion_color.as_deref() else { + return false; + }; + let color_override = stack + .data() + .and_then(|d| d.other("minecraft:cushion/color")) + .and_then(|tag| match tag { + horizon_world::nbt::Tag::String(s) => Some(s.to_string_lossy()), + _ => None, + }); + let color = dye_index(color_override.as_deref().unwrap_or(default_color)); + // CushionItem.recalculateContextForSpecialCollisionShapes: open containers + // (cauldrons, hoppers and composters) use the collision ray's actual height. + let mut adjusted = Hit { + pos: hit.pos, + face: hit.face, + point: hit.point, + }; + let state = self.world.block(hit.pos[0], hit.pos[1], hit.pos[2]); + if self.res.items().block_in_tag( + "minecraft:cushion_uses_collision_shape", + &self.res.facts().get(state).name, + ) && let Some(eye) = self.eye_position() + { + let start = Vec3::new(eye[0], eye[1], eye[2]); + let point = Vec3::new(hit.point[0], hit.point[1], hit.point[2]); + let end = point.add_vector(point.subtract(start).normalize().scale(0.001)); + let binding = self.res.collision(); + let mut world = horizon_client::collisions::SceneCollisions { + world: &self.world, + binding, + subject: None, + }; + if let Ok(shape) = binding.collision_shape(&mut world, state, hit.pos) + && let Some(result) = shape.clip( + start, + end, + horizon_core::position::BlockPos::new(hit.pos[0], hit.pos[1], hit.pos[2]), + ) + { + adjusted.face = result.direction.normal(); + adjusted.point = [result.location.x, result.location.y, result.location.z]; + } + } + let hit = &adjusted; + if hit.face != [0, 1, 0] { + return false; + } + // BlockPlaceContext: a replaceable clicked block is replaced. + let clicked = self + .res + .facts() + .get(self.world.block(hit.pos[0], hit.pos[1], hit.pos[2])); + let pos = if clicked.replaceable { + hit.pos + } else { + std::array::from_fn(|i| hit.pos[i] + hit.face[i]) + }; + // `Vec3.atCenterOfWithY(clickedPos, clickLocation.y)`. + let y = hit.point[1]; + let position = Vec3::new(f64::from(pos[0]) + 0.5, y, f64::from(pos[2]) + 0.5); + let bounds = aabb(( + [position.x - 0.5, position.y, position.z - 0.5], + [position.x + 0.5, position.y + 0.25, position.z + 0.5], + )); + if !horizon_client::cushion::can_place(&PlacementWorld(self), bounds) { + return false; + } + // `getEntitiesOfClass(Cushion.class, spawnAABB).isEmpty()`. + if self + .cushions + .iter() + .any(|c| overlaps(aabb(c.bounds()), bounds)) + { + return false; + } + self.next_entity += 1; + let id = self.next_entity; + // `BlockAttachedEntity.setPos`: `BlockPos.containing(position)`. + let attached = [ + position.x.floor() as i32, + position.y.floor() as i32, + position.z.floor() as i32, + ]; + self.cushions.push(Cushion { + id, + position, + pos: attached, + yaw: snap_yaw(self.yaw), + color, + check_interval: 0, + }); + self.world + .modified + .insert((attached[0] >> 4, attached[2] >> 4)); + // `destroyIfInFire`: placed into fire, it breaks at once. + let placed = self.cushions.len() - 1; + if self.cushion_in_fire(&self.cushions[placed]) { + self.break_cushion(placed, false); + } + self.audio.play( + "minecraft:entity.cushion.place", + Some([position.x, position.y, position.z]), + 0.75, + 0.8, + ); + let ctx = self.who_context(Some(horizon_client::mobs::Who::Player), None); + self.post_game_event( + "minecraft:entity_place", + [position.x, position.y, position.z], + ctx, + ); + if !self.creative { + self.consume_held(); + } + true + } + + /// `Cushion.interact`: sit down unless sneaking or already occupied. + pub(super) fn interact_cushion(&mut self) -> bool { + let Some((i, d, _)) = self.cushion_hit() else { + return false; + }; + if !self.before_block(d) { + return false; + } + // isSecondaryUseActive. + if self.keys.contains(&KeyCode::ShiftLeft) { + return false; + } + let id = self.cushions[i].id; + let occupied = self.riding == Some(id) + || self + .lan + .as_ref() + .is_some_and(|h| h.hub.guests.iter().any(|g| g.vehicle == Some(id))); + // `Cushion.interact`: an occupied cushion (`isVehicle`) passes. + if occupied { + return false; + } + // `Player.startRiding` gives up the vehicle it already has; the + // client never sends that click, so pass instead. + if self.riding.is_some() { + return false; + } + self.riding = Some(id); + let p = self.cushions[i].position; + self.audio.play( + "minecraft:entity.cushion.sit", + Some([p.x, p.y, p.z]), + 1.0, + 1.0, + ); + self.swing_arm(); + true + } + + /// `Cushion.hurtServer` from a player: killed, then the item dropped. + pub(super) fn attack_cushion(&mut self) -> bool { + let Some((i, d, _)) = self.cushion_hit() else { + return false; + }; + if !self.before_block(d) || self.mob_hit().is_some_and(|m| m.1 < d) { + return false; + } + // `skipAttackInteraction` when `mayInteract` is false. + if !self.may_build() { + return true; + } + self.break_cushion(i, true); + true + } + + /// `Cushion.dropItem`: the break sound and particles, then the coloured + /// item unless drops are off or the breaker has infinite materials. + pub(super) fn break_cushion(&mut self, index: usize, by_player: bool) { + let c = self.cushions.remove(index); + let p = c.position; + self.world.modified.insert((c.pos[0] >> 4, c.pos[2] >> 4)); + if self.riding == Some(c.id) { + self.riding = None; + } + self.audio.play( + "minecraft:entity.cushion.break", + Some([p.x, p.y, p.z]), + 1.0, + 1.0, + ); + self.cushion_break_particles(&c); + if !self.ui.rules.bool("entity_drops") || (by_player && self.creative) { + return; + } + let stack = ItemStack { + item: std::sync::Arc::from(c.item()), + count: 1, + damage: 0, + extra: None, + }; + self.spawn_item(stack, [p.x, p.y, p.z], [0.0; 3], 10); + } + + /// `Cushion.showBreakingParticles`: ten of the matching wool block. + fn cushion_break_particles(&mut self, c: &Cushion) { + let name = format!("minecraft:{}_wool", c.color_name()); + let Some(state) = self.pack.assets.registry.default_state(&name) else { + return; + }; + let at = [ + c.position.x.floor() as i32, + c.position.y.floor() as i32, + c.position.z.floor() as i32, + ]; + let Some((sprite, tint)) = self.particle_sprite(state, at) else { + return; + }; + let options = horizon_client::particles::ParticleOptions::block( + horizon_client::particles::ParticleType::Block, + sprite, + tint, + ); + let p = c.position; + self.particles.send_particles( + &options, + [p.x, p.y + 0.666_666_7, p.z], + [0.25, 0.0625, 0.25], + 0.05, + 10, + ); + } + + /// `BlockAttachedEntity.tick`: survive and burn checks after the post-increment reaches 100. + pub(super) fn tick_cushions(&mut self) { + let ticking = self.entity_ticking_area(); + let mut i = 0; + while i < self.cushions.len() { + let p = self.cushions[i].position; + if !ticking(p.x.floor() as i32, p.z.floor() as i32) { + i += 1; + continue; + } + let previous = self.cushions[i].check_interval; + self.cushions[i].check_interval += 1; + if previous < 100 { + i += 1; + continue; + } + self.cushions[i].check_interval = 0; + let c = self.cushions[i].clone(); + if self.cushion_in_fire(&c) || !self.cushion_survives(&c) { + self.break_cushion(i, false); + continue; + } + i += 1; + } + } + + /// `Player.rideTick` on a cushion: hold the seat, and get up on sneak. + pub(super) fn tick_cushion_riding(&mut self, keys: super::Keys) -> bool { + let Some(c) = self + .cushions + .iter() + .find(|c| Some(c.id) == self.riding) + .cloned() + else { + return false; + }; + if keys.shift { + let at = c.dismount(); + self.riding = None; + if let Some(p) = self.player.as_mut() { + self.previous_position = p.position; + p.position = at; + p.velocity = Vec3::ZERO; + p.fall_distance = 0.0; + } + // `Cushion.removePassenger`: the get-up sound for a rider that + // left rather than one whose cushion was killed. + self.audio.play( + "minecraft:entity.cushion.get_up", + Some([c.position.x, c.position.y, c.position.z]), + 1.0, + 1.0, + ); + return true; + } + let seat = c.seat(); + if let Some(p) = self.player.as_mut() { + self.previous_position = p.position; + p.position = seat; + p.velocity = Vec3::ZERO; + p.fall_distance = 0.0; + } + true + } + + /// `CushionRenderer`: the coloured model, rotated to the nearest + /// direction, with its bottom on the cushion's position. + pub(super) fn cushion_geometry( + &self, + camera: glam::DVec3, + out: &mut Vec, + ) { + let Some(model) = self.cushion_model.as_ref() else { + return; + }; + let sprites = &self.gui.atlas.sprites; + for c in &self.cushions { + let entity_start = out.len(); + let a = aabb(c.bounds()); + let (lo, hi) = (a.min_position(), a.max_position()); + let (lo, hi) = ( + glam::DVec3::new(lo.x, lo.y, lo.z), + glam::DVec3::new(hi.x, hi.y, hi.z), + ); + let range = + super::entity_culling::default_range(hi - lo, self.settings.entity_distance); + if !self.entity_in_view(camera, (lo + hi) / 2.0, range, lo, hi) { + continue; + } + let Some(uv) = sprites + .get(&format!("entity/cushion/{}_cushion", c.color_name())) + .map(|r| [r.u0, r.v0, r.u1, r.v1]) + else { + continue; + }; + let p = glam::DVec3::new(c.position.x, c.position.y, c.position.z) - camera; + let base = glam::Mat4::from_translation(p.as_vec3()) + * glam::Mat4::from_rotation_y((180.0 - snap_yaw(c.yaw)).to_radians()) + * glam::Mat4::from_rotation_x(std::f32::consts::PI) + * glam::Mat4::from_translation(glam::Vec3::new(0.0, -0.25, 0.0)); + // `EntityRenderer.getPackedLightCoords` probes at the eye height. + let l = self.world.light( + c.position.x.floor() as i32, + (c.position.y + 0.2125).floor() as i32, + c.position.z.floor() as i32, + ); + let packed = (u32::from(l >> 4) * 16) | ((u32::from(l & 15) * 16) << 8); + horizon_client::mobs::render::draw( + model, + base, + &Poses::new(model), + uv, + 0xFFFF_FFFF, + packed, + 0, + out, + ); + self.cull_entity_vertices(out, entity_start); + } + } +} diff --git a/crates/horizon-client/src/game/dragon.rs b/crates/horizon-client/src/game/dragon.rs index 8c316deeb..e33064531 100644 --- a/crates/horizon-client/src/game/dragon.rs +++ b/crates/horizon-client/src/game/dragon.rs @@ -12,11 +12,13 @@ use horizon_client::{ hud_layout, hud_overlays, mesher::Vertex, particles::{ParticleOptions, ParticleType}, + text::Text, }; use horizon_core::{ geometry::{Aabb, Vec3}, random::{LegacyRandom, RandomSource}, }; +use horizon_protocol::entity_data::Value; use horizon_world::nbt::Tag; /// Mob ids from here on are dragon parts (`SPECIAL + part`) and crystals @@ -1691,25 +1693,8 @@ impl Game<'_> { } if d.random.next_int_bound(10).unwrap_or(1) == 0 { let p = d.position; - d.nearest_crystal = self - .crystals - .iter() - .enumerate() - .filter(|(_, c)| { - (c.position.x - p.x).abs() <= 32.0 - && (c.position.y - p.y).abs() <= 32.0 - && (c.position.z - p.z).abs() <= 32.0 - }) - .min_by(|a, b| { - let da = (a.1.position.x - p.x).powi(2) - + (a.1.position.y - p.y).powi(2) - + (a.1.position.z - p.z).powi(2); - let db = (b.1.position.x - p.x).powi(2) - + (b.1.position.y - p.y).powi(2) - + (b.1.position.z - p.z).powi(2); - da.total_cmp(&db) - }) - .map(|(i, _)| i); + let nearest = self.nearest_crystal_to(p); + self.dragon.as_mut().expect("dragon").nearest_crystal = nearest; } let d = self.dragon.as_mut().expect("dragon"); d.yaw = wrap(d.yaw); @@ -1870,7 +1855,7 @@ impl Game<'_> { pl.velocity.z += zd / dd * 4.0; } if !sitting { - g.hurt_player_by("minecraft:mob_attack", 5.0); + g.dragon_hurts_player("minecraft:mob_attack", 5.0); } }); } @@ -1879,7 +1864,7 @@ impl Game<'_> { for h in heads { if h.inflate(Vec3::new(1.0, 1.0, 1.0)).intersects(p.bounds) { self.as_fight_player(p.who, |g| { - g.hurt_player_by("minecraft:mob_attack", 10.0); + g.dragon_hurts_player("minecraft:mob_attack", 10.0); }); } } @@ -2161,10 +2146,20 @@ impl Game<'_> { self.breath_clouds.append(&mut clouds); for (who, amount) in harmed { self.as_fight_player(who, |g| { - g.hurt_player_by("minecraft:indirect_magic", amount); + g.dragon_hurts_player("minecraft:indirect_magic", amount); }); } } + /// Damage from the dragon, which is its causing entity + /// (`DamageSources.mobAttack(dragon)`, `indirectMagic(cloud, dragon)`): the + /// death message names it. + fn dragon_hurts_player(&mut self, damage_type: &str, amount: f32) { + if let Some(id) = self.dragon.as_ref().map(|d| d.id) { + let name = Text::translate("entity.minecraft.ender_dragon", &[]); + self.note_named_attacker(damage_type, id, name); + } + self.hurt_player_by(damage_type, amount); + } /// `BossHealthOverlay.extractRenderState`: whatever `publish_boss_bars` /// (or a server's packets) put on this client's overlay. pub(super) fn draw_boss_bars(&self, batch: &mut HudBatch) { @@ -3132,6 +3127,204 @@ impl Game<'_> { let _ = self.activate_exit_portal(); self.fight.dirty = true; } + /// `EnderDragon.checkCrystals`' search: the nearest crystal within 32 + /// blocks on each axis. + fn nearest_crystal_to(&self, p: Vec3) -> Option { + self.crystals + .iter() + .enumerate() + .filter(|(_, c)| { + (c.position.x - p.x).abs() <= 32.0 + && (c.position.y - p.y).abs() <= 32.0 + && (c.position.z - p.z).abs() <= 32.0 + }) + .min_by(|a, b| { + let da = (a.1.position.x - p.x).powi(2) + + (a.1.position.y - p.y).powi(2) + + (a.1.position.z - p.z).powi(2); + let db = (b.1.position.x - p.x).powi(2) + + (b.1.position.y - p.y).powi(2) + + (b.1.position.z - p.z).powi(2); + da.total_cmp(&db) + }) + .map(|(i, _)| i) + } +} + +/// The dragon on a server's client (`ClientPacketListener.handleAddEntity` +/// and the client side of `EnderDragon.aiStep`): the server flies it and +/// sends its moves, health and phase; the client flaps its wings, keeps +/// its flight history and places its parts, so it can be drawn and hit. +impl Game<'_> { + /// `handleAddEntity` for `minecraft:ender_dragon`. Its constructor + /// sets the full health and the hovering phase until the server's + /// synched data says otherwise. + pub(super) fn spawn_remote_dragon(&mut self, id: i32, position: [f64; 3], yaw: f32) { + let at = Vec3::new(position[0], position[1], position[2]); + let mut d = Dragon::new(at, yaw, i64::from(id)); + d.id = id as u32; + d.phase = Phase::from_id(10); + self.dragon = Some(d); + self.place_dragon_parts(); + if let Some(d) = self.dragon.as_mut() { + for part in &mut d.parts { + part.1 = part.0; + } + } + } + /// The remote dragon, if `id` is it. + fn remote_dragon_mut(&mut self, id: i32) -> Option<&mut Dragon> { + self.dragon.as_mut().filter(|d| d.id as i32 == id) + } + /// `handleSetEntityData`: LivingEntity.DATA_HEALTH_ID and + /// EnderDragon.DATA_PHASE (`onSyncedDataUpdated` sets the phase). + pub(super) fn remote_dragon_data(&mut self, id: i32, values: &[(u8, i32, Value)]) { + let Some(d) = self.remote_dragon_mut(id) else { + return; + }; + for (index, _, value) in values { + match (index, value) { + (9, Value::Float(health)) => d.health = *health, + (16, Value::Int(phase)) => d.set_phase(Phase::from_id(*phase)), + _ => {} + } + } + } + /// `handleSetEntityMotion`: the velocity its wings flap by. + pub(super) fn remote_dragon_motion(&mut self, id: i32, velocity: [f64; 3]) { + if let Some(d) = self.remote_dragon_mut(id) { + d.velocity = Vec3::new(velocity[0], velocity[1], velocity[2]); + } + } + /// `handleHurtAnimation` and `handleDamageEvent`: the red flash. + pub(super) fn remote_dragon_hurt(&mut self, id: i32) { + if let Some(d) = self.remote_dragon_mut(id) { + d.hurt_time = 10; + } + } + /// `handleRemoveEntities`, or a crystal removed: the healing beam + /// keeps pointing at the same crystal. + pub(super) fn remove_remote_dragon(&mut self, id: i32) { + if self.remote_dragon_mut(id).is_some() { + self.dragon = None; + return; + } + let Some(index) = self.crystals.iter().position(|c| c.id as i32 == id) else { + return; + }; + if let Some(d) = self.dragon.as_mut() { + match d.nearest_crystal { + Some(n) if n == index => d.nearest_crystal = None, + Some(n) if n > index => d.nearest_crystal = Some(n - 1), + _ => {} + } + } + } + /// One client tick of the dragon. `lerp`: the step toward its last + /// sent position and yaw (LivingEntity's interpolation), and the + /// steps left including this one. + pub(super) fn tick_remote_dragon(&mut self, lerp: Option<([f64; 3], Option, u32)>) { + let Some(d) = self.dragon.as_mut() else { + return; + }; + d.previous = d.position; + d.previous_yaw = d.yaw; + d.old_flap = d.flap; + d.ticks += 1; + d.hurt_time = (d.hurt_time - 1).max(0); + for part in &mut d.parts { + part.1 = part.0; + } + if let Some((target, yaw, steps)) = lerp { + let n = f64::from(steps.max(1)); + d.position = Vec3::new( + d.position.x + (target[0] - d.position.x) / n, + d.position.y + (target[1] - d.position.y) / n, + d.position.z + (target[2] - d.position.z) / n, + ); + if let Some(yaw) = yaw { + d.yaw += wrap(yaw - d.yaw) / steps.max(1) as f32; + } + } + if !d.alive() { + // EnderDragon.tickDeath on a client: it rises, and bursts + // from tick 180 to 200; the server removes it. + d.death_time += 1; + let (t, p) = (d.death_time, d.position); + if (180..=200).contains(&t) { + let r = &mut d.random; + let o = [ + f64::from((r.next_float() - 0.5) * 8.0), + f64::from((r.next_float() - 0.5) * 4.0), + f64::from((r.next_float() - 0.5) * 8.0), + ]; + self.particles.add( + &ParticleOptions::simple(ParticleType::ExplosionEmitter), + [p.x + o[0], p.y + 2.0 + o[1], p.z + o[2]], + [0.0; 3], + ); + } + if let Some(d) = self.dragon.as_mut() { + d.position.y += 0.1; + for part in &mut d.parts { + part.0.y += 0.1; + } + } + return; + } + // processFlappingMovement and onFlap: its wing beats, and their sound. + let flap_was = (d.old_flap * std::f32::consts::TAU).cos(); + let v = d.velocity; + let mut flap_speed = 0.2 / ((v.x.hypot(v.z) as f32) * 10.0 + 1.0); + flap_speed *= 2f32.powf(v.y as f32); + d.flap += if d.phase.sitting() { 0.1 } else { flap_speed }; + let flap_now = (d.flap * std::f32::consts::TAU).cos(); + let at = [d.position.x, d.position.y, d.position.z]; + if flap_was <= -0.3 && flap_now >= -0.3 { + let pitch = 0.8 + self.world.random.next_float() * 0.3; + self.audio + .play("minecraft:entity.ender_dragon.flap", Some(at), 5.0, pitch); + } + let d = self.dragon.as_mut().expect("dragon"); + if !d.phase.sitting() { + d.growl -= 1; + if d.growl < 0 { + d.growl = 200 + d.random.next_int_bound(200).unwrap_or(0); + let pitch = 0.8 + self.world.random.next_float() * 0.3; + self.audio + .play("minecraft:entity.ender_dragon.growl", Some(at), 2.5, pitch); + } + } + // checkCrystals' search runs on a client too (the healing beam). + let d = self.dragon.as_mut().expect("dragon"); + if d.random.next_int_bound(10).unwrap_or(1) == 0 { + let p = d.position; + let nearest = self.nearest_crystal_to(p); + self.dragon.as_mut().expect("dragon").nearest_crystal = nearest; + } + let d = self.dragon.as_mut().expect("dragon"); + d.yaw = wrap(d.yaw); + d.record(); + self.place_dragon_parts(); + } + /// The dragon's parts as a server's client attacks them: the server's + /// ids for `EnderDragonPart`s follow the dragon's. + pub(super) fn remote_dragon_part_hit( + &self, + eye: [f64; 3], + dir: [f64; 3], + reach: f64, + ) -> Option<(i32, f64, [f64; 3])> { + let d = self.dragon.as_ref().filter(|d| d.alive() && d.id != 0)?; + (0..8) + .filter_map(|i| { + let b = d.part_box(i); + let p = d.parts[i].0; + super::ray_box(eye, dir, reach, b) + .map(|t| ((d.id + 1 + i as u32) as i32, t, [p.x, p.y, p.z])) + }) + .min_by(|a, b| a.1.total_cmp(&b.1)) + } } #[cfg(test)] diff --git a/crates/horizon-client/src/game/end.rs b/crates/horizon-client/src/game/end.rs index 904c035c5..32d5113b0 100644 --- a/crates/horizon-client/src/game/end.rs +++ b/crates/horizon-client/src/game/end.rs @@ -129,15 +129,32 @@ impl EndState { survive: false, }); } - /// One tick of a server's client: `step` moves each toward where the - /// server put it. - pub(super) fn step_remote_eyes(&mut self, mut step: impl FnMut(u32, [f64; 3]) -> [f64; 3]) { + /// `EyeOfEnder.tick` on a server's client: it moves by its last known + /// motion; only the server steers it. + pub(super) fn step_remote_eyes(&mut self) { for e in &mut self.eyes { e.previous = e.position; e.life += 1; - e.position = glam::DVec3::from_array(step(e.id, e.position.to_array())); + e.position += e.velocity; } } + /// A server's move: an eye has no interpolation handler, so + /// `moveOrInterpolateTo` puts it there at once. False when `id` isn't one. + pub(super) fn move_remote_eye(&mut self, id: u32, at: [f64; 3]) -> bool { + let Some(e) = self.eyes.iter_mut().find(|e| e.id == id) else { + return false; + }; + e.position = glam::DVec3::from_array(at); + true + } + /// `handleSetEntityMotion` for an eye. False when `id` isn't one. + pub(super) fn remote_eye_motion(&mut self, id: u32, velocity: [f64; 3]) -> bool { + let Some(e) = self.eyes.iter_mut().find(|e| e.id == id) else { + return false; + }; + e.velocity = glam::DVec3::from_array(velocity); + true + } pub(super) fn remove_remote_eye(&mut self, id: u32) { self.eyes.retain(|e| e.id != id); } @@ -1099,6 +1116,7 @@ impl Game<'_> { /// EyeOfEnder.tick: fly, then drop (4 in 5) or shatter after 80 ticks. fn tick_eyes(&mut self) { let mut eyes = std::mem::take(&mut self.end.eyes); + let mut shattered = Vec::new(); eyes.retain_mut(|eye| { eye.previous = eye.position; let next = eye.position + eye.velocity; @@ -1122,10 +1140,44 @@ impl Game<'_> { extra: None, }; self.spawn_item(stack, at, [vx, 0.2, vz], 0); + } else { + shattered.push(at.map(|v| v.floor() as i32)); } false }); self.end.eyes = eyes; + for pos in shattered { + self.level_event_at(2003, pos, 0); + } + } + + /// `LevelEventHandler` 2003: a shattered eye's item crumbs and two rings + /// of portal particles drawn in towards it. + pub(super) fn eye_break_particles(&mut self, pos: [i32; 3]) { + let (x, y, z) = ( + f64::from(pos[0]) + 0.5, + f64::from(pos[1]), + f64::from(pos[2]) + 0.5, + ); + let crumbs = self.item_particle(&ItemStack::new("minecraft:ender_eye", 1)); + for _ in 0..8 { + let r = self.particles.random(); + let v = [ + r.next_gaussian() * 0.15, + r.next_double() * 0.2, + r.next_gaussian() * 0.15, + ]; + self.particles.add(&crumbs, [x, y, z], v); + } + let portal = ParticleOptions::simple(ParticleType::Portal); + let mut angle = 0.0f64; + while angle < std::f64::consts::PI * 2.0 { + let (c, s) = (angle.cos(), angle.sin()); + let at = [x + c * 5.0, y - 0.4, z + s * 5.0]; + self.particles.add(&portal, at, [c * -5.0, 0.0, s * -5.0]); + self.particles.add(&portal, at, [c * -7.0, 0.0, s * -7.0]); + angle += std::f64::consts::PI / 20.0; + } } /// `EyeOfEnder.tick` on a client: behind each eye (a quarter of its last diff --git a/crates/horizon-client/src/game/extras.rs b/crates/horizon-client/src/game/extras.rs index 8ed585116..4d21f5288 100644 --- a/crates/horizon-client/src/game/extras.rs +++ b/crates/horizon-client/src/game/extras.rs @@ -1,5 +1,5 @@ -//! 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 +//! Horizon's extras in the game (`docs/extras.md`); a mod's minimap +//! (`render.set-minimap`: its tiles, image and HUD) and 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}; @@ -128,44 +128,29 @@ impl Game<'_> { } Ok(()) } - /// The minimap that shows, the extra's or else a mod's - /// (`render.set-minimap`): its corner, its side in GUI pixels and its - /// view of the player. + /// The minimap a mod shows (`render.set-minimap`): its corner, its side + /// in GUI pixels and its view of the player. fn minimap_shown(&self) -> Option<(Corner, f32, View)> { let p = self.player.as_ref()?; if self.title.is_some() || self.ui.hide_gui { return None; } - let e = &self.settings.extras; - let (corner, size, rotate, blocks_per_pixel, round) = if e.minimap { - let size = f32::from(e.minimap_size); - ( - e.minimap_corner, - size, - e.minimap_rotate, - e.minimap_zoom, - e.minimap_round, - ) - } else { - let m = self.mod_minimap()?; - (m.corner, m.size, m.rotate, m.blocks_per_pixel, m.round) - }; + let m = self.mod_minimap()?; let view = View { x: p.position.x, z: p.position.z, yaw: self.yaw, - rotate, - blocks_per_pixel, - round, + rotate: m.rotate, + blocks_per_pixel: m.blocks_per_pixel, + round: m.round, }; - Some((corner, size, view)) + Some((m.corner, m.size, view)) } /// Refresh the minimap's tiles within the frame budget, recompose its /// image when the view or a tile changed, and queue the upload. fn update_minimap(&mut self) { let Some((_, _, view)) = self.minimap_shown() else { - let wanted = self.settings.extras.minimap || self.mod_minimap().is_some(); - if !wanted || self.player.is_none() { + if self.mod_minimap().is_none() || self.player.is_none() { self.extras.minimap.clear(); self.extras.minimap_dim = None; } diff --git a/crates/horizon-client/src/game/fireworks.rs b/crates/horizon-client/src/game/fireworks.rs index 7838c9590..fd160a920 100644 --- a/crates/horizon-client/src/game/fireworks.rs +++ b/crates/horizon-client/src/game/fireworks.rs @@ -17,6 +17,8 @@ use horizon_core::{ random::RandomSource, }; +pub(super) const FIREWORK_EXPLODE_EVENT: i8 = 17; + pub(super) struct Rocket { /// The entity id a server tracks it by (0 until it is tracked). pub id: u32, @@ -71,6 +73,18 @@ impl Rocket { (self.position, self.velocity) } } +/// `damageAmount * (float)Math.sqrt((5.0 - this.distanceTo(target)) / 5.0)` +/// from the rocket at `from` to a target at `to`; `Entity.distanceTo` sums +/// the squared offsets in floats. +fn blast_damage(damage: f32, from: Vec3, to: Vec3) -> f32 { + let (x, y, z) = ( + (from.x - to.x) as f32, + (from.y - to.y) as f32, + (from.z - to.z) as f32, + ); + let distance = f64::from(x * x + y * y + z * z).sqrt() as f32; + damage * ((5.0 - f64::from(distance)) / 5.0).sqrt() as f32 +} pub(super) fn fireworks_of(stack: &ItemStack) -> (u8, Vec) { // The item's default component: flight 1, no explosions. stack @@ -249,23 +263,34 @@ impl Game<'_> { /// `FireworkRocketEntity.explode` and `dealExplosionDamage`. fn explode_rocket(&mut self, r: &Rocket) { let at = [r.position.x, r.position.y, r.position.z]; + // FireworkRocketEntity.explode broadcasts before discard. Send now: + // tick_lan removes missing tracked entities before flushing effects. + if r.id != 0 + && let Some(host) = &self.lan + { + host.hub + .entity_event(r.id as i32, FIREWORK_EXPLODE_EVENT, at); + } if !r.explosions.is_empty() { let damage = 5.0 + r.explosions.len() as f32 * 2.0; - // The player it boosts takes the full damage, a guest as well. - if r.attached { - match r.guest { - None => self.hurt_player_by("minecraft:fireworks", damage), - Some(conn) => { - if let Some(mut host) = self.lan.take() { - self.as_guest(&mut host, conn, |g| { - g.hurt_player_by("minecraft:fireworks", damage); - }); - self.lan = Some(host); - } - } - } - } let from = r.position; + // `attachedToEntity` takes the full damage, a guest as well; every + // other player in range and in sight takes the blast. + let boosted = r.guest.filter(|_| r.attached); + if r.attached && boosted.is_none() { + self.rocket_hurt_player(damage); + } else { + self.rocket_blast_player(from, damage); + } + if let Some(conn) = boosted + && let Some(mut host) = self.lan.take() + { + self.as_guest(&mut host, conn, |g| g.rocket_hurt_player(damage)); + self.lan = Some(host); + } + // Every other player in the level (LAN guests, the players of a + // server thread), each swapped in as the player. + self.each_guest_hit_except(boosted, |g| g.rocket_blast_player(from, damage)); let hits: Vec<(u32, f32)> = { let world = self.mob_world_base(&[]); self.mobs @@ -285,7 +310,7 @@ impl Game<'_> { ); world.clear_between(from, to, false) }); - sees.then(|| (m.id, damage * ((5.0 - d2.sqrt()) / 5.0).sqrt() as f32)) + sees.then(|| (m.id, blast_damage(damage, from, m.position))) }) .collect() }; @@ -307,6 +332,59 @@ impl Game<'_> { self.particles .fireworks(at, v, r.explosions.clone(), camera); } + /// FireworkRocketEntity.handleEntityEvent: use the synchronized item data. + pub(super) fn remote_firework_explosion(&mut self, id: i32) { + let camera = self.eye_position(); + if let Some(r) = self.rockets.iter().find(|r| r.id == id as u32) { + let at = [r.position.x, r.position.y, r.position.z]; + let v = [r.velocity.x, r.velocity.y, r.velocity.z]; + self.particles + .fireworks(at, v, r.explosions.clone(), camera.unwrap_or(at)); + } + } + /// `dealExplosionDamage` on a player that is not the rocket's + /// `attachedToEntity`: within 5 blocks, when the rocket sees its feet or + /// its middle (`ClipContext.Block.COLLIDER`, no fluids). + fn rocket_blast_player(&mut self, from: Vec3, damage: f32) { + let Some(p) = self.player.as_ref() else { + return; + }; + let feet = p.position; + let d2 = (feet.x - from.x).powi(2) + (feet.y - from.y).powi(2) + (feet.z - from.z).powi(2); + if d2 > 25.0 { + return; + } + let height = f64::from(p.dimensions.height); + let sees = { + let world = self.mob_world_base(&[]); + (0..2).any(|step| { + let to = Vec3::new(feet.x, feet.y + height * 0.5 * f64::from(step), feet.z); + world.clear_between(from, to, false) + }) + }; + if sees { + self.rocket_hurt_player(blast_damage(damage, from, feet)); + } + } + /// `hurtServer` with `damageSources().fireworks`: armor absorbs it and + /// wears (`hurtArmor`); creative and spectator players are immune. + fn rocket_hurt_player(&mut self, amount: f32) { + if self.creative || self.spectator() { + return; + } + let hurt = if let Some(p) = self.player.as_mut() + && !p.health.dead_or_dying() + && let Some(id) = self.motion.health.damage.id("minecraft:fireworks") + { + p.hurt(&self.motion.health, self.world.health_rules, id, amount) + .unwrap_or(false) + } else { + false + }; + if hurt { + self.hurt_armor(amount); + } + } /// `FireworkEntityRenderer.submit`: the item (GROUND) facing the camera, /// lit at the rocket's light probe. pub(super) fn rocket_geometry(&self, camera: glam::DVec3, alpha: f64, out: &mut Vec) { diff --git a/crates/horizon-client/src/game/fov.rs b/crates/horizon-client/src/game/fov.rs index 27d3fb61e..95e2e1e6e 100644 --- a/crates/horizon-client/src/game/fov.rs +++ b/crates/horizon-client/src/game/fov.rs @@ -64,14 +64,14 @@ impl Game<'_> { }); self.view.tick(eye, target); } - /// The player's `deathTime` while dead or dying. - fn death_time(&self) -> Option { + /// The player's `deathTime` while dead or dying: whole ticks counted by + /// `LivingEntity.tickDeath`, so `deathTime + partialTicks` in + /// `Camera.extractRenderState` rises smoothly across frames. + pub(super) fn death_time(&self) -> Option { let p = self.player.as_ref()?; - p.health.dead_or_dying().then(|| { - self.ui - .died_at - .map_or(0, |t| (t.elapsed().as_secs_f32() * 20.0) as i32) - }) + p.health + .dead_or_dying() + .then(|| self.ui.death_time.min(i32::MAX as u32) as i32) } /// The fluid at the camera, as `Camera.getFluidInCamera` reports it. pub(super) fn camera_fluid(&self, camera: [f64; 3]) -> CameraFluid { diff --git a/crates/horizon-client/src/game/frames.rs b/crates/horizon-client/src/game/frames.rs index 7f5e6c26a..d08c5f283 100644 --- a/crates/horizon-client/src/game/frames.rs +++ b/crates/horizon-client/src/game/frames.rs @@ -355,12 +355,23 @@ impl Game<'_> { * glam::DMat4::from_rotation_y(y_rot.to_radians()); let light = self.world.light(f.pos[0], f.pos[1], f.pos[2]); let packed = (u32::from(light >> 4) * 16) | ((u32::from(light & 15) * 16) << 8); + // ItemFrameRenderer.getBlockLightLevel: a glow frame's model is at least 5 bright. + let frame_light = if f.glow { + (light & 0xF0) | (light & 15).max(5) + } else { + light + }; + let frame_packed = + (u32::from(frame_light >> 4) * 16) | ((u32::from(frame_light & 15) * 16) << 8); let mut quad = |m: &glam::DMat4, corners: [[f64; 3]; 4], uv: [[f32; 2]; 4], light: u32| { - for (c, uv) in corners.iter().zip(uv) { - let p = m.transform_point3(glam::DVec3::from_array(*c)); + // The frame model is drawn with the entity shader, lit by its face normal. + let at = corners.map(|c| m.transform_point3(glam::DVec3::from_array(c))); + let n = (at[1] - at[0]).cross(at[2] - at[0]).normalize_or_zero(); + let normal = [0, 1, 2].map(|k| (n[k].clamp(-1.0, 1.0) * 127.0) as i8); + for (p, uv) in at.into_iter().zip(uv) { out.push(Vertex { - normal: [0; 4], + normal: [normal[0], normal[1], normal[2], -127], pos: p.as_vec3().to_array(), uv, layer: 0, @@ -393,7 +404,7 @@ impl Game<'_> { ] }), map_uv(r, *uv), - packed, + frame_packed, ); } } diff --git a/crates/horizon-client/src/game/hand.rs b/crates/horizon-client/src/game/hand.rs index a7218ff3c..d91d3b979 100644 --- a/crates/horizon-client/src/game/hand.rs +++ b/crates/horizon-client/src/game/hand.rs @@ -151,6 +151,7 @@ impl Game<'_> { before(self.painting_hit().map(|h| h.1)) || before(self.frame_hit().map(|h| h.1)) || before(self.armor_stand_hit().map(|h| h.1)) + || before(self.cushion_hit().map(|h| h.1)) || before(self.boat_hit().map(|h| h.1)) || before(self.cart_hit().map(|h| h.1)) || before(self.dragon_hit().map(|h| h.1)) diff --git a/crates/horizon-client/src/game/integrated.rs b/crates/horizon-client/src/game/integrated.rs index abe6df9b3..dd1c04e23 100644 --- a/crates/horizon-client/src/game/integrated.rs +++ b/crates/horizon-client/src/game/integrated.rs @@ -222,7 +222,6 @@ impl Game<'_> { options.report = None; options.server = None; options.world = None; - options.dev_mods.clear(); self.join_world_rest()?; let (res, pack, settings) = (self.res.clone(), self.pack.clone(), self.settings.clone()); let flags = Arc::new(Flags::default()); @@ -292,6 +291,9 @@ impl Game<'_> { launch.create.as_ref(), )?)?; let saved = Box::new(self.level.clone()); + // IntegratedServer runs the server mods; the window the client mods. + self.mods.dev = self.options.dev_mods.clone(); + self.start_mods(); // Math.max(2, options.renderDistance): past vanilla's 32 when the // window's render distance is (Horizon's options go to 64). let view_distance = self.settings.render_distance.max(2); @@ -370,6 +372,12 @@ impl Game<'_> { let mut next = Instant::now(); while !flags.stop.load(Ordering::Relaxed) { self.run_tasks(); + if self.agent.hold_server { + // Keep servicing control requests so the fixture can release the barrier. + // Unlike /tick freeze, no player's queued packets are applied here. + self.wait_for_next_server_tick(&mut next, true); + continue; + } let paused = flags.paused.load(Ordering::Relaxed); if paused { // Only the connections run. diff --git a/crates/horizon-client/src/game/lan.rs b/crates/horizon-client/src/game/lan.rs index 50fa222e6..63aea7e9f 100644 --- a/crates/horizon-client/src/game/lan.rs +++ b/crates/horizon-client/src/game/lan.rs @@ -14,7 +14,7 @@ use horizon_client::{ hub::{HostEvent, HostState, Hub, HubConfig, TickCtx}, playerdata, }, - mobs::{Mob, leash::Holder}, + mobs::{Mob, Who, leash::Holder}, text::Text, }; use horizon_core::geometry::Vec3; @@ -71,6 +71,8 @@ pub(super) struct LanHost { /// Guests' commands waiting for the hub to be back in `self.lan`, where /// a command can reach every player (game/lan_actions.rs). pub commands: Vec, + /// Mods' quiet commands waiting to run a few a tick (game/lan_quiet.rs). + pub quiet: std::collections::VecDeque, /// The entities the guests track, described again every tick /// (`lan_entities`) over last tick's states. states: lan::entity::States, @@ -145,6 +147,7 @@ pub(super) fn baby_index(kind: &str) -> Option { fn mob_meta( m: &Mob, hub: &Hub, + player_entity: Option, meta: &mut Vec<(u8, i32, Value)>, defaults: &mut Vec<(u8, i32, Value)>, ) { @@ -194,6 +197,32 @@ fn mob_meta( let e = &m.extra; let id = |registry: &str, name: &str| hub.registry_id(registry, &format!("minecraft:{name}")); match kind { + "minecraft:guardian" | "minecraft:elder_guardian" => { + // Guardian.DATA_ID_MOVING and DATA_ID_ATTACK_TARGET. + if e.flag2 { + meta.push((16, serializer::BOOLEAN, Value::Bool(true))); + } + let target = if e.flag { + m.ai.target.and_then(|who| match who { + Who::Player => player_entity, + Who::Mob(id) => Some(id as i32), + }) + } else { + None + }; + if let Some(target) = target { + meta.push((17, serializer::INT, Value::Int(target))); + } + defaults.push((16, serializer::BOOLEAN, Value::Bool(false))); + defaults.push((17, serializer::INT, Value::Int(0))); + } + // Bat.DATA_ID_FLAGS: resting in bit 0, flying by default. + "minecraft:bat" => { + if e.flag { + meta.push((16, serializer::BYTE, Value::Byte(1))); + } + defaults.push((16, serializer::BYTE, Value::Byte(0))); + } // Sheep.DATA_WOOL_ID: the colour in the low nibble, 16 when sheared. "minecraft:sheep" => { let value = (e.color & 15) | if e.sheared { 16 } else { 0 }; @@ -596,6 +625,7 @@ impl Game<'_> { waypoint_dead: Default::default(), border_sent: None, commands: Vec::new(), + quiet: std::collections::VecDeque::new(), states: Default::default(), }); self.audio.capture = Some(Vec::new()); @@ -634,6 +664,7 @@ impl Game<'_> { self.world.light_log = None; self.audio.capture = None; self.lan_events.clear(); + self.lan_critical_hits.clear(); self.streaming.extra.clear(); if announce { self.system_message(Text::translate( @@ -820,12 +851,13 @@ impl Game<'_> { for m in self.mobs.iter().filter(|m| !m.removed) { // The lead's holder: the player the mob sees (a guest, else the // host) or another mob. A fence knot isn't an entity here. + let player_entity = mob_players + .get(&m.id) + .and_then(|conn| hub.guest(*conn)) + .map(|g| g.entity_id) + .or(host_entity); let leash = m.extra.leash.and_then(|h| match h { - Holder::Player => mob_players - .get(&m.id) - .and_then(|conn| hub.guest(*conn)) - .map(|g| g.entity_id) - .or(host_entity), + Holder::Player => player_entity, Holder::Mob(id) => Some(id as i32), Holder::Knot(_) => None, }); @@ -835,7 +867,7 @@ impl Game<'_> { e.on_ground = m.on_ground; e.velocity = [m.velocity.x, m.velocity.y, m.velocity.z]; e.needs_sync = m.needs_sync; - mob_meta(m, hub, &mut e.meta, &mut e.defaults); + mob_meta(m, hub, player_entity, &mut e.meta, &mut e.defaults); mob_equipment(m, hub, &mut e.equipment); self.mob_attributes(m, &mut e.attributes); e.leash = leash; @@ -960,6 +992,9 @@ impl Game<'_> { event @ (HostEvent::Chat { .. } | HostEvent::Warn(_) | HostEvent::Error(_)) => { self.lan_log_event(event); } + HostEvent::PlayerChat { sender, text } => { + self.mod_player_chat(super::server_mods::Who::Uuid(sender), &text); + } HostEvent::Joined(conn) => { self.lan_guest_joined(&mut host, conn, state.as_ref(), entities, spawn); if self.options.dedicated.is_some() @@ -1029,6 +1064,14 @@ impl Game<'_> { } host.states = states; } + if !host.quiet.is_empty() { + self.lan = Some(host); + self.run_quiet_commands(); + host = self + .lan + .take() + .expect("the hub is back after the quiet commands"); + } self.lan_flush_effects(&mut host); if !paused { self.tick_guests(&mut host); @@ -1162,8 +1205,30 @@ impl Game<'_> { self.lan_entity_events.push((id, event, at)); } } + /// `ServerPlayer.crit`: this window's emitter, and an animation for the + /// attacker's client and observers once the hub is back in place. + pub(super) fn critical_hit( + &mut self, + attacker: Option, + id: i32, + feet: [f64; 3], + width: f64, + height: f64, + ) { + use horizon_client::particles::{ParticleOptions, ParticleType}; + self.particles.tracking_emitter( + ParticleOptions::simple(ParticleType::Crit), + feet, + width, + height, + ); + if self.audio.capture.is_some() { + self.lan_critical_hits.push((attacker, id)); + } + } /// Send the tick's level events, sounds and mob animations. fn lan_flush_effects(&mut self, host: &mut LanHost) { + let critical_hits = std::mem::take(&mut self.lan_critical_hits); for (kind, pos, data, acting) in std::mem::take(&mut self.lan_events) { if kind == 2001 { host.broken @@ -1236,6 +1301,14 @@ impl Game<'_> { seen.insert(m.id, (m.hurt_time, dead, swing)); } host.mob_state.insert(self.dim, seen); + for (attacker, target) in critical_hits { + let Some(attacker) = attacker.map_or(Some(host.host_entity), |conn| { + host.hub.guest(conn).map(|g| g.entity_id) + }) else { + continue; + }; + host.hub.critical_hit(attacker, target); + } } /// Keep the chunks around every guest loaded. @@ -1403,7 +1476,11 @@ impl Game<'_> { let tag = if secure { "" } else { "[Not Secure] " }; super::dedicated::log("INFO", &format!("{tag}{line}")); } - HostEvent::Chat { line, .. } => self.system_message(Text::literal(line)), + // Player chat (and `/say`'s or `/me`'s, which are chat messages + // too): the host's Chat option decides, as `ChatListener` does + // for the guests' packets. Command feedback is a system message + // and takes the system-message permission instead. + HostEvent::Chat { line, .. } => self.player_message(Text::literal(line)), HostEvent::Warn(line) if dedicated => super::dedicated::log("WARN", &line), HostEvent::Warn(line) => log::warn!("{line}"), HostEvent::Error(line) if dedicated => super::dedicated::log("ERROR", &line), diff --git a/crates/horizon-client/src/game/lan_actions.rs b/crates/horizon-client/src/game/lan_actions.rs index 76839ffd1..43bb573dc 100644 --- a/crates/horizon-client/src/game/lan_actions.rs +++ b/crates/horizon-client/src/game/lan_actions.rs @@ -77,6 +77,10 @@ pub(super) struct GuestPlay { last_inventory: u64, /// `Entity.portalProcess` and `portalCooldown` (game/server_travel.rs). pub(super) portal: horizon_client::nether_portal::PortalState, + /// `ServerPlayer.wonGame`: the End poem is showing, the player waits for + /// its client's PERFORM_RESPAWN (`respawn_requested`). + pub(super) won_game: bool, + pub(super) respawn_requested: bool, /// `Player.takeXpDelay`: ticks until the next orb can be taken. xp_delay: u32, /// What last killed the guest outright (`/kill`): the death message's key. @@ -94,11 +98,14 @@ pub(super) struct GuestPlay { /// A guest's command waiting for the hub (`LanHost::commands`). pub(super) struct GuestCommand { - conn: u32, - command: String, - permission: u8, + pub(super) conn: u32, + pub(super) command: String, + pub(super) permission: u8, /// An integrated server's: no level teleports (yet). - integrated: bool, + pub(super) integrated: bool, + /// A mod's quiet command (game/lan_quiet.rs): its output suppressed, as + /// `CommandSourceStack.withSuppressedOutput` does. + pub(super) quiet: bool, } /// The game's own state while a guest's is swapped in (`enter_guest`), and @@ -872,7 +879,11 @@ impl Game<'_> { .filter(|g| host.hub.here(g)) .filter(|g| { g.menu.as_ref().is_some_and(|m| { - m.slots.valid(&self.world) && !m.slots.still_valid(&self.world, g, m.pos) + (m.slots.valid(&self.world) && !m.slots.still_valid(&self.world, g, m.pos)) + || m.pos.is_some_and(|k| { + k.1 == super::minecarts::CART_KEY_Y + && !self.chest_vehicle_still_valid(k.2, g) + }) }) }) .map(|g| g.conn) @@ -886,6 +897,35 @@ impl Game<'_> { } } + /// `ContainerEntity.isChestVehicleStillValid`: the chest minecart or chest + /// boat is still there and within the guest's entity interaction range + /// plus 4 of its box. + fn chest_vehicle_still_valid(&self, id: i32, g: &horizon_client::lan::guest::Guest) -> bool { + let bounds = self + .carts + .iter() + .find(|c| c.id as i32 == id) + .map(|c| c.bounds()) + .or_else(|| { + self.boats + .iter() + .find(|b| b.id as i32 == id) + .map(|b| b.bounds()) + }); + let Some(b) = bounds else { + return false; + }; + let eye = [g.position[0], g.position[1] + g.eye_height(), g.position[2]]; + let (lo, hi) = (b.min_position(), b.max_position()); + let d = [ + eye[0] - eye[0].clamp(lo.x, hi.x), + eye[1] - eye[1].clamp(lo.y, hi.y), + eye[2] - eye[2].clamp(lo.z, hi.z), + ]; + let range = if g.creative() { 5.0 } else { 3.0 } + 4.0; + d[0] * d[0] + d[1] * d[1] + d[2] * d[2] < range * range + } + /// A packet from a guest that the hub does not handle itself. pub(super) fn lan_guest_packet(&mut self, host: &mut LanHost, conn: u32, packet: S) { let Some(gi) = host.hub.guests.iter().position(|g| g.conn == conn) else { @@ -1192,6 +1232,10 @@ impl Game<'_> { { self.container_changed(key); } + // A vehicle's menu edits the vehicle's own items. + if let Some(Slots::Block(key)) = slots { + self.store_cart_items(key); + } self.drop_guest_items(host, gi, drops); } S::ContainerClose(p) => { @@ -1206,6 +1250,9 @@ impl Game<'_> { self.guest_carried_back(host, gi); } S::ChatCommand(c) => self.guest_chat_command(host, conn, &c.command), + S::CustomPayload(p) if p.channel == horizon_protocol::quiet::CHANNEL => { + self.guest_quiet_commands(host, conn, &p.data) + } S::ChatCommandSigned(p) => self.guest_signed_command(host, conn, p), S::ChangeDifficulty(p) if host.hub.guests[gi].permission >= 2 => { if !self.level.difficulty_locked && (0..=3).contains(&p.difficulty) { @@ -1304,6 +1351,13 @@ impl Game<'_> { self.guest_suggestions(host, conn, &payload); } S::PlaceRecipe(p) => self.lan_place_recipe(host, conn, &p), + // handleClientCommand: PERFORM_RESPAWN after the poem leaves the End + // (the next server tick sends the player on). + S::ClientCommand(c) + if c.action == 0 && host.play.get(&conn).is_some_and(|p| p.won_game) => + { + host.play.entry(conn).or_default().respawn_requested = true; + } S::ClientCommand(c) if c.action == 0 => self.guest_respawn(host, conn), // ServerStatsCounter.sendStats. S::ClientCommand(c) if c.action == 1 => { @@ -1529,6 +1583,10 @@ impl Game<'_> { ); return; } + // A server mod's command, for every player whatever their level. + if self.guest_server_mod_command(host, conn, command.trim_start_matches('/')) { + return; + } // An integrated server runs every player's commands at their own // permission level (`CommandSourceStack.permissions`); a LAN world // follows its Allow Commands, and a dedicated server leaves it to @@ -1555,6 +1613,7 @@ impl Game<'_> { command: command.trim_start_matches('/').to_owned(), permission, integrated, + quiet: false, }); } @@ -1569,41 +1628,54 @@ impl Game<'_> { return; } let c = host.commands.remove(0); - let mut host = self.lan.take().expect("checked above"); - let Some(swap) = self.enter_guest(&mut host, c.conn) else { - self.lan = Some(host); - continue; - }; - self.lan = Some(host); - self.chat_capture = Some(Vec::new()); - let level = std::mem::replace(&mut self.ui.registries.permission, c.permission); - self.run_command(&c.command); - self.ui.registries.permission = level; - let lines = self.chat_capture.take().unwrap_or_default(); - let mut host = self.lan.take().expect("a command puts the hub back"); - self.leave_guest(&mut host, swap); - host.hub.sync_all_effects(); - if !c.integrated { - // A teleport into another level happens before its feedback is sent. - self.run_level_teleports(&mut host); - } - // What the command earned is announced before its feedback. - self.announce_guest_advancements(&mut host); - for line in lines { - host.hub.send_to( - c.conn, - &C::SystemChat(play::SystemChat { - content: horizon_client::lan::data::component_nbt(&line.component()), - overlay: false, - }), - ); - } - // The other operators hear of it; never the player whose command it was. - self.send_admin_feedback(&mut host, Some(c.conn)); - self.lan = Some(host); + self.run_guest_command(c); } } + /// One guest's command as that guest, its feedback sent to them; false + /// when it failed (or the guest is gone). + pub(super) fn run_guest_command(&mut self, c: GuestCommand) -> bool { + let Some(mut host) = self.lan.take() else { + return false; + }; + let Some(swap) = self.enter_guest(&mut host, c.conn) else { + self.lan = Some(host); + return false; + }; + self.lan = Some(host); + self.chat_capture = Some(Vec::new()); + let level = std::mem::replace(&mut self.ui.registries.permission, c.permission); + let ok = if c.quiet { + self.run_command_quietly(&c.command) + } else { + self.run_command(&c.command) + }; + self.ui.registries.permission = level; + let lines = self.chat_capture.take().unwrap_or_default(); + let mut host = self.lan.take().expect("a command puts the hub back"); + self.leave_guest(&mut host, swap); + host.hub.sync_all_effects(); + if !c.integrated { + // A teleport into another level happens before its feedback is sent. + self.run_level_teleports(&mut host); + } + // What the command earned is announced before its feedback. + self.announce_guest_advancements(&mut host); + for line in lines { + host.hub.send_to( + c.conn, + &C::SystemChat(play::SystemChat { + content: horizon_client::lan::data::component_nbt(&line.component()), + overlay: false, + }), + ); + } + // The other operators hear of it; never the player whose command it was. + self.send_admin_feedback(&mut host, Some(c.conn)); + self.lan = Some(host); + ok + } + /// The `broadcastToAdmins` lines a command queued (`source`: the guest /// whose it was; none for the host's or the console's): every other /// operator gets them, and the console logs them as the server's own @@ -1831,6 +1903,10 @@ impl Game<'_> { continue; } if self.on_server_trip(conn) { + // LivingEntity.hurt kills at once (die), whether the level + // has loaded around the player or not: its respawn request + // is taken as soon as it comes. + self.guest_die(host, gi, conn); continue; } let play = host.play.entry(conn).or_default(); @@ -1916,69 +1992,72 @@ impl Game<'_> { self.guest_dig_feedback(host, conn); self.guest_pickups(host, gi); self.guest_orbs(host, gi); - if host.hub.guests[gi].health <= 0.0 && !host.hub.guests[gi].dead { - self.guest_forget_digging(host, conn); - // FishingHook.shouldStopFishing: its owner is dead. - if let Some(play) = host.play.get_mut(&conn) { - play.hook = None; - } + self.guest_die(host, gi, conn); + } + } + + /// `ServerPlayer.die` for a guest whose health has run out: the death + /// message, the loot and experience, the death screen. + fn guest_die(&mut self, host: &mut LanHost, gi: usize, conn: u32) { + if host.hub.guests[gi].health <= 0.0 && !host.hub.guests[gi].dead { + self.guest_forget_digging(host, conn); + // FishingHook.shouldStopFishing: its owner is dead. + if let Some(play) = host.play.get_mut(&conn) { + play.hook = None; } - let g = &mut host.hub.guests[gi]; - if g.health <= 0.0 && !g.dead { - g.dead = true; - g.last_death = Some(g.position.map(|v| v.floor() as i32)); - let (id, at) = (g.entity_id, g.position); - let reward = Experience { - level: g.xp_level, - progress: g.xp_progress, - total: g.xp_total, - } - .death_reward(self.ui.rules.bool("keep_inventory") || g.game_mode == SPECTATOR); - let (name, uuid) = (g.name.clone(), g.uuid); - // ServerPlayer.die: dropAllDeathLoot unless a spectator, from the eyes less 0.3. - let drops = (g.game_mode != SPECTATOR) - .then(|| [at[0], at[1] + g.eye_height() - 0.3, at[2]]); - let cause = host.play.get_mut(&conn).and_then(|p| p.death_cause.take()); - // ServerPlayer.die: with showDeathMessages, the message goes to - // the dying player's death screen and to everyone the team lets - // see it; without it, the death screen gets an empty one. - let message = if self.ui.rules.bool("show_death_messages") { - let me = self.player_text(&name, uuid); - let text = match cause { - Some(key) => horizon_client::text::Text::translate(&key, &[me]), - None if at[1] < f64::from(horizon_client::chunk::MIN_Y - 64) => { - horizon_client::text::Text::translate("death.attack.outOfWorld", &[me]) - } - None => self.guest_death_message(conn, me), - }; - let message = horizon_client::lan::data::component_nbt(&text.component()); - let team = self.score.board.players_team(&name); - if horizon_client::scoreboard::own_death_message_shown(team) { - host.hub.system_message(message.clone()); - if self.options.dedicated.is_some() { - super::dedicated::log( - "INFO", - &format!("System chat: {}", text.plain()), - ); - } else if self.player.is_some() { - self.system_message(text); - } + } + let g = &mut host.hub.guests[gi]; + if g.health <= 0.0 && !g.dead { + g.dead = true; + g.last_death = Some(g.position.map(|v| v.floor() as i32)); + let (id, at) = (g.entity_id, g.position); + let reward = Experience { + level: g.xp_level, + progress: g.xp_progress, + total: g.xp_total, + } + .death_reward(self.ui.rules.bool("keep_inventory") || g.game_mode == SPECTATOR); + let (name, uuid) = (g.name.clone(), g.uuid); + // ServerPlayer.die: dropAllDeathLoot unless a spectator, from the eyes less 0.3. + let drops = + (g.game_mode != SPECTATOR).then(|| [at[0], at[1] + g.eye_height() - 0.3, at[2]]); + let cause = host.play.get_mut(&conn).and_then(|p| p.death_cause.take()); + // ServerPlayer.die: with showDeathMessages, the message goes to + // the dying player's death screen and to everyone the team lets + // see it; without it, the death screen gets an empty one. + let message = if self.ui.rules.bool("show_death_messages") { + let me = self.player_text(&name, uuid); + let text = match cause { + Some(key) => horizon_client::text::Text::translate(&key, &[me]), + None if at[1] < f64::from(horizon_client::chunk::MIN_Y - 64) => { + horizon_client::text::Text::translate("death.attack.outOfWorld", &[me]) } - message - } else { - literal("") + None => self.guest_death_message(conn, me), }; - host.hub.send_to( - conn, - &C::PlayerCombatKill(play::PlayerCombatKill { id, message }), - ); - // LivingEntity.die: the death animation, the dying player included. - host.hub.entity_event(id, 3, at); - if let Some(eyes) = drops { - self.as_guest(host, conn, |game| game.drop_inventory(eyes)); + let message = horizon_client::lan::data::component_nbt(&text.component()); + let team = self.score.board.players_team(&name); + if horizon_client::scoreboard::own_death_message_shown(team) { + host.hub.system_message(message.clone()); + if self.options.dedicated.is_some() { + super::dedicated::log("INFO", &format!("System chat: {}", text.plain())); + } else if self.player.is_some() { + self.system_message(text); + } } - self.spawn_orbs(at, reward); + message + } else { + literal("") + }; + host.hub.send_to( + conn, + &C::PlayerCombatKill(play::PlayerCombatKill { id, message }), + ); + // LivingEntity.die: the death animation, the dying player included. + host.hub.entity_event(id, 3, at); + if let Some(eyes) = drops { + self.as_guest(host, conn, |game| game.drop_inventory(eyes)); } + self.spawn_orbs(at, reward); } } @@ -2176,6 +2255,9 @@ impl Game<'_> { let _ = w.tick_environment_damage(); let _ = w.apply_fire_contact(); let _ = w.server_hazards_tick(in_wall); + // Player.tick ends with updatePlayerPose: a swimmer, or a player + // crawling under a block, takes the short box its moves are checked with. + let _ = w.update_player_pose(); let mut events = std::mem::take(&mut w.player.events); // LayeredCauldronBlock.handleEntityOnFireInside along those moves. for event in &events { diff --git a/crates/horizon-client/src/game/lan_chat.rs b/crates/horizon-client/src/game/lan_chat.rs index f678480ab..621955967 100644 --- a/crates/horizon-client/src/game/lan_chat.rs +++ b/crates/horizon-client/src/game/lan_chat.rs @@ -28,7 +28,11 @@ impl Game<'_> { /// SignableCommand.of: the command's message arguments, by name, with /// their text, not past a redirect to the root (`execute ... run`). - fn signable_arguments(&mut self, permission: u8, command: &str) -> Vec<(String, String)> { + pub(super) fn signable_arguments( + &mut self, + permission: u8, + command: &str, + ) -> Vec<(String, String)> { let parse = self.parse_as(permission, command); let nodes = &vanilla::game_dispatcher().nodes; let root = parse.context.root; diff --git a/crates/horizon-client/src/game/lan_crafting.rs b/crates/horizon-client/src/game/lan_crafting.rs index f74935522..db6235c4d 100644 --- a/crates/horizon-client/src/game/lan_crafting.rs +++ b/crates/horizon-client/src/game/lan_crafting.rs @@ -291,6 +291,11 @@ impl Game<'_> { let at = host.hub.guests[gi].position; self.award_furnace_recipes(pos, at); } + // Slot.setChanged on a changed container slot: BlockEntity.setChanged, + // so the chunk is saved and comparators read the block again. + if changed.iter().any(|&s| s < items.len()) { + self.container_changed(pos); + } host.play.entry(conn).or_default().crafting.machine = Some((p.container, menu)); host.hub.inventory_clicked(conn, p, &self.world, &changed); true diff --git a/crates/horizon-client/src/game/lan_entities.rs b/crates/horizon-client/src/game/lan_entities.rs index cd4ba2fb8..776466c25 100644 --- a/crates/horizon-client/src/game/lan_entities.rs +++ b/crates/horizon-client/src/game/lan_entities.rs @@ -245,6 +245,16 @@ impl Game<'_> { } out.push(e); } + for c in &self.cushions { + let p = c.position; + let mut e = state(c.id, "minecraft:cushion", [p.x, p.y, p.z], c.yaw, false); + // Cushion.DATA_COLOR, set unless it is the default white. + if c.color != 0 { + e.meta + .push((8, serializer::DYE_COLOR, Value::Id(i32::from(c.color)))); + } + out.push(e); + } self.lan_projectile_states(host_entity, hub, out); for o in &self.others { let p = o.position; diff --git a/crates/horizon-client/src/game/lan_mobs.rs b/crates/horizon-client/src/game/lan_mobs.rs index dc4d1eb42..4f53cec60 100644 --- a/crates/horizon-client/src/game/lan_mobs.rs +++ b/crates/horizon-client/src/game/lan_mobs.rs @@ -119,7 +119,17 @@ impl Game<'_> { /// Runs `f` as each guest in play here, for what strikes every player in /// an area (`Level.getEntities`), not only the window's own. - pub(super) fn each_guest_hit(&mut self, mut f: impl FnMut(&mut Self)) { + pub(super) fn each_guest_hit(&mut self, f: impl FnMut(&mut Self)) { + self.each_guest_hit_except(None, f); + } + + /// [`Self::each_guest_hit`] leaving out the guest `except` (the one a + /// firework rocket is attached to, which it hurts on its own). + pub(super) fn each_guest_hit_except( + &mut self, + except: Option, + mut f: impl FnMut(&mut Self), + ) { let Some(mut host) = self.lan.take() else { return; }; @@ -127,7 +137,7 @@ impl Game<'_> { .hub .guests .iter() - .filter(|g| host.hub.here(g) && g.loaded && !g.dead) + .filter(|g| host.hub.here(g) && g.loaded && !g.dead && Some(g.conn) != except) .map(|g| g.conn) .collect(); for conn in conns { diff --git a/crates/horizon-client/src/game/lan_particles.rs b/crates/horizon-client/src/game/lan_particles.rs index 0e35392bf..719fe79ab 100644 --- a/crates/horizon-client/src/game/lan_particles.rs +++ b/crates/horizon-client/src/game/lan_particles.rs @@ -25,6 +25,33 @@ fn rgb(c: [f32; 4]) -> [f32; 3] { } impl Game<'_> { + /// `SonicBoom.tick` uses `ServerLevel.sendParticles` for each ray point. + /// Keep the local event's rendering; connected players receive one at rest. + pub(super) fn lan_sonic_boom(&self, options: &ParticleOptions, at: [f64; 3]) { + let (Some(host), Some(particle)) = (&self.lan, self.network_particle(options, None)) else { + return; + }; + let packet = C::LevelParticles(play::LevelParticles { + particle, + override_limiter: false, + always_show: false, + pos: at, + dist: [0.0; 3], + max_speed: [0.0; 3], + count: 0, + randomization: 0, + }); + for g in host.hub.guests.iter().filter(|g| host.hub.here(g)) { + // ServerLevel compares the player's block centre, strictly within 32. + let distance: f64 = (0..3) + .map(|k| (g.position[k].floor() + 0.5 - at[k]).powi(2)) + .sum(); + if distance < 32.0 * 32.0 { + g.send(&packet); + } + } + } + /// `ParticleTypes.STREAM_CODEC`'s value for `options`: the type's /// network id and the data it carries (`state` for the block particles). /// None while not serving, or for a particle whose data isn't sent from diff --git a/crates/horizon-client/src/game/lan_pvp.rs b/crates/horizon-client/src/game/lan_pvp.rs index 467c4537c..c7c6b6525 100644 --- a/crates/horizon-client/src/game/lan_pvp.rs +++ b/crates/horizon-client/src/game/lan_pvp.rs @@ -32,6 +32,8 @@ pub(super) enum Victim { /// The attacker's side of the hit. pub(super) struct Strike { + /// The attacking guest, kept after their turn through `as_guest` ends. + attacker: Option, amount: f32, scale: f32, crit: bool, @@ -119,6 +121,7 @@ impl Game<'_> { } self.swing_arm(); Some(Strike { + attacker: self.lan_acting, amount, scale, crit, @@ -250,6 +253,25 @@ impl Game<'_> { Victim::Host => land(self), Victim::Guest(conn) => self.guest_struck_by(host, conn, land).unwrap_or(false), }; + if hurt && s.crit { + let target = match victim { + Victim::Host => self.player.as_ref().map(|p| (host.host_entity, p)), + Victim::Guest(conn) => host + .hub + .guest(conn) + .and_then(|g| g.motion.as_deref().map(|p| (g.entity_id, p))), + }; + if let Some((id, p)) = target { + let d = p.dimensions; + self.critical_hit( + s.attacker, + id, + [p.position.x, p.position.y, p.position.z], + f64::from(d.width), + f64::from(d.height), + ); + } + } let sound = match (hurt, s.crit, s.scale > 0.9) { (false, ..) => "minecraft:entity.player.attack.nodamage", (true, true, _) => "minecraft:entity.player.attack.crit", diff --git a/crates/horizon-client/src/game/lan_quiet.rs b/crates/horizon-client/src/game/lan_quiet.rs new file mode 100644 index 000000000..63d382c02 --- /dev/null +++ b/crates/horizon-client/src/game/lan_quiet.rs @@ -0,0 +1,165 @@ +//! Quiet commands (`horizon_protocol::quiet`): a Horizon client's mod sends a +//! batch of command lines in one payload, and the server runs each exactly as +//! that player typing it would (`guest_command`'s checks, the player's own +//! permission level, at the time it runs) with its output suppressed, as +//! vanilla's functions run (`CommandSourceStack.withSuppressedOutput`): no +//! feedback and no failure in anyone's chat. A batch waits in a queue and runs +//! [`PER_TICK`] lines a player a tick, so a mod can't flood a server; each +//! finished batch is one line in the server's log. +use super::{Game, lan::LanHost, lan_actions::GuestCommand}; +use horizon_protocol::quiet; +use std::collections::{HashMap, VecDeque}; + +/// Lines a player may have waiting at most; a batch past it loses the rest. +pub(super) const PENDING: usize = 4096; +/// Lines run a player a tick at most. +pub(super) const PER_TICK: usize = 64; + +/// A batch waiting to run. +pub(super) struct QuietBatch { + conn: u32, + mod_id: String, + lines: VecDeque, + ran: usize, + failed: usize, + /// Lines past [`PENDING`], never run. + dropped: usize, +} + +impl Game<'_> { + /// A `horizon:quiet_commands` payload from `conn`: queued (or logged as + /// refused when it breaks the payload's caps). + pub(super) fn guest_quiet_commands(&mut self, host: &mut LanHost, conn: u32, data: &[u8]) { + let Some(name) = host.hub.guest(conn).map(|g| g.name.clone()) else { + return; + }; + let batch = match quiet::decode(data) { + Ok(b) => b, + Err(e) => { + super::dedicated::log( + "WARN", + &format!("{name} sent quiet commands that were refused: {e}"), + ); + return; + } + }; + let waiting: usize = host + .quiet + .iter() + .filter(|b| b.conn == conn) + .map(|b| b.lines.len()) + .sum(); + let room = PENDING.saturating_sub(waiting); + let dropped = batch.lines.len().saturating_sub(room); + host.quiet.push_back(QuietBatch { + conn, + mod_id: batch.mod_id, + lines: batch.lines.into_iter().take(room).collect(), + ran: 0, + failed: 0, + dropped, + }); + } + + /// The waiting batches, [`PER_TICK`] lines a player this tick, in order. + pub(super) fn run_quiet_commands(&mut self) { + let mut left: HashMap = HashMap::new(); + let mut i = 0; + loop { + let Some(host) = self.lan.as_mut() else { + return; + }; + let Some(batch) = host.quiet.get_mut(i) else { + return; + }; + let conn = batch.conn; + let budget = left.entry(conn).or_insert(PER_TICK); + let gone = host.hub.guest(conn).is_none(); + if gone || batch.lines.is_empty() { + let batch = host.quiet.remove(i).expect("got it above"); + if !gone { + let name = host + .hub + .guest(conn) + .map_or(String::new(), |g| g.name.clone()); + super::dedicated::log("INFO", &summary(&name, &batch)); + } + continue; + } + if *budget == 0 { + i += 1; + continue; + } + *budget -= 1; + let line = batch.lines.pop_front().expect("not empty"); + let ok = self.run_quiet_line(conn, &line); + if let Some(batch) = self.lan.as_mut().and_then(|h| h.quiet.get_mut(i)) { + batch.ran += 1; + batch.failed += usize::from(!ok); + } + } + } + + /// One line as `guest_command` would run it for `conn`, quietly. False + /// when it is refused or fails. A command that carries a chat message + /// (`say`, `msg`...) is refused: it would need the player's signature. + fn run_quiet_line(&mut self, conn: u32, line: &str) -> bool { + let allowed = self.options.dedicated.is_some() || self.allow_commands(); + let Some(host) = self.lan.as_ref() else { + return false; + }; + let integrated = host.hub.config.integrated; + if !integrated && (!host.settings.guest_commands || !allowed) { + return false; + } + let Some(permission) = host.hub.guest(conn).map(|g| g.permission) else { + return false; + }; + let command = line.trim_start_matches('/'); + if !self.signable_arguments(permission, command).is_empty() { + return false; + } + self.run_guest_command(GuestCommand { + conn, + command: command.to_owned(), + permission, + integrated, + quiet: true, + }) + } +} + +/// The batch's line in the server's log. +fn summary(name: &str, b: &QuietBatch) -> String { + let mut line = format!( + "{name} ran {} quiet command(s) from mod {}: {} failed", + b.ran, b.mod_id, b.failed + ); + if b.dropped > 0 { + line += &format!(", {} dropped (more than {PENDING} waiting)", b.dropped); + } + line +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn the_log_line_counts_the_batch() { + let b = QuietBatch { + conn: 1, + mod_id: "orbital".into(), + lines: VecDeque::new(), + ran: 12, + failed: 3, + dropped: 0, + }; + assert_eq!( + summary("Alex", &b), + "Alex ran 12 quiet command(s) from mod orbital: 3 failed" + ); + let b = QuietBatch { dropped: 5, ..b }; + assert!(summary("Alex", &b).ends_with(", 5 dropped (more than 4096 waiting)")); + } +} diff --git a/crates/horizon-client/src/game/lan_trading.rs b/crates/horizon-client/src/game/lan_trading.rs index 1bec9809d..7beeeba2f 100644 --- a/crates/horizon-client/src/game/lan_trading.rs +++ b/crates/horizon-client/src/game/lan_trading.rs @@ -144,15 +144,16 @@ impl Game<'_> { .offers .iter() .filter_map(|o| { - let cost = - |st: &ItemStack, hub: &mut horizon_client::lan::hub::Hub| play::NetCost { - item: hub.item_id(&st.item), - count: st.count as i32, - }; + let cost = |st: &ItemStack, hub: &mut horizon_client::lan::hub::Hub| { + hub.stack(&Some(st.clone())).map(play::NetCost::from) + }; Some(play::NetOffer { - cost_a: cost(&o.base_cost_a.stack, &mut host.hub), + cost_a: cost(&o.base_cost_a.stack, &mut host.hub)?, result: host.hub.stack(&Some(o.result.clone()))?, - cost_b: o.cost_b.as_ref().map(|b| cost(&b.stack, &mut host.hub)), + cost_b: match &o.cost_b { + Some(b) => Some(cost(&b.stack, &mut host.hub)?), + None => None, + }, out_of_stock: o.out_of_stock(), uses: o.uses, max_uses: o.max_uses, diff --git a/crates/horizon-client/src/game/lan_vehicles.rs b/crates/horizon-client/src/game/lan_vehicles.rs index f16a1e37d..00795aa62 100644 --- a/crates/horizon-client/src/game/lan_vehicles.rs +++ b/crates/horizon-client/src/game/lan_vehicles.rs @@ -56,6 +56,13 @@ impl Game<'_> { let (lo, hi) = corners(a.bounds()); return Some((lo, hi, at(a.position))); } + if let Some(c) = self.cushions.iter().find(|c| c.id == id) { + let (lo, hi) = corners(Aabb::new( + Vec3::new(c.position.x - 0.5, c.position.y, c.position.z - 0.5), + Vec3::new(c.position.x + 0.5, c.position.y + 0.25, c.position.z + 0.5), + )); + return Some((lo, hi, at(c.position))); + } if let Some(f) = self.item_frames.iter().find(|f| f.id == id) { let (lo, hi) = f.bounds(); return Some((lo, hi, centre(f.pos))); @@ -98,9 +105,10 @@ impl Game<'_> { let boat = self.boats.iter().position(|b| b.id == vehicle); let cart = self.carts.iter().any(|c| c.id == vehicle); let mount = self.mobs.iter().any(|m| m.id == vehicle); + let cushion = self.cushions.iter().any(|c| c.id == vehicle); // The vehicle is gone (broken, in another level) or the rider died: // its client drops it with the entity or the death screen. - if dead || (boat.is_none() && !cart && !mount) { + if dead || (boat.is_none() && !cart && !mount && !cushion) { let g = &mut host.hub.guests[gi]; (g.vehicle, g.vehicle_good) = (None, None); return; @@ -115,6 +123,17 @@ impl Game<'_> { // Getting out goes through leave_guest, which tells the client and // teleports it (ServerPlayer.dismountTo). let seat = self.as_guest(host, conn, |game| { + // A cushion does not move: the rider sits on it until it sneaks + // (`Cushion.removePassenger` plays the get-up sound). + if game.cushions.iter().any(|c| Some(c.id) == game.riding) { + if keys.shift { + game.tick_cushion_riding(keys); + return None; + } + let c = game.cushions.iter().find(|c| Some(c.id) == game.riding)?; + let p = c.seat(); + return Some([p.x, p.y, p.z]); + } if let Some(i) = game.boats.iter().position(|b| Some(b.id) == game.riding) { if keys.shift { game.dismount(i); @@ -168,6 +187,12 @@ impl Game<'_> { .iter() .find(|c| c.id == vehicle) .map(|c| (c.position, c.position.add_vector(Vec3::new(0.0, SEAT, 0.0)))) + }) + .or_else(|| { + self.cushions + .iter() + .find(|c| c.id == vehicle) + .map(|c| (c.position, c.seat())) }); if let Some((p, seat)) = at { let g = &mut host.hub.guests[gi]; diff --git a/crates/horizon-client/src/game/levels.rs b/crates/horizon-client/src/game/levels.rs index e8a8cfb59..9137a26d1 100644 --- a/crates/horizon-client/src/game/levels.rs +++ b/crates/horizon-client/src/game/levels.rs @@ -50,6 +50,7 @@ pub(super) struct Parked { paintings: Vec, item_frames: Vec, armor_stands: Vec, + cushions: Vec, others: Vec, boats: Vec, carts: Vec, @@ -74,6 +75,7 @@ pub(super) struct Parked { lan_events: Vec<(i32, [i32; 3], i32, Option)>, lan_block_events: Vec<([i32; 3], i32, i32, u32)>, lan_entity_events: Vec<(i32, i8, [f64; 3])>, + lan_critical_hits: Vec<(Option, i32)>, /// Only the per-level parts of these are used (`swap_level`). anims: BlockEntityAnims, raiding: Raiding, @@ -135,6 +137,7 @@ impl Game<'_> { paintings: Vec::new(), item_frames: Vec::new(), armor_stands: Vec::new(), + cushions: Vec::new(), others: Vec::new(), boats: Vec::new(), carts: Vec::new(), @@ -159,6 +162,7 @@ impl Game<'_> { lan_events: Vec::new(), lan_block_events: Vec::new(), lan_entity_events: Vec::new(), + lan_critical_hits: Vec::new(), anims: Default::default(), raiding: Default::default(), sculk: Default::default(), @@ -185,6 +189,7 @@ impl Game<'_> { swap(&mut self.paintings, &mut p.paintings); swap(&mut self.item_frames, &mut p.item_frames); swap(&mut self.armor_stands, &mut p.armor_stands); + swap(&mut self.cushions, &mut p.cushions); swap(&mut self.others, &mut p.others); swap(&mut self.boats, &mut p.boats); swap(&mut self.carts, &mut p.carts); @@ -209,6 +214,7 @@ impl Game<'_> { swap(&mut self.lan_events, &mut p.lan_events); swap(&mut self.lan_block_events, &mut p.lan_block_events); swap(&mut self.lan_entity_events, &mut p.lan_entity_events); + swap(&mut self.lan_critical_hits, &mut p.lan_critical_hits); let (a, b) = (&mut self.be_anims, &mut p.anims); swap(&mut a.chests, &mut b.chests); swap(&mut a.books, &mut b.books); diff --git a/crates/horizon-client/src/game/minecarts.rs b/crates/horizon-client/src/game/minecarts.rs index 8d4920b48..f5f748a49 100644 --- a/crates/horizon-client/src/game/minecarts.rs +++ b/crates/horizon-client/src/game/minecarts.rs @@ -88,8 +88,8 @@ pub(super) struct Minecart { /// Hopper minecarts: an unpowered activator rail enables them. pub enabled: bool, } -const WIDTH: f64 = 0.98; -const HEIGHT: f64 = 0.7; +pub(super) const WIDTH: f64 = 0.98; +pub(super) const HEIGHT: f64 = 0.7; /// AbstractMinecart.getDefaultDisplayOffset, in sixteenths of a block. fn display_offset(kind: CartKind) -> f64 { if kind == CartKind::Hopper { 1.0 } else { 6.0 } @@ -97,7 +97,7 @@ fn display_offset(kind: CartKind) -> f64 { /// The minecart's passenger attachment minus Player.DEFAULT_VEHICLE_ATTACHMENT. pub(super) const SEAT: f64 = 0.1875 - 0.6; /// The placeholder container key under which an open cart's items live. -pub(super) const CART_KEY_Y: i32 = -100_000; +pub(super) const CART_KEY_Y: i32 = horizon_client::lan::menu::VEHICLE_KEY_Y; #[derive(Clone, Copy, PartialEq, Eq, Debug)] pub(super) enum Shape { @@ -1117,22 +1117,35 @@ impl Game<'_> { self.swing_arm(); true } - /// Closing a cart's container copies the items back. - pub(super) fn close_cart_container(&mut self) { - let Some(key) = self.container.filter(|k| k.1 == CART_KEY_Y) else { - return; - }; - let Some(BlockEntity::Chest(items)) = self.world.block_entities.remove(&key) else { + /// Closing the cart's container open under `key` copies the items back. + pub(super) fn close_cart_container(&mut self, key: (i32, i32, i32)) { + if key.1 != CART_KEY_Y { + return; + } + self.store_cart_items(key); + self.world.block_entities.remove(&key); + if let Some(c) = self.carts.iter().find(|c| c.id as i32 == key.2) + && c.kind == CartKind::Chest + { + let at = [c.position.x, c.position.y, c.position.z]; + let pitch = self.world.random.next_float() * 0.1 + 0.9; + self.audio + .play("minecraft:block.chest.close", Some(at), 0.5, pitch); + } + } + /// The menu of a chest or hopper minecart or a chest boat works on the + /// vehicle's own items (`ContainerEntity`): the placeholder under `key` + /// that the menu edits is copied back to the vehicle. + pub(super) fn store_cart_items(&mut self, key: (i32, i32, i32)) { + if key.1 != CART_KEY_Y { + return; + } + let Some(BlockEntity::Chest(items)) = self.world.block_entities.get(&key) else { return; }; + let items = items.clone(); if let Some(c) = self.carts.iter_mut().find(|c| c.id as i32 == key.2) { c.items = items; - let at = [c.position.x, c.position.y, c.position.z]; - if c.kind == CartKind::Chest { - let pitch = self.world.random.next_float() * 0.1 + 0.9; - self.audio - .play("minecraft:block.chest.close", Some(at), 0.5, pitch); - } } else if let Some(b) = self.boats.iter_mut().find(|b| b.id as i32 == key.2) { b.items = items; } diff --git a/crates/horizon-client/src/game/mods.rs b/crates/horizon-client/src/game/mods.rs index bbd0261b9..e2df267f4 100644 --- a/crates/horizon-client/src/game/mods.rs +++ b/crates/horizon-client/src/game/mods.rs @@ -17,6 +17,7 @@ use std::{path::PathBuf, time::Duration}; #[cfg(feature = "mods")] use { super::Screen, + super::{execution_role::ExecutionRole, lan::LanHost, server_mods::ModEvent}, horizon_client::{ extras::Corner, extras_hud, @@ -27,7 +28,10 @@ use { text::{self, Text}, ui, }, - horizon_mods::{Clock, ModKey, Mods, Output, Player, Snapshot, Status, UiScreen, UiWidget}, + horizon_mods::{ + Clock, ModKey, Mods, Output, Player, Runs, ServerPlayer, Snapshot, Status, UiScreen, + UiWidget, + }, std::time::Instant, winit::{event::MouseButton, keyboard::KeyCode}, }; @@ -50,6 +54,15 @@ pub(super) struct ModsState { /// The chat's command tree while a running mod owns commands. #[cfg(feature = "mods")] tree: Option, + /// A server mod runs here: what players do is queued for it. + #[cfg(feature = "mods")] + pub(super) server: bool, + /// The players server mods saw last tick, for joins and leaves. + #[cfg(feature = "mods")] + pub(super) players: Vec, + /// What players did this tick, for server mods at its end. + #[cfg(feature = "mods")] + pub(super) events: Vec, /// `command.run` lines for this window's own world, run on the next tick: /// run at once, their chat lines would reach the mods while their output /// is still being shown, and a mod answering its own lines would recurse. @@ -270,7 +283,7 @@ impl Game<'_> { .collect(); let enabled = &self.settings.mods.enabled; let on = |id: &str| enabled.contains(id) || dev_ids.iter().any(|d| d == id); - let mods = Mods::load(&paths, on, vanilla_command); + let mods = Mods::load_for(self.mod_runs(), &paths, on, vanilla_command); self.mods.mods = mods; let chosen = &self.settings.mods; self.mods.mods.set_bindings(|id| chosen.keys_of(id)); @@ -280,8 +293,18 @@ impl Game<'_> { self.sync_mod_commands(); self.show_mod_output(); } + /// Which mods this game runs: a server the server mods, the window + /// client mods, and both when it simulates the world itself (in-frame). + fn mod_runs(&self) -> Runs { + match self.options.execution_role { + ExecutionRole::IntegratedServer | ExecutionRole::DedicatedServer => Runs::Server, + ExecutionRole::Client if self.options.server_thread => Runs::Client, + ExecutionRole::Client => Runs::Both, + } + } /// The Mods page's rows, from what loaded. fn list_mods(&mut self) { + self.mods.server = self.mods.mods.runs_server(); let dev = &self.mods.dev; self.settings.mods.installed = self .mods @@ -367,8 +390,18 @@ impl Game<'_> { self.start_mods(); } } - /// What mods read this tick (or frame, for mods with a `frame` hook). + /// What mods read this tick (or frame, for mods with a `frame` hook): the + /// server's players as they were at the last tick's end. fn mod_snapshot(&mut self) -> Snapshot { + let players = if self.mods.server { + self.mods.players.clone() + } else { + Vec::new() + }; + self.mod_snapshot_with(players) + } + /// What mods read, with these players on the server. + pub(super) fn mod_snapshot_with(&mut self, players: Vec) -> Snapshot { let player = self.player.as_ref().map(|p| Player { x: p.position.x, y: p.position.y, @@ -412,8 +445,66 @@ impl Game<'_> { mappings, cps, font_widths: self.mods.font_widths.clone(), + players, + view_hit: self.mod_view_hit(), } } + /// The first block along the player's view within + /// [`horizon_mods::RAYCAST_MAX`] and its distance from the eye + /// (`game.raycast`): through the loaded chunks as the crosshair's ray + /// goes (fluids pass), then across the distant terrain's ground heights, + /// a block at a time. + fn mod_view_hit(&self) -> Option<(f32, horizon_mods::Hit)> { + if !self.mods.mods.wants_raycast() { + return None; + } + let eye = self.eye_position()?; + let dir = super::view_vector(self.yaw, self.pitch); + let reach = f64::from(horizon_mods::RAYCAST_MAX); + let (pos, point, state) = match self.clip_ray(eye, dir, reach) { + Some(hit) => ( + hit.pos, + hit.point, + self.world.block(hit.pos[0], hit.pos[1], hit.pos[2]), + ), + None => self.lod_ray(eye, dir, reach)?, + }; + let distance = (0..3).map(|i| (point[i] - eye[i]).powi(2)).sum::(); + let hit = horizon_mods::Hit { + block_x: pos[0], + block_y: pos[1], + block_z: pos[2], + x: point[0], + y: point[1], + z: point[2], + block: self.res.facts().get(state).name.to_string(), + }; + Some((distance.sqrt() as f32, hit)) + } + /// Past the resident chunks: the view walked across the distant + /// terrain's ground heights (`Lod::ground`), a block at a time. Columns in + /// loaded chunks are left to `clip_ray`, which has already missed them. + fn lod_ray( + &self, + eye: [f64; 3], + dir: [f64; 3], + reach: f64, + ) -> Option<([i32; 3], [f64; 3], horizon_world::registry::BlockStateId)> { + let lod = self.lod.as_ref()?; + let mut t = 0.0; + while t <= reach { + let p = [0, 1, 2].map(|i| eye[i] + dir[i] * t); + let (x, z) = (p[0].floor() as i32, p[2].floor() as i32); + if !self.world.loaded(x, z) + && let Some((height, state)) = lod.ground(x, z) + && p[1] <= f64::from(height) + { + return Some(([x, height - 1, z], [p[0], f64::from(height), p[2]], state)); + } + t += 1.0; + } + None + } /// A game tick. pub(super) fn tick_mods(&mut self) { // Here, at the player's level: shown inside a console call (a control @@ -430,23 +521,32 @@ impl Game<'_> { self.mods.mods.tick(self.ticks); self.show_mod_output(); } - /// Once per frame: the frame hook, and dev mods' rebuilds. - pub(super) fn mods_frame(&mut self, elapsed: Duration) { - if !self.mods.dev.is_empty() - && self + /// Restarts the dev mods rebuilt since the last check, once a second. + pub(super) fn reload_dev_mods(&mut self) { + if self.mods.dev.is_empty() + || self .mods .checked - .is_none_or(|t| t.elapsed() >= RELOAD_CHECK) + .is_some_and(|t| t.elapsed() < RELOAD_CHECK) { - self.mods.checked = Some(Instant::now()); - if self.mods.mods.reload_changed(vanilla_command) { - let chosen = &self.settings.mods; - self.mods.mods.set_bindings(|id| chosen.keys_of(id)); - self.list_mods(); - self.sync_mod_commands(); + return; + } + self.mods.checked = Some(Instant::now()); + if self.mods.mods.reload_changed(vanilla_command) { + let chosen = &self.settings.mods; + self.mods.mods.set_bindings(|id| chosen.keys_of(id)); + self.list_mods(); + self.sync_mod_commands(); + if self.options.execution_role.is_client() { self.system_message(Text::literal("Mods reloaded").with_color(text::GRAY)); + } else { + log::info!("Horizon: mods reloaded"); } } + } + /// Once per frame: the frame hook, and dev mods' rebuilds. + pub(super) fn mods_frame(&mut self, elapsed: Duration) { + self.reload_dev_mods(); if !self.mods.mods.is_running() { return; } @@ -477,8 +577,13 @@ impl Game<'_> { self.mods.mods.chat(line); self.show_mod_output(); } - /// Chat lines, command feedback and stopped mods, into the chat. - fn show_mod_output(&mut self) { + /// What mods showed: client mods' lines into the chat, server mods' + /// to their players. + pub(super) fn show_mod_output(&mut self) { + self.route_mod_output(None); + } + /// [`Game::show_mod_output`], with the hub when it is out of `self.lan`. + pub(super) fn route_mod_output(&mut self, mut host: Option<&mut LanHost>) { for output in self.mods.mods.drain() { let line = match output { Output::Chat { name, text } => { @@ -506,7 +611,16 @@ impl Game<'_> { // `mod_ui_view` finds no widgets and the screen closes. self.list_mods(); self.sync_mod_commands(); - Text::literal(format!("Mod {name} stopped: {reason}")).with_color(text::RED) + let line = format!("Mod {name} stopped: {reason}"); + if self.options.dedicated.is_some() { + super::dedicated::log("WARN", &line); + } + Text::literal(line).with_color(text::RED) + } + server + @ (Output::Tell { .. } | Output::Broadcast { .. } | Output::Reply { .. }) => { + self.route_server_output(host.as_deref_mut(), server); + continue; } Output::OpenScreen { owner } => { self.open_mod_screen(owner, false); @@ -523,17 +637,7 @@ impl Game<'_> { continue; } }; - // Not through system_message: a mod must not hear its own lines. - // Written by this client, so the Chat option doesn't hide it. - let focused = self.screen == Screen::Chat; - self.ui.chat.add( - &self.gui.atlas, - line, - None, - horizon_client::chat::ChatSource::Client, - self.ticks, - focused, - ); + self.add_mod_chat_line(line); } // A mod may set or clear its settings page in any call, not only // while loading: its row's Settings button follows. @@ -542,6 +646,20 @@ impl Game<'_> { row.has_settings = e.has_ui_settings(); } } + /// A mod's line in the window's chat; not through system_message: a mod + /// must not hear its own lines. + /// Written by this client, so the Chat option doesn't hide it. + pub(super) fn add_mod_chat_line(&mut self, line: Text) { + let focused = self.screen == Screen::Chat; + self.ui.chat.add( + &self.gui.atlas, + line, + None, + horizon_client::chat::ChatSource::Client, + self.ticks, + focused, + ); + } /// The mods' HUD panels, stacked with the extras in their corners. pub(super) fn draw_mod_panels(&self, batch: &mut HudBatch, corners: &mut Corners) { for panel in self.mods.mods.panels() { diff --git a/crates/horizon-client/src/game/names.rs b/crates/horizon-client/src/game/names.rs index f249bd01f..9f7561e53 100644 --- a/crates/horizon-client/src/game/names.rs +++ b/crates/horizon-client/src/game/names.rs @@ -86,6 +86,10 @@ impl Game<'_> { .iter() .filter_map(|m| Some((m, m.custom_name.clone()?, false))); let players = players.into_iter().map(|(m, name)| (m, name, true)); + // Who is riding whom: asked once per tag below, and rescanning every mob + // for each tag made this quadratic in the number of loaded mobs. + let ridden: std::collections::HashSet = + self.mobs.iter().filter_map(|o| o.extra.mount).collect(); for (m, name, player) in named.chain(players) { if !m.alive() { continue; @@ -134,7 +138,7 @@ impl Game<'_> { invisible_to_viewer: invisible, hud_hidden: self.ui.hide_gui, is_camera: false, - is_vehicle: self.mobs.iter().any(|o| o.extra.mount == Some(m.id)), + is_vehicle: ridden.contains(&m.id), }; // MobRenderer.shouldShowName: a visible name, or the mob under the // crosshair; players (LivingEntityRenderer) need neither. @@ -310,7 +314,7 @@ impl Game<'_> { } /// The lines of one name tag, `o` from the camera: the text at /// `text_alpha` in its layer, on the translucent black background - /// (unlit, a hair behind) when `background`. + /// (in `text_layer` like the glyphs, a hair behind) when `background`. #[allow(clippy::too_many_arguments)] fn name_tag_quads( &self, @@ -382,7 +386,7 @@ impl Game<'_> { [white.u0, white.v0, white.u1, white.v1], BACKGROUND, true, - 2, + text_layer, ); } let mut x = x0; diff --git a/crates/horizon-client/src/game/net_harness.rs b/crates/horizon-client/src/game/net_harness.rs index 1ec573e7c..468f1db71 100644 --- a/crates/horizon-client/src/game/net_harness.rs +++ b/crates/horizon-client/src/game/net_harness.rs @@ -3,7 +3,10 @@ //! window, waits until it stands in the world with the chunks around it, //! sends a chat message and `/list`, collects the chat it is shown, leaves //! and writes a JSON report (position, chunks, chat lines, whether the -//! server kept it connected throughout). +//! server kept it connected throughout). With `HORIZON_NET_QUIET` (lines +//! split by `;`) it then sends them as one batch of a mod's quiet commands +//! (`horizon_protocol::quiet`, `tools/quiet_commands_e2e.py`) and waits two +//! seconds for any chat they bring. use super::Game; use horizon_client::Result; use serde_json::json; @@ -23,6 +26,9 @@ impl Game<'_> { let mut step_at = Instant::now(); let mut chat_at = 0; let mut position = None; + let quiet: Vec = std::env::var("HORIZON_NET_QUIET") + .map(|v| v.split(';').map(str::to_owned).collect()) + .unwrap_or_default(); let mut chunks = 0; let mut error = None; while Instant::now() < deadline { @@ -71,6 +77,22 @@ impl Game<'_> { step_at = now; chat_at = shown; } + 2 if answered && !quiet.is_empty() => { + for data in horizon_protocol::quiet::encode("net_harness", &quiet) { + self.send(horizon_protocol::packets::play::Serverbound::CustomPayload( + horizon_protocol::packets::configuration::CustomPayload { + channel: horizon_protocol::quiet::CHANNEL.into(), + data, + }, + )); + } + step = 4; + step_at = now; + } + 4 if now - step_at > Duration::from_secs(2) => { + step = 3; + break; + } 2 if answered => { step = 3; break; diff --git a/crates/horizon-client/src/game/nether_portal.rs b/crates/horizon-client/src/game/nether_portal.rs index 353ad216c..87ba81c93 100644 --- a/crates/horizon-client/src/game/nether_portal.rs +++ b/crates/horizon-client/src/game/nether_portal.rs @@ -454,11 +454,24 @@ impl Game<'_> { for m in &self.mobs { self.portals.before.insert(m.id, m.position); } + for b in &self.boats { + self.portals.before.insert(b.id, b.position); + } + for c in &self.carts { + self.portals.before.insert(c.id, c.position); + } let ids: Vec<(u32, bool)> = self .dropped .iter() .map(|e| (e.id, true)) .chain(self.mobs.iter().map(|m| (m.id, self.mob_can_use_portal(m)))) + .chain( + self.boats + .iter() + .map(|b| b.id) + .chain(self.carts.iter().map(|c| c.id)) + .map(|id| (id, !self.vehicle_occupied(id))), + ) .collect(); let present: std::collections::HashSet = ids.iter().map(|(id, _)| *id).collect(); self.portals.entities.retain(|id, _| present.contains(id)); @@ -501,8 +514,15 @@ impl Game<'_> { && self.riding != Some(m.id) && m.species() != Species::Wither } - /// `NetherPortalBlock.entityInside` for the items and mobs that moved this - /// tick: the portal blocks their box swept through. + /// Whether the player, a server player or a mob rides vehicle `id`. + fn vehicle_occupied(&self, id: u32) -> bool { + self.riding == Some(id) + || self.ridden_by_guest(id) + || self.mobs.iter().any(|m| m.extra.mount == Some(id)) + } + /// `NetherPortalBlock.entityInside` for the items, mobs and empty boats + /// and minecarts that moved this tick: the portal blocks their box swept + /// through. pub(super) fn find_entity_portals(&mut self) { if self.remote.is_some() { return; @@ -519,8 +539,23 @@ impl Game<'_> { .filter(|m| self.mob_can_use_portal(m)) .map(|m| (m.id, m.position, m.width(), m.height())) .collect(); + let vehicles: Vec<(u32, Vec3, f32, f32)> = self + .boats + .iter() + .map(|b| (b.id, b.position, super::boats::WIDTH, super::boats::HEIGHT)) + .chain(self.carts.iter().map(|c| { + ( + c.id, + c.position, + super::minecarts::WIDTH, + super::minecarts::HEIGHT, + ) + })) + .filter(|(id, ..)| !self.vehicle_occupied(*id)) + .map(|(id, at, w, h)| (id, at, w as f32, h as f32)) + .collect(); let mut portal_sections = std::mem::take(&mut self.portals.sections); - for (id, to, width, height) in items.into_iter().chain(mobs) { + for (id, to, width, height) in items.into_iter().chain(mobs).chain(vehicles) { let from = self.portals.before.get(&id).copied().unwrap_or(to); if let Some(pos) = self.swept_portal(from, to, width, height, &mut portal_sections) { inside.push((id, pos)); @@ -678,6 +713,44 @@ impl Game<'_> { } self.portals.arrivals.push(Arrival { plan, tag }); self.portals.dirty = true; + } else if let Some(i) = self.boats.iter().position(|b| b.id == id) { + let b = &self.boats[i]; + let (width, height) = (super::boats::WIDTH as f32, super::boats::HEIGHT as f32); + let plan = self.portal_plan(entry, b.position, width, height, false); + if !self.may_enter(plan.dim) { + return; + } + let uuid = self.uuid_for(id); + let b = &self.boats[i]; + let tag = horizon_client::entity_nbt::boat_to_nbt( + &b.entity_type(), + b.position, + b.velocity, + b.yaw, + uuid, + self.persist_raw(id), + b.chest.then_some(&b.items[..]), + ); + self.boats.remove(i); + self.forget_entity(id); + self.portals.arrivals.push(Arrival { plan, tag }); + self.portals.dirty = true; + } else if let Some(i) = self.carts.iter().position(|c| c.id == id) { + let c = &self.carts[i]; + let (width, height) = ( + super::minecarts::WIDTH as f32, + super::minecarts::HEIGHT as f32, + ); + let plan = self.portal_plan(entry, c.position, width, height, false); + if !self.may_enter(plan.dim) { + return; + } + let uuid = self.uuid_for(id); + let tag = self.carts[i].to_nbt(uuid, self.persist_raw(id)); + self.carts.remove(i); + self.forget_entity(id); + self.portals.arrivals.push(Arrival { plan, tag }); + self.portals.dirty = true; } } /// Entities waiting for the loaded dimension whose exit area is loaded: diff --git a/crates/horizon-client/src/game/options.rs b/crates/horizon-client/src/game/options.rs index 243eced5c..73548c7a6 100644 --- a/crates/horizon-client/src/game/options.rs +++ b/crates/horizon-client/src/game/options.rs @@ -268,6 +268,11 @@ impl Game<'_> { r.animated_textures = s.horizon.animated_textures; r.set_mipmap_levels(s.mipmap_levels.max(0) as u32); r.set_world_post(s.horizon.resolution_scale as f32 / 100.0, s.horizon.fxaa); + r.set_hdr( + s.horizon.hdr, + s.horizon.hdr_paper_white as f32, + s.horizon.hdr_peak as f32, + ); } // Window.updateFullscreenIfChanged: only a changed option asks the // window to change, so applying settings never undoes a fullscreen diff --git a/crates/horizon-client/src/game/persist.rs b/crates/horizon-client/src/game/persist.rs index 45ef8801f..0c053d34e 100644 --- a/crates/horizon-client/src/game/persist.rs +++ b/crates/horizon-client/src/game/persist.rs @@ -314,6 +314,13 @@ impl Game<'_> { self.item_frames.push(f); } } + "minecraft:cushion" => { + self.next_entity += 1; + if let Some(c) = entity_nbt::cushion_from_nbt(&tag, self.next_entity) { + self.remember(c.id, uuid, tag); + self.cushions.push(c); + } + } "minecraft:painting" => { if let Some((pos, facing, variant)) = entity_nbt::painting_from_nbt(&tag) && let Some(v) = self.painting_variants.get(&variant).cloned() @@ -776,6 +783,18 @@ impl Game<'_> { out.entry(chunk_of(at)).or_default().push(tag); } } + for c in &self.cushions { + if keys.contains(&chunk_of(c.position)) { + let uuid = self + .persist + .uuids + .get(&c.id) + .copied() + .unwrap_or_else(random_uuid); + let tag = entity_nbt::cushion_to_nbt(c, uuid, self.persist.raw.get(&c.id)); + out.entry(chunk_of(c.position)).or_default().push(tag); + } + } for p in &self.paintings { let at = painting_center(p); if keys.contains(&chunk_of(at)) { @@ -868,6 +887,13 @@ impl Game<'_> { } keep }); + self.cushions.retain(|c| { + let keep = !gone(c.position); + if !keep { + removed.push(c.id); + } + keep + }); // Riders leave with their root vehicle, a boat's with the boat. let leaving: HashSet = (0..self.mobs.len()) .filter(|&i| { @@ -934,6 +960,7 @@ impl Game<'_> { .chain(self.boats.iter().map(|e| e.id)) .chain(self.carts.iter().map(|e| e.id)) .chain(self.armor_stands.iter().map(|e| e.id)) + .chain(self.cushions.iter().map(|e| e.id)) .chain(self.item_frames.iter().map(|e| e.id)) .chain(self.paintings.iter().map(|e| e.id)) .chain(self.others.iter().map(|e| e.id)) diff --git a/crates/horizon-client/src/game/potions.rs b/crates/horizon-client/src/game/potions.rs index b28c2fb4d..0b14db314 100644 --- a/crates/horizon-client/src/game/potions.rs +++ b/crates/horizon-client/src/game/potions.rs @@ -141,14 +141,22 @@ impl PotionState { t.stack = stack; } } - /// One tick of a server's client: `step` moves each toward where the - /// server put it. - pub(super) fn step_remote_thrown(&mut self, mut step: impl FnMut(u32, Vec3) -> Vec3) { - for t in &mut self.thrown { - t.previous = t.position; - t.age += 1; - t.position = step(t.id, t.position); - } + /// A server's move: thrown potions have no interpolation handler, so + /// `moveOrInterpolateTo` puts them there at once. False when `id` isn't one. + pub(super) fn move_remote_thrown(&mut self, id: u32, at: Vec3) -> bool { + let Some(t) = self.thrown.iter_mut().find(|t| t.id == id) else { + return false; + }; + t.position = at; + true + } + /// `handleSetEntityMotion` for a thrown potion. False when `id` isn't one. + pub(super) fn remote_thrown_motion(&mut self, id: u32, velocity: Vec3) -> bool { + let Some(t) = self.thrown.iter_mut().find(|t| t.id == id) else { + return false; + }; + t.velocity = velocity; + true } pub(super) fn remove_remote_thrown(&mut self, id: u32) { self.thrown.retain(|t| t.id != id); @@ -484,6 +492,7 @@ impl Game<'_> { thrown.retain_mut(|t| { t.age += 1; t.previous = t.position; + self.thrown_potion_motion(t); let next = Vec3::new( t.position.x + t.velocity.x, t.position.y + t.velocity.y, @@ -520,18 +529,6 @@ impl Game<'_> { return false; } t.position = next; - // ThrowableItemProjectile: drag 0.99 then gravity 0.05. - // ThrownExperienceBottle.getDefaultGravity is 0.07. - let gravity = if &*t.stack.item == "minecraft:experience_bottle" { - 0.07 - } else { - 0.05 - }; - t.velocity = Vec3::new( - t.velocity.x * 0.99, - t.velocity.y * 0.99 - gravity, - t.velocity.z * 0.99, - ); t.age < 1200 && t.position.y > -128.0 }); self.potions.thrown = thrown; @@ -539,6 +536,60 @@ impl Game<'_> { self.splash(&stack, at); } } + /// `ThrowableProjectile.tick`'s `applyGravity` and `applyInertia`, which + /// come before the move: gravity 0.05 (0.07 for an experience bottle), + /// then drag 0.99 (0.8 in water). + fn thrown_potion_motion(&self, t: &mut ThrownPotion) { + let gravity = if &*t.stack.item == "minecraft:experience_bottle" { + 0.07 + } else { + 0.05 + }; + let at = t.position; + let water = self + .res + .facts() + .get(self.world.block( + at.x.floor() as i32, + at.y.floor() as i32, + at.z.floor() as i32, + )) + .fluid + == horizon_client::blocks::Fluid::Water; + let inertia = if water { 0.8 } else { 0.99 }; + t.velocity = Vec3::new( + t.velocity.x * inertia, + (t.velocity.y - gravity) * inertia, + t.velocity.z * inertia, + ); + } + /// `ThrowableProjectile.tick` on a server's client: it falls and moves + /// by itself between the server's updates and stops at a block; only + /// the server breaks it. + pub(super) fn step_remote_thrown(&mut self) { + let mut thrown = std::mem::take(&mut self.potions.thrown); + for t in &mut thrown { + t.previous = t.position; + t.age += 1; + self.thrown_potion_motion(t); + let next = Vec3::new( + t.position.x + t.velocity.x, + t.position.y + t.velocity.y, + t.position.z + t.velocity.z, + ); + let state = self.world.block( + next.x.floor() as i32, + next.y.floor() as i32, + next.z.floor() as i32, + ); + if self.res.facts().get(state).full_collision { + t.velocity = Vec3::ZERO; + } else { + t.position = next; + } + } + self.potions.thrown = thrown; + } /// `ThrownItemRenderer` for thrown splash and lingering potions and /// experience bottles: the item (GROUND) facing the camera at scale 1, /// lit at the light probe (the eye, 0.85 of the 0.25 height). diff --git a/crates/horizon-client/src/game/remote.rs b/crates/horizon-client/src/game/remote.rs index bc199b24b..e121ae553 100644 --- a/crates/horizon-client/src/game/remote.rs +++ b/crates/horizon-client/src/game/remote.rs @@ -6,11 +6,12 @@ //! clicks). The player still moves with the local physics, as the vanilla //! client predicts its own movement; the server stays authoritative for //! everything else. +use super::remote_chunks::{ChunkDecoder, ChunkFormat, Next}; use super::{Dim, Game, Mining, Screen}; use horizon_client::first_person::{Hand, SwingAnimation}; use horizon_client::{ Result, - chunk::{BIOME_STRATEGY, Chunk, Light, MIN_Y, SECTIONS, Section, block_strategy}, + chunk::Chunk, containers::{BlockEntity, Furnace, FurnaceKind}, entities::{Experience, ExperienceOrb, ItemEntity}, hud::{HudBatch, rgba}, @@ -25,11 +26,7 @@ use horizon_client::{ tab_list::SPECTATOR, world::World, }; -use horizon_core::{ - geometry::Vec3, - paletted::{PalettedContainer, Strategy}, - random::RandomSource, -}; +use horizon_core::{geometry::Vec3, random::RandomSource}; use horizon_protocol::{ entity_data::{ITEM_ENTITY_ITEM, Value}, item::{Hashed, Stack}, @@ -64,9 +61,6 @@ fn menu_title(tag: &Tag) -> horizon_client::text::Text { remote_text(tag).resolve_legacy() } -/// A section's sky and block light layers from the wire. -type LightLayers = (Option>, Option>); - /// Streaming needs a generator; a server world never generates. struct NoTerrain; impl ChunkGenerator for NoTerrain { @@ -104,6 +98,14 @@ fn place_interpolated(m: &mut Mob, at: PosRot) { m.head_pitch = (at.pitch % 360.0).clamp(-90.0, 90.0); } +/// What the network thread delivered, in order: an event, or a chunk packet +/// handed to the decoder (with the format it decodes with), whose column +/// comes back from `ChunkDecoder::next`. +enum Received { + Event(Event), + Chunk(Arc), +} + pub(super) struct Remote { pub session: Session, pub brand: String, @@ -114,8 +116,11 @@ pub(super) struct Remote { status: String, pub(super) entity_id: i32, dimension: DimensionType, - biome_map: Vec, - biome_bits: u8, + /// What chunk packets decode with (the dimension's height and sky, the + /// biome registry); replaced whenever one of them changes. + pub(super) chunk_format: Arc, + /// Decodes chunk packets as they arrive, off the frame. + decoder: ChunkDecoder, view_distance: i32, sequence: i32, position_sender: horizon_client::player_sync::PositionSender, @@ -200,7 +205,7 @@ pub(super) struct Remote { chunk_center: (i32, i32), /// Received events a frame left for the next one, in order, and when /// the oldest of them first waited (`poll_remote`). - backlog: VecDeque, + backlog: VecDeque, backlog_since: Option, /// `ClientboundTransferPacket`'s target: when the connection ends the /// game connects here, the stored cookies carried over (`TransferState`). @@ -210,11 +215,12 @@ pub(super) struct Remote { /// The time a frame spends on chunk packets before it leaves the rest of /// the received events for the next frame. A batch of 25 to 60 columns /// (0.1 ms each on an M4 Pro) all in one frame was a 3 to 8 ms frame every -/// time the player crossed a chunk border at 32 chunks. +/// time the player crossed a chunk border at 32 chunks; they decode on the +/// chunk decoder's thread now, and the frame only inserts them. const CHUNK_PACKETS_PER_FRAME: Duration = Duration::from_millis(1); /// Events that have waited this long are all handled in the next frame, -/// whatever their cost: the packets after a slow machine's chunks never -/// wait more than a tick. +/// whatever inserting their columns costs, up to a column still decoding: +/// the packets after a slow machine's chunks don't wait on its frames. const BACKLOG_LIMIT: Duration = Duration::from_millis(50); /// The open menu name of a server's horse inventory, then its chest's /// columns (the packet names no `MenuType`). @@ -420,8 +426,12 @@ impl Game<'_> { status: "Connecting to the server...".into(), entity_id: 0, dimension: DimensionType::vanilla("minecraft:overworld"), - biome_map: Vec::new(), - biome_bits: 7, + chunk_format: Arc::new(ChunkFormat::new( + &DimensionType::vanilla("minecraft:overworld"), + Vec::new(), + 7, + )), + decoder: ChunkDecoder::new(), view_distance: self.settings.render_distance, sequence: 0, position_sender: Default::default(), @@ -741,25 +751,63 @@ impl Game<'_> { /// client's packet processor), in order. Chunk packets get /// `CHUNK_PACKETS_PER_FRAME`: once a frame has spent it, the events from /// the next chunk packet on wait for the next frame, unless they have - /// already waited `BACKLOG_LIMIT`. + /// already waited `BACKLOG_LIMIT`. A chunk packet still decoding holds + /// back what follows it. pub(super) fn poll_remote(&mut self) -> Result<()> { let Some(r) = self.remote.as_mut() else { return Ok(()); }; let mut events = std::mem::take(&mut r.backlog); - events.extend(r.session.poll()); + // Chunk packets start decoding now; the frame that reaches one in + // order inserts its column. + for event in r.session.poll() { + events.push_back(match event { + Event::Packet(p) if matches!(*p, C::LevelChunkWithLight(_)) => { + match r.decoder.submit(r.chunk_format.clone(), p) { + None => Received::Chunk(r.chunk_format.clone()), + Some(p) => Received::Event(Event::Packet(p)), + } + } + event => Received::Event(event), + }); + } let overdue = r .backlog_since .is_some_and(|since| since.elapsed() >= BACKLOG_LIMIT); let mut chunks = Duration::ZERO; - while let Some(event) = events.pop_front() { - let chunk = - matches!(&event, Event::Packet(p) if matches!(**p, C::LevelChunkWithLight(_))); + while let Some(item) = events.pop_front() { + let chunk = matches!(item, Received::Chunk(_)); if chunk && !overdue && chunks >= CHUNK_PACKETS_PER_FRAME { - events.push_front(event); + events.push_front(item); break; } let started = chunk.then(Instant::now); + let event = match item { + Received::Event(event) => event, + Received::Chunk(format) => { + // A column still decoding waits for the next frame, with + // what came after it, overdue or not. + let Some(next) = self.remote.as_ref().map(|r| r.decoder.next()) else { + break; + }; + let (packet, column) = match next { + Next::Ready(decoded) => decoded, + Next::Decoding => { + events.push_front(Received::Chunk(format)); + break; + } + Next::Lost => { + log::warn!("Horizon: the chunk decoder stopped; a column is missing"); + continue; + } + }; + if let C::LevelChunkWithLight(p) = *packet { + self.remote_chunk(&p, Some((&format, column))); + } + chunks += started.map_or(Duration::ZERO, |t| t.elapsed()); + continue; + } + }; match event { Event::Status(s) => { if let Some(r) = self.remote.as_mut() { @@ -791,7 +839,10 @@ impl Game<'_> { remote.brand = brand; } } - Event::Reconfigured(registries) => self.set_registries(registries), + Event::Reconfigured(registries) => { + self.boss_overlay.reset(); + self.set_registries(registries); + } // handleTransfer: "Cannot transfer to server from // singleplayer" (no ServerData), so the world just closes. Event::Transfer { host, port } => { @@ -915,8 +966,8 @@ impl Game<'_> { }) .unwrap_or_default(); if let Some(r) = self.remote.as_mut() { - r.biome_bits = ceil_log2(biomes.len()); - r.biome_map = biomes; + let bits = ceil_log2(biomes.len()); + r.chunk_format = Arc::new(ChunkFormat::new(&r.dimension, biomes, bits)); r.registries = registries; } } @@ -927,6 +978,7 @@ impl Game<'_> { }; let dimension = r.registries.dimension(spawn.dimension_type); let same = r.dimension.name == dimension.name && keep_world; + r.chunk_format = Arc::new(r.chunk_format.with_dimension(&dimension)); r.dimension = dimension; r.game_mode = spawn.game_type; r.loaded_sent = false; @@ -949,6 +1001,9 @@ impl Game<'_> { self.world.day_time, self.world.weather, ); + let old = std::mem::take(&mut self.world.chunks); + let count = old.len(); + horizon_client::chunk::free_columns(old, count); self.world = World::new(self.res.facts().air, spawn.seed); self.world.game_time = time; self.world.day_time = day; @@ -989,145 +1044,10 @@ impl Game<'_> { self.apply_settings(); } - /// LevelChunkSection data into the client's fixed -64..320 column. - fn remote_chunk(&self, p: &play::LevelChunkWithLight) -> std::result::Result { - let r = self.remote.as_ref().ok_or("no connection")?; - let sections = p - .chunk - .sections(r.dimension.sections(), 16, r.biome_bits) - .map_err(|e| e.to_string())?; - let mut chunk = Chunk::empty(p.x, p.z); - let offset = (r.dimension.min_y - MIN_Y).div_euclid(16); - // Biome table index per quart cell of the dimension's own sections. - let mut biome_cells: Vec<[u32; 64]> = Vec::with_capacity(sections.len()); - for (i, s) in sections.iter().enumerate() { - let target = offset + i as i32; - let mut cells = [0u32; 64]; - for (j, cell) in cells.iter_mut().enumerate() { - *cell = u32::from( - r.biome_map - .get(s.biomes.get(j) as usize) - .copied() - .unwrap_or(0), - ); - } - biome_cells.push(cells); - if !(0..SECTIONS as i32).contains(&target) { - continue; - } - // A global section is as wide as the server's registry: 16 bits - // from a vanilla server, wider from a Horizon host with the same - // content mods. Read it at that width, then widen it to ours. - let ours = block_strategy(); - let strategy = if ours.wire_has_palette(s.states.bits) { - ours - } else { - Strategy::blocks(s.states.bits) - }; - let palette = s.states.palette.iter().map(|&p| p as u32).collect(); - let words = s.states.data.iter().map(|&w| w as u64).collect(); - let mut blocks = PalettedContainer::from_wire(strategy, s.states.bits, palette, words) - .map_err(|e| e.to_string())?; - if strategy.global_bits != ours.global_bits { - let mut values = [0u32; 4096]; - blocks.unpack(&mut values); - // Ids past our registry (a host with mods we lack) read as air. - let limit = 1u64 << ours.global_bits; - for v in &mut values { - if u64::from(*v) >= limit { - *v = 0; - } - } - blocks = PalettedContainer::from_values(ours, &values); - } - let mut section = Section { - blocks, - biomes: PalettedContainer::from_values(BIOME_STRATEGY, &cells), - light: Light::Uniform(0xF0), - }; - section.compact(); - chunk.sections[target as usize] = Arc::new(section); - } - // Sections outside the dimension's range take its nearest biomes - // (the column's top or bottom cell layer repeated). - if !biome_cells.is_empty() { - let last = biome_cells.len() - 1; - for si in 0..SECTIONS as i32 { - let i = si - offset; - if (0..sections.len() as i32).contains(&i) { - continue; - } - let (edge, layer) = if i < 0 { (0, 0) } else { (last, 3) }; - let mut cells = [0u32; 64]; - for (j, cell) in cells.iter_mut().enumerate() { - *cell = biome_cells[edge][layer * 16 + j % 16]; - } - Arc::make_mut(&mut chunk.sections[si as usize]).biomes = - PalettedContainer::from_values(BIOME_STRATEGY, &cells); - } - } - // ClientPacketListener.applyLightData: the column keeps the light - // the server sent; nothing is relit. - let (layers, above) = self.wire_light(&p.light); - let sky = r.dimension.has_skylight; - horizon_client::light::light_from_layers(&mut chunk, &layers, above, sky); - Ok(chunk) - } - /// `ClientPacketListener.readSectionList`: the sky and block layers of a - /// light packet, by section of the client's column, and the sky light - /// above the column's top section (from the light section just above - /// it, else open sky). - fn wire_light( - &self, - light: &horizon_protocol::chunk::LightData, - ) -> (Vec, [u8; 256]) { - let mut layers: Vec = vec![(None, None); SECTIONS]; - let Some(r) = self.remote.as_ref() else { - return (layers, [0; 256]); - }; - let sky = r.dimension.has_skylight; - let mut above = [if sky { 15 } else { 0 }; 256]; - // Light section b is the dimension's section b - 1. - let first = (r.dimension.min_y - MIN_Y).div_euclid(16) - 1; - for (b, layer) in light - .layers(r.dimension.sections() + 2) - .into_iter() - .enumerate() - { - let si = first + b as i32; - if (0..SECTIONS as i32).contains(&si) { - layers[si as usize] = layer; - } else if si == SECTIONS as i32 - && sky - && let Some(l) = &layer.0 - { - for (i, a) in above.iter_mut().enumerate() { - *a = (l[i >> 1] >> ((i & 1) * 4)) & 15; - } - } - } - (layers, above) - } - /// `handleLightUpdatePacket`: the sections it names take its light. - fn remote_light_update(&mut self, p: &play::LightUpdate) { - let Some(sky) = self.remote.as_ref().map(|r| r.dimension.has_skylight) else { - return; - }; - if !self.world.chunks.contains_key(&(p.x, p.z)) { - return; - } - let (layers, _) = self.wire_light(&p.light); - let Some(chunk) = self.world.chunks.get_mut(&(p.x, p.z)) else { - return; - }; - let changed = - horizon_client::light::update_light_layers(Arc::make_mut(chunk), &layers, sky); - Streaming::light_updated(&mut self.world, p.x, p.z, &changed); - } /// `ClientChunkCache.Storage.inRange`: within the storage around the /// view centre, `calculateStorageRange` (the server's radius, at least /// two, plus three) chunks each way. - fn remote_chunk_in_range(&self, x: i32, z: i32) -> bool { + pub(super) fn remote_chunk_in_range(&self, x: i32, z: i32) -> bool { self.remote.as_ref().is_none_or(|r| { let range = r.view_distance.max(2) + 3; (x - r.chunk_center.0).abs() <= range && (z - r.chunk_center.1).abs() <= range @@ -1135,29 +1055,33 @@ impl Game<'_> { } /// The columns a moved or resized storage no longer holds. fn drop_remote_chunks_out_of_range(&mut self) { - let gone: Vec<(i32, i32)> = self + let gone: horizon_client::fast_hash::FxHashSet<(i32, i32)> = self .world .chunks .keys() .copied() .filter(|&(x, z)| !self.remote_chunk_in_range(x, z)) .collect(); - for (x, z) in gone { - self.streaming.forget(&mut self.world, x, z); - self.world - .block_entities - .retain(|k, _| (k.0 >> 4, k.2 >> 4) != (x, z)); - if let Some(renderer) = self.renderer.as_mut() { - for sy in 0..SECTIONS as i32 { - renderer.remove((x, sy, z)); - } - } + if gone.is_empty() { + return; } + let mut freed = Vec::with_capacity(gone.len()); + for &(x, z) in &gone { + freed.extend(self.streaming.forget(&mut self.world, x, z)); + } + if let Some(renderer) = self.renderer.as_mut() { + renderer.remove_columns(gone.iter().copied()); + } + horizon_client::chunk::free_columns(freed, gone.len()); + // One pass for all of them. + self.world + .block_entities + .retain(|k, _| !gone.contains(&(k.0 >> 4, k.2 >> 4))); } /// `handleBlockEntityData`: the block entity at `pos`, when it is of the /// packet's type, loads the tag (`loadWithComponents`); an empty tag /// changes nothing. - fn remote_block_entity_data(&mut self, pos: [i32; 3], kind: i32, tag: &Tag) { + pub(super) fn remote_block_entity_data(&mut self, pos: [i32; 3], kind: i32, tag: &Tag) { let key = (pos[0], pos[1], pos[2]); let Some(name) = self .remote @@ -1248,7 +1172,7 @@ impl Game<'_> { } } /// Keep the renderable block entities (chests, furnaces) in step with blocks. - fn sync_block_entity(&mut self, pos: (i32, i32, i32), state: BlockStateId) { + pub(super) fn sync_block_entity(&mut self, pos: (i32, i32, i32), state: BlockStateId) { let name = self.res.facts().get(state).name.clone(); match BlockEntity::for_block(&name) { Some(entity) => { @@ -1337,6 +1261,9 @@ impl Game<'_> { } else { self.res.mob_types().get(kind).cloned() }; + if kind == "minecraft:ender_dragon" { + self.spawn_remote_dragon(id, position, yaw); + } if kind == "minecraft:experience_orb" { // Its value (ExperienceOrb.DATA_VALUE) follows in SetEntityData. self.orbs.retain(|o| o.id != id as u32); @@ -1443,13 +1370,17 @@ impl Game<'_> { m.on_ground = on_ground; return; } - if let Some(p) = self.creatures.projectiles.iter_mut().find(|p| { - p.id == id as u32 - && matches!( - p.kind, - horizon_client::projectiles::ProjectileKind::LargeFireball { .. } - ) - }) { + // Projectiles keep Entity's NO_OP InterpolationHandler too: the + // server's position replaces theirs at once and their own tick + // flies them on (`tick_remote_projectiles`). Eased towards it + // instead, they only moved when an update came, every 10 to 20 + // ticks. + if let Some(p) = self + .creatures + .projectiles + .iter_mut() + .find(|p| p.id == id as u32) + { if path.is_some() { p.position = Vec3::new(position[0], position[1], position[2]); } @@ -1459,6 +1390,14 @@ impl Game<'_> { } return; } + if path.is_some() + && (self.potions.move_remote_thrown( + id as u32, + Vec3::new(position[0], position[1], position[2]), + ) || self.end.move_remote_eye(id as u32, position)) + { + return; + } if let Some(p) = r.pending_items.get_mut(&id) { p.0 = position; } @@ -1505,6 +1444,8 @@ impl Game<'_> { self.mobs.retain(|m| m.id != id as u32); self.orbs.retain(|o| o.id != id as u32); self.dropped.retain(|d| d.id != id as u32); + // Before the crystals go: the dragon's beam index follows them. + self.remove_remote_dragon(id); self.remove_remote_object(id as u32); self.remove_remote_projectile(id as u32); if let Some(r) = self.remote.as_mut() { @@ -1704,36 +1645,7 @@ impl Game<'_> { }) .clamp(-90.0, 90.0); } - // ClientChunkCache.replaceWithPacketData: a column outside the - // storage around the view centre is ignored. - C::LevelChunkWithLight(p) if !self.remote_chunk_in_range(p.x, p.z) => { - log::warn!( - "Ignoring chunk since it's not in the view range: {}, {}", - p.x, - p.z - ); - } - C::LevelChunkWithLight(p) => match self.remote_chunk(&p) { - Ok(chunk) => { - let (x, z) = (p.x, p.z); - self.streaming.insert_remote(&mut self.world, chunk); - self.world - .block_entities - .retain(|k, _| (k.0 >> 4, k.2 >> 4) != (x, z)); - for info in &p.chunk.block_entities { - let pos = ( - x * 16 + i32::from(info.packed_xz as u8 >> 4), - i32::from(info.y), - z * 16 + i32::from(info.packed_xz as u8 & 15), - ); - let state = self.world.block(pos.0, pos.1, pos.2); - self.sync_block_entity(pos, state); - // LevelChunk.replaceWithPacketData: the block entity loads its update tag. - self.remote_block_entity_data([pos.0, pos.1, pos.2], info.kind, &info.tag); - } - } - Err(e) => log::warn!("Horizon: chunk {} {}: {e}", p.x, p.z), - }, + C::LevelChunkWithLight(p) => self.remote_chunk(&p, None), C::LightUpdate(p) => self.remote_light_update(&p), C::ForgetLevelChunk(p) => { let [x, z] = p.pos; @@ -1742,9 +1654,7 @@ impl Game<'_> { .block_entities .retain(|k, _| (k.0 >> 4, k.2 >> 4) != (x, z)); if let Some(renderer) = self.renderer.as_mut() { - for sy in 0..SECTIONS as i32 { - renderer.remove((x, sy, z)); - } + renderer.remove_columns([(x, z)]); } } C::ChunkBatchFinished(_) => { @@ -2068,6 +1978,7 @@ impl Game<'_> { } self.remote_object_data(p.id, &p.values); self.remote_projectile_data(p.id, &p.values); + self.remote_dragon_data(p.id, &p.values); } // ClientPacketListener.handleSetEquipment: what a mob or another // player holds and wears (EquipmentSlot ordinals). @@ -2149,6 +2060,8 @@ impl Game<'_> { } else if let Some(m) = self.mobs.iter_mut().find(|m| m.id == p.id as u32) { m.limb_speed = 1.5; m.hurt_time = 10; + } else { + self.remote_dragon_hurt(p.id); } } C::HurtAnimation(p) => { @@ -2158,9 +2071,14 @@ impl Game<'_> { } } else if let Some(m) = self.mobs.iter_mut().find(|m| m.id == p.id as u32) { m.hurt_time = 10; + } else { + self.remote_dragon_hurt(p.id); } } C::EntityEvent(p) => { + if p.event == super::fireworks::FIREWORK_EXPLODE_EVENT { + self.remote_firework_explosion(p.id); + } // LocalPlayer.setPermissions also refreshes an open World Options screen. if (24..=28).contains(&p.event) && self.remote.as_ref().is_some_and(|r| r.entity_id == p.id) @@ -2234,6 +2152,7 @@ impl Game<'_> { self.apply_remote_health(); if p.health <= 0.0 && self.screen != Screen::Dead && self.player.is_some() { self.screen = Screen::Dead; + self.ui.death_time = 0; self.capture(false); } } @@ -2250,6 +2169,7 @@ impl Game<'_> { // screen, whatever health was last sent. if me && self.screen != Screen::Dead && self.player.is_some() { self.screen = Screen::Dead; + self.ui.death_time = 0; self.capture(false); } } @@ -3044,6 +2964,7 @@ impl Game<'_> { /// entities whose own tick moves them on a client: dropped items, falling /// blocks and primed TNT. fn remote_motion(&mut self, id: i32, velocity: [f64; 3]) { + self.remote_dragon_motion(id, velocity); let v = Vec3::new(velocity[0], velocity[1], velocity[2]); if let Some(d) = self.dropped.iter_mut().find(|d| d.id == id as u32) { d.velocity = v; @@ -3064,6 +2985,8 @@ impl Game<'_> { .and_then(|r| r.pending_items.get_mut(&id)) { p.1 = v; + } else if !self.potions.remote_thrown_motion(id as u32, v) { + self.end.remote_eye_motion(id as u32, velocity); } } fn apply_remote_health(&mut self) { @@ -3170,6 +3093,12 @@ impl Game<'_> { fn tick_remote_level(&mut self) -> Result<()> { self.ticks += 1; self.track_experience_display(); + // Player.tick's ItemCooldowns.tick: this path replaces `tick_world`'s + // for a server's client (multiplayer and the default single player), + // so the entries advance here or the slot stays shaded until the + // server says the entry ended. `onCooldownEnded` is the plain + // ItemCooldowns' no-op on a client. + self.cooldowns.tick(); // Options.broadcastOptions: a changed render distance or Chat option // is sent again. let view = client_view_distance(self.settings.render_distance); @@ -3288,6 +3217,11 @@ impl Game<'_> { ); let was_flying = player.flying; self.sync_player_body(); + // LivingEntity.tickDeath: the local player counts its deathTime once + // per client tick while dead (the camera's death roll and zoom). + if self.screen == Screen::Dead { + self.ui.death_time = self.ui.death_time.saturating_add(1); + } let Some(player) = self.player.as_mut() else { return Ok(()); }; @@ -3528,6 +3462,13 @@ impl Game<'_> { if m.species() == horizon_client::mobs::Species::Creeper { horizon_client::mobs::hostile::creeper_client_tick(m); } + if matches!( + m.species(), + horizon_client::mobs::Species::Guardian + | horizon_client::mobs::Species::ElderGuardian + ) { + horizon_client::mobs::guardian::client_tick(m); + } if m.hurt_time > 0 { m.hurt_time -= 1; } @@ -3595,6 +3536,9 @@ impl Game<'_> { if m.species() == horizon_client::mobs::Species::Rabbit { horizon_client::mobs::rabbit::post_tick(m); } + if m.species() == horizon_client::mobs::Species::Bat { + horizon_client::mobs::bat::setup_animation_states(m); + } } for o in self.orbs.iter_mut().filter(|_| running) { o.previous = o.position; @@ -3616,13 +3560,25 @@ impl Game<'_> { // ticks), and only the server removes it. let (world, facts, collision) = (&self.world, self.res.facts(), self.collision); for d in self.dropped.iter_mut().filter(|_| running) { - d.tick(world, facts, collision, false); + d.tick(world, facts, collision, false, &self.res.motion().fluids); } head_lerps.retain(|_, (_, steps)| *steps > 0); for (item, ticks, at, eye, pitch, yaw) in using { self.remote_player_eating(&item, ticks, at, eye, pitch, yaw); } if running { + // The dragon: LivingEntity's interpolation, inside its aiStep. + let dragon_lerp = self + .dragon + .as_ref() + .and_then(|d| lerps.get_mut(&(d.id as i32))) + .filter(|l| l.steps > 0) + .map(|l| { + let steps = l.steps; + l.steps -= 1; + (l.target, l.rotation.map(|r| r.0), steps) + }); + self.tick_remote_dragon(dragon_lerp); // Boats, minecarts, armor stands, projectiles and the rest // interpolate like mobs. let mut step = |id: u32, at: Vec3| match lerps.get_mut(&(id as i32)) { @@ -3924,19 +3880,25 @@ impl Game<'_> { .and_modify(|p| p.0 = sequence) .or_insert((sequence, state.0 as i32)); } - let s = self.res.facts().get(state).sounds.clone(); - let at = [ - f64::from(pos[0]) + 0.5, - f64::from(pos[1]) + 0.5, - f64::from(pos[2]) + 0.5, - ]; - self.audio.play( - &s.break_sound, - Some(at), - (s.volume + 1.0) / 2.0, - s.pitch * 0.8, - ); - self.destroy_particles(pos, state); + // Block.playerWillDestroy's destroy event (particles and the break + // sound), which BaseFireBlock skips: the server's extinguish sound + // is all a player hears. + let facts = self.res.facts().get(state); + if !facts.has_class("BaseFireBlock") { + let s = facts.sounds.clone(); + let at = [ + f64::from(pos[0]) + 0.5, + f64::from(pos[1]) + 0.5, + f64::from(pos[2]) + 0.5, + ]; + self.audio.play( + &s.break_sound, + Some(at), + (s.volume + 1.0) / 2.0, + s.pitch * 0.8, + ); + self.destroy_particles(pos, state); + } // The server's block update follows (waterlogged blocks leave water). let air = self.world.air; if self.world.set(pos[0], pos[1], pos[2], air).is_ok() { @@ -4066,6 +4028,10 @@ impl Game<'_> { if let Some(placed) = &placed { self.predict_place(placed, seq); self.with_hand(hand, Game::consume_held); + } else if let Some(r) = self.remote.as_mut() { + // BlockItem.place plays its sound only once the block is set: the + // server's resend of the target it refused is no placement. + r.placing = None; } if reacts || placed.is_some() { self.with_hand(hand, Game::swing_arm); @@ -4606,6 +4572,7 @@ impl Game<'_> { } KeyCode::KeyE => { // The inventory opens without telling the server. + self.recipe_ui.reset_screen(); self.screen = if self.creative { Screen::Creative } else { @@ -4872,6 +4839,7 @@ impl Game<'_> { self.remote_close_local(); } fn remote_close_local(&mut self) { + self.recipe_ui.reset_screen(); if let Some(r) = self.remote.as_mut() { r.menu = None; r.menu_title = None; @@ -4907,16 +4875,20 @@ impl Game<'_> { if self.open_menu_name(p.container) != "minecraft:merchant" { return; } - let cost = |g: &Self, c: &play::NetCost| horizon_client::merchant::ItemCost { - stack: ItemStack::new(&g.item_name(c.item), c.count.max(0) as u32), + let cost = |g: &Self, c: &play::NetCost| { + g.to_stack(&Some(c.clone().into())) + .map(|stack| horizon_client::merchant::ItemCost { stack }) }; let offers: Vec<_> = p .offers .iter() .filter_map(|o| { let mut offer = horizon_client::merchant::MerchantOffer { - base_cost_a: cost(self, &o.cost_a), - cost_b: o.cost_b.as_ref().map(|b| cost(self, b)), + base_cost_a: cost(self, &o.cost_a)?, + cost_b: match &o.cost_b { + Some(b) => Some(cost(self, b)?), + None => None, + }, result: self.to_stack(&Some(o.result.clone()))?, uses: o.uses, max_uses: o.max_uses, @@ -4942,6 +4914,9 @@ impl Game<'_> { } /// ClientboundOpenScreenPacket for the menus Horizon draws. fn remote_open_screen(&mut self, p: play::OpenScreen) { + // A new RecipeBookComponent owns fresh ghost slots and an overlay, + // even when the server replaces a menu without a close packet. + self.recipe_ui.reset_screen(); let menu = self .remote .as_ref() diff --git a/crates/horizon-client/src/game/remote_chunks.rs b/crates/horizon-client/src/game/remote_chunks.rs new file mode 100644 index 000000000..47f474619 --- /dev/null +++ b/crates/horizon-client/src/game/remote_chunks.rs @@ -0,0 +1,355 @@ +//! A server's chunk columns (`ClientboundLevelChunkWithLightPacket`): the +//! sections and light of each packet become a client column on a decoder +//! thread as soon as the packet arrives, so the frame that handles it in +//! order only inserts the result (`ClientPacketListener.handleLevelChunkWithLight`). +use super::Game; +use horizon_client::{ + chunk::{BIOME_STRATEGY, Chunk, Light, MIN_Y, SECTIONS, Section, block_strategy}, + streaming::Streaming, +}; +use horizon_core::paletted::{PalettedContainer, Strategy}; +use horizon_protocol::{ + chunk::{LightData, SectionLight}, + packets::play::{self, Clientbound as C}, + registry::DimensionType, +}; +use std::sync::{ + Arc, + mpsc::{self, TryRecvError}, +}; + +/// What turning a chunk packet into a client column depends on: the +/// dimension's height and sky, and the server's biome registry mapped to +/// ours. The connection replaces it when either changes, so a column decoded +/// with an older one is decoded again. +#[derive(Default)] +pub(super) struct ChunkFormat { + min_y: i32, + sections: usize, + has_skylight: bool, + biome_map: Vec, + biome_bits: u8, +} + +impl ChunkFormat { + pub(super) fn new(dimension: &DimensionType, biome_map: Vec, biome_bits: u8) -> Self { + Self { + min_y: dimension.min_y, + sections: dimension.sections(), + has_skylight: dimension.has_skylight, + biome_map, + biome_bits, + } + } + pub(super) fn with_dimension(&self, dimension: &DimensionType) -> Self { + Self::new(dimension, self.biome_map.clone(), self.biome_bits) + } + + /// LevelChunkSection data into the client's fixed -64..320 column. + fn column(&self, p: &play::LevelChunkWithLight) -> Result { + let sections = p + .chunk + .sections(self.sections, 16, self.biome_bits) + .map_err(|e| e.to_string())?; + let mut chunk = Chunk::empty(p.x, p.z); + let offset = (self.min_y - MIN_Y).div_euclid(16); + // Biome table index per quart cell of the dimension's own sections. + let mut biome_cells: Vec<[u32; 64]> = Vec::with_capacity(sections.len()); + for (i, s) in sections.iter().enumerate() { + let target = offset + i as i32; + let mut cells = [0u32; 64]; + for (j, cell) in cells.iter_mut().enumerate() { + *cell = u32::from( + self.biome_map + .get(s.biomes.get(j) as usize) + .copied() + .unwrap_or(0), + ); + } + biome_cells.push(cells); + if !(0..SECTIONS as i32).contains(&target) { + continue; + } + // A global section is as wide as the server's registry: 16 bits + // from a vanilla server, wider from a Horizon host with the same + // content mods. Read it at that width, then widen it to ours. + let ours = block_strategy(); + let strategy = if ours.wire_has_palette(s.states.bits) { + ours + } else { + Strategy::blocks(s.states.bits) + }; + let palette = s.states.palette.iter().map(|&p| p as u32).collect(); + let words = s.states.data.iter().map(|&w| w as u64).collect(); + let mut blocks = PalettedContainer::from_wire(strategy, s.states.bits, palette, words) + .map_err(|e| e.to_string())?; + if strategy.global_bits != ours.global_bits { + let mut values = [0u32; 4096]; + blocks.unpack(&mut values); + // Ids past our registry (a host with mods we lack) read as air. + let limit = 1u64 << ours.global_bits; + for v in &mut values { + if u64::from(*v) >= limit { + *v = 0; + } + } + blocks = PalettedContainer::from_values(ours, &values); + } + let mut section = Section { + blocks, + biomes: PalettedContainer::from_values(BIOME_STRATEGY, &cells), + light: Light::Uniform(0xF0), + }; + section.compact(); + chunk.sections[target as usize] = Arc::new(section); + } + // Sections outside the dimension's range take its nearest biomes + // (the column's top or bottom cell layer repeated). + if !biome_cells.is_empty() { + let last = biome_cells.len() - 1; + for si in 0..SECTIONS as i32 { + let i = si - offset; + if (0..sections.len() as i32).contains(&i) { + continue; + } + let (edge, layer) = if i < 0 { (0, 0) } else { (last, 3) }; + let mut cells = [0u32; 64]; + for (j, cell) in cells.iter_mut().enumerate() { + *cell = biome_cells[edge][layer * 16 + j % 16]; + } + Arc::make_mut(&mut chunk.sections[si as usize]).biomes = + PalettedContainer::from_values(BIOME_STRATEGY, &cells); + } + } + // ClientPacketListener.applyLightData: the column keeps the light + // the server sent; nothing is relit. + let (layers, above) = self.light(&p.light); + horizon_client::light::light_from_layers(&mut chunk, &layers, above, self.has_skylight); + Ok(chunk) + } + + /// `ClientPacketListener.readSectionList`: the sky and block layers of a + /// light packet, by section of the client's column, and the sky light + /// above the column's top section (from the light section just above + /// it, else open sky). + pub(super) fn light(&self, light: &LightData) -> (Vec, [u8; 256]) { + let mut layers: Vec = vec![(None, None); SECTIONS]; + let sky = self.has_skylight; + let mut above = [if sky { 15 } else { 0 }; 256]; + // Light section b is the dimension's section b - 1. + let first = (self.min_y - MIN_Y).div_euclid(16) - 1; + for (b, layer) in light.layers(self.sections + 2).into_iter().enumerate() { + let si = first + b as i32; + if (0..SECTIONS as i32).contains(&si) { + layers[si as usize] = layer; + } else if si == SECTIONS as i32 + && sky + && let Some(l) = &layer.0 + { + for (i, a) in above.iter_mut().enumerate() { + *a = (l[i >> 1] >> ((i & 1) * 4)) & 15; + } + } + } + (layers, above) + } +} + +type Decoded = (Box, Result); + +/// One thread that decodes chunk packets in the order they arrived; its +/// results come back in that order, one per `submit`. +pub(super) struct ChunkDecoder { + jobs: mpsc::Sender<(Arc, Box)>, + done: mpsc::Receiver, +} + +impl ChunkDecoder { + pub(super) fn new() -> Self { + let (jobs, todo) = mpsc::channel::<(Arc, Box)>(); + let (finished, done) = mpsc::channel(); + // The thread ends with the connection, when `jobs` is dropped. + let spawned = std::thread::Builder::new() + .name("Chunk decoder".into()) + .spawn(move || { + // A frame waits for its columns, as it would for the render + // thread's own work. + horizon_threads::favour_current(); + for (format, packet) in todo { + let column = match &*packet { + C::LevelChunkWithLight(p) => format.column(p), + _ => Err("not a chunk packet".into()), + }; + if finished.send((packet, column)).is_err() { + break; + } + } + }); + if let Err(e) = spawned { + log::warn!("Horizon: no chunk decoder thread ({e}); chunks decode in the frame"); + } + Self { jobs, done } + } + + /// Start decoding a chunk packet with the format it arrived under. + /// Without a decoder thread the packet comes back undecoded. + pub(super) fn submit(&self, format: Arc, packet: Box) -> Option> { + self.jobs.send((format, packet)).err().map(|e| (e.0).1) + } + + /// The oldest submitted packet and its column, unless it is still + /// decoding: a frame never waits for the decoder. + pub(super) fn next(&self) -> Next { + match self.done.try_recv() { + Ok(decoded) => Next::Ready(decoded), + Err(TryRecvError::Empty) => Next::Decoding, + // The decoder thread panicked: its columns are gone. + Err(TryRecvError::Disconnected) => Next::Lost, + } + } +} + +pub(super) enum Next { + Ready(Decoded), + Decoding, + Lost, +} + +impl Game<'_> { + /// `handleLevelChunkWithLight`: the column replaces any loaded one, and + /// its block entities load their update tags. `decoded` is the column the + /// decoder made with `format`; another format since means decode again. + pub(super) fn remote_chunk( + &mut self, + p: &play::LevelChunkWithLight, + decoded: Option<(&Arc, Result)>, + ) { + // ClientChunkCache.replaceWithPacketData: a column outside the + // storage around the view centre is ignored. + if !self.remote_chunk_in_range(p.x, p.z) { + log::warn!( + "Ignoring chunk since it's not in the view range: {}, {}", + p.x, + p.z + ); + return; + } + let Some(format) = self.remote.as_ref().map(|r| r.chunk_format.clone()) else { + return; + }; + let column = match decoded { + Some((used, column)) if Arc::ptr_eq(used, &format) => column, + _ => format.column(p), + }; + let chunk = match column { + Ok(chunk) => chunk, + Err(e) => { + log::warn!("Horizon: chunk {} {}: {e}", p.x, p.z); + return; + } + }; + let (x, z) = (p.x, p.z); + self.streaming.insert_remote(&mut self.world, chunk); + self.world + .block_entities + .retain(|k, _| (k.0 >> 4, k.2 >> 4) != (x, z)); + for info in &p.chunk.block_entities { + let pos = ( + x * 16 + i32::from(info.packed_xz as u8 >> 4), + i32::from(info.y), + z * 16 + i32::from(info.packed_xz as u8 & 15), + ); + let state = self.world.block(pos.0, pos.1, pos.2); + self.sync_block_entity(pos, state); + // LevelChunk.replaceWithPacketData: the block entity loads its update tag. + self.remote_block_entity_data([pos.0, pos.1, pos.2], info.kind, &info.tag); + } + } + + /// `handleLightUpdatePacket`: the sections it names take its light. + pub(super) fn remote_light_update(&mut self, p: &play::LightUpdate) { + let Some(format) = self.remote.as_ref().map(|r| r.chunk_format.clone()) else { + return; + }; + if !self.world.chunks.contains_key(&(p.x, p.z)) { + return; + } + let (layers, _) = format.light(&p.light); + let Some(chunk) = self.world.chunks.get_mut(&(p.x, p.z)) else { + return; + }; + let changed = horizon_client::light::update_light_layers( + Arc::make_mut(chunk), + &layers, + format.has_skylight, + ); + Streaming::light_updated(&mut self.world, p.x, p.z, &changed); + } +} + +#[cfg(test)] +mod tests { + use super::*; + use horizon_protocol::chunk::{ChunkData, Paletted, Section as Wire, Strategy as Wiring}; + + /// A column of `state` with biome 1 everywhere, unlit. + fn packet(x: i32, state: i32) -> Box { + let section = Wire { + non_empty: 4096, + fluids: 0, + states: Paletted::from_values(&[state; 4096], Wiring::Blocks, 16), + biomes: Paletted::from_values(&[1; 64], Wiring::Biomes, 2), + }; + let none = LightData { + sky_mask: Vec::new(), + block_mask: Vec::new(), + empty_sky_mask: Vec::new(), + empty_block_mask: Vec::new(), + sky: Vec::new(), + block: Vec::new(), + }; + Box::new(C::LevelChunkWithLight(play::LevelChunkWithLight { + x, + z: -3, + chunk: ChunkData { + heightmaps: Vec::new(), + buffer: ChunkData::from_sections(&vec![section; 24]), + block_entities: Vec::new(), + }, + light: none, + })) + } + + /// Columns come back one per packet, in the order the packets went in, + /// as the frame would have decoded them itself. + #[test] + fn the_decoder_returns_columns_in_order() { + let overworld = DimensionType::vanilla("minecraft:overworld"); + let format = Arc::new(ChunkFormat::new(&overworld, vec![0, 7, 9], 2)); + let decoder = ChunkDecoder::new(); + for x in 0..20 { + assert!(decoder.submit(format.clone(), packet(x, 1 + x)).is_none()); + } + for x in 0..20 { + let (packet, column) = loop { + match decoder.next() { + Next::Ready(decoded) => break decoded, + Next::Decoding => std::thread::yield_now(), + Next::Lost => panic!("the decoder stopped"), + } + }; + let C::LevelChunkWithLight(p) = *packet else { + panic!("not a chunk packet"); + }; + let (column, direct) = (column.unwrap(), format.column(&p).unwrap()); + assert_eq!((column.x, column.z), (x, -3)); + for (cx, y, cz) in [(0, -64, 0), (5, 70, 9), (15, 319, 15)] { + assert_eq!(column.get(cx, y, cz), 1 + x as u32); + assert_eq!(column.get(cx, y, cz), direct.get(cx, y, cz)); + // Wire biome 1 is our biome 7. + assert_eq!(column.biome(cx, y, cz), 7); + } + } + assert!(matches!(decoder.next(), Next::Decoding)); + } +} diff --git a/crates/horizon-client/src/game/remote_mob_data.rs b/crates/horizon-client/src/game/remote_mob_data.rs index fbfc5a4fb..c6702dfb6 100644 --- a/crates/horizon-client/src/game/remote_mob_data.rs +++ b/crates/horizon-client/src/game/remote_mob_data.rs @@ -4,14 +4,14 @@ //! own simulation, which a client of a server doesn't run. use super::Game; use horizon_client::mobs::render::{PROFESSIONS, VILLAGER_TYPES}; -use horizon_client::mobs::{Mob, Species, tame}; +use horizon_client::mobs::{Mob, Species, Who, bat, tame}; use horizon_protocol::entity_data::Value; use horizon_protocol::registry::Builtin; /// The values `apply` takes from one SetEntityData packet, by vanilla's entry /// indices (Entity 0..=7, LivingEntity 8..=14, Mob 15, then the subclasses). /// `builtin` names the ids of built-in registries. -fn apply(m: &mut Mob, values: &[(u8, i32, Value)], builtin: &Builtin) { +fn apply(m: &mut Mob, values: &[(u8, i32, Value)], builtin: &Builtin, local_entity: i32) { let species = m.species(); let baby = super::lan::baby_index(&m.kind.id); for (index, _, value) in values { @@ -46,6 +46,21 @@ fn apply(m: &mut Mob, values: &[(u8, i32, Value)], builtin: &Builtin) { _ => {} } match (species, *index, value) { + (Species::Guardian | Species::ElderGuardian, 16, Value::Bool(moving)) => { + m.extra.flag2 = *moving; + } + (Species::Guardian | Species::ElderGuardian, 17, Value::Int(target)) => { + // Guardian.onSyncedDataUpdated resets the visual charge clock. + m.extra.counter2 = 0; + m.extra.flag = *target != 0; + m.ai.target = (*target != 0).then_some(if *target == local_entity { + Who::Player + } else { + Who::Mob(*target as u32) + }); + } + // Bat.DATA_ID_FLAGS: resting in bit 0. + (Species::Bat, 16, Value::Byte(flags)) => bat::set_resting(m, flags & 1 != 0), // Sheep.DATA_WOOL_ID: the colour in the low nibble, 16 sheared. (Species::Sheep, 18, Value::Byte(wool)) => { m.extra.color = (*wool & 15) as u8; @@ -114,7 +129,7 @@ impl Game<'_> { return; }; if let Some(m) = self.mobs.iter_mut().find(|m| m.id == id as u32) { - apply(m, values, &r.builtin); + apply(m, values, &r.builtin, r.entity_id); } } } @@ -126,6 +141,10 @@ pub(super) fn client_defaults(m: &mut Mob) { if matches!(m.species(), Species::Wolf | Species::Cat) { m.extra.color = tame::RED; } + if m.species() == Species::Bat { + // Bat's constructor sets resting only on the server; the data default is 0. + bat::set_resting(m, false); + } } #[cfg(test)] @@ -147,7 +166,7 @@ mod tests { } fn apply(m: &mut Mob, values: &[(u8, i32, Value)]) { - super::apply(m, values, &builtin()); + super::apply(m, values, &builtin(), 99); } fn mob(kind: &str) -> Option { @@ -158,6 +177,49 @@ mod tests { Some(m) } + #[test] + fn guardian_charge_follows_target_updates_and_caps_at_its_duration() { + use horizon_client::mobs::guardian::{beam, client_tick}; + for (kind, duration) in [("guardian", 80), ("elder_guardian", 60)] { + let Some(mut m) = mob(&format!("minecraft:{kind}")) else { + return; + }; + assert!(beam(&m, 0.0).is_none()); + apply( + &mut m, + &[ + (16, s::BOOLEAN, Value::Bool(true)), + (17, s::INT, Value::Int(99)), + ], + ); + assert!(m.extra.flag2); + assert_eq!(m.ai.target, Some(Who::Player)); + assert_eq!(beam(&m, 0.0), Some((0.0, 0.0))); + for _ in 0..duration + 10 { + client_tick(&mut m); + } + assert_eq!(beam(&m, 0.0), Some((duration as f32, 1.0))); + // Another player or a mob retains its network entity id. + apply(&mut m, &[(17, s::INT, Value::Int(42))]); + assert_eq!(m.ai.target, Some(Who::Mob(42))); + assert_eq!(m.extra.counter2, 0); + client_tick(&mut m); + assert_eq!(m.extra.counter2, 1); + apply( + &mut m, + &[ + (16, s::BOOLEAN, Value::Bool(false)), + (17, s::INT, Value::Int(0)), + ], + ); + client_tick(&mut m); + assert!(!m.extra.flag2); + assert_eq!(m.ai.target, None); + assert_eq!(m.extra.counter2, 0); + assert!(beam(&m, 0.0).is_none()); + } + } + #[test] fn a_sheep_takes_its_wool_and_a_calf_its_size() { let Some(mut m) = mob("minecraft:sheep") else { @@ -174,6 +236,69 @@ mod tests { assert!(!calf.is_baby()); } + #[test] + fn bat_flags_select_continuous_client_clocks_without_changing_motion() { + use horizon_client::mobs::{MobTypes, anim, keyframes::Animation}; + use horizon_core::geometry::Vec3; + use serde_json::json; + use std::{collections::HashMap, fs, sync::Arc}; + + // Original minimal resources keep this regression runnable without vanilla data. + let root = + std::env::temp_dir().join(format!("horizon-bat-animation-{}", std::process::id())); + fs::create_dir(&root).unwrap(); + fs::write(root.join("entity-types.json"), r#"{"minecraft:bat": {}}"#).unwrap(); + fs::write( + root.join("entity-models.json"), + r#"{"minecraft:bat#main": {"children": {"right_wing": {}, "head": {}}}}"#, + ) + .unwrap(); + let mut types = MobTypes::load(&root).unwrap(); + fs::remove_dir_all(root).unwrap(); + let position = Vec3::new(1.0, 2.25, 3.0); + let velocity = Vec3::new(0.2, 0.3, 0.4); + let mut m = Mob::new( + 1, + Arc::new(types.types.remove("minecraft:bat").unwrap()), + position, + 0.0, + ); + assert!(bat::resting(&m)); + client_defaults(&mut m); + assert!(!bat::resting(&m)); + m.velocity = velocity; + m.age = 1; + bat::setup_animation_states(&mut m); + m.age = 4; + apply(&mut m, &[(16, s::BYTE, Value::Byte(2))]); + bat::setup_animation_states(&mut m); + assert_eq!(m.anim.states[0].started, Some(1.0)); + + let curve = Animation::parse(&json!({"length": 1, "looping": true, + "bones": {"right_wing": [{"target": "rotation", "keyframes": + [[0,[0,0,0],[0,0,0],"linear"],[1,[0,1,0],[0,1,0],"linear"]]}]}})); + let animations = HashMap::from([("BatAnimation.BAT_FLYING".into(), curve)]); + let wing = |partial| { + let mut poses = anim::Poses::new(&m.kind.model); + anim::setup(&m, &anim::state(&m, partial), &mut poses, &animations); + poses.get("right_wing")[4] + }; + assert!(wing(0.5) > wing(0.0)); + + m.age = 5; + apply(&mut m, &[(16, s::BYTE, Value::Byte(3))]); + bat::setup_animation_states(&mut m); + assert!(bat::resting(&m)); + assert_eq!(m.anim.states[0].started, None); + assert_eq!(m.anim.states[1].started, Some(5.0)); + m.age = 7; + apply(&mut m, &[(16, s::BYTE, Value::Byte(0))]); + bat::setup_animation_states(&mut m); + assert_eq!(m.anim.states[0].started, Some(7.0)); + assert_eq!(m.anim.states[1].started, None); + assert_eq!((m.position, m.velocity), (position, velocity)); + } + #[test] fn a_wolf_takes_its_owner_flags_and_collar() { let Some(mut m) = mob("minecraft:wolf") else { diff --git a/crates/horizon-client/src/game/remote_objects.rs b/crates/horizon-client/src/game/remote_objects.rs index 251d277f3..05b1a2b9e 100644 --- a/crates/horizon-client/src/game/remote_objects.rs +++ b/crates/horizon-client/src/game/remote_objects.rs @@ -3,7 +3,7 @@ //! `handleSetEquipment`): the server simulates them, the client places them //! where it says and interpolates their moves like a mob's. use super::Game; -use horizon_client::entities::{ArmorStand, ItemFrame, Painting}; +use horizon_client::entities::{ArmorStand, Cushion, ItemFrame, Painting}; use horizon_core::geometry::Vec3; use horizon_protocol::entity_data::Value; use std::sync::Arc; @@ -57,6 +57,16 @@ impl Game<'_> { invisible: false, check_interval: 0, }); + } else if kind == "minecraft:cushion" { + // BlockAttachedEntity.pos: `BlockPos.containing` of the spawn. + self.cushions.push(Cushion { + id, + position: at, + pos: block, + yaw: super::cushions::snap_yaw(yaw), + color: 0, + check_interval: 0, + }); } else if kind == "minecraft:lightning_bolt" { self.spawn_remote_bolt(id, position); } else if kind == "minecraft:painting" { @@ -152,6 +162,11 @@ impl Game<'_> { } _ => {} } + } else if let Some(c) = self.cushions.iter_mut().find(|c| c.id == id) { + // Cushion.DATA_COLOR (DyeColor, a byte-backed id). + if let (8, Value::Id(color)) = (index, value) { + c.color = (*color).clamp(0, 15) as u8; + } } else if let Some(b) = self.boats.iter_mut().find(|b| b.id == id) { // VehicleEntity's hurt, direction and damage; the paddles. match (index, value) { @@ -267,6 +282,12 @@ impl Game<'_> { out.push(json!({"id": a.id, "kind": "minecraft:armor_stand", "position": at(a.position), "yaw": a.yaw, "small": a.small, "arms": a.show_arms, "no_base_plate": a.no_base_plate, "equipment": items})); } + for c in &self.cushions { + out.push( + json!({"id": c.id, "kind": "minecraft:cushion", "position": at(c.position), + "yaw": c.yaw, "color": c.color_name()}), + ); + } for f in &self.item_frames { out.push( json!({"id": f.id, "kind": f.kind(), "position": f.pos, "facing": f.facing, @@ -286,6 +307,7 @@ impl Game<'_> { self.carts.clear(); self.boats.clear(); self.armor_stands.clear(); + self.cushions.clear(); self.item_frames.clear(); self.paintings.clear(); } @@ -295,6 +317,7 @@ impl Game<'_> { self.carts.retain(|c| c.id != id); self.boats.retain(|b| b.id != id); self.armor_stands.retain(|a| a.id != id); + self.cushions.retain(|c| c.id != id); self.item_frames.retain(|f| f.id != id); self.paintings.retain(|p| p.id != id); self.bolts.retain(|b| b.id != id); diff --git a/crates/horizon-client/src/game/remote_projectiles.rs b/crates/horizon-client/src/game/remote_projectiles.rs index 2ba4510ea..ac0413cc6 100644 --- a/crates/horizon-client/src/game/remote_projectiles.rs +++ b/crates/horizon-client/src/game/remote_projectiles.rs @@ -3,7 +3,7 @@ //! and `handleSetEntityData`): the server simulates them, the client draws //! them where it says and interpolates their moves. use super::{FallStep, FallingBlock, Game, fireworks::fireworks_of, view_vector}; -use horizon_client::projectiles::{Projectile, ProjectileKind}; +use horizon_client::projectiles::{Hit, Projectile, ProjectileKind, ProjectileWorld}; use horizon_core::{geometry::Vec3, position::BlockPos}; use horizon_protocol::entity_data::Value; use horizon_world::registry::BlockStateId; @@ -37,6 +37,32 @@ fn projectile_kind(kind: &str) -> Option { }) } +/// `AbstractArrow.tick` on a client: water drag before the move, air drag +/// after it, then gravity; a block it reaches holds it (`inGround`). +fn remote_arrow_tick(p: &mut Projectile, w: &impl ProjectileWorld) { + p.previous = p.position; + p.age += 1; + if p.stuck { + return; + } + let water = w.in_water(p.position); + if water { + p.velocity = p.velocity.scale(0.6); + } + let to = p.position.add_vector(p.velocity); + if let Some((at, _, _)) = w.clip(p.position, to) { + p.position = at; + p.velocity = Vec3::ZERO; + p.stuck = true; + return; + } + p.position = to; + if !water { + p.velocity = p.velocity.scale(0.99); + } + p.velocity.y -= 0.05; +} + impl Game<'_> { /// `handleAddEntity` for these types; false when `kind` isn't one. pub(super) fn spawn_remote_projectile( @@ -246,29 +272,34 @@ impl Game<'_> { } } self.falling = falling; - for p in &mut self.creatures.projectiles { - p.previous = p.position; - p.age += 1; - if matches!(p.kind, ProjectileKind::LargeFireball { .. }) { - // AbstractHurtingProjectile.tick advances on the client between - // the tracker updates (ten ticks apart for a ghast's fireball). - let at = p.position; - let water = self - .res - .facts() - .get(self.world.block( - at.x.floor() as i32, - at.y.floor() as i32, - at.z.floor() as i32, - )) - .fluid - == horizon_client::blocks::Fluid::Water; - p.apply_hurting_inertia(water); - p.position = p.position.add_vector(p.velocity); - } else { - p.position = step(p.id, p.position); + // Projectiles tick on the client too and fly on between the tracker's + // updates (10 to 20 ticks apart); a block stops them there, and only + // the server decides what they hit. + let mut projectiles = std::mem::take(&mut self.creatures.projectiles); + { + let w = self.mob_world_base(&[]); + let world = super::creatures::ProjWorld { + w: &w, + targets: Vec::new(), + }; + for p in &mut projectiles { + match p.kind { + ProjectileKind::Arrow { .. } => remote_arrow_tick(p, &world), + // ShulkerBullet.tick: only the server steers it. + ProjectileKind::ShulkerBullet { .. } => { + p.previous = p.position; + p.age += 1; + p.position = p.position.add_vector(p.velocity); + } + _ => { + if !matches!(p.tick(&world).1, Hit::None) { + p.velocity = Vec3::ZERO; + } + } + } } } + self.creatures.projectiles = projectiles; for t in &mut self.tridents { let id = t.id; t.remote_step(|at| step(id, at)); @@ -302,12 +333,9 @@ impl Game<'_> { c.time += 1; c.position = step(c.id, c.position); } - self.potions.step_remote_thrown(&mut step); + self.step_remote_thrown(); self.step_remote_hooks(&mut step); - self.end.step_remote_eyes(|id, at| { - let at = step(id, Vec3::new(at[0], at[1], at[2])); - [at.x, at.y, at.z] - }); + self.end.step_remote_eyes(); } pub(super) fn remove_remote_projectile(&mut self, id: u32) { @@ -330,6 +358,8 @@ impl Game<'_> { self.tridents.clear(); self.rockets.clear(); self.crystals.clear(); + // The dragon a server sent goes with its crystals. + self.dragon = None; self.potions.clear_thrown(); self.end.clear_remote_eyes(); self.clear_remote_hooks(); @@ -353,7 +383,8 @@ impl Game<'_> { out.push(json!({"id": t.id, "kind": "minecraft:trident", "position": at(t.position)})); } for p in &self.creatures.projectiles { - out.push(json!({"id": p.id, "kind": format!("{:?}", p.kind).split([' ', '{']).next().unwrap_or(""), "position": at(p.position)})); + out.push(json!({"id": p.id, "kind": format!("{:?}", p.kind).split([' ', '{']).next().unwrap_or(""), "position": at(p.position), "velocity": at(p.velocity), + "player_owned": p.owner == Some(horizon_client::mobs::Who::Player)})); } for (kind, p, _) in self.potions.thrown_entities() { out.push(json!({"kind": kind, "position": at(p)})); diff --git a/crates/horizon-client/src/game/remote_vehicles.rs b/crates/horizon-client/src/game/remote_vehicles.rs index 620aff97c..877ed66e6 100644 --- a/crates/horizon-client/src/game/remote_vehicles.rs +++ b/crates/horizon-client/src/game/remote_vehicles.rs @@ -56,6 +56,11 @@ impl Game<'_> { let p = a.position; hits.push((a.id as i32, d, [p.x, p.y, p.z])); } + if let Some((i, d, _)) = self.cushion_hit() { + let c = &self.cushions[i]; + let p = c.position; + hits.push((c.id as i32, d, [p.x, p.y, p.z])); + } if let Some((i, d)) = self.boat_hit() { let p = self.boats[i].position; hits.push((self.boats[i].id as i32, d, [p.x, p.y, p.z])); @@ -79,6 +84,8 @@ impl Game<'_> { hits.push((c.id as i32, d, [p.x, p.y, p.z])); } } + // EnderDragonPart.isPickable: the server's dragon hurts by part. + hits.extend(self.remote_dragon_part_hit(eye, dir, reach)); } let (id, distance, origin) = hits.into_iter().min_by(|a, b| a.1.total_cmp(&b.1))?; let point = at(distance); @@ -138,7 +145,10 @@ impl Game<'_> { self.position_rider(); return true; } - let seat = if let Some(i) = self.boats.iter().position(|b| b.id == id) { + let seat = if let Some(c) = self.cushions.iter().find(|c| c.id == id) { + // The seat does not move; the rider sits on the cushion. + Some(c.seat()) + } else if let Some(i) = self.boats.iter().position(|b| b.id == id) { // AbstractBoat.tick on the controlling client: steer and move. let mut b = self.boats[i].clone(); b.input = [keys.left, keys.right, keys.forward, keys.backward]; diff --git a/crates/horizon-client/src/game/server_mods.rs b/crates/horizon-client/src/game/server_mods.rs new file mode 100644 index 000000000..db88639eb --- /dev/null +++ b/crates/horizon-client/src/game/server_mods.rs @@ -0,0 +1,356 @@ +//! Server mods in the game (`docs/mods.md`, "Server mods"): the game that +//! simulates the world (in-frame single player, the server thread, a LAN +//! host, the dedicated server) runs them. At the end of each tick it tells +//! them who joined and left, then what players said, broke and placed since +//! the last one, then ticks them; a player's command reaches them at once. +//! Their lines go to the players they name. With no server mod on, each hook +//! here is one check. +use super::{Game, lan::LanHost}; +#[cfg(not(feature = "mods"))] +use horizon_world::registry::BlockStateId; + +/// Who did something a server mod hears about, resolved at the tick's end. +#[cfg_attr(not(feature = "mods"), allow(dead_code))] +pub(super) enum Who { + /// The window's own player, in-frame. + Local, + /// A connection's player (the server thread's owner is one). + Conn(u32), + Uuid(u128), +} + +/// What players did during a tick, for the server mods at its end. +#[cfg_attr(not(feature = "mods"), allow(dead_code))] +pub(super) enum ModEvent { + Chat(Who, String), + Block { + who: Who, + pos: [i32; 3], + state: String, + placed: bool, + }, +} + +#[cfg(not(feature = "mods"))] +impl Game<'_> { + pub(super) fn tick_server_mods(&mut self) {} + pub(super) fn mod_block_event(&mut self, _pos: [i32; 3], _state: BlockStateId, _placed: bool) {} + pub(super) fn mod_player_chat(&mut self, _who: Who, _text: &str) {} + pub(super) fn local_server_mod_command(&mut self, _line: &str) -> bool { + false + } + pub(super) fn guest_server_mod_command( + &mut self, + _host: &mut LanHost, + _conn: u32, + _line: &str, + ) -> bool { + false + } +} + +#[cfg(feature = "mods")] +mod run { + use super::{Game, LanHost, ModEvent, Who}; + use horizon_client::{ + command::args::GameMode as Mode, + lan::data::component_nbt, + text::{self, Text}, + }; + use horizon_mods::{BlockPos, GameMode, Output, ServerPlayer}; + use horizon_protocol::packets::play::{self, Clientbound as C}; + use horizon_world::registry::BlockStateId; + + /// `UUID.toString()`. + fn uuid_string(u: u128) -> String { + let h = format!("{u:032x}"); + format!( + "{}-{}-{}-{}-{}", + &h[..8], + &h[8..12], + &h[12..16], + &h[16..20], + &h[20..] + ) + } + + fn mode(id: i32) -> GameMode { + match id { + 1 => GameMode::Creative, + 2 => GameMode::Adventure, + 3 => GameMode::Spectator, + _ => GameMode::Survival, + } + } + + impl Game<'_> { + /// The players on this game's server: the window's own player + /// in-frame, then every connection's. `host` is the hub when it is + /// out of `self.lan`. + pub(in crate::game) fn server_players(&self, host: Option<&LanHost>) -> Vec { + let mut out = Vec::new(); + if self.options.execution_role.is_client() + && self.remote.is_none() + && let Some(p) = &self.player + { + out.push(ServerPlayer { + id: self.player_uuid_string(), + name: crate::game::chat::PLAYER_NAME.to_owned(), + x: p.position.x, + y: p.position.y, + z: p.position.z, + dimension: self.dim.id().to_owned(), + game_mode: match self.mode { + Mode::Survival => GameMode::Survival, + Mode::Creative => GameMode::Creative, + Mode::Adventure => GameMode::Adventure, + Mode::Spectator => GameMode::Spectator, + }, + health: p.health.health(), + }); + } + let guests = host + .or(self.lan.as_ref()) + .into_iter() + .flat_map(|h| &h.hub.guests); + out.extend(guests.filter(|g| g.placed).map(|g| ServerPlayer { + id: uuid_string(g.uuid), + name: g.name.clone(), + x: g.position[0], + y: g.position[1], + z: g.position[2], + dimension: g.dimension.clone(), + game_mode: mode(g.game_mode), + health: g.health, + })); + out + } + + /// Whether what players do now reaches server mods: one is running + /// and this game simulates the world. + fn hears_players(&self) -> bool { + self.mods.server && self.remote.is_none() + } + + /// The tick's end: joins and leaves, the tick's events, the tick hook. + pub(in crate::game) fn tick_server_mods(&mut self) { + if !self.options.execution_role.is_client() { + // A server has no frames to check its dev mods in. + self.reload_dev_mods(); + } + if !self.mods.server { + return; + } + let players = self.server_players(None); + let snapshot = self.mod_snapshot_with(players.clone()); + self.mods.mods.set_snapshot(snapshot); + let before = std::mem::take(&mut self.mods.players); + for p in before + .iter() + .filter(|p| !players.iter().any(|q| q.id == p.id)) + { + self.mods.mods.player_left(p); + } + for p in players + .iter() + .filter(|p| !before.iter().any(|q| q.id == p.id)) + { + self.mods.mods.player_joined(p); + } + for event in std::mem::take(&mut self.mods.events) { + let who = |w: &Who| { + let id = match w { + Who::Local => self.player_uuid_string(), + Who::Uuid(u) => uuid_string(*u), + Who::Conn(c) => { + let guests = self.lan.iter().flat_map(|h| &h.hub.guests); + let g = guests.into_iter().find(|g| g.conn == *c); + g.map_or_else(String::new, |g| uuid_string(g.uuid)) + } + }; + players.iter().chain(&before).find(|p| p.id == id).cloned() + }; + match event { + ModEvent::Chat(w, text) => { + if let Some(p) = who(&w) { + self.mods.mods.player_chat(&p, &text); + } + } + ModEvent::Block { + who: w, + pos, + state, + placed, + } => { + let Some(p) = who(&w) else { continue }; + let pos = BlockPos { + x: pos[0], + y: pos[1], + z: pos[2], + }; + if placed { + self.mods.mods.block_placed(&p, pos, &state); + } else { + self.mods.mods.block_broken(&p, pos, &state); + } + } + } + } + self.mods.mods.server_tick(self.ticks); + self.mods.players = players; + self.show_mod_output(); + } + + /// A player broke (or placed) `state` at `pos`: the player acting now. + pub(in crate::game) fn mod_block_event( + &mut self, + pos: [i32; 3], + state: BlockStateId, + placed: bool, + ) { + if !self.hears_players() { + return; + } + let who = self.lan_acting.map_or(Who::Local, Who::Conn); + let state = self.state_string(state); + self.mods.events.push(ModEvent::Block { + who, + pos, + state, + placed, + }); + } + + /// A chat message a player sent. + pub(in crate::game) fn mod_player_chat(&mut self, who: Who, text: &str) { + if self.hears_players() { + self.mods.events.push(ModEvent::Chat(who, text.to_owned())); + } + } + + /// `/line` typed by the window's own player in-frame: true when a + /// server mod owns it. + pub(in crate::game) fn local_server_mod_command(&mut self, line: &str) -> bool { + if !self.hears_players() { + return false; + } + let players = self.server_players(None); + let Some(me) = players.first().cloned() else { + return false; + }; + let snapshot = self.mod_snapshot_with(players); + self.mods.mods.set_snapshot(snapshot); + let owned = self.mods.mods.server_command(&me, line); + self.show_mod_output(); + owned + } + + /// `/line` typed by a connection's player: true when a server mod + /// owns it, whatever the player's permission level. + pub(in crate::game) fn guest_server_mod_command( + &mut self, + host: &mut LanHost, + conn: u32, + line: &str, + ) -> bool { + if !self.hears_players() { + return false; + } + let Some(g) = host.hub.guest(conn) else { + return false; + }; + let id = uuid_string(g.uuid); + let players = self.server_players(Some(host)); + let Some(me) = players.iter().find(|p| p.id == id).cloned() else { + return false; + }; + let snapshot = self.mod_snapshot_with(players); + self.mods.mods.set_snapshot(snapshot); + if !self.mods.mods.server_command(&me, line) { + return false; + } + self.route_mod_output(Some(host)); + true + } + + /// Sends a server mod's line to the player with this id: the + /// window's own chat for the local player, a system message for a + /// connection's. `host` is the hub when it is out of `self.lan`. + pub(in crate::game) fn tell_server_player( + &mut self, + host: Option<&mut LanHost>, + id: &str, + line: Text, + ) { + let local = self.options.execution_role.is_client() + && self.remote.is_none() + && self.player.is_some(); + if local && self.player_uuid_string() == id { + self.add_mod_chat_line(line); + return; + } + let Some(host) = host.or(self.lan.as_mut()) else { + return; + }; + let to = host + .hub + .guests + .iter() + .find(|g| g.placed && uuid_string(g.uuid) == id); + if let Some(conn) = to.map(|g| g.conn) { + host.hub.send_to( + conn, + &C::SystemChat(play::SystemChat { + content: component_nbt(&line.component()), + overlay: false, + }), + ); + } + } + + /// Routes a server mod's output: `Tell` and `Reply` to their player, + /// `Broadcast` to everyone and the log. + pub(in crate::game) fn route_server_output( + &mut self, + mut host: Option<&mut LanHost>, + output: Output, + ) { + let named = |name: &str, text: String| { + let mut line = Text::literal(format!("[{name}] ")).with_color(text::GRAY); + line.push(Text::literal(text)); + line + }; + match output { + Output::Tell { name, player, text } => { + self.tell_server_player(host, &player, named(&name, text)); + } + Output::Reply { + player, + text, + error, + } => { + let line = Text::literal(text); + let line = if error { + line.with_color(text::RED) + } else { + line + }; + self.tell_server_player(host, &player, line); + } + Output::Broadcast { name, text } => { + let plain = format!("[{name}] {text}"); + if self.options.dedicated.is_some() { + super::super::dedicated::log("INFO", &plain); + } else { + log::info!("{plain}"); + } + for p in self.server_players(host.as_deref()) { + let line = named(&name, text.clone()); + self.tell_server_player(host.as_deref_mut(), &p.id, line); + } + } + _ => {} + } + } + } +} diff --git a/crates/horizon-client/src/game/server_travel.rs b/crates/horizon-client/src/game/server_travel.rs index 158b2301e..bcaf37a76 100644 --- a/crates/horizon-client/src/game/server_travel.rs +++ b/crates/horizon-client/src/game/server_travel.rs @@ -13,6 +13,7 @@ use super::respawn_anchor::RespawnConfig; use super::{Dim, Game, lan::LanHost}; use horizon_client::{lan::hub::TickCtx, text::Text}; use horizon_core::{geometry::Vec3, position::BlockPos}; +use horizon_protocol::packets::play::{self, Clientbound as C}; /// A trip under way: the player is in the destination's level, whose /// chunks are loading around `target`. @@ -103,8 +104,35 @@ impl Game<'_> { if let Some(pos) = self.nether_portal_inside(at) { self.portals.player.set_inside(pos, PLAYER_DELAY); } + // `ServerPlayer.showEndCredits`: the player stays out of the world while the + // poem rolls, then PERFORM_RESPAWN takes it to its respawn point. + let play = host.play.entry(conn).or_default(); + if play.won_game { + if std::mem::take(&mut play.respawn_requested) { + play.won_game = false; + self.start_server_trip(host, conn, Dim::Overworld, None); + self.portals.player.cooldown = 10; + } + return; + } let (end_portal, gateway) = self.inside_end_portals(at, WIDTH, HEIGHT); if end_portal { + // EndPortalBlock.entityInside: the first exit from the End shows the credits. + if self.dim == Dim::End && !host.hub.guest(conn).is_some_and(|g| g.seen_credits) { + if let Some(g) = host.hub.guests.iter_mut().find(|g| g.conn == conn) { + g.seen_credits = true; + } + host.play.entry(conn).or_default().won_game = true; + // ClientboundGameEventPacket.WIN_GAME. + host.hub.send_to( + conn, + &C::GameEvent(play::GameEvent { + event: 4, + param: 0.0, + }), + ); + return; + } if self.portals.player.cooldown == 0 { let target = if self.dim == Dim::End { Dim::Overworld diff --git a/crates/horizon-client/src/game/sign_edit.rs b/crates/horizon-client/src/game/sign_edit.rs index 2f50ad9ab..2d010f1f5 100644 --- a/crates/horizon-client/src/game/sign_edit.rs +++ b/crates/horizon-client/src/game/sign_edit.rs @@ -6,9 +6,9 @@ use horizon_client::{ containers::BlockEntity, hud::{HudBatch, rgba}, signs::wood_type, + ui::EditBox, }; use horizon_protocol::packets::play::{self, Clientbound as C, Serverbound as S}; -use std::time::Instant; use winit::{ event::{ElementState, KeyEvent}, keyboard::{KeyCode, PhysicalKey}, @@ -18,7 +18,16 @@ pub(super) struct SignEditor { pub pos: (i32, i32, i32), pub front: bool, pub line: usize, - pub opened: Instant, + /// The line being edited (`AbstractSignEditScreen`'s text field). + edit: EditBox, +} + +fn sign_box() -> EditBox { + let mut edit = EditBox::new(0.0, 0.0, 90.0, 9.0); + edit.bordered = false; + edit.max_length = 384; + edit.focused = true; + edit } impl Game<'_> { @@ -28,8 +37,9 @@ impl Game<'_> { pos, front, line: 0, - opened: Instant::now(), + edit: sign_box(), }); + self.sign_load(); self.keys.clear(); self.right = false; self.capture(false); @@ -140,97 +150,154 @@ impl Game<'_> { /// A key and the text it typed on the sign being edited (the keyboard, /// or a controller's on-screen keyboard). pub(super) fn sign_input(&mut self, key: Option, typed: Option<&str>) { - let Some(edit) = self.sign_edit.as_mut() else { + if self.sign_edit.is_none() { return; - }; - let front = edit.front; - let id = sign_line_id(front, edit.line); + } match key { Some(KeyCode::Escape) => self.close_sign_editor(), - Some(KeyCode::ArrowUp) => edit.line = (edit.line + 3) & 3, + Some(KeyCode::ArrowUp) => self.sign_move_line(3), Some(KeyCode::ArrowDown | KeyCode::Enter | KeyCode::NumpadEnter) => { - edit.line = (edit.line + 1) & 3 + self.sign_move_line(1) } - Some(KeyCode::Backspace) => { - let (line, key) = (edit.line, edit.pos); - if let Some(BlockEntity::Sign(sign)) = self.world.block_entities.get_mut(&key) { - let text = if front { - &mut sign.front - } else { - &mut sign.back - }; - let value = &mut text.lines[line]; - if !self.text_selection.take(id, value) { - value.pop(); - } - } + Some( + key @ (KeyCode::ArrowLeft + | KeyCode::ArrowRight + | KeyCode::Home + | KeyCode::End + | KeyCode::Backspace + | KeyCode::Delete), + ) => { + let (ctrl, shift) = (self.has_control_down(), self.has_shift_down()); + self.sign_change(|edit| { + edit.key(key, ctrl, shift); + }); } _ => { let Some(typed) = typed else { return; }; - let line = edit.line; - let atlas = &self.gui.atlas; - let width = |s: &str| HudBatch::text_width(atlas, s); - let Some(key) = self.sign_edit.as_ref().map(|e| e.pos) else { - return; - }; - if let Some(BlockEntity::Sign(sign)) = self.world.block_entities.get_mut(&key) { - let max = sign.max_line_width(); - let text = if front { - &mut sign.front - } else { - &mut sign.back - }; - self.text_selection.take(id, &mut text.lines[line]); - for ch in typed.chars().filter(|c| !c.is_control()) { - let mut next = text.lines[line].clone(); - next.push(ch); - // TextFieldHelper filter: font.width(s) <= maxTextLineWidth. - if width(&next) <= max { - text.lines[line] = next; - } - } - } + self.sign_change(|edit| edit.insert_text(typed)); } } } - /// `TextFieldHelper.keyPressed`'s shortcuts on the edited line: a paste - /// (formatting and carriage returns removed) is taken whole or not at - /// all, as the line must stay within the sign's width. - fn sign_shortcut(&mut self, shortcut: horizon_client::clipboard::EditShortcut) { + /// Up or down a line: the box writes the line it leaves and loads the next. + fn sign_move_line(&mut self, by: usize) { + self.sign_write(); + if let Some(edit) = self.sign_edit.as_mut() { + edit.line = (edit.line + by) & 3; + } + self.sign_load(); + } + /// The edited line's text. + fn sign_current(&self) -> Option { + let edit = self.sign_edit.as_ref()?; + let BlockEntity::Sign(sign) = self.world.block_entities.get(&edit.pos)? else { + return None; + }; + let side = if edit.front { &sign.front } else { &sign.back }; + Some(side.lines[edit.line].clone()) + } + /// `EditBox.setValue` from the line now being edited. + fn sign_load(&mut self) { + let Some(text) = self.sign_current() else { + return; + }; + if let Some(edit) = self.sign_edit.as_mut() { + edit.edit.set_value(&text); + } + } + /// The box's text onto the sign, when it still fits the line. + fn sign_write(&mut self) { let Some(edit) = self.sign_edit.as_ref() else { return; }; - let (key, front, line) = (edit.pos, edit.front, edit.line); - let Some(BlockEntity::Sign(sign)) = self.world.block_entities.get_mut(&key) else { + let (pos, front, line, value) = (edit.pos, edit.front, edit.line, edit.edit.value.clone()); + if !self.sign_fits(&value) { + return; + } + let Some(BlockEntity::Sign(sign)) = self.world.block_entities.get_mut(&pos) else { return; }; - let max = sign.max_line_width(); - let text = if front { + let side = if front { &mut sign.front } else { &mut sign.back }; - let atlas = &self.gui.atlas; - self.text_selection.apply( - sign_line_id(front, line), - &mut text.lines[line], - shortcut, - &mut self.clipboard, - |value, pasted| { - let next = format!( - "{value}{}", - horizon_client::clipboard::helper_clipboard_contents(pasted) - ); - HudBatch::text_width(atlas, &next) <= max && { - *value = next; - true - } - }, - ); + side.lines[line] = value; } - /// Done button (`this.width / 2 - 100, this.height / 4 + 144`, 200x20). + /// TextFieldHelper: `font.width(s) <= maxTextLineWidth`. + fn sign_fits(&self, value: &str) -> bool { + let Some(edit) = self.sign_edit.as_ref() else { + return false; + }; + let Some(BlockEntity::Sign(sign)) = self.world.block_entities.get(&edit.pos) else { + return false; + }; + HudBatch::text_width(&self.gui.atlas, value) <= sign.max_line_width() + } + /// Edit the line, then keep the result only when it still fits. + fn sign_change(&mut self, f: impl FnOnce(&mut EditBox)) { + let before = self + .sign_edit + .as_ref() + .map(|e| (e.edit.value.clone(), e.edit.cursor, e.edit.highlight)); + if let Some(edit) = self.sign_edit.as_mut() { + f(&mut edit.edit); + let clean = horizon_client::clipboard::strip_formatting(&edit.edit.value); + if clean != edit.edit.value { + let n = horizon_client::ui::char_len(&clean); + edit.edit.value = clean; + edit.edit.cursor = edit.edit.cursor.min(n); + edit.edit.highlight = edit.edit.highlight.min(n); + } + } + self.sign_keep(before); + } + /// Write the box when the line still fits; otherwise put the old text back. + fn sign_keep(&mut self, before: Option<(String, usize, usize)>) { + let value = self + .sign_edit + .as_ref() + .map(|e| e.edit.value.clone()) + .unwrap_or_default(); + if self.sign_fits(&value) { + self.sign_write(); + } else if let (Some(edit), Some((value, cursor, highlight))) = + (self.sign_edit.as_mut(), before) + { + edit.edit.value = value; + edit.edit.cursor = cursor; + edit.edit.highlight = highlight; + } + } + /// `TextFieldHelper.keyPressed`'s shortcuts on the edited line. Paste + /// reads `getClipboardContents` before `insertText`. A paste that would + /// pass the sign's width is refused whole. + fn sign_shortcut(&mut self, shortcut: horizon_client::clipboard::EditShortcut) { + if shortcut == horizon_client::clipboard::EditShortcut::Paste { + let raw = horizon_client::clipboard::Clipboard::get(&mut self.clipboard); + let text = horizon_client::clipboard::helper_clipboard_contents(&raw); + self.sign_change(|edit| edit.insert_text(&text)); + return; + } + let before = self + .sign_edit + .as_ref() + .map(|e| (e.edit.value.clone(), e.edit.cursor, e.edit.highlight)); + if let Some(edit) = self.sign_edit.as_mut() { + edit.edit.shortcut(shortcut, &mut self.clipboard); + let clean = horizon_client::clipboard::strip_formatting(&edit.edit.value); + if clean != edit.edit.value { + let n = horizon_client::ui::char_len(&clean); + edit.edit.value = clean; + edit.edit.cursor = edit.edit.cursor.min(n); + edit.edit.highlight = edit.edit.highlight.min(n); + } + } + self.sign_keep(before); + } + /// Done button (`this.width / 2 - 100, this.height / 4 + 144`, 200x20), + /// or a click on a line (`EditBox.onClick`). pub(super) fn sign_edit_click(&mut self, size: [u32; 2]) { let b = HudBatch::new(size); let (x, y) = (b.width / 2.0 - 100.0, b.height / 4.0 + 144.0); @@ -238,7 +305,56 @@ impl Game<'_> { if mx >= x && mx < x + 200.0 && my >= y && my < y + 20.0 { self.audio.play_button_click(); self.close_sign_editor(); + return; } + let Some((cx, top, line_height, max_width, lines)) = self.sign_lines(b.width) else { + return; + }; + let shift = self.has_shift_down(); + for i in 0..lines.len() { + let ly = top + i as f32 * line_height; + let left = cx - max_width / 2.0; + if mx < left || mx >= left + max_width || my < ly || my >= ly + line_height { + continue; + } + let current = self.sign_edit.as_ref().map(|e| e.line); + if current != Some(i) { + self.sign_move_line((i + 4 - current.unwrap_or(0)) & 3); + } + let value = self + .sign_edit + .as_ref() + .map(|e| e.edit.value.clone()) + .unwrap_or_default(); + let lw = HudBatch::text_width(&self.gui.atlas, &value); + let text_x = cx - (lw as i32 / 2) as f32; + if let Some(edit) = self.sign_edit.as_mut() { + edit.edit.x = text_x; + edit.edit.y = ly; + edit.edit.width = max_width; + edit.edit.click(&self.gui.atlas, mx, shift, false); + } + self.sign_write(); + return; + } + } + /// Centre x, the first line's y, the line height, the width limit and the four lines. + fn sign_lines(&self, width: f32) -> Option<(f32, f32, f32, f32, Vec)> { + let edit = self.sign_edit.as_ref()?; + let BlockEntity::Sign(sign) = self.world.block_entities.get(&edit.pos)? else { + return None; + }; + let text = if edit.front { &sign.front } else { &sign.back }; + let line_height = sign.line_height(); + let y = if sign.hanging { 125.0 } else { 90.0 }; + let top = y - (4.0 * line_height / 2.0).floor(); + Some(( + width / 2.0, + top, + line_height, + sign.max_line_width(), + text.lines.to_vec(), + )) } pub(super) fn draw_sign_editor(&self, batch: &mut HudBatch) { let Some(edit) = &self.sign_edit else { return }; @@ -304,23 +420,48 @@ impl Game<'_> { let color = rgba((color >> 16) as u8, (color >> 8) as u8, color as u8, 255); let line_height = sign.line_height(); let midpoint = (4.0 * line_height / 2.0).floor(); - let blink = (edit.opened.elapsed().as_millis() / 300) % 2 == 0; for (i, line) in text.lines.iter().enumerate() { - let lw = HudBatch::text_width(atlas, line); + let shown = if i == edit.line { + edit.edit.value.as_str() + } else { + line.as_str() + }; + let lw = HudBatch::text_width(atlas, shown); let x = cx - (lw as i32 / 2) as f32; let ly = y + i as f32 * line_height - midpoint; - batch.text(atlas, line, x, ly, color, false); - if i == edit.line - && self - .text_selection - .covers(sign_line_id(edit.front, i), line) - { - // AbstractSignEditScreen: the selection from its start to its end. - batch.text_highlight(atlas, (x, ly, lw, line_height), true); + batch.text(atlas, shown, x, ly, color, false); + if i != edit.line { + continue; } - if i == edit.line && blink { - // TextCursorUtils.extractAppendCursor: an underscore after the text. - batch.text(atlas, "_", x + lw, ly, color, false); + let value = &edit.edit.value; + if edit.edit.cursor != edit.edit.highlight { + let (a, b) = ( + edit.edit.cursor.min(edit.edit.highlight), + edit.edit.cursor.max(edit.edit.highlight), + ); + let pre: String = value.chars().take(a).collect(); + let sel: String = value.chars().skip(a).take(b - a).collect(); + batch.text_highlight( + atlas, + ( + x + HudBatch::text_width(atlas, &pre), + ly, + HudBatch::text_width(atlas, &sel), + line_height, + ), + true, + ); + } + if edit.edit.cursor_visible() { + let pre: String = value.chars().take(edit.edit.cursor).collect(); + batch.fill( + atlas, + x + HudBatch::text_width(atlas, &pre), + ly, + 1.0, + line_height, + color, + ); } } let (bx, by) = (w / 2.0 - 100.0, h / 4.0 + 144.0); @@ -344,8 +485,3 @@ impl Game<'_> { ); } } - -/// The sign line being edited, for Select All. -fn sign_line_id(front: bool, line: usize) -> horizon_client::clipboard::FieldId { - (if front { "sign.front" } else { "sign.back" }, line) -} diff --git a/crates/horizon-client/src/game/spill.rs b/crates/horizon-client/src/game/spill.rs index b7283c57b..7f370507f 100644 --- a/crates/horizon-client/src/game/spill.rs +++ b/crates/horizon-client/src/game/spill.rs @@ -398,8 +398,12 @@ impl GameLevel<'_> { } } PreRemove::Campfire => { - for _ in 0..4 { - self.drop_item_stack(pos, None); + let items = match &entity { + Some(BlockEntity::Campfire(c)) => c.items.clone(), + _ => Default::default(), + }; + for stack in items { + self.drop_item_stack(pos, stack); } } PreRemove::Jukebox => { diff --git a/crates/horizon-client/src/game/stations.rs b/crates/horizon-client/src/game/stations.rs index f7f05e1c4..56b19e393 100644 --- a/crates/horizon-client/src/game/stations.rs +++ b/crates/horizon-client/src/game/stations.rs @@ -135,8 +135,10 @@ pub(super) struct Station { pub(super) offers: EnchantOffers, bookcases: i32, pub(super) anvil: AnvilResult, - /// Anvil rename box text. + /// Anvil rename box text (`AnvilMenu.itemName`). pub(super) name: String, + /// The box itself (`AnvilScreen`'s `EditBox` of 50, unbordered). + pub(super) rename: horizon_client::ui::EditBox, /// Stonecutter: the menu's recipe list (horizon_client::menu), its /// `selectedRecipeIndex` and the screen's first shown index. pub(super) stone: horizon_client::menu::Stonecutter, @@ -146,8 +148,6 @@ pub(super) struct Station { anvil_last: Option, /// Anvil on a server: the name last sent (the client menu's `itemName`). pub(super) anvil_sent: Option, - /// When the screen opened: the rename box has the focus from then. - opened: std::time::Instant, pub(super) last_sound: u64, /// Villager trading state. pub(super) merchant: Option>, @@ -169,12 +169,12 @@ impl Station { bookcases: 0, anvil: AnvilResult::default(), name: String::new(), + rename: anvil_box(), stone: Default::default(), selected: None, start: 0, anvil_last: None, anvil_sent: None, - opened: std::time::Instant::now(), last_sound: 0, merchant: None, beacon: [None; 2], @@ -868,6 +868,9 @@ impl Game<'_> { if kind == Kind::Stonecutter && self.stonecutter_click(local) { return true; } + if kind == Kind::Anvil && !right && self.anvil_name_click(ox, oy) { + return true; + } } let Some(slot) = self.slot_at(&batch, self.cursor.0, self.cursor.1) else { return true; @@ -894,6 +897,8 @@ impl Game<'_> { .as_ref() .map(|i| stations::hover_name(&|id| self.pack.names.display_item(id), i)) .unwrap_or_default(); + let name = s.name.clone(); + s.rename.set_value(&name); } self.station_changed(); } @@ -960,21 +965,29 @@ impl Game<'_> { let Some(s) = self.station.as_mut() else { return; }; - let cleared = self.text_selection.take(ANVIL_NAME, &mut s.name); if backspace { - if !cleared { - s.name.pop(); - } + s.rename.delete_chars(-1); } else if let Some(t) = text { - for c in t.chars().filter(|c| !c.is_control()) { - if s.name.chars().count() < ANVIL_NAME_CHARS { - s.name.push(c); - } - } + s.rename.insert_text(t); } + s.name.clone_from(&s.rename.value); self.station_changed(); self.remote_anvil_rename(); } + /// `AnvilScreen.keyPressed`: the rename box handles the key. + pub(super) fn station_key(&mut self, key: winit::keyboard::KeyCode) -> bool { + let (ctrl, shift) = (self.has_control_down(), self.has_shift_down()); + let Some(s) = self.station.as_mut() else { + return false; + }; + if !s.rename.key(key, ctrl, shift) { + return false; + } + s.name.clone_from(&s.rename.value); + self.station_changed(); + self.remote_anvil_rename(); + true + } /// Ctrl+A/C/V/X in the anvil's rename box (an `EditBox` of 50) or the /// recipe book's search box. pub(super) fn station_shortcut(&mut self, shortcut: horizon_client::clipboard::EditShortcut) { @@ -985,18 +998,52 @@ impl Game<'_> { let Some(s) = self.station.as_mut() else { return; }; - if Self::append_shortcut( - &mut self.text_selection, - &mut self.clipboard, - ANVIL_NAME, - &mut s.name, - shortcut, - ANVIL_NAME_CHARS, - ) { + if s.rename.shortcut(shortcut, &mut self.clipboard) { + s.name.clone_from(&s.rename.value); self.station_changed(); self.remote_anvil_rename(); } } + /// A click in the anvil's name box (`EditBox.onClick`). + fn anvil_name_click(&mut self, ox: f32, oy: f32) -> bool { + let open = self + .station + .as_ref() + .is_some_and(|s| s.kind == Kind::Anvil && s.inputs[0].is_some()); + if !open { + return false; + } + let (x, y, w, h) = (ox + 62.0, oy + 24.0, 103.0, 12.0); + let (mx, my) = self.cursor; + if mx < x || my < y || mx >= x + w || my >= y + h { + return false; + } + let shift = self.has_shift_down(); + let Some(s) = self.station.as_mut() else { + return false; + }; + s.rename.x = x; + s.rename.y = y; + s.rename.width = w; + s.rename.click(&self.gui.atlas, mx, shift, false); + true + } + /// AnvilScreen's name box, drawn after the station picture. + fn draw_anvil_name(&mut self, batch: &mut HudBatch, ox: f32, oy: f32) { + let Some(s) = self.station.as_mut() else { + return; + }; + let edit = &mut s.rename; + edit.x = ox + 62.0; + edit.y = oy + 24.0; + edit.width = 103.0; + edit.height = 12.0; + edit.bordered = false; + edit.focused = true; + edit.text_color = u32::MAX; + edit.max_length = ANVIL_NAME_CHARS; + edit.draw(batch, &self.gui.atlas, None); + } // ---------------------------------------------------------------- drawing @@ -1094,6 +1141,10 @@ impl Game<'_> { let (ox, oy) = self.inventory_origin(batch); let local = (self.cursor.0 - ox, self.cursor.1 - oy); let mut tooltip: Option> = None; + let mut anvil_name = false; + // Keep item tooltips as stacks until drawing: text alone loses the + // bundle contents component (including in the player's inventory). + let mut tooltip_stack: Option = None; { let atlas = &self.gui.atlas; batch.fill( @@ -1428,18 +1479,8 @@ impl Game<'_> { ); } if s.inputs[0].is_some() { - // AnvilScreen's name box: white, 103 wide, no inverted highlight. - horizon_client::ui::append_field( - batch, - atlas, - &s.name, - (ox + 62.0, oy + 24.0, 103.0), - (u32::MAX, true), - ANVIL_NAME_CHARS, - self.text_selection.covers(ANVIL_NAME, &s.name), - false, - s.opened.elapsed().as_millis(), - ); + // Drawn once this borrow of the station ends. + anvil_name = true; } let cost = s.anvil.cost; if cost > 0 { @@ -1579,13 +1620,16 @@ impl Game<'_> { ); self.draw_item(batch, &result, ox + x, oy + y); if hover { - tooltip = Some(self.stack_tooltip(&result)); + tooltip_stack = Some(result); } } } } } } + if anvil_name { + self.draw_anvil_name(batch, ox, oy); + } let drag = self.drag_view(); for i in self.station_slots().unwrap_or_default() { let Some((sx, sy)) = self.slot_position_any(i) else { @@ -1606,13 +1650,16 @@ impl Game<'_> { ); if self.carried.is_none() && tooltip.is_none() + && tooltip_stack.is_none() && let Some(stack) = self.slot_mut(slot).clone() { - tooltip = Some(self.stack_tooltip(&stack)); + tooltip_stack = Some(stack); } } if self.carried.is_some() { self.draw_carried(batch); + } else if let Some(stack) = tooltip_stack { + self.draw_stack_tooltip(batch, &stack, self.cursor.0, self.cursor.1); } else if let Some(lines) = tooltip { self.draw_tooltip_lines(batch, &lines, self.cursor.0, self.cursor.1); } @@ -1656,6 +1703,8 @@ impl Game<'_> { }; let name = if let Some(n) = stack.custom_name() { n.to_owned() + } else if let Some(n) = stack.item_name() { + n } else if stack.data().is_some_and(|d| d.ominous_banner) { self.translate("block.minecraft.ominous_banner", "Ominous Banner") } else if stack.data().and_then(|d| d.potion.as_ref()).is_some() @@ -1682,7 +1731,9 @@ impl Game<'_> { // ItemContainerContents.addToTooltip. let hover_name = |s: &ItemStack| { s.custom_name() - .map_or_else(|| self.pack.names.display_item(&s.item), str::to_owned) + .map(str::to_owned) + .or_else(|| s.item_name()) + .unwrap_or_else(|| self.pack.names.display_item(&s.item)) }; if display.shows("minecraft:container") { for text in @@ -1907,32 +1958,65 @@ impl Game<'_> { if lines.is_empty() { return; } - let lines: Vec<_> = lines + let lines = Self::resolved(lines); + let atlas = &self.gui.atlas; + let (x, y, w, h) = + Self::tooltip_geometry(atlas, &lines, (x, y), (batch.width, batch.height), 0.0); + Self::tooltip_box(batch, atlas, x, y, w, h); + Self::tooltip_text(batch, atlas, &lines, x, y); + } + /// A tooltip's lines with their legacy codes resolved and their colours. + fn resolved>( + lines: &[(T, u32)], + ) -> Vec<(horizon_client::text::Text, u32)> { + lines .iter() .map(|(text, color)| { let text: horizon_client::text::Text = text.clone().into(); (text.resolve_legacy(), *color) }) - .collect(); - let atlas = &self.gui.atlas; + .collect() + } + /// The tooltip's text's top-left corner and the box's size: beside the + /// cursor, kept on screen, `extra` pixels taller than the text. + fn tooltip_geometry( + atlas: &horizon_client::hud::HudAtlas, + lines: &[(horizon_client::text::Text, u32)], + (x, y): (f32, f32), + (width, height): (f32, f32), + extra: f32, + ) -> (f32, f32, f32, f32) { let w = lines .iter() .map(|(t, _)| atlas.font.width_text(t)) - .fold(0.0, f32::max); - let h = if lines.len() == 1 { + .fold(0.0, f32::max) + .max(if extra > 0.0 { 96.0 } else { 0.0 }); + let text_h = if lines.len() == 1 { 8.0 } else { 8.0 + 2.0 + (lines.len() - 1) as f32 * 10.0 }; + let h = text_h + extra; let mut x = x + 12.0; let mut y = y - 12.0; - if x + w > batch.width - 4.0 { + if x + w > width - 4.0 { x = (x - 28.0 - w).max(4.0); } - if y + h + 3.0 > batch.height { - y = batch.height - h - 3.0; + if y + h + 3.0 > height { + y = height - h - 3.0; } y = y.max(4.0); + (x, y, w, h) + } + /// The box and its frame sprites. + fn tooltip_box( + batch: &mut HudBatch, + atlas: &horizon_client::hud::HudAtlas, + x: f32, + y: f32, + w: f32, + h: f32, + ) { batch.fill(atlas, x - 3.0, y - 4.0, w + 6.0, 1.0, rgba(16, 0, 16, 240)); batch.fill( atlas, @@ -1968,12 +2052,137 @@ impl Game<'_> { h + 4.0, rgba(60, 0, 190, 80), ); + } + fn tooltip_text( + batch: &mut HudBatch, + atlas: &horizon_client::hud::HudAtlas, + lines: &[(horizon_client::text::Text, u32)], + x: f32, + y: f32, + ) { let mut ty = y; for (i, (text, color)) in lines.iter().enumerate() { batch.text_styled(atlas, text, x, ty, *color, true); ty += if i == 0 { 12.0 } else { 10.0 }; } } + /// A stack's tooltip: its lines, and under them a bundle's contents + /// (`ClientBundleTooltip`: the 4 wide grid, the `+N` of what it leaves + /// out, and the weight bar). + pub(super) fn draw_stack_tooltip( + &mut self, + batch: &mut HudBatch, + stack: &ItemStack, + x: f32, + y: f32, + ) { + let lines = Self::resolved(&self.stack_tooltip(stack)); + if lines.is_empty() { + return; + } + // The component's height does not depend on where it is drawn, so a + // probe at the origin gives the box its extra height. + let probe = horizon_client::bundle::tooltip_layout(self.res.items(), stack, 0.0, 0.0, 96.0); + let extra = probe.as_ref().map_or(0.0, |l| l.height + 2.0); + let atlas = &self.gui.atlas; + let (x, y, w, h) = + Self::tooltip_geometry(atlas, &lines, (x, y), (batch.width, batch.height), extra); + Self::tooltip_box(batch, atlas, x, y, w, h); + let text_h = h - extra; + Self::tooltip_text(batch, atlas, &lines, x, y); + let Some(layout) = + horizon_client::bundle::tooltip_layout(self.res.items(), stack, x, y + text_h + 2.0, w) + else { + return; + }; + self.draw_bundle_tooltip(batch, &layout); + } + /// `ClientBundleTooltip.extractImage`: the slots, the count past them and + /// the progress bar. + fn draw_bundle_tooltip( + &mut self, + batch: &mut HudBatch, + layout: &horizon_client::bundle::TooltipLayout, + ) { + for (at, stack) in &layout.slots { + // Each draw takes the atlas on its own: the item's needs `&mut self`. + horizon_client::ui::nine_slice( + batch, + &self.gui.atlas, + "gui/sprites/container/bundle/slot_background", + at[0], + at[1], + 24.0, + 24.0, + u32::MAX, + ); + let stack = stack.clone(); + let [x, y] = *at; + self.draw_item(batch, &stack, x + 4.0, y + 4.0); + } + let atlas = &self.gui.atlas; + if let Some((at, hidden)) = layout.overflow { + let label = horizon_client::text::Text::literal(format!("+{hidden}")); + let w = atlas.font.width_text(&label); + batch.text_styled( + atlas, + &label, + at[0] + 12.0 - (w / 2.0).floor(), + at[1] + 10.0, + u32::MAX, + true, + ); + } + if let Some((at, description)) = layout + .empty_description + .zip(Some("item.minecraft.bundle.empty.description")) + { + let text = horizon_client::text::Text::translate(description, &[]); + let mut ty = at[1]; + for line in atlas.font.split_lines(&text, layout.width) { + batch.text_styled(atlas, &line.0, at[0], ty, 0xFFAA_AAAA, false); + ty += 9.0; + } + } + let [bx, by] = layout.bar; + let fill_sprite = if layout.full { + "gui/sprites/container/bundle/bundle_progressbar_full" + } else { + "gui/sprites/container/bundle/bundle_progressbar_fill" + }; + horizon_client::ui::nine_slice( + batch, + atlas, + fill_sprite, + bx + 1.0, + by, + layout.fill, + 13.0, + u32::MAX, + ); + horizon_client::ui::nine_slice( + batch, + atlas, + "gui/sprites/container/bundle/bundle_progressbar_border", + bx, + by, + 96.0, + 13.0, + u32::MAX, + ); + if let Some(key) = layout.label { + let label = horizon_client::text::Text::translate(key, &[]); + let w = atlas.font.width_text(&label); + batch.text_styled( + atlas, + &label, + bx + 48.0 - (w / 2.0).floor(), + by + 3.0, + u32::MAX, + true, + ); + } + } /// Hovered-slot tooltip on the plain inventory, crafting and container screens. pub(super) fn draw_slot_tooltip(&mut self, batch: &mut HudBatch) { if self.carried.is_some() { @@ -1984,8 +2193,7 @@ impl Game<'_> { }; let stack = self.slot_view(slot); if let Some(stack) = stack { - let lines = self.stack_tooltip(&stack); - self.draw_tooltip_lines(batch, &lines, self.cursor.0, self.cursor.1); + self.draw_stack_tooltip(batch, &stack, self.cursor.0, self.cursor.1); } else if let Some(text) = self.crafter_tooltip(slot) { self.draw_tooltip_lines( batch, @@ -2041,5 +2249,13 @@ impl Game<'_> { } /// The anvil's rename box (`AnvilScreen`: `setMaxLength(50)`). -const ANVIL_NAME: horizon_client::clipboard::FieldId = ("anvil.name", 0); const ANVIL_NAME_CHARS: usize = 50; + +fn anvil_box() -> horizon_client::ui::EditBox { + let mut edit = horizon_client::ui::EditBox::new(0.0, 0.0, 103.0, 12.0); + edit.bordered = false; + edit.max_length = ANVIL_NAME_CHARS; + edit.text_color = u32::MAX; + edit.focused = true; + edit +} diff --git a/crates/horizon-client/src/game/text_displays.rs b/crates/horizon-client/src/game/text_displays.rs index f6c946bcc..45bd64fa7 100644 --- a/crates/horizon-client/src/game/text_displays.rs +++ b/crates/horizon-client/src/game/text_displays.rs @@ -210,6 +210,7 @@ impl Game<'_> { if bg != 0 { batch.fill( atlas, + // submitTextBackground(-1, -1, width, height): corners, not a size. -1.0, -1.0, width + 1.0, diff --git a/crates/horizon-client/src/game/trading.rs b/crates/horizon-client/src/game/trading.rs index 87e0c18c6..6986d8baa 100644 --- a/crates/horizon-client/src/game/trading.rs +++ b/crates/horizon-client/src/game/trading.rs @@ -803,8 +803,7 @@ impl Game<'_> { text.split('\n').map(|l| (l.to_owned(), u32::MAX)).collect(); self.draw_tooltip_lines(batch, &lines, self.cursor.0, self.cursor.1); } else if let Some(stack) = tooltip { - let lines = self.stack_tooltip(&stack); - self.draw_tooltip_lines(batch, &lines, self.cursor.0, self.cursor.1); + self.draw_stack_tooltip(batch, &stack, self.cursor.0, self.cursor.1); } true } diff --git a/crates/horizon-client/src/gfx.rs b/crates/horizon-client/src/gfx.rs index 80cf1140e..904370c04 100644 --- a/crates/horizon-client/src/gfx.rs +++ b/crates/horizon-client/src/gfx.rs @@ -65,9 +65,13 @@ mod arena; mod cull; mod end_sky; mod flat; +mod hdr; pub mod lightning; mod lod; +mod native_material; +mod native_pack; mod native_post; +mod native_sky; mod occlusion; mod pack_atlas; pub mod pack_draw; @@ -86,6 +90,7 @@ mod stars; mod timing; pub mod translucency; pub(crate) mod upload; +mod wgsl_prefix; mod world_post; /// A column whose every section has its mesh (`Renderer::lod_detail_columns`). @@ -426,6 +431,8 @@ pub struct Renderer { /// The mipmap levels sampled (the Mipmap Levels option), at most `mip_levels - 1`. mipmaps: u32, terrain_layout: wgpu::BindGroupLayout, + /// terrain.wgsl's `SPRITE_ARRAYS` and `SPRITE_SPLIT`, for a shader pack's terrain. + terrain_sprites: [f64; 2], sprite_sampler: wgpu::Sampler, lightmap_view: wgpu::TextureView, lightmap_sampler: wgpu::Sampler, @@ -457,7 +464,7 @@ pub struct Renderer { lod_retiring: crate::fast_hash::FxHashSet, /// Finished tile meshes `upload_lods` has yet to upload. lod_pending: Option, - detail_columns: HashMap<(i32, i32), u32>, + detail_columns: crate::fast_hash::FxHashMap<(i32, i32), u32>, /// Bumped whenever a column becomes or stops being complete. detail_revision: u64, arena: arena::Arena, @@ -491,17 +498,21 @@ pub struct Renderer { /// The shadow camera's draws by page, in bands of distance from the light. shadow_runs: page_runs::PageRuns, /// Block-entity blocks per meshed section (world position, state id). - block_entities: HashMap>, + block_entities: crate::fast_hash::FxHashMap>, /// Changes whenever `block_entities` does (unique across renderers). block_entity_revision: u64, /// VisGraph face connectivity per meshed section (cave culling). occlusion: occlusion::Occlusion, /// Resolution scale and FXAA (Horizon settings). world_post: world_post::Post, + /// HDR output (Horizon setting): `Some` while the swapchain is scRGB. + hdr: Option, + /// Whether the window's surface can present scRGB. + hdr_capable: bool, /// The shader pack's post-processing, and the dimension (legacy id) it was loaded for. pack_post: Option<(i32, Option)>, /// The post passes of one of Horizon's own shader packs; never beside `pack_post`'s. - native_post: Option, + native: Option, /// Time the shader pack's passes on the GPU (F3, or `HORIZON_SHADER_PACK_TIMING`). pass_timing: bool, /// The entity vertices Horizon draws itself while a shader pack draws the others. @@ -904,15 +915,24 @@ async fn open_device( limits.max_storage_buffer_binding_size, limits.max_texture_array_layers, )); - match adapter - .request_device(&wgpu::DeviceDescriptor { - label: Some("Horizon device"), - required_features: features, - required_limits: limits, - ..Default::default() - }) - .await - { + let desc = wgpu::DeviceDescriptor { + label: Some("Horizon device"), + required_features: features, + required_limits: limits, + ..Default::default() + }; + #[cfg(not(target_os = "macos"))] + let opened = match info.backend { + wgpu::Backend::Vulkan => horizon_hdr::open_vulkan_device(&adapter, &desc), + _ => None, + }; + #[cfg(target_os = "macos")] + let opened = None; + let opened = match opened { + Some(opened) => opened, + None => adapter.request_device(&desc).await, + }; + match opened { Ok((device, queue)) => { return Ok(Opened { instance, @@ -1037,7 +1057,7 @@ impl Renderer { let info = adapter.get_info(); crate::graphics::suggest_reduced_far_detail(crate::graphics::lod_capped(&info)); let size = window.inner_size(); - let (config, present_modes) = if let Some(surface) = &surface { + let (config, present_modes, hdr_capable) = if let Some(surface) = &surface { let mut config = surface .get_default_config(&adapter, size.width.max(1), size.height.max(1)) .ok_or("surface has no supported configuration")?; @@ -1065,7 +1085,7 @@ impl Renderer { )); } surface.configure(&device, &config); - (config, caps.present_modes.clone()) + (config, caps.present_modes.clone(), hdr::supported(&caps)) } else { let format = wgpu::TextureFormat::Bgra8Unorm; let config = wgpu::SurfaceConfiguration { @@ -1079,7 +1099,7 @@ impl Renderer { view_formats: vec![format], color_space: wgpu::SurfaceColorSpace::default(), }; - (config, Vec::new()) + (config, Vec::new(), false) }; let offscreen = surface .is_none() @@ -1923,14 +1943,20 @@ impl Renderer { compilation_options: Default::default(), targets: &[Some(wgpu::ColorTargetState { format: config.format.remove_srgb_suffix(), - // RenderPipelines.CELESTIAL: additive (src alpha, one). + // RenderPipelines.CELESTIAL: additive (src alpha, one). The + // alpha goes to 0: HDR output (hdr.wgsl) lets the sun and + // moon shine; nothing else reads the frame's alpha. blend: Some(wgpu::BlendState { color: wgpu::BlendComponent { src_factor: wgpu::BlendFactor::SrcAlpha, dst_factor: wgpu::BlendFactor::One, operation: wgpu::BlendOperation::Add, }, - alpha: wgpu::BlendComponent::OVER, + alpha: wgpu::BlendComponent { + src_factor: wgpu::BlendFactor::Zero, + dst_factor: wgpu::BlendFactor::Zero, + operation: wgpu::BlendOperation::Add, + }, }), write_mask: wgpu::ColorWrites::ALL, })], @@ -2367,6 +2393,7 @@ impl Renderer { mip_levels, mipmaps: mip_levels - 1, terrain_layout: bindings, + terrain_sprites: sprite_constants.map(|(_, v)| v), sprite_sampler, lightmap_view, lightmap_sampler, @@ -2388,7 +2415,7 @@ impl Renderer { lod_cutout: Default::default(), lod_retiring: Default::default(), lod_pending: None, - detail_columns: HashMap::new(), + detail_columns: Default::default(), detail_revision: 0, arena, sorted_indices, @@ -2409,12 +2436,14 @@ impl Renderer { solid_runs: page_runs::PageRuns::default(), phase2_runs: page_runs::PageRuns::default(), shadow_runs: page_runs::PageRuns::default(), - block_entities: HashMap::new(), + block_entities: Default::default(), block_entity_revision: next_block_entity_revision(), occlusion: occlusion::Occlusion::new(crate::chunk::MIN_Y, crate::chunk::HEIGHT / 16), world_post, + hdr: None, + hdr_capable, pack_post: None, - native_post: None, + native: None, pass_timing: pack_timing::PassTiming::logging(), pack_entity_rest: Vec::new(), cloud_bindings, @@ -2482,7 +2511,12 @@ impl Renderer { // Wayland allows only one tearing-control object per window surface. self.release_surface(); let surface = self.instance.create_surface(self.window.clone())?; - surface.configure(&self.device, &self.config); + Self::configure( + &self.device, + &surface, + &self.surface_config(), + self.hdr.as_ref(), + ); self.surface = Some(surface); Ok(()) } @@ -2545,7 +2579,12 @@ impl Renderer { && let Some(surface) = &self.surface { self.config.present_mode = mode; - surface.configure(&self.device, &self.config); + Self::configure( + &self.device, + surface, + &self.surface_config(), + self.hdr.as_ref(), + ); } } pub fn resize(&mut self, width: u32, height: u32) { @@ -2556,7 +2595,12 @@ impl Renderer { self.config.width = width; self.config.height = height; if let Some(surface) = &self.surface { - surface.configure(&self.device, &self.config); + Self::configure( + &self.device, + surface, + &self.surface_config(), + self.hdr.as_ref(), + ); } else { self.offscreen = Some(Self::offscreen_target(&self.device, &self.config)); } @@ -2845,20 +2889,106 @@ impl Renderer { self.detail_columns.insert(column, next); } } - pub fn remove(&mut self, key: SectionKey) { - self.set_detail(key, false); - if self.block_entities.remove(&key).is_some() { + /// Every section of these columns goes: one lookup per column where the + /// tables are by column, and the meshes' ranges freed in one batch. A + /// teleport removes a few thousand columns in one frame. + pub fn remove_columns(&mut self, columns: impl IntoIterator) { + let mut released = Vec::new(); + let mut block_entities = false; + for (x, z) in columns { + if self.detail_columns.remove(&(x, z)) == Some(COMPLETE_COLUMN) { + self.detail_revision += 1; + } + self.occlusion.remove_column(x, z); + let retiring = !self.lod_cutout.is_empty() && self.lod_cutout.contains(&(x, z)); + for sy in 0..crate::chunk::SECTIONS as i32 { + let key = (x, sy, z); + block_entities |= self.block_entities.remove(&key).is_some(); + if retiring { + // Distant tiles still leave its column out: drawn until they don't. + self.lod_retiring.insert(key); + } else if let Some(section) = self.sections.remove(key) { + released.push(section); + } + } + } + if block_entities { self.block_entity_revision = next_block_entity_revision(); } - self.occlusion.remove(key); - if !self.lod_cutout.is_empty() && self.lod_cutout.contains(&(key.0, key.2)) { - // Distant tiles still leave its column out: drawn until they don't. - self.lod_retiring.insert(key); - } else { - self.release_section(key); + if let Some(flat) = &mut self.flat { + for id in released.iter().filter_map(|s| s.flat_id) { + flat.remove(id); + } } + self.sorted_indices + .release_all(released.iter().filter_map(|s| { + let (page, start) = s.sorted_indices?; + Some((page, start, u64::from(s.translucent) * 6)) + })); + self.arena.release_all( + released + .iter() + .map(|s| (s.page, s.start, u64::from(s.solid + s.translucent) * 4)), + ); } /// Horizon's resolution scale (world pixels per window pixel) and FXAA. + /// Configures `surface` and, while HDR output is on, sends its HDR metadata + /// again: a new swapchain starts without it. + fn configure( + device: &wgpu::Device, + surface: &wgpu::Surface<'_>, + config: &wgpu::SurfaceConfiguration, + hdr: Option<&hdr::Hdr>, + ) { + surface.configure(device, config); + if let Some(hdr) = hdr { + horizon_hdr::set_metadata(device, surface, hdr.paper_white, hdr.peak); + } + } + fn configure_surface(&self) { + if let Some(surface) = &self.surface { + Self::configure( + &self.device, + surface, + &self.surface_config(), + self.hdr.as_ref(), + ); + } + } + fn send_hdr_metadata(&self) { + if let (Some(surface), Some(hdr)) = (&self.surface, &self.hdr) { + horizon_hdr::set_metadata(&self.device, surface, hdr.paper_white, hdr.peak); + } + } + /// The swapchain's configuration: `config` (what every pipeline draws in), or + /// scRGB while HDR output is on. + fn surface_config(&self) -> wgpu::SurfaceConfiguration { + let mut config = self.config.clone(); + if self.hdr.is_some() { + config.format = hdr::FORMAT; + config.view_formats = vec![hdr::FORMAT]; + config.color_space = hdr::COLOR_SPACE; + config.usage = wgpu::TextureUsages::RENDER_ATTACHMENT; + } + config + } + /// HDR output (Horizon setting): scRGB at `paper_white` nits, the world's + /// highlights expanded up to `peak` nits. Off where the surface can't present it. + pub fn set_hdr(&mut self, on: bool, paper_white: f32, peak: f32) { + let on = on && self.hdr_capable && self.surface.is_some(); + if on != self.hdr.is_some() { + self.hdr = + on.then(|| hdr::Hdr::new(&self.device, self.config.format.remove_srgb_suffix())); + self.configure_surface(); + } + if let Some(hdr) = &mut self.hdr + && (hdr.paper_white, hdr.peak) != (paper_white, peak) + { + hdr.paper_white = paper_white; + hdr.peak = peak; + self.send_hdr_metadata(); + } + } pub fn set_world_post(&mut self, scale: f32, antialias: bool) { self.world_post.scale = scale.clamp(0.25, 2.0); self.world_post.antialias = antialias; @@ -2924,41 +3054,40 @@ impl Renderer { }); self.pack_post = Some((dimension, post)); if self.pack_post.as_ref().is_some_and(|p| p.1.is_some()) { - self.native_post = None; + self.native = None; } report } /// Drops the running shader pack, of either kind. pub fn drop_shader_packs(&mut self) { self.pack_post = None; - self.native_post = None; + self.native = None; self.pack_atlas = None; } - /// Runs the post passes of one of Horizon's own shader packs over the world from now on - /// (`None`: no pack), with its options' values; replaces a `shaders/` pack. Returns the - /// passes' labels; on an error the passes that ran keep running. + /// Runs the sky, material and post stages of one of Horizon's own shader packs from now + /// on (`None`: no pack), with its options' values; replaces a `shaders/` pack. Returns the + /// stages' labels; on an error the pack that ran keeps running. pub fn set_native_shader_pack( &mut self, pack: Option<(horizon_shader_api::Report, Vec<(String, f64)>)>, ) -> std::result::Result, String> { - let stages = pack.map(|(report, constants)| { - let post: Vec<_> = report - .stages - .into_iter() - .filter(|s| s.kind == horizon_shader_api::StageKind::Post) - .collect(); - (post, constants) - }); - let Some((post, constants)) = stages.filter(|(post, _)| !post.is_empty()) else { - self.native_post = None; + let Some((report, constants)) = pack else { + self.native = None; return Ok(Vec::new()); }; - let format = self.config.format.remove_srgb_suffix(); - let post = native_post::NativePost::new(&self.device, post, &constants, format)?; - let labels = post.labels().into_iter().map(str::to_owned).collect(); - self.pack_post = None; - self.pack_atlas = None; - self.native_post = Some(post); + let terrain = native_material::TerrainShape { + globals: &self.terrain_layout, + flat: self.flat.as_ref().map(|f| &f.draw_layout), + sprites: self.terrain_sprites, + format: self.config.format.remove_srgb_suffix(), + }; + let (pack, labels) = + native_pack::NativePack::new(&self.device, &terrain, report, &constants)?; + self.native = pack.draws().then_some(pack); + if self.native.is_some() { + self.pack_post = None; + self.pack_atlas = None; + } Ok(labels) } /// What a shader pack's gbuffers programs read from Horizon's geometry: the sky's, and @@ -3009,20 +3138,20 @@ impl Renderer { /// The running shader pack's timer, of either kind. fn pass_timer<'a>( pack: &'a mut Option<(i32, Option)>, - native: &'a mut Option, + native: &'a mut Option, ) -> Option<&'a mut Option> { match (pack, native) { (Some((_, Some(post))), _) => Some(&mut post.timing), - (_, Some(post)) => Some(&mut post.timing), + (_, Some(native)) => Some(&mut native.timing), _ => None, } } /// Each pass of the running shader pack with its median GPU time in milliseconds, while /// they are timed (`set_pass_timing`). pub fn shader_pass_times(&self) -> Vec<(String, f32)> { - let timer = match (&self.pack_post, &self.native_post) { + let timer = match (&self.pack_post, &self.native) { (Some((_, Some(post))), _) => post.timing.as_ref(), - (_, Some(post)) => post.timing.as_ref(), + (_, Some(native)) => native.timing.as_ref(), _ => None, }; timer @@ -3195,7 +3324,12 @@ impl Renderer { } Some(wgpu::CurrentSurfaceTexture::Outdated) => { if let Some(surface) = &self.surface { - surface.configure(&self.device, &self.config); + Self::configure( + &self.device, + surface, + &self.surface_config(), + self.hdr.as_ref(), + ); } return Ok(false); } @@ -3207,9 +3341,11 @@ impl Renderer { return Err("surface acquisition failed validation".into()); } }; - let target_texture = match &surface_frame { - Some(f) => f.texture.clone(), - None => self.offscreen.clone().ok_or("no offscreen target")?, + let size = [self.config.width, self.config.height]; + let target_texture = match (&surface_frame, &mut self.hdr) { + (Some(_), Some(hdr)) => hdr.frame(&self.device, size), + (Some(f), None) => f.texture.clone(), + (None, _) => self.offscreen.clone().ok_or("no offscreen target")?, }; // One command buffer for the frame, after the section copies staged // since the last one: Metal commits every command buffer wgpu-core @@ -4052,8 +4188,8 @@ impl Renderer { // The world's targets: the screen, or the scaled target of `post`. let pack_post = !frame.title && self.pack_post.as_ref().is_some_and(|p| p.1.is_some()); // One of Horizon's own packs reads the same world target. - let native_post = !frame.title && self.native_post.is_some(); - if let Some(timer) = Self::pass_timer(&mut self.pack_post, &mut self.native_post) + let native_post = !frame.title && self.native.as_ref().is_some_and(|n| n.post.is_some()); + if let Some(timer) = Self::pass_timer(&mut self.pack_post, &mut self.native) && timer.is_some() != self.pass_timing { *timer = self @@ -4115,24 +4251,94 @@ impl Renderer { cull.bind_depth(&self.device, world_depth); } let cull = self.cull.as_ref().filter(|_| culling && solid_draws > 0); + let clear = if frame.title || (frame.end_sky && !frame.underwater) { + wgpu::Color::BLACK + } else { + wgpu::Color { + r: f64::from(fog_color[0]), + g: f64::from(fog_color[1]), + b: f64::from(fog_color[2]), + a: 1.0, + } + }; + let sky_visible = sky_open(frame); + // One of Horizon's own packs: this frame's inputs; in a timed frame its sky draws in a + // pass of its own, so that it has a time of its own. + let mut native_sky_pass = false; + if !frame.title + && let Some(native) = &mut self.native + { + let size = self + .world_post + .size() + .filter(|_| scaled.is_some()) + .unwrap_or([self.config.width, self.config.height]); + native.frame.write(&self.queue, frame, size); + if let Some(t) = &mut native.timing { + t.begin(&self.device, &self.queue); + native_sky_pass = + native.sky.is_some() && t.recording() && sky_visible && frame.skybox; + } + } + if native_sky_pass + && let Some(native) = &mut self.native + && let Some(sky) = &native.sky + { + if let Some(t) = &mut native.timing { + let format = self.config.format.remove_srgb_suffix(); + t.mark(&self.device, &mut encoder, (world_view, format)); + } + let mut pass = encoder.begin_render_pass(&wgpu::RenderPassDescriptor { + label: Some(&sky.label), + color_attachments: &[Some(wgpu::RenderPassColorAttachment { + view: world_view, + resolve_target: None, + depth_slice: None, + ops: wgpu::Operations { + load: wgpu::LoadOp::Clear(clear), + store: wgpu::StoreOp::Store, + }, + })], + depth_stencil_attachment: Some(wgpu::RenderPassDepthStencilAttachment { + view: world_depth, + depth_ops: Some(wgpu::Operations { + load: wgpu::LoadOp::Clear(0.0), + store: wgpu::StoreOp::Discard, + }), + stencil_ops: None, + }), + timestamp_writes: native.timing.as_mut().and_then(|t| t.writes(&sky.label)), + ..Default::default() + }); + pass.set_bind_group(0, &self.group, &[]); + sky.draw(&mut pass, &native.frame); + } + // One of Horizon's own packs with a material stage: terrain draws with its pipelines, + // which read the pack's frame at group 3. + let material = self + .native + .as_ref() + .filter(|_| !frame.title) + .and_then(|n| Some((n.material.as_ref()?, &n.frame.group))); + let solid_pipeline = material.map_or(&self.solid, |(m, _)| &m.solid); + let translucent_pipeline = material.map_or(&self.translucent, |(m, _)| &m.translucent); + let pack_flat = material.and_then(|(m, _)| m.flat.as_ref()); + let pack_frame = |pass: &mut wgpu::RenderPass<'_>| { + if let Some((_, group)) = material { + pass.set_bind_group(horizon_shader_api::stages::GROUP, group, &[]); + } + }; { let attachments = [Some(wgpu::RenderPassColorAttachment { view: world_view, resolve_target: None, depth_slice: None, ops: wgpu::Operations { - load: wgpu::LoadOp::Clear( - if frame.title || (frame.end_sky && !frame.underwater) { - wgpu::Color::BLACK - } else { - wgpu::Color { - r: f64::from(fog_color[0]), - g: f64::from(fog_color[1]), - b: f64::from(fog_color[2]), - a: 1.0, - } - }, - ), + load: if native_sky_pass { + wgpu::LoadOp::Load + } else { + wgpu::LoadOp::Clear(clear) + }, store: wgpu::StoreOp::Store, }, })]; @@ -4155,11 +4361,20 @@ impl Renderer { ..Default::default() }); pass.set_bind_group(0, &self.group, &[]); - let sky_visible = sky_open(frame); + pack_frame(&mut pass); if frame.title || (sky_visible && (frame.skybox || frame.end_sky)) { - if !frame.title && frame.skybox && !pack_draws_sky { - pass.set_pipeline(&self.sky); - pass.draw(0..3, 0..1); + if !frame.title && frame.skybox && !pack_draws_sky && !native_sky_pass { + match self + .native + .as_ref() + .and_then(|n| Some((n.sky.as_ref()?, &n.frame))) + { + Some((sky, native)) => sky.draw(&mut pass, native), + None => { + pass.set_pipeline(&self.sky); + pass.draw(0..3, 0..1); + } + } } if frame.title { self.panorama.draw(&mut pass); @@ -4195,7 +4410,7 @@ impl Renderer { pass.set_index_buffer(self.indices.slice(..), wgpu::IndexFormat::Uint32); } Some(flat) => { - pass.set_pipeline(&flat.solid); + pass.set_pipeline(pack_flat.map_or(&flat.solid, |p| &p.0)); let vertices = |p| self.arena.buffer(p); match cull { // As below: phase 1, the test, then phase 2's draws @@ -4213,7 +4428,8 @@ impl Renderer { pack_reads_world, ); pass.set_bind_group(0, &self.group, &[]); - pass.set_pipeline(&flat.solid); + pack_frame(&mut pass); + pass.set_pipeline(pack_flat.map_or(&flat.solid, |p| &p.0)); flat.draw_phase2(&mut pass, vertices); } None => flat.draw(&mut pass, &flat.calls[..flat.solid_calls], vertices), @@ -4222,7 +4438,7 @@ impl Renderer { pass.set_index_buffer(self.indices.slice(..), wgpu::IndexFormat::Uint32); } None => { - pass.set_pipeline(&self.solid); + pass.set_pipeline(solid_pipeline); pass.set_index_buffer(self.indices.slice(..), wgpu::IndexFormat::Uint32); pass.set_vertex_buffer(1, self.instances.slice(..)); match cull { @@ -4242,7 +4458,8 @@ impl Renderer { pack_reads_world, ); pass.set_bind_group(0, &self.group, &[]); - pass.set_pipeline(&self.solid); + pack_frame(&mut pass); + pass.set_pipeline(solid_pipeline); pass.set_index_buffer( self.indices.slice(..), wgpu::IndexFormat::Uint32, @@ -4334,7 +4551,7 @@ impl Renderer { // The pack draws translucent terrain after its deferred programs. _ if pack_draws_water => {} Some(flat) => { - pass.set_pipeline(&flat.translucent); + pass.set_pipeline(pack_flat.map_or(&flat.translucent, |p| &p.1)); flat.draw(&mut pass, flat.translucent_calls(), |p| { self.arena.buffer(p) }); @@ -4342,7 +4559,7 @@ impl Renderer { pass.set_index_buffer(self.indices.slice(..), wgpu::IndexFormat::Uint32); } None => { - pass.set_pipeline(&self.translucent); + pass.set_pipeline(translucent_pipeline); pass.set_index_buffer(self.indices.slice(..), wgpu::IndexFormat::Uint32); pass.set_vertex_buffer(1, self.instances.slice(..)); self.draw_sections( @@ -4511,21 +4728,24 @@ impl Renderer { self.pack_post = Some((dimension, Some(post))); } else if let Some((color, depth)) = &scaled && native_post - && let Some(post) = &mut self.native_post + && let Some(native) = &mut self.native + && let Some(post) = &mut native.post { let size = self.world_post.size().unwrap_or([1, 1]); post.run( &self.device, - &self.queue, &mut encoder, (color, depth), &view_target, - frame, size, + native.timing.as_mut(), ); } else if scaled.is_some() { self.world_post.finish(&mut encoder, &view_target); } + if let Some(hdr) = &self.hdr { + hdr.keep_world(&mut encoder); + } if hand_quads > 0 && !pack_draws_hand { let attachments = [Some(wgpu::RenderPassColorAttachment { view: &view_target, @@ -4680,6 +4900,9 @@ impl Renderer { self.section_copy_bytes = 0; self.section_uploads.finish(&encoder); } + if let (Some(hdr), Some(f)) = (&self.hdr, &surface_frame) { + hdr.present(&self.queue, &mut encoder, &f.texture, !frame.title); + } let commands = crate::spans::time("encode", || encoder.finish()); let first_frame = self.first_frame == FirstFrame::Submit; if first_frame { @@ -4694,7 +4917,7 @@ impl Renderer { timer.submitted(&self.queue); timer.collect(&self.device, &mut self.gpu_times); } - if let Some(Some(timer)) = Self::pass_timer(&mut self.pack_post, &mut self.native_post) { + if let Some(Some(timer)) = Self::pass_timer(&mut self.pack_post, &mut self.native) { timer.submitted(&self.queue); } if let Some((path, buffer)) = readback { @@ -4716,7 +4939,12 @@ impl Renderer { } self.queue.present(surface_frame); if reconfigure && let Some(surface) = &self.surface { - surface.configure(&self.device, &self.config); + Self::configure( + &self.device, + surface, + &self.surface_config(), + self.hdr.as_ref(), + ); } } else { // No swapchain paces offscreen frames: keep two on the GPU at most. diff --git a/crates/horizon-client/src/gfx/arena.rs b/crates/horizon-client/src/gfx/arena.rs index 34b4d332d..8f320a408 100644 --- a/crates/horizon-client/src/gfx/arena.rs +++ b/crates/horizon-client/src/gfx/arena.rs @@ -39,6 +39,35 @@ impl FreeList { } self.0.insert(start, len); } + /// `give` for many ranges: one merge of the sorted ranges into the list, + /// where giving them one by one costs a few tree lookups each. + fn give_all(&mut self, mut ranges: Vec<(u64, u64)>) { + if ranges.len() < 64 { + for (start, len) in ranges { + self.give(start, len); + } + return; + } + ranges.sort_unstable(); + let mut free = std::mem::take(&mut self.0).into_iter().peekable(); + let mut given = ranges.into_iter().peekable(); + let mut merged: Vec<(u64, u64)> = Vec::new(); + loop { + let next = match (free.peek(), given.peek()) { + (Some(a), Some(b)) if a.0 <= b.0 => free.next(), + (_, Some(_)) => given.next(), + (Some(_), None) => free.next(), + (None, None) => break, + }; + let (start, len) = next.expect("peeked"); + match merged.last_mut() { + Some(last) if last.0 + last.1 == start => last.1 += len, + _ => merged.push((start, len)), + } + } + // Sorted: the tree is built in one pass. + self.0 = merged.into_iter().collect(); + } } /// One vertex buffer of the arena; only the newest page grows. @@ -237,6 +266,26 @@ impl Arena { .free .give(start, len); } + /// `release` for many ranges (page, start, vertices) at once. + pub fn release_all(&mut self, ranges: impl IntoIterator) { + let mut by_page: Vec> = Vec::new(); + for (page, start, vertices) in ranges { + let page = page as usize; + if by_page.len() <= page { + by_page.resize_with(page + 1, Vec::new); + } + by_page[page].push((start, Self::span(vertices).min(self.page_limit))); + } + for (page, ranges) in by_page.into_iter().enumerate() { + if !ranges.is_empty() { + self.pages[page] + .as_mut() + .expect("live arena page") + .free + .give_all(ranges); + } + } + } /// Moves a page into a larger buffer; false (the page unchanged) when /// there is no memory for it. fn grow( @@ -435,6 +484,44 @@ mod tests { assert_eq!(free, FreeList::new(4 * GRAIN)); } + #[test] + fn many_ranges_given_at_once_coalesce_as_one_by_one() { + let fill = || { + let mut free = FreeList::new(1 << 30); + let taken: Vec<(u64, u64)> = (0..500u64) + .map(|i| { + let len = GRAIN * (1 + i * 7 % 5); + (free.take(len).unwrap(), len) + }) + .collect(); + for &(start, len) in taken.iter().step_by(3) { + free.give(start, len); + } + (free, taken) + }; + // Every other range of those still taken, in a scattered order. + let (mut one_by_one, taken) = fill(); + let (mut at_once, _) = fill(); + let mut given: Vec<(u64, u64)> = (0..taken.len()) + .filter(|i| i % 3 != 0 && i % 2 == 0) + .map(|i| taken[i]) + .collect(); + given.sort_by_key(|&(start, _)| start.wrapping_mul(0x9E37_79B9_7F4A_7C15)); + assert!(given.len() >= 64); + for &(start, len) in &given { + one_by_one.give(start, len); + } + at_once.give_all(given); + assert_eq!(at_once, one_by_one); + // The rest too: everything is free again, in one range. + let rest: Vec<(u64, u64)> = (0..taken.len()) + .filter(|i| i % 3 != 0 && i % 2 != 0) + .map(|i| taken[i]) + .collect(); + at_once.give_all(rest); + assert_eq!(at_once, FreeList::new(1 << 30)); + } + #[test] fn first_fit_reuses_the_lowest_hole() { let mut free = FreeList::new(8 * GRAIN); diff --git a/crates/horizon-client/src/gfx/hdr.rs b/crates/horizon-client/src/gfx/hdr.rs new file mode 100644 index 000000000..11deed546 --- /dev/null +++ b/crates/horizon-client/src/gfx/hdr.rs @@ -0,0 +1,222 @@ +//! HDR output (Horizon setting, off by default): the frame renders exactly as +//! without it, into an 8-bit target in vanilla's gamma space, and one pass +//! (`hdr.wgsl`) writes it to an scRGB swapchain at the player's paper white, +//! expanding the world's highlights towards their peak brightness. The world +//! is copied aside before the hand and HUD so only it is expanded. + +/// The swapchain format and colour space HDR output presents in. +pub const FORMAT: wgpu::TextureFormat = wgpu::TextureFormat::Rgba16Float; +pub const COLOR_SPACE: wgpu::SurfaceColorSpace = wgpu::SurfaceColorSpace::ExtendedSrgbLinear; + +/// Whether `caps` can present scRGB. +pub fn supported(caps: &wgpu::SurfaceCapabilities) -> bool { + caps.color_spaces(FORMAT) + .contains(wgpu::SurfaceColorSpaces::EXTENDED_SRGB_LINEAR) +} + +struct Targets { + size: [u32; 2], + frame: wgpu::Texture, + world: wgpu::Texture, + group: wgpu::BindGroup, +} + +pub struct Hdr { + layout: wgpu::BindGroupLayout, + pipeline: wgpu::RenderPipeline, + params: wgpu::Buffer, + /// The frame's format: what every other pipeline draws in. + format: wgpu::TextureFormat, + targets: Option, + /// `HORIZON_HDR_DEBUG=1`: paint expanded pixels magenta. + debug: bool, + /// Paper white and peak brightness, in nits. + pub paper_white: f32, + pub peak: f32, +} + +impl Hdr { + pub fn new(device: &wgpu::Device, format: wgpu::TextureFormat) -> Self { + let shader = device.create_shader_module(wgpu::ShaderModuleDescriptor { + label: Some("Horizon HDR"), + source: wgpu::ShaderSource::Wgsl(include_str!("../hdr.wgsl").into()), + }); + let texture = |binding| wgpu::BindGroupLayoutEntry { + binding, + visibility: wgpu::ShaderStages::FRAGMENT, + ty: wgpu::BindingType::Texture { + sample_type: wgpu::TextureSampleType::Float { filterable: false }, + view_dimension: wgpu::TextureViewDimension::D2, + multisampled: false, + }, + count: None, + }; + let layout = device.create_bind_group_layout(&wgpu::BindGroupLayoutDescriptor { + label: Some("Horizon HDR bindings"), + entries: &[ + texture(0), + texture(1), + wgpu::BindGroupLayoutEntry { + binding: 2, + visibility: wgpu::ShaderStages::FRAGMENT, + ty: wgpu::BindingType::Buffer { + ty: wgpu::BufferBindingType::Uniform, + has_dynamic_offset: false, + min_binding_size: None, + }, + count: None, + }, + ], + }); + let pipeline_layout = device.create_pipeline_layout(&wgpu::PipelineLayoutDescriptor { + label: Some("Horizon HDR"), + bind_group_layouts: &[Some(&layout)], + ..Default::default() + }); + let pipeline = device.create_render_pipeline(&wgpu::RenderPipelineDescriptor { + label: Some("Horizon HDR"), + layout: Some(&pipeline_layout), + vertex: wgpu::VertexState { + module: &shader, + entry_point: Some("vs_hdr"), + compilation_options: Default::default(), + buffers: &[], + }, + primitive: Default::default(), + depth_stencil: None, + multisample: Default::default(), + fragment: Some(wgpu::FragmentState { + module: &shader, + entry_point: Some("fs_hdr"), + compilation_options: Default::default(), + targets: &[Some(wgpu::ColorTargetState { + format: FORMAT, + blend: None, + write_mask: wgpu::ColorWrites::ALL, + })], + }), + multiview_mask: None, + cache: None, + }); + let params = device.create_buffer(&wgpu::BufferDescriptor { + label: Some("Horizon HDR parameters"), + size: 16, + usage: wgpu::BufferUsages::UNIFORM | wgpu::BufferUsages::COPY_DST, + mapped_at_creation: false, + }); + Self { + layout, + pipeline, + params, + format, + targets: None, + debug: std::env::var_os("HORIZON_HDR_DEBUG").is_some_and(|v| v == "1"), + paper_white: 200.0, + peak: 1000.0, + } + } + + /// The 8-bit frame every pass draws into this frame, sized like the window. + pub fn frame(&mut self, device: &wgpu::Device, size: [u32; 2]) -> wgpu::Texture { + if self.targets.as_ref().is_none_or(|t| t.size != size) { + let texture = |label, usage| { + device.create_texture(&wgpu::TextureDescriptor { + label: Some(label), + size: wgpu::Extent3d { + width: size[0].max(1), + height: size[1].max(1), + depth_or_array_layers: 1, + }, + mip_level_count: 1, + sample_count: 1, + dimension: wgpu::TextureDimension::D2, + format: self.format, + usage: usage | wgpu::TextureUsages::TEXTURE_BINDING, + view_formats: &[], + }) + }; + let frame = texture( + "Horizon HDR frame", + wgpu::TextureUsages::RENDER_ATTACHMENT | wgpu::TextureUsages::COPY_SRC, + ); + let world = texture("Horizon HDR world", wgpu::TextureUsages::COPY_DST); + let view = |t: &wgpu::Texture| t.create_view(&Default::default()); + let group = device.create_bind_group(&wgpu::BindGroupDescriptor { + label: Some("Horizon HDR bindings"), + layout: &self.layout, + entries: &[ + wgpu::BindGroupEntry { + binding: 0, + resource: wgpu::BindingResource::TextureView(&view(&frame)), + }, + wgpu::BindGroupEntry { + binding: 1, + resource: wgpu::BindingResource::TextureView(&view(&world)), + }, + wgpu::BindGroupEntry { + binding: 2, + resource: self.params.as_entire_binding(), + }, + ], + }); + self.targets = Some(Targets { + size, + frame, + world, + group, + }); + } + self.targets.as_ref().unwrap().frame.clone() + } + + /// Keeps the world as drawn so far, before the hand and HUD cover it. + pub fn keep_world(&self, encoder: &mut wgpu::CommandEncoder) { + let Some(t) = &self.targets else { + return; + }; + encoder.copy_texture_to_texture( + t.frame.as_image_copy(), + t.world.as_image_copy(), + t.frame.size(), + ); + } + + /// Writes the finished frame to the swapchain image `target`. + pub fn present( + &self, + queue: &wgpu::Queue, + encoder: &mut wgpu::CommandEncoder, + target: &wgpu::Texture, + world: bool, + ) { + let Some(t) = &self.targets else { + return; + }; + let paper = self.paper_white.max(1.0); + let params = [ + paper / 80.0, + (self.peak / paper).max(1.0), + f32::from(u8::from(world)), + f32::from(u8::from(self.debug)), + ]; + queue.write_buffer(&self.params, 0, bytemuck::cast_slice(¶ms)); + let view = target.create_view(&Default::default()); + let attachments = [Some(wgpu::RenderPassColorAttachment { + view: &view, + resolve_target: None, + depth_slice: None, + ops: wgpu::Operations { + load: wgpu::LoadOp::Clear(wgpu::Color::BLACK), + store: wgpu::StoreOp::Store, + }, + })]; + let mut pass = encoder.begin_render_pass(&wgpu::RenderPassDescriptor { + label: Some("Horizon HDR"), + color_attachments: &attachments, + ..Default::default() + }); + pass.set_pipeline(&self.pipeline); + pass.set_bind_group(0, &t.group, &[]); + pass.draw(0..3, 0..1); + } +} diff --git a/crates/horizon-client/src/gfx/native_material.rs b/crates/horizon-client/src/gfx/native_material.rs new file mode 100644 index 000000000..e7f8f7bf2 --- /dev/null +++ b/crates/horizon-client/src/gfx/native_material.rs @@ -0,0 +1,328 @@ +//! The material stage of Horizon's own shader packs (docs/shaders.md): the pack's `material` +//! function gives the lit colour of each point of a block's surface, before the alpha test and +//! fog. Terrain still draws with Horizon's meshes, culling and draw lists; only its pipelines +//! change. Their shader is the pack's stage (`CheckedStage::source`), then a copy of +//! terrain.wgsl's terrain section whose names all take a `horizon_terrain_` prefix +//! (`wgsl_prefix.rs`), then entries that hand the pack what vanilla's `fs_solid` and +//! `fs_translucent` combine: the texture, the vertex tint, the light levels and the lightmap's +//! colour. They read the terrain's group 0, the flat draws' group 1 where those run, and the +//! pack's frame at group 3. + +use horizon_shader_api::{check::CheckedStage, stages::GROUP}; + +use super::native_post::{NativeFrame, present_constants}; +use super::wgsl_prefix::{TERRAIN, prefixed, section}; + +const PREFIX: &str = "horizon_terrain_"; + +/// The entries around the pack's `material`: vanilla's vertex work without the lightmap +/// product, then the material, the alpha test and fog as `fs_solid` and `fs_translucent` do. +const ENTRIES: &str = " +struct HorizonMaterialOut { + @builtin(position) clip: vec4, + @location(0) uv: vec2, + @location(1) @interpolate(flat) layer: u32, + @location(2) tint: vec4, + @location(3) light: vec2, + @location(4) lightmap: vec3, + @location(5) position: vec3, + @location(6) spherical: f32, + @location(7) cylindrical: f32, +} +fn horizon_material_vertex(position: vec3, uv: vec2, layer: u32, color: vec4, + light: vec2, origin: vec3) -> HorizonMaterialOut { + let pos = position + origin; + var out: HorizonMaterialOut; + out.clip = horizon_terrain_globals.view_proj * vec4(pos, 1.0); + out.uv = uv; + out.layer = layer; + out.tint = vec4(color.rgb, 1.0); + let block = max(f32(light.y), horizon_terrain_dynamic_block_light(pos)); + let sky = f32(light.x); + // 16 per level, 15 levels. + out.light = min(vec2(block, sky) / 240.0, vec2(1.0)); + out.lightmap = horizon_terrain_sample_lightmap(sky / 16.0, block / 16.0).rgb; + out.position = pos; + out.spherical = length(pos); + out.cylindrical = max(length(pos.xz), abs(pos.y)); + return out; +} +@vertex fn horizon_material_vs( + @location(0) position: vec3, @location(1) uv: vec2, + @location(2) layer: u32, @location(3) color: vec4, @location(4) light: vec2, + @location(5) origin: vec4) -> HorizonMaterialOut { + return horizon_material_vertex(position, horizon_terrain_terrain_uv(uv, origin.w), layer, + color, light, origin.xyz); +} +@vertex fn horizon_material_vs_flat( + @builtin(vertex_index) vertex: u32, + @location(0) position: vec3, @location(1) uv: vec2, + @location(2) layer: u32, @location(3) color: vec4, @location(4) light: vec2 +) -> HorizonMaterialOut { + let origin = horizon_terrain_slot_origins[horizon_terrain_block_slots[vertex >> 8u]]; + return horizon_material_vertex(position, horizon_terrain_terrain_uv(uv, origin.w), layer, + color, light, origin.xyz); +} +fn horizon_material_color(in: HorizonMaterialOut, translucent: bool) -> vec4 { + let albedo = horizon_terrain_sprite(in.uv, in.layer & 0x7fffu); + return material(MaterialInput(albedo, in.tint, in.light, in.lightmap, in.position, in.uv, + translucent)).color; +} +@fragment fn horizon_material_fs_solid(in: HorizonMaterialOut) -> @location(0) vec4 { + let color = horizon_material_color(in, false); + // Bit 15 of the layer marks opaque leaves (forceOpaque): no alpha cutout. + if color.a < 0.5 && (in.layer & 0x8000u) == 0u { discard; } + return horizon_terrain_apply_fog(vec4(color.rgb, 1.0), in.spherical, in.cylindrical); +} +@fragment fn horizon_material_fs_translucent(in: HorizonMaterialOut) -> @location(0) vec4 { + let color = horizon_material_color(in, true); + if color.a < 0.01 { discard; } + return horizon_terrain_apply_fog(color, in.spherical, in.cylindrical); +} +"; + +/// What terrain pipelines are built against: the renderer's layouts and constants. +pub struct TerrainShape<'a> { + /// The terrain's group 0. + pub globals: &'a wgpu::BindGroupLayout, + /// The flat draws' group 1, where they run (`flat.rs`). + pub flat: Option<&'a wgpu::BindGroupLayout>, + /// terrain.wgsl's `SPRITE_ARRAYS` and `SPRITE_SPLIT`. + pub sprites: [f64; 2], + /// The world target's colour format. + pub format: wgpu::TextureFormat, +} + +/// The pack's terrain pipelines: solid (with the cutout test) and translucent, for the +/// renderer's instanced draws and, where they run, its flat ones. +pub struct NativeMaterial { + pub solid: wgpu::RenderPipeline, + pub translucent: wgpu::RenderPipeline, + pub flat: Option<(wgpu::RenderPipeline, wgpu::RenderPipeline)>, +} + +/// terrain.wgsl's terrain section (its globals, bindings, sampling, lighting and fog), with +/// every name it declares prefixed. +fn vanilla_terrain() -> String { + prefixed( + section(TERRAIN, "struct Globals {", "// Sky (SkyRenderer)"), + PREFIX, + ) +} + +/// The terrain shader for the pack's material stage `source`. +fn shader_source(source: &str) -> String { + format!( + "{source}\n// Horizon's terrain (terrain.wgsl)\n{}{ENTRIES}", + vanilla_terrain() + ) +} + +/// The material's naga module, its errors in the stage's file. +fn module(stage: &CheckedStage) -> Result { + let text = shader_source(&stage.source); + naga::front::wgsl::parse_str(&text) + .map_err(|e| format!("{}: {}", stage.file, e.emit_to_string(&text))) +} + +impl NativeMaterial { + /// The pipelines of the pack's material `stage` with the option values `constants`. + pub fn new( + device: &wgpu::Device, + shape: &TerrainShape<'_>, + frame: &NativeFrame, + stage: &CheckedStage, + constants: &[(String, f64)], + ) -> Result { + let module = module(stage)?; + let mut constants = present_constants(&module, constants); + let sprite_names = [ + "horizon_terrain_SPRITE_ARRAYS", + "horizon_terrain_SPRITE_SPLIT", + ]; + constants.extend(sprite_names.into_iter().zip(shape.sprites)); + let scope = device.push_error_scope(wgpu::ErrorFilter::Validation); + let module = device.create_shader_module(wgpu::ShaderModuleDescriptor { + label: Some(&stage.label), + source: wgpu::ShaderSource::Naga(std::borrow::Cow::Owned(module)), + }); + let layout = |flat: Option<&wgpu::BindGroupLayout>| { + let mut groups: [Option<&wgpu::BindGroupLayout>; GROUP as usize + 1] = + Default::default(); + groups[0] = Some(shape.globals); + groups[1] = flat; + groups[GROUP as usize] = Some(&frame.layout); + device.create_pipeline_layout(&wgpu::PipelineLayoutDescriptor { + label: Some("Native shader pack terrain"), + bind_group_layouts: &groups, + ..Default::default() + }) + }; + let instance_attributes = wgpu::vertex_attr_array![5=>Float32x4]; + let vertices = wgpu::VertexBufferLayout { + array_stride: std::mem::size_of::() as u64, + step_mode: wgpu::VertexStepMode::Vertex, + attributes: &super::TERRAIN_ATTRIBUTES, + }; + let instances = wgpu::VertexBufferLayout { + array_stride: 16, + step_mode: wgpu::VertexStepMode::Instance, + attributes: &instance_attributes, + }; + // As the renderer's terrain pipelines (gfx.rs): back faces culled, reversed depth. + let pipeline = |layout: &wgpu::PipelineLayout, + vertex: &str, + buffers: &[Option>], + fragment: &str, + blend: Option| { + let options = wgpu::PipelineCompilationOptions { + constants: &constants, + ..Default::default() + }; + device.create_render_pipeline(&wgpu::RenderPipelineDescriptor { + label: Some(&stage.label), + layout: Some(layout), + vertex: wgpu::VertexState { + module: &module, + entry_point: Some(vertex), + compilation_options: options.clone(), + buffers, + }, + primitive: wgpu::PrimitiveState { + cull_mode: Some(wgpu::Face::Back), + ..Default::default() + }, + depth_stencil: Some(wgpu::DepthStencilState { + format: wgpu::TextureFormat::Depth32Float, + depth_write_enabled: Some(true), + depth_compare: Some(wgpu::CompareFunction::GreaterEqual), + stencil: Default::default(), + bias: Default::default(), + }), + multisample: Default::default(), + fragment: Some(wgpu::FragmentState { + module: &module, + entry_point: Some(fragment), + compilation_options: options, + targets: &[Some(wgpu::ColorTargetState { + format: shape.format, + blend, + write_mask: wgpu::ColorWrites::ALL, + })], + }), + multiview_mask: None, + cache: None, + }) + }; + let blend = Some(wgpu::BlendState::ALPHA_BLENDING); + let instanced = layout(None); + let buffers = [Some(vertices.clone()), Some(instances)]; + let solid = pipeline( + &instanced, + "horizon_material_vs", + &buffers, + "horizon_material_fs_solid", + None, + ); + let translucent = pipeline( + &instanced, + "horizon_material_vs", + &buffers, + "horizon_material_fs_translucent", + blend, + ); + let flat = shape.flat.map(|group| { + let layout = layout(Some(group)); + let buffers = [Some(vertices.clone())]; + let vs = "horizon_material_vs_flat"; + ( + pipeline(&layout, vs, &buffers, "horizon_material_fs_solid", None), + pipeline( + &layout, + vs, + &buffers, + "horizon_material_fs_translucent", + blend, + ), + ) + }); + if let Some(e) = pollster::block_on(scope.pop()) { + return Err(format!("{}: {e}", stage.file)); + } + Ok(Self { + solid, + translucent, + flat, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + use horizon_shader_api::{MANIFEST, Pack, StageKind, check}; + + fn stage(material: &str) -> CheckedStage { + let manifest = "schema = 1\nid = \"t\"\nname = \"T\"\nversion = \"1\"\napi = \"0.1\"\n\ + [material]\nfile = \"material.wgsl\"\n\ + [[options]]\nid = \"gain\"\nname = \"Gain\"\ntype = \"float\"\n\ + default = 1.0\nmin = 0.0\nmax = 2.0\n"; + let files = [(MANIFEST, manifest), ("material.wgsl", material)] + .map(|(n, t)| (n.to_owned(), t.as_bytes().to_vec())) + .into(); + let mut report = check(&Pack::from_files(files).unwrap()).unwrap(); + assert_eq!(report.stages[0].kind, StageKind::Material); + report.stages.remove(0) + } + + #[test] + fn the_terrain_takes_a_prefix_and_validates_with_a_pack() { + let terrain = vanilla_terrain(); + for name in [ + "Globals", + "globals", + "sprites_7", + "sprite", + "SPRITE_SPLIT", + "block_slots", + "sample_lightmap", + "apply_fog", + ] { + assert!(terrain.contains(&format!("{PREFIX}{name}")), "{name}"); + } + assert!(!terrain.contains("fs_sky"), "the sky stays out"); + // A pack may use any name Horizon's terrain uses unprefixed. + let own = "override gain: f32;\nconst PI: f32 = 3.0;\n\ + fn sprite(c: vec4) -> vec4 { return c * PI; }\n\ + fn apply_fog(c: vec4) -> vec4 { return c * gain; }\n\ + fn material(input: MaterialInput) -> Surface {\n \ + let lit = input.albedo * input.tint * vec4(input.lightmap, 1.0);\n \ + return Surface(apply_fog(sprite(lit)));\n}\n"; + let stage = stage(own); + let module = module(&stage).unwrap(); + let info = naga::valid::Validator::new( + naga::valid::ValidationFlags::all(), + naga::valid::Capabilities::all(), + ) + .validate(&module) + .unwrap_or_else(|e| panic!("{}", e.emit_to_string(&shader_source(&stage.source)))); + let entries: Vec<&str> = module + .entry_points + .iter() + .map(|e| e.name.as_str()) + .collect(); + for entry in [ + "horizon_material_vs", + "horizon_material_vs_flat", + "horizon_material_fs_solid", + "horizon_material_fs_translucent", + ] { + assert!(entries.contains(&entry), "{entry}"); + } + drop(info); + assert_eq!( + present_constants(&module, &[("gain".into(), 1.5), ("other".into(), 1.0)]), + [("gain", 1.5)] + ); + } +} diff --git a/crates/horizon-client/src/gfx/native_pack.rs b/crates/horizon-client/src/gfx/native_pack.rs new file mode 100644 index 000000000..4fb5cdc59 --- /dev/null +++ b/crates/horizon-client/src/gfx/native_pack.rs @@ -0,0 +1,74 @@ +//! One of Horizon's own shader packs while it runs (docs/shaders.md): the frame its stages +//! read, its sky, material and post stages, and the timer of their passes. + +use horizon_shader_api::{Report, StageKind}; + +use super::native_material::{NativeMaterial, TerrainShape}; +use super::native_post::{NativeFrame, NativePost}; +use super::native_sky::NativeSky; +use super::pack_timing::PassTiming; + +pub struct NativePack { + pub frame: NativeFrame, + pub sky: Option, + pub material: Option, + pub post: Option, + /// GPU time of each pass, while the renderer asks for it (`pack_timing.rs`). + pub timing: Option, +} + +impl NativePack { + /// The pack of the checked stages `report` with the option values `constants`, drawing + /// onto the world's targets as `terrain` describes; the sky reads the terrain's group 0. + /// Also returns its stages' labels, in the order they draw. Errors name the stage wgpu + /// refused. + pub fn new( + device: &wgpu::Device, + terrain: &TerrainShape<'_>, + report: Report, + constants: &[(String, f64)], + ) -> Result<(Self, Vec), String> { + let (globals, format) = (terrain.globals, terrain.format); + let frame = NativeFrame::new(device); + let (post, others): (Vec<_>, Vec<_>) = report + .stages + .into_iter() + .partition(|s| s.kind == StageKind::Post); + let sky = others + .iter() + .find(|s| s.kind == StageKind::Sky) + .map(|stage| NativeSky::new(device, globals, &frame, stage, constants, format)) + .transpose()?; + let material = others + .iter() + .find(|s| s.kind == StageKind::Material) + .map(|stage| NativeMaterial::new(device, terrain, &frame, stage, constants)) + .transpose()?; + let post = (!post.is_empty()) + .then(|| NativePost::new(device, post, constants, format, &frame)) + .transpose()?; + let mut labels: Vec = sky.iter().map(|s| s.label.clone()).collect(); + labels.extend( + others + .iter() + .filter(|s| material.is_some() && s.kind == StageKind::Material) + .map(|s| s.label.clone()), + ); + if let Some(post) = &post { + labels.extend(post.labels().into_iter().map(str::to_owned)); + } + let pack = Self { + frame, + sky, + material, + post, + timing: None, + }; + Ok((pack, labels)) + } + + /// Whether the pack draws anything the game runs today. + pub fn draws(&self) -> bool { + self.sky.is_some() || self.material.is_some() || self.post.is_some() + } +} diff --git a/crates/horizon-client/src/gfx/native_post.rs b/crates/horizon-client/src/gfx/native_post.rs index cf99b1936..89515f5db 100644 --- a/crates/horizon-client/src/gfx/native_post.rs +++ b/crates/horizon-client/src/gfx/native_post.rs @@ -3,7 +3,8 @@ //! the pack's options as pipeline constants. A pass reads bind group 3: the frame, the world's //! colour and depth, the previous pass's output and two samplers. Passes before the last write //! half-float targets of the world's size, so values over 1 carry to the next; the last draws -//! onto the screen. +//! onto the screen. Every stage of a pack reads the same `frame`, written once a frame +//! (`NativeFrame`). use glam::{Mat4, Vec3}; use horizon_shader_api::{Frame as FrameInputs, check::CheckedStage, stages::GROUP}; @@ -25,12 +26,87 @@ pub struct NativePost { targets: Option<([u32; 2], [wgpu::TextureView; 2])>, /// One bind group per pass, for these world views. groups: Option<(WorldViews, Vec)>, - start: std::time::Instant, - frames: u32, /// The screen's colour format, the world target's too. format: wgpu::TextureFormat, - /// GPU time of each pass, while the renderer asks for it (`pack_timing.rs`). - pub timing: Option, +} + +/// The `frame` every stage of a pack reads (group 3, binding 0), written once a frame. +pub struct NativeFrame { + pub(super) buffer: wgpu::Buffer, + /// Group 3 of the stages that read only the frame (the sky). + pub layout: wgpu::BindGroupLayout, + pub group: wgpu::BindGroup, + start: std::time::Instant, + frames: u32, +} + +/// The uniform `frame` at binding 0, read by `visibility`. +fn frame_entry(visibility: wgpu::ShaderStages) -> wgpu::BindGroupLayoutEntry { + wgpu::BindGroupLayoutEntry { + binding: 0, + visibility, + ty: wgpu::BindingType::Buffer { + ty: wgpu::BufferBindingType::Uniform, + has_dynamic_offset: false, + min_binding_size: wgpu::BufferSize::new(size_of::() as u64), + }, + count: None, + } +} + +impl NativeFrame { + pub fn new(device: &wgpu::Device) -> Self { + let buffer = device.create_buffer(&wgpu::BufferDescriptor { + label: Some("Native shader pack frame"), + size: size_of::() as u64, + usage: wgpu::BufferUsages::UNIFORM | wgpu::BufferUsages::COPY_DST, + mapped_at_creation: false, + }); + let layout = device.create_bind_group_layout(&wgpu::BindGroupLayoutDescriptor { + label: Some("Native shader pack frame"), + entries: &[frame_entry(wgpu::ShaderStages::VERTEX_FRAGMENT)], + }); + let group = device.create_bind_group(&wgpu::BindGroupDescriptor { + label: Some("Native shader pack frame"), + layout: &layout, + entries: &[wgpu::BindGroupEntry { + binding: 0, + resource: buffer.as_entire_binding(), + }], + }); + Self { + buffer, + layout, + group, + start: std::time::Instant::now(), + frames: 0, + } + } + + /// Writes this frame's inputs, for a world of `size`. + pub fn write(&mut self, queue: &wgpu::Queue, frame: &Frame, size: [u32; 2]) { + let seconds = self.start.elapsed().as_secs_f32() % 3600.0; + let inputs = frame_inputs(frame, size, seconds, self.frames); + self.frames = self.frames.wrapping_add(1); + queue.write_buffer(&self.buffer, 0, bytemuck::bytes_of(&inputs)); + } +} + +/// The option values of `constants` that `module` declares as overrides (wgpu refuses others). +pub fn present_constants<'a>( + module: &naga::Module, + constants: &'a [(String, f64)], +) -> Vec<(&'a str, f64)> { + constants + .iter() + .filter(|(id, _)| { + module + .overrides + .iter() + .any(|(_, o)| o.name.as_ref() == Some(id)) + }) + .map(|(id, v)| (id.as_str(), *v)) + .collect() } fn texture_entry(binding: u32, sample_type: wgpu::TextureSampleType) -> wgpu::BindGroupLayoutEntry { @@ -63,21 +139,13 @@ impl NativePost { stages: Vec, constants: &[(String, f64)], format: wgpu::TextureFormat, + frame: &NativeFrame, ) -> Result { let float = wgpu::TextureSampleType::Float { filterable: true }; let layout = device.create_bind_group_layout(&wgpu::BindGroupLayoutDescriptor { label: Some("Native shader pack post"), entries: &[ - wgpu::BindGroupLayoutEntry { - binding: 0, - visibility: wgpu::ShaderStages::FRAGMENT, - ty: wgpu::BindingType::Buffer { - ty: wgpu::BufferBindingType::Uniform, - has_dynamic_offset: false, - min_binding_size: wgpu::BufferSize::new(size_of::() as u64), - }, - count: None, - }, + frame_entry(wgpu::ShaderStages::FRAGMENT), texture_entry(1, float), texture_entry(2, wgpu::TextureSampleType::Depth), texture_entry(3, float), @@ -95,17 +163,7 @@ impl NativePost { let count = stages.len(); let mut passes = Vec::with_capacity(count); for (i, stage) in stages.into_iter().enumerate() { - let present: Vec<(&str, f64)> = constants - .iter() - .filter(|(id, _)| { - stage - .module - .overrides - .iter() - .any(|(_, o)| o.name.as_ref() == Some(id)) - }) - .map(|(id, v)| (id.as_str(), *v)) - .collect(); + let present = present_constants(&stage.module, constants); let scope = device.push_error_scope(wgpu::ErrorFilter::Validation); let module = device.create_shader_module(wgpu::ShaderModuleDescriptor { label: Some(&stage.label), @@ -145,12 +203,6 @@ impl NativePost { } passes.push((stage.label, pipeline)); } - let frame = device.create_buffer(&wgpu::BufferDescriptor { - label: Some("Native shader pack frame"), - size: size_of::() as u64, - usage: wgpu::BufferUsages::UNIFORM | wgpu::BufferUsages::COPY_DST, - mapped_at_creation: false, - }); let sampler = |label, filter| { device.create_sampler(&wgpu::SamplerDescriptor { label: Some(label), @@ -162,15 +214,12 @@ impl NativePost { Ok(Self { passes, layout, - frame, + frame: frame.buffer.clone(), linear: sampler("Native shader pack linear", wgpu::FilterMode::Linear), nearest: sampler("Native shader pack nearest", wgpu::FilterMode::Nearest), targets: None, groups: None, - start: std::time::Instant::now(), - frames: 0, format, - timing: None, }) } @@ -264,37 +313,18 @@ impl NativePost { } /// Runs the passes over the world target `world` (colour, depth) of `size`, the last onto - /// `screen`. + /// `screen`, timed by `timing` when it times this frame. pub fn run( &mut self, device: &wgpu::Device, - queue: &wgpu::Queue, encoder: &mut wgpu::CommandEncoder, world: (&wgpu::TextureView, &wgpu::TextureView), screen: &wgpu::TextureView, - frame: &Frame, - size: [u32; 2], - ) { - let seconds = self.start.elapsed().as_secs_f32() % 3600.0; - let inputs = frame_inputs(frame, size, seconds, self.frames); - self.frames = self.frames.wrapping_add(1); - self.draw(device, queue, encoder, world, screen, &inputs, size); - } - - fn draw( - &mut self, - device: &wgpu::Device, - queue: &wgpu::Queue, - encoder: &mut wgpu::CommandEncoder, - world: (&wgpu::TextureView, &wgpu::TextureView), - screen: &wgpu::TextureView, - inputs: &FrameInputs, size: [u32; 2], + mut timing: Option<&mut super::pack_timing::PassTiming>, ) { self.prepare(device, world, size); - queue.write_buffer(&self.frame, 0, bytemuck::bytes_of(inputs)); - if let Some(t) = &mut self.timing { - t.begin(device, queue); + if let Some(t) = timing.as_deref_mut() { t.mark(device, encoder, (world.0, self.format)); } let Some((_, groups)) = &self.groups else { @@ -317,7 +347,7 @@ impl NativePost { let mut pass = encoder.begin_render_pass(&wgpu::RenderPassDescriptor { label: Some(label), color_attachments: &attachments, - timestamp_writes: self.timing.as_mut().and_then(|t| t.writes(label)), + timestamp_writes: timing.as_deref_mut().and_then(|t| t.writes(label)), ..Default::default() }); pass.set_pipeline(pipeline); @@ -437,8 +467,20 @@ mod tests { .into(); let report = check(&Pack::from_files(files).unwrap()).unwrap(); let format = wgpu::TextureFormat::Rgba8Unorm; - let mut post = - NativePost::new(&device, report.stages, &[("gain".into(), 1.0)], format).unwrap(); + let frame = NativeFrame::new(&device); + queue.write_buffer( + &frame.buffer, + 0, + bytemuck::bytes_of(&FrameInputs::default()), + ); + let mut post = NativePost::new( + &device, + report.stages, + &[("gain".into(), 1.0)], + format, + &frame, + ) + .unwrap(); assert_eq!(post.labels(), ["a.wgsl", "b.wgsl"]); let usage = wgpu::TextureUsages::RENDER_ATTACHMENT | wgpu::TextureUsages::TEXTURE_BINDING; @@ -478,15 +520,7 @@ mod tests { ..Default::default() }); let view = screen.create_view(&Default::default()); - post.draw( - &device, - &queue, - &mut encoder, - (&color, &depth), - &view, - &FrameInputs::default(), - [4, 4], - ); + post.run(&device, &mut encoder, (&color, &depth), &view, [4, 4], None); let buffer = device.create_buffer(&wgpu::BufferDescriptor { label: None, size: u64::from(wgpu::COPY_BYTES_PER_ROW_ALIGNMENT * 4), diff --git a/crates/horizon-client/src/gfx/native_sky.rs b/crates/horizon-client/src/gfx/native_sky.rs new file mode 100644 index 000000000..3b3c9a3b7 --- /dev/null +++ b/crates/horizon-client/src/gfx/native_sky.rs @@ -0,0 +1,379 @@ +//! The sky stage of Horizon's own shader packs (docs/shaders.md): the pack's `sky` function, +//! called for each pixel of the sky disc with vanilla's colour along its view ray. The +//! pipeline's shader is the pack's stage (`CheckedStage::source`) followed by a copy of the +//! renderer's sky (terrain.wgsl's `Globals`, `linear_fog` and sky section) whose names all +//! take a `horizon_sky_` prefix, so none can meet a pack's (the check refuses `horizon_` +//! names). It reads the renderer's globals (group 0) and the pack's frame (group 3), and +//! draws where vanilla's sky draws; the sun, moon, stars and the dark disc are drawn over it. + +use horizon_shader_api::{check::CheckedStage, stages::GROUP}; + +use super::native_post::{NativeFrame, present_constants}; +use super::wgsl_prefix::{TERRAIN, prefixed, section}; + +const PREFIX: &str = "horizon_sky_"; + +/// The fragment entry that calls the pack: vanilla's colour in, an opaque colour out. +const PACK_ENTRY: &str = " +@fragment fn horizon_sky_fs_pack(in: horizon_sky_SkyOut) -> @location(0) vec4 { + let d = horizon_sky_view_ray(in.ndc); + return vec4(sky(SkyInput(d, vec4(horizon_sky_sky_along_ray(d), 1.0))).rgb, 1.0); +} +"; + +pub struct NativeSky { + pipeline: wgpu::RenderPipeline, + pub label: String, +} + +/// terrain.wgsl's sky with every name it declares (and `globals`) prefixed. +fn vanilla_sky() -> String { + let text = [ + section(TERRAIN, "struct Globals {", "@group(0) @binding(1)"), + section(TERRAIN, "fn linear_fog(", "fn apply_fog("), + section(TERRAIN, "struct SkyOut {", "// rendertype_lines"), + ] + .concat(); + prefixed(&text, PREFIX) +} + +/// The sky shader for the pack's sky stage `source`. +fn shader_source(source: &str) -> String { + format!( + "{source}\n// Horizon's sky (terrain.wgsl)\n{}{PACK_ENTRY}", + vanilla_sky() + ) +} + +/// A sky pipeline over `module` whose fragment entry is `fragment`. +fn pipeline( + device: &wgpu::Device, + layout: &wgpu::PipelineLayout, + module: &wgpu::ShaderModule, + fragment: &str, + constants: &[(&str, f64)], + format: wgpu::TextureFormat, +) -> wgpu::RenderPipeline { + let options = wgpu::PipelineCompilationOptions { + constants, + ..Default::default() + }; + device.create_render_pipeline(&wgpu::RenderPipelineDescriptor { + label: Some("Native shader pack sky"), + layout: Some(layout), + vertex: wgpu::VertexState { + module, + entry_point: Some("horizon_sky_vs_sky"), + compilation_options: options.clone(), + buffers: &[], + }, + primitive: Default::default(), + depth_stencil: Some(wgpu::DepthStencilState { + format: wgpu::TextureFormat::Depth32Float, + depth_write_enabled: Some(false), + depth_compare: Some(wgpu::CompareFunction::Always), + stencil: Default::default(), + bias: Default::default(), + }), + multisample: Default::default(), + fragment: Some(wgpu::FragmentState { + module, + entry_point: Some(fragment), + compilation_options: options, + targets: &[Some(wgpu::ColorTargetState { + format, + blend: None, + write_mask: wgpu::ColorWrites::ALL, + })], + }), + multiview_mask: None, + cache: None, + }) +} + +/// The sky's naga module and the layout of its pipelines: `globals` at group 0, the frame +/// at group 3. +fn build( + device: &wgpu::Device, + globals: &wgpu::BindGroupLayout, + frame: &NativeFrame, + stage: &CheckedStage, +) -> Result<(naga::Module, wgpu::PipelineLayout), String> { + let text = shader_source(&stage.source); + let module = naga::front::wgsl::parse_str(&text) + .map_err(|e| format!("{}: {}", stage.file, e.emit_to_string(&text)))?; + let mut groups: [Option<&wgpu::BindGroupLayout>; GROUP as usize + 1] = Default::default(); + groups[0] = Some(globals); + groups[GROUP as usize] = Some(&frame.layout); + let layout = device.create_pipeline_layout(&wgpu::PipelineLayoutDescriptor { + label: Some("Native shader pack sky"), + bind_group_layouts: &groups, + ..Default::default() + }); + Ok((module, layout)) +} + +impl NativeSky { + /// The pipeline of the pack's sky `stage` with the option values `constants`, drawing + /// onto the world's target of `format`; `globals` is the terrain's group 0. + pub fn new( + device: &wgpu::Device, + globals: &wgpu::BindGroupLayout, + frame: &NativeFrame, + stage: &CheckedStage, + constants: &[(String, f64)], + format: wgpu::TextureFormat, + ) -> Result { + let (module, layout) = build(device, globals, frame, stage)?; + let present = present_constants(&module, constants); + let scope = device.push_error_scope(wgpu::ErrorFilter::Validation); + let module = device.create_shader_module(wgpu::ShaderModuleDescriptor { + label: Some(&stage.label), + source: wgpu::ShaderSource::Naga(std::borrow::Cow::Owned(module)), + }); + let pipeline = pipeline( + device, + &layout, + &module, + "horizon_sky_fs_pack", + &present, + format, + ); + if let Some(e) = pollster::block_on(scope.pop()) { + return Err(format!("{}: {e}", stage.file)); + } + Ok(Self { + pipeline, + label: stage.label.clone(), + }) + } + + /// Draws the sky in a pass whose group 0 is the terrain's. + pub fn draw(&self, pass: &mut wgpu::RenderPass<'_>, frame: &NativeFrame) { + pass.set_pipeline(&self.pipeline); + pass.set_bind_group(GROUP, &frame.group, &[]); + pass.draw(0..3, 0..1); + } +} + +#[cfg(test)] +mod tests { + use super::*; + use horizon_shader_api::{Frame as FrameInputs, MANIFEST, Pack, StageKind, check}; + + fn stage(sky: &str) -> CheckedStage { + let mut manifest = "schema = 1\nid = \"t\"\nname = \"T\"\nversion = \"1\"\napi = \"0.1\"\n\ + [sky]\nfile = \"sky.wgsl\"\n" + .to_owned(); + if sky.contains("gain") { + manifest += "[[options]]\nid = \"gain\"\nname = \"Gain\"\ntype = \"float\"\n\ + default = 1.0\nmin = 0.0\nmax = 2.0\n"; + } + let manifest = manifest.as_str(); + let files = [(MANIFEST, manifest), ("sky.wgsl", sky)] + .map(|(n, t)| (n.to_owned(), t.as_bytes().to_vec())) + .into(); + let mut report = check(&Pack::from_files(files).unwrap()).unwrap(); + assert_eq!(report.stages[0].kind, StageKind::Sky); + report.stages.remove(0) + } + + #[test] + fn the_renderer_s_sky_takes_a_prefix_and_validates_with_a_pack() { + let sky = vanilla_sky(); + for name in [ + "Globals", + "SkyOut", + "view_ray", + "PI", + "sky_along_ray", + "linear_fog", + "fs_sky", + ] { + assert!(sky.contains(&format!("{PREFIX}{name}")), "{name}"); + } + // A pack may use the renderer's names for its own things. + let own = "override gain: f32;\nconst PI: f32 = 3.0;\nfn view_ray() -> f32 { return PI; }\n\ + fn sky(input: SkyInput) -> vec4 { return input.color * gain * view_ray(); }\n"; + let text = shader_source(&stage(own).source); + let module = naga::front::wgsl::parse_str(&text).unwrap_or_else(|e| { + panic!("{}", e.emit_to_string(&text)); + }); + naga::valid::Validator::new( + naga::valid::ValidationFlags::all(), + naga::valid::Capabilities::default(), + ) + .validate(&module) + .unwrap(); + } + + /// Vanilla's sky and two packs over the same globals: one that returns its input draws + /// vanilla's pixels, one that inverts them draws the inverse (and stays opaque). + #[test] + fn a_pack_gets_vanilla_s_colour_and_draws_opaque() { + let instance = wgpu::Instance::new(wgpu::InstanceDescriptor::new_without_display_handle()); + let Ok(adapter) = pollster::block_on(instance.request_adapter(&Default::default())) else { + return; + }; + let (device, queue) = + pollster::block_on(adapter.request_device(&Default::default())).unwrap(); + let format = wgpu::TextureFormat::Rgba8Unorm; + let globals_layout = device.create_bind_group_layout(&wgpu::BindGroupLayoutDescriptor { + label: None, + entries: &[wgpu::BindGroupLayoutEntry { + binding: 0, + visibility: wgpu::ShaderStages::VERTEX_FRAGMENT, + ty: wgpu::BindingType::Buffer { + ty: wgpu::BufferBindingType::Uniform, + has_dynamic_offset: false, + min_binding_size: None, + }, + count: None, + }], + }); + let mut globals: super::super::Globals = bytemuck::Zeroable::zeroed(); + globals.inverse_view = glam::Mat4::IDENTITY.to_cols_array_2d(); + globals.misc = [0.0, 0.0, 1.0, 1.0]; + globals.fog_color = [0.2, 0.4, 0.6, 1.0]; + globals.sky_color = [0.5, 0.7, 1.0, 1.0]; + globals.fog_ends = [64.0, 0.0, 0.0, 0.0]; + let globals_buffer = device.create_buffer(&wgpu::BufferDescriptor { + label: None, + size: size_of::() as u64, + usage: wgpu::BufferUsages::UNIFORM | wgpu::BufferUsages::COPY_DST, + mapped_at_creation: false, + }); + queue.write_buffer(&globals_buffer, 0, bytemuck::bytes_of(&globals)); + let globals_group = device.create_bind_group(&wgpu::BindGroupDescriptor { + label: None, + layout: &globals_layout, + entries: &[wgpu::BindGroupEntry { + binding: 0, + resource: globals_buffer.as_entire_binding(), + }], + }); + let frame = NativeFrame::new(&device); + queue.write_buffer( + &frame.buffer, + 0, + bytemuck::bytes_of(&FrameInputs::default()), + ); + + let gain = [("gain".to_owned(), 1.0)]; + let draw = |stage: &CheckedStage, vanilla: bool| -> Vec { + let sky = + NativeSky::new(&device, &globals_layout, &frame, stage, &gain, format).unwrap(); + let pipeline = if vanilla { + let (module, layout) = build(&device, &globals_layout, &frame, stage).unwrap(); + let module = device.create_shader_module(wgpu::ShaderModuleDescriptor { + label: None, + source: wgpu::ShaderSource::Naga(std::borrow::Cow::Owned(module)), + }); + pipeline(&device, &layout, &module, "horizon_sky_fs_sky", &[], format) + } else { + sky.pipeline.clone() + }; + let texture = |format, usage| { + device.create_texture(&wgpu::TextureDescriptor { + label: None, + size: wgpu::Extent3d { + width: 4, + height: 4, + depth_or_array_layers: 1, + }, + mip_level_count: 1, + sample_count: 1, + dimension: wgpu::TextureDimension::D2, + format, + usage, + view_formats: &[], + }) + }; + let color = texture( + format, + wgpu::TextureUsages::RENDER_ATTACHMENT | wgpu::TextureUsages::COPY_SRC, + ); + let depth = texture( + wgpu::TextureFormat::Depth32Float, + wgpu::TextureUsages::RENDER_ATTACHMENT, + ); + let (color_view, depth_view) = ( + color.create_view(&Default::default()), + depth.create_view(&Default::default()), + ); + let mut encoder = device.create_command_encoder(&Default::default()); + { + let mut pass = encoder.begin_render_pass(&wgpu::RenderPassDescriptor { + label: None, + color_attachments: &[Some(wgpu::RenderPassColorAttachment { + view: &color_view, + resolve_target: None, + depth_slice: None, + ops: wgpu::Operations { + load: wgpu::LoadOp::Clear(wgpu::Color::TRANSPARENT), + store: wgpu::StoreOp::Store, + }, + })], + depth_stencil_attachment: Some(wgpu::RenderPassDepthStencilAttachment { + view: &depth_view, + depth_ops: Some(wgpu::Operations { + load: wgpu::LoadOp::Clear(0.0), + store: wgpu::StoreOp::Discard, + }), + stencil_ops: None, + }), + ..Default::default() + }); + pass.set_bind_group(0, &globals_group, &[]); + pass.set_pipeline(&pipeline); + pass.set_bind_group(GROUP, &frame.group, &[]); + pass.draw(0..3, 0..1); + } + let buffer = device.create_buffer(&wgpu::BufferDescriptor { + label: None, + size: u64::from(wgpu::COPY_BYTES_PER_ROW_ALIGNMENT * 4), + usage: wgpu::BufferUsages::MAP_READ | wgpu::BufferUsages::COPY_DST, + mapped_at_creation: false, + }); + encoder.copy_texture_to_buffer( + color.as_image_copy(), + wgpu::TexelCopyBufferInfo { + buffer: &buffer, + layout: wgpu::TexelCopyBufferLayout { + offset: 0, + bytes_per_row: Some(wgpu::COPY_BYTES_PER_ROW_ALIGNMENT), + rows_per_image: Some(4), + }, + }, + color.size(), + ); + queue.submit([encoder.finish()]); + buffer + .slice(..) + .map_async(wgpu::MapMode::Read, |r| r.unwrap()); + device.poll(wgpu::PollType::wait_indefinitely()).unwrap(); + let bytes = buffer.slice(..).get_mapped_range().unwrap().to_vec(); + (0..4) + .flat_map(|row| { + let start = row * wgpu::COPY_BYTES_PER_ROW_ALIGNMENT as usize; + bytes[start..start + 16].to_vec() + }) + .collect() + }; + let same = stage("fn sky(input: SkyInput) -> vec4 { return input.color; }\n"); + let vanilla = draw(&same, true); + assert_eq!(draw(&same, false), vanilla); + // The top row looks up into the sky disc, the bottom one down into the fog. + assert_ne!(vanilla[..4], vanilla[vanilla.len() - 4..]); + let inverse = stage( + "override gain: f32;\nfn sky(input: SkyInput) -> vec4 { return vec4(vec3(gain) - input.color.rgb, 0.25); }\n", + ); + let inverted = draw(&inverse, false); + for (got, want) in inverted.chunks(4).zip(vanilla.chunks(4)) { + assert_eq!(got[3], 255); + for i in 0..3 { + assert!(got[i].abs_diff(255 - want[i]) <= 1, "{got:?} {want:?}"); + } + } + } +} diff --git a/crates/horizon-client/src/gfx/occlusion.rs b/crates/horizon-client/src/gfx/occlusion.rs index e17ba87d1..22e2f3c81 100644 --- a/crates/horizon-client/src/gfx/occlusion.rs +++ b/crates/horizon-client/src/gfx/occlusion.rs @@ -522,16 +522,27 @@ impl Occlusion { } pub fn set(&mut self, key: SectionKey, vis: u64) { if self.columns.set(key, vis) { - self.edits.push(Edit::Set(key, vis)); - self.dirty = true; - self.changed.push(key); - if self.running.is_some() { - self.changed_late.push(key); - } + self.changed(key, vis); } } - pub fn remove(&mut self, key: SectionKey) { - self.set(key, ALL_VISIBLE); + fn changed(&mut self, key: SectionKey, vis: u64) { + self.edits.push(Edit::Set(key, vis)); + self.dirty = true; + self.changed.push(key); + if self.running.is_some() { + self.changed_late.push(key); + } + } + /// Every section of the column `x`, `z` goes (sees through every face). + pub fn remove_column(&mut self, x: i32, z: i32) { + let Some(column) = self.columns.map.remove(&(x, z)) else { + return; + }; + for (y, &vis) in column.iter().enumerate() { + if vis != ALL_VISIBLE { + self.changed((x, y as i32, z), ALL_VISIBLE); + } + } } pub fn clear(&mut self) { self.columns.map.clear(); diff --git a/crates/horizon-client/src/gfx/pack_atlas.rs b/crates/horizon-client/src/gfx/pack_atlas.rs index 42a2abee1..c7a67a50b 100644 --- a/crates/horizon-client/src/gfx/pack_atlas.rs +++ b/crates/horizon-client/src/gfx/pack_atlas.rs @@ -169,6 +169,7 @@ impl PackAtlas { ]; let columns = self.columns; // UVs past a sprite (models up to 2, distant tiles) cannot repeat in an atlas: clamped. + // The colour's alpha holds HDR's emission level (`mesher::EMISSION_BITS`): packs get 1. let body = format!( " vec4 hz_origin = {origin};\n \ uint hz_layer = hz_v_layer & 32767u;\n \ @@ -178,7 +179,7 @@ impl PackAtlas { hz_MultiTexCoord0 = vec4((hz_cell + clamp(vec2(hz_v_uv) * hz_origin.w, 0.0, 1.0)) * hz_scale, 0.0, 1.0);\n \ hz_MultiTexCoord1 = vec4(float(hz_v_light.y), float(hz_v_light.x), 0.0, 1.0);\n \ hz_MultiTexCoord2 = hz_MultiTexCoord1;\n \ - hz_Color = hz_v_color;\n \ + hz_Color = vec4(hz_v_color.rgb, 1.0);\n \ hz_Normal = vec3(0.0, 1.0, 0.0);\n \ hz_tangent = vec4(1.0, 0.0, 0.0, 1.0);\n", scale[0], scale[1], diff --git a/crates/horizon-client/src/gfx/pack_timing.rs b/crates/horizon-client/src/gfx/pack_timing.rs index 24b97d7af..2a8dcf4a5 100644 --- a/crates/horizon-client/src/gfx/pack_timing.rs +++ b/crates/horizon-client/src/gfx/pack_timing.rs @@ -128,6 +128,11 @@ impl PassTiming { } } + /// Whether the frame being recorded is timed. + pub fn recording(&self) -> bool { + matches!(self.stage, Stage::Recording) + } + /// Timestamp writes for the pass `name`, in a timed frame. pub fn writes(&mut self, name: &str) -> Option> { let i = self.push(name)?; diff --git a/crates/horizon-client/src/gfx/pack_uniforms.rs b/crates/horizon-client/src/gfx/pack_uniforms.rs index c4df4377b..8f5f1a2de 100644 --- a/crates/horizon-client/src/gfx/pack_uniforms.rs +++ b/crates/horizon-client/src/gfx/pack_uniforms.rs @@ -399,7 +399,8 @@ impl FrameUniforms { _ => Value::i(&[0]), } }; - self.values = NAMES.iter().map(|n| value(n)).collect(); + self.values.clear(); + self.values.extend(NAMES.iter().map(|n| value(n))); self.frame = (self.frame + 1) % 720_720; } diff --git a/crates/horizon-client/src/gfx/wgsl_prefix.rs b/crates/horizon-client/src/gfx/wgsl_prefix.rs new file mode 100644 index 000000000..03d84a56e --- /dev/null +++ b/crates/horizon-client/src/gfx/wgsl_prefix.rs @@ -0,0 +1,124 @@ +//! Copies of the renderer's own WGSL that run beside a shader pack's code in one module (the +//! sky and material stages of Horizon's packs, docs/shaders.md): every name such a copy +//! declares takes a prefix starting with `horizon_`, which the pack check refuses in a pack, +//! so no pack name can meet one of Horizon's. + +/// terrain.wgsl, which the copies are taken from. +pub const TERRAIN: &str = include_str!("../terrain.wgsl"); + +/// The text of `source` from the line starting with `start` up to (not including) the one +/// starting with `end`. +pub fn section<'a>(source: &'a str, start: &str, end: &str) -> &'a str { + let from = source + .find(&format!("\n{start}")) + .expect("the source has the section") + + 1; + let to = from + + source[from..] + .find(&format!("\n{end}")) + .expect("the source ends the section") + + 1; + &source[from..to] +} + +/// The names `text` declares at its top level: functions, structs, constants, overrides and +/// module variables (bindings). +fn declared(text: &str) -> Vec<&str> { + let mut names = Vec::new(); + for line in text.lines() { + // Top level only: a function's own `var` and `let` stay as they are. + if line.starts_with(char::is_whitespace) { + continue; + } + let mut line = line; + while let Some(rest) = line.strip_prefix('@') { + // An attribute: `@vertex`, `@group(0)`, `@binding(1)`. + let end = rest.find(' ').unwrap_or(rest.len()); + line = rest[end..].trim_start(); + } + let rest = ["fn ", "struct ", "const ", "override ", "var "] + .iter() + .find_map(|k| line.strip_prefix(k)) + .or_else(|| { + // `var name`, `var name`. + let rest = line.strip_prefix("var<")?; + Some(rest[rest.find('>')? + 1..].trim_start()) + }); + if let Some(rest) = rest { + let end = rest + .find(|c: char| !(c.is_ascii_alphanumeric() || c == '_')) + .unwrap_or(rest.len()); + names.push(&rest[..end]); + } + } + names +} + +/// `text` with every name it declares at its top level, and every use of one, prefixed by +/// `prefix`. Comments are rewritten too, which is harmless. +pub fn prefixed(text: &str, prefix: &str) -> String { + let names = declared(text); + let mut out = String::with_capacity(text.len() * 2); + let mut word = String::new(); + let flush = |word: &mut String, out: &mut String| { + if names.contains(&word.as_str()) { + out.push_str(prefix); + } + out.push_str(word); + word.clear(); + }; + for c in text.chars() { + if c.is_ascii_alphanumeric() || c == '_' { + word.push(c); + } else { + flush(&mut word, &mut out); + out.push(c); + } + } + flush(&mut word, &mut out); + out +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn prefixes_top_level_names_and_their_uses_only() { + let text = "struct S { a: f32, }\n\ + @group(0) @binding(0) var g: S;\n\ + @group(1) @binding(2) var list: array;\n\ + override N: u32 = 1u;\n\ + const K: f32 = 2.0;\n\ + @fragment fn f(x: f32) -> @location(0) vec4 {\n \ + var a = g.a * K;\n \ + return vec4(a + f32(list[N]) + x);\n\ + }\n"; + let out = prefixed(text, "p_"); + assert_eq!( + out, + "struct p_S { a: f32, }\n\ + @group(0) @binding(0) var p_g: p_S;\n\ + @group(1) @binding(2) var p_list: array;\n\ + override p_N: u32 = 1u;\n\ + const p_K: f32 = 2.0;\n\ + @fragment fn p_f(x: f32) -> @location(0) vec4 {\n \ + var a = p_g.a * p_K;\n \ + return vec4(a + f32(p_list[p_N]) + x);\n\ + }\n" + ); + // Every top-level declaration of terrain.wgsl is found. + let names = declared(TERRAIN); + for name in [ + "Globals", + "globals", + "sprites_7", + "SPRITE_SPLIT", + "block_slots", + "fs_sky", + ] { + assert!(names.contains(&name), "{name}"); + } + assert!(!names.contains(&"out")); + } +} diff --git a/crates/horizon-client/src/graphics.rs b/crates/horizon-client/src/graphics.rs index b51a586ab..4f6f04bc0 100644 --- a/crates/horizon-client/src/graphics.rs +++ b/crates/horizon-client/src/graphics.rs @@ -255,6 +255,12 @@ pub struct Graphics { pub resolution_scale: u32, /// FXAA over the world. pub fxaa: bool, + /// HDR output (scRGB), where the display path offers it. + pub hdr: bool, + /// HDR paper white (where SDR white sits), in nits. + pub hdr_paper_white: u32, + /// HDR peak brightness the world's highlights reach, in nits. + pub hdr_peak: u32, /// Battery mode: at most 60 frames per second in a world and 30 in menus /// or behind other windows, and half the worker threads. Off by default; /// it changes when frames are drawn, never what they show or the ticks. @@ -286,6 +292,9 @@ impl Default for Graphics { overlay: Overlay::Off, resolution_scale: 100, fxaa: false, + hdr: false, + hdr_paper_white: 200, + hdr_peak: 1000, battery: false, api: GraphicsApi::Auto, shader_pack: String::new(), @@ -337,6 +346,9 @@ impl Graphics { "workers" => g.workers = number(g.workers).min(64), "resolutionScale" => g.resolution_scale = number(g.resolution_scale).clamp(50, 200), "fxaa" => g.fxaa = flag(g.fxaa), + "hdr" => g.hdr = flag(g.hdr), + "hdrPaperWhite" => g.hdr_paper_white = number(g.hdr_paper_white).clamp(80, 480), + "hdrPeak" => g.hdr_peak = number(g.hdr_peak).clamp(200, 2000), "batteryMode" => g.battery = flag(g.battery), "graphicsApi" => g.api = GraphicsApi::from_name(value).unwrap_or_default(), "pickedShaderPack" => g.shader_pack = value.to_owned(), @@ -354,7 +366,7 @@ impl Graphics { } pub fn serialize(&self) -> String { format!( - "preset:{}\nlodDistance:{}\nfarDetail:{}\ncaveCulling:{}\nentityCulling:{}\nchunkUpdates:{}\nuploadBudgetKiB:{}\nsky:{}\nfog:{}\nweather:{}\nanimatedTextures:{}\npresentMode:{}\nframePacing:{}\nworkers:{}\noverlay:{}\nresolutionScale:{}\nfxaa:{}\nbatteryMode:{}\ngraphicsApi:{}\npickedShaderPack:{}\n", + "preset:{}\nlodDistance:{}\nfarDetail:{}\ncaveCulling:{}\nentityCulling:{}\nchunkUpdates:{}\nuploadBudgetKiB:{}\nsky:{}\nfog:{}\nweather:{}\nanimatedTextures:{}\npresentMode:{}\nframePacing:{}\nworkers:{}\noverlay:{}\nresolutionScale:{}\nfxaa:{}\nhdr:{}\nhdrPaperWhite:{}\nhdrPeak:{}\nbatteryMode:{}\ngraphicsApi:{}\npickedShaderPack:{}\n", self.preset.name(), self.lod_distance, self.far_detail.name(), @@ -379,6 +391,9 @@ impl Graphics { }, self.resolution_scale, bool_text(self.fxaa), + bool_text(self.hdr), + self.hdr_paper_white, + self.hdr_peak, bool_text(self.battery), self.api.name(), self.shader_pack, @@ -444,7 +459,7 @@ pub fn apply_preset(preset: Preset, s: &mut crate::settings::Settings) { let g = &mut s.horizon; g.preset = preset; g.cave_culling = true; - g.animated_textures = preset != Preset::Performance; + g.animated_textures = true; g.chunk_updates = 0; g.upload_budget_kib = 0; g.sky = true; @@ -476,6 +491,9 @@ mod tests { overlay: Overlay::Graph, resolution_scale: 75, fxaa: true, + hdr: true, + hdr_paper_white: 240, + hdr_peak: 1400, battery: true, api: GraphicsApi::Dx12, shader_pack: "Golden Hour".into(), diff --git a/crates/horizon-client/src/graphics_ui.rs b/crates/horizon-client/src/graphics_ui.rs index ba99f89a8..3c7a40e02 100644 --- a/crates/horizon-client/src/graphics_ui.rs +++ b/crates/horizon-client/src/graphics_ui.rs @@ -37,6 +37,9 @@ pub enum H { Overlay, ResolutionScale, Antialiasing, + Hdr, + HdrPaperWhite, + HdrPeak, BatteryMode, GraphicsApi, } @@ -221,6 +224,21 @@ pub fn rows(level: Level) -> Vec { Medium, "FXAA smooths jagged edges of the world; slightly softer image.", ), + h( + H::Hdr, + None, + "HDR output on an HDR display: lava, fire and sunlight shine brighter.", + ), + h( + H::HdrPaperWhite, + None, + "HDR: how bright white paper and menus look. Match your desktop.", + ), + h( + H::HdrPeak, + None, + "HDR: how bright the brightest highlights get. Your display's peak.", + ), h( H::PresentMode, None, @@ -324,6 +342,8 @@ impl H { } H::Workers => Some(g.workers as f32 / max_workers() as f32), H::ResolutionScale => Some((g.resolution_scale as f32 - 50.0) / 150.0), + H::HdrPaperWhite => Some((g.hdr_paper_white as f32 - 80.0) / 400.0), + H::HdrPeak => Some((g.hdr_peak as f32 - 200.0) / 1800.0), _ => None, } } @@ -365,6 +385,9 @@ impl H { }, H::ResolutionScale => labelled("Resolution Scale", format!("{}%", g.resolution_scale)), H::Antialiasing => labelled("Anti-aliasing", if g.fxaa { "FXAA" } else { "Off" }), + H::Hdr => labelled("HDR", on_off(g.hdr)), + H::HdrPaperWhite => labelled("Paper White", format!("{} nits", g.hdr_paper_white)), + H::HdrPeak => labelled("Peak Brightness", format!("{} nits", g.hdr_peak)), H::BatteryMode => labelled("Battery Mode", on_off(g.battery)), H::GraphicsApi => labelled("Graphics API", g.api.label()), H::Overlay => labelled( @@ -387,6 +410,8 @@ impl H { } H::Workers => g.workers = (v * max_workers() as f32).round() as u32, H::ResolutionScale => g.resolution_scale = (50.0 + (v * 30.0).round() * 5.0) as u32, + H::HdrPaperWhite => g.hdr_paper_white = (80.0 + (v * 40.0).round() * 10.0) as u32, + H::HdrPeak => g.hdr_peak = (200.0 + (v * 36.0).round() * 50.0) as u32, _ => {} } } @@ -418,6 +443,7 @@ impl H { H::AnimatedTextures => g.animated_textures = !g.animated_textures, H::PresentMode => g.present_mode = step(&PresentMode::ALL, g.present_mode, back), H::Antialiasing => g.fxaa = !g.fxaa, + H::Hdr => g.hdr = !g.hdr, H::BatteryMode => g.battery = !g.battery, H::GraphicsApi => g.api = step(&GraphicsApi::ALL, g.api, back), H::Pacing => { @@ -453,6 +479,7 @@ impl Item { Item::Horizon(H::Weather) => g.weather, Item::Horizon(H::AnimatedTextures) => g.animated_textures, Item::Horizon(H::Antialiasing) => g.fxaa, + Item::Horizon(H::Hdr) => g.hdr, Item::Horizon(H::BatteryMode) => g.battery, Item::Vanilla(Opt::ViewBobbing) => s.view_bobbing, Item::Vanilla(Opt::Vsync) => s.vsync, diff --git a/crates/horizon-client/src/hdr.wgsl b/crates/horizon-client/src/hdr.wgsl new file mode 100644 index 000000000..bf6c27cca --- /dev/null +++ b/crates/horizon-client/src/hdr.wgsl @@ -0,0 +1,69 @@ +// Horizon's HDR output pass: the frame, drawn as without HDR in vanilla's gamma +// space, decoded to linear light at the paper white and written to the scRGB +// swapchain (1.0 = 80 nits). Bright pixels of light sources that still show the +// world as it was before the hand and HUD are expanded towards the peak. +@group(0) @binding(0) var frame: texture_2d; +@group(0) @binding(1) var world: texture_2d; + +struct Params { + // Paper white in scRGB units (nits / 80). + paper: f32, + // Peak brightness relative to paper white; 1 expands nothing. + peak: f32, + // 1 when this frame drew a world. + world: f32, + // 1 paints expanded pixels magenta (HORIZON_HDR_DEBUG=1). + debug: f32, +}; +@group(0) @binding(2) var params: Params; + +// Light sources are lifted evenly rather than by a highlight curve: vanilla's +// textures were drawn for SDR, so a curve on their brightest pixels blows out +// near-white spots (glowstone) and leaves the rest (lava, a jack o'lantern's +// face) nearly as it was. Pixels brighter than LIFT_FULL get STRENGTH of the +// headroom, dimmer ones less down to none at LIFT_START (lava's crust, a +// lantern's metal), and no channel goes past the peak. Brightness is the mean +// of luminance and the brightest channel, so saturated light counts as bright. +const LIFT_START: f32 = 0.18; +const LIFT_FULL: f32 = 0.42; +const STRENGTH: f32 = 0.7; + +// Whether `c` still shows the world pixel `w`: the same, or darkened evenly +// across its channels, as the vignette and other screen-wide tints darken it. +// The hand, HUD and text replace pixels instead, so they never pass. +fn shows_world(c: vec3, w: vec3) -> bool { + if all(c == w) { + return true; + } + let k = c / max(w, vec3(1.0 / 255.0)); + let mean = (k.r + k.g + k.b) / 3.0; + return mean <= 1.01 && mean > 0.5 && all(abs(k - vec3(mean)) < vec3(0.03)); +} + +@vertex fn vs_hdr(@builtin(vertex_index) i: u32) -> @builtin(position) vec4 { + let p = vec2(f32((i << 1u) & 2u), f32(i & 2u)); + return vec4(p * 2.0 - 1.0, 0.0, 1.0); +} + +@fragment fn fs_hdr(@builtin(position) pos: vec4) -> @location(0) vec4 { + let at = vec2(pos.xy); + let c = textureLoad(frame, at, 0).rgb; + // Gamma 2.2, as SDR displays and the compositors' SDR paths decode it. + var light = pow(max(c, vec3(0.0)), vec3(2.2)); + let w = textureLoad(world, at, 0); + // The world's alpha is 0 on light-emitting blocks, the sun and the moon + // (terrain.wgsl, the celestial pipeline): only those shine. + if params.world > 0.5 && params.peak > 1.0 && w.a < 0.75 && shows_world(c, w.rgb) { + let y = 0.5 * (dot(light, vec3(0.2126, 0.7152, 0.0722)) + max(light.r, max(light.g, light.b))); + let lift = smoothstep(LIFT_START, LIFT_FULL, y); + if lift > 0.0 { + let top = max(light.r, max(light.g, light.b)); + let gain = min(1.0 + (params.peak - 1.0) * STRENGTH * lift, params.peak / max(top, 1e-4)); + light *= max(gain, 1.0); + if params.debug > 0.5 { + light = mix(light, vec3(gain, 0.0, gain), 0.6); + } + } + } + return vec4(light * params.paper, 1.0); +} diff --git a/crates/horizon-client/src/hud_overlays.rs b/crates/horizon-client/src/hud_overlays.rs index ecc23a5ee..ebd860e08 100644 --- a/crates/horizon-client/src/hud_overlays.rs +++ b/crates/horizon-client/src/hud_overlays.rs @@ -1111,8 +1111,9 @@ impl SubtitleOverlay { s.purge_old_instances(3000.0 * frame.multiplier, now); } if s.audible_from(position) && !s.played.is_empty() { - width = width.max(width_of(&Text::translate(&s.key, &[]))); - audible.push(i); + let text_width = width_of(&Text::translate(&s.key, &[])); + width = width.max(text_width); + audible.push((i, text_width)); } } if audible.is_empty() { @@ -1121,7 +1122,7 @@ impl SubtitleOverlay { let w = |s: &str| font.width(s) as i32; width += w("<") + w(" ") + w(">") + w(" "); let mut row = 0; - for i in audible { + for (i, text_width) in audible { let s = &self.subtitles[i]; let text_value = Text::translate(&s.key, &[]); let Some(closest) = s.best_candidate(position) else { @@ -1145,7 +1146,6 @@ impl SubtitleOverlay { let half_width = width / 2; let height = 9; let half_height = height / 2; - let text_width = width_of(&text_value); let brightness = s.brightness(closest, frame.multiplier, now); out.push(GuiDraw::Push(vec![ PoseOp::Translate( diff --git a/crates/horizon-client/src/item_data.rs b/crates/horizon-client/src/item_data.rs index c07e2f352..ac624e85b 100644 --- a/crates/horizon-client/src/item_data.rs +++ b/crates/horizon-client/src/item_data.rs @@ -204,6 +204,14 @@ impl ItemStack { pub fn custom_name(&self) -> Option<&str> { self.data().and_then(|d| d.custom_name.as_deref()) } + /// `minecraft:item_name` in the current language (`getItemName`'s + /// component). It stays in the patch as loaded, so a translatable name + /// saves and reaches clients unchanged; the ominous banner's is modelled + /// by `ominous_banner` instead. + pub fn item_name(&self) -> Option { + let name = self.data()?.other("minecraft:item_name")?; + Some(crate::entity_nbt::name_text(name).plain()) + } pub fn potion(&self) -> Option<&str> { self.data().and_then(|d| d.potion.as_deref()) } diff --git a/crates/horizon-client/src/item_sync.rs b/crates/horizon-client/src/item_sync.rs index 930304ec4..fc35e15e7 100644 --- a/crates/horizon-client/src/item_sync.rs +++ b/crates/horizon-client/src/item_sync.rs @@ -238,6 +238,125 @@ mod tests { use super::*; use horizon_protocol::registry::Ids; + #[test] + fn merchant_water_cost_survives_the_offer_packet() { + use horizon_protocol::{ + buf::{Codec, Reader, Writer}, + packets::play::{NetOffer, Offers}, + }; + let mut components = vec![String::new(); component::POTION_CONTENTS as usize + 1]; + components[component::POTION_CONTENTS as usize] = "minecraft:potion_contents".into(); + let builtin = Builtin { + registries: [ + ( + "minecraft:item".into(), + Ids::from_names(vec!["minecraft:potion".into(), "minecraft:emerald".into()]), + ), + ( + "minecraft:potion".into(), + Ids::from_names(vec!["minecraft:water".into()]), + ), + ( + "minecraft:data_component_type".into(), + Ids::from_names(components), + ), + ] + .into(), + }; + let dynamic = Dynamic::default(); + let water = ItemStack::new("minecraft:potion", 1).with_potion("minecraft:water"); + let wire = crate::lan::guest::stack_to_network( + |name| builtin.get("minecraft:item").unwrap().id(name).unwrap(), + |registry, name| builtin.get(registry)?.id(name), + &Some(water.clone()), + ) + .unwrap(); + let offers = vec![NetOffer { + cost_a: wire.into(), + result: Stack::new(1, 1), + cost_b: Some(Stack::new(1, 2).into()), + out_of_stock: false, + uses: 0, + max_uses: 2, + xp: 0, + special_price: 0, + price_multiplier: 0.05, + demand: 0, + }]; + let mut w = Writer::new(); + Offers::write(&offers, &mut w); + let mut r = Reader::new(&w.data); + let decoded = Offers::read(&mut r).unwrap(); + assert_eq!(r.remaining(), 0); + let cost = crate::merchant::ItemCost { + stack: from_network(&decoded[0].cost_a.clone().into(), &builtin, &dynamic), + }; + assert_eq!(cost.stack, water); + assert_eq!(cost.stack.potion(), Some("minecraft:water")); + let authoritative = crate::merchant::ItemCost { + stack: water.clone(), + }; + for payment in [ + water, + ItemStack::new("minecraft:potion", 1).with_potion("minecraft:swiftness"), + ItemStack::new("minecraft:potion", 1), + ] { + assert_eq!(cost.test(&payment), authoritative.test(&payment)); + } + assert!(cost.test(&ItemStack::new("minecraft:potion", 1).with_potion("minecraft:water"))); + assert!( + !cost.test(&ItemStack::new("minecraft:potion", 1).with_potion("minecraft:swiftness")) + ); + let emerald = crate::merchant::ItemCost { + stack: from_network( + &decoded[0].cost_b.clone().unwrap().into(), + &builtin, + &dynamic, + ), + }; + assert!(emerald.test(&ItemStack::new("minecraft:emerald", 2))); + } + + /// A bundle's contents cross the wire, so a server's client can draw + /// its tooltip (BundleContents' stream codec: a list of templates). + #[test] + fn a_bundle_keeps_its_contents_across_the_wire() { + let mut components = vec![String::new(); 60]; + components[component::BUNDLE_CONTENTS as usize] = "minecraft:bundle_contents".into(); + let items = ["minecraft:air", "minecraft:bundle", "minecraft:stone"]; + let builtin = Builtin { + registries: [ + ( + "minecraft:item".to_owned(), + Ids::from_names(items.iter().map(|s| s.to_string()).collect()), + ), + ( + "minecraft:data_component_type".to_owned(), + Ids::from_names(components), + ), + ] + .into(), + }; + let dynamic = Dynamic { + registries: Default::default(), + }; + let mut bundle = ItemStack::new("minecraft:bundle", 1); + bundle.data_mut().bundle_contents = vec![ItemStack::new("minecraft:stone", 32)]; + let wire = crate::lan::guest::stack_to_network( + |name| items.iter().position(|i| *i == name).unwrap_or(0) as i32, + |_, _| None, + &Some(bundle), + ) + .unwrap(); + let back = from_network(&wire, &builtin, &dynamic); + let contents = &back.data().expect("components").bundle_contents; + assert_eq!(contents.len(), 1); + assert_eq!( + (&*contents[0].item, contents[0].count), + ("minecraft:stone", 32) + ); + } + /// What a creative client sends (`stack_to_network`) comes back whole on /// the server: damage, both enchantment lists, repair cost, name, trim. #[test] @@ -246,6 +365,7 @@ mod tests { for (id, name) in [ (component::DAMAGE, "minecraft:damage"), (component::CUSTOM_NAME, "minecraft:custom_name"), + (component::ITEM_NAME, "minecraft:item_name"), (component::ENCHANTMENTS, "minecraft:enchantments"), (component::POTION_CONTENTS, "minecraft:potion_contents"), (component::REPAIR_COST, "minecraft:repair_cost"), @@ -305,6 +425,10 @@ mod tests { .push((Arc::from("minecraft:sharpness"), 2)); d.repair_cost = 9; d.custom_name = Some("Keeper".to_owned()); + // A translatable item name reaches the client as the same component. + let item_name = Tag::compound([("translate", Tag::String("filled_map.monument".into()))]); + d.other + .push(("minecraft:item_name".into(), item_name.clone())); d.trim = Some((Arc::from("minecraft:gold"), Arc::from("minecraft:sentry"))); let id = |registry: &str, name: &str| { builtin @@ -334,6 +458,7 @@ mod tests { ); assert_eq!(d.repair_cost, 9); assert_eq!(d.custom_name.as_deref(), Some("Keeper")); + assert_eq!(d.other("minecraft:item_name"), Some(&item_name)); assert_eq!( d.trim, Some((Arc::from("minecraft:gold"), Arc::from("minecraft:sentry"))) diff --git a/crates/horizon-client/src/item_tooltip.rs b/crates/horizon-client/src/item_tooltip.rs index 6e51de391..88f01439e 100644 --- a/crates/horizon-client/src/item_tooltip.rs +++ b/crates/horizon-client/src/item_tooltip.rs @@ -56,10 +56,9 @@ impl<'a> TooltipDisplay<'a> { else { return true; }; - let component = horizon_world::nbt::JavaString::from(component); - !hidden - .iter() - .any(|tag| matches!(tag, Tag::String(id) if id == &component)) + !hidden.iter().any(|tag| { + matches!(tag, Tag::String(id) if id.0.iter().copied().eq(component.encode_utf16())) + }) } } @@ -189,6 +188,9 @@ pub fn name_line(stack: &ItemStack, translate: &dyn Fn(&str) -> Option) if let Some(name) = stack.custom_name() { return name.to_owned(); } + if let Some(name) = stack.item_name() { + return name; + } if stack.data().is_some_and(|d| d.ominous_banner) { return translate("block.minecraft.ominous_banner") .unwrap_or_else(|| "Ominous Banner".to_owned()); @@ -612,6 +614,14 @@ mod tests { assert_eq!(rarity(&banner, "common"), "uncommon"); banner.data_mut().custom_name = Some("Captain's Standard".into()); assert_eq!(name_line(&banner, &translate), "Captain's Standard"); + let mut custom_item = ItemStack::new("minecraft:diamond_sword", 1); + custom_item.data_mut().other.push(( + "minecraft:item_name".into(), + Tag::String("Excalibur".into()), + )); + assert_eq!(name_line(&custom_item, &translate), "Excalibur"); + custom_item.data_mut().custom_name = Some("Custom Blade".into()); + assert_eq!(name_line(&custom_item, &translate), "Custom Blade"); banner.enchant("minecraft:unbreaking", 1); assert_eq!(rarity(&banner, "common"), "rare"); let plain = ItemStack::new("minecraft:white_banner", 1); diff --git a/crates/horizon-client/src/items.rs b/crates/horizon-client/src/items.rs index 8ac450bcb..e34471966 100644 --- a/crates/horizon-client/src/items.rs +++ b/crates/horizon-client/src/items.rs @@ -120,6 +120,8 @@ pub struct ItemInfo { pub crafting_remainder: Option, /// `dye`: the dye colour name (dyes, and anything else with the component). pub dye: Option, + /// `cushion/color`: the DyeColor name of a cushion item. + pub cushion_color: Option, /// `block_transformer`: the registry entry an axe, hoe or shovel uses on blocks. pub block_transformer: Option, /// Has a default `bundle_contents` (the bundles, `BundleItem`). @@ -251,6 +253,10 @@ pub struct Items { loot: HashMap, /// The `jukebox_song` registry. pub songs: HashMap, + /// The enchantment registry: loot functions enchant the items they roll + /// (`EnchantWithLevelsFunction`, `EnchantRandomlyFunction`), and the + /// station menus share this copy. + pub enchantments: Arc, } /// A `JukeboxSong`. #[derive(Clone, Debug)] @@ -599,6 +605,7 @@ impl Items { .map(str::to_owned), jukebox_song: c["minecraft:jukebox_playable"].as_str().map(str::to_owned), dye: c["minecraft:dye"].as_str().map(str::to_owned), + cushion_color: c["minecraft:cushion/color"].as_str().map(str::to_owned), block_transformer: c["minecraft:block_transformer"].as_str().map(str::to_owned), bundle: c.get("minecraft:bundle_contents").is_some(), crafting_remainder: CRAFT_REMAINDERS @@ -701,12 +708,15 @@ impl Items { item_tag_order: load_tag_lists(root, "item")?, loot, songs: load_songs(root), + enchantments: Arc::new(crate::enchant::Enchantments::load(root)), }) } pub fn get(&self, id: &str) -> Option<&ItemInfo> { self.items.get(id) } - /// Only the block and item tags, for tools that need tag membership. + /// Only the block and item tags (and the enchantment registry, which the + /// station rules and loot functions are built from), for tools that need + /// tag membership. pub fn tags_only(root: &Path) -> Result { Ok(Self { items: HashMap::new(), @@ -717,6 +727,7 @@ impl Items { item_tag_order: load_tag_lists(root, "item")?, loot: HashMap::new(), songs: HashMap::new(), + enchantments: Arc::new(crate::enchant::Enchantments::load(root)), }) } /// An item table with only tags, for unit tests of item rules. @@ -734,6 +745,7 @@ impl Items { item_tags, loot: HashMap::new(), songs: HashMap::new(), + enchantments: Arc::new(crate::enchant::Enchantments::default()), } } /// Whether `block` is in the block tag `tag` (`minecraft:fire`, no `#`). @@ -1371,6 +1383,16 @@ impl LootContext<'_> { self.modifiers(&modifiers, &mut stack, random); produced.push(stack); } + /// An enchantment function's `options` (`HolderSet`): a tag, a list or + /// one id; every enchantment when absent (`registryAccess().listElements`). + fn enchant_pool(e: &crate::enchant::Enchantments, options: &Value) -> Vec> { + match options { + Value::String(s) if s.starts_with('#') => e.tag(s).to_vec(), + Value::String(s) => vec![Arc::from(s.as_str())], + Value::Array(a) => a.iter().filter_map(|x| x.as_str().map(Arc::from)).collect(), + _ => e.list.iter().map(|x| Arc::clone(&x.id)).collect(), + } + } fn modifiers(&self, m: &Value, stack: &mut ItemStack, random: &mut R) { let list: Vec<&Value> = match m { Value::Array(a) => a.iter().collect(), @@ -1449,6 +1471,54 @@ impl LootContext<'_> { .with_potion(id); } } + // EnchantWithLevelsFunction: EnchantmentHelper.enchantItem on + // the context's random (the End cities' gear). + "minecraft:enchant_with_levels" => { + let cost = Self::int_number(&f["levels"], random); + let e = &self.items.enchantments; + let pool = Self::enchant_pool(e, &f["options"]); + let chosen = e.select(self.items, random, &stack.item, cost, &pool); + // EnchantmentHelper.enchantItem: a book becomes one + // enchanted book (the fresh stack's count). + if &*stack.item == "minecraft:book" { + *stack = ItemStack::new("minecraft:enchanted_book", 1); + } + for (id, level) in chosen { + stack.enchant(&id, level); + } + } + // EnchantRandomlyFunction: one enchantment the item accepts, + // at a level between its min and max. + "minecraft:enchant_randomly" => { + let e = &self.items.enchantments; + let book = &*stack.item == "minecraft:book"; + let only_compatible = f["only_compatible"].as_bool().unwrap_or(true); + let options: Vec> = Self::enchant_pool(e, &f["options"]) + .into_iter() + .filter(|id| { + book || !only_compatible || e.can_enchant(self.items, id, &stack.item) + }) + .collect(); + if options.is_empty() { + continue; + } + let id = options + [random.next_int_bound(options.len() as i32).unwrap_or(0) as usize] + .clone(); + let max = e.get(&id).map_or(1, |d| d.max_level).max(1); + // `Mth.nextInt(random, 1, max)`: a single-level + // enchantment (Mending) returns 1 without drawing, so the + // rolls after this one keep vanilla's sequence. + let level = if max <= 1 { + 1 + } else { + 1 + random.next_int_bound(max as i32).unwrap_or(0) as u32 + }; + if book { + *stack = ItemStack::new("minecraft:enchanted_book", 1); + } + stack.enchant(&id, level); + } "minecraft:limit_count" => { let limit = &f["limit"]; if let Some(min) = limit["min"].as_i64() { @@ -1658,6 +1728,102 @@ mod tests { assert_eq!(drops[0].potion(), Some("minecraft:fire_resistance")); } + /// `/loot give` and every other table this dispatcher rolls: the two + /// enchantment functions (`EnchantWithLevelsFunction`, + /// `EnchantRandomlyFunction`) put their enchantments on the stack. + #[test] + fn loot_enchant_functions_enchant_the_rolled_item() { + let root = std::path::PathBuf::from(env!("CARGO_MANIFEST_DIR")) + .join("../../.local/horizon-client/26.3"); + if !root.join("items.json").exists() { + return; + } + let assets = crate::assets::Assets::load(&root).unwrap(); + let facts = crate::blocks::BlockFacts::load(&root, assets.registry).unwrap(); + let items = Items::load(&root, assets.registry, &facts).unwrap(); + let props = BTreeMap::new(); + let mut random = LegacyRandom::new(11); + // A sword at levels 20..39 comes out enchanted, as in an End city. + let levels = json!({"pools":[{"rolls":1,"entries":[{"type":"minecraft:item", + "name":"minecraft:diamond_sword","modifier":[ + {"type":"minecraft:enchant_with_levels","levels":{"type":"minecraft:uniform","min":20.0,"max":39.0}}]}]}]}); + let mut enchanted = 0; + for _ in 0..40 { + let drops = ctx(&items, None, &props, "").evaluate(&levels, &mut random); + if drops[0].enchantments().is_empty() { + continue; + } + enchanted += 1; + assert_eq!(&*drops[0].item, "minecraft:diamond_sword"); + // Levels stay within the enchantment's range. + for (id, level) in drops[0].enchantments() { + let max = items + .enchantments + .get(id) + .expect("a known enchantment") + .max_level; + assert!((1..=max).contains(level), "{id} at {level}"); + } + } + assert!( + enchanted > 30, + "only {enchanted} of 40 rolls were enchanted" + ); + // `enchant_randomly` on a book makes one enchanted book, its levels + // stored; the pool is the enchantment tag it names. + let book = json!({"pools":[{"rolls":1,"entries":[{"type":"minecraft:item", + "name":"minecraft:book","modifier":[ + {"type":"minecraft:enchant_randomly","options":"#minecraft:on_random_loot"}]}]}]}); + let drops = ctx(&items, None, &props, "").evaluate(&book, &mut random); + assert_eq!(&*drops[0].item, "minecraft:enchanted_book"); + assert_eq!(drops[0].count, 1); + assert!(drops[0].enchantments().is_empty()); + let stored = drops[0].stored_enchantments(); + assert_eq!(stored.len(), 1, "{stored:?}"); + assert!( + items + .enchantments + .in_tag("minecraft:on_random_loot", &stored[0].0) + ); + // An item no enchantment accepts keeps none of them. + let dirt = json!({"pools":[{"rolls":1,"entries":[{"type":"minecraft:item", + "name":"minecraft:dirt","modifier":[ + {"type":"minecraft:enchant_with_levels","levels":{"type":"minecraft:constant","value":30.0}}]}]}]}); + let drops = ctx(&items, None, &props, "").evaluate(&dirt, &mut random); + assert!(drops[0].enchantments().is_empty()); + } + + /// `Mth.nextInt(random, 1, max)` returns `1` without drawing when the + /// enchantment has one level (`EnchantRandomlyFunction.enchantItem`), so + /// the rolls after it must not shift. Vanilla with `LegacyRandom(11)`: a + /// Mending book, then `set_count` uniform 1..64, is 46. + #[test] + fn a_single_level_enchantment_draws_no_level() { + let root = std::path::PathBuf::from(env!("CARGO_MANIFEST_DIR")) + .join("../../.local/horizon-client/26.3"); + if !root.join("items.json").exists() { + return; + } + let assets = crate::assets::Assets::load(&root).unwrap(); + let facts = crate::blocks::BlockFacts::load(&root, assets.registry).unwrap(); + let items = Items::load(&root, assets.registry, &facts).unwrap(); + let props = BTreeMap::new(); + let table = json!({"pools":[{"rolls":1,"entries":[{"type":"minecraft:item", + "name":"minecraft:book","modifier":[ + {"type":"minecraft:enchant_randomly","options":"minecraft:mending"}, + {"type":"minecraft:set_count","count":{"type":"minecraft:uniform","min":1.0,"max":64.0}}]}]}]}); + let drops = ctx(&items, None, &props, "").evaluate(&table, &mut LegacyRandom::new(11)); + assert_eq!(drops.len(), 1); + assert_eq!(&*drops[0].item, "minecraft:enchanted_book"); + assert_eq!( + drops[0].stored_enchantments(), + [("minecraft:mending".to_owned().into(), 1)], + "the book keeps its single-level enchantment" + ); + // 46 is vanilla's count for this seed; an extra level draw gives 28. + assert_eq!(drops[0].count, 46); + } + #[test] fn always_edible_and_consume_effects_loaded() { let root = std::path::PathBuf::from(env!("CARGO_MANIFEST_DIR")) diff --git a/crates/horizon-client/src/lan/chunks.rs b/crates/horizon-client/src/lan/chunks.rs index d7dcc6cd8..122d37bcd 100644 --- a/crates/horizon-client/src/lan/chunks.rs +++ b/crates/horizon-client/src/lan/chunks.rs @@ -952,6 +952,11 @@ pub fn entity_tag(entity: &BlockEntity) -> Option { Some(Tag::compound(entries)) } BlockEntity::Jukebox(_) | BlockEntity::Lectern(_) => None, + // CampfireBlockEntity.getUpdateTag: the items alone. + BlockEntity::Campfire(c) => Some(Tag::compound([( + "Items", + crate::save::encode_items(&c.items), + )])), _ => None, } } diff --git a/crates/horizon-client/src/lan/conn.rs b/crates/horizon-client/src/lan/conn.rs index fb91f3006..f2dcf701d 100644 --- a/crates/horizon-client/src/lan/conn.rs +++ b/crates/horizon-client/src/lan/conn.rs @@ -823,6 +823,17 @@ fn login_and_configure( _ => {} } }; + // A Horizon client hears that this server runs its mods' quiet commands + // (horizon_protocol::quiet); a vanilla one is told nothing. + if brand == "horizon" { + send( + c, + cfg::Clientbound::CustomPayload(cfg::CustomPayload { + channel: horizon_protocol::quiet::CHANNEL.into(), + data: Vec::new(), + }), + )?; + } for packet in sync.registry_packets(known_pack) { send(c, cfg::Clientbound::RegistryData(packet))?; } diff --git a/crates/horizon-client/src/lan/containers.rs b/crates/horizon-client/src/lan/containers.rs index 7e150e7bd..002f95cbb 100644 --- a/crates/horizon-client/src/lan/containers.rs +++ b/crates/horizon-client/src/lan/containers.rs @@ -120,6 +120,21 @@ impl Hub { ); } + /// `ServerPlayer.crit`: send the victim's animation to the players tracking + /// the attacker and the attacker themselves (`sendToTrackingPlayersAndSelf`). + pub fn critical_hit(&self, attacker: i32, target: i32) { + let body = C::Animate(play::Animate { + id: target, + action: 1, + }) + .encode(); + for g in self.guests.iter().filter(|g| { + self.here(g) && (g.entity_id == attacker || g.tracker.is_tracking(attacker)) + }) { + g.sender.send(body.clone()); + } + } + /// `ServerLevel.broadcastDamageEvent`: the clients around show the hurt /// entity's flash and hear its hurt sound. pub fn damage_event( diff --git a/crates/horizon-client/src/lan/guest.rs b/crates/horizon-client/src/lan/guest.rs index aa1994257..7e43cf04e 100644 --- a/crates/horizon-client/src/lan/guest.rs +++ b/crates/horizon-client/src/lan/guest.rs @@ -237,6 +237,8 @@ pub struct Guest { pub drag: Option<(u8, Vec)>, /// The compound this player was loaded from, for fields Horizon does not model. pub saved: Option, + /// `ServerPlayer.seenCredits`: the end poem has been shown. + pub seen_credits: bool, /// `ServerPlayer.recipeBook`. pub recipe_book: crate::recipe_book::Settings, /// `PlayerAdvancements`: the criteria obtained, whether they came from @@ -358,6 +360,7 @@ impl Guest { next_window: 0, drag: None, saved: None, + seen_credits: false, recipe_book: Default::default(), advancements: Default::default(), advancements_loaded: false, @@ -601,6 +604,18 @@ fn network_stack( horizon_protocol::item::Component::Stacks(charged), )); } + // What a bundle holds, for its tooltip (ClientBundleTooltip). + if !d.bundle_contents.is_empty() { + let contents = d + .bundle_contents + .iter() + .filter_map(|c| network_stack(item_id, synced_id, &Some(c.clone()))) + .collect(); + stack.added.push(( + horizon_protocol::item::component::BUNDLE_CONTENTS, + horizon_protocol::item::Component::Stacks(contents), + )); + } // The books a lectern shows and a guest reads. if !d.writable_pages.is_empty() { stack.added.push(( @@ -633,6 +648,13 @@ fn network_stack( horizon_protocol::item::Component::Text(horizon_protocol::text::literal(name)), )); } + // The component as loaded, so a translatable name stays one. + if let Some(name) = s.data().and_then(|d| d.other("minecraft:item_name")) { + stack.added.push(( + horizon_protocol::item::component::ITEM_NAME, + horizon_protocol::item::Component::Text(name.clone()), + )); + } Some(stack) } diff --git a/crates/horizon-client/src/lan/hub.rs b/crates/horizon-client/src/lan/hub.rs index b462536b9..b1a8cbc62 100644 --- a/crates/horizon-client/src/lan/hub.rs +++ b/crates/horizon-client/src/lan/hub.rs @@ -128,6 +128,11 @@ pub enum HostEvent { line: String, secure: bool, }, + /// A chat message a player sent (after it was broadcast), for server mods. + PlayerChat { + sender: u128, + text: String, + }, /// A server log warning (ServerGamePacketListenerImpl's LOGGER.warn). Warn(String), /// A server log error (LOGGER.error). @@ -371,9 +376,21 @@ impl Hub { id } pub fn stack(&mut self, s: &Option) -> Option { - let id = s.as_ref().map(|s| self.item_id(&s.item))?; + let item = s.as_ref()?.item.clone(); + let id = self.item_id(&item); let sync = self.sync.clone(); - stack_to_network(|_| id, |registry, name| sync.id(registry, name), s) + // The stacks inside it (a bundle's contents, a crossbow's projectiles) + // have ids of their own. + let item_id = |name: &str| { + if name == &*item { + return id; + } + sync.builtin + .get("minecraft:item") + .and_then(|i| i.id(name)) + .unwrap_or(0) + }; + stack_to_network(item_id, |registry, name| sync.id(registry, name), s) } pub fn broadcast(&self, packet: &C) { @@ -2175,17 +2192,24 @@ impl Hub { if g.spectator() || g.sleeping { return (false, false); } - let height = if g.fall_flying { - 0.6 + // getBoundingBox: the box of the body's pose (swimming and crawling + // are 0.6 tall), so a swimmer under a ceiling isn't sent back. + let (half, height) = if g.fall_flying { + (0.3, 0.6) + } else if let Some(m) = &g.motion { + ( + f64::from(m.dimensions.width) / 2.0, + f64::from(m.dimensions.height), + ) } else if g.sneaking { - 1.5 + (0.3, 1.5) } else { - 1.8 + (0.3, 1.8) }; let at = |p: [f64; 3]| { Aabb::new( - Vec3::new(p[0] - 0.3, p[1], p[2] - 0.3), - Vec3::new(p[0] + 0.3, p[1] + height, p[2] + 0.3), + Vec3::new(p[0] - half, p[1], p[2] - half), + Vec3::new(p[0] + half, p[1] + height, p[2] + half), ) }; let (old, new) = (at(g.position), at(to)); diff --git a/crates/horizon-client/src/lan/hub/chat.rs b/crates/horizon-client/src/lan/hub/chat.rs index bdc7c3fb2..591c0dfc5 100644 --- a/crates/horizon-client/src/lan/hub/chat.rs +++ b/crates/horizon-client/src/lan/hub/chat.rs @@ -219,6 +219,10 @@ impl Hub { }; let line = format!("<{name}> {}", message.content); self.broadcast_chat(&message, &bound, line, events); + events.push(HostEvent::PlayerChat { + sender: uuid, + text: message.content, + }); } /// handleChatSessionUpdate: a new profile key, validated against the diff --git a/crates/horizon-client/src/lan/menu.rs b/crates/horizon-client/src/lan/menu.rs index 4185dadc4..859bafa23 100644 --- a/crates/horizon-client/src/lan/menu.rs +++ b/crates/horizon-client/src/lan/menu.rs @@ -37,6 +37,10 @@ pub struct Menu { pub sent_data: Vec, } +/// The y of the key a chest minecart's or chest boat's items are kept under +/// while a menu shows them. +pub const VEHICLE_KEY_Y: i32 = -100_000; + /// Where the slots of a container menu live. #[derive(Clone, Copy, Debug, PartialEq, Eq)] pub enum Slots { @@ -72,10 +76,12 @@ impl Slots { Slots::Ender => at.into_iter().collect(), _ => self.halves(), }; + // A vehicle's container is kept under a key, not a block: the game + // checks its reach to the vehicle (`isChestVehicleStillValid`). self.valid(world) && blocks .iter() - .all(|k| guest.within_block_range([k.0, k.1, k.2], 4.0)) + .all(|k| k.1 == VEHICLE_KEY_Y || guest.within_block_range([k.0, k.1, k.2], 4.0)) } /// Container slot `n`. pub fn get(self, world: &World, guest: &Guest, mut n: usize) -> Option { diff --git a/crates/horizon-client/src/lan/playerdata.rs b/crates/horizon-client/src/lan/playerdata.rs index 90fe0bcfe..f5eb935c9 100644 --- a/crates/horizon-client/src/lan/playerdata.rs +++ b/crates/horizon-client/src/lan/playerdata.rs @@ -85,6 +85,7 @@ pub fn apply(guest: &mut Guest, level: &Level) { .map(|s| [s[0] + 0.5, s[1], s[2] + 0.5]); guest.respawn_elsewhere = level.respawn_elsewhere.clone(); guest.saved = level.player_extra.clone(); + guest.seen_credits = level.seen_credits; let extra = level.player_extra.as_ref(); let short = |key: &str, default: i64| { extra @@ -166,6 +167,7 @@ pub fn store(guest: &Guest, level: &mut Level) { level.spawn = guest.spawn.map(|s| [s[0] - 0.5, s[1], s[2] - 0.5]); level.respawn_elsewhere = guest.respawn_elsewhere.clone(); level.on_ground = guest.on_ground; + level.seen_credits = guest.seen_credits; level.player_extra = guest.saved.clone(); // The live body's fire, air and fall distance (Entity.saveWithoutId), // or what the file had while the player has no body yet. diff --git a/crates/horizon-client/src/lib.rs b/crates/horizon-client/src/lib.rs index 6bf40d1f0..ebfbdea58 100644 --- a/crates/horizon-client/src/lib.rs +++ b/crates/horizon-client/src/lib.rs @@ -50,6 +50,7 @@ pub mod cooldowns; pub mod crafting; pub mod crash; pub mod creative; +pub mod cushion; pub mod data_cmd; pub mod datapack; pub mod debug_chart; diff --git a/crates/horizon-client/src/lod.rs b/crates/horizon-client/src/lod.rs index a429863a7..1ee61cdf4 100644 --- a/crates/horizon-client/src/lod.rs +++ b/crates/horizon-client/src/lod.rs @@ -752,6 +752,25 @@ impl Lod { saved_order: VecDeque::new(), } } + /// The solid ground at block column (x, z): its top face's height and + /// its block, from the finest tile sampled there. For aiming past the + /// resident chunks (`game.raycast`); water is passed, as the view's ray + /// passes it. + pub fn ground(&self, x: i32, z: i32) -> Option<(i32, BlockStateId)> { + (0..=MAX_LEVEL).find_map(|level| { + let size = 16 << level; + let key = TileKey { + x: x.div_euclid(size), + z: z.div_euclid(size), + level, + }; + let columns = self.ready.get(&key).filter(|c| c.len() == CELLS * CELLS)?; + let cell = size / CELLS as i32; + let (cx, cz) = ((x - key.x * size) / cell, (z - key.z * size) / cell); + let surface = columns[cz as usize * CELLS + cx as usize].surface?; + Some((surface.height, surface.state)) + }) + } pub fn stats(&self) -> (usize, usize) { (self.active.len(), self.ready.len()) } diff --git a/crates/horizon-client/src/main.rs b/crates/horizon-client/src/main.rs index 8004b2fa7..7144a1670 100644 --- a/crates/horizon-client/src/main.rs +++ b/crates/horizon-client/src/main.rs @@ -4,7 +4,13 @@ mod game; use horizon_client::{crash, logging}; +/// The mod API level this game serves, kept in the program for the launcher +/// to read without running it (`horizon_mods::api_level::MARK`). `main` +/// reads it, so the linker keeps it. +static MOD_API_LEVEL: [u8; 27] = horizon_mods::api_level::MARK; + fn main() { + std::hint::black_box(&MOD_API_LEVEL); horizon_client::telemetry::mark_start(); let args: Vec = std::env::args().skip(1).collect(); let game_args = args.iter().take_while(|a| *a != "--dedicated"); diff --git a/crates/horizon-client/src/mesher.rs b/crates/horizon-client/src/mesher.rs index fff3c6aa0..48d2f08bd 100644 --- a/crates/horizon-client/src/mesher.rs +++ b/crates/horizon-client/src/mesher.rs @@ -113,6 +113,14 @@ mod vertex_tests { assert!((a - b).abs() <= 0.5 / 32768.0, "{a} {b}"); } } + #[test] + fn emission_keeps_the_colour_and_the_free_bits() { + let rgb = super::pack_rgb([0x12, 0x34, 0x56]); + assert_eq!(super::emitting(rgb, 0), rgb); + assert_eq!(super::emitting(rgb, 9), 0xF656_3412); + assert_eq!(super::emitting(rgb, 15), 0xF056_3412); + assert_eq!(super::emitting(rgb, 15) | super::EMISSION_BITS, rgb); + } } pub struct SectionMesh { pub solid: Vec, @@ -566,6 +574,14 @@ impl Padded { } /// Set on a terrain vertex's sprite layer when its texture alpha must be ignored. pub const OPAQUE_LAYER: u16 = 1 << 15; +/// The bits of `TerrainVertex::color`'s alpha byte that hold the light its face emits, for +/// HDR output's highlights (`gfx/hdr.rs`): 15 minus the level, so the usual 0xFF means none. +/// The byte's other four bits stay set. +pub const EMISSION_BITS: u32 = 0x0F00_0000; +/// `color` marked as emitting light `level` (0 to 15). +pub fn emitting(color: u32, level: u8) -> u32 { + color & !EMISSION_BITS | u32::from(15 - level.min(15)) << 24 +} const UNSET: u32 = u32::MAX; const NO_BIOME: u16 = u16::MAX; /// The `ColorResolver`s `ClientLevel` caches block tints for. @@ -880,7 +896,7 @@ impl Mesher<'_> { } else { face.layer as u16 }, - pack_rgb(rgb), + emitting(pack_rgb(rgb), state.emission.max(q.light_emission)), pack_coords(lighting::with_emission(coords[i], q.light_emission)), )); } diff --git a/crates/horizon-client/src/mesher/fluid.rs b/crates/horizon-client/src/mesher/fluid.rs index 6e42685ba..d30b914a4 100644 --- a/crates/horizon-client/src/mesher/fluid.rs +++ b/crates/horizon-client/src/mesher/fluid.rs @@ -227,8 +227,11 @@ pub(super) fn tesselate( } else { 0xFF_FFFF }; + // Lava emits light level 15. + let emission = if water { 0 } else { 15 }; let color = |by: f32| { - pack_rgb([16, 8, 0].map(|shift| lighting::scale((tint >> shift & 255) as i32, by) as u32)) + let rgb = [16, 8, 0].map(|shift| lighting::scale((tint >> shift & 255) as i32, by) as u32); + crate::mesher::emitting(pack_rgb(rgb), emission) }; let height = |p: [i32; 3]| -> f32 { let s = at(p); diff --git a/crates/horizon-client/src/mobs/ai.rs b/crates/horizon-client/src/mobs/ai.rs index c9bc15fda..8335cb745 100644 --- a/crates/horizon-client/src/mobs/ai.rs +++ b/crates/horizon-client/src/mobs/ai.rs @@ -1024,6 +1024,10 @@ fn check_despawn(m: &mut Mob, w: &MobWorld) -> bool { if m.species() == Species::Mannequin { return true; } + // Mob.checkDespawn discards disallowed types even when persistent or NoAI. + if w.difficulty.effective == 0.0 && !super::spawn_rules::allowed_in_peaceful(m.species()) { + return false; + } let Some(p) = w.nearest_player else { return true; }; diff --git a/crates/horizon-client/src/mobs/anim.rs b/crates/horizon-client/src/mobs/anim.rs index b2158132b..b81f224ae 100644 --- a/crates/horizon-client/src/mobs/anim.rs +++ b/crates/horizon-client/src/mobs/anim.rs @@ -102,7 +102,7 @@ impl AnimState { pub fn end_tick(&mut self, _swinging: bool) {} } /// Part poses for one draw, keyed by part name. -#[derive(Clone)] +#[derive(Clone, Default)] pub struct Poses { map: HashMap, dummy: [f32; 9], @@ -113,20 +113,24 @@ pub struct Poses { } impl Poses { pub fn new(model: &Part) -> Self { - let mut map = HashMap::new(); + let mut poses = Self::default(); + poses.reset(model); + poses + } + /// Refills this for another model, keeping the map and the sets' capacity: + /// a mob draws its body and every equipment layer each frame. + pub fn reset(&mut self, model: &Part) { fn walk(p: &Part, map: &mut HashMap) { map.insert(p.name.clone(), p.pose); for c in &p.children { walk(c, map); } } - walk(model, &mut map); - Self { - map, - dummy: [0.0; 9], - skipped: Default::default(), - hidden: Default::default(), - } + self.map.clear(); + self.dummy = [0.0; 9]; + self.skipped.clear(); + self.hidden.clear(); + walk(model, &mut self.map); } pub fn get(&mut self, name: &str) -> &mut [f32; 9] { match self.map.get_mut(name) { @@ -189,14 +193,15 @@ pub fn state(m: &Mob, alpha: f32) -> State { swing += 1.0; } let swing = m.anim.attack_anim_o + swing * alpha; - let alive = m.alive(); + // LivingEntityRenderer.extractRenderState: riding motion is not walking. + let walking = m.alive() && !m.extra.passenger; State { - pos: if alive { + pos: if walking { m.limb_position - m.limb_speed * (1.0 - alpha) } else { 0.0 }, - speed: if alive { + speed: if walking { (m.previous_limb_speed + (m.limb_speed - m.previous_limb_speed) * alpha).min(1.0) } else { 0.0 diff --git a/crates/horizon-client/src/mobs/bat.rs b/crates/horizon-client/src/mobs/bat.rs index 9f38e9e60..ca5efa4a2 100644 --- a/crates/horizon-client/src/mobs/bat.rs +++ b/crates/horizon-client/src/mobs/bat.rs @@ -132,6 +132,10 @@ pub fn tick(m: &mut Mob) { } else { m.velocity.y *= 0.6; } + setup_animation_states(m); +} +/// `Bat.setupAnimationStates`: client visuals, without changing server motion. +pub fn setup_animation_states(m: &mut Mob) { let age = m.age as f32; if resting(m) { m.anim.states[0].stop(); diff --git a/crates/horizon-client/src/mobs/enderman.rs b/crates/horizon-client/src/mobs/enderman.rs index fcfba832e..c5ed01680 100644 --- a/crates/horizon-client/src/mobs/enderman.rs +++ b/crates/horizon-client/src/mobs/enderman.rs @@ -138,9 +138,10 @@ fn teleport_towards( let z = m.position.z + (m.random.next_double() - 0.5) * 8.0 - d[2] * 16.0; teleport_to(m, w, x, y, z, events) } -/// Enderman.customServerAiStep: in daylight, flee by teleporting. +/// Enderman.customServerAiStep: in daylight, flee by teleporting. The End has a +/// fixed time, so `Level.isBrightOutside` is never true there. pub fn custom_server_ai_step(m: &mut Mob, cx: &mut Cx) { - if cx.w.daylight && m.age as i32 >= m.extra.counter + 600 { + if cx.w.daylight && !cx.w.end && m.age as i32 >= m.extra.counter + 600 { let br = super::hostile::mob_brightness(m, cx.w); let (x, y, z) = ( m.position.x.floor() as i32, diff --git a/crates/horizon-client/src/mobs/guardian.rs b/crates/horizon-client/src/mobs/guardian.rs index d6219794d..9704de044 100644 --- a/crates/horizon-client/src/mobs/guardian.rs +++ b/crates/horizon-client/src/mobs/guardian.rs @@ -241,9 +241,7 @@ pub fn ai_step(m: &mut Mob, w: &MobWorld, events: &mut Vec) { } else { a.v[SPIKES] += (1.0 - a.v[SPIKES]) * 0.06; } - if m.extra.flag && m.extra.counter2 < attack_duration(m) { - m.extra.counter2 += 1; - } + client_tick(m); if in_water { m.air = 300; } else if m.on_ground { @@ -332,6 +330,13 @@ pub fn elder_server_ai_step(m: &mut Mob, cx: &mut Cx) { ]); } } +/// Guardian.aiStep's visual attack clock, also used by server clients. +/// Does not run attack goals, movement, damage or random draws. +pub fn client_tick(m: &mut Mob) { + if m.extra.flag && m.extra.counter2 < attack_duration(m) { + m.extra.counter2 += 1; + } +} /// The beam's clock for rendering: (attack time with the partial tick, /// attack scale), while a target is locked. pub fn beam(m: &Mob, partial: f32) -> Option<(f32, f32)> { diff --git a/crates/horizon-client/src/mobs/render.rs b/crates/horizon-client/src/mobs/render.rs index bbbf26738..077fd38a6 100644 --- a/crates/horizon-client/src/mobs/render.rs +++ b/crates/horizon-client/src/mobs/render.rs @@ -951,21 +951,25 @@ fn draw_normals( return; } let normals = normals.part(p); - for poly in part.polygons.iter().filter(|_| !poses.skips(part)) { - let normal = poly.vertex_normal(normals); - for v in poly.vertices { - let pos = m.transform_point3(glam::Vec3::new(v[0], v[1], v[2]) / 16.0); - out.push(Vertex { - normal, - pos: pos.to_array(), - uv: [ - uv[0] + (uv[2] - uv[0]) * v[3], - uv[1] + (uv[3] - uv[1]) * v[4], - ], - layer: overlay, - color, - light, - }); + // `skips` is a name lookup: ask once per part, not once per polygon. A part + // hidden this way still draws its children, so only the polygons are gated. + if !poses.skips(part) { + for poly in &part.polygons { + let normal = poly.vertex_normal(normals); + for v in poly.vertices { + let pos = m.transform_point3(glam::Vec3::new(v[0], v[1], v[2]) / 16.0); + out.push(Vertex { + normal, + pos: pos.to_array(), + uv: [ + uv[0] + (uv[2] - uv[0]) * v[3], + uv[1] + (uv[3] - uv[1]) * v[4], + ], + layer: overlay, + color, + light, + }); + } } } for c in &part.children { @@ -1094,6 +1098,9 @@ fn render_visible( } } } + // One Poses refilled for every layer (armour draws up to seven): it keeps + // its maps' capacity. + let mut layer_poses = Poses::default(); for layer in all_layers { let Some(part) = m.kind.layer(&layer.model).cloned() else { continue; @@ -1101,8 +1108,8 @@ fn render_visible( let Some(uv) = atlas(&layer.texture) else { continue; }; - let mut poses = Poses::new(&part); - anim::setup(m, &s, &mut poses, &data.animations); + layer_poses.reset(&part); + anim::setup(m, &s, &mut layer_poses, &data.animations); if matches!(m.species(), Species::Villager | Species::ZombieVillager) && let Some((folder, variant)) = layer .texture @@ -1113,7 +1120,7 @@ fn render_visible( data.villager_hats .read() .unwrap_or_else(std::sync::PoisonError::into_inner) - .apply(folder, variant, profession, &mut poses); + .apply(folder, variant, profession, &mut layer_poses); } let light = if layer.full_bright { 240 | 240 << 8 @@ -1128,7 +1135,16 @@ fn render_visible( None => overlay, }; let start = out.len(); - draw(&part, base, &poses, uv, layer.color, light, overlay, out); + draw( + &part, + base, + &layer_poses, + uv, + layer.color, + light, + overlay, + out, + ); if layer.full_bright && m.species() != Species::Warden { for vertex in &mut out[start..] { vertex.normal = [0; 4]; diff --git a/crates/horizon-client/src/mobs/villager.rs b/crates/horizon-client/src/mobs/villager.rs index 575fafaed..148034323 100644 --- a/crates/horizon-client/src/mobs/villager.rs +++ b/crates/horizon-client/src/mobs/villager.rs @@ -284,12 +284,14 @@ pub fn xp(m: &Mob) -> i32 { m.extra.trade.as_ref().map_or(0, |t| t.xp) } /// `Villager.setVillagerData(withProfession)`: a new profession forgets the -/// offers. +/// offers (`offers = null`), so the next `getOffers` rolls the new +/// profession's trades. pub fn set_profession(m: &mut Mob, profession: u8) { if m.extra.variant2 != profession { m.extra.variant2 = profession; if let Some(t) = m.extra.trade.as_mut() { t.offers.clear(); + t.unset = true; } } } @@ -846,6 +848,70 @@ pub fn read_nbt(m: &mut Mob, tag: &horizon_world::nbt::Tag) { mod tests { use super::*; + fn villager() -> Mob { + use crate::mobs::{Anim, Brain, Flags, MobType, Part, Species}; + use std::{collections::HashMap, sync::Arc}; + let kind = Arc::new(MobType { + id: "minecraft:villager".into(), + species: Species::Villager, + width: 0.6, + height: 1.95, + eye_height: 1.62, + category: "misc".into(), + max_health: 20.0, + speed: 0.5, + flying_speed: 0.02, + attack_damage: 0.0, + attack_knockback: 0.0, + follow_range: 48.0, + step_height: 0.6, + armor: 0.0, + armor_toughness: 0.0, + knockback_resistance: 0.0, + jump_strength: 0.42, + attributes: Arc::default(), + gravity: 0.08, + safe_fall_distance: 3.0, + fall_damage_multiplier: 1.0, + water_efficiency: 0.0, + water_slowdown: 0.8, + air_speed: 0.02, + baby_scale: 0.5, + head_rot_speed: 10.0, + max_head_x_rot: 40.0, + max_head_y_rot: 75.0, + ambient_interval: 80, + flags: Flags::default(), + model: Arc::new(Part::parse("root", &serde_json::json!({}))), + layers: HashMap::new(), + texture: String::new(), + brain: Brain::Passive, + anim: Anim::Villager, + sounds: [""; 3], + step_sound: None, + food: Arc::default(), + tempt: Arc::default(), + }); + Mob::new(1, kind, horizon_core::geometry::Vec3::ZERO, 0.0) + } + #[test] + fn a_new_profession_rolls_new_offers() { + let mut m = villager(); + set_profession(&mut m, 1); + // Offers made for the first profession. + m.extra.trade.get_or_insert_default().unset = false; + // The same profession keeps them. + set_profession(&mut m, 1); + assert!(!m.extra.trade.as_ref().unwrap().unset); + // A new one forgets them (offers = null), so the next getOffers + // (ensure_offers) rolls the new profession's trades. + set_profession(&mut m, 2); + let t = m.extra.trade.as_ref().unwrap(); + assert!(t.offers.is_empty()); + assert!(t.unset); + assert_eq!(m.extra.variant2, 2); + } + fn stack(item: &str, count: u32) -> ItemStack { ItemStack::new(item, count) } diff --git a/crates/horizon-client/src/motion.rs b/crates/horizon-client/src/motion.rs index a6f97981e..0bce8927c 100644 --- a/crates/horizon-client/src/motion.rs +++ b/crates/horizon-client/src/motion.rs @@ -44,7 +44,7 @@ use std::{ pub(crate) mod environment; mod fluids; -pub use fluids::{FluidResources, LAVA, PlayerFluids, WATER}; +pub use fluids::{FluidResources, FluidTags, LAVA, PlayerFluids, WATER}; pub struct MotionResources { pub attributes: Arc, diff --git a/crates/horizon-client/src/motion/fluids.rs b/crates/horizon-client/src/motion/fluids.rs index 89affeb64..894e6d907 100644 --- a/crates/horizon-client/src/motion/fluids.rs +++ b/crates/horizon-client/src/motion/fluids.rs @@ -103,10 +103,10 @@ fn is_tagged(kind: FluidKind, tag: FluidTagId) -> bool { } impl PlayerMotion { pub fn fluid_height(&self, tag: FluidTagId) -> f64 { - self.fluids.interaction.fluid_height(&Membership, tag) + self.fluids.interaction.fluid_height(&FluidTags, tag) } pub fn is_eye_in_fluid(&self, tag: FluidTagId) -> bool { - self.fluids.interaction.is_eye_in_fluid(&Membership, tag) + self.fluids.interaction.is_eye_in_fluid(&FluidTags, tag) } /// `LocalPlayer.isUnderWater`: `wasUnderwater`, the eye sample `Player.tick` /// takes before the base tick (`Entity.isUnderWater` also needs the body @@ -116,11 +116,12 @@ impl PlayerMotion { } /// `Entity.isInLava`. pub fn is_in_lava(&self) -> bool { - !self.fluids.first_tick && self.fluids.interaction.is_in_fluid(&Membership, LAVA) + !self.fluids.first_tick && self.fluids.interaction.is_in_fluid(&FluidTags, LAVA) } } -struct Membership; -impl FluidMembership for Membership { +/// Which fluids `FluidTags.WATER` and `FluidTags.LAVA` hold. +pub struct FluidTags; +impl FluidMembership for FluidTags { fn fluid_in_tag(&self, kind: FluidKind, tag: FluidTagId) -> bool { is_tagged(kind, tag) } diff --git a/crates/horizon-client/src/moved_extras.rs b/crates/horizon-client/src/moved_extras.rs index 3b5db6fbc..4c99a49bf 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; 3] = [ +pub const MOVED: [Moved; 4] = [ Moved { id: "fps_overlay", name: "FPS counter", @@ -38,6 +38,10 @@ pub const MOVED: [Moved; 3] = [ id: "zoom", name: "Zoom", }, + Moved { + id: "minimap", + name: "Minimap", + }, ]; impl Moved { @@ -45,7 +49,8 @@ impl Moved { match self.id { "fps_overlay" => e.fps, "keystrokes" => e.keystrokes, - _ => e.zoom, + "zoom" => e.zoom, + _ => e.minimap, } } /// The extra's settings as the mod keeps them (its storage keys). @@ -60,11 +65,21 @@ impl Moved { ("corner", e.keystrokes_corner.name().into()), ("cps", flag(e.keystrokes_cps)), ], - _ => vec![ + "zoom" => vec![ ("level", e.zoom_level.to_string()), ("smooth", flag(e.zoom_smooth)), ("sensitivity", flag(e.zoom_sensitivity)), ], + _ => vec![ + ("corner", e.minimap_corner.name().into()), + ("size", e.minimap_size.to_string()), + ( + "shape", + if e.minimap_round { "round" } else { "square" }.into(), + ), + ("zoom", e.minimap_zoom.to_string()), + ("rotate", flag(e.minimap_rotate)), + ], } } /// The extra's key as the mod's key (`horizon-mods.txt`), when the @@ -149,21 +164,21 @@ pub fn fetch_index() -> Result { /// Installs `m` into the game folder `dir` (where `options.txt` is), for a /// player whose extras were `e`: its newest version for this game that -/// wasn't taken down, checked against the index (size, SHA-256, signature, -/// manifest), as `horizon-mods/.hmod`, turned on, with the extra's -/// settings in its storage unless the mod has its own already. +/// wasn't taken down and that this Horizon's mod API level runs, checked +/// against the index (size, SHA-256, signature, manifest), as +/// `horizon-mods/.hmod`, turned on, with the extra's settings in its +/// storage unless the mod has its own already. pub fn install(index: &Index, m: &Moved, e: &Extras, dir: &Path) -> Result<(), String> { let project = index .project(m.id) .ok_or_else(|| format!("{} isn't in Horizon's registry yet", m.id))?; - let version = project - .versions - .iter() - .find(|v| { - v.game == horizon_core::version::VERSION_ID - && index.revoked(&project.id, &v.file.sha256).is_none() - }) - .ok_or_else(|| format!("{} has no version for this game", m.id))?; + let version = index + .installable( + project, + horizon_core::version::VERSION_ID, + horizon_mods::api_level::LEVEL, + ) + .ok_or_else(|| format!("{} has no version this Horizon can run", m.id))?; let mods = dir.join(crate::mod_list::DIR); fs::create_dir_all(&mods).map_err(|e| format!("{}: {e}", mods.display()))?; let target = mods.join(format!("{}.hmod", m.id)); @@ -208,7 +223,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(), 3); + assert_eq!(nothing_to_do(&e).len(), 4); e.fps = true; e.fps_corner = Corner::BottomRight; e.fps_lows = true; @@ -223,7 +238,7 @@ mod tests { ); e.moved.push("fps_overlay".into()); assert!(pending(&e).is_empty()); - assert_eq!(nothing_to_do(&e), [&MOVED[1], &MOVED[2]]); + assert_eq!(nothing_to_do(&e), [&MOVED[1], &MOVED[2], &MOVED[3]]); // Zoom: its settings, and its key only when the player changed it. e.zoom = true; e.zoom_level = 8; @@ -240,6 +255,23 @@ mod tests { 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())]); + // The minimap: its five settings, in the extra's values. + e.minimap = true; + e.minimap_corner = Corner::BottomLeft; + e.minimap_size = 128; + e.minimap_round = true; + e.minimap_zoom = 0.5; + assert_eq!(pending(&e), [&MOVED[2], &MOVED[3]]); + assert_eq!( + MOVED[3].settings(&e), + [ + ("corner", "bottom_left".into()), + ("size", "128".into()), + ("shape", "round".into()), + ("zoom", "0.5".into()), + ("rotate", "false".into()) + ] + ); assert_eq!( MOVED[0].notice(), "FPS counter moved to the mod browser: installed for you" diff --git a/crates/horizon-client/src/multiplayer.rs b/crates/horizon-client/src/multiplayer.rs index 07d8552ff..39ea26502 100644 --- a/crates/horizon-client/src/multiplayer.rs +++ b/crates/horizon-client/src/multiplayer.rs @@ -11,9 +11,15 @@ use std::{ collections::HashMap, path::{Path, PathBuf}, sync::{Arc, Mutex}, - time::Duration, + time::{Duration, Instant}, }; +const SERVER_NAME: crate::clipboard::FieldId = ("server.name", 0); +const SERVER_ADDRESS: crate::clipboard::FieldId = ("server.address", 0); +const SERVER_DIRECT: crate::clipboard::FieldId = ("server.direct", 0); +const FRIEND_CODE: crate::clipboard::FieldId = ("friend.code", 0); +const FRIEND_RELAY: crate::clipboard::FieldId = ("friend.relay", 0); + /// The result of pinging one address. #[derive(Clone, Debug)] pub enum Ping { @@ -491,7 +497,7 @@ impl Screen { w / 2.0 - 100.0, h / 4.0 + 96.0 + 18.0, 200.0, - "Done", + &crate::lang::get_or("gui.done", "Done"), servers::parse_address(address).is_some(), 50, ), @@ -499,7 +505,7 @@ impl Screen { w / 2.0 - 100.0, h / 4.0 + 120.0 + 18.0, 200.0, - "Cancel", + &crate::lang::get_or("gui.cancel", "Cancel"), true, 51, ), @@ -532,7 +538,7 @@ impl Screen { w / 2.0 - 100.0, h / 4.0 + 96.0 + 12.0, 200.0, - "Join Server", + &crate::lang::get_or("selectServer.select", "Join Server"), servers::parse_address(address).is_some(), 52, ), @@ -540,7 +546,7 @@ impl Screen { w / 2.0 - 100.0, h / 4.0 + 120.0 + 12.0, 200.0, - "Cancel", + &crate::lang::get_or("gui.cancel", "Cancel"), true, 53, ), @@ -558,7 +564,7 @@ impl Screen { w / 2.0 - 100.0, h / 4.0 + 120.0 + 18.0, 200.0, - "Cancel", + &crate::lang::get_or("gui.cancel", "Cancel"), true, 57, ), @@ -568,7 +574,7 @@ impl Screen { w / 2.0 - 100.0, h / 2.0 + 30.0, 200.0, - "Back to Server List", + &crate::lang::get_or("gui.toMenu", "Back to Server List"), true, 54, )]; @@ -587,18 +593,21 @@ impl Screen { } } /// An EditBox and its label: the label at `label_y` (one pixel in, in - /// 0xA0A0A0), the 200x20 box at `box_y`. + /// 0xA0A0A0), the 200x20 box at `box_y`. The box is the same `EditBox` + /// the world screens edit (`Caret`): cursor, selection and scrolling. fn field( atlas: &HudAtlas, batch: &mut HudBatch, + caret: &mut crate::ui::Caret, + focused_at: Instant, label: &str, value: &str, + id: crate::clipboard::FieldId, + max: usize, (label_y, box_y): (f32, f32), focused: bool, - blink: bool, ) { let x = (batch.width.ceil() / 2.0).floor() - 100.0; - crate::widgets::target_as([x, box_y, 200.0, 20.0], crate::widgets::Kind::Field); batch.text( atlas, label, @@ -607,35 +616,25 @@ impl Screen { rgba(160, 160, 160, 255), true, ); - batch.fill( + caret.draw( + batch, atlas, - x, - box_y, - 200.0, - 20.0, - if focused { - u32::MAX - } else { - rgba(160, 160, 160, 255) - }, - ); - batch.fill(atlas, x + 1.0, box_y + 1.0, 198.0, 18.0, rgba(0, 0, 0, 255)); - let shown = if focused && blink { - format!("{value}_") - } else { - value.to_owned() - }; - batch.text( - atlas, - &shown, - x + 4.0, - box_y + 6.0, - rgba(224, 224, 224, 255), - true, + (id, value, max), + [x, box_y, 200.0, 20.0], + focused, + focused_at, ); } - pub fn draw(&self, atlas: &HudAtlas, batch: &mut HudBatch, blink: bool, cursor: (f32, f32)) { + pub fn draw( + &self, + atlas: &HudAtlas, + batch: &mut HudBatch, + caret: &mut crate::ui::Caret, + focused_at: Instant, + cursor: (f32, f32), + ) { let (w, h) = (batch.width, batch.height); + let max = self.max_length(); crate::ui::menu_background(batch, atlas, 0.0, 0.0, w, h, false); let centered = |batch: &mut HudBatch, text: &str, y: f32, color: u32| { let tw = HudBatch::text_width(atlas, text); @@ -876,10 +875,10 @@ impl Screen { } => { centered( batch, - if index.is_some() { - "Edit Server Info" + &if index.is_some() { + crate::lang::get_or("manageServer.edit.title", "Edit Server Info") } else { - "Add Server" + crate::lang::get_or("manageServer.add.title", "Add Server") }, 17.0, u32::MAX, @@ -888,20 +887,26 @@ impl Screen { Self::field( atlas, batch, - "Server Name", + caret, + focused_at, + &crate::lang::get_or("manageServer.enterName", "Server Name"), name, + SERVER_NAME, + max, (53.0, 66.0), *focus == 0, - blink, ); Self::field( atlas, batch, - "Server Address", + caret, + focused_at, + &crate::lang::get_or("manageServer.enterIp", "Server Address"), address, + SERVER_ADDRESS, + max, (94.0, 106.0), *focus == 1, - blink, ); } Self::Direct { address } => { @@ -916,11 +921,14 @@ impl Screen { Self::field( atlas, batch, - &crate::lang::get_or("addServer.enterIp", "Server Address"), + caret, + focused_at, + &crate::lang::get_or("manageServer.enterIp", "Server Address"), address, + SERVER_DIRECT, + max, (100.0, 116.0), true, - blink, ); } Self::ConfirmDelete { name, lines, .. } => { @@ -954,26 +962,32 @@ impl Screen { Self::field( atlas, batch, + caret, + focused_at, "Invite Code", code, + FRIEND_CODE, + max, (53.0, 64.0), *focus == 0, - blink, ); Self::field( atlas, batch, + caret, + focused_at, "Relay (optional)", relay, + FRIEND_RELAY, + max, (94.0, 105.0), *focus == 1, - blink, ); } Self::Disconnected { reason, retry } => { centered( batch, - "Connection Lost", + &crate::lang::get_or("disconnect.lost", "Connection Lost"), h / 2.0 - 40.0, rgba(170, 170, 170, 255), ); @@ -1019,7 +1033,7 @@ impl Screen { (Self::List { .. }, Some(42)) => { *self = Self::Edit { index: None, - name: "Minecraft Server".into(), + name: crate::lang::get_or("selectServer.defaultName", "Minecraft Server"), address: String::new(), focus: 1, packs: None, @@ -1261,6 +1275,19 @@ impl Screen { scroll.release(); } } + /// The focused box, in GUI pixels: name at 66, address at 106 + /// (`ManageServerScreen`), direct address at 116, friend fields at 64 and 105. + pub fn focused_box(&self, (w, _h): (f32, f32)) -> Option<[f32; 4]> { + let y = match self { + Self::Edit { focus: 0, .. } => 66.0, + Self::Edit { .. } => 106.0, + Self::Direct { .. } => 116.0, + Self::Friend { focus: 0, .. } => 64.0, + Self::Friend { .. } => 105.0, + _ => return None, + }; + Some([(w / 2.0).floor() - 100.0, y, 200.0, 20.0]) + } fn focused_field(&mut self) -> Option<&mut String> { match self { Self::Edit { @@ -1297,11 +1324,11 @@ impl Screen { /// The focused text field, its id and maximum length (copy and paste). pub fn focused_text(&mut self) -> Option<(crate::clipboard::FieldId, &mut String, usize)> { let id = match self { - Self::Edit { focus: 0, .. } => ("server.name", 0), - Self::Edit { .. } => ("server.address", 0), - Self::Direct { .. } => ("server.direct", 0), - Self::Friend { focus: 0, .. } => ("friend.code", 0), - Self::Friend { .. } => ("friend.relay", 0), + Self::Edit { focus: 0, .. } => SERVER_NAME, + Self::Edit { .. } => SERVER_ADDRESS, + Self::Direct { .. } => SERVER_DIRECT, + Self::Friend { focus: 0, .. } => FRIEND_CODE, + Self::Friend { .. } => FRIEND_RELAY, _ => return None, }; let max = self.max_length(); @@ -1315,21 +1342,6 @@ impl Screen { 128 } } - pub fn type_text(&mut self, text: &str) { - let max = self.max_length(); - if let Some(field) = self.focused_field() { - for c in text.chars().filter(|c| !c.is_control()) { - if field.chars().count() < max { - field.push(c); - } - } - } - } - pub fn backspace(&mut self) { - if let Some(field) = self.focused_field() { - field.pop(); - } - } pub fn tab(&mut self) { if let Self::Edit { focus, .. } | Self::Friend { focus, .. } = self { *focus = (*focus + 1) % 2; diff --git a/crates/horizon-client/src/options_ui.rs b/crates/horizon-client/src/options_ui.rs index b0df37367..61fda9878 100644 --- a/crates/horizon-client/src/options_ui.rs +++ b/crates/horizon-client/src/options_ui.rs @@ -3377,7 +3377,7 @@ mod tests { s.extras ); // In a window too short for the page, the wheel scrolls to its end. - let short = (480.0, 300.0); + let short = (480.0, 180.0); ui.scroll(&s, short, -1000.0); let (_, top, bottom, content) = ui.layout(&s, short.0, short.1); assert!(content > bottom - top); diff --git a/crates/horizon-client/src/save.rs b/crates/horizon-client/src/save.rs index 246bacbac..3c2c0c4dc 100644 --- a/crates/horizon-client/src/save.rs +++ b/crates/horizon-client/src/save.rs @@ -568,6 +568,12 @@ pub fn encode_block_entity( } } BlockEntity::Sculk(s) => entries.extend(s.to_nbt()), + // CampfireBlockEntity.saveAdditional. + BlockEntity::Campfire(c) => { + entries.push(("Items", encode_items(&c.items))); + entries.push(("CookingTimes", Tag::IntArray(c.progress.to_vec()))); + entries.push(("CookingTotalTimes", Tag::IntArray(c.total.to_vec()))); + } BlockEntity::Crafter(c) => { entries.push(("Items", encode_items(&c.items))); entries.push(( @@ -718,8 +724,10 @@ pub fn decode_block_entity(tag: &Tag) -> Option<((i32, i32, i32), crate::contain Tag::Int(n) => *n, _ => continue, }; - f.recipes_used - .insert(id.to_string_lossy(), count.max(0) as u32); + // Saves from before the key was namespaced hold both forms of an id. + *f.recipes_used + .entry(crate::containers::recipe_used_key(&id.to_string_lossy())) + .or_insert(0) += count.max(0) as u32; } } } @@ -746,6 +754,18 @@ pub fn decode_block_entity(tag: &Tag) -> Option<((i32, i32, i32), crate::contain } BlockEntity::Sign(sign) => sign.decode(tag), BlockEntity::Sculk(s) => s.load(tag), + // CampfireBlockEntity.loadAdditional: missing time arrays stay zeros. + BlockEntity::Campfire(c) => { + for (slot, item) in decode_items(tag.get("Items"), 4).into_iter().enumerate() { + c.items[slot] = item; + } + let ints = |key: &str| match tag.get(key) { + Some(Tag::IntArray(v)) => std::array::from_fn(|i| v.get(i).copied().unwrap_or(0)), + _ => [0; 4], + }; + c.progress = ints("CookingTimes"); + c.total = ints("CookingTotalTimes"); + } BlockEntity::Crafter(c) => { for (slot, item) in decode_items(tag.get("Items"), 9).into_iter().enumerate() { c.items[slot] = item; @@ -873,18 +893,67 @@ fn poi_root(sections: Compound) -> NamedTag { } } +/// What a dimension's saved chunks depend on: skylight and the build height +/// (`DimensionType.minY` and `height`). `Chunk` always holds the Overworld's +/// sections; a level saves only the ones inside its own height. +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub struct LevelShape { + pub sky_light: bool, + pub min_y: i32, + pub height: i32, +} +impl LevelShape { + pub const OVERWORLD: Self = Self { + sky_light: true, + min_y: MIN_Y, + height: SECTIONS as i32 * 16, + }; + pub const NETHER: Self = Self { + sky_light: false, + min_y: 0, + height: 256, + }; + pub const END: Self = Self { + sky_light: true, + min_y: 0, + height: 256, + }; + /// The shape of a dimension folder (`dimensions/minecraft/`, or the + /// old `DIM-1` and `DIM1`). + pub fn for_dir(root: &Path) -> Self { + if root.ends_with("the_nether") || root.ends_with("DIM-1") { + Self::NETHER + } else if root.ends_with("the_end") || root.ends_with("DIM1") { + Self::END + } else { + Self::OVERWORLD + } + } + fn min_section(self) -> i32 { + self.min_y >> 4 + } + fn section_count(self) -> usize { + (self.height >> 4) as usize + } + fn has_section(self, y: i32) -> bool { + (self.min_section()..self.min_section() + self.section_count() as i32).contains(&y) + } +} + /// A column's sections as `Heightmap.primeHeightmaps` reads them. struct HeightmapView<'a> { sections: &'a [Arc
], tables: &'a SaveTables, + min_y: i32, + height: i32, } impl HeightmapChunk for HeightmapView<'_> { type State = crate::assets::StateFacts; fn min_y(&self) -> i32 { - MIN_Y + self.min_y } fn height(&self) -> i32 { - SECTIONS as i32 * 16 + self.height } fn highest_section_y(&self) -> i32 { let top = self @@ -904,7 +973,7 @@ impl HeightmapChunk for HeightmapView<'_> { } } /// Heightmaps kept after world generation (`ChunkStatus.FULL.heightmapsAfter`). -fn heightmaps(chunk: &Chunk, tables: &SaveTables) -> Tag { +fn heightmaps(chunk: &Chunk, tables: &SaveTables, shape: LevelShape) -> Tag { let kinds = [ HeightmapType::WorldSurface, HeightmapType::OceanFloor, @@ -913,11 +982,13 @@ fn heightmaps(chunk: &Chunk, tables: &SaveTables) -> Tag { ]; let mut maps: Vec = kinds .iter() - .filter_map(|k| Heightmap::new(*k, MIN_Y, SECTIONS as i32 * 16).ok()) + .filter_map(|k| Heightmap::new(*k, shape.min_y, shape.height).ok()) .collect(); let view = HeightmapView { sections: &chunk.sections, tables, + min_y: shape.min_y, + height: shape.height, }; let mut refs: Vec<&mut Heightmap> = maps.iter_mut().collect(); if Heightmap::prime(&view, &mut refs).is_err() { @@ -947,7 +1018,12 @@ pub fn client_heightmaps_in( .iter() .filter_map(|(id, k)| Heightmap::new(*k, min_y, height).ok().map(|m| (*id, m))) .collect(); - let view = HeightmapView { sections, tables }; + let view = HeightmapView { + sections, + tables, + min_y, + height, + }; let mut refs: Vec<&mut Heightmap> = maps.iter_mut().map(|(_, m)| m).collect(); if Heightmap::prime(&view, &mut refs).is_err() { return Vec::new(); @@ -973,17 +1049,18 @@ fn nibbles(light: &Light, sky: bool) -> Vec { } pub fn encode(chunk: &Chunk, registry: &BlockRegistry, biomes: &Biomes) -> NamedTag { - encode_with(chunk, registry, biomes, None, true) + encode_with(chunk, registry, biomes, None, LevelShape::OVERWORLD) } /// The chunk NBT vanilla's `SerializableChunkData.write` produces for a full -/// chunk. `sky_light` is false in dimensions without skylight. +/// chunk in a level of `shape`. pub fn encode_with( chunk: &Chunk, registry: &BlockRegistry, biomes: &Biomes, tables: Option<&SaveTables>, - sky_light: bool, + shape: LevelShape, ) -> NamedTag { + let sky_light = shape.sky_light; let mut sections = Vec::new(); let air = tables.map_or(0, |t| t.air); // Sky layers below the highest section with light other than 15 are @@ -995,6 +1072,9 @@ pub fn encode_with( }); for (si, section) in chunk.sections.iter().enumerate() { let y = (MIN_Y >> 4) + si as i32; + if !shape.has_section(y) { + continue; + } // PalettedContainer.pack: distinct states in index order, indices at // the saved width. let packed = section.blocks.pack(); @@ -1124,7 +1204,7 @@ pub fn encode_with( ("DataVersion", Tag::Int(DATA_VERSION)), ("xPos", Tag::Int(chunk.x)), ("zPos", Tag::Int(chunk.z)), - ("yPos", Tag::Int(MIN_Y >> 4)), + ("yPos", Tag::Int(shape.min_section())), ("Status", string("minecraft:full")), ("LastUpdate", Tag::Long(extras.map_or(0, |e| e.last_update))), ("isLightOn", Tag::Byte(i8::from(chunk.lit))), @@ -1156,11 +1236,30 @@ pub fn encode_with( .collect(); s.insert("References".into(), Tag::Compound(refs)); } + let starts: Compound = chunk + .structure_starts + .iter() + .filter_map(|start| match start.save() { + Some(tag) => Some((start.name.as_str().into(), tag)), + None => { + log::warn!( + "Horizon: structure start {} not saved: one of its pieces cannot be", + start.name + ); + None + } + }) + .collect(); + if !starts.is_empty() + && let Some(Tag::Compound(s)) = map.get_mut(&"structures".into()) + { + s.insert("starts".into(), Tag::Compound(starts)); + } map.entry("PostProcessing".into()) - .or_insert_with(|| Tag::List(vec![Tag::List(Vec::new()); SECTIONS])); + .or_insert_with(|| Tag::List(vec![Tag::List(Vec::new()); shape.section_count()])); } if let Some(t) = tables { - put(&mut root, "Heightmaps", heightmaps(chunk, t)); + put(&mut root, "Heightmaps", heightmaps(chunk, t, shape)); let names = |k: u32| t.block_names.get(k as usize).cloned(); let (blocks, fluids) = extras.map_or((&[][..], &[][..]), |e| { (&e.block_ticks[..], &e.fluid_ticks[..]) @@ -1376,18 +1475,19 @@ pub fn encode_proto( registry: &BlockRegistry, biomes: &Biomes, tables: Option<&SaveTables>, - sky_light: bool, + shape: LevelShape, ) -> NamedTag { - let mut root = encode_with(&proto.column, registry, biomes, tables, sky_light); + let mut root = encode_with(&proto.column, registry, biomes, tables, shape); let status = if proto.decorated { ChunkStatus::Features } else { ChunkStatus::Terrain }; // ProtoChunk.postProcessing: one list per section, packed section offsets. - let mut marks = vec![Vec::new(); SECTIONS]; + let mut marks = vec![Vec::new(); shape.section_count()]; for &[x, y, z] in &proto.column.postprocess { - if let Some(list) = marks.get_mut(((y - MIN_Y) >> 4) as usize) { + let section = usize::try_from((y - shape.min_y) >> 4).ok(); + if let Some(list) = section.and_then(|s| marks.get_mut(s)) { list.push(Tag::Short( ((x & 15) | (y & 15) << 4 | (z & 15) << 8) as i16, )); @@ -1704,7 +1804,7 @@ struct Encoding { registry: &'static BlockRegistry, biomes: Arc, tables: Option>, - sky_light: bool, + shape: LevelShape, } impl Record { fn tag(&self) -> Option> { @@ -1715,7 +1815,7 @@ impl Record { e.registry, &e.biomes, e.tables.as_deref(), - e.sky_light, + e.shape, ))), Record::Poi(c, t) => encode_poi(c, t).map(Arc::new), Record::Delete => None, @@ -1825,12 +1925,12 @@ pub struct SaveDir { outstanding: Arc, /// Set by `Persistent` before the first load. pub tables: OnceLock>, - /// False in dimensions without skylight (no SkyLight layers are written). - pub sky_light: bool, + /// The dimension's skylight and height, from its folder name. + pub shape: LevelShape, } impl SaveDir { pub fn new(root: PathBuf) -> Self { - let sky_light = !root.ends_with("the_nether") && !root.ends_with("DIM-1"); + let shape = LevelShape::for_dir(&root); Self { root, regions: Default::default(), @@ -1841,7 +1941,7 @@ impl SaveDir { writer: Mutex::new(None), outstanding: Default::default(), tables: OnceLock::new(), - sky_light, + shape, } } fn region_path(&self, folder: &str, rx: i32, rz: i32) -> PathBuf { @@ -1868,7 +1968,7 @@ impl SaveDir { let root = self.read_record("region", x, z)?; let tables = self.tables.get().map(|t| &**t); let mut chunk = decode_with(&root, registry, biomes, tables)?; - load_light(&root.tag, &mut chunk, self.sky_light); + load_light(&root.tag, &mut chunk, self.shape.sky_light); Some(chunk) } /// A proto chunk saved before it became final (`decode_proto`). @@ -1893,7 +1993,7 @@ impl SaveDir { let records = protos .iter() .map(|p| { - let tag = encode_proto(p, registry, biomes, tables, self.sky_light); + let tag = encode_proto(p, registry, biomes, tables, self.shape); ((p.column.x, p.column.z), Some(tag)) }) .collect(); @@ -2071,7 +2171,7 @@ impl SaveDir { .map(|c| { ( (c.x, c.z), - Some(encode_with(c, registry, biomes, tables, self.sky_light)), + Some(encode_with(c, registry, biomes, tables, self.shape)), ) }) .collect(); @@ -2101,7 +2201,7 @@ impl SaveDir { registry, biomes: biomes.clone(), tables: self.tables.get().cloned(), - sky_light: self.sky_light, + shape: self.shape, }); let records = chunks .iter() @@ -3572,7 +3672,7 @@ impl SaveDir { { return None; } - decode_lod_surfaces(&root, assets, biomes, self.sky_light) + decode_lod_surfaces(&root, assets, biomes, self.shape.sky_light) } } @@ -3791,6 +3891,71 @@ mod tests { assert_eq!(saved.tag, expected.tag); } + #[test] + fn nether_and_end_chunks_save_with_their_own_height() { + let Some(root) = std::env::var_os("HORIZON_TEST_RESOURCES") else { + return; + }; + let root = PathBuf::from(root); + let assets = crate::assets::Assets::load(&root).expect("assets"); + let biomes = Biomes::load(&root).expect("biomes"); + let tables = SaveTables::new(&assets); + let rack = assets + .registry + .default_state("minecraft:netherrack") + .unwrap(); + let mut chunk = Chunk::empty(0, 0); + for y in 0..128 { + chunk.set(0, y, 0, rack.0); + } + let saved = encode_with( + &chunk, + assets.registry, + &biomes, + Some(&tables), + LevelShape::NETHER, + ); + assert_eq!(number(saved.tag.get("yPos")), Some(0)); + let Some(Tag::List(sections)) = saved.tag.get("sections") else { + panic!("no sections"); + }; + let ys: Vec = sections + .iter() + .filter_map(|s| number(s.get("Y")).map(|y| y as i32)) + .collect(); + assert_eq!(ys, (0..16).collect::>()); + let Some(Tag::List(post)) = saved.tag.get("PostProcessing") else { + panic!("no PostProcessing"); + }; + assert_eq!(post.len(), 16); + // Heightmap values count from the level's minimum: the column's top + // block at y=127 reads 128 (vanilla), not 192 (from the Overworld's -64). + let Some(Tag::LongArray(surface)) = saved + .tag + .get("Heightmaps") + .and_then(|h| h.get("WORLD_SURFACE")) + else { + panic!("no WORLD_SURFACE"); + }; + assert_eq!(surface[0] & 0x1ff, 128); + let overworld = encode_with( + &chunk, + assets.registry, + &biomes, + Some(&tables), + LevelShape::OVERWORLD, + ); + assert_eq!(number(overworld.tag.get("yPos")), Some(-4)); + assert_eq!( + LevelShape::for_dir(Path::new("w/dimensions/minecraft/the_end")), + LevelShape::END + ); + assert_eq!( + LevelShape::for_dir(Path::new("w/DIM-1")), + LevelShape::NETHER + ); + } + #[test] fn saved_far_surface_reads_builds_and_water_without_gameplay_chunks() { let Some(root) = std::env::var_os("HORIZON_TEST_RESOURCES") else { @@ -3909,7 +4074,7 @@ mod tests { "unfinished proto saves must not suppress complete decoration" ); let mut nether = SaveDir::new(dir.clone()); - nether.sky_light = false; + nether.shape = LevelShape::NETHER; let dark = nether.lod_surfaces(-2, 3, &assets, &biomes).unwrap(); assert!( dark.iter() @@ -4228,6 +4393,31 @@ mod tests { assert_eq!(back.redstone_signal(), 2); } #[test] + fn campfire_block_entity_round_trips() { + let mut c = crate::containers::Campfire::default(); + c.items[1] = Some(crate::items::ItemStack::new("minecraft:beef", 1)); + c.progress[1] = 120; + c.total[1] = 600; + let tag = encode_block_entity( + (3, 64, -2), + &crate::containers::BlockEntity::Campfire(Box::new(c.clone())), + "minecraft:soul_campfire", + ); + // One block entity type for both campfires. + assert_eq!(text(tag.get("id")).as_deref(), Some("minecraft:campfire")); + let (pos, back) = decode_block_entity(&tag).expect("campfire"); + assert_eq!(pos, (3, 64, -2)); + let crate::containers::BlockEntity::Campfire(back) = back else { + panic!("not a campfire"); + }; + assert_eq!(*back, c); + // The update tag a server's clients get: the items alone. + let update = + crate::lan::chunks::entity_tag(&crate::containers::BlockEntity::Campfire(Box::new(c))) + .expect("update tag"); + assert!(update.get("Items").is_some() && update.get("CookingTimes").is_none()); + } + #[test] fn spawner_block_entity_round_trips() { // A dungeon spawner as vanilla saves it (`id` is mob_spawner, not the block). let saved = horizon_world::nbt::parse_snbt( @@ -4737,4 +4927,28 @@ mod tests { }; assert_eq!(back.recipes_used.get("minecraft:cooked_porkchop"), Some(&3)); } + + /// A save written before the key was namespaced holds an id twice, once bare: vanilla + /// refuses such a furnace, so a load merges them under the full id. + #[test] + fn a_furnaces_recipes_used_merges_bare_and_full_ids() { + use crate::containers::BlockEntity; + let Some(BlockEntity::Furnace(mut f)) = BlockEntity::for_block("minecraft:furnace") else { + panic!("a furnace"); + }; + f.recipes_used + .insert("iron_ingot_from_smelting_iron_ore".to_owned(), 2); + f.recipes_used + .insert("minecraft:iron_ingot_from_smelting_iron_ore".to_owned(), 3); + let tag = encode_block_entity((1, 64, 2), &BlockEntity::Furnace(f), "minecraft:furnace"); + let Some((_, BlockEntity::Furnace(back))) = decode_block_entity(&tag) else { + panic!("a furnace back"); + }; + assert_eq!(back.recipes_used.len(), 1); + assert_eq!( + back.recipes_used + .get("minecraft:iron_ingot_from_smelting_iron_ore"), + Some(&5) + ); + } } diff --git a/crates/horizon-client/src/sprint.rs b/crates/horizon-client/src/sprint.rs index c2099306c..872667b55 100644 --- a/crates/horizon-client/src/sprint.rs +++ b/crates/horizon-client/src/sprint.rs @@ -134,3 +134,76 @@ impl SprintState { Ok(()) } } + +#[cfg(test)] +mod tests { + use super::*; + + fn standing() -> Conditions { + Conditions { + enough_food: true, + on_ground: true, + ..Conditions::default() + } + } + + fn step(state: &mut SprintState, keys: Keys, sprinting: &mut bool) { + let current = *sprinting; + let mut next = current; + state + .tick( + keys, + Conditions { + sprinting: current, + ..standing() + }, + 7, + |value| { + next = value; + Ok::<(), ()>(()) + }, + ) + .unwrap(); + *sprinting = next; + } + + /// Vanilla sprint is a state. Releasing the sprint key, including on the + /// jump tick, keeps it while forward is held; releasing forward stops it. + #[test] + fn sprint_survives_releasing_the_key_through_a_jump() { + let mut state = SprintState::default(); + let mut sprinting = false; + step( + &mut state, + Keys { + forward: true, + sprint: true, + ..Keys::default() + }, + &mut sprinting, + ); + assert!(sprinting); + step( + &mut state, + Keys { + forward: true, + jump: true, + ..Keys::default() + }, + &mut sprinting, + ); + assert!( + sprinting, + "a jump after the sprint key comes up must stay a sprint" + ); + step( + &mut state, + Keys { + jump: true, + ..Keys::default() + }, + &mut sprinting, + ); + assert!(!sprinting); + } +} diff --git a/crates/horizon-client/src/stations.rs b/crates/horizon-client/src/stations.rs index 715c2663e..a307b35cf 100644 --- a/crates/horizon-client/src/stations.rs +++ b/crates/horizon-client/src/stations.rs @@ -14,7 +14,8 @@ use std::{fs, path::Path, sync::Arc}; /// Everything the workstation menus read, loaded once with the resources. pub struct StationData { - pub enchantments: Enchantments, + /// The same registry `Items` carries (`Items::enchantments`). + pub enchantments: std::sync::Arc, pub recipes: StationRecipes, pub brewing: crate::brewing::Brewing, pub trades: crate::merchant::Trades, @@ -25,7 +26,7 @@ pub struct StationData { impl StationData { pub fn load(root: &Path, items: &Items) -> Self { Self { - enchantments: Enchantments::load(root), + enchantments: std::sync::Arc::clone(&items.enchantments), recipes: StationRecipes::load(root, items), brewing: crate::brewing::Brewing::load(root, items), trades: crate::merchant::Trades::load(root), @@ -174,7 +175,9 @@ pub fn increased_repair_cost(cost: u32) -> u32 { pub fn hover_name(names: &dyn Fn(&str) -> String, stack: &ItemStack) -> String { stack .custom_name() - .map_or_else(|| names(&stack.item), str::to_owned) + .map(str::to_owned) + .or_else(|| stack.item_name()) + .unwrap_or_else(|| names(&stack.item)) } /// `AnvilMenu.createResult`. `name` is the rename box text (None = untouched). pub fn anvil_result( diff --git a/crates/horizon-client/src/streaming.rs b/crates/horizon-client/src/streaming.rs index 103f7402b..643a604bc 100644 --- a/crates/horizon-client/src/streaming.rs +++ b/crates/horizon-client/src/streaming.rs @@ -639,8 +639,12 @@ impl Streaming { self.lit.remove(&(x, z)); self.meshed.remove(&(x, z)); self.lighting.remove(&(x, z)); - self.meshing.retain(|k, _| (k.0, k.2) != (x, z)); - self.waiting.retain(|k| (k.0, k.2) != (x, z)); + // By key, not by a pass over every pending section: a moved or + // shrunk storage forgets thousands of columns in one frame. + for sy in 0..SECTIONS as i32 { + self.meshing.remove(&(x, sy, z)); + self.waiting.remove(&(x, sy, z)); + } world.dirty_sections.take_column(x, z); world.chunks.remove(&(x, z)) } diff --git a/crates/horizon-client/src/terrain.wgsl b/crates/horizon-client/src/terrain.wgsl index c0a2fc6fd..c0cf44bb5 100644 --- a/crates/horizon-client/src/terrain.wgsl +++ b/crates/horizon-client/src/terrain.wgsl @@ -69,6 +69,8 @@ struct TerrainOut { @location(2) color: vec4, @location(3) spherical: f32, @location(4) cylindrical: f32, + // The light the face emits, 0 to 15 (mesher.rs's `EMISSION_BITS`). + @location(5) @interpolate(flat) emission: u32, } // Horizon Extras' dynamic lights (dynamic_light.rs): the block light, in the vertex's units // (16 per level), a vertex at camera-relative `pos` gets from the frame's light sources, one @@ -121,7 +123,8 @@ fn terrain_vertex(position: vec3, uv: vec2, layer: u32, color: vec4, spherical: f32, cylindrical: f32) -> vec4 { // Bit 15 of the layer marks opaque leaves (forceOpaque): no alpha cutout. let color = sprite(in.uv, in.layer & 0x7fffu) * in.color; if color.a < 0.5 && (in.layer & 0x8000u) == 0u { discard; } - return apply_fog(vec4(color.rgb, 1.0), in.spherical, in.cylindrical); + // Alpha 0 tells HDR output (hdr.wgsl) a light-emitting block's bright pixels + // may shine. Nothing else reads the frame's alpha. + let emissive = select(1.0, 0.0, in.emission > 0u); + return apply_fog(vec4(color.rgb, emissive), in.spherical, in.cylindrical); } @fragment fn fs_translucent(in: TerrainOut) -> @location(0) vec4 { let color = sprite(in.uv, in.layer & 0x7fffu) * in.color; @@ -227,8 +233,9 @@ fn sunrise_weight(d: vec3) -> f32 { } return best; } -@fragment fn fs_sky(in: SkyOut) -> @location(0) vec4 { - let d = view_ray(in.ndc); +// The sky's colour along the view ray `d` (a shader pack's sky stage gets it as its input: +// gfx/native_sky.rs builds that stage from this section). +fn sky_along_ray(d: vec3) -> vec3 { var color = globals.fog_color.rgb; let dist = disc_distance(d, 16.0); if dist.x >= 0.0 { @@ -238,7 +245,10 @@ fn sunrise_weight(d: vec3) -> f32 { if w > 0.0 { color = mix(color, globals.sunrise.rgb, w * globals.sunrise.a); } - return vec4(color, 1.0); + return color; +} +@fragment fn fs_sky(in: SkyOut) -> @location(0) vec4 { + return vec4(sky_along_ray(view_ray(in.ndc)), 1.0); } @fragment fn fs_dark_disc(in: SkyOut) -> @location(0) vec4 { let d = view_ray(in.ndc); diff --git a/crates/horizon-client/src/title.rs b/crates/horizon-client/src/title.rs index a6967816a..87bd05fd0 100644 --- a/crates/horizon-client/src/title.rs +++ b/crates/horizon-client/src/title.rs @@ -192,7 +192,7 @@ pub fn list_worlds(saves: &Path) -> Vec { commands: matches!(data.get("allowCommands"), Some(horizon_world::nbt::Tag::Byte(v)) if *v != 0), version: data.get("Version").and_then(|v| v.get("Name")) .and_then(|v| match v { horizon_world::nbt::Tag::String(s) => Some(s.to_string_lossy()), _ => None }) - .unwrap_or_else(|| "Unknown".into()), + .unwrap_or_else(|| lang::get_or("selectWorld.versionUnknown", "Unknown")), }) }) .collect(); @@ -272,7 +272,7 @@ impl Title { } pub(crate) fn new_world() -> Mode { Mode::Create { - name: "New World".into(), + name: lang::get_or("selectWorld.newWorld", "New World"), seed: String::new(), creative: false, focus: 0, @@ -867,7 +867,13 @@ impl Title { } Mode::Select { worlds, selected } => { crate::ui::menu_background(batch, atlas, 0.0, 0.0, w, h, false); - centered(atlas, batch, "Select World", 8.0, u32::MAX); + centered( + atlas, + batch, + &lang::get_or("selectWorld.title", "Select World"), + 8.0, + u32::MAX, + ); self.caret.borrow_mut().draw( batch, atlas, @@ -1113,7 +1119,8 @@ impl Title { Mode::Multiplayer(screen) => screen.draw( atlas, batch, - (self.started.elapsed().as_millis() / 300).is_multiple_of(2), + &mut self.caret.borrow_mut(), + self.started, cursor, ), } @@ -1408,8 +1415,7 @@ impl Title { mode => caret_field(mode, self.search_focused, &mut self.search), } } - /// Whether the focused field edits at its cursor (every field but the - /// server screens', which still append). + /// Whether the focused field edits at its cursor. pub fn has_caret_field(&mut self) -> bool { caret_field(&mut self.mode, self.search_focused, &mut self.search).is_some() } @@ -1429,15 +1435,9 @@ impl Title { } /// EditBox.charTyped / insertText at the cursor. pub fn type_text(&mut self, text: &str) { - if let Mode::Multiplayer(screen) = &mut self.mode { - return screen.type_text(text); - } self.edit_field(|edit| edit.insert_text(text)); } pub fn backspace(&mut self) { - if let Mode::Multiplayer(screen) = &mut self.mode { - return screen.backspace(); - } self.field_key(winit::keyboard::KeyCode::Backspace, false, false); } /// EditBox.keyPressed: moving and deleting in the focused field. @@ -1465,6 +1465,7 @@ impl Title { Mode::Create { focus, options, .. } => create_world::field_rect(w, h, options.tab) .filter(|(id, _)| id == focus) .map(|(_, rect)| rect), + Mode::Multiplayer(screen) => screen.focused_box((w, h)), _ => None, } } @@ -1617,8 +1618,9 @@ const SEARCH: crate::clipboard::FieldId = ("world.search", 0); const EDIT_NAME: crate::clipboard::FieldId = ("world.edit-name", 0); const WORLD_NAME: crate::clipboard::FieldId = ("world.name", 0); const WORLD_SEED: crate::clipboard::FieldId = ("world.seed", 0); -/// The focused field of the world screens: the list's search, the world -/// name being edited, or Create New World's name or seed. +/// The focused field of the world screens and the server screens: the list's +/// search, a world name or seed, or Add Server, Direct Connection and Join a +/// Friend. fn caret_field<'a>( mode: &'a mut Mode, search_focused: bool, @@ -1638,6 +1640,7 @@ fn caret_field<'a>( 1 => Some((WORLD_SEED, seed, 32)), _ => None, }, + Mode::Multiplayer(screen) => screen.focused_text(), _ => None, } } diff --git a/crates/horizon-client/src/title/tests.rs b/crates/horizon-client/src/title/tests.rs index 572be2ef2..fcaf68225 100644 --- a/crates/horizon-client/src/title/tests.rs +++ b/crates/horizon-client/src/title/tests.rs @@ -824,3 +824,50 @@ fn world_fields_edit_at_their_cursor() { f.title.field_key(KeyCode::Backspace, false, false); assert_eq!(f.title.search, "world"); } + +#[test] +fn server_fields_edit_at_their_cursor() { + use winit::keyboard::KeyCode; + let mut f = Fixture::new(); + f.title.mode = Mode::Multiplayer(crate::multiplayer::Screen::Edit { + index: None, + name: "Minecraft Server".into(), + address: String::new(), + focus: 1, + packs: None, + }); + f.title.type_text("localhost"); + for _ in 0..4 { + assert!(f.title.field_key(KeyCode::ArrowLeft, false, false)); + } + f.title.type_text("X"); + let Mode::Multiplayer(crate::multiplayer::Screen::Edit { address, .. }) = &f.title.mode else { + panic!("add server"); + }; + assert_eq!(address, "localXhost"); + // Shift+Home selects back to the start; typing replaces the selection. + f.title.field_key(KeyCode::Home, false, true); + f.title.type_text("Y"); + let Mode::Multiplayer(crate::multiplayer::Screen::Edit { address, .. }) = &f.title.mode else { + panic!("add server"); + }; + assert_eq!(address, "Yhost"); + // Tab moves to the name, which edits at its own cursor. + f.title.tab(); + f.title.field_key(KeyCode::ArrowLeft, false, false); + f.title.type_text("X"); + let Mode::Multiplayer(crate::multiplayer::Screen::Edit { name, .. }) = &f.title.mode else { + panic!("add server"); + }; + assert_eq!(name, "Minecraft ServeXr"); + f.title.mode = Mode::Multiplayer(crate::multiplayer::Screen::Direct { + address: String::new(), + }); + f.title.type_text("one two"); + // Ctrl+Backspace deletes the word before the caret. + f.title.field_key(KeyCode::Backspace, true, false); + let Mode::Multiplayer(crate::multiplayer::Screen::Direct { address }) = &f.title.mode else { + panic!("direct"); + }; + assert_eq!(address, "one "); +} diff --git a/crates/horizon-client/src/ui.rs b/crates/horizon-client/src/ui.rs index 1954a29dc..e034f2b39 100644 --- a/crates/horizon-client/src/ui.rs +++ b/crates/horizon-client/src/ui.rs @@ -658,6 +658,8 @@ pub struct EditBox { display: usize, pub max_length: usize, pub bordered: bool, + /// `MultiLineEditBox`: a book page keeps line breaks. A single-line box strips them. + pub multiline: bool, pub x: f32, pub y: f32, pub width: f32, @@ -669,7 +671,7 @@ pub struct EditBox { pub text_color: u32, } /// The focused text field of a screen that keeps its values as `String`s -/// (the world list's search, world names, seeds): the `EditBox` state that +/// (the world list's search, world names, seeds, and the server screens): the `EditBox` state that /// outlives a frame, its cursor, selection and scroll. #[derive(Clone, Debug)] pub struct Caret { @@ -853,6 +855,38 @@ pub fn word_position(value: &str, dir: isize, from: usize) -> usize { } pos } +/// `MultilineTextField.getPreviousWord` / `getNextWord`'s `beginIndex` (a book page): any +/// whitespace, line breaks included, separates words, and the search starts from the cursor +/// clamped to the last character, as vanilla's does. +pub fn multiline_word_position(value: &str, dir: isize, from: usize) -> usize { + let chars: Vec = value.chars().collect(); + if chars.is_empty() { + return 0; + } + let mut pos = from.min(chars.len() - 1); + if dir < 0 { + while pos > 0 && java_whitespace(chars[pos - 1]) { + pos -= 1; + } + while pos > 0 && !java_whitespace(chars[pos - 1]) { + pos -= 1; + } + } else { + while pos < chars.len() && !java_whitespace(chars[pos]) { + pos += 1; + } + while pos < chars.len() && java_whitespace(chars[pos]) { + pos += 1; + } + } + pos +} +/// `Character.isWhitespace`: Unicode spaces and line breaks but not the no-break spaces, plus +/// the ASCII separators U+001C to U+001F. +fn java_whitespace(c: char) -> bool { + (c.is_whitespace() && !matches!(c, '\u{85}' | '\u{a0}' | '\u{2007}' | '\u{202f}')) + || ('\u{1c}'..='\u{1f}').contains(&c) +} /// `EditBox.deleteWords(dir)` for an append-only field, whose caret is at the /// end: removes the word in that direction. True when the value changed. pub fn delete_words(value: &mut String, dir: isize) -> bool { @@ -887,6 +921,7 @@ impl EditBox { display: 0, max_length: 32, bordered: true, + multiline: false, x, y, width, @@ -917,6 +952,10 @@ impl EditBox { pub fn reset_blink(&mut self) { self.focused_at = Instant::now(); } + /// The caret is showing (`EditBox`'s blink, on for 300 ms of every 600). + pub fn cursor_visible(&self) -> bool { + self.focused && (self.focused_at.elapsed().as_millis() / 300).is_multiple_of(2) + } pub fn set_value(&mut self, value: &str) { self.value = value.chars().take(self.max_length).collect(); self.move_cursor_to_end(false); @@ -934,7 +973,7 @@ impl EditBox { /// EditBox.insertText: replace the selection, respecting the maximum length. pub fn insert_text(&mut self, text: &str) { let (a, b) = self.selected(); - let filtered = crate::clipboard::filter_text(text, false); + let filtered = crate::clipboard::filter_text(text, self.multiline); let room = self .max_length .saturating_sub(char_len(&self.value) - (b - a)); @@ -960,9 +999,13 @@ impl EditBox { pub fn word_position(&self, dir: isize) -> usize { self.word_position_from(dir, self.cursor) } - /// EditBox.getWordPosition(dir, from). + /// EditBox.getWordPosition(dir, from), or MultilineTextField's word for a book page. fn word_position_from(&self, dir: isize, from: usize) -> usize { - word_position(&self.value, dir, from) + if self.multiline { + multiline_word_position(&self.value, dir, from) + } else { + word_position(&self.value, dir, from) + } } pub fn set_cursor(&mut self, pos: usize, select: bool) { self.cursor = pos.min(char_len(&self.value)); @@ -1492,6 +1535,17 @@ mod tests { assert_eq!(word_position("hi", 1, 99), 2); } #[test] + fn multiline_words_split_at_any_whitespace() { + // Ctrl+Backspace at the end of `one\ntwo` deletes `two` only. + assert_eq!(multiline_word_position("one\ntwo", -1, 7), 4); + // From the end the search starts at the last character, as vanilla's does. + assert_eq!(multiline_word_position("one\n", -1, 4), 0); + assert_eq!(multiline_word_position("a b", -1, 3), 0); + assert_eq!(multiline_word_position("one\n\ntwo", 1, 0), 5); + assert_eq!(multiline_word_position("one\u{a0}two", 1, 0), 7); + assert_eq!(multiline_word_position("", -1, 0), 0); + } + #[test] fn delete_words_removes_the_word_before_the_end() { let mut v = "stone bricks".to_string(); assert!(delete_words(&mut v, -1)); diff --git a/crates/horizon-client/src/vanillagen.rs b/crates/horizon-client/src/vanillagen.rs index c890213c5..9c8edf6ad 100644 --- a/crates/horizon-client/src/vanillagen.rs +++ b/crates/horizon-client/src/vanillagen.rs @@ -158,6 +158,12 @@ impl VanillaTerrain { chunk.terrain.min_y().max(MIN_Y), (chunk.terrain.min_y() + chunk.terrain.height()).min(MIN_Y + HEIGHT), ); + out.structure_refs = chunk + .structures() + .into_iter() + .map(|(id, start, _, _)| (Arc::from(id), (start.x, start.z))) + .collect(); + out.structure_starts = chunk.own_starts(); let mut values = Box::new([0u32; 4096]); for si in 0..SECTIONS as i32 { let base = MIN_Y + si * 16; @@ -339,7 +345,9 @@ pub fn shared_data( if let Some((_, data)) = cache.iter().find(|(path, _)| path == dir) { return Ok(data.clone()); } + let started = std::time::Instant::now(); let data = GeneratorData::load(dir, registry)?; + log::info!("Horizon: worldgen data loaded in {:?}", started.elapsed()); cache.push((dir.to_owned(), data.clone())); Ok(data) } @@ -434,6 +442,14 @@ impl ChunkGenerator for VanillaTerrain { .iter() .map(|(pos, nbt)| { let mut nbt = nbt.clone(); + // Placed data can lack its type (a brushable block's loot table + // alone); vanilla saves every pending block entity with its id, + // and skips one without when the chunk finishes. + if let Some(id) = + crate::lan::chunks::block_entity_type(chunk.block_name(pos[0], pos[1], pos[2])) + { + nbt.insert("id".into(), Tag::String(id.into())); + } for (key, v) in ["x", "y", "z"].into_iter().zip(pos) { nbt.insert(key.into(), Tag::Int(*v)); } @@ -564,11 +580,6 @@ impl ChunkGenerator for VanillaTerrain { extras.block_entities = unmodelled; out.saved = Some(Arc::new(extras)); } - out.structure_refs = chunk - .structures() - .into_iter() - .map(|(id, start, _, _)| (Arc::from(id), (start.x, start.z))) - .collect(); let entities = std::mem::take(&mut chunk.entities); out.entities = entities .into_iter() diff --git a/crates/horizon-client/src/world_post.wgsl b/crates/horizon-client/src/world_post.wgsl index 7332213c5..ed1a7a094 100644 --- a/crates/horizon-client/src/world_post.wgsl +++ b/crates/horizon-client/src/world_post.wgsl @@ -18,7 +18,8 @@ struct PostOut { } @fragment fn fs_copy(in: PostOut) -> @location(0) vec4 { - return vec4(textureSampleLevel(world, world_sampler, in.uv, 0.0).rgb, 1.0); + // The alpha carries the emissive mark through to HDR output (hdr.wgsl). + return textureSampleLevel(world, world_sampler, in.uv, 0.0); } fn luma(c: vec3) -> f32 { @@ -28,7 +29,8 @@ fn luma(c: vec3) -> f32 { // FXAA 3.11 (console quality): blend along the local edge direction. @fragment fn fs_fxaa(in: PostOut) -> @location(0) vec4 { let texel = 1.0 / vec2(textureDimensions(world)); - let rgb_m = textureSampleLevel(world, world_sampler, in.uv, 0.0).rgb; + let centre = textureSampleLevel(world, world_sampler, in.uv, 0.0); + let rgb_m = centre.rgb; let nw = luma(textureSampleLevel(world, world_sampler, in.uv + vec2(-0.5, -0.5) * texel, 0.0).rgb); let ne = luma(textureSampleLevel(world, world_sampler, in.uv + vec2(0.5, -0.5) * texel, 0.0).rgb); let sw = luma(textureSampleLevel(world, world_sampler, in.uv + vec2(-0.5, 0.5) * texel, 0.0).rgb); @@ -37,7 +39,7 @@ fn luma(c: vec3) -> f32 { let lo = min(m, min(min(nw, ne), min(sw, se))); let hi = max(m, max(max(nw, ne), max(sw, se))); if hi - lo < max(0.0312, hi * 0.125) { - return vec4(rgb_m, 1.0); + return centre; } var dir = vec2(-((nw + ne) - (sw + se)), (nw + sw) - (ne + se)); let reduce = max((nw + ne + sw + se) * 0.25 * 0.125, 1.0 / 128.0); @@ -49,7 +51,7 @@ fn luma(c: vec3) -> f32 { + textureSampleLevel(world, world_sampler, in.uv + dir * 0.5, 0.0).rgb); let lb = luma(b); if lb < lo || lb > hi { - return vec4(a, 1.0); + return vec4(a, centre.a); } - return vec4(b, 1.0); + return vec4(b, centre.a); } diff --git a/crates/horizon-client/tests/generation_saves.rs b/crates/horizon-client/tests/generation_saves.rs index 30b971e05..2f8c2ab6b 100644 --- a/crates/horizon-client/tests/generation_saves.rs +++ b/crates/horizon-client/tests/generation_saves.rs @@ -315,3 +315,70 @@ fn saved_proto_chunks_restore_exactly() { drop(save); let _ = std::fs::remove_dir_all(&dir); } + +#[test] +fn saved_proto_block_entities_keep_their_id() { + use horizon_client::{ + save::{Persistent, SaveDir}, + vanillagen::VanillaTerrain, + }; + use horizon_world::{ + nbt::{Limits, Tag}, + region::RegionFile, + }; + let Some(root) = resources() else { + return; + }; + let assets = Arc::new(Assets::load(&root).unwrap()); + let biomes = Arc::new(Biomes::load(&root).unwrap()); + let terrain = VanillaTerrain::for_dimension( + &root.join("worldgen"), + assets.registry, + &biomes, + 12345, + "minecraft:overworld", + ) + .unwrap(); + let dir = std::env::temp_dir().join(format!("horizon-proto-ids-{}", std::process::id())); + let _ = std::fs::remove_dir_all(&dir); + let save = Arc::new(SaveDir::new(dir.clone())); + let generator = Persistent { + inner: Arc::new(terrain), + save: save.clone(), + registry: assets.clone(), + biomes, + }; + let mut worker = generator.worker(); + // A cold ocean ruin of seed 12345: its suspicious gravel is placed with a + // loot table and no type. + let keys: Vec<(i32, i32)> = (0..9).map(|i| (43 + i % 3 - 1, 21 + i / 3 - 1)).collect(); + let mut region: [Proto; 9] = + std::array::from_fn(|i| generator.proto(&mut worker, keys[i].0, keys[i].1)); + generator.decorate(&mut worker, &mut region); + generator.save_protos(®ion.iter().collect::>()); + save.flush().unwrap(); + let mut file = RegionFile::open(dir.join("region/r.1.0.mca")).unwrap(); + let mut suspicious = 0; + for &(x, z) in &keys { + let Some(record) = file + .read(horizon_core::position::ChunkPos::new(x, z)) + .unwrap() + else { + continue; + }; + let root = record.nbt(Limits::default()).unwrap(); + let Some(Tag::List(entities)) = root.tag.get("block_entities") else { + continue; + }; + for e in entities { + assert!(e.get("id").is_some(), "chunk {x} {z}: {e:?}"); + if let Some(Tag::String(table)) = e.get("LootTable") { + suspicious += usize::from(table.to_string_lossy().contains("archaeology/")); + } + } + } + assert!(suspicious > 0, "the ruin placed no suspicious blocks"); + drop(generator); + drop(save); + let _ = std::fs::remove_dir_all(&dir); +} diff --git a/crates/horizon-hdr/Cargo.toml b/crates/horizon-hdr/Cargo.toml new file mode 100644 index 000000000..e83e590e8 --- /dev/null +++ b/crates/horizon-hdr/Cargo.toml @@ -0,0 +1,17 @@ +[package] +name = "horizon-hdr" +version = "0.1.0" +edition.workspace = true +license.workspace = true +rust-version = "1.85" +description = "HDR metadata for the swapchain: the Vulkan calls the crates that forbid unsafe code can't make" + +[dependencies] +wgpu = { version = "30.0.1", default-features = false, features = ["vulkan"] } + +[target.'cfg(not(target_os = "macos"))'.dependencies] +# The version wgpu-hal already uses. +ash = { version = "0.38", default-features = false } + +[lints] +workspace = true diff --git a/crates/horizon-hdr/src/lib.rs b/crates/horizon-hdr/src/lib.rs new file mode 100644 index 000000000..cda61868e --- /dev/null +++ b/crates/horizon-hdr/src/lib.rs @@ -0,0 +1,95 @@ +//! HDR metadata for the swapchain: the Vulkan calls the game crate, which +//! forbids unsafe code, can't make itself. wgpu sets no HDR metadata, and +//! without it a compositor may clip or tone-map everything above 1.0 (80 nits) +//! of an scRGB swapchain. + +/// Opens a Vulkan device with `VK_EXT_hdr_metadata` too, when the GPU offers +/// it, so [`set_metadata`] can tell the compositor the real peak brightness. +/// `None` leaves opening to wgpu. +#[cfg(not(target_os = "macos"))] +pub fn open_vulkan_device( + adapter: &wgpu::Adapter, + desc: &wgpu::DeviceDescriptor<'_>, +) -> Option> { + use wgpu::hal::api::Vulkan; + let open = { + // Safety: only read and opened from here; dropped before wgpu takes it back. + let hal = unsafe { adapter.as_hal::() }?; + let instance = hal.shared_instance().raw_instance(); + // Safety: the adapter's own physical device on its own instance. + let offered = + unsafe { instance.enumerate_device_extension_properties(hal.raw_physical_device()) } + .ok()? + .iter() + .any(|e| e.extension_name_as_c_str() == Ok(ash::ext::hdr_metadata::NAME)); + if !offered { + return None; + } + // Safety: what wgpu's own request_device does, with one more extension. + unsafe { + hal.open_with_callback( + desc.required_features, + &desc.required_limits, + &desc.memory_hints, + Some(Box::new( + |args: wgpu::hal::vulkan::CreateDeviceCallbackArgs| { + args.extensions.push(ash::ext::hdr_metadata::NAME); + }, + )), + ) + } + .ok()? + }; + // Safety: opened from this adapter with exactly `desc`'s features. + Some(unsafe { adapter.create_device_from_hal(open, desc) }) +} + +/// Tells the compositor, through `VK_EXT_hdr_metadata`, that the swapchain's +/// content is BT.709 and peaks at `peak` nits. Needs a device from +/// `open_vulkan_device` and a configured surface; does nothing otherwise. +pub fn set_metadata( + device: &wgpu::Device, + surface: &wgpu::Surface<'_>, + paper_white: f32, + peak: f32, +) { + #[cfg(not(target_os = "macos"))] + { + use wgpu::hal::api::Vulkan; + // Safety: read-only access to handles wgpu keeps alive while these guards live. + let (Some(hal_device), Some(hal_surface)) = + (unsafe { device.as_hal::() }, unsafe { + surface.as_hal::() + }) + else { + return; + }; + if !hal_device + .enabled_device_extensions() + .contains(&ash::ext::hdr_metadata::NAME) + { + return; + } + let Some(swapchain) = hal_surface.raw_native_swapchain() else { + return; + }; + let xy = |x, y| ash::vk::XYColorEXT { x, y }; + let metadata = ash::vk::HdrMetadataEXT::default() + .display_primary_red(xy(0.64, 0.33)) + .display_primary_green(xy(0.30, 0.60)) + .display_primary_blue(xy(0.15, 0.06)) + .white_point(xy(0.3127, 0.3290)) + .max_luminance(peak) + .min_luminance(0.0) + .max_content_light_level(peak) + .max_frame_average_light_level(paper_white.min(peak)); + let loader = ash::ext::hdr_metadata::Device::new( + hal_device.shared_instance().raw_instance(), + hal_device.raw_device(), + ); + // Safety: a live swapchain of this device, one metadata entry for it. + unsafe { loader.set_hdr_metadata(&[swapchain], &[metadata]) }; + } + #[cfg(target_os = "macos")] + let _ = (device, surface, paper_white, peak); +} diff --git a/crates/horizon-mod-registry/Cargo.lock b/crates/horizon-mod-registry/Cargo.lock index 44ef1e078..59bd37134 100644 --- a/crates/horizon-mod-registry/Cargo.lock +++ b/crates/horizon-mod-registry/Cargo.lock @@ -17,12 +17,24 @@ dependencies = [ "derive_arbitrary", ] +[[package]] +name = "arrayvec" +version = "0.7.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d3fb67a6e08acf24fdeccbac2cb6ac4305825bd1f117462e0e6f2f193345ad56" + [[package]] name = "atomic-waker" version = "1.1.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "1505bd5d3d116872e7271a6d4e16d81d0c8570876c8de68093a09ac269d8aac0" +[[package]] +name = "autocfg" +version = "1.5.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f2032f911046de80f0a198e0901378627c33f59ea0ac00e363d481118bd70a53" + [[package]] name = "axum" version = "0.8.9" @@ -80,6 +92,27 @@ version = "0.22.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "72b3254f16251a8381aa12e40e3c4d2f0199f8c6508fbecb9d91f575e0fbb8c6" +[[package]] +name = "bit-set" +version = "0.10.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "09ec2f926cc3060f09db9ebc5b52823d85268d24bb917e472c0c4bea35780a7d" +dependencies = [ + "bit-vec", +] + +[[package]] +name = "bit-vec" +version = "0.9.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b71798fca2c1fe1086445a7258a4bc81e6e49dcd24c8d0dd9a1e57395b603f51" + +[[package]] +name = "bitflags" +version = "2.13.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3ded4057c258ba199e2d26386d3af3780957ecaee6c4ef4041c6b4b8b97c0b06" + [[package]] name = "block-buffer" version = "0.10.4" @@ -95,6 +128,26 @@ version = "3.20.3" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "72f5acc6cb2ba439de613abc23857ec3d78374d8ed5ac84e9d11336e87da8649" +[[package]] +name = "bytemuck" +version = "1.25.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "95832e849adfb21180ccb6826a99da14e5d266ae5c2e668e1602cf234f153797" +dependencies = [ + "bytemuck_derive", +] + +[[package]] +name = "bytemuck_derive" +version = "1.12.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6a1f896587b6f2c069c73d2f0913e2d590c3990285cd2f0b6aa02b786b4c679c" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.9", +] + [[package]] name = "bytes" version = "1.12.1" @@ -117,6 +170,21 @@ version = "1.0.5" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "4e7648175b45a9a48536d676f68d918270699102aa8dab5496df06904c914600" +[[package]] +name = "cfg_aliases" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f079e83a288787bcd14a6aea84cee5c87a67c5a3e660c30f557a3d24761b3527" + +[[package]] +name = "codespan-reporting" +version = "0.13.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "af491d569909a7e4dee0ad7db7f5341fef5c614d5b8ec8cf765732aba3cff681" +dependencies = [ + "unicode-width", +] + [[package]] name = "core_detect" version = "1.0.0" @@ -147,6 +215,12 @@ version = "0.8.23" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "a31eee39dddec8330830986fcd7625edb5a24ec90ea038215273bbc3adb08ac6" +[[package]] +name = "crunchy" +version = "0.2.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "460fbee9c2c2f33933d720630a6a0bac33ba7053db5344fac858d4b8952d77d5" + [[package]] name = "crypto-common" version = "0.1.7" @@ -165,7 +239,7 @@ checksum = "1b034bd7d5f032402a2479444dcc6f74e36a03f31854d41680fb240ef682a1ac" dependencies = [ "proc-macro2", "quote", - "syn", + "syn 3.0.9", ] [[package]] @@ -187,7 +261,7 @@ checksum = "c6232dd377dcc64799954cbd3a9bb882e9cdc1308ccd87b1c098f1fb2eaf82a8" dependencies = [ "proc-macro2", "quote", - "syn", + "syn 3.0.9", ] [[package]] @@ -220,6 +294,18 @@ dependencies = [ "windows-sys 0.61.2", ] +[[package]] +name = "fallible-iterator" +version = "0.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2acce4a10f12dc2fb14a218589d4f1f62ef011b2d0cc4b3cb1bba8e94da14649" + +[[package]] +name = "fallible-streaming-iterator" +version = "0.1.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7360491ce676a36bf9bb3c56c1aa791658183a54d2744120f27285738d90465a" + [[package]] name = "find-msvc-tools" version = "0.1.15" @@ -236,6 +322,18 @@ dependencies = [ "miniz_oxide", ] +[[package]] +name = "foldhash" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d9c4f5dac5e15c24eb999c26181a6ca40b39fe946cbe4c263c7209467bc83af2" + +[[package]] +name = "foldhash" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "77ce24cb58228fbb8aa041425bb1050850ac19177686ea6e0f41a70416f56fdb" + [[package]] name = "form_urlencoded" version = "1.2.2" @@ -302,11 +400,46 @@ dependencies = [ "wasip2", ] +[[package]] +name = "half" +version = "2.7.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6ea2d84b969582b4b1864a92dc5d27cd2b77b622a8d79306834f1be5ba20d84b" +dependencies = [ + "cfg-if", + "crunchy", + "num-traits", + "zerocopy", +] + +[[package]] +name = "hashbrown" +version = "0.15.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9229cfe53dfd69f0609a49f65461bd93001ea1ef889cd5529dd176593f5338a1" +dependencies = [ + "foldhash 0.1.5", +] + [[package]] name = "hashbrown" version = "0.17.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "ed5909b6e89a2db4456e54cd5f673791d7eca6732202bbf2a9cc504fe2f9b84a" +dependencies = [ + "foldhash 0.2.0", + "serde", + "serde_core", +] + +[[package]] +name = "hashlink" +version = "0.10.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7382cf6263419f2d8df38c55d7da83da5c18aef87fc7a7fc1fb1e344edfe14c1" +dependencies = [ + "hashbrown 0.15.5", +] [[package]] name = "hmac" @@ -327,6 +460,7 @@ dependencies = [ "hmac", "horizon-mods", "http-body-util", + "rusqlite", "serde", "serde_json", "sha2", @@ -340,12 +474,27 @@ dependencies = [ name = "horizon-mods" version = "0.1.0" dependencies = [ + "horizon-shader-api", "log", "minisign-verify", "serde", "serde_json", "sha2", "toml", + "wasmparser", + "zip", +] + +[[package]] +name = "horizon-shader-api" +version = "0.1.0" +dependencies = [ + "bytemuck", + "naga", + "serde", + "serde_json", + "sha2", + "toml", "zip", ] @@ -539,7 +688,9 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "cc4e190f5d26ca7051642629da2c52fc03bde85a03197c99408dcd291734c855" dependencies = [ "equivalent", - "hashbrown", + "hashbrown 0.17.1", + "serde", + "serde_core", ] [[package]] @@ -554,6 +705,23 @@ version = "0.2.191" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "65cd87c9a6d60536580b316ad985726104730a5151c99845f2490428ef91240a" +[[package]] +name = "libm" +version = "0.2.16" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b6d2cec3eae94f9f509c767b45932f1ada8350c4bdb85af2fcab4a3c14807981" + +[[package]] +name = "libsqlite3-sys" +version = "0.35.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "133c182a6a2c87864fe97778797e46c7e999672690dc9fa3ee8e241aa4a9c13f" +dependencies = [ + "cc", + "pkg-config", + "vcpkg", +] + [[package]] name = "litemap" version = "0.8.3" @@ -634,6 +802,54 @@ version = "1.0.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "743fb55ba31b18fb1ecef6bdc9aa2743314978ac084044301a7eee33fb99a20d" +[[package]] +name = "naga" +version = "30.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a616d2fb8c89516ac2723a581f69d6c18576046bed761bd6b305e5618e6ae130" +dependencies = [ + "arrayvec", + "bit-set", + "bitflags", + "cfg-if", + "cfg_aliases", + "codespan-reporting", + "half", + "hashbrown 0.17.1", + "indexmap", + "libm", + "log", + "naga-types", + "num-traits", + "once_cell", + "rustc-hash", + "spirv", + "thiserror", + "unicode-ident", +] + +[[package]] +name = "naga-types" +version = "30.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "590afbf58a6f4f62873cd5cff4468061844bafa1cdf399cc954537c22d768d49" +dependencies = [ + "hashbrown 0.17.1", + "indexmap", + "rustc-hash", + "thiserror", +] + +[[package]] +name = "num-traits" +version = "0.2.19" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "071dfc062690e90b734c0b2273ce72ad0ffa95f0c74596bc250dcfd960262841" +dependencies = [ + "autocfg", + "libm", +] + [[package]] name = "once_cell" version = "1.21.4" @@ -652,6 +868,12 @@ version = "0.2.17" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "a89322df9ebe1c1578d689c92318e070967d1042b512afbe49518723f4e6d5cd" +[[package]] +name = "pkg-config" +version = "0.3.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f6b464fbc74e149a392436b17d523f769e057cb6877f6a5c4618bc6f11800548" + [[package]] name = "potential_utf" version = "0.1.6" @@ -699,6 +921,26 @@ dependencies = [ "windows-sys 0.52.0", ] +[[package]] +name = "rusqlite" +version = "0.37.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "165ca6e57b20e1351573e3729b958bc62f0e48025386970b6e4d29e7a7e71f3f" +dependencies = [ + "bitflags", + "fallible-iterator", + "fallible-streaming-iterator", + "hashlink", + "libsqlite3-sys", + "smallvec", +] + +[[package]] +name = "rustc-hash" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "08d43f7aa6b08d49f382cde6a7982047c3426db949b1424bc4b7ec9ae12c6ce2" + [[package]] name = "rustls" version = "0.23.46" @@ -752,6 +994,12 @@ version = "1.2.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "94143f37725109f92c262ed2cf5e59bce7498c01bcc1502d7b9afe439a4e9f49" +[[package]] +name = "semver" +version = "1.0.28" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8a7852d02fc848982e0c167ef163aaff9cd91dc640ba85e263cb1ce46fae51cd" + [[package]] name = "serde" version = "1.0.229" @@ -779,7 +1027,7 @@ checksum = "e7a5d71263a5a7d47b41f6b3f06ba276f10cc18b0931f1799f710578e2309348" dependencies = [ "proc-macro2", "quote", - "syn", + "syn 3.0.9", ] [[package]] @@ -894,6 +1142,15 @@ version = "0.9.9" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "3763264f6b73151db08c50ff20d7d8a0b8796e021cdea7ceedad07b80155fa0e" +[[package]] +name = "spirv" +version = "0.4.0+sdk-1.4.341.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d9571ea910ebd84c86af4b3ed27f9dbdc6ad06f17c5f96146b2b671e2976744f" +dependencies = [ + "bitflags", +] + [[package]] name = "stable_deref_trait" version = "1.2.1" @@ -906,6 +1163,17 @@ version = "2.6.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "13c2bddecc57b384dee18652358fb23172facb8a2c51ccc10d74c157bdea3292" +[[package]] +name = "syn" +version = "2.0.119" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "872831b642d1a07999a962a351ed35b955ea2cfc8f3862091e2a240a84f17297" +dependencies = [ + "proc-macro2", + "quote", + "unicode-ident", +] + [[package]] name = "syn" version = "3.0.9" @@ -931,7 +1199,27 @@ checksum = "901704edd0dfe137f1987838ee4f259e4e063c31371bdb423f7ae38ec6f77f02" dependencies = [ "proc-macro2", "quote", - "syn", + "syn 3.0.9", +] + +[[package]] +name = "thiserror" +version = "2.0.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "09e52cb86a36cede5cb101bf8908837b3e4c6e5e59fe7fd85c23fb56200d189e" +dependencies = [ + "thiserror-impl", +] + +[[package]] +name = "thiserror-impl" +version = "2.0.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fe5197923287db20a58125f0bc85c062f7f2c892de97b18c356f9efb14b28524" +dependencies = [ + "proc-macro2", + "quote", + "syn 3.0.9", ] [[package]] @@ -968,7 +1256,7 @@ checksum = "78773a2a397f451582ce068015985c33193cf6dea8b74d2a639fe457b2f07b0e" dependencies = [ "proc-macro2", "quote", - "syn", + "syn 3.0.9", ] [[package]] @@ -1049,6 +1337,12 @@ version = "1.0.27" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "a2c754d6c33795a1c324727428e5a7dedb5b06195f9890bdbcba760d3e246563" +[[package]] +name = "unicode-width" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b4ac048d71ede7ee76d585517add45da530660ef4390e49b098733c6e897f254" + [[package]] name = "untrusted" version = "0.9.0" @@ -1090,6 +1384,12 @@ version = "1.0.4" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "b6c140620e7ffbb22c2dee59cafe6084a59b5ffc27a8859a5f0d494b5d52b6be" +[[package]] +name = "vcpkg" +version = "0.2.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "accd4ea62f7bb7a82fe23066fb0957d48ef677f6eeb8215f372f52e48bb32426" + [[package]] name = "version_check" version = "0.9.5" @@ -1111,6 +1411,19 @@ dependencies = [ "wit-bindgen", ] +[[package]] +name = "wasmparser" +version = "0.254.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c5ff8685b587722894b6f25958fc608d315b93b8d23647bfb567664e7006d757" +dependencies = [ + "bitflags", + "hashbrown 0.17.1", + "indexmap", + "semver", + "serde", +] + [[package]] name = "webpki-roots" version = "0.26.11" @@ -1254,10 +1567,30 @@ checksum = "ec8ebde2db3681e8c9980cc27822030e68752690ddfa9473e739aeb4dbde6d71" dependencies = [ "proc-macro2", "quote", - "syn", + "syn 3.0.9", "synstructure", ] +[[package]] +name = "zerocopy" +version = "0.8.63" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e5fe1f8f1b06191a00962174c61aa5005e0bb391a6d80d07e24d115c01a92ed8" +dependencies = [ + "zerocopy-derive", +] + +[[package]] +name = "zerocopy-derive" +version = "0.8.63" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "863ad3ac83293fb4d740aedbfdc9240dd8d1a50c1099acd76ce80ce7c7230c7f" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.119", +] + [[package]] name = "zerofrom" version = "0.1.8" @@ -1275,7 +1608,7 @@ checksum = "f75b4683f6c7f45248d4d64056a24298c6281e0993356d7d1b4a1a962ef10d4a" dependencies = [ "proc-macro2", "quote", - "syn", + "syn 3.0.9", "synstructure", ] @@ -1315,7 +1648,7 @@ checksum = "c3743ddbf47738d929cd1ae2e199d40d0162979dfe31aef8ae646d2bf00bf97a" dependencies = [ "proc-macro2", "quote", - "syn", + "syn 3.0.9", ] [[package]] diff --git a/crates/horizon-mod-registry/Cargo.toml b/crates/horizon-mod-registry/Cargo.toml index affc08f62..959e84f91 100644 --- a/crates/horizon-mod-registry/Cargo.toml +++ b/crates/horizon-mod-registry/Cargo.toml @@ -23,6 +23,8 @@ hmac = "0.12" sha2 = "0.10" base64 = "0.22" getrandom = "0.3" +# Ratings: one SQLite file on a small volume, as the telemetry server keeps its data. +rusqlite = { version = "0.37", features = ["bundled"] } [dev-dependencies] tower = { version = "0.5", features = ["util"] } diff --git a/crates/horizon-mod-registry/Dockerfile b/crates/horizon-mod-registry/Dockerfile index 13522165a..ee2065008 100644 --- a/crates/horizon-mod-registry/Dockerfile +++ b/crates/horizon-mod-registry/Dockerfile @@ -4,11 +4,15 @@ WORKDIR /src # The root manifest only for the shared crate's workspace settings (edition, lints). COPY Cargo.toml Cargo.toml COPY crates/horizon-mods crates/horizon-mods +# horizon-mods' optional dependency: cargo needs its manifest even with the feature off. +COPY crates/horizon-shader-api crates/horizon-shader-api COPY crates/horizon-mod-registry crates/horizon-mod-registry RUN cargo build --release --locked --manifest-path crates/horizon-mod-registry/Cargo.toml FROM debian:stable-slim RUN apt-get update && apt-get install -y --no-install-recommends ca-certificates && rm -rf /var/lib/apt/lists/* COPY --from=build /src/crates/horizon-mod-registry/target/release/horizon-mod-registry /usr/local/bin/ -USER nobody -CMD ["horizon-mod-registry"] +ENV REGISTRY_DB=/data/registry.sqlite3 +# Railway mounts the ratings' volume at /data owned by root: hand it to nobody, then run as nobody (setpriv is +# util-linux's, in every Debian image). +CMD ["sh", "-c", "mkdir -p /data && chown nobody:nogroup /data && exec setpriv --reuid=nobody --regid=nogroup --clear-groups horizon-mod-registry"] diff --git a/crates/horizon-mod-registry/README.md b/crates/horizon-mod-registry/README.md index f7cdc68c5..d609e6739 100644 --- a/crates/horizon-mod-registry/README.md +++ b/crates/horizon-mod-registry/README.md @@ -7,20 +7,26 @@ entry's fields), uploads it to the `staging` release of request adding or updating `mods/.toml`. That repository's CI checks it again, with a trial run of a mod in the sandbox; reviewers decide, and merging publishes. Formats and rules: [docs/api/mod-index.md](../../docs/api/mod-index.md). -It keeps no data: a session is a signed cookie holding the GitHub login, and the user's OAuth token is used once, to -read that login, and dropped. The sign-in asks for no scope. +Signed-in players also rate published projects, 1 to 5 stars: one rating per GitHub account and project, which they can +change, never their own project's. That is the only data it keeps, in one SQLite file (`REGISTRY_DB`); it only ever +shows totals, never who rated. A session is a signed cookie holding the GitHub login and id, and the user's OAuth token +is used once, to read them, and dropped. The sign-in asks for no scope. | Route | | | --- | --- | -| `GET /api/mods/auth/login` | Starts the GitHub sign-in | -| `GET /api/mods/auth/callback` | GitHub's redirect: sets the session, back to `/mods/submit` | +| `GET /api/mods/auth/login` | Starts the GitHub sign-in; `?back=/mods/` (or `/mods`) comes back to that page | +| `GET /api/mods/auth/callback` | GitHub's redirect: sets the session, back to `/mods/submit` or the `back` page | | `POST /api/mods/auth/logout` | Ends it | | `GET /api/mods/me` | `{login, csrf}`, or 401 | | `POST /api/mods/submit` | Multipart: `entry` (JSON: `id kind name summary description authors license source icon key signature version game changelog`) and `file`; `{pull_request}` or `{error}` | +| `GET /api/mods/ratings` | `{projects: {: {average, count}}}` for every rated project; cached a minute | +| `GET /api/mods//rating` | The signed-in account's own `{stars}` (null when it hasn't rated), or 401 | +| `POST /api/mods//rating` | JSON `{stars}`, 1 to 5: sets or changes it; `{stars, average, count}` or `{error}` | | `GET /healthz` | `ok` | -A submission must come from `REGISTRY_PUBLIC_URL`'s origin with the session's `X-CSRF-Token`. Six per account and sixty -in all per hour. Only an entry's `owners` publish its updates; a key change, an icon in the repository or anything else +A submission or a rating must come from `REGISTRY_PUBLIC_URL`'s origin with the session's `X-CSRF-Token`. Six +submissions per account and sixty in all per hour; thirty ratings per account and 600 in all. A project's owners can't +rate it, and only projects on the registry's `main` can be rated. Only an entry's `owners` publish its updates; a key change, an icon in the repository or anything else is a pull request by hand. ## Running it @@ -28,7 +34,7 @@ is a pull request by hand. ```sh cargo test # against a mock GitHub (tests/submit.rs) REGISTRY_PUBLIC_URL=http://localhost:4173 REGISTRY_SESSION_KEY=... GITHUB_CLIENT_ID=... GITHUB_CLIENT_SECRET=... \ - GITHUB_BOT_TOKEN=... REGISTRY_REPO=you/horizon-mods-test cargo run + GITHUB_BOT_TOKEN=... REGISTRY_REPO=you/horizon-mods-test REGISTRY_DB=/tmp/registry.sqlite3 cargo run ``` | Variable | | @@ -38,10 +44,12 @@ REGISTRY_PUBLIC_URL=http://localhost:4173 REGISTRY_SESSION_KEY=... GITHUB_CLIENT | `GITHUB_CLIENT_ID`, `GITHUB_CLIENT_SECRET` | The OAuth app | | `GITHUB_BOT_TOKEN` | Fine-grained, the registry repository only: Contents and Pull requests read and write | | `REGISTRY_REPO` | Default `ludovic111/horizon-mods` | +| `REGISTRY_DB` | The ratings' SQLite file: default `/data/registry.sqlite3`, the volume | | `PORT` | Default 8080 | On Railway it is the service `horizon-mod-registry` of the project `horizon-site`, next to the website: built from -`main` with this `Dockerfile` from the repository root, health check `/healthz`, no public domain and no volume. The +`main` with this `Dockerfile` from the repository root, health check `/healthz`, no public domain, and the volume +`registry-data` at `/data` for the ratings. The website's Caddy sends `/api/mods/*` to it over Railway's private network (`REGISTRY_UPSTREAM` on the website service: `http://horizon-mod-registry.railway.internal:8080`). `railway.json` lists the same settings; Railway reads them from the service, not from the file. diff --git a/crates/horizon-mod-registry/src/lib.rs b/crates/horizon-mod-registry/src/lib.rs index 72970017a..661337c8c 100644 --- a/crates/horizon-mod-registry/src/lib.rs +++ b/crates/horizon-mod-registry/src/lib.rs @@ -2,13 +2,15 @@ //! `playhorizon.dev/api/mods/*` (docs/api/mod-index.md). A creator signs in //! with GitHub, sends a file and its page; the service runs the file's own //! checks, uploads it to the registry's `staging` release and opens a pull -//! request with the entry. Reviewers decide; merging publishes. It keeps no -//! data: sessions are signed cookies, and GitHub holds everything else. +//! request with the entry. Reviewers decide; merging publishes. Signed-in +//! players also rate published projects (`ratings`, its only data: sessions +//! are signed cookies, and GitHub holds everything else). pub mod github; +pub mod ratings; use axum::{ Json, Router, - extract::{DefaultBodyLimit, Multipart, Query, State}, + extract::{DefaultBodyLimit, Multipart, Path as UrlPath, Query, State}, http::{HeaderMap, StatusCode, header}, response::{IntoResponse, Redirect, Response}, routing::{get, post}, @@ -20,6 +22,7 @@ use horizon_mods::index::{ self, Kind, registry::{self, Entry, EntryVersion, Sources}, }; +use ratings::Ratings; use serde::Deserialize; use serde_json::json; use sha2::Sha256; @@ -37,6 +40,12 @@ const PER_ACCOUNT: usize = 6; const PER_HOUR: usize = 60; /// The page's JSON. const MAX_FORM: usize = 64 << 10; +/// Ratings set per account per hour, and by everyone. +const RATINGS_PER_ACCOUNT: usize = 30; +const RATINGS_PER_HOUR: usize = 600; +/// How long the ratings' totals are served from memory (and cached by +/// browsers and the launcher). +const TOTALS_FOR: Duration = Duration::from_secs(60); pub struct Config { /// `https://playhorizon.dev`: where the form is, and the only origin it @@ -47,11 +56,14 @@ pub struct Config { pub github: GitHub, /// Where files wait during a submission. pub scratch: PathBuf, + /// The ratings' SQLite file (a volume): `:memory:` keeps them in memory. + pub database: PathBuf, } impl Config { /// `REGISTRY_PUBLIC_URL`, `REGISTRY_SESSION_KEY`, `REGISTRY_REPO`, - /// `GITHUB_CLIENT_ID`, `GITHUB_CLIENT_SECRET`, `GITHUB_BOT_TOKEN`. + /// `GITHUB_CLIENT_ID`, `GITHUB_CLIENT_SECRET`, `GITHUB_BOT_TOKEN`, + /// `REGISTRY_DB` (default `/data/registry.sqlite3`). pub fn from_env() -> Result { let var = |name: &str| std::env::var(name).map_err(|_| format!("{name} is not set")); let key = var("REGISTRY_SESSION_KEY")?; @@ -69,6 +81,8 @@ impl Config { var("GITHUB_BOT_TOKEN")?, ), scratch: std::env::temp_dir().join("horizon-mod-registry"), + database: std::env::var_os("REGISTRY_DB") + .map_or_else(|| PathBuf::from("/data/registry.sqlite3"), PathBuf::from), }) } @@ -80,17 +94,31 @@ impl Config { #[derive(Clone)] pub struct App(Arc); +type Windows = Mutex>>; + struct Inner { config: Config, - recent: Mutex>>, + /// Submissions in the last hour, by account ("" for everyone's). + recent: Windows, + /// Ratings set in the last hour, the same way. + rated: Windows, + ratings: Mutex, + /// `GET /api/mods/ratings`' body, and when it was made. + totals: Mutex>, } impl App { - pub fn new(config: Config) -> App { - App(Arc::new(Inner { + /// Fails when the ratings' file can't be opened. + pub fn new(config: Config) -> Result { + let ratings = Ratings::open(&config.database) + .map_err(|e| format!("{}: {e}", config.database.display()))?; + Ok(App(Arc::new(Inner { config, - recent: Mutex::new(HashMap::new()), - })) + recent: Mutex::default(), + rated: Mutex::default(), + ratings: Mutex::new(ratings), + totals: Mutex::default(), + }))) } } @@ -101,6 +129,8 @@ pub fn router(app: App) -> Router { .route("/api/mods/auth/callback", get(callback)) .route("/api/mods/auth/logout", post(logout)) .route("/api/mods/me", get(me)) + .route("/api/mods/ratings", get(totals)) + .route("/api/mods/{id}/rating", get(my_rating).post(rate)) .route( "/api/mods/submit", post(submit).layer(DefaultBodyLimit::max( @@ -203,9 +233,29 @@ fn csrf(app: &Inner, headers: &HeaderMap) -> Option { Some(signed.rsplit('.').next()?.chars().take(32).collect()) } -async fn login(State(app): State) -> Response { +#[derive(Deserialize)] +struct Login { + /// The site's page to come back to: `/mods`, `/mods/submit` (the + /// default) or `/mods/`. + back: Option, +} + +/// Whether `path` is a registry page a sign-in may come back to. +fn registry_page(path: &str) -> bool { + match path.strip_prefix("/mods") { + Some("") => true, + Some(rest) => rest.strip_prefix('/').is_some_and(index::valid_id) || rest == "/submit", + None => false, + } +} + +async fn login(State(app): State, Query(q): Query) -> Response { let state = random_hex(); - let signed = sign(&app.0.config.session_key, &state); + let back = q + .back + .filter(|b| registry_page(b)) + .unwrap_or_else(|| "/mods/submit".into()); + let signed = sign(&app.0.config.session_key, &format!("{state}\n{back}")); let url = app .0 .config @@ -229,13 +279,17 @@ async fn callback( headers: HeaderMap, Query(q): Query, ) -> Result { - let expected = cookie(&headers, "hm_state").and_then(|v| unsign(&app.0.config.session_key, &v)); - if expected.as_deref() != Some(q.state.as_str()) { + let started = cookie(&headers, "hm_state").and_then(|v| unsign(&app.0.config.session_key, &v)); + let Some((_, back)) = started + .as_deref() + .and_then(|s| s.split_once('\n')) + .filter(|(state, _)| *state == q.state) + else { return Err(Refusal::new( StatusCode::FORBIDDEN, "the sign-in expired or didn't start here: try again", )); - } + }; let inner = app.0.clone(); let (login, id) = tokio::task::spawn_blocking(move || { inner @@ -250,7 +304,7 @@ async fn callback( &app.0.config.session_key, &format!("{login}\n{id}\n{}", now() + SESSION), ); - let back = format!("{}/mods/submit", app.0.config.public_url); + let back = format!("{}{back}", app.0.config.public_url); let mut response = Redirect::to(&back).into_response(); let headers = response.headers_mut(); headers.append( @@ -283,6 +337,131 @@ async fn me( )) } +fn database(e: rusqlite::Error) -> Refusal { + eprintln!("horizon-mod-registry: ratings: {e}"); + Refusal::new( + StatusCode::INTERNAL_SERVER_ERROR, + "the ratings can't be read right now", + ) +} + +/// A mean as the pages show it: two decimals. +fn rounded(average: f64) -> f64 { + (average * 100.0).round() / 100.0 +} + +/// `GET /api/mods/ratings`: `{"projects": {"": {"average", "count"}}}` for +/// every rated project. Totals only: never who rated. +async fn totals(State(app): State) -> Result { + let mut cached = app.0.totals.lock().unwrap(); + let body = match cached.as_ref().filter(|(at, _)| at.elapsed() < TOTALS_FOR) { + Some((_, body)) => body.clone(), + None => { + let all = app + .0 + .ratings + .lock() + .unwrap() + .summaries() + .map_err(database)?; + let projects: serde_json::Map = all + .into_iter() + .map(|(id, s)| (id, json!({"average": rounded(s.average), "count": s.count}))) + .collect(); + let body = json!({ "projects": projects }).to_string(); + *cached = Some((Instant::now(), body.clone())); + body + } + }; + Ok(( + [ + (header::CONTENT_TYPE, "application/json"), + (header::CACHE_CONTROL, "public, max-age=60"), + ], + body, + ) + .into_response()) +} + +/// `GET /api/mods/{id}/rating`: the signed-in account's own rating, +/// `{"stars": 1..5}` or `{"stars": null}`. +async fn my_rating( + State(app): State, + headers: HeaderMap, + UrlPath(id): UrlPath, +) -> Result, Refusal> { + let (_, account) = session(&app.0, &headers) + .ok_or_else(|| Refusal::new(StatusCode::UNAUTHORIZED, "not signed in"))?; + let stars = app + .0 + .ratings + .lock() + .unwrap() + .mine(&id, account) + .map_err(database)?; + Ok(Json(json!({ "stars": stars }))) +} + +#[derive(Deserialize)] +struct Rating { + stars: u8, +} + +/// `POST /api/mods/{id}/rating` with `{"stars": 1..5}`: sets or changes the +/// signed-in account's rating of a published project, not its own. Answers +/// the project's new totals and `stars`. +async fn rate( + State(app): State, + headers: HeaderMap, + UrlPath(id): UrlPath, + Json(rating): Json, +) -> Result, Refusal> { + let inner = app.0.clone(); + let (login, account) = signed_in_here(&inner, &headers)?; + if !(1..=5).contains(&rating.stars) { + return Err(bad("a rating is 1 to 5 stars")); + } + if !index::valid_id(&id) { + return Err(Refusal::new(StatusCode::NOT_FOUND, "no such project")); + } + if !allow(&inner.rated, &login, RATINGS_PER_ACCOUNT, RATINGS_PER_HOUR) { + return Err(Refusal::new( + StatusCode::TOO_MANY_REQUESTS, + "too many ratings this hour: try again later", + )); + } + let lookup = inner.clone(); + let wanted = id.clone(); + let entry = tokio::task::spawn_blocking(move || lookup.config.github.entry(&wanted)) + .await + .map_err(|_| Refusal::new(StatusCode::INTERNAL_SERVER_ERROR, "the check crashed"))? + .map_err(github_down)?; + let Some((entry, _)) = entry else { + return Err(Refusal::new( + StatusCode::NOT_FOUND, + format!("{id} isn't published in the registry"), + )); + }; + if entry.owners.iter().any(|o| o.eq_ignore_ascii_case(&login)) { + return Err(Refusal::new( + StatusCode::FORBIDDEN, + "you publish this project: its players rate it", + )); + } + let summary = { + let ratings = inner.ratings.lock().unwrap(); + ratings + .rate(&id, account, rating.stars, now()) + .map_err(database)?; + ratings.summary(&id).map_err(database)? + }; + *inner.totals.lock().unwrap() = None; + let (average, count) = summary.map_or((0.0, 0), |s| (rounded(s.average), s.count)); + Ok(Json( + json!({"stars": rating.stars, "average": average, "count": count}), + )) +} + /// The page a submission fills in: a project's fields, and the version's. #[derive(Clone, Debug, Deserialize)] #[serde(deny_unknown_fields)] @@ -322,45 +501,56 @@ fn take(window: &mut VecDeque, max: usize) -> bool { window.len() < max } +/// A change sent by the site's own pages: from its origin, signed in, with +/// the session's CSRF token. The account: (login, id). +fn signed_in_here(app: &Inner, headers: &HeaderMap) -> Result<(String, u64), Refusal> { + let origin = headers.get(header::ORIGIN).and_then(|v| v.to_str().ok()); + if origin != Some(app.config.public_url.as_str()) { + return Err(Refusal::new( + StatusCode::FORBIDDEN, + "send it from the registry's pages", + )); + } + let account = session(app, headers) + .ok_or_else(|| Refusal::new(StatusCode::UNAUTHORIZED, "sign in with GitHub first"))?; + let sent = headers.get("x-csrf-token").and_then(|v| v.to_str().ok()); + if sent.is_none() || sent.map(str::to_owned) != csrf(app, headers) { + return Err(Refusal::new( + StatusCode::FORBIDDEN, + "reload the page and try again", + )); + } + Ok(account) +} + +/// Counts one more for `login` and for everyone, unless either is at its +/// hourly limit. +fn allow(windows: &Windows, login: &str, per_account: usize, per_hour: usize) -> bool { + let mut windows = windows.lock().unwrap(); + let account = login.to_lowercase(); + let ok = take(windows.entry(String::new()).or_default(), per_hour) + && take(windows.entry(account.clone()).or_default(), per_account); + if ok { + let at = Instant::now(); + windows.entry(String::new()).or_default().push_back(at); + windows.entry(account).or_default().push_back(at); + } + ok +} + async fn submit( State(app): State, headers: HeaderMap, mut multipart: Multipart, ) -> Result, Refusal> { let inner = app.0.clone(); - let origin = headers.get(header::ORIGIN).and_then(|v| v.to_str().ok()); - if origin != Some(inner.config.public_url.as_str()) { + let (login, user_id) = signed_in_here(&inner, &headers)?; + if !allow(&inner.recent, &login, PER_ACCOUNT, PER_HOUR) { return Err(Refusal::new( - StatusCode::FORBIDDEN, - "submit from the registry's form", + StatusCode::TOO_MANY_REQUESTS, + "too many submissions this hour: try again later", )); } - let (login, user_id) = session(&inner, &headers) - .ok_or_else(|| Refusal::new(StatusCode::UNAUTHORIZED, "sign in with GitHub first"))?; - let sent = headers.get("x-csrf-token").and_then(|v| v.to_str().ok()); - if sent.is_none() || sent.map(str::to_owned) != csrf(&inner, &headers) { - return Err(Refusal::new( - StatusCode::FORBIDDEN, - "reload the form and try again", - )); - } - { - let mut recent = inner.recent.lock().unwrap(); - let ok = take(recent.entry(String::new()).or_default(), PER_HOUR) - && take(recent.entry(login.to_lowercase()).or_default(), PER_ACCOUNT); - if !ok { - return Err(Refusal::new( - StatusCode::TOO_MANY_REQUESTS, - "too many submissions this hour: try again later", - )); - } - let at = Instant::now(); - recent.entry(String::new()).or_default().push_back(at); - recent - .entry(login.to_lowercase()) - .or_default() - .push_back(at); - } let dir = inner.config.scratch.join(random_hex()); std::fs::create_dir_all(&dir) .map_err(|e| Refusal::new(StatusCode::INTERNAL_SERVER_ERROR, e.to_string()))?; diff --git a/crates/horizon-mod-registry/src/main.rs b/crates/horizon-mod-registry/src/main.rs index 81fe1b7b6..a1e40a57a 100644 --- a/crates/horizon-mod-registry/src/main.rs +++ b/crates/horizon-mod-registry/src/main.rs @@ -1,5 +1,5 @@ //! `horizon-mod-registry`: serves on `PORT` (default 8080). Configured by the -//! environment (see `Config::from_env`); keeps no data. +//! environment (see `Config::from_env`); keeps the ratings in `REGISTRY_DB`. use std::net::SocketAddr; use horizon_mod_registry::{App, Config, router}; @@ -16,7 +16,8 @@ async fn main() { .await .unwrap_or_else(|e| panic!("port {port}: {e}")); eprintln!("horizon-mod-registry: listening on {port}, submitting to {repo}"); - axum::serve(listener, router(App::new(config))) + let app = App::new(config).unwrap_or_else(|e| panic!("horizon-mod-registry: {e}")); + axum::serve(listener, router(app)) .with_graceful_shutdown(async { let _ = tokio::signal::ctrl_c().await; }) diff --git a/crates/horizon-mod-registry/src/ratings.rs b/crates/horizon-mod-registry/src/ratings.rs new file mode 100644 index 000000000..0cba85142 --- /dev/null +++ b/crates/horizon-mod-registry/src/ratings.rs @@ -0,0 +1,129 @@ +//! Players' ratings of published projects, 1 to 5 stars: one per GitHub +//! account and project, which its rater can change. Stored in one SQLite +//! file (a Railway volume). Only totals leave it: never who rated what, +//! except a signed-in account's own rating, to that account. +use rusqlite::{Connection, OptionalExtension, params}; +use std::{collections::BTreeMap, path::Path}; + +const SCHEMA: &str = " +PRAGMA journal_mode = WAL; +PRAGMA synchronous = NORMAL; +CREATE TABLE IF NOT EXISTS ratings ( + project TEXT NOT NULL, + account INTEGER NOT NULL, + stars INTEGER NOT NULL CHECK (stars BETWEEN 1 AND 5), + updated INTEGER NOT NULL, + PRIMARY KEY (project, account) +) WITHOUT ROWID; +"; + +/// A project's ratings: their mean, and how many. +#[derive(Clone, Copy, Debug, PartialEq)] +pub struct Summary { + pub average: f64, + pub count: u64, +} + +pub struct Ratings { + db: Connection, +} + +impl Ratings { + /// Opens (or creates) the file at `path`; `:memory:` for a test. + pub fn open(path: &Path) -> rusqlite::Result { + let db = Connection::open(path)?; + db.execute_batch(SCHEMA)?; + Ok(Ratings { db }) + } + + /// Sets `account`'s rating of `project`, replacing an earlier one. + pub fn rate(&self, project: &str, account: u64, stars: u8, now: u64) -> rusqlite::Result<()> { + self.db.execute( + "INSERT INTO ratings (project, account, stars, updated) VALUES (?1, ?2, ?3, ?4) + ON CONFLICT (project, account) DO UPDATE SET stars = excluded.stars, updated = excluded.updated", + params![project, account as i64, stars, now as i64], + )?; + Ok(()) + } + + /// `account`'s own rating of `project`. + pub fn mine(&self, project: &str, account: u64) -> rusqlite::Result> { + self.db + .query_row( + "SELECT stars FROM ratings WHERE project = ?1 AND account = ?2", + params![project, account as i64], + |r| r.get(0), + ) + .optional() + } + + /// `project`'s summary; None when nobody rated it. + pub fn summary(&self, project: &str) -> rusqlite::Result> { + self.db + .query_row( + "SELECT avg(stars), count(*) FROM ratings WHERE project = ?1 HAVING count(*) > 0", + [project], + |r| { + Ok(Summary { + average: r.get(0)?, + count: r.get::<_, i64>(1)? as u64, + }) + }, + ) + .optional() + } + + /// Every rated project's summary. + pub fn summaries(&self) -> rusqlite::Result> { + let mut statement = self + .db + .prepare("SELECT project, avg(stars), count(*) FROM ratings GROUP BY project")?; + let rows = statement.query_map([], |r| { + Ok(( + r.get::<_, String>(0)?, + Summary { + average: r.get(1)?, + count: r.get::<_, i64>(2)? as u64, + }, + )) + })?; + rows.collect() + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn one_rating_per_account_and_project() { + let r = Ratings::open(Path::new(":memory:")).unwrap(); + r.rate("zoom", 1, 5, 10).unwrap(); + r.rate("zoom", 2, 2, 10).unwrap(); + r.rate("zoom", 1, 4, 11).unwrap(); + r.rate("minimap", 1, 3, 11).unwrap(); + assert_eq!(r.mine("zoom", 1).unwrap(), Some(4)); + assert_eq!(r.mine("zoom", 3).unwrap(), None); + let all = r.summaries().unwrap(); + assert_eq!( + all["zoom"], + Summary { + average: 3.0, + count: 2 + } + ); + assert_eq!( + all["minimap"], + Summary { + average: 3.0, + count: 1 + } + ); + assert_eq!(r.summary("zoom").unwrap(), Some(all["zoom"])); + assert_eq!(r.summary("nothing").unwrap(), None); + assert!( + r.rate("zoom", 1, 6, 12).is_err(), + "the table checks the range too" + ); + } +} diff --git a/crates/horizon-mod-registry/tests/submit.rs b/crates/horizon-mod-registry/tests/submit.rs index f586effac..d5591d4fc 100644 --- a/crates/horizon-mod-registry/tests/submit.rs +++ b/crates/horizon-mod-registry/tests/submit.rs @@ -1,6 +1,6 @@ //! The whole submission against a mock GitHub: sign in, submit the sample //! signed mod (`crates/horizon-mods/tests/index`), and what lands on GitHub; -//! then what is refused. +//! then what is refused. Then ratings: who may rate what, and what is shown. use axum::{ Json, Router, body::{Body, Bytes}, @@ -55,7 +55,9 @@ async fn mock_github() -> (String, Shared) { .route( "/user", get(|State(s): State| async move { - Json(json!({"login": s.lock().unwrap().login, "id": 7})) + let login = s.lock().unwrap().login.clone(); + let id = if login == "alice" { 7 } else { 8 }; + Json(json!({"login": login, "id": id})) }), ) .route( @@ -174,7 +176,16 @@ impl Client { } async fn sign_in(&mut self) -> String { - let (status, _, location) = self.send(self.get("/api/mods/auth/login")).await; + self.sign_in_from("").await + } + + /// Signs in from the page `back` (`?back=` of the sign-in; "" for none). + async fn sign_in_from(&mut self, back: &str) -> String { + let login = match back { + "" => "/api/mods/auth/login".to_owned(), + back => format!("/api/mods/auth/login?back={back}"), + }; + let (status, _, location) = self.send(self.get(&login)).await; assert_eq!(status, StatusCode::SEE_OTHER); let location = location.unwrap(); assert!(location.contains( @@ -197,10 +208,11 @@ impl Client { .send(self.get(&format!("/api/mods/auth/callback?code=good&state={state}"))) .await; assert_eq!(status, StatusCode::SEE_OTHER); - assert_eq!( - location.as_deref(), - Some("https://playhorizon.test/mods/submit") - ); + let page = match back { + "/mods" | "/mods/zoom" => back, + _ => "/mods/submit", + }; + assert_eq!(location, Some(format!("https://playhorizon.test{page}"))); let (status, me, _) = self.send(self.get("/api/mods/me")).await; assert_eq!(status, StatusCode::OK); me["csrf"].as_str().unwrap().to_owned() @@ -265,9 +277,10 @@ async fn setup() -> (Client, Shared) { "bot".into(), ), scratch, + database: ":memory:".into(), }; let client = Client { - app: router(App::new(config)), + app: router(App::new(config).unwrap()), cookies: HashMap::new(), }; (client, mock) @@ -342,11 +355,12 @@ async fn what_the_form_refuses() { ); let (status, json) = client.submit(&csrf, &f, &file).await; assert_eq!(status, StatusCode::BAD_REQUEST, "{json}"); - // Shader packs aren't open. + // A shader pack runs the game's own check: a mod's file isn't one. let mut f = form(); f["kind"] = json!("shader"); let (status, json) = client.submit(&csrf, &f, &file).await; - refused(status, &json, "shader packs open"); + assert_eq!(status, StatusCode::BAD_REQUEST, "{json}"); + refused(status, &json, "horizon-shaders.toml: missing"); // An update by someone who isn't an owner. let owned = "id = \"coords_hud\"\nkind = \"mod\"\nname = \"C\"\nsummary = \"s\"\nowners = [\"bob\"]\nlicense = \"MIT\"\nsource = \"https://x.test\"\n\n[[versions]]\nversion = \"0.0.1\"\npublished = \"2026-01-01\"\ngame = \"26.3\"\nfile = \"coords_hud-0.0.1.hmod\"\nsha256 = \"0000000000000000000000000000000000000000000000000000000000000000\"\n"; mock.lock() @@ -375,3 +389,95 @@ async fn what_the_form_refuses() { "nothing reached GitHub" ); } + +const ENTRY: &str = "kind = \"mod\"\nname = \"N\"\nsummary = \"s\"\nlicense = \"MIT\"\nsource = \"https://x.test\"\n\n[[versions]]\nversion = \"1.0.0\"\npublished = \"2026-01-01\"\ngame = \"26.3\"\nfile = \"f.hmod\"\nsha256 = \"0000000000000000000000000000000000000000000000000000000000000000\"\n"; + +impl Client { + async fn rate(&mut self, csrf: &str, id: &str, body: &str) -> (StatusCode, Value) { + let request = Request::post(format!("/api/mods/{id}/rating")) + .header(header::COOKIE, self.cookie_header()) + .header(header::ORIGIN, PUBLIC) + .header("x-csrf-token", csrf) + .header(header::CONTENT_TYPE, "application/json") + .body(Body::from(body.to_owned())) + .unwrap(); + let (status, json, _) = self.send(request).await; + (status, json) + } +} + +#[tokio::test(flavor = "multi_thread")] +async fn ratings() { + let (mut client, mock) = setup().await; + { + let mut m = mock.lock().unwrap(); + m.main.insert( + "mods/zoom.toml".into(), + format!("id = \"zoom\"\nowners = [\"bob\"]\n{ENTRY}"), + ); + m.main.insert( + "mods/mine.toml".into(), + format!("id = \"mine\"\nowners = [\"Alice\"]\n{ENTRY}"), + ); + } + // Nothing rated yet; signed out, no own rating and no rating at all. + let (status, json, _) = client.send(client.get("/api/mods/ratings")).await; + assert_eq!((status, json), (StatusCode::OK, json!({"projects": {}}))); + let (status, ..) = client.send(client.get("/api/mods/zoom/rating")).await; + assert_eq!(status, StatusCode::UNAUTHORIZED); + let (status, _) = client.rate("x", "zoom", r#"{"stars": 4}"#).await; + assert_eq!(status, StatusCode::UNAUTHORIZED); + + // A sign-in from a project's page comes back to it; anywhere else is the form. + client.sign_in_from("https://evil.test/").await; + let csrf = client.sign_in_from("/mods/zoom").await; + let (status, json) = client.rate("wrong", "zoom", r#"{"stars": 4}"#).await; + assert_eq!(status, StatusCode::FORBIDDEN, "{json}"); + for stars in ["0", "6"] { + let (status, json) = client + .rate(&csrf, "zoom", &format!(r#"{{"stars": {stars}}}"#)) + .await; + assert_eq!(status, StatusCode::BAD_REQUEST, "{json}"); + } + let (status, json) = client.rate(&csrf, "zoom", r#"{"stars": 4}"#).await; + assert_eq!(status, StatusCode::OK, "{json}"); + assert_eq!(json, json!({"stars": 4, "average": 4.0, "count": 1})); + // Changing it replaces it. + let (status, json) = client.rate(&csrf, "zoom", r#"{"stars": 2}"#).await; + assert_eq!(status, StatusCode::OK, "{json}"); + assert_eq!(json["count"], 1); + let (_, json, _) = client.send(client.get("/api/mods/zoom/rating")).await; + assert_eq!(json, json!({"stars": 2})); + let (_, json, _) = client.send(client.get("/api/mods/minimap/rating")).await; + assert_eq!(json, json!({"stars": null})); + + // Not one's own project, nor one that isn't published. + let (status, json) = client.rate(&csrf, "mine", r#"{"stars": 5}"#).await; + assert_eq!(status, StatusCode::FORBIDDEN, "{json}"); + let (status, json) = client.rate(&csrf, "nothing", r#"{"stars": 5}"#).await; + assert_eq!(status, StatusCode::NOT_FOUND, "{json}"); + + // Another account's rating counts once more; the totals never say whose. + let mut other = Client { + app: client.app.clone(), + cookies: HashMap::new(), + }; + mock.lock().unwrap().login = "carol".into(); + let carol = other.sign_in().await; + let (status, json) = other.rate(&carol, "zoom", r#"{"stars": 5}"#).await; + assert_eq!(status, StatusCode::OK, "{json}"); + assert_eq!(json, json!({"stars": 5, "average": 3.5, "count": 2})); + let (status, json, _) = client.send(client.get("/api/mods/ratings")).await; + assert_eq!(status, StatusCode::OK); + assert_eq!( + json, + json!({"projects": {"zoom": {"average": 3.5, "count": 2}}}) + ); + + // The limit per account and hour. + let mut last = StatusCode::OK; + for _ in 0..40 { + (last, _) = client.rate(&csrf, "zoom", r#"{"stars": 3}"#).await; + } + assert_eq!(last, StatusCode::TOO_MANY_REQUESTS); +} diff --git a/crates/horizon-mod-sdk/examples/welcome/Cargo.toml b/crates/horizon-mod-sdk/examples/welcome/Cargo.toml new file mode 100644 index 000000000..50ab1a10a --- /dev/null +++ b/crates/horizon-mod-sdk/examples/welcome/Cargo.toml @@ -0,0 +1,16 @@ +[package] +name = "welcome" +version = "0.1.0" +edition.workspace = true +license.workspace = true +publish = false +description = "Example Horizon server mod: greets players, announces newcomers, /online and /mined" + +[lib] +crate-type = ["cdylib"] + +[dependencies] +horizon-mod-sdk = { path = "../.." } + +[lints] +workspace = true diff --git a/crates/horizon-mod-sdk/examples/welcome/horizon-mod.toml b/crates/horizon-mod-sdk/examples/welcome/horizon-mod.toml new file mode 100644 index 000000000..f8e73c482 --- /dev/null +++ b/crates/horizon-mod-sdk/examples/welcome/horizon-mod.toml @@ -0,0 +1,8 @@ +id = "welcome" +name = "Welcome" +version = "0.1.0" +description = "Greets each player who joins, announces a newcomer to everyone, /online lists who is on, /mined counts the blocks you broke." +authors = ["Horizon"] +api = "0.3" +side = "server" +capabilities = ["players", "storage"] diff --git a/crates/horizon-mod-sdk/examples/welcome/src/lib.rs b/crates/horizon-mod-sdk/examples/welcome/src/lib.rs new file mode 100644 index 000000000..c45712c88 --- /dev/null +++ b/crates/horizon-mod-sdk/examples/welcome/src/lib.rs @@ -0,0 +1,84 @@ +//! Example Horizon server mod (`docs/mods.md`, "Server mods"): greets each +//! player who joins, announces a newcomer to everyone (the players it has +//! seen are kept in `storage`), `/online` lists who is on and where, and +//! `/mined` counts the blocks the player broke since the server started. +use horizon_mod_sdk::{ + server::{BlockPos, Player, Registration, ServerMod, players}, + storage, +}; +use std::collections::HashMap; + +struct Welcome { + /// Ids of every player seen, one per line in storage key `seen`. + seen: Vec, + mined: HashMap, +} + +impl ServerMod for Welcome { + fn init() -> Result<(Self, Registration), String> { + let seen = storage::get("seen") + .map(|b| { + String::from_utf8_lossy(&b) + .lines() + .map(str::to_owned) + .collect() + }) + .unwrap_or_default(); + let hooks = Registration::new() + .command("online") + .command("mined") + .on_joins() + .on_blocks(); + Ok(( + Welcome { + seen, + mined: HashMap::new(), + }, + hooks, + )) + } + + fn player_joined(&mut self, player: &Player) { + let others = players::online().len() - 1; + players::tell( + &player.id, + &format!("Welcome, {}! {others} other player(s) online.", player.name), + ); + if !self.seen.contains(&player.id) { + self.seen.push(player.id.clone()); + let _ = storage::set("seen", self.seen.join("\n").as_bytes()); + players::broadcast(&format!("{} is here for the first time", player.name)); + } + } + + fn command( + &mut self, + player: &Player, + name: &str, + _args: &str, + ) -> Result, String> { + Ok(Some(match name { + "online" => players::online() + .iter() + .map(|p| { + format!( + "{} ({})", + p.name, + p.dimension.trim_start_matches("minecraft:") + ) + }) + .collect::>() + .join(", "), + _ => { + let n = self.mined.get(&player.id).copied().unwrap_or(0); + format!("You broke {n} block(s)") + } + })) + } + + fn block_broken(&mut self, player: &Player, _pos: BlockPos, _state: &str) { + *self.mined.entry(player.id.clone()).or_default() += 1; + } +} + +horizon_mod_sdk::export_server_mod!(Welcome); diff --git a/crates/horizon-mod-sdk/examples/welcome/tests/commands.toml b/crates/horizon-mod-sdk/examples/welcome/tests/commands.toml new file mode 100644 index 000000000..5f0018346 --- /dev/null +++ b/crates/horizon-mod-sdk/examples/welcome/tests/commands.toml @@ -0,0 +1,31 @@ +# /online lists the players and their dimension; /mined counts the acting player's blocks. + +[[step]] +join = "Alex" +expect.commands = ["online", "mined"] + +[[step]] +join = "Steve" +as = "Steve" +player = { dimension = "minecraft:the_nether" } +command = "online" +expect.feedback = "Alex (overworld), Steve (the_nether)" + +[[step]] +as = "Alex" +break = { x = 1, y = 63, z = 0, state = "minecraft:stone" } + +[[step]] +as = "Alex" +break = { x = 2, y = 63, z = 0, state = "minecraft:dirt" } + +# A step's command comes before its break and place. +[[step]] +as = "Alex" +command = "mined" +expect.feedback = "You broke 2 block(s)" + +[[step]] +as = "Steve" +command = "mined" +expect.feedback = "You broke 0 block(s)" diff --git a/crates/horizon-mod-sdk/examples/welcome/tests/welcome.toml b/crates/horizon-mod-sdk/examples/welcome/tests/welcome.toml new file mode 100644 index 000000000..c8a1836db --- /dev/null +++ b/crates/horizon-mod-sdk/examples/welcome/tests/welcome.toml @@ -0,0 +1,21 @@ +# Joins are greeted; a newcomer is announced once, even after a reload (storage). + +[[step]] +join = "Alex" +expect.told = ["Alex: Welcome, Alex! 0 other player(s) online."] +expect.broadcast = ["Alex is here for the first time"] + +[[step]] +join = "Steve" +expect.told = ["Steve: Welcome, Steve! 1 other player(s) online."] +expect.broadcast = ["Steve is here for the first time"] + +[[step]] +leave = "Alex" +expect.told = [] + +[[step]] +reload = true +join = "Alex" +expect.told = ["Alex: Welcome, Alex! 1 other player(s) online."] +expect.broadcast = [] diff --git a/crates/horizon-mod-sdk/src/lib.rs b/crates/horizon-mod-sdk/src/lib.rs index 734fffb89..679fdc7b8 100644 --- a/crates/horizon-mod-sdk/src/lib.rs +++ b/crates/horizon-mod-sdk/src/lib.rs @@ -21,7 +21,8 @@ //! ``` //! //! Every interface but `log` is a capability: list the ones the mod uses in -//! `horizon-mod.toml` (`game-read`, `chat`, `hud`, `storage`, `command`, `ui`). +//! `horizon-mod.toml` (`game-read`, `chat`, `hud`, `storage`, `command`, `ui`; +//! a server mod `storage` and `players`). Server mods: [`server`]. //! //! Widgets (capability `ui`): a mod shows a screen it owns with //! [`ui::open_screen`] and a page in Options > Mods with @@ -173,3 +174,152 @@ macro_rules! export_mod { }; }; } + +/// Server mods (manifest `side = "server"`, `api = "0.3"`, experimental): a +/// type implementing [`ServerMod`](server::ServerMod), exported with +/// [`export_server_mod!`]. It runs where the world is simulated, and reads +/// and messages the players with capability `players`. +pub mod server { + wit_bindgen::generate!({ + path: "wit", + world: "horizon-server-mod", + pub_export_macro: true, + export_macro_name: "__export_horizon_server_mod", + default_bindings_module: "horizon_mod_sdk::server", + with: { + "horizon:mods/log@0.1.0": crate::log, + "horizon:mods/storage@0.1.0": crate::storage, + }, + }); + + pub use exports::horizon::mods::server_events::{BlockPos, Guest as __Guest, Registration}; + pub use horizon::mods::players::{self, GameMode, Player}; + + /// The server's calls into a mod. Only the hooks [`Registration`] asks + /// for are called; the others may stay as their defaults. + pub trait ServerMod: Sized + 'static { + /// Once, after loading: the mod's state and the hooks it wants. An + /// error keeps the mod off and is logged. + fn init() -> Result<(Self, Registration), String>; + /// Every server tick, when [`Registration::tick`] is set. + fn tick(&mut self, _tick: u64) {} + /// When [`Registration::joins`] is set. + fn player_joined(&mut self, _player: &Player) {} + fn player_left(&mut self, _player: &Player) {} + /// A chat message a player sent, when [`Registration::chat`] is set. + fn chat(&mut self, _player: &Player, _text: &str) {} + /// `/name args` typed by `player`. `Ok(Some(text))` is their + /// feedback, `Err(text)` their error in red. + fn command( + &mut self, + _player: &Player, + _name: &str, + _args: &str, + ) -> Result, String> { + Err("This command does nothing".into()) + } + /// When [`Registration::blocks`] is set: `state` is what was there. + fn block_broken(&mut self, _player: &Player, _pos: BlockPos, _state: &str) {} + fn block_placed(&mut self, _player: &Player, _pos: BlockPos, _state: &str) {} + } + + impl Registration { + /// No commands and no hooks. + pub fn new() -> Self { + Self { + commands: Vec::new(), + tick: false, + joins: false, + chat: false, + blocks: false, + } + } + /// Adds `/name`. + pub fn command(mut self, name: &str) -> Self { + self.commands.push(name.into()); + self + } + pub fn on_tick(mut self) -> Self { + self.tick = true; + self + } + pub fn on_joins(mut self) -> Self { + self.joins = true; + self + } + pub fn on_chat(mut self) -> Self { + self.chat = true; + self + } + pub fn on_blocks(mut self) -> Self { + self.blocks = true; + self + } + } + impl Default for Registration { + fn default() -> Self { + Self::new() + } + } +} + +/// Exports a [`ServerMod`](server::ServerMod) as the component's +/// `server-events` interface, as [`export_mod!`] does for a client mod. +#[macro_export] +macro_rules! export_server_mod { + ($t:ty) => { + const _: () = { + use ::std::cell::RefCell; + use $crate::server::{BlockPos, Player, Registration, ServerMod}; + ::std::thread_local! { + static STATE: RefCell> = const { RefCell::new(None) }; + } + fn with(f: impl FnOnce(&mut $t)) { + STATE.with(|s| { + if let Some(m) = s.borrow_mut().as_mut() { + f(m) + } + }) + } + struct Export; + impl $crate::server::__Guest for Export { + fn init() -> Result { + let (m, registration) = <$t as ServerMod>::init()?; + STATE.with(|s| *s.borrow_mut() = Some(m)); + Ok(registration) + } + fn tick(tick: u64) { + with(|m| m.tick(tick)) + } + fn player_joined(player: Player) { + with(|m| m.player_joined(&player)) + } + fn player_left(player: Player) { + with(|m| m.player_left(&player)) + } + fn chat(player: Player, text: String) { + with(|m| m.chat(&player, &text)) + } + fn command( + player: Player, + name: String, + args: String, + ) -> Result, String> { + let mut out = Err("The mod is not running".to_string()); + with(|m| out = m.command(&player, &name, &args)); + out + } + fn block_broken(player: Player, pos: BlockPos, state: String) { + with(|m| m.block_broken(&player, pos, &state)) + } + fn block_placed(player: Player, pos: BlockPos, state: String) { + with(|m| m.block_placed(&player, pos, &state)) + } + } + #[cfg(target_arch = "wasm32")] + $crate::server::__export_horizon_server_mod!(Export); + #[cfg(not(target_arch = "wasm32"))] + let _ = ::init; + }; + }; +} diff --git a/crates/horizon-mod-sdk/wit/horizon.wit b/crates/horizon-mod-sdk/wit/horizon.wit index 5fbfafc24..7f8245c48 100644 --- a/crates/horizon-mod-sdk/wit/horizon.wit +++ b/crates/horizon-mod-sdk/wit/horizon.wit @@ -18,7 +18,8 @@ interface log { write: func(level: level, message: string); } -/// Capability `game-read`: the local player and the world clock. +/// Capability `game-read`: the local player, the world clock and the block +/// the player looks at. interface game { record player { /// Feet position, in blocks. @@ -46,6 +47,24 @@ interface game { get-player: func() -> option; /// None on the title screen. get-clock: func() -> option; + /// A block along the player's view. + record hit { + /// The block hit. + block-x: s32, + block-y: s32, + block-z: s32, + /// The point on its face where the view meets it. + x: f64, + y: f64, + z: f64, + /// `minecraft:stone`, ... + block: string, + } + /// The first block along the player's view (fluids pass), up to + /// `distance` blocks (at most 1024; past the loaded chunks, across the + /// distant terrain when LOD Distance is on), as of this tick. None when + /// nothing is hit, and on the title screen. + raycast: func(distance: f32) -> option; } /// Capability `chat`: messages only the local player sees. @@ -412,6 +431,84 @@ interface events { chat: func(text: string); } +/// Capability `players`, server mods only (manifest `api = "0.3"`, +/// experimental): the players on the server, and messages to them. +interface players { + enum game-mode { + survival, + creative, + adventure, + spectator, + } + record player { + /// The player's UUID, `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`. + id: string, + name: string, + /// Feet position, in blocks. + x: f64, + y: f64, + z: f64, + /// `minecraft:overworld`, `minecraft:the_nether`, ... + dimension: string, + game-mode: game-mode, + /// Hit points as vanilla counts them: 20 is full health without effects. + health: f32, + } + /// The players online, in the order they joined. + online: func() -> list; + /// A system message to one player, after the mod's name; false when no + /// player with that id is online. Up to 8 messages per call. + tell: func(player: string, text: string) -> bool; + /// A system message to every player and the server's log, after the + /// mod's name. Counts toward the same 8 per call. + broadcast: func(text: string); +} + +/// What the server calls in a server mod (manifest `api = "0.3"`, +/// experimental). Only the hooks `init` asks for are ever called. The player +/// in each event is as the server saw them when it happened. +interface server-events { + use players.{player}; + + record registration { + /// Commands players may type, without the slash. A name vanilla + /// already uses is refused (vanilla's command runs). + commands: list, + /// Call `tick` every server tick (20 per second). + tick: bool, + /// Call `player-joined` and `player-left`. + joins: bool, + /// Call `chat` for each chat message a player sends. + chat: bool, + /// Call `block-broken` and `block-placed`. + blocks: bool, + } + record block-pos { + x: s32, + y: s32, + z: s32, + } + /// Once, after loading. An error keeps the mod off and is logged. + init: func() -> result; + /// Each server tick, with the server's tick counter. + tick: func(tick: u64); + /// A player joined the server; they are in `players.online` already. + player-joined: func(player: player); + /// A player left the server; they are no longer in `players.online`. + player-left: func(player: player); + /// A chat message a player sent, as plain text. + chat: func(player: player, text: string); + /// `/name args` typed by `player`: ok(some(text)) is their feedback, + /// err(text) their error in red. + command: func(player: player, name: string, args: string) -> result, string>; + /// A player broke the block at `pos` in their dimension: `state` is what + /// was there, as `minecraft:oak_log[axis=y]`. + block-broken: func(player: player, pos: block-pos, state: string); + /// A player placed `state` at `pos` in their dimension. + block-placed: func(player: player, pos: block-pos, state: string); +} + +/// A client mod: runs in the player's game. world horizon-mod { import log; import game; @@ -422,6 +519,16 @@ world horizon-mod { export events; } +/// A server mod (manifest `side = "server"`, `api = "0.3"`, experimental): +/// runs where the world is simulated, on the dedicated server, a LAN host +/// and single player's own server. +world horizon-server-mod { + import log; + import storage; + import players; + export server-events; +} + /// A mod with widgets (capability `ui`): the SDK builds every mod against /// this world. Mods built for `horizon-mod` alone (no `ui-events` export) /// still load and simply hear nothing of their widgets. diff --git a/crates/horizon-mods/Cargo.toml b/crates/horizon-mods/Cargo.toml index a398e4d8b..8bfa58bcd 100644 --- a/crates/horizon-mods/Cargo.toml +++ b/crates/horizon-mods/Cargo.toml @@ -17,18 +17,27 @@ wasmtime = { version = "48.0.7", default-features = false, features = ["runtime" # Turns a mod's core module into a component (cargo horizon-mod build, the tests). wit-component = { version = "0.254", optional = true } wit-parser = { version = "0.254", optional = true } +# The functions a mod imports, for its API level (src/api_level.rs): the game and the registry index. +wasmparser = { version = "0.254", optional = true } # The registry index's checks (feature `index`): SHA-256, and minisign signatures (no dependencies of its own). sha2 = { version = "0.10", optional = true } minisign-verify = { version = "0.3", optional = true } +# A shader pack's check (kind `shader`): the one the game runs before it loads a pack. +horizon-shader-api = { path = "../horizon-shader-api", optional = true } + +[dev-dependencies] +# A component made for a newer Horizon, from the WIT alone (tests/sandbox.rs). +wit-component = { version = "0.254", features = ["dummy-module"] } +wit-parser = "0.254" [features] # Loads and runs mods (the game's `mods` feature); without it only manifests, # content and packaging. Off by default so builds that don't run mods (the # game's tests and probes) skip wasmtime and cranelift. -runtime = ["dep:wasmtime"] +runtime = ["dep:wasmtime", "dep:wasmparser"] pack = ["dep:wit-component", "dep:wit-parser"] # The mod registry's index (docs/api/mod-index.md): the launcher, the registry server and its CI. -index = ["dep:sha2", "dep:minisign-verify"] +index = ["dep:sha2", "dep:minisign-verify", "dep:horizon-shader-api", "dep:wasmparser"] # Runs real mods: `cargo test -p horizon-mods --features runtime,pack`. [[test]] diff --git a/crates/horizon-mods/src/api_level.rs b/crates/horizon-mods/src/api_level.rs new file mode 100644 index 000000000..785f0e573 --- /dev/null +++ b/crates/horizon-mods/src/api_level.rs @@ -0,0 +1,190 @@ +//! Mod API levels: which of the WIT contract's functions a Horizon has +//! (`docs/api/stability.md`). Every function the game offers mods has the +//! level it arrived at; a Horizon serves every level up to its [`LEVEL`]. +//! A mod needs the level of the newest function it imports, so a mod that +//! calls a function this Horizon doesn't have is refused with "update +//! Horizon" instead of a linking error, and the registry lists each +//! version's level so the launcher can tell before it installs. + +/// The newest level this Horizon serves. +pub const LEVEL: u32 = 2; + +/// Every function the game offers mods, as `interface.function`, with its +/// level. Level 0 is the contract of Horizon 0.2.67 to 0.2.69. A new +/// function takes the next level and raises [`LEVEL`] (the `api_reference` +/// test fails until it is listed here). +pub const FUNCTIONS: [(&str, u32); 33] = [ + ("log.write", 0), + ("game.get-player", 0), + ("game.get-clock", 0), + ("chat.show", 0), + ("hud.set-panel", 0), + ("hud.clear", 0), + ("storage.get", 0), + ("storage.set", 0), + ("storage.delete", 0), + ("command.run", 0), + ("ui.open-screen", 0), + ("ui.close-screen", 0), + ("ui.set-settings", 0), + ("input.claim-items", 0), + ("input.register-key", 0), + ("input.held", 0), + ("input.poll", 0), + ("input.claim-wheel", 0), + ("input.mapping", 0), + ("input.clicks-per-second", 0), + ("render.set-hud", 0), + ("render.gui-size", 0), + ("render.shake", 0), + ("render.set-corner", 0), + ("render.clear-corner", 0), + ("render.text-width", 0), + ("render.frame-stats", 0), + ("render.set-zoom", 0), + ("render.set-minimap", 1), + ("players.online", 1), + ("players.tell", 1), + ("players.broadcast", 1), + ("game.raycast", 2), +]; + +/// What the game's program carries so the launcher can read its level +/// without running it: `horizon-mod-api-level:0001;` (four digits). A +/// program from before the mark serves level 0. +pub const MARK: [u8; 27] = { + let mut mark = *b"horizon-mod-api-level:0000;"; + let mut level = LEVEL; + let mut i = 25; + while level > 0 { + mark[i] = b'0' + (level % 10) as u8; + level /= 10; + i -= 1; + } + mark +}; + +/// The level a program's bytes carry in their [`MARK`], if any. +pub fn read_mark(program: &[u8]) -> Option { + let prefix = &MARK[..22]; + program + .windows(MARK.len()) + .filter(|w| w.starts_with(prefix) && w[26] == b';') + .find_map(|w| std::str::from_utf8(&w[22..26]).ok()?.parse().ok()) +} + +/// A function's level; None for one this Horizon doesn't have. +pub fn level_of(function: &str) -> Option { + FUNCTIONS + .iter() + .find(|(name, _)| *name == function) + .map(|&(_, level)| level) +} + +/// The level a mod needs, from the functions it imports (as [`imports`] +/// names them): its newest function's. A function this Horizon doesn't +/// know comes from a newer one, so it needs more than [`LEVEL`]; that +/// function is returned with it, for the message. +pub fn needed<'a>(imports: impl IntoIterator) -> (u32, Option<&'a str>) { + let mut needed = (0, None); + for name in imports { + match level_of(name) { + Some(level) if level > needed.0 => needed = (level, Some(name)), + Some(_) => {} + None => return (LEVEL + 1, Some(name)), + } + } + needed +} + +/// Why this Horizon can't run a mod that needs `level`, or None when it can. +pub fn too_new(level: u32, function: Option<&str>) -> Option { + (level > LEVEL).then(|| { + let uses = function.map_or(String::new(), |f| format!(" (it uses {f})")); + format!("made for a newer Horizon{uses}: update Horizon to run it") + }) +} + +/// The functions a mod's component imports from Horizon (`horizon:mods/*`), +/// as `interface.function`, in the component's order. +#[cfg(any(feature = "runtime", feature = "index"))] +pub fn imports(wasm: &[u8]) -> Result, String> { + use wasmparser::{ + Parser, Payload, Validator, WasmFeatures, component_types::ComponentEntityType, + }; + let types = Validator::new_with_features(WasmFeatures::all()) + .validate_all(wasm) + .map_err(|e| format!("not a component: {e}"))?; + let types = types.as_ref(); + let mut out = Vec::new(); + for payload in Parser::new(0).parse_all(wasm) { + let Payload::ComponentImportSection(section) = payload.map_err(|e| e.to_string())? else { + continue; + }; + for import in section { + let name = import.map_err(|e| e.to_string())?.name.name; + // `horizon:mods/render@0.1.0` → `render`. + let Some(interface) = name.strip_prefix("horizon:mods/") else { + continue; + }; + let interface = interface.split('@').next().unwrap_or(interface); + let Some(item) = types.component_item_for_import(name) else { + continue; + }; + if let ComponentEntityType::Instance(id) = item.ty { + for (function, export) in &types[id].exports { + if matches!(export.ty, ComponentEntityType::Func(_)) { + out.push(format!("{interface}.{function}")); + } + } + } + } + } + Ok(out) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn levels_are_listed_once_and_up_to_this_horizons() { + for (i, (name, level)) in FUNCTIONS.iter().enumerate() { + assert!(*level <= LEVEL, "{name}"); + assert!( + FUNCTIONS[..i].iter().all(|(other, _)| other != name), + "{name} twice" + ); + } + assert!(FUNCTIONS.iter().any(|&(_, level)| level == LEVEL)); + } + + #[test] + fn the_mark_carries_the_level() { + assert_eq!(read_mark(&MARK), Some(LEVEL)); + let mut program = b"\0\x7fELF horizon-mod-api-level: horizon-mod-api-level:".to_vec(); + program.extend_from_slice(&MARK); + program.extend_from_slice(b"\0rest"); + assert_eq!(read_mark(&program), Some(LEVEL)); + assert_eq!(read_mark(b"horizon-mod-api-level:12;"), None); + assert_eq!(read_mark(b"no mark"), None); + } + + #[test] + fn a_mod_needs_its_newest_function() { + assert_eq!(needed(["log.write", "hud.set-panel"]), (0, None)); + assert_eq!( + needed(["log.write", "render.set-minimap", "hud.clear"]), + (1, Some("render.set-minimap")) + ); + assert_eq!( + needed(["render.set-minimap", "render.set-sky"]), + (LEVEL + 1, Some("render.set-sky")) + ); + assert_eq!(too_new(LEVEL, None), None); + assert_eq!( + too_new(LEVEL + 1, Some("render.set-sky")).as_deref(), + Some("made for a newer Horizon (it uses render.set-sky): update Horizon to run it") + ); + } +} diff --git a/crates/horizon-mods/src/index.rs b/crates/horizon-mods/src/index.rs index db860fd9f..4ef292a23 100644 --- a/crates/horizon-mods/src/index.rs +++ b/crates/horizon-mods/src/index.rs @@ -47,8 +47,8 @@ pub enum Kind { Modpack, /// A resource pack (`.zip` with `pack.mcmeta`) made or tested for Horizon. ResourcePack, - /// A Horizon shader pack (the native WGSL format, not Iris or OptiFine - /// packs). Listed by the schema; submissions open with its API. + /// A Horizon shader pack (`.hshader`, the native WGSL format of + /// docs/shaders.md; not the shaders/-folder packs, which stay on Modrinth). Shader, Other(String), } @@ -69,7 +69,8 @@ impl Kind { match self { Kind::Mod => Some("hmod"), Kind::Modpack => Some("hpack"), - Kind::ResourcePack | Kind::Shader => Some("zip"), + Kind::ResourcePack => Some("zip"), + Kind::Shader => Some(horizon_shader_api::EXTENSION), Kind::Other(_) => None, } } @@ -121,6 +122,14 @@ pub struct Project { pub key: Option, /// Newest first. pub versions: Vec, + /// Its files' downloads from their releases, all versions together: + /// GitHub's counts, added by the registry's publish job (hourly). + #[serde(default, skip_serializing_if = "is_zero")] + pub downloads: u64, +} + +fn is_zero(n: &u64) -> bool { + *n == 0 } #[derive(Clone, Debug, PartialEq, Serialize, Deserialize)] @@ -137,6 +146,11 @@ pub struct Version { pub side: Option, #[serde(default, skip_serializing_if = "Vec::is_empty")] pub capabilities: Vec, + /// The mod API level a mod's code needs ([`crate::api_level`]), read + /// from its file; none for content and other kinds, and in indexes + /// built before levels. + #[serde(default, skip_serializing_if = "Option::is_none")] + pub api_level: Option, /// The Minecraft version it is for. pub game: String, /// A modpack's mods, as its manifest lists them. @@ -316,6 +330,21 @@ impl Index { Ok(()) } + /// A project's newest version for Minecraft `game` that wasn't taken + /// down and that a Horizon serving mod API `level` can run (an unknown + /// level counts as runnable: the game still checks when it starts it). + pub fn installable<'a>( + &self, + project: &'a Project, + game: &str, + level: u32, + ) -> Option<&'a Version> { + project.versions.iter().find(|v| { + v.game == game + && v.api_level.is_none_or(|l| l <= level) + && self.revoked(&project.id, &v.file.sha256).is_none() + }) + } pub fn project(&self, id: &str) -> Option<&Project> { self.projects.iter().find(|p| p.id == id) } @@ -448,7 +477,7 @@ pub fn check_file( (None, None) => Trust::Unsigned, _ => return Err("its signature and the project's key don't go together".into()), }; - if matches!(project.kind, Kind::Shader | Kind::Other(_)) { + if matches!(project.kind, Kind::Other(_)) { return Err(format!( "this Horizon can't install a {} yet", project.kind.name() @@ -471,6 +500,8 @@ pub struct Facts { pub side: Option, /// In the manifest's order. pub capabilities: Vec, + /// The mod API level a mod's code needs, from the functions it imports. + pub api_level: Option, /// The Minecraft version, when the file names one (a modpack does). pub game: Option, pub requires: Vec, @@ -487,6 +518,7 @@ impl Facts { || self.api != version.api || self.side != version.side || caps != listed + || version.api_level.is_some() && self.api_level != version.api_level || self.game.as_ref().is_some_and(|g| *g != version.game) || self.requires != version.requires; if !differs { @@ -502,6 +534,13 @@ impl Facts { names(&self.capabilities) ), Kind::Modpack => format!("its {} isn't what the index lists", modpack::MANIFEST), + Kind::Shader => format!( + "its {} ({} {}, shader API {}) isn't what the index lists", + horizon_shader_api::MANIFEST, + self.id.as_deref().unwrap_or("?"), + self.version.as_deref().unwrap_or("?"), + self.api + ), _ => format!("its pack format {} isn't what the index lists", self.api), }) } @@ -509,14 +548,22 @@ impl Facts { /// Reads and checks a file as its kind: a mod's manifest and content, a /// modpack's manifest and overrides, a resource pack's `pack.mcmeta` and -/// paths. Shader packs and kinds this build doesn't know are refused: their -/// checks come with their formats. +/// paths, a shader pack's `horizon_shader_api::check` (the game's own). Kinds +/// this build doesn't know are refused: their checks come with their formats. pub fn inspect(kind: &Kind, path: &Path) -> Result { match kind { Kind::Mod => { - let m = Package::read(path)?.manifest; + let Package { manifest: m, wasm } = Package::read(path)?; crate::Content::read(path, &m)?; + let api_level = match wasm { + Some(wasm) => { + let functions = crate::api_level::imports(&wasm)?; + Some(crate::api_level::needed(functions.iter().map(String::as_str)).0) + } + None => None, + }; Ok(Facts { + api_level, capabilities: m.capabilities, id: Some(m.id), version: Some(m.version), @@ -540,9 +587,23 @@ pub fn inspect(kind: &Kind, path: &Path) -> Result { api: check_resource_pack(path)?, ..Facts::default() }), - Kind::Shader => Err( - "Horizon's own shader pack format isn't out yet: shader packs open when it is".into(), - ), + Kind::Shader => { + let pack = horizon_shader_api::Pack::read(path)?; + if let Err(problems) = horizon_shader_api::check(&pack) { + let lines: Vec = problems.iter().map(ToString::to_string).collect(); + return Err(format!( + "the shader pack fails its check:\n{}", + lines.join("\n") + )); + } + let m = pack.manifest; + Ok(Facts { + id: Some(m.id), + version: Some(m.version), + api: m.api, + ..Facts::default() + }) + } Kind::Other(name) => Err(format!("this Horizon can't read a {name} yet")), } } @@ -591,14 +652,11 @@ fn check_resource_pack(path: &Path) -> Result { Ok(format) } -/// The kinds the registry takes submissions for. Shader packs wait for -/// Horizon's own format; other kinds for theirs. +/// The kinds the registry takes submissions for; other kinds wait for their +/// formats. pub fn open(kind: &Kind) -> Result<(), String> { match kind { - Kind::Mod | Kind::Modpack | Kind::ResourcePack => Ok(()), - Kind::Shader => Err( - "shader packs open when Horizon's own shader pack format is out (Iris and OptiFine packs stay on Modrinth)".into(), - ), + Kind::Mod | Kind::Modpack | Kind::ResourcePack | Kind::Shader => Ok(()), Kind::Other(name) => Err(format!("the registry doesn't take {name} yet")), } } diff --git a/crates/horizon-mods/src/index/registry.rs b/crates/horizon-mods/src/index/registry.rs index 21b5de9fb..05fff7f14 100644 --- a/crates/horizon-mods/src/index/registry.rs +++ b/crates/horizon-mods/src/index/registry.rs @@ -231,6 +231,7 @@ pub fn project(entry: &Entry, src: &Sources) -> Result> { icon, key: entry.key.as_ref().map(|k| k.trim().to_owned()), versions, + downloads: 0, }) } @@ -283,6 +284,7 @@ fn version(entry: &Entry, v: &EntryVersion, src: &Sources) -> Result PathBuf { Path::new(env!("CARGO_MANIFEST_DIR")).join("tests/index") @@ -61,6 +62,23 @@ file = "cozy-1.0.0.hpack" sha256 = "241ac840f9c5ea3f6252d849da10c90d36cb1da4d6cd8d1d268c2760a353cd65" "#; +const GLOW: &str = r#"id = "glow" +kind = "shader" +name = "Soft Glow" +summary = "A post-processing pass over the world." +authors = ["Horizon"] +owners = ["ludovic111"] +license = "MIT" +source = "https://github.com/ludovic111/horizon-mods" + +[[versions]] +version = "1.0.0" +published = "2026-10-26" +game = "26.3" +file = "glow-1.0.0.hshader" +sha256 = "331cfe29a666a0de804e9a9ff3d19d246eebcfbfa70b4f49bba8482d30ad9f02" +"#; + const REVOKED_TOML: &str = r#"[[revoked]] id = "bad_mod" sha256 = "1111111111111111111111111111111111111111111111111111111111111111" @@ -82,9 +100,14 @@ impl Scratch { let s = Scratch(dir); s.write("mods/coords_hud.toml", &hud_entry()); s.write("mods/cozy.toml", COZY); + s.write("mods/glow.toml", GLOW); s.write("revoked.toml", REVOKED_TOML); s.write("icons/coords_hud.png", "png"); - for (name, hash) in [("coords_hud-0.1.0.hmod", HMOD), ("cozy-1.0.0.hpack", HPACK)] { + for (name, hash) in [ + ("coords_hud-0.1.0.hmod", HMOD), + ("cozy-1.0.0.hpack", HPACK), + ("glow-1.0.0.hshader", HSHADER), + ] { std::fs::copy(fixtures().join(name), s.0.join("files").join(hash)).unwrap(); } s @@ -117,7 +140,7 @@ fn builds_the_sample_index() { let s = Scratch::new("sample"); let built = s.build().unwrap(); let sample = sample(); - assert_eq!(built.projects, sample.projects[..2]); + assert_eq!(built.projects, sample.projects[..3]); assert_eq!(built.revoked, sample.revoked); assert_eq!(built.generated, sample.generated); // What it writes reads back. @@ -154,7 +177,11 @@ fn lists_every_problem_of_a_registry() { "{errors:?}" ); assert!(has("coords_hud 0.1.0: the project has a key"), "{errors:?}"); - assert!(has("glow: shader packs open when"), "{errors:?}"); + // A shader entry is taken now, and checked like the others. + assert!( + has("glow 1.0.0: the file isn't the one its sha256 names"), + "{errors:?}" + ); assert!( has("other 0.1.0: the file's id is \"coords_hud\""), "{errors:?}" @@ -219,7 +246,7 @@ fn a_review_protects_published_files() { #[test] fn only_open_kinds_are_taken() { assert!(open(&Kind::Mod).is_ok() && open(&Kind::ResourcePack).is_ok()); - assert!(open(&Kind::Shader).unwrap_err().contains("Iris")); + assert!(open(&Kind::Shader).is_ok()); assert!(open(&Kind::Other("world".into())).is_err()); let mut submit: Entry = toml::from_str(COZY).unwrap(); submit.id = "submit".into(); diff --git a/crates/horizon-mods/src/index/tests.rs b/crates/horizon-mods/src/index/tests.rs index e3883f79e..486704b7d 100644 --- a/crates/horizon-mods/src/index/tests.rs +++ b/crates/horizon-mods/src/index/tests.rs @@ -1,7 +1,8 @@ //! The sample index (`tests/index/index-v1.json`, the one docs/api/mod-index.md //! shows) and its files: `coords_hud-0.1.0.hmod`, signed with the throwaway -//! key `test.pub` by minisign 0.12 (its secret key was deleted), and -//! `cozy-1.0.0.hpack`, unsigned. +//! key `test.pub` by minisign 0.12 (its secret key was deleted), +//! `cozy-1.0.0.hpack`, unsigned, and `glow-1.0.0.hshader`, unsigned +//! (`horizon-shader new --template post`, then `horizon-shader pack`). use super::*; use std::path::PathBuf; @@ -25,16 +26,22 @@ fn reads_the_sample_and_keeps_unknown_kinds() { let index = sample(); assert_eq!(index.schema, SCHEMA); let kinds: Vec<&str> = index.projects.iter().map(|p| p.kind.name()).collect(); - assert_eq!(kinds, ["mod", "modpack", "world"]); - assert_eq!(index.projects[2].kind, Kind::Other("world".into())); + assert_eq!(kinds, ["mod", "modpack", "shader", "world"]); + assert_eq!(index.projects[3].kind, Kind::Other("world".into())); let hud = index.project("coords_hud").unwrap(); assert_eq!( hud.versions[0].capabilities, [Capability::GameRead, Capability::Hud, Capability::Chat] ); // What CI writes reads back the same. - let again = Index::parse(&serde_json::to_string(&index).unwrap()).unwrap(); + let text = serde_json::to_string(&index).unwrap(); + let again = Index::parse(&text).unwrap(); assert_eq!(again, index); + // Download counts: the publish job adds them; none is left out. + assert_eq!(hud.downloads, 0); + assert!(!text.contains("downloads")); + let counted = text.replacen("\"versions\"", "\"downloads\":12345,\"versions\"", 1); + assert_eq!(Index::parse(&counted).unwrap().projects[0].downloads, 12345); } #[test] @@ -44,6 +51,8 @@ fn files_pass_against_their_entries() { assert_eq!(check(&index, "coords_hud", &hmod), Ok(Trust::Verified)); let hpack = fixtures().join("cozy-1.0.0.hpack"); assert_eq!(check(&index, "cozy", &hpack), Ok(Trust::Unsigned)); + let hshader = fixtures().join("glow-1.0.0.hshader"); + assert_eq!(check(&index, "glow", &hshader), Ok(Trust::Unsigned)); let world = index.project("skyblock_start").unwrap(); let e = check_file(&index, world, &world.versions[0], &hpack).unwrap_err(); assert!(e.contains("bytes"), "{e}"); @@ -73,6 +82,15 @@ fn a_changed_file_key_or_manifest_is_refused() { let e = check(&more_caps, "coords_hud", &hmod).unwrap_err(); assert!(e.contains("isn't what the index lists"), "{e}"); + let mut other_level = index.clone(); + other_level.projects[0].versions[0].api_level = Some(1); + let e = check(&other_level, "coords_hud", &hmod).unwrap_err(); + assert!(e.contains("isn't what the index lists"), "{e}"); + // An index built before levels lists none: the file still passes. + let mut no_level = index.clone(); + no_level.projects[0].versions[0].api_level = None; + assert_eq!(check(&no_level, "coords_hud", &hmod), Ok(Trust::Verified)); + let mut revoked = index.clone(); revoked.revoked.push(Revoked { id: "coords_hud".into(), @@ -163,3 +181,79 @@ fn resource_packs_need_a_pack_mcmeta() { assert!(e.contains("plain path"), "{e}"); std::fs::remove_dir_all(&dir).unwrap(); } + +#[test] +fn the_newest_version_this_horizon_runs_is_installed() { + let mut index = sample(); + let mut newer = index.projects[0].versions[0].clone(); + newer.version = "0.2.0".into(); + newer.file.sha256 = "2".repeat(64); + newer.api_level = Some(crate::api_level::LEVEL + 1); + index.projects[0].versions.insert(0, newer); + let p = index.project("coords_hud").unwrap(); + let pick = |level| { + index + .installable(p, "26.3", level) + .map(|v| v.version.as_str()) + }; + assert_eq!(pick(crate::api_level::LEVEL), Some("0.1.0")); + assert_eq!(pick(crate::api_level::LEVEL + 1), Some("0.2.0")); + assert_eq!(index.installable(p, "26.4", crate::api_level::LEVEL), None); + // No level listed: runnable as far as the index knows. + index.projects[0].versions[0].api_level = None; + let p = index.project("coords_hud").unwrap(); + let v = index.installable(p, "26.3", 0).unwrap(); + assert_eq!(v.version, "0.2.0"); +} + +#[test] +fn shader_packs_pass_the_game_s_own_check() { + let manifest = "schema = 1\nid = \"glow\"\nname = \"Glow\"\nversion = \"1.0.0\"\napi = \"0.1\"\n\ + [[post]]\nfile = \"post.wgsl\"\n"; + let pack = |post: &str| { + let files = [ + (horizon_shader_api::MANIFEST, manifest), + ("post.wgsl", post), + ] + .map(|(n, t)| (n.to_owned(), t.as_bytes().to_vec())) + .into(); + horizon_shader_api::Pack::from_files(files) + .unwrap() + .package() + .unwrap() + }; + let dir = std::env::temp_dir().join(format!("horizon-mods-shader-{}", std::process::id())); + std::fs::create_dir_all(&dir).unwrap(); + let good = dir.join("glow-1.0.0.hshader"); + std::fs::write( + &good, + pack("fn post(input: PostInput) -> vec4 { return input.color; }\n"), + ) + .unwrap(); + let bad = dir.join("bad.hshader"); + std::fs::write( + &bad, + pack("fn post(input: PostInput) -> vec4 { return input.color }\n"), + ) + .unwrap(); + let facts = inspect(&Kind::Shader, &good); + let refused = inspect(&Kind::Shader, &bad).unwrap_err(); + let not_a_pack = inspect(&Kind::Shader, &fixtures().join("cozy-1.0.0.hpack")).unwrap_err(); + std::fs::remove_dir_all(&dir).unwrap(); + let facts = facts.unwrap(); + assert_eq!( + ( + facts.id.as_deref(), + facts.version.as_deref(), + facts.api.as_str() + ), + (Some("glow"), Some("1.0.0"), "0.1") + ); + assert!(refused.contains("post.wgsl:1:"), "{refused}"); + assert!( + not_a_pack.contains(horizon_shader_api::MANIFEST), + "{not_a_pack}" + ); + assert_eq!(Kind::Shader.extension(), Some("hshader")); + assert!(open(&Kind::Shader).is_ok()); +} diff --git a/crates/horizon-mods/src/lib.rs b/crates/horizon-mods/src/lib.rs index 3c5fe74f6..20f475165 100644 --- a/crates/horizon-mods/src/lib.rs +++ b/crates/horizon-mods/src/lib.rs @@ -5,6 +5,7 @@ //! //! Nothing here runs unless a mod is installed and turned on: an empty //! [`Mods`] makes no engine and every hook returns at once. +pub mod api_level; pub mod content; #[cfg(feature = "index")] pub mod index; diff --git a/crates/horizon-mods/src/manifest.rs b/crates/horizon-mods/src/manifest.rs index d520d55e3..5ad7823aa 100644 --- a/crates/horizon-mods/src/manifest.rs +++ b/crates/horizon-mods/src/manifest.rs @@ -16,7 +16,10 @@ pub const API: &str = "0.1"; /// The manifest `api` lines this build loads. 0.2 is 0.1 plus content: /// `assets/` and `data/` in the `.hmod`, with blocks and items declared in /// `data//horizon/` (docs/modpacks.md). Code still links API 0.1. -pub const APIS: [&str; 2] = [API, "0.2"]; +/// 0.3 is a server mod (experimental): the `horizon-server-mod` world. +pub const APIS: [&str; 3] = [API, "0.2", SERVER_API]; +/// The line of server mods, experimental: `side = "server"`. +pub const SERVER_API: &str = "0.3"; /// Namespaces no mod may claim: vanilla's, the convention tags' (mods add /// to those, docs/mods.md) and the game's own. const RESERVED_NAMESPACES: [&str; 3] = ["minecraft", "c", "horizon"]; @@ -63,7 +66,7 @@ pub enum Side { /// Runs in the player's game only (HUD, keys, chat commands). #[default] Client, - /// Runs where the world is simulated (rules, blocks); not run yet. + /// Runs where the world is simulated (rules, blocks): `api = "0.3"`. Server, /// Both, and the server tells clients which version it expects. Both, @@ -92,9 +95,11 @@ pub enum Capability { /// The use button on items the mod claims, and its own keys /// (interface `input`). Input, + /// The players on the server and messages to them (server mods). + Players, } impl Capability { - pub const ALL: [Capability; 9] = [ + pub const ALL: [Capability; 10] = [ Capability::GameRead, Capability::Chat, Capability::Hud, @@ -104,7 +109,12 @@ impl Capability { Capability::Ui, Capability::Render, Capability::Input, + Capability::Players, ]; + /// Whether a server mod may have it: the others act on a local player. + pub fn on_server(self) -> bool { + matches!(self, Capability::Storage | Capability::Players) + } /// The WIT interface it grants, in `horizon:mods`. pub fn interface(self) -> &'static str { match self { @@ -117,6 +127,7 @@ impl Capability { Capability::Ui => "ui", Capability::Render => "render", Capability::Input => "input", + Capability::Players => "players", } } /// May change in any release: a mod uses it only with @@ -141,6 +152,7 @@ impl Capability { Capability::Input => { "see the keys you hold and your clicks, take over the use button on its own items and the mouse wheel, and add keys" } + Capability::Players => "see who is on the server and message them", } } /// The capability a component import needs, `Ok(None)` for one every @@ -175,6 +187,7 @@ impl fmt::Display for Capability { Capability::Ui => "ui", Capability::Render => "render", Capability::Input => "input", + Capability::Players => "players", }; f.write_str(name) } @@ -205,6 +218,20 @@ impl Manifest { "{MANIFEST}: capability registries needs api = \"0.2\"" )); } + let server = m.side == Side::Server; + if server != (m.api == SERVER_API) { + return Err(format!( + "{MANIFEST}: a server mod is side = \"server\" with api = \"{SERVER_API}\", and only it" + )); + } + if let Some(c) = m + .capabilities + .iter() + .find(|c| c.on_server() != server && **c != Capability::Storage) + { + let side = if server { "client" } else { "server" }; + return Err(format!("{MANIFEST}: capability {c} is for {side} mods")); + } if let Some(c) = m .capabilities .iter() @@ -435,12 +462,32 @@ capabilities = ["game-read", "hud"] fn refuses_bad_ids_and_apis() { let bad_id = EXAMPLE.replace("coords_hud", "Coords HUD"); assert!(Manifest::parse(&bad_id).unwrap_err().contains("is not")); - let bad_api = EXAMPLE.replace("api = \"0.1\"", "api = \"0.3\""); - assert!(Manifest::parse(&bad_api).unwrap_err().contains("API 0.3")); + let bad_api = EXAMPLE.replace("api = \"0.1\"", "api = \"0.4\""); + assert!(Manifest::parse(&bad_api).unwrap_err().contains("API 0.4")); let unknown = format!("{EXAMPLE}network = true\n"); assert!(Manifest::parse(&unknown).is_err()); } + #[test] + fn server_mods_are_api_0_3_with_server_capabilities() { + let server = |api: &str, side: &str, caps: &str| { + Manifest::parse(&format!( + "id = \"w\"\nname = \"W\"\nversion = \"1\"\napi = \"{api}\"\nside = \"{side}\"\ncapabilities = [{caps}]\n" + )) + }; + let m = server("0.3", "server", "\"players\", \"storage\"").unwrap(); + let imports = ["horizon:mods/players@0.1.0", "horizon:mods/storage@0.1.0"]; + assert_eq!(m.check_imports(imports), Ok(())); + for (api, side) in [("0.3", "client"), ("0.3", "both"), ("0.1", "server")] { + let e = server(api, side, "").unwrap_err(); + assert!(e.contains("a server mod is side"), "{e}"); + } + let e = server("0.3", "server", "\"hud\"").unwrap_err(); + assert!(e.contains("capability hud is for client mods"), "{e}"); + let e = server("0.1", "client", "\"players\"").unwrap_err(); + assert!(e.contains("capability players is for server mods"), "{e}"); + } + #[test] fn checks_extra_namespaces() { let content = "id = \"t_and_t\"\nname = \"T\"\nversion = \"1\"\napi = \"0.2\"\ncapabilities = [\"registries\"]\n"; diff --git a/crates/horizon-mods/src/runtime.rs b/crates/horizon-mods/src/runtime.rs index 4dc334ea5..ea603ee31 100644 --- a/crates/horizon-mods/src/runtime.rs +++ b/crates/horizon-mods/src/runtime.rs @@ -1,5 +1,9 @@ //! Loading and calling mods with wasmtime's component model. use crate::manifest::{Manifest, Package, Side}; +use server_bindings::{ + HorizonServerMod, exports::horizon::mods::server_events::Registration as ServerRegistration, + horizon::mods::players, +}; use std::{ path::{Path, PathBuf}, sync::Arc, @@ -16,6 +20,17 @@ mod bindings { world: "horizon-mod", }); } +/// The server mods' world: `log` and `storage` are the client world's. +mod server_bindings { + wasmtime::component::bindgen!({ + path: "../horizon-mod-sdk/wit", + world: "horizon-server-mod", + with: { + "horizon:mods/log": super::bindings::horizon::mods::log, + "horizon:mods/storage": super::bindings::horizon::mods::storage, + }, + }); +} /// Capability `ui`'s world beyond `horizon-mod` (docs/mods.md): a second /// world, so mods built before it (no `ui-events` export) still instantiate /// as `horizon-mod` and simply hear nothing of their widgets. @@ -26,7 +41,7 @@ mod ui_bindings { }); } pub use bindings::horizon::mods::{ - game::{Clock, Player}, + game::{Clock, Hit, Player}, hud::{Corner, Line}, }; use bindings::{ @@ -34,6 +49,12 @@ use bindings::{ exports::horizon::mods::events::Registration, horizon::mods::{chat, command, game, hud, log as mod_log, storage}, }; +pub use server_bindings::{ + exports::horizon::mods::server_events::BlockPos, + horizon::mods::players::{GameMode, Player as ServerPlayer}, +}; +type ClientEvents = bindings::exports::horizon::mods::events::Guest; +type ServerEvents = server_bindings::exports::horizon::mods::server_events::Guest; /// The widget model a `ui` screen or settings page shows (WIT `interface /// ui`), for the game to draw with its menus' own widgets. pub use ui_bindings::horizon::mods::ui::{ @@ -68,6 +89,8 @@ const FUEL_FRAME: u64 = 10_000_000; const FUEL_EVENT: u64 = 100_000_000; /// Chat lines a mod may show per call, HUD lines and their length. const CHAT_PER_CALL: usize = 8; +/// How far `game.raycast` sees, in blocks. +pub const RAYCAST_MAX: f32 = 1024.0; const HUD_LINES: usize = 16; const LINE_CHARS: usize = 256; /// Total bytes a mod's `storage` may hold on disk, across all its keys. @@ -101,6 +124,30 @@ pub struct Snapshot { /// The HUD font's advance per character from U+0000 /// (`render.text-width`); empty: 6 each. pub font_widths: Arc<[f32]>, + /// The players on the server, for server mods. + pub players: Vec, + /// The first block along the player's view within [`RAYCAST_MAX`] and + /// its distance from the eye, for `game.raycast`; the game works it out + /// only while a mod calls it ([`Mods::wants_raycast`]). + pub view_hit: Option<(f32, Hit)>, +} + +/// Which mods a game starts: the window's game the client mods, the game +/// simulating the world the server mods, single player in the frame both. +#[derive(Clone, Copy, Debug, PartialEq)] +pub enum Runs { + Client, + Server, + Both, +} +impl Runs { + fn starts(self, side: Side) -> bool { + match self { + Runs::Both => true, + Runs::Client => side != Side::Server, + Runs::Server => side == Side::Server, + } + } } /// What mods asked the game to show since the last [`Mods::drain`]. @@ -115,6 +162,20 @@ pub enum Output { Command { line: String }, /// The mod was turned off: it trapped, overran or failed to start. Stopped { name: String, reason: String }, + /// `players.tell`: a line after the mod's name, to the player with this id. + Tell { + name: String, + player: String, + text: String, + }, + /// `players.broadcast`: a line after the mod's name, to every player. + Broadcast { name: String, text: String }, + /// A server mod command's feedback, to the player who typed it. + Reply { + player: String, + text: String, + error: bool, + }, /// `ui.open-screen`: the mod's entry in `entries()`; what it shows is /// [`Mods::screen`]. OpenScreen { owner: usize }, @@ -136,6 +197,9 @@ pub enum Status { /// Installed and turned off by the player. Off, Running, + /// Turned on, and run by another game: a server mod in the window while + /// the world runs on its server thread. + Elsewhere, /// Could not load or start, or stopped while running. Failed(String), } @@ -165,10 +229,38 @@ impl Entry { struct Running { store: Store, - exports: HorizonMod, - /// The mod's `ui-events` export; none for a mod built before `ui`. + /// The mod's `ui-events` export; none for a mod built before `ui`, or a + /// server mod. ui: Option, - hooks: Registration, + hooks: Hooks, + /// It imports `game.raycast`. + raycasts: bool, +} + +/// A running mod's exports and the hooks its `init` asked for. +enum Hooks { + Client(HorizonMod, Registration), + Server(HorizonServerMod, ServerRegistration), +} +impl Hooks { + fn client(&self) -> Option<&Registration> { + match self { + Hooks::Client(_, r) => Some(r), + Hooks::Server(..) => None, + } + } + fn server(&self) -> Option<&ServerRegistration> { + match self { + Hooks::Server(_, r) => Some(r), + Hooks::Client(..) => None, + } + } + fn commands(&self) -> &[String] { + match self { + Hooks::Client(_, r) => &r.commands, + Hooks::Server(_, r) => &r.commands, + } + } } /// What capability `ui` pushed since the hooks last ran. @@ -221,13 +313,23 @@ pub struct Mods { } impl Mods { - /// Reads every mod at `paths` and starts those `enabled` says are on. - /// A command that `reserved` (vanilla's commands) or an earlier mod - /// already uses is refused. + /// Reads every mod at `paths` and starts those `enabled` says are on, + /// client and server mods alike. A command that `reserved` (vanilla's + /// commands) or an earlier mod already uses is refused. pub fn load( paths: &[PathBuf], enabled: impl Fn(&str) -> bool, reserved: impl Fn(&str) -> bool, + ) -> Mods { + Mods::load_for(Runs::Both, paths, enabled, reserved) + } + /// [`Mods::load`], starting only the mods `runs` says this game runs; the + /// others that are on are [`Status::Elsewhere`]. + pub fn load_for( + runs: Runs, + paths: &[PathBuf], + enabled: impl Fn(&str) -> bool, + reserved: impl Fn(&str) -> bool, ) -> Mods { let mut mods = Mods::default(); for path in paths { @@ -245,7 +347,9 @@ impl Mods { Ok(package) => { let on = enabled(&package.manifest.id); entry.manifest = Some(package.manifest.clone()); - if on { + if on && !runs.starts(package.manifest.side) { + entry.status = Status::Elsewhere; + } else if on { // Content is read before the world loads; a mod whose // content is refused stays off, with the reason. let content = crate::Content::read(path, &package.manifest); @@ -276,6 +380,8 @@ impl Mods { let mut linker = Linker::new(&engine); HorizonMod::add_to_linker::>(&mut linker, |s| s) .map_err(|e| e.to_string())?; + players::add_to_linker::>(&mut linker, |s| s) + .map_err(|e| e.to_string())?; UiHost::add_to_linker::>(&mut linker, |s| s) .map_err(|e| e.to_string())?; RenderHost::add_to_linker::>(&mut linker, |s| s) @@ -299,9 +405,6 @@ impl Mods { let Some(wasm) = &package.wasm else { return Ok(None); }; - if m.side == Side::Server { - return Err("server mods do not run yet".into()); - } // Two running mods with the same id would share one `data_dir` // (capability `storage`): the first loaded keeps the id. if self @@ -311,11 +414,13 @@ impl Mods { { return Err(format!("another running mod already uses id {}", m.id)); } + let server = m.side == Side::Server; let taken: Vec = self .entries .iter() .filter_map(|e| e.run.as_ref()) - .flat_map(|r| r.hooks.commands.iter().cloned()) + .filter(|r| r.hooks.server().is_some() == server) + .flat_map(|r| r.hooks.commands().iter().cloned()) .collect(); let snapshot = self.snapshot.clone(); let (engine, linker) = self.engine()?; @@ -327,6 +432,12 @@ impl Mods { .map(|(name, _)| name.to_string()) .collect(); m.check_imports(imports.iter().map(String::as_str))?; + // A function this Horizon doesn't have: say so, not wasmtime's linking error. + let functions = crate::api_level::imports(wasm)?; + let (level, function) = crate::api_level::needed(functions.iter().map(String::as_str)); + if let Some(why) = crate::api_level::too_new(level, function) { + return Err(why); + } let data_dir = path .parent() .unwrap_or(Path::new(".")) @@ -357,15 +468,29 @@ impl Mods { let instance = linker .instantiate(&mut store, &component) .map_err(|e| reason(&e))?; - let exports = HorizonMod::new(&mut store, &instance).map_err(|e| reason(&e))?; - // `ui-events` is a mod built since `ui`'s; older mods have no export - // and stay callable through `events` alone. - let ui = UiHost::new(&mut store, &instance).ok(); - let mut hooks = exports - .horizon_mods_events() - .call_init(&mut store) - .map_err(|e| reason(&e))??; - hooks.commands.retain(|c| { + let (mut hooks, ui) = if server { + let exports = HorizonServerMod::new(&mut store, &instance).map_err(|e| reason(&e))?; + let r = exports + .horizon_mods_server_events() + .call_init(&mut store) + .map_err(|e| reason(&e))??; + (Hooks::Server(exports, r), None) + } else { + let exports = HorizonMod::new(&mut store, &instance).map_err(|e| reason(&e))?; + // `ui-events` is a mod built since `ui`'s; older mods have no export + // and stay callable through `events` alone. + let ui = UiHost::new(&mut store, &instance).ok(); + let r = exports + .horizon_mods_events() + .call_init(&mut store) + .map_err(|e| reason(&e))??; + (Hooks::Client(exports, r), ui) + }; + let commands = match &mut hooks { + Hooks::Client(_, r) => &mut r.commands, + Hooks::Server(_, r) => &mut r.commands, + }; + commands.retain(|c| { let free = !reserved(c) && !taken.contains(c); if !free { log::warn!("Horizon: mod {} cannot take /{c}: already a command", m.id); @@ -375,9 +500,9 @@ impl Mods { self.out.append(&mut store.data_mut().out); Ok(Some(Running { store, - exports, ui, hooks, + raycasts: functions.iter().any(|f| f == "game.raycast"), })) } @@ -385,6 +510,12 @@ impl Mods { pub fn is_running(&self) -> bool { self.entries.iter().any(|e| e.run.is_some()) } + /// True when a server mod runs: the server skips its mod work otherwise. + pub fn runs_server(&self) -> bool { + self.entries + .iter() + .any(|e| e.run.as_ref().is_some_and(|r| r.hooks.server().is_some())) + } pub fn entries(&self) -> &[Entry] { &self.entries } @@ -397,7 +528,7 @@ impl Mods { fn each( &mut self, fuel: u64, - wants: impl Fn(&Registration) -> bool, + wants: impl Fn(&Hooks) -> bool, mut f: impl FnMut(&mut Running) -> wasmtime::Result<()>, ) { for i in 0..self.entries.len() { @@ -410,6 +541,38 @@ impl Mods { } } } + /// [`Mods::each`] over the client mods. + fn each_client( + &mut self, + fuel: u64, + wants: impl Fn(&Registration) -> bool, + mut f: impl FnMut(&ClientEvents, &mut Store) -> wasmtime::Result<()>, + ) { + self.each( + fuel, + |h| h.client().is_some_and(&wants), + |run| match &run.hooks { + Hooks::Client(m, _) => f(m.horizon_mods_events(), &mut run.store), + Hooks::Server(..) => Ok(()), + }, + ); + } + /// [`Mods::each`] over the server mods. + fn each_server( + &mut self, + fuel: u64, + wants: impl Fn(&ServerRegistration) -> bool, + mut f: impl FnMut(&ServerEvents, &mut Store) -> wasmtime::Result<()>, + ) { + self.each( + fuel, + |h| h.server().is_some_and(&wants), + |run| match &run.hooks { + Hooks::Server(m, _) => f(m.horizon_mods_server_events(), &mut run.store), + Hooks::Client(..) => Ok(()), + }, + ); + } /// One call into mod `i`; a trap or an overrun turns the mod off. fn call( @@ -457,62 +620,39 @@ impl Mods { /// A game tick. pub fn tick(&mut self, tick: u64) { - self.each( - FUEL_TICK, - |h| h.tick, - |run| { - run.exports - .horizon_mods_events() - .call_tick(&mut run.store, tick) - }, - ); + self.each_client(FUEL_TICK, |h| h.tick, |m, s| m.call_tick(s, tick)); } /// A rendered frame, `seconds` after the last. pub fn frame(&mut self, seconds: f32) { - self.each( - FUEL_FRAME, - |h| h.frame, - |run| { - run.exports - .horizon_mods_events() - .call_frame(&mut run.store, seconds) - }, - ); + self.each_client(FUEL_FRAME, |h| h.frame, |m, s| m.call_frame(s, seconds)); } /// A chat line the player received, as plain text. pub fn chat(&mut self, text: &str) { - self.each( - FUEL_EVENT, - |h| h.chat, - |run| { - run.exports - .horizon_mods_events() - .call_chat(&mut run.store, text) - }, - ); + self.each_client(FUEL_EVENT, |h| h.chat, |m, s| m.call_chat(s, text)); } - /// Whether a running mod owns `/name`. + /// Whether a running client mod owns `/name`. pub fn has_command(&self, name: &str) -> bool { - self.command_owner(name).is_some() + self.command_owner(false, name).is_some() } - fn command_owner(&self, name: &str) -> Option { + fn command_owner(&self, server: bool, name: &str) -> Option { self.entries.iter().position(|e| { - e.run - .as_ref() - .is_some_and(|r| r.hooks.commands.iter().any(|c| c == name)) + e.run.as_ref().is_some_and(|r| { + r.hooks.server().is_some() == server && r.hooks.commands().iter().any(|c| c == name) + }) }) } - /// Runs `line` (without its slash) if a mod owns its command; false - /// when none does. + /// Runs `line` (without its slash) if a client mod owns its command; + /// false when none does. pub fn command(&mut self, line: &str) -> bool { let (name, args) = line.split_once(' ').unwrap_or((line, "")); - let Some(i) = self.command_owner(name) else { + let Some(i) = self.command_owner(false, name) else { return false; }; - let result = self.call(i, FUEL_EVENT, |run| { - run.exports + let result = self.call(i, FUEL_EVENT, |run| match &run.hooks { + Hooks::Client(m, _) => m .horizon_mods_events() - .call_command(&mut run.store, name, args) + .call_command(&mut run.store, name, args), + Hooks::Server(..) => Ok(Ok(None)), }); match result { Some(Ok(Some(text))) => self.out.push(Output::Feedback { text, error: false }), @@ -521,14 +661,89 @@ impl Mods { } true } - /// The commands running mods own, for suggestions. + /// The commands running client mods own, for suggestions. pub fn commands(&self) -> impl Iterator { + self.owned_commands(false) + } + fn owned_commands(&self, server: bool) -> impl Iterator { self.entries .iter() .filter_map(|e| e.run.as_ref()) - .flat_map(|r| r.hooks.commands.iter().map(String::as_str)) + .filter(move |r| r.hooks.server().is_some() == server) + .flat_map(|r| r.hooks.commands().iter().map(String::as_str)) } + /// A server tick. + pub fn server_tick(&mut self, tick: u64) { + self.each_server(FUEL_TICK, |h| h.tick, |m, s| m.call_tick(s, tick)); + } + /// `player` joined the server (they are in the snapshot's players). + pub fn player_joined(&mut self, player: &ServerPlayer) { + self.each_server( + FUEL_EVENT, + |h| h.joins, + |m, s| m.call_player_joined(s, player), + ); + } + /// `player` left the server (they are no longer in the snapshot's players). + pub fn player_left(&mut self, player: &ServerPlayer) { + self.each_server( + FUEL_EVENT, + |h| h.joins, + |m, s| m.call_player_left(s, player), + ); + } + /// A chat message `player` sent, as plain text. + pub fn player_chat(&mut self, player: &ServerPlayer, text: &str) { + self.each_server(FUEL_EVENT, |h| h.chat, |m, s| m.call_chat(s, player, text)); + } + /// `player` broke `state` at `pos`. + pub fn block_broken(&mut self, player: &ServerPlayer, pos: BlockPos, state: &str) { + self.each_server( + FUEL_EVENT, + |h| h.blocks, + |m, s| m.call_block_broken(s, player, pos, state), + ); + } + /// `player` placed `state` at `pos`. + pub fn block_placed(&mut self, player: &ServerPlayer, pos: BlockPos, state: &str) { + self.each_server( + FUEL_EVENT, + |h| h.blocks, + |m, s| m.call_block_placed(s, player, pos, state), + ); + } + /// The commands running server mods own, for the server's command tree. + pub fn server_commands(&self) -> impl Iterator { + self.owned_commands(true) + } + /// Runs `line` (without its slash), typed by `player`, if a server mod + /// owns its command; its feedback is an [`Output::Reply`]. False when + /// none does. + pub fn server_command(&mut self, player: &ServerPlayer, line: &str) -> bool { + let (name, args) = line.split_once(' ').unwrap_or((line, "")); + let Some(i) = self.command_owner(true, name) else { + return false; + }; + let result = self.call(i, FUEL_EVENT, |run| match &run.hooks { + Hooks::Server(m, _) => { + m.horizon_mods_server_events() + .call_command(&mut run.store, player, name, args) + } + Hooks::Client(..) => Ok(Ok(None)), + }); + let reply = |text, error| Output::Reply { + player: player.id.clone(), + text, + error, + }; + match result { + Some(Ok(Some(text))) => self.out.push(reply(text, false)), + Some(Err(text)) => self.out.push(reply(text, true)), + Some(Ok(None)) | None => {} + } + true + } /// The running mods' HUD panels. pub fn panels(&self) -> impl Iterator { self.entries @@ -541,12 +756,21 @@ impl Mods { .iter() .filter_map(|e| e.run.as_ref()?.store.data().corner.as_ref()) } + /// Some running mod calls `game.raycast`: the snapshot needs a + /// [`Snapshot::view_hit`]. + pub fn wants_raycast(&self) -> bool { + self.entries + .iter() + .any(|e| e.run.as_ref().is_some_and(|r| r.raycasts)) + } /// Some running mod has a `frame` hook: the game refreshes the snapshot /// every frame for it. pub fn wants_frames(&self) -> bool { - self.entries - .iter() - .any(|e| e.run.as_ref().is_some_and(|r| r.hooks.frame)) + self.entries.iter().any(|e| { + e.run + .as_ref() + .is_some_and(|r| r.hooks.client().is_some_and(|h| h.frame)) + }) } /// Some running mod claimed items (capability `input`). pub fn claims_any(&self) -> bool { @@ -781,7 +1005,7 @@ impl Mods { for i in 0..self.entries.len() { let entry = &self.entries[i]; let now = modified(&entry.path); - let was_on = entry.status != Status::Off; + let was_on = !matches!(entry.status, Status::Off | Status::Elsewhere); if now == entry.modified || !was_on { continue; } @@ -889,21 +1113,57 @@ impl game::Host for State { fn get_clock(&mut self) -> Option { self.snapshot.clock } + fn raycast(&mut self, distance: f32) -> Option { + let (at, hit) = self.snapshot.view_hit.as_ref()?; + // NaN compares false: no hit. + (*at <= distance.min(RAYCAST_MAX) && !distance.is_nan()).then(|| hit.clone()) + } } -impl chat::Host for State { - fn show(&mut self, text: String) { +impl State { + /// Queues a chat line unless the call already sent [`CHAT_PER_CALL`]. + fn say(&mut self, line: impl FnOnce(String) -> Output) -> bool { let shown = self .out .iter() - .filter(|o| matches!(o, Output::Chat { .. })) + .filter(|o| { + matches!( + o, + Output::Chat { .. } | Output::Tell { .. } | Output::Broadcast { .. } + ) + }) .count(); if shown < CHAT_PER_CALL { let name = self.name.clone(); - self.out.push(Output::Chat { - name, - text: clip(text), - }); + self.out.push(line(name)); } + shown < CHAT_PER_CALL + } +} +impl chat::Host for State { + fn show(&mut self, text: String) { + self.say(|name| Output::Chat { + name, + text: clip(text), + }); + } +} +impl players::Host for State { + fn online(&mut self) -> Vec { + self.snapshot.players.clone() + } + fn tell(&mut self, player: String, text: String) -> bool { + self.snapshot.players.iter().any(|p| p.id == player) + && self.say(|name| Output::Tell { + name, + player, + text: clip(text), + }) + } + fn broadcast(&mut self, text: String) { + self.say(|name| Output::Broadcast { + name, + text: clip(text), + }); } } /// A key a mod registered (capability `input`). diff --git a/crates/horizon-mods/src/testing.rs b/crates/horizon-mods/src/testing.rs index d8c8076b4..3a7422377 100644 --- a/crates/horizon-mods/src/testing.rs +++ b/crates/horizon-mods/src/testing.rs @@ -2,10 +2,14 @@ //! //! [`TestGame`] loads one `.hmod` from a scratch copy (its `storage` lives and //! dies with the run) into the same sandbox the game uses, and plays the game's -//! part: the snapshot, ticks, frames, chat lines and commands. [`Script`] is a +//! part: the snapshot, ticks, frames, chat lines and commands, and for a +//! server mod the players joining, leaving, chatting and breaking or placing +//! blocks. [`Script`] is a //! test written in TOML, `tests/.toml` in the mod's folder: steps, each //! saying what happens and what the mod must have shown by then. -use crate::{Clock, Corner, Mods, Output, Panel, Player, Snapshot, Status}; +use crate::{ + BlockPos, Clock, Corner, GameMode, Mods, Output, Panel, Player, ServerPlayer, Snapshot, Status, +}; use serde::Deserialize; use std::{ path::{Path, PathBuf}, @@ -20,6 +24,10 @@ pub struct TestGame { /// What the mod reads with `game-read`; ticks move the clock as the game does. pub player: Option, pub clock: Option, + /// The players on the server, for a server mod, in join order. + pub players: Vec, + /// Every name that joined, for their id. + names: Vec, tick: u64, } @@ -60,6 +68,8 @@ impl TestGame { game_time: 0, day_time: 0, }), + players: Vec::new(), + names: Vec::new(), tick: 0, }; copy_mod(hmod, ©)?; @@ -87,11 +97,16 @@ impl TestGame { self.mods.set_snapshot(Snapshot { player: self.player.clone(), clock: self.clock, + players: self.players.clone(), // The GUI of a 1280 x 720 window at scale 3, as the trial run's. gui_size: (427.0, 240.0), ..Snapshot::default() }); } + /// Whether the mod is a server mod. + pub fn server(&self) -> bool { + self.mods.runs_server() + } /// `n` game ticks; each moves the clock one tick on, as the game does. pub fn tick(&mut self, n: u64) { @@ -103,6 +118,7 @@ impl TestGame { } self.snapshot(); self.mods.tick(self.tick); + self.mods.server_tick(self.tick); } } /// `n` frames, 1/60 s apart. @@ -124,13 +140,76 @@ impl TestGame { self.mods.command(line) } + /// A player named `name` joins the server, standing where a script starts + /// in survival. Their id is `00000000-0000-4000-8000-000000000001` for + /// the first name that joined, `...0002` for the second, and so on. + pub fn join(&mut self, name: &str) -> ServerPlayer { + let n = match self.names.iter().position(|n| n == name) { + Some(i) => i + 1, + None => { + self.names.push(name.to_owned()); + self.names.len() + } + }; + let p = default_player(); + let player = ServerPlayer { + id: format!("00000000-0000-4000-8000-{n:012x}"), + name: name.to_owned(), + x: p.x, + y: p.y, + z: p.z, + dimension: p.dimension, + game_mode: GameMode::Survival, + health: p.health, + }; + self.players.push(player.clone()); + self.snapshot(); + self.mods.player_joined(&player); + player + } + /// The player named `name` leaves; false when no such player is on. + pub fn leave(&mut self, name: &str) -> bool { + let Some(i) = self.players.iter().position(|p| p.name == name) else { + return false; + }; + let player = self.players.remove(i); + self.snapshot(); + self.mods.player_left(&player); + true + } + /// A chat message `player` sends, for a server mod. + pub fn player_chat(&mut self, player: &ServerPlayer, line: &str) { + self.snapshot(); + self.mods.player_chat(player, line); + } + /// `/line` typed by `player`, for a server mod; false when the mod owns + /// no such command. + pub fn player_command(&mut self, player: &ServerPlayer, line: &str) -> bool { + self.snapshot(); + self.mods.server_command(player, line) + } + /// `player` breaks (or places) `state` at `pos`. + pub fn block(&mut self, player: &ServerPlayer, pos: BlockPos, state: &str, placed: bool) { + self.snapshot(); + if placed { + self.mods.block_placed(player, pos, state); + } else { + self.mods.block_broken(player, pos, state); + } + } + /// The scratch copy the mod runs from; its `storage` is beside it. pub fn hmod(&self) -> &Path { &self.hmod } /// The commands the mod registered. pub fn commands(&self) -> Vec { - self.mods.commands().map(str::to_owned).collect() + let server = self.mods.server_commands(); + self.mods + .commands() + .chain(server) + .map(str::to_owned) + .collect() } pub fn panel(&self) -> Option<&Panel> { self.mods.panels().next() @@ -166,7 +245,7 @@ fn copy_mod(from: &Path, to: &Path) -> Result<(), String> { Ok(()) } -/// A test in TOML: where the player starts, then steps run in order. +/// A test in TOML: where a client mod's player starts, then steps run in order. #[derive(Debug, Default, Deserialize)] #[serde(deny_unknown_fields, rename_all = "kebab-case")] pub struct Script { @@ -178,9 +257,11 @@ pub struct Script { pub steps: Vec, } -/// Fields of the player to change; the others keep their values. +/// Fields of the player to change; the others keep their values. A server +/// mod's players have no `yaw`, `pitch` or `food`, and a client mod's player +/// no `game-mode`. #[derive(Debug, Default, Deserialize)] -#[serde(deny_unknown_fields)] +#[serde(deny_unknown_fields, rename_all = "kebab-case")] pub struct PlayerSet { x: Option, y: Option, @@ -190,6 +271,37 @@ pub struct PlayerSet { health: Option, food: Option, dimension: Option, + game_mode: Option, +} + +/// `players.game-mode` as a script spells it. +#[derive(Clone, Copy, Debug, Deserialize)] +#[serde(rename_all = "lowercase")] +enum Mode { + Survival, + Creative, + Adventure, + Spectator, +} +impl From for GameMode { + fn from(m: Mode) -> GameMode { + match m { + Mode::Survival => GameMode::Survival, + Mode::Creative => GameMode::Creative, + Mode::Adventure => GameMode::Adventure, + Mode::Spectator => GameMode::Spectator, + } + } +} + +/// A block a player breaks or places. +#[derive(Debug, Deserialize)] +#[serde(deny_unknown_fields)] +pub struct BlockSet { + x: i32, + y: i32, + z: i32, + state: String, } #[derive(Debug, Default, Deserialize)] @@ -200,8 +312,11 @@ pub struct ClockSet { } /// One step. Its parts happen in this order: `reload`, `title-screen`, -/// `player`, `clock`, `ticks`, `frames`, `chat`, `command`; then `expect` is -/// checked against what the mod showed during the step. +/// `join`, `player`, `clock`, `ticks`, `frames`, `chat`, `command`, `break`, +/// `place`, `leave`; then `expect` is checked against what the mod showed +/// during the step. For a server mod, `player`, `chat`, `command`, `break` +/// and `place` are the doing of the player named by `as`, or of the first +/// player on. #[derive(Debug, Default, Deserialize)] #[serde(deny_unknown_fields, rename_all = "kebab-case")] pub struct Step { @@ -218,6 +333,14 @@ pub struct Step { frames: u64, chat: Option, command: Option, + /// Server mods: a player joins, leaves, breaks or places a block. + join: Option, + leave: Option, + #[serde(rename = "as")] + actor: Option, + #[serde(rename = "break")] + broken: Option, + place: Option, #[serde(default)] expect: Expect, } @@ -233,6 +356,10 @@ pub struct Expect { /// The command's feedback, and its red error. feedback: Option, error: Option, + /// Server mods: every `players.tell` as `"Name: text"`, and every + /// `players.broadcast`, in order. + told: Option>, + broadcast: Option>, /// The panel's lines (`[]`: no panel) and its corner. panel: Option>, corner: Option, @@ -276,6 +403,17 @@ impl PlayerSet { p.dimension.clone_from(d); } } + fn apply_server(&self, p: &mut ServerPlayer) { + let set = |to: &mut f64, v: Option| *to = v.unwrap_or(*to); + set(&mut p.x, self.x); + set(&mut p.y, self.y); + set(&mut p.z, self.z); + p.health = self.health.unwrap_or(p.health); + p.game_mode = self.game_mode.map_or(p.game_mode, GameMode::from); + if let Some(d) = &self.dimension { + p.dimension.clone_from(d); + } + } } impl ClockSet { @@ -304,6 +442,17 @@ impl Step { if let Some(line) = &self.command { parts.push(format!("/{line}")); } + if let Some(name) = &self.join { + parts.insert(0, format!("{name} joins")); + } + for (what, b) in [("breaks", &self.broken), ("places", &self.place)] { + if let Some(b) = b { + parts.push(format!("{what} {} at {} {} {}", b.state, b.x, b.y, b.z)); + } + } + if let Some(name) = &self.leave { + parts.push(format!("{name} leaves")); + } if parts.is_empty() { parts.push("checks".into()); } @@ -318,8 +467,35 @@ impl Step { game.player = None; game.clock = None; } + if let Some(name) = &self.join { + game.join(name); + } + let server = game.server(); + let actor = |game: &TestGame| match &self.actor { + Some(name) => game + .players + .iter() + .position(|p| p.name == *name) + .ok_or_else(|| format!("{name} is not on the server")), + None => (!game.players.is_empty()) + .then_some(0) + .ok_or_else(|| "no player is on the server: add join = \"Name\"".to_string()), + }; + let acts = self.player.is_some() + || self.chat.is_some() + || self.command.is_some() + || self.broken.is_some() + || self.place.is_some(); + let actor = if server && acts { + Some(actor(game)?) + } else { + None + }; if let Some(set) = &self.player { - set.apply(game.player.get_or_insert_with(default_player)); + match actor { + Some(i) => set.apply_server(&mut game.players[i]), + None => set.apply(game.player.get_or_insert_with(default_player)), + } } if let Some(set) = &self.clock { set.apply(game.clock.get_or_insert(Clock { @@ -329,10 +505,32 @@ impl Step { } game.tick(self.ticks); game.frames(self.frames); + let who = actor.map(|i| game.players[i].clone()); if let Some(line) = &self.chat { - game.chat(line); + match &who { + Some(p) => game.player_chat(p, line), + None => game.chat(line), + } + } + let owned = self.command.as_ref().map(|line| match &who { + Some(p) => game.player_command(p, line), + None => game.command(line), + }); + for (b, placed) in [(&self.broken, false), (&self.place, true)] { + if let (Some(b), Some(p)) = (b, &who) { + let pos = BlockPos { + x: b.x, + y: b.y, + z: b.z, + }; + game.block(p, pos, &b.state, placed); + } + } + if let Some(name) = &self.leave + && !game.leave(name) + { + return Err(format!("{name} is not on the server")); } - let owned = self.command.as_ref().map(|line| game.command(line)); let out = game.drain(); let stopped = out.iter().find_map(|o| match o { Output::Stopped { reason, .. } => Some(reason.as_str()), @@ -372,10 +570,38 @@ impl Step { } let feedback = |error: bool| { out.iter().rev().find_map(|o| match o { - Output::Feedback { text, error: e } if *e == error => Some(text.clone()), + Output::Feedback { text, error: e } | Output::Reply { text, error: e, .. } + if *e == error => + { + Some(text.clone()) + } _ => None, }) }; + if let Some(want) = &e.told { + let name = |id: &str| { + let p = game.players.iter().find(|p| p.id == id); + p.map_or(id.to_owned(), |p| p.name.clone()) + }; + let got: Vec = out + .iter() + .filter_map(|o| match o { + Output::Tell { player, text, .. } => Some(format!("{}: {text}", name(player))), + _ => None, + }) + .collect(); + same("told", want, &got)?; + } + if let Some(want) = &e.broadcast { + let got: Vec = out + .iter() + .filter_map(|o| match o { + Output::Broadcast { text, .. } => Some(text.clone()), + _ => None, + }) + .collect(); + same("broadcast", want, &got)?; + } if let Some(want) = &e.feedback { same("feedback", &Some(want.clone()), &feedback(false))?; } diff --git a/crates/horizon-mods/tests/api_reference.rs b/crates/horizon-mods/tests/api_reference.rs index b3d2363a9..6e9a92c85 100644 --- a/crates/horizon-mods/tests/api_reference.rs +++ b/crates/horizon-mods/tests/api_reference.rs @@ -302,3 +302,38 @@ fn every_capability_with_an_interface_is_in_the_contract() { } } } + +/// Every function the game offers (an interface some world imports and none +/// exports) has an API level, and the levels list nothing else. +#[test] +fn every_function_has_an_api_level() { + let mut resolve = Resolve::default(); + let package = resolve.push_file(root().join(WIT)).unwrap(); + let package = &resolve.packages[package]; + let exported: Vec<_> = package + .worlds + .values() + .flat_map(|&w| resolve.worlds[w].exports.values()) + .filter_map(|item| match item { + WorldItem::Interface { id, .. } => Some(*id), + _ => None, + }) + .collect(); + let mut offered = Vec::new(); + for (name, &id) in &package.interfaces { + if !exported.contains(&id) { + for function in resolve.interfaces[id].functions.keys() { + offered.push(format!("{name}.{function}")); + } + } + } + for f in &offered { + assert!( + horizon_mods::api_level::level_of(f).is_some(), + "{f} has no level in crates/horizon-mods/src/api_level.rs: add it at the next level" + ); + } + for (f, _) in horizon_mods::api_level::FUNCTIONS { + assert!(offered.iter().any(|o| o == f), "{f} isn't in the WIT"); + } +} diff --git a/crates/horizon-mods/tests/index/glow-1.0.0.hshader b/crates/horizon-mods/tests/index/glow-1.0.0.hshader new file mode 100644 index 000000000..dda1651f8 Binary files /dev/null and b/crates/horizon-mods/tests/index/glow-1.0.0.hshader differ diff --git a/crates/horizon-mods/tests/index/index-v1.json b/crates/horizon-mods/tests/index/index-v1.json index 215c94667..4f92c7c1d 100644 --- a/crates/horizon-mods/tests/index/index-v1.json +++ b/crates/horizon-mods/tests/index/index-v1.json @@ -29,6 +29,7 @@ "hud", "chat" ], + "api_level": 0, "game": "26.3", "file": { "name": "coords_hud-0.1.0.hmod", @@ -75,6 +76,34 @@ } ] }, + { + "id": "glow", + "kind": "shader", + "name": "Soft Glow", + "summary": "A post-processing pass over the world.", + "authors": [ + "Horizon" + ], + "owners": [ + "ludovic111" + ], + "license": "MIT", + "source": "https://github.com/ludovic111/horizon-mods", + "versions": [ + { + "version": "1.0.0", + "published": "2026-10-26", + "api": "0.1", + "game": "26.3", + "file": { + "name": "glow-1.0.0.hshader", + "url": "https://github.com/ludovic111/horizon-mods/releases/download/glow-1.0.0/glow-1.0.0.hshader", + "size": 689, + "sha256": "331cfe29a666a0de804e9a9ff3d19d246eebcfbfa70b4f49bba8482d30ad9f02" + } + } + ] + }, { "id": "skyblock_start", "kind": "world", diff --git a/crates/horizon-mods/tests/sandbox.rs b/crates/horizon-mods/tests/sandbox.rs index 0be4fa47d..5b673583d 100644 --- a/crates/horizon-mods/tests/sandbox.rs +++ b/crates/horizon-mods/tests/sandbox.rs @@ -2,7 +2,8 @@ //! examples and a guest //! that misbehaves on command. Needs `rustup target add wasm32-unknown-unknown`. use horizon_mods::{ - Clock, Corner, HeldItem, Mods, Output, Package, Player, Shape, Snapshot, Status, + BlockPos, Clock, Corner, GameMode, HeldItem, Hit, Mods, Output, Package, Player, Runs, + ServerPlayer, Shape, Snapshot, Status, manifest::componentize, testing::{Script, TestGame}, }; @@ -25,7 +26,7 @@ id = "test_ui_guest" name = "Test UI Guest" version = "0.1.0" api = "0.1" -capabilities = ["chat", "ui", "render", "input"] +capabilities = ["game-read", "chat", "ui", "render", "input"] experimental = ["ui", "render", "input"] "#; @@ -44,6 +45,8 @@ fn mods_dir() -> &'static Path { "-p", "predator-missile", "-p", + "welcome", + "-p", "horizon-mods-test-guest", "-p", "horizon-mods-test-ui-guest", @@ -66,6 +69,7 @@ fn mods_dir() -> &'static Path { let mods = [ ("coords_hud", example("coords-hud")), ("predator_missile", example("predator-missile")), + ("welcome", example("welcome")), ("horizon_mods_test_guest", GUEST_MANIFEST.to_string()), ("horizon_mods_test_ui_guest", UI_MANIFEST.to_string()), ]; @@ -193,6 +197,65 @@ fn undeclared_capabilities_are_refused() { assert_eq!(mods.entries()[0].status, refused); } +/// A mod calling a function this Horizon doesn't have is refused with +/// "update Horizon", not a linking error; the test mods' levels are read +/// from the functions they import. +#[test] +fn a_mod_for_a_newer_horizon_is_refused() { + use horizon_mods::api_level::{LEVEL, imports, needed}; + use wit_parser::{ManglingAndAbi, Resolve}; + let root = Path::new(env!("CARGO_MANIFEST_DIR")).join("../.."); + let wit = std::fs::read_to_string(root.join("crates/horizon-mod-sdk/wit/horizon.wit")) + .unwrap() + .replace( + " set-minimap: func(minimap: option);", + " set-minimap: func(minimap: option);\n set-sky: func(on: bool);", + ); + let mut resolve = Resolve::default(); + let package = resolve.push_str("horizon.wit", &wit).unwrap(); + let world = resolve + .select_world(&[package], Some("horizon-ui-mod")) + .unwrap(); + let mut module = wit_component::dummy_module(&resolve, world, ManglingAndAbi::Standard32); + wit_component::embed_component_metadata( + &mut module, + &resolve, + world, + wit_component::StringEncoding::UTF8, + ) + .unwrap(); + let wasm = wit_component::ComponentEncoder::default() + .module(&module) + .unwrap() + .encode() + .unwrap(); + let functions = imports(&wasm).unwrap(); + assert!(functions.iter().any(|f| f == "render.set-sky")); + let dir = mods_dir().join("too_new"); + std::fs::create_dir_all(&dir).unwrap(); + let manifest = r#" +id = "too_new" +name = "Too New" +version = "0.1.0" +api = "0.1" +capabilities = ["game-read", "chat", "hud", "storage", "command", "ui", "render", "input"] +experimental = ["ui", "render", "input"] +"#; + std::fs::write(dir.join("horizon-mod.toml"), manifest).unwrap(); + std::fs::write(dir.join("mod.wasm"), wasm).unwrap(); + let mods = Mods::load(&[dir], |_| true, |_| false); + let refused = "made for a newer Horizon (it uses render.set-sky): update Horizon to run it"; + assert_eq!(mods.entries()[0].status, Status::Failed(refused.into())); + + let level = |file: &str| { + let wasm = Package::read(&mods_dir().join(file)).unwrap().wasm.unwrap(); + needed(imports(&wasm).unwrap().iter().map(String::as_str)).0 + }; + assert_eq!(level("coords_hud.hmod"), 0); + // The UI guest shows a minimap (`render.set-minimap`). + assert_eq!(level("horizon_mods_test_ui_guest.hmod"), LEVEL); +} + #[test] fn vanilla_commands_win() { let mods = Mods::load( @@ -659,6 +722,47 @@ fn render_minimap_is_clamped_and_hidden() { assert_eq!(map(&mut mods, "off"), None); } +/// `game.raycast`: the view's hit the game worked out, up to the distance +/// asked for; the game works it out only while a mod imports the call. +#[test] +fn game_raycast_sees_the_view_hit_within_its_distance() { + let mut mods = load("horizon_mods_test_ui_guest.hmod"); + assert!(mods.wants_raycast()); + assert!(!load("coords_hud.hmod").wants_raycast()); + let said = |mods: &mut Mods, args: &str| -> Vec { + assert!(mods.command(&format!("raycast {args}"))); + mods.drain() + .into_iter() + .filter_map(|o| match o { + Output::Chat { text, .. } => Some(text), + _ => None, + }) + .collect() + }; + assert_eq!(said(&mut mods, "100"), ["no hit"]); + mods.set_snapshot(Snapshot { + view_hit: Some(( + 40.5, + Hit { + block_x: 12, + block_y: 63, + block_z: -44, + x: 12.5, + y: 64.0, + z: -43.75, + block: "minecraft:grass_block".into(), + }, + )), + ..player() + }); + let hit = "hit minecraft:grass_block at 12 63 -44 (12.5 64.0 -43.8)"; + assert_eq!(said(&mut mods, "100"), [hit]); + assert_eq!(said(&mut mods, "40"), ["no hit"]); + // NaN asks for nothing; past 1024 is 1024. + assert_eq!(said(&mut mods, "x"), ["no hit"]); + assert_eq!(said(&mut mods, "1e9"), [hit]); +} + #[test] fn corner_panels_text_width_and_readings() { let mut mods = load("horizon_mods_test_ui_guest.hmod"); @@ -731,22 +835,23 @@ capabilities = ["registries"] assert!(!mods.is_running()); } -/// `cargo horizon-mod test` on the example: its own `tests/*.toml` pass. +/// `cargo horizon-mod test` on the examples: their own `tests/*.toml` pass. #[test] fn the_examples_test_scripts_pass() { - let tests = - Path::new(env!("CARGO_MANIFEST_DIR")).join("../horizon-mod-sdk/examples/coords-hud/tests"); + let examples = Path::new(env!("CARGO_MANIFEST_DIR")).join("../horizon-mod-sdk/examples"); let mut ran = 0; - for entry in std::fs::read_dir(tests).unwrap() { - let path = entry.unwrap().path(); - let script = Script::parse(&std::fs::read_to_string(&path).unwrap()).unwrap(); - let mut game = TestGame::load(&mods_dir().join("coords_hud.hmod")).unwrap(); - script - .run(&mut game) - .unwrap_or_else(|e| panic!("{}: {e}", path.display())); - ran += 1; + for (example, hmod) in [("coords-hud", "coords_hud"), ("welcome", "welcome")] { + for entry in std::fs::read_dir(examples.join(example).join("tests")).unwrap() { + let path = entry.unwrap().path(); + let script = Script::parse(&std::fs::read_to_string(&path).unwrap()).unwrap(); + let mut game = TestGame::load(&mods_dir().join(format!("{hmod}.hmod"))).unwrap(); + script + .run(&mut game) + .unwrap_or_else(|e| panic!("{}: {e}", path.display())); + ran += 1; + } } - assert_eq!(ran, 2); + assert_eq!(ran, 4); } #[test] @@ -770,6 +875,13 @@ fn a_test_script_says_which_step_failed_and_why() { Script::parse("[[step]]\ntick = 1").is_err(), "a typo is an error" ); + + let mut game = TestGame::load(&mods_dir().join("welcome.hmod")).unwrap(); + let script = "[[step]]\njoin = \"Alex\"\n\n[[step]]\nas = \"Steve\"\ncommand = \"mined\""; + assert_eq!( + Script::parse(script).unwrap().run(&mut game).unwrap_err(), + "step 2 (/mined): Steve is not on the server" + ); } #[test] @@ -807,3 +919,74 @@ fn a_test_script_reloads_and_expects_a_stop() { "the scratch copy and its storage are removed" ); } + +fn alex() -> ServerPlayer { + ServerPlayer { + id: "00000000-0000-4000-8000-000000000001".into(), + name: "Alex".into(), + x: 0.5, + y: 64.0, + z: 0.5, + dimension: "minecraft:the_nether".into(), + game_mode: GameMode::Survival, + health: 20.0, + } +} + +#[test] +fn a_server_mod_runs_only_where_the_world_does() { + // A fresh folder: what the mod stored in an earlier run is beside it. + let dir = mods_dir().join("server"); + let _ = std::fs::remove_dir_all(&dir); + std::fs::create_dir_all(&dir).unwrap(); + let path = dir.join("welcome.hmod"); + std::fs::copy(mods_dir().join("welcome.hmod"), &path).unwrap(); + let paths = std::slice::from_ref(&path); + let window = Mods::load_for(Runs::Client, paths, |_| true, |_| false); + assert_eq!(window.entries()[0].status, Status::Elsewhere); + assert!(!window.is_running()); + + let mut mods = Mods::load_for(Runs::Server, paths, |_| true, |c| c == "give"); + assert!(mods.runs_server()); + assert_eq!( + mods.server_commands().collect::>(), + ["online", "mined"] + ); + assert_eq!(mods.commands().count(), 0, "not the window's chat commands"); + let alex = alex(); + mods.set_snapshot(Snapshot { + players: vec![alex.clone()], + ..Snapshot::default() + }); + mods.player_joined(&alex); + let greeted = [ + Output::Tell { + name: "Welcome".into(), + player: alex.id.clone(), + text: "Welcome, Alex! 0 other player(s) online.".into(), + }, + Output::Broadcast { + name: "Welcome".into(), + text: "Alex is here for the first time".into(), + }, + ]; + assert_eq!(mods.drain(), greeted); + let stone = BlockPos { x: 1, y: 63, z: 0 }; + mods.block_broken(&alex, stone, "minecraft:stone"); + assert!(mods.server_command(&alex, "mined")); + assert!(mods.server_command(&alex, "online")); + let reply = |text: &str| Output::Reply { + player: alex.id.clone(), + text: text.into(), + error: false, + }; + assert_eq!( + mods.drain(), + [reply("You broke 1 block(s)"), reply("Alex (the_nether)")] + ); + assert!(!mods.server_command(&alex, "where")); + assert!( + !mods.command("online"), + "a server command isn't the window's" + ); +} diff --git a/crates/horizon-mods/tests/ui_guest/src/lib.rs b/crates/horizon-mods/tests/ui_guest/src/lib.rs index 3d4c66076..32e811fc7 100644 --- a/crates/horizon-mods/tests/ui_guest/src/lib.rs +++ b/crates/horizon-mods/tests/ui_guest/src/lib.rs @@ -4,9 +4,10 @@ //! `/render_hud`, `/render_clear` and `/render_shake` test `render`; //! `/input_claim`, `/input_poll`, `/input_held` and `/input_wheel` test //! `input`; `/zoom FACTOR SMOOTH TURN` tests `render.set-zoom`; -//! `/corner` and `/readings` the calls the official extras mods use. +//! `/corner` and `/readings` the calls the official extras mods use; +//! `/raycast DISTANCE` says what `game.raycast` sees. use horizon_mod_sdk::{ - Mod, Registration, chat, + Mod, Registration, chat, game, input::{self, Event}, render::{self, FillShape, ItemShape, Point, QuadShape, Rect, Shape, SpriteShape, TextShape}, ui::{self, ItemWidget, ListWidget, Screen, TextWidget, Widget}, @@ -97,6 +98,7 @@ impl Mod for Guest { "input_wheel", "zoom", "minimap", + "raycast", "corner", "readings", ] @@ -217,6 +219,16 @@ impl Mod for Guest { }); render::set_minimap(map); } + "raycast" => { + let distance = args.parse().unwrap_or(f32::NAN); + chat::show(&match game::raycast(distance) { + Some(h) => format!( + "hit {} at {} {} {} ({:.1} {:.1} {:.1})", + h.block, h.block_x, h.block_y, h.block_z, h.x, h.y, h.z + ), + None => "no hit".into(), + }); + } // Clamped to (1, 10); the two after it shake nothing. "render_shake" => { render::shake(2.0, 99.0); diff --git a/crates/horizon-port-pack/src/carry.rs b/crates/horizon-port-pack/src/carry.rs index 82dbf11af..a87f92ede 100644 --- a/crates/horizon-port-pack/src/carry.rs +++ b/crates/horizon-port-pack/src/carry.rs @@ -828,9 +828,9 @@ pub fn carry( // Additions to other sets and pools, as files the game merges. let modifier = serde_json::from_slice::(&bytes).ok(); let types = &mut report.worldgen_types; - if let Some((kind, mut added)) = modifier.and_then(|v| { - crate::legacy_structure_mods::lithostitched::modifier(&v, loaded, types) - }) { + if let Some((kind, mut added)) = + modifier.and_then(|v| crate::lithostitched::modifier(&v, loaded, types)) + { crate::processors::carry( kind, &mut added, diff --git a/crates/horizon-port-pack/src/fetch.rs b/crates/horizon-port-pack/src/fetch.rs index f2803baa2..82c1ea794 100644 --- a/crates/horizon-port-pack/src/fetch.rs +++ b/crates/horizon-port-pack/src/fetch.rs @@ -143,7 +143,9 @@ pub fn fetch( if let Some((dest, url)) = crate::worldgen::loader_jar(work, &pack.loader, &pack.loader_version) .filter(|(dest, _)| !dest.exists()) { - let sha1 = ureq::get(&format!("{url}.sha1")) + let checksum = format!("{url}.sha1"); + let sha1 = crate::net::agent(&checksum) + .get(&checksum) .set("User-Agent", modrinth::AGENT) .call() .ok() @@ -201,7 +203,8 @@ pub fn url_of(file: &PackFile, cache: &Cache) -> Option { /// Downloads `url` to `dest`, kept only if its SHA-1 is `sha1`. fn download(url: &str, sha1: Option<&str>, dest: &Path) -> Result<(), String> { - let response = ureq::get(url) + let response = crate::net::agent(url) + .get(url) .set("User-Agent", modrinth::AGENT) .call() .map_err(|e| format!("{url}: {e}"))?; diff --git a/crates/horizon-port-pack/src/legacy_structure_mods/ctov.rs b/crates/horizon-port-pack/src/legacy_structure_mods/ctov.rs index af46174ae..62c25739f 100644 --- a/crates/horizon-port-pack/src/legacy_structure_mods/ctov.rs +++ b/crates/horizon-port-pack/src/legacy_structure_mods/ctov.rs @@ -157,6 +157,7 @@ mod tests { } #[test] + #[ignore = "modular compat is crate::lithostitched's now (its tests)"] fn modular_compat_runs_its_list_only_with_its_mod() { let mut data = ProcessorData::default(); let swap = json!({"processor_type": "minecraft:rule", "rules": []}); diff --git a/crates/horizon-port-pack/src/legacy_structure_mods/lithostitched.rs b/crates/horizon-port-pack/src/legacy_structure_mods/lithostitched.rs deleted file mode 100644 index 54415a76a..000000000 --- a/crates/horizon-port-pack/src/legacy_structure_mods/lithostitched.rs +++ /dev/null @@ -1,503 +0,0 @@ -//! Lithostitched: its jigsaw structure, its worldgen modifiers and its -//! processors. -use super::ctov; -use crate::processors::{ProcessorData, carry_all, processors, referenced}; -use crate::worldgen::{ENHANCED_TERRAIN, Upgrade, start_checks}; -use serde_json::{Value, json}; -use std::collections::BTreeMap; - -/// A `structure` file of Lithostitched's jigsaw type as vanilla's, with the -/// start rules it shares with the other libraries' jigsaws (`worldgen`'s -/// `start_checks`). `None` for any other file. -pub(crate) fn upgrade( - kind: &str, - v: &mut Value, - lost: &mut BTreeMap, -) -> Option { - if kind != "structure" || v["type"] != "lithostitched:jigsaw" { - return None; - } - start_checks(v, "lowest", lost, false); - if v.as_object_mut() - .and_then(|o| o.remove(ENHANCED_TERRAIN)) - .is_some() - { - *lost.entry(ENHANCED_TERRAIN.into()).or_default() += 1; - } - v["type"] = "minecraft:jigsaw".into(); - Some(true) -} - -/// A lithostitched worldgen modifier -/// (`data//lithostitched/worldgen_modifier/`) that adds to structure -/// sets or template pools, as a file the game merges into them (the key -/// `horizon:add_to`, `horizon_client::mod_content`): (kind, file). The -/// modifier's conditions are checked against `loaded`, the mods ported -/// along: a compat addition for a mod that is not would place that mod's -/// blocks, which the game does not have. Other modifier types are left out. -/// Both are counted in `report`. -pub(crate) fn modifier( - v: &Value, - loaded: &dyn Fn(&str) -> bool, - report: &mut Upgrade, -) -> Option<(&'static str, Value)> { - let t = v["type"].as_str().unwrap_or_default(); - let mut left = |why: &str| *report.modifiers_left.entry(why.to_owned()).or_default() += 1; - let (kind, targets, from, to) = match t { - "lithostitched:add_structure_set_entries" => { - ("structure_set", "structure_sets", "entries", "structures") - } - "lithostitched:add_template_pool_elements" => { - ("template_pool", "template_pools", "elements", "elements") - } - _ => { - left(t); - return None; - } - }; - if !conditions_hold(v, loaded) { - left("conditions"); - return None; - } - let targets: Option> = match &v[targets] { - Value::String(s) => Some(vec![s.as_str()]), - Value::Array(a) => a.iter().map(Value::as_str).collect(), - _ => None, - }; - let Some(targets) = targets.filter(|t| !t.is_empty() && t.iter().all(|t| !t.starts_with('#'))) - else { - left("target"); - return None; - }; - let entries = v[from].as_array().cloned().unwrap_or_default(); - for target in &targets { - *report.added_to.entry((*target).to_owned()).or_default() += entries.len(); - } - Some(( - kind, - serde_json::json!({"horizon:add_to": targets, to: entries}), - )) -} - -/// Whether a modifier's load conditions hold: lithostitched's `predicate`, -/// and the loader's conditions (NeoForge's, else Fabric's). A condition -/// type not known here does not hold. -fn conditions_hold(v: &Value, loaded: &dyn Fn(&str) -> bool) -> bool { - let all = |list: &Value, test: &dyn Fn(&Value) -> bool| { - list.as_array().is_some_and(|a| a.iter().all(test)) - }; - fn predicate(p: &Value, loaded: &dyn Fn(&str) -> bool) -> bool { - let test = |q: &Value| predicate(q, loaded); - let list = &p["predicates"]; - match p["type"] - .as_str() - .map(|t| t.trim_start_matches("lithostitched:")) - { - Some("true") => true, - Some("mod_loaded") => p["mod_id"].as_str().is_some_and(loaded), - Some("not") => !predicate(&p["predicate"], loaded), - Some("all_of") => list.as_array().is_some_and(|a| a.iter().all(test)), - Some("any_of") => list.as_array().is_some_and(|a| a.iter().any(test)), - _ => false, - } - } - fn neoforge(c: &Value, loaded: &dyn Fn(&str) -> bool) -> bool { - let test = |q: &Value| neoforge(q, loaded); - match c["type"].as_str() { - Some("neoforge:true") => true, - Some("neoforge:mod_loaded") => c["modid"].as_str().is_some_and(loaded), - Some("neoforge:not") => !neoforge(&c["value"], loaded), - Some("neoforge:and") => c["values"].as_array().is_some_and(|a| a.iter().all(test)), - Some("neoforge:or") => c["values"].as_array().is_some_and(|a| a.iter().any(test)), - _ => false, - } - } - fn fabric(c: &Value, loaded: &dyn Fn(&str) -> bool) -> bool { - let test = |q: &Value| fabric(q, loaded); - let mods = || { - c["values"] - .as_array() - .into_iter() - .flatten() - .map(Value::as_str) - }; - match c["condition"].as_str() { - Some("fabric:true") => true, - Some("fabric:all_mods_loaded") => mods().all(|m| m.is_some_and(loaded)), - Some("fabric:any_mods_loaded") => mods().any(|m| m.is_some_and(loaded)), - Some("fabric:not") => !fabric(&c["value"], loaded), - Some("fabric:and") => c["values"].as_array().is_some_and(|a| a.iter().all(test)), - Some("fabric:or") => c["values"].as_array().is_some_and(|a| a.iter().any(test)), - _ => false, - } - } - let litho = v.get("predicate").is_none_or(|p| predicate(p, loaded)); - let loader = match ( - v.get("neoforge:conditions"), - v.get("fabric:load_conditions"), - ) { - (Some(c), _) => all(c, &|c| neoforge(c, loaded)), - // One condition or a list of them. - (None, Some(c)) if c.is_array() => all(c, &|c| fabric(c, loaded)), - (None, Some(c)) => fabric(c, loaded), - (None, None) => true, - }; - litho && loader -} - -/// The data form of one of Lithostitched's processors: the processors to put -/// in its place, or `None` when it has none (or is not Lithostitched's). -pub(crate) fn processor( - kind: &str, - p: &Value, - data: &ProcessorData, - carried: &mut BTreeMap, -) -> Option> { - match kind { - "lithostitched:apply_random" => apply_random(p, data, carried).map(|p| vec![p]), - "lithostitched:condition" => condition(p, data, carried).map(|p| vec![p]), - "lithostitched:block_swap" => { - // The same map; the game's swap keeps the properties both have. - p["blocks"].as_object()?; - Some(vec![ - json!({"processor_type": "horizon:block_swap", "blocks": p["blocks"]}), - ]) - } - "lithostitched:set_block" => { - // A simple or weighted state provider, the block entity left as - // it is. - let provider = p["state_provider"]["type"].as_str()?; - let modifier = p["block_entity_modifier"]["type"].as_str(); - let plain = - modifier.is_none_or(|m| m.trim_start_matches("minecraft:") == "passthrough"); - if !plain - || !matches!( - provider, - "minecraft:simple_state_provider" | "minecraft:weighted_state_provider" - ) - { - return None; - } - let mut out = p.clone(); - out["processor_type"] = "horizon:set_block".into(); - if let Some(o) = out.as_object_mut() { - o.remove("block_entity_modifier"); - } - Some(vec![out]) - } - _ => None, - } -} - -/// The references (Lithostitched's, and CTOV's compat processors) in a -/// processor list written in; whether any was. -pub(crate) fn expand_references( - list: Vec, - data: &ProcessorData, - carried: &mut BTreeMap, -) -> (Vec, bool) { - references(list, data, carried, 0) -} - -/// A processor list inside a carried processor: an id stays (the game reads -/// that file, carried on its own); an inline one is carried here. -fn nested(list: &Value, data: &ProcessorData, carried: &mut BTreeMap) -> Value { - let mut list = list.clone(); - if let Some(ps) = processors(&mut list) { - *ps = carry_all(std::mem::take(ps), data, carried).0; - } - list -} - -/// Lithostitched's `apply_random` as `horizon:apply_random`: its weighted -/// lists, or its set of lists at weight 1. A tag is not carried. -fn apply_random( - p: &Value, - data: &ProcessorData, - carried: &mut BTreeMap, -) -> Option { - let lists = &p["processor_lists"]; - let weighted = lists.as_array().is_some_and(|a| { - a.iter() - .all(|e| e.get("weight").is_some() && e.get("data").is_some()) - }); - let entries: Vec<(Value, Value)> = if weighted { - lists - .as_array()? - .iter() - .map(|e| (e["weight"].clone(), e["data"].clone())) - .collect() - } else { - match lists { - Value::String(id) if !id.starts_with('#') => vec![(1.into(), lists.clone())], - Value::Array(a) if a.iter().any(|x| x.get("processor_type").is_some()) => { - vec![(1.into(), lists.clone())] - } - Value::Array(a) - if a.iter() - .all(|x| x.as_str().is_some_and(|s| !s.starts_with('#')) || x.is_object()) => - { - a.iter().map(|x| (1.into(), x.clone())).collect() - } - Value::Object(_) => vec![(1.into(), lists.clone())], - _ => return None, - } - }; - let lists: Vec = entries - .into_iter() - .map(|(weight, list)| json!({"weight": weight, "data": nested(&list, data, carried)})) - .collect(); - let mut out = json!({"processor_type": "horizon:apply_random", "processor_lists": lists}); - if let Some(mode) = p.get("mode") { - out["mode"] = mode.clone(); - } - Some(out) -} - -/// Lithostitched's `condition` as `horizon:condition`, when the game runs -/// every condition in it (true, all_of, any_of, not, random_chance, -/// matching_blocks with plain property values); else it stays Java. -fn condition( - p: &Value, - data: &ProcessorData, - carried: &mut BTreeMap, -) -> Option { - fn runs(c: &Value) -> bool { - if let Some(all) = c.as_array() { - return all.iter().all(runs); - } - let kind = c["type"].as_str().unwrap_or_default(); - match kind.strip_prefix("lithostitched:").unwrap_or(kind) { - "true" | "random_chance" => true, - "all_of" | "any_of" => c["conditions"] - .as_array() - .is_some_and(|a| a.iter().all(runs)), - "not" => runs(&c["condition"]), - "matching_blocks" => c.get("properties").is_none_or(|p| { - p.as_object() - .is_some_and(|o| o.values().all(Value::is_string)) - }), - _ => false, - } - } - if !runs(&p["if_true"]) { - return None; - } - // One processor or a list of them. - let mut branch = |key: &str| -> Value { - let list = match p.get(key) { - None => Vec::new(), - Some(Value::Array(a)) => a.clone(), - Some(one) => vec![one.clone()], - }; - carry_all(list, data, carried).0.into() - }; - let (then, otherwise) = (branch("then"), branch("else")); - let mut out = json!({"processor_type": "horizon:condition", "if_true": p["if_true"], - "then": then, "else": otherwise}); - if let Some(mode) = p.get("random_mode") { - out["random_mode"] = mode.clone(); - } - Some(out) -} - -/// Lithostitched's references in a list, each replaced by the processors of -/// the lists it names, in order (references in them too, to a depth of 8). -/// One naming a tag or a list the mod does not have stays, to be dropped. -/// Whether any was replaced. -fn references( - list: Vec, - data: &ProcessorData, - carried: &mut BTreeMap, - depth: usize, -) -> (Vec, bool) { - let mut out = Vec::with_capacity(list.len()); - let mut changed = false; - for p in list { - if let Some(inner) = ctov::modular_compat(&p, data, carried, depth) { - changed = true; - out.extend(references(inner, data, carried, depth + 1).0); - continue; - } - let named = (p["processor_type"] == "lithostitched:reference" && depth < 8) - .then(|| referenced(&p["processor_lists"], data)) - .flatten(); - match named { - Some(inner) => { - *carried.entry("lithostitched:reference".into()).or_default() += 1; - out.extend(references(inner, data, carried, depth + 1).0); - changed = true; - } - None => out.push(p), - } - } - (out, changed) -} - -#[cfg(test)] -mod tests { - use super::*; - use crate::legacy_structure_mods::data; - use crate::processors::carry; - - #[test] - fn modifiers_add_to_sets_and_pools() { - let mut report = Upgrade::default(); - let only_fd = |m: &str| m == "farmersdelight"; - let set = json!({"type": "lithostitched:add_structure_set_entries", - "structure_sets": "minecraft:villages", - "entries": [{"structure": "x:village", "weight": 4}]}); - let (kind, added) = modifier(&set, &only_fd, &mut report).unwrap(); - assert_eq!(kind, "structure_set"); - assert_eq!( - added, - json!({"horizon:add_to": ["minecraft:villages"], - "structures": [{"structure": "x:village", "weight": 4}]}) - ); - // A compat addition holds only when its mod is ported along. - let pool = |modid: &str| { - json!({"type": "lithostitched:add_template_pool_elements", - "neoforge:conditions": [{"type": "neoforge:mod_loaded", "modid": modid}], - "fabric:load_conditions": {"condition": "fabric:all_mods_loaded", "values": ["other"]}, - "template_pools": ["x:houses", "y:houses"], - "elements": [{"weight": 5, "element": {"element_type": "minecraft:single_pool_element", - "location": "x:fd_farm", "projection": "rigid", "processors": "minecraft:empty"}}]}) - }; - let (kind, added) = modifier(&pool("farmersdelight"), &only_fd, &mut report).unwrap(); - assert_eq!(kind, "template_pool"); - assert_eq!(added["horizon:add_to"], json!(["x:houses", "y:houses"])); - assert_eq!(added["elements"][0]["weight"], 5); - assert!(modifier(&pool("create"), &only_fd, &mut report).is_none()); - // Fabric's conditions when there are no NeoForge ones; lithostitched's own. - let fabric = json!({"type": "lithostitched:add_structure_set_entries", - "fabric:load_conditions": [{"condition": "fabric:not", - "value": {"condition": "fabric:any_mods_loaded", "values": ["create"]}}], - "predicate": {"type": "lithostitched:all_of", "predicates": [ - {"type": "lithostitched:mod_loaded", "mod_id": "farmersdelight"}, - {"type": "lithostitched:true"}]}, - "structure_sets": "minecraft:villages", "entries": []}); - assert!(modifier(&fabric, &only_fd, &mut report).is_some()); - let tagged = json!({"type": "lithostitched:add_structure_set_entries", - "structure_sets": "#x:sets", "entries": []}); - assert!(modifier(&tagged, &only_fd, &mut report).is_none()); - let features = json!({"type": "lithostitched:add_features"}); - assert!(modifier(&features, &only_fd, &mut report).is_none()); - assert_eq!( - report.added_to, - BTreeMap::from([ - ("minecraft:villages".into(), 1), - ("x:houses".into(), 1), - ("y:houses".into(), 1), - ]) - ); - assert_eq!( - report.modifiers_left, - BTreeMap::from([ - ("conditions".into(), 1), - ("lithostitched:add_features".into(), 1), - ("target".into(), 1), - ]) - ); - } - - #[test] - fn lithostitched_block_swaps_become_the_games() { - let mut list = json!({"processors": [ - {"processor_type": "lithostitched:block_swap", - "blocks": {"minecraft:cobblestone": "minecraft:mossy_cobblestone"}}, - {"processor_type": "lithostitched:block_swap", "blocks": []}]}); - let mut carried = BTreeMap::new(); - assert!(carry("processor_list", &mut list, &data(), &mut carried)); - let p = list["processors"].as_array().unwrap(); - assert_eq!( - p[0], - json!({"processor_type": "horizon:block_swap", - "blocks": {"minecraft:cobblestone": "minecraft:mossy_cobblestone"}}) - ); - // A map that is not one stays Java (dropped later). - assert_eq!(p[1]["processor_type"], "lithostitched:block_swap"); - } - - #[test] - fn lithostitched_references_are_written_in() { - let mut data = data(); - let gravity = json!({"processor_type": "minecraft:gravity", "heightmap": "WORLD_SURFACE_WG", "offset": 0}); - data.lists - .insert("v:road".into(), json!({"processors": [gravity.clone()]})); - data.lists.insert( - "v:house".into(), - json!({"processors": [ - {"processor_type": "lithostitched:reference", "processor_lists": "v:road"}, - {"processor_type": "lithostitched:block_swap", "blocks": {"minecraft:dirt": "minecraft:grass_block"}}]}), - ); - let mut list = json!({"processors": [ - {"processor_type": "lithostitched:reference", "processor_lists": ["v:house", "v:road"]}, - {"processor_type": "lithostitched:reference", "processor_lists": "#v:roads"}, - {"processor_type": "lithostitched:reference", "processor_lists": ["v:nowhere"]}]}); - let mut carried = BTreeMap::new(); - assert!(carry("processor_list", &mut list, &data, &mut carried)); - let p = list["processors"].as_array().unwrap(); - // House (its own reference to road first, then its swap), then road; - // the swap inside is carried too. - assert_eq!(p[0], gravity); - assert_eq!(p[1]["processor_type"], "horizon:block_swap"); - assert_eq!(p[2], gravity); - // A tag or a list the mod lacks stays, to be dropped. - assert_eq!(p[3]["processor_lists"], "#v:roads"); - assert_eq!(p[4]["processor_lists"], json!(["v:nowhere"])); - assert_eq!(carried["lithostitched:reference"], 2); - } - - #[test] - fn lithostitched_random_and_condition_become_the_games() { - let mut data = data(); - let swap = json!({"processor_type": "lithostitched:block_swap", - "blocks": {"minecraft:dirt": "minecraft:grass_block"}}); - data.lists - .insert("v:green".into(), json!({"processors": [swap.clone()]})); - let mut list = json!({"processors": [ - {"processor_type": "lithostitched:apply_random", "mode": "per_piece", "processor_lists": [ - {"weight": 3, "data": "minecraft:empty"}, - {"weight": 1, "data": {"processors": [ - {"processor_type": "lithostitched:reference", "processor_lists": "v:green"}, - {"processor_type": "v:java"}]}}]}, - {"processor_type": "lithostitched:apply_random", "mode": "per_block", - "processor_lists": ["v:green", "v:red"]}, - {"processor_type": "lithostitched:apply_random", "mode": "per_block", - "processor_lists": "#v:colours"}, - {"processor_type": "lithostitched:condition", - "if_true": [{"type": "lithostitched:matching_blocks", "blocks": "minecraft:cobblestone"}], - "then": swap, "else": {"processor_type": "lithostitched:set_block", "state_provider": - {"type": "minecraft:simple_state_provider", "state": {"Name": "minecraft:stone"}}}}, - {"processor_type": "lithostitched:condition", - "if_true": {"type": "lithostitched:matching_biomes", "biomes": "#c:is_cold"}, - "then": []}]}); - let mut carried = BTreeMap::new(); - assert!(carry("processor_list", &mut list, &data, &mut carried)); - let p = list["processors"].as_array().unwrap(); - let green = json!({"processor_type": "horizon:block_swap", - "blocks": {"minecraft:dirt": "minecraft:grass_block"}}); - // Inline lists are carried; Java left in them is dropped later. - assert_eq!( - p[0], - json!({"processor_type": "horizon:apply_random", "mode": "per_piece", "processor_lists": [ - {"weight": 3, "data": "minecraft:empty"}, - {"weight": 1, "data": {"processors": [green.clone(), {"processor_type": "v:java"}]}}]}) - ); - assert_eq!( - p[1]["processor_lists"], - json!([{"weight": 1, "data": "v:green"}, {"weight": 1, "data": "v:red"}]) - ); - assert_eq!(p[2]["processor_type"], "lithostitched:apply_random"); - assert_eq!( - p[3], - json!({"processor_type": "horizon:condition", - "if_true": [{"type": "lithostitched:matching_blocks", "blocks": "minecraft:cobblestone"}], - "then": [green], "else": [{"processor_type": "horizon:set_block", "state_provider": - {"type": "minecraft:simple_state_provider", "state": {"Name": "minecraft:stone"}}}]}) - ); - assert_eq!(p[4]["processor_type"], "lithostitched:condition"); - assert_eq!(carried["lithostitched:apply_random"], 2); - assert_eq!(carried["lithostitched:condition"], 1); - } -} diff --git a/crates/horizon-port-pack/src/legacy_structure_mods/mod.rs b/crates/horizon-port-pack/src/legacy_structure_mods/mod.rs index 1faa1b39f..980798720 100644 --- a/crates/horizon-port-pack/src/legacy_structure_mods/mod.rs +++ b/crates/horizon-port-pack/src/legacy_structure_mods/mod.rs @@ -13,10 +13,11 @@ //! The general code reaches them only through the `pub(crate)` entry points //! of these three modules. Nothing in them is used by another mod's //! conversion. +#[allow(dead_code)] // its modular compat is `crate::lithostitched`'s now; the rest goes with C1 pub(crate) mod ctov; -pub(crate) mod lithostitched; #[cfg(test)] +#[allow(dead_code)] // the old Lithostitched tests used it fn data() -> crate::processors::ProcessorData { let mut d = crate::processors::ProcessorData::default(); d.spawners.insert( diff --git a/crates/horizon-port-pack/src/lib.rs b/crates/horizon-port-pack/src/lib.rs index 3b17f1c9c..3b77aec63 100644 --- a/crates/horizon-port-pack/src/lib.rs +++ b/crates/horizon-port-pack/src/lib.rs @@ -14,7 +14,9 @@ pub mod import; pub mod inventory; pub mod jar; pub(crate) mod legacy_structure_mods; +mod lithostitched; pub mod modrinth; +pub mod net; pub mod oracle; pub mod pipeline; pub mod processors; diff --git a/crates/horizon-port-pack/src/lithostitched.rs b/crates/horizon-port-pack/src/lithostitched.rs new file mode 100644 index 000000000..e65efcf0e --- /dev/null +++ b/crates/horizon-port-pack/src/lithostitched.rs @@ -0,0 +1,434 @@ +//! Lithostitched's worldgen, carried as the game reads it (clean room: +//! `cleanroom/structures/spec-lithostitched.md`; CTOV's processor: +//! `spec-ctov.md` §4). +//! +//! - `lithostitched:jigsaw` structures become vanilla's jigsaw. Lithostitched +//! lays jigsaws out its own way (OPEN-L5): Horizon keeps vanilla's layouts. +//! - Its processors (`block_swap`, `reference`, `apply_random`, `condition`, +//! `set_block`, `discard_input`) are the game's own types +//! (`horizon_world`'s `structure::processor`): they are carried as written, +//! the processors nested in them carried in turn. CTOV's +//! `ctov:modular_compat` (a reference that runs only when its mod is loaded) +//! becomes a `reference` when the mod is ported along, else nothing. +//! - `add_template_pool_elements` modifiers become `horizon:add_to` pool files +//! (`docs/mods.md`), when their load conditions pass. Lithostitched's own +//! pool elements (`limited`, `guaranteed`, `delegating`) place their +//! `delegate`; what they add to it is counted as lost. +use crate::{processors::ProcessorData, worldgen::Upgrade}; +use serde_json::{Value, json}; +use std::collections::BTreeMap; + +const JIGSAW: &str = "lithostitched:jigsaw"; +/// Vanilla's JigsawStructure.MAX_DEPTH. +const MAX_SIZE: i64 = 20; +const MODULAR_COMPAT: &str = "ctov:modular_compat"; +/// The processor types the game reads. +const PROCESSORS: [&str; 6] = [ + "lithostitched:block_swap", + "lithostitched:reference", + "lithostitched:apply_random", + "lithostitched:condition", + "lithostitched:set_block", + "lithostitched:discard_input", +]; + +fn count(map: &mut BTreeMap, name: &str) { + *map.entry(name.to_owned()).or_default() += 1; +} + +/// A `lithostitched:jigsaw` structure as vanilla's jigsaw: `Some(true)`, else +/// `None`. +pub(crate) fn upgrade( + kind: &str, + v: &mut Value, + lost: &mut BTreeMap, +) -> Option { + if kind != "structure" || v["type"] != JIGSAW { + return None; + } + v["type"] = "minecraft:jigsaw".into(); + // `size` may be an int provider (sampled per start): its largest value. + let size = match &v["size"] { + Value::Null => None, + Value::Number(n) => n.as_i64(), + provider => { + count(lost, "lithostitched:jigsaw size provider"); + ["max_inclusive", "value"] + .iter() + .find_map(|k| provider[k].as_i64()) + } + }; + if let Some(size) = size { + if size > MAX_SIZE { + count(lost, "lithostitched:jigsaw size over 20"); + } + v["size"] = size.clamp(0, MAX_SIZE).into(); + } + let o = v.as_object_mut()?; + match o.remove("start_projection") { + Some(Value::String(heightmap)) if heightmap != "floor" && heightmap != "ceiling" => { + o.entry("project_start_to_heightmap") + .or_insert(heightmap.into()); + } + Some(_) => count(lost, "lithostitched:jigsaw start_projection"), + None => {} + } + if o.remove("fixed_rotation").is_some_and(|f| f == true) { + count(lost, "lithostitched:jigsaw fixed_rotation"); + } + Some(true) +} + +/// Lithostitched's pool elements as the element they wrap; whether `element` +/// was one. +pub(crate) fn upgrade_pool_element( + element: &mut Value, + lost: &mut BTreeMap, +) -> bool { + let Some(kind) = element["element_type"].as_str() else { + return false; + }; + match kind { + "lithostitched:limited" | "lithostitched:guaranteed" | "lithostitched:delegating" => { + count(lost, kind); + let delegate = element["delegate"].take(); + *element = delegate; + // A delegate wrapping another (only `delegating` allows it). + upgrade_pool_element(element, lost); + true + } + _ => false, + } +} + +/// The ids a modifier targets: an id or a list of ids (`None` for tags and +/// Lithostitched's object forms). +fn ids(v: &Value) -> Option> { + let id = |v: &Value| { + v.as_str() + .filter(|s| !s.starts_with('#')) + .map(str::to_owned) + }; + match v { + Value::Array(a) => a.iter().map(id).collect(), + other => Some(vec![id(other)?]), + } +} + +/// NeoForge's load conditions (`neoforge:conditions`): all must pass. +fn conditions_pass(v: &Value, loaded: &dyn Fn(&str) -> bool) -> bool { + fn pass(c: &Value, loaded: &dyn Fn(&str) -> bool) -> bool { + let all = |key: &str| { + c[key] + .as_array() + .into_iter() + .flatten() + .all(|c| pass(c, loaded)) + }; + match c["type"].as_str() { + Some("neoforge:mod_loaded") => c["modid"].as_str().is_some_and(loaded), + Some("neoforge:true") => true, + Some("neoforge:not") => !pass(&c["value"], loaded), + Some("neoforge:and") => all("values"), + Some("neoforge:or") => { + (c["values"].as_array().into_iter().flatten()).any(|c| pass(c, loaded)) + } + _ => false, + } + } + (v["neoforge:conditions"].as_array().into_iter().flatten()).all(|c| pass(c, loaded)) +} + +/// A worldgen modifier as a file the game merges: `("template_pool", file)` +/// for `add_template_pool_elements`; the others are counted in +/// `report.modifiers_left`. +pub(crate) fn modifier( + v: &Value, + loaded: &dyn Fn(&str) -> bool, + report: &mut Upgrade, +) -> Option<(&'static str, Value)> { + let kind = v["type"].as_str().unwrap_or("no type"); + if !conditions_pass(v, loaded) { + count(&mut report.modifiers_left, "conditions"); + return None; + } + if kind != "lithostitched:add_template_pool_elements" { + count(&mut report.modifiers_left, kind); + return None; + } + let (Some(targets), Some(elements)) = (ids(&v["template_pools"]), v["elements"].as_array()) + else { + count(&mut report.modifiers_left, "target"); + return None; + }; + for target in &targets { + *report.added_to.entry(target.clone()).or_default() += elements.len(); + } + Some(( + "template_pool", + json!({"horizon:add_to": targets, "elements": elements}), + )) +} + +/// Whether the game reads a Lithostitched processor as it is: one of its +/// types, with no processor list named by tag (the game has no processor +/// list tags) and a state provider it runs. +pub(crate) fn game_reads(p: &Value) -> bool { + let Some(kind) = p["processor_type"] + .as_str() + .filter(|t| PROCESSORS.contains(t)) + else { + return false; + }; + let tag = |v: &Value| v.as_str().is_some_and(|s| s.starts_with('#')); + match kind { + "lithostitched:reference" => match &p["processor_lists"] { + Value::Array(a) => !a.iter().any(tag), + other => other.is_string() && !tag(other), + }, + "lithostitched:apply_random" => p["processor_lists"] + .as_array() + .is_some_and(|a| a.iter().all(|e| !tag(e) && !tag(&e["data"]))), + "lithostitched:set_block" => matches!( + p["state_provider"]["type"].as_str(), + Some("minecraft:simple_state_provider" | "minecraft:weighted_state_provider") + ), + "lithostitched:block_swap" => p["blocks"].is_object(), + "lithostitched:condition" => !p["if_true"].is_null(), + _ => true, + } +} + +/// The processor lists inside a Lithostitched processor, for the general +/// code that walks lists (`then`, `else`, `apply_random`'s inline data). +pub(crate) fn inner_lists(p: &mut Value) -> Vec<&mut Value> { + match p["processor_type"].as_str() { + Some("lithostitched:apply_random") => (p["processor_lists"].as_array_mut().into_iter()) + .flatten() + .filter_map(|e| e.get_mut("data").filter(|d| !d.is_string())) + .collect(), + Some("lithostitched:condition") => (p.as_object_mut().into_iter()) + .flat_map(|o| o.iter_mut()) + .filter(|(k, _)| *k == "then" || *k == "else") + .map(|(_, v)| v) + .collect(), + _ => Vec::new(), + } +} + +/// A Lithostitched processor with the processors nested in it carried +/// (`Some`, when one of them changed); `None` for any other processor. +pub(crate) fn processor( + kind: &str, + p: &Value, + data: &ProcessorData, + carried: &mut BTreeMap, +) -> Option> { + if !PROCESSORS.contains(&kind) { + return None; + } + let mut out = p.clone(); + let mut changed = false; + for list in inner_lists(&mut out) { + // One processor alone is a list of one. + if list.get("processor_type").is_some() { + *list = Value::Array(vec![list.take()]); + changed = true; + } + if let Some(processors) = crate::processors::processors(list) { + let (inner, inner_changed) = + crate::processors::carry_all(std::mem::take(processors), data, carried); + *processors = inner; + changed |= inner_changed; + } + } + changed.then(|| vec![out]) +} + +/// The list with CTOV's modular compat processors written as the game's +/// `reference` (its mod is ported along) or taken out; whether any was. +pub(crate) fn expand_references( + list: Vec, + data: &ProcessorData, + carried: &mut BTreeMap, +) -> (Vec, bool) { + let mut changed = false; + let mut out = Vec::with_capacity(list.len()); + for p in list { + if p["processor_type"] != MODULAR_COMPAT { + out.push(p); + continue; + } + changed = true; + count(carried, MODULAR_COMPAT); + let loaded = p["modid"] + .as_str() + .is_some_and(|m| data.compat_loaded.contains(m)); + if loaded { + out.push(json!({"processor_type": "lithostitched:reference", + "processor_lists": p["reference"].clone()})); + } + } + (out, changed) +} + +/// Notes which mods CTOV's modular compat processors name are `loaded`. +pub(crate) fn mark_loaded(data: &mut ProcessorData, loaded: &dyn Fn(&str) -> bool) { + fn visit(v: &Value, out: &mut Vec) { + match v { + Value::Object(o) => { + if o.get("processor_type").and_then(Value::as_str) == Some(MODULAR_COMPAT) + && let Some(m) = o.get("modid").and_then(Value::as_str) + { + out.push(m.to_owned()); + } + o.values().for_each(|v| visit(v, out)); + } + Value::Array(a) => a.iter().for_each(|v| visit(v, out)), + _ => {} + } + } + let mut named = Vec::new(); + data.lists.values().for_each(|l| visit(l, &mut named)); + data.compat_loaded + .extend(named.into_iter().filter(|m| loaded(m))); +} + +#[cfg(test)] +mod tests { + use super::*; + use crate::worldgen::upgrade as upgrade_file; + + #[test] + fn jigsaws_become_vanillas() { + let mut lost = BTreeMap::new(); + let mut s = json!({"type": JIGSAW, "size": {"type": "uniform", "min_inclusive": 3, + "max_inclusive": 40}, "start_projection": "WORLD_SURFACE_WG", "fixed_rotation": true}); + assert_eq!(upgrade("structure", &mut s, &mut lost), Some(true)); + assert_eq!( + s, + json!({"type": "minecraft:jigsaw", "size": 20, + "project_start_to_heightmap": "WORLD_SURFACE_WG"}) + ); + assert_eq!(lost.len(), 3); + assert_eq!( + upgrade( + "structure", + &mut json!({"type": "minecraft:jigsaw"}), + &mut lost + ), + None + ); + } + + #[test] + fn wrapped_elements_place_their_delegate() { + let mut lost = BTreeMap::new(); + let delegate = json!({"element_type": "minecraft:single_pool_element", "location": "a:b", + "projection": "rigid", "processors": "minecraft:empty"}); + let mut e = + json!({"element_type": "lithostitched:limited", "limit": 1, "delegate": delegate}); + assert!(upgrade_pool_element(&mut e, &mut lost)); + assert_eq!(e, delegate); + assert_eq!(lost["lithostitched:limited"], 1); + assert!(!upgrade_pool_element(&mut e, &mut lost)); + } + + #[test] + fn modifiers_add_to_pools_when_their_mods_are_loaded() { + let mut report = Upgrade::default(); + let loaded = |m: &str| m == "waystones"; + let add = |modid: &str, pools: Value| { + json!({"type": "lithostitched:add_template_pool_elements", "template_pools": pools, + "elements": [{"weight": 2, "element": {"element_type": "minecraft:empty_pool_element"}}], + "neoforge:conditions": [{"type": "neoforge:mod_loaded", "modid": modid}]}) + }; + let (kind, file) = modifier( + &add("waystones", json!("ctov:village/plains/house")), + &loaded, + &mut report, + ) + .unwrap(); + assert_eq!(kind, "template_pool"); + assert_eq!(file["horizon:add_to"], json!(["ctov:village/plains/house"])); + assert_eq!(file["elements"][0]["weight"], 2); + assert_eq!(report.added_to["ctov:village/plains/house"], 1); + assert!(modifier(&add("sawmill", json!("a:b")), &loaded, &mut report).is_none()); + assert!(modifier(&add("waystones", json!("#a:pools")), &loaded, &mut report).is_none()); + let aliases = json!({"type": "lithostitched:set_pool_aliases"}); + assert!(modifier(&aliases, &loaded, &mut report).is_none()); + assert_eq!( + report.modifiers_left, + BTreeMap::from([ + ("conditions".into(), 1), + ("lithostitched:set_pool_aliases".into(), 1), + ("target".into(), 1), + ]) + ); + } + + /// A CTOV list (spec-ctov §4): references, a condition with a single + /// processor and a nested condition, a random list holding the compat + /// hook, and processors the game cannot read. + #[test] + fn processors_stay_lithostitcheds_with_their_insides_carried() { + let hook = json!({"processor_type": MODULAR_COMPAT, "modid": "natures_spirit", + "reference": "ctov:village/mesa/house_wisteria"}); + let list = json!({"processors": [ + {"processor_type": "lithostitched:reference", "processor_lists": ["ctov:village/mesa/house"]}, + {"processor_type": "lithostitched:condition", "random_mode": "per_block", + "if_true": {"type": "lithostitched:matching_blocks", "blocks": "minecraft:water", + "match_type": "location"}, + "then": {"processor_type": "lithostitched:set_block", "state_provider": { + "type": "minecraft:simple_state_provider", "state": {"Name": "minecraft:spruce_planks"}}}, + "else": [{"processor_type": "somemod:java_processor"}]}, + {"processor_type": "lithostitched:apply_random", "mode": "per_piece", "processor_lists": [ + {"weight": 1, "data": "minecraft:empty"}, + {"weight": 1, "data": {"processors": [hook]}}]}, + {"processor_type": "lithostitched:reference", "processor_lists": "#ctov:palettes"}, + {"processor_type": "lithostitched:set_block", "state_provider": { + "type": "minecraft:noise_provider"}}]}); + for (loaded, wisteria) in [ + (false, json!([])), + ( + true, + json!([{"processor_type": + "lithostitched:reference", "processor_lists": "ctov:village/mesa/house_wisteria"}]), + ), + ] { + let mut data = ProcessorData::default(); + data.lists + .insert("ctov:village/mesa/house".into(), list.clone()); + mark_loaded(&mut data, &|m| loaded && m == "natures_spirit"); + let mut v = list.clone(); + let mut report = Upgrade::default(); + crate::processors::carry( + "processor_list", + &mut v, + &data, + &mut report.processors_carried, + ); + upgrade_file("processor_list", &mut v, &mut report, &BTreeMap::new()); + let p = &v["processors"]; + assert_eq!(p.as_array().unwrap().len(), 3, "{p}"); + assert_eq!(p[0], list["processors"][0]); + // One processor is a list of one; the Java one is taken out. + assert_eq!( + p[1]["then"][0]["state_provider"]["state"]["id"], + "minecraft:spruce_planks" + ); + assert_eq!(p[1]["else"], json!([])); + assert_eq!(p[2]["processor_lists"][0]["data"], "minecraft:empty"); + assert_eq!(p[2]["processor_lists"][1]["data"]["processors"], wisteria); + assert_eq!(report.processors_carried[MODULAR_COMPAT], 1); + assert_eq!( + report.processors_dropped, + BTreeMap::from([ + ("lithostitched:reference".into(), 1), + ("lithostitched:set_block".into(), 1), + ("somemod:java_processor".into(), 1), + ]) + ); + } + } +} diff --git a/crates/horizon-port-pack/src/modrinth.rs b/crates/horizon-port-pack/src/modrinth.rs index 4e90c871a..17d6b3222 100644 --- a/crates/horizon-port-pack/src/modrinth.rs +++ b/crates/horizon-port-pack/src/modrinth.rs @@ -79,7 +79,8 @@ impl Cache { } fn post(url: &str, body: &Value) -> Result { - let response = ureq::post(url) + let response = crate::net::agent(url) + .post(url) .set("User-Agent", AGENT) .set("Content-Type", "application/json") .send_string(&body.to_string()) @@ -88,7 +89,8 @@ fn post(url: &str, body: &Value) -> Result { } fn get(url: &str) -> Result { - let response = ureq::get(url) + let response = crate::net::agent(url) + .get(url) .set("User-Agent", AGENT) .call() .map_err(|e| format!("{url}: {e}"))?; diff --git a/crates/horizon-port-pack/src/net.rs b/crates/horizon-port-pack/src/net.rs new file mode 100644 index 000000000..a441fb13a --- /dev/null +++ b/crates/horizon-port-pack/src/net.rs @@ -0,0 +1,389 @@ +//! The agents port-pack's downloads go through: the jars of an imported modpack come from the same +//! places as everything else, so they take the same proxy — and leave the same hosts alone. +//! +//! The launcher hands its own setting over (`set_proxy`, from `proxy.rs`); a run of the +//! `horizon-port-pack` command reads `HTTPS_PROXY`, `HTTP_PROXY` and `ALL_PROXY` instead (`env_for`), +//! taking the one that matches the address's scheme the way the launcher does. Either way a host in +//! `NO_PROXY`, or on this computer, is reached directly: a host that only answers without the proxy +//! would otherwise fail here while the launcher's own downloads worked. +//! +//! Which hosts those are is decided here and nowhere else. The launcher asks `direct`, `env_for`, +//! `host_of`, `scheme_of`, `socks` and `parse` for its own traffic, and keeps its agents here too +//! (`keep`), so the two agree whatever the player set — and there is one copy of the rules to +//! change when they need it. +use std::collections::HashMap; +use std::sync::atomic::{AtomicBool, Ordering}; +use std::sync::{Mutex, MutexGuard}; + +/// What the launcher set, when it did. +static PROXY: Mutex> = Mutex::new(None); + +/// Agents kept for reuse, named by the part that asked and the proxy they use: a fresh `Agent` +/// starts a new connection pool, so building one per request costs a handshake per file. +static KEPT: Mutex>> = Mutex::new(None); + +/// The proxy to use from now on: the launcher's setting, or None to fall back to the environment. +/// The agents built so far are dropped when it changes, since they hold the address it replaces. +pub fn set_proxy(spec: Option) { + let spec = spec.map(|s| s.trim().to_owned()).filter(|s| !s.is_empty()); + let mut proxy = lock(&PROXY); + if *proxy == spec { + return; + } + *proxy = spec; + drop(proxy); + *lock(&KEPT) = None; +} + +/// The proxy address `url` is fetched through: what the launcher set, else the environment's for +/// its scheme, unless `url` is a host that must be reached directly. +fn spec_for(url: &str) -> Option { + if direct(url) { + return None; + } + lock(&PROXY) + .clone() + .or_else(|| env_for(scheme_of(url).unwrap_or("https"))) +} + +/// An agent for downloading `url`: through the proxy when one is set, unless `url` is a host that +/// must be reached directly. +pub fn agent(url: &str) -> ureq::Agent { + keep("port-pack", spec_for(url).as_deref(), |proxy| { + let builder = ureq::AgentBuilder::new(); + match proxy { + Some(proxy) => builder.proxy(proxy).build(), + None => builder.build(), + } + }) +} + +/// The agent `url` is fetched with, built by `build` and then kept for the next request that names +/// the same `slot` and proxy: a fresh `Agent` starts a new connection pool, so building one per +/// request is a handshake per file, and a modpack's jars are fetched one after another. +pub fn keep( + slot: &str, + spec: Option<&str>, + build: impl FnOnce(Option) -> ureq::Agent, +) -> ureq::Agent { + let proxy = spec.and_then(parse); + // An address that isn't a proxy is used as none, and remembered as none. + let key = format!( + "{slot} {}", + if proxy.is_some() { + spec.unwrap_or_default() + } else { + "" + } + ); + if let Some(agent) = lock(&KEPT).as_ref().and_then(|kept| kept.get(&key)) { + return agent.clone(); + } + let agent = build(proxy); + lock(&KEPT) + .get_or_insert_with(HashMap::new) + .insert(key, agent.clone()); + agent +} + +/// `spec` as a proxy, when it is one. An address that can't be used is said once: a download left +/// to go direct would otherwise fail with nothing pointing at the proxy. +pub fn parse(spec: &str) -> Option { + if socks(spec) { + say(&format!( + "{} is a SOCKS proxy; downloads go without one. Write the http:// address your \ + proxy app listens on as well.", + redacted(spec) + )); + return None; + } + match ureq::Proxy::new(spec) { + Ok(proxy) => Some(proxy), + Err(e) => { + say(&format!( + "The proxy address {} can't be used ({e}); downloads go without one.", + redacted(spec) + )); + None + } + } +} + +/// `spec` as it may be shown: a user name and password in it become `***`. An address that can't +/// be used is printed to stderr and shown in the launcher, and a proxy's credentials don't belong in +/// either. Everything up to the last `@` is the credentials, so a password with an unescaped `/` or +/// `@` is hidden too. +pub fn redacted(spec: &str) -> String { + let (scheme, rest) = match spec.split_once("://") { + Some((scheme, rest)) => (format!("{scheme}://"), rest), + None => (String::new(), spec), + }; + match rest.rfind('@') { + Some(at) => format!("{scheme}***@{}", &rest[at + 1..]), + None => spec.to_owned(), + } +} + +/// Whether `spec` names a SOCKS proxy, which these downloads don't go through: `ureq` reads a +/// SOCKS address happily and only fails when it connects through it. +pub fn socks(spec: &str) -> bool { + matches!( + spec.split_once("://") + .map(|(s, _)| s.to_ascii_lowercase()) + .as_deref(), + Some("socks" | "socks4" | "socks4a" | "socks5" | "socks5h") + ) +} + +/// Whether `url` is reached without the proxy: a local address, or a host `NO_PROXY` names. The +/// launcher asks this of its own requests, so both reach the same hosts directly. +pub fn direct(url: &str) -> bool { + host_of(url).is_some_and(|host| local(host) || excluded(host, &no_proxy())) +} + +/// `HTTPS_PROXY` (`HTTP_PROXY` for an http address), then `ALL_PROXY`, in the upper-case spelling +/// first and the lower-case one after, as the tools that write them do. +pub fn env_for(scheme: &str) -> Option { + let names: &[&str] = if scheme.eq_ignore_ascii_case("http") { + &["HTTP_PROXY", "http_proxy", "ALL_PROXY", "all_proxy"] + } else { + &["HTTPS_PROXY", "https_proxy", "ALL_PROXY", "all_proxy"] + }; + names.iter().find_map(|name| { + std::env::var(name) + .ok() + .map(|v| v.trim().to_owned()) + .filter(|v| !v.is_empty()) + }) +} + +/// `NO_PROXY`'s list: the hosts reached directly whatever the proxy is. +fn no_proxy() -> String { + ["NO_PROXY", "no_proxy"] + .iter() + .find_map(|name| std::env::var(name).ok()) + .unwrap_or_default() +} + +/// The host part of a URL (`https://user@host:port/path` is `host`). +pub fn host_of(url: &str) -> Option<&str> { + let rest = url.split_once("://").map_or(url, |(_, rest)| rest); + let rest = rest.split(['/', '?', '#']).next()?; + let rest = rest.rsplit_once('@').map_or(rest, |(_, host)| host); + Some(match rest.rfind(':') { + // A port follows the last colon; an IPv6 literal keeps the colons inside its brackets. + Some(at) if !rest[at..].contains(']') => &rest[..at], + _ => rest, + }) +} + +/// `https` in `https://…`, or None for anything that isn't an absolute address. +pub fn scheme_of(url: &str) -> Option<&str> { + url.split_once("://").map(|(scheme, _)| scheme) +} + +/// Whether `host` is this computer: the game's own API and a server on the same machine. +fn local(host: &str) -> bool { + let host = bare(host); + host == "localhost" + || host.ends_with(".localhost") + || host == "::1" + || host == "0.0.0.0" + || host.starts_with("127.") +} + +/// Whether `host` is in `NO_PROXY`: `*`, `host`, `.domain`, `*.domain` and `host:port` entries. +fn excluded(host: &str, no_proxy: &str) -> bool { + let host = bare(host); + no_proxy + .split(',') + .map(str::trim) + .filter(|e| !e.is_empty()) + .any(|entry| { + if entry == "*" { + return true; + } + let entry = entry.trim_start_matches('*').trim_start_matches('.'); + let entry = match entry.rfind(':') { + Some(at) if !entry[at..].contains(']') => &entry[..at], + _ => entry, + }; + let entry = bare(entry); + !entry.is_empty() && (host == entry || host.ends_with(&format!(".{entry}"))) + }) +} + +/// A host without the brackets an IPv6 literal wears, lower case. +fn bare(host: &str) -> String { + host.trim().trim_matches(['[', ']']).to_ascii_lowercase() +} + +/// Said once, however many downloads follow: a wrong address is one thing to report, not one +/// report per file. +fn say(what: &str) { + static SAID: AtomicBool = AtomicBool::new(false); + if !SAID.swap(true, Ordering::Relaxed) { + eprintln!("{what}"); + } +} + +/// The lock, even after a thread panicked while holding it: an address lost to a panic is worse +/// than an old one kept. +fn lock(m: &Mutex) -> MutexGuard<'_, T> { + m.lock().unwrap_or_else(|e| e.into_inner()) +} + +#[cfg(test)] +mod tests { + use super::*; + + /// What the tests below share, since the address and the agents are one of each for the whole + /// process: they take it in turn. + fn alone() -> MutexGuard<'static, ()> { + static TURN: Mutex<()> = Mutex::new(()); + lock(&TURN) + } + + #[test] + fn credentials_are_not_shown() { + assert_eq!(redacted("http://127.0.0.1:7890"), "http://127.0.0.1:7890"); + assert_eq!(redacted("proxy.local:3128"), "proxy.local:3128"); + assert_eq!( + redacted("http://user:pass@proxy.local:3128"), + "http://***@proxy.local:3128" + ); + assert_eq!( + redacted("socks5://u:p@10.0.0.1:1080"), + "socks5://***@10.0.0.1:1080" + ); + assert_eq!( + redacted("user:pass@proxy.local:3128"), + "***@proxy.local:3128" + ); + assert_eq!(redacted("http://u:p/a@ss@proxy:1"), "http://***@proxy:1"); + assert_eq!(redacted("http://user:pass@"), "http://***@"); + } + + #[test] + fn a_proxy_the_launcher_sets_is_trimmed_and_kept() { + let _turn = alone(); + set_proxy(Some(" http://127.0.0.1:7890 ".into())); + assert_eq!( + PROXY.lock().unwrap().as_deref(), + Some("http://127.0.0.1:7890") + ); + set_proxy(Some(" ".into())); + assert!(PROXY.lock().unwrap().is_none()); + } + + /// An address on this computer is reached directly whatever `NO_PROXY` says: what an import + /// needs when the launcher's own requests to it go direct. + #[test] + fn a_local_address_is_reached_directly() { + assert!(direct("http://127.0.0.1:8130/api/v1/status")); + assert!(direct("http://localhost/api/v1/status")); + assert!(direct("https://[::1]:25565/")); + } + + #[test] + fn a_host_is_read_out_of_the_address() { + assert_eq!( + host_of("https://cdn.modrinth.com/v2/x.jar"), + Some("cdn.modrinth.com") + ); + assert_eq!( + host_of("https://user:pass@piston-meta.mojang.com:8443/a"), + Some("piston-meta.mojang.com") + ); + assert_eq!( + host_of("http://127.0.0.1:8130/api/v1/status"), + Some("127.0.0.1") + ); + assert_eq!(host_of("https://[::1]:25565/"), Some("[::1]")); + assert_eq!(host_of("https://example.com?x=1"), Some("example.com")); + assert_eq!(host_of("https://example.com#top"), Some("example.com")); + } + + #[test] + fn only_absolute_addresses_have_a_scheme() { + assert_eq!(scheme_of("https://a.b"), Some("https")); + assert_eq!(scheme_of("http://a.b"), Some("http")); + assert_eq!(scheme_of("a.b/c"), None); + } + + #[test] + fn this_computer_is_never_proxied() { + for host in [ + "localhost", + "LOCALHOST", + "[::1]", + "::1", + "127.0.0.1", + "127.1.2.3", + ] { + assert!(local(host), "{host}"); + } + for host in ["playhorizon.dev", "api.minecraftservices.com", "10.0.0.1"] { + assert!(!local(host), "{host}"); + } + } + + /// What an import with `NO_PROXY=modrinth.com` needs: the launcher's own requests to it go + /// direct, so the jars fetched for it must too. + #[test] + fn no_proxy_lists_hosts_and_their_subdomains() { + assert!(excluded("anything.at.all", "*")); + assert!(excluded("cdn.modrinth.com", "modrinth.com")); + assert!(excluded("api.modrinth.com", "modrinth.com")); + assert!(excluded("piston-meta.mojang.com", "mojang.com")); + assert!(excluded( + "wiki.corp.example", + " .corp.example , other.host " + )); + assert!(excluded("github.com", "github.com:443")); + assert!(!excluded("notmodrinth.com", "modrinth.com")); + assert!(!excluded("modrinth.com", " .corp.example , mojang.com ")); + assert!(!excluded("edge.forgecdn.net", "modrinth.com")); + assert!(!excluded("modrinth.com", "")); + } + + #[test] + fn an_address_that_cant_be_used_becomes_no_proxy() { + assert!(parse("http://127.0.0.1:7890").is_some()); + assert!(parse("127.0.0.1:7890").is_some()); + // `ureq` reads a SOCKS address and only fails once it connects through it. + assert!(socks("socks5://127.0.0.1:7891")); + assert!(parse("socks5://127.0.0.1:7891").is_none()); + assert!(!socks("http://127.0.0.1:7890")); + } + + /// The agent a second request gets is the one the first built: one connection pool, not one + /// handshake per jar. + #[test] + fn an_agent_is_kept_for_the_next_request() { + let _turn = alone(); + set_proxy(None); + let mut built = 0; + for _ in 0..3 { + keep("kept", None, |_| { + built += 1; + ureq::AgentBuilder::new().build() + }); + } + assert_eq!(built, 1, "three requests, one agent"); + // Another address is another agent, and a new setting drops the ones before it. + keep("kept", Some("http://127.0.0.1:7890"), |proxy| { + assert!(proxy.is_some()); + built += 1; + ureq::AgentBuilder::new().build() + }); + assert_eq!(built, 2, "a second address needs a second agent"); + set_proxy(Some("http://127.0.0.1:7891".into())); + keep("kept", Some("http://127.0.0.1:7891"), |_| { + built += 1; + ureq::AgentBuilder::new().build() + }); + assert_eq!(built, 3, "a new setting drops the agents kept before it"); + set_proxy(None); + } +} diff --git a/crates/horizon-port-pack/src/processors.rs b/crates/horizon-port-pack/src/processors.rs index af1595f92..046eaa0bf 100644 --- a/crates/horizon-port-pack/src/processors.rs +++ b/crates/horizon-port-pack/src/processors.rs @@ -10,13 +10,13 @@ //! - Repurposed Structures' mineshaft sky view becomes the game's //! `horizon:mineshaft_sky_view`. //! -//! The processors of YUNG's mods, Lithostitched and Choice Theorem's Overhauled -//! Village are carried by `legacy_structure_mods`, called from [`carry`]. +//! Lithostitched's processors and Choice Theorem's Overhauled Village's +//! compat hook are carried by `crate::lithostitched`, called from [`carry`]. //! //! What is not here is taken out of its list later and counted //! (`worldgen::upgrade`). The entity NBT is written in 26.3's shape (an //! `equipment` map, not 1.21.1's `HandItems` and `ArmorItems`). -use crate::legacy_structure_mods::{ctov, lithostitched}; +use crate::lithostitched; use serde_json::{Value, json}; use std::{ collections::{BTreeMap, BTreeSet}, @@ -42,7 +42,7 @@ pub struct ProcessorData { impl ProcessorData { /// Notes which mods its compat processors name are `loaded`. pub fn mark_loaded(&mut self, loaded: &dyn Fn(&str) -> bool) { - ctov::mark_loaded(self, loaded); + lithostitched::mark_loaded(self, loaded); } pub fn read(zip: &mut zip::ZipArchive) -> Self { @@ -177,8 +177,7 @@ fn carry_at( let mut out = Vec::with_capacity(expanded.len()); for p in expanded { let kind = p["processor_type"].as_str().unwrap_or_default().to_owned(); - // Lithostitched's processors are carried apart from this code - // (`legacy_structure_mods`). + // Lithostitched's processors stay theirs, with what they hold carried. let replacement = lithostitched::processor(&kind, &p, data, carried).or_else(|| { match pillar_type(&kind) { Some(to) => Some(vec![pillar(&p, to, data, carried, depth)]), diff --git a/crates/horizon-port-pack/src/worldgen.rs b/crates/horizon-port-pack/src/worldgen.rs index 298179acf..0e3d968e3 100644 --- a/crates/horizon-port-pack/src/worldgen.rs +++ b/crates/horizon-port-pack/src/worldgen.rs @@ -15,10 +15,10 @@ //! closely. //! //! YUNG's API's files are carried as written ([`crate::yung`]). -//! Lithostitched's and CTOV's worldgen files are converted by -//! `legacy_structure_mods`, called from [`upgrade`], [`crate::carry`] and the -//! processors. -use crate::{legacy_structure_mods::lithostitched, yung}; +//! Lithostitched's jigsaws, elements, modifiers and processors are carried by +//! [`crate::lithostitched`]; the entries CTOV adds to vanilla's structure sets +//! by `legacy_structure_mods`, called from [`crate::carry`]. +use crate::{lithostitched, yung}; use serde_json::Value; use std::{ collections::{BTreeMap, BTreeSet}, @@ -191,28 +191,19 @@ fn drop_java_processors(list: &mut Value, dropped: &mut BTreeMap) let before = processors.len(); processors.retain(|p| { let t = p["processor_type"].as_str().unwrap_or_default(); - let java = !t.starts_with("minecraft:") && !t.starts_with("horizon:"); + let java = !t.starts_with("minecraft:") + && !t.starts_with("horizon:") + && !lithostitched::game_reads(p); if java { *dropped.entry(t.to_owned()).or_default() += 1; } !java }); let mut changed = processors.len() != before; - // The inline lists inside the game's apply_random and condition. + // The inline lists inside Lithostitched's apply_random and condition. for p in processors.iter_mut() { let inner: Vec<&mut Value> = match p["processor_type"].as_str() { - Some("horizon:apply_random") => p["processor_lists"] - .as_array_mut() - .into_iter() - .flatten() - .map(|e| &mut e["data"]) - .collect(), - Some("horizon:condition") => { - let o = p.as_object_mut().into_iter().flat_map(|o| o.iter_mut()); - o.filter(|(k, _)| *k == "then" || *k == "else") - .map(|(_, v)| v) - .collect() - } + Some(t) if t.starts_with("lithostitched:") => lithostitched::inner_lists(p), Some("horizon:pillar" | "horizon:bottom_pillar") => { p.get_mut("pillar_processor_list").into_iter().collect() } @@ -398,7 +389,9 @@ fn upgrade_types( } } for element in elements { - if yung::upgrade_pool_element(element, lost) { + if yung::upgrade_pool_element(element, lost) + || lithostitched::upgrade_pool_element(element, lost) + { changed = true; continue; } diff --git a/crates/horizon-prepare/src/artifacts.rs b/crates/horizon-prepare/src/artifacts.rs index 994cb1a0d..533da0cce 100644 --- a/crates/horizon-prepare/src/artifacts.rs +++ b/crates/horizon-prepare/src/artifacts.rs @@ -1,5 +1,5 @@ //! The player's own game files: the pinned version JSON, client jar and libraries from their -//! official launcher install, and the server jar they downloaded, each checked against +//! official launcher or ATLauncher install, and the server jar they downloaded, each checked against //! research-lock.json before it is copied to `.local/minecraft/` (tools/lab.py's //! `prepare`, which the Python preparer ran first), then checked again on every run //! (tools/test_rust_parity.py's `verify_artifacts`). @@ -12,9 +12,10 @@ use std::path::{Component, Path, PathBuf}; const LAUNCHER_HINT: &str = "Horizon does not download the game: play {version} once in the launcher you play \ -Minecraft Java Edition with (the official launcher, Prism Launcher, MultiMC...) so it downloads \ -the game's files, then rerun. If that launcher keeps them in another folder, pass \ ---minecraft-dir or set HORIZON_MINECRAFT_DIR."; +Minecraft Java Edition with so it downloads the game's files, then rerun. Horizon reads the \ +official launcher's folder, ATLauncher's and the CurseForge app's; for Prism Launcher, MultiMC, \ +the Modrinth App or GDLauncher, prepare from the Horizon launcher, which finds their files. If your launcher keeps \ +them in another folder, pass --minecraft-dir or set HORIZON_MINECRAFT_DIR."; const SERVER_HINT: &str = "Horizon does not download the game: download the {version} server jar yourself (minecraft.net/download/server \ while {version} is the current release, otherwise the downloads.server.url in your launcher's \ versions/{version}/{version}.json), then pass --server-jar PATH or set HORIZON_SERVER_JAR."; @@ -23,11 +24,6 @@ fn hint(text: &str, version: &str) -> String { text.replace("{version}", version) } -/// What to do when the player's launcher install lacks the pinned version's files. -pub(crate) fn launcher_hint(version: &str) -> String { - hint(LAUNCHER_HINT, version) -} - /// research-lock.json and the folder the pinned version's files go to. pub struct Lock { pub json: Value, @@ -134,6 +130,137 @@ pub fn minecraft_dir(chosen: Option<&Path>) -> PathBuf { } } +/// One launcher's copy of the pinned version: its version JSON (Mojang's file, checked by its +/// sha1), the client jar, and the folder holding its `libraries` (at the version JSON's paths) +/// and `assets`. +pub struct GameFiles { + pub folder: PathBuf, + pub manifest: PathBuf, + pub client: PathBuf, + /// Mojang's Java runtimes the launcher downloaded (java::minecraft_runtimes). + pub runtimes: PathBuf, + /// The folders looked in, each with its launcher, when none held the version. + searched: Vec<(&'static str, PathBuf)>, +} + +impl GameFiles { + /// What to do when these files are missing, with the folders looked in. + pub(crate) fn hint(&self, version: &str) -> String { + let mut text = hint(LAUNCHER_HINT, version); + if !self.searched.is_empty() { + text += &format!(" Horizon looked for {version} in:"); + for (launcher, folder) in &self.searched { + text += &format!("\n {} ({launcher})", folder.display()); + } + } + text + } +} + +/// The layouts horizon-prepare reads in `folder`: the official launcher's, then ATLauncher's, +/// which saves Mojang's version JSON as is in `configs/json/minecraft` and the client jar as +/// the library `net.minecraft:client:`. +fn layouts(folder: &Path, version: &str) -> [GameFiles; 2] { + let files = |manifest: String, client: String, runtimes: &str| GameFiles { + folder: folder.to_path_buf(), + manifest: folder.join(manifest), + client: folder.join(client), + runtimes: folder.join(runtimes), + searched: Vec::new(), + }; + let v = version; + [ + files( + format!("versions/{v}/{v}.json"), + format!("versions/{v}/{v}.jar"), + "runtime", + ), + files( + format!("configs/json/minecraft/{v}.json"), + format!("libraries/net/minecraft/client/{v}/client-{v}.jar"), + "runtimes/minecraft", + ), + ] +} + +/// The launchers whose folders are looked in when none is chosen: the official launcher's +/// (`minecraft_dir`), ATLauncher's, then the CurseForge app's `Install` folder, where it runs +/// the official launcher (its default modding folder, `curseforge/minecraft`, is in the home +/// folder on Windows and in Documents elsewhere). ATLauncher keeps its files in its working folder: +/// where its Windows installer puts it, inside the macOS app, and the folders its Linux +/// packages and Flatpak start it in. +fn launcher_folders() -> Vec<(&'static str, PathBuf)> { + let mut folders = vec![("the official launcher", minecraft_dir(None))]; + // The same folders as the Horizon launcher's (launcher/src/sources.rs `known_folders`). + let atlauncher: Vec = if cfg!(target_os = "macos") { + let app = Path::new("Applications/ATLauncher.app/Contents/Java"); + vec![ + home().join("Library/Application Support/ATLauncher"), + Path::new("/").join(app), + home().join(app), + ] + } else if cfg!(windows) { + std::env::var_os("APPDATA") + .map(|d| PathBuf::from(d).join("ATLauncher")) + .into_iter() + .collect() + } else { + let data = std::env::var_os("XDG_DATA_HOME") + .filter(|d| !d.is_empty()) + .map_or_else(|| home().join(".local/share"), PathBuf::from); + let flatpak = home().join(".var/app/com.atlauncher.ATLauncher/data"); + vec![data.join("atlauncher"), flatpak.join("atlauncher"), flatpak] + }; + folders.extend(atlauncher.into_iter().map(|dir| ("ATLauncher", dir))); + let curseforge = if cfg!(windows) { "" } else { "Documents" }; + folders.push(( + "the CurseForge app", + home().join(curseforge).join("curseforge/minecraft/Install"), + )); + folders +} + +/// The pinned version's files in the chosen folder (`--minecraft-dir`, HORIZON_MINECRAFT_DIR), +/// or the launcher above it when an instance folder (`instances/`) is chosen; with no +/// folder chosen, in the first launcher folder that has them. When none does, the official +/// layout of the first folder is returned, for the errors to name, with the folders looked in. +pub fn game_files(chosen: Option<&Path>, version: &str) -> GameFiles { + let chosen = chosen + .filter(|d| !d.as_os_str().is_empty()) + .map(Path::to_path_buf) + .or_else(|| std::env::var_os("HORIZON_MINECRAFT_DIR").map(PathBuf::from)) + .filter(|d| !d.as_os_str().is_empty()) + .map(|d| expand_user(&d)); + let folders = match chosen { + Some(dir) => { + let launcher = dir + .ancestors() + .find(|a| a.file_name().is_some_and(|n| n == "instances")) + .and_then(Path::parent) + .map(Path::to_path_buf); + let mut folders = vec![("the folder chosen", dir)]; + folders.extend(launcher.map(|dir| ("the launcher above it", dir))); + folders + } + None => launcher_folders(), + }; + // A folder with both files first: a version JSON left without its jar is used, for the + // error to name the jar, only when no folder has both. + let complete = |files: &GameFiles| files.manifest.is_file() && files.client.is_file(); + let partial = |files: &GameFiles| files.manifest.is_file(); + for found in [complete, partial] { + let mut all = folders + .iter() + .flat_map(|(_, folder)| layouts(folder, version)); + if let Some(files) = all.find(found) { + return files; + } + } + let [mut files, _] = layouts(&folders[0].1, version); + files.searched = folders; + files +} + /// Copy one file from the player's install, checked like a download; an existing verified /// copy is kept. pub(crate) fn import_copy( @@ -156,17 +283,14 @@ pub(crate) fn import_copy( .commit() } -/// The pinned version JSON from the launcher's versions/ directory. The launcher's copy wins -/// over the cached one so the manifest matches the asset index installed alongside it. -pub(crate) fn import_manifest(lock: &Lock, minecraft: &Path) -> Result { +/// The pinned version JSON from the launcher's install. The launcher's copy wins over the +/// cached one so the manifest matches the asset index installed alongside it. +pub(crate) fn import_manifest(lock: &Lock, files: &GameFiles) -> Result { let version = &lock.version; let destination = lock.directory.join("manifest.json"); - let source = minecraft - .join("versions") - .join(version) - .join(format!("{version}.json")); + let source = &files.manifest; if source.is_file() { - let manifest = read_json(&source)?; + let manifest = read_json(source)?; let downloads = manifest.get("downloads"); let sha1 = |side: &str| { downloads @@ -183,7 +307,7 @@ pub(crate) fn import_manifest(lock: &Lock, minecraft: &Path) -> Result Result, log: Log, ) -> Result<(), String> { - let minecraft = minecraft_dir(minecraft); - let version = &lock.version; - let manifest = import_manifest(lock, &minecraft)?; + let files = game_files(minecraft, &lock.version); + let minecraft = &files.folder; + let manifest = import_manifest(lock, &files)?; let client = import_copy( - &minecraft - .join("versions") - .join(version) - .join(format!("{version}.jar")), + &files.client, &lock.directory.join("jars/client.jar"), lock.pin("client_sha1")?, "sha1", - &hint(LAUNCHER_HINT, version), + &files.hint(&lock.version), )?; let downloads = manifest.get("downloads"); if downloads.and_then(|d| d.get("client_mappings")).is_some() @@ -555,7 +676,7 @@ pub fn import( for (name, artifact) in client_library_artifacts(&manifest)? { let (path, sha1) = artifact_fields(artifact)?; let relative = safe_relative(path).ok_or("Unsafe library path")?; - let source = launcher_library(&minecraft, name, &relative); + let source = launcher_library(minecraft, name, &relative); let destination = lock.directory.join("libraries/client").join(&relative); if runs_without(name) && !source.is_file() && !destination.exists() { log(&format!( @@ -569,7 +690,7 @@ pub fn import( &destination, sha1, "sha1", - &hint(LAUNCHER_HINT, version), + &files.hint(&lock.version), )?); } write_import_metadata( @@ -1122,7 +1243,7 @@ mod tests { let lock = Lock::read(&root).unwrap(); let destination = lock.directory.join("manifest.json"); - let error = import_manifest(&lock, &minecraft).unwrap_err(); + let error = import_manifest(&lock, &game_files(Some(&minecraft), "9.9")).unwrap_err(); assert!(error.contains("may have rewritten it"), "{error}"); assert!( error.contains(&format!("packages/{pinned}/9.9.json")), @@ -1136,7 +1257,7 @@ mod tests { fs::create_dir_all(&lock.directory).unwrap(); fs::copy(root.join("mojang.json"), &destination).unwrap(); - let manifest = import_manifest(&lock, &minecraft).unwrap(); + let manifest = import_manifest(&lock, &game_files(Some(&minecraft), "9.9")).unwrap(); assert!(manifest.get("patches").is_none()); assert_eq!(digest(&destination, "sha1").unwrap(), pinned); fs::remove_dir_all(&root).unwrap(); @@ -1253,6 +1374,103 @@ mod tests { assert!(prepare().unwrap_err().starts_with("Missing ")); } + /// ATLauncher keeps Mojang's version JSON in `configs/json/minecraft` and the client jar as + /// a library; its folder, or one of its instances, prepares like the official launcher's, + /// with the same pins. + #[test] + fn an_atlauncher_install_prepares() { + let fixture = Imports::new(); + let old = fixture.imported(&fixture.source); + let atlauncher = fixture.directory.join("ATLauncher"); + let put = |path: &str, data: &[u8]| { + let path = atlauncher.join(path); + fs::create_dir_all(path.parent().unwrap()).unwrap(); + fs::write(path, data).unwrap(); + }; + let client = fs::read(old.join("jars/client.jar")).unwrap(); + put("libraries/net/minecraft/client/9.9/client-9.9.jar", &client); + put("libraries/client.jar", b"client library"); + put("instances/Minecraft99/instance.json", b"{}"); + // A version JSON left without its jar does not hide the launcher's complete copy. + put("instances/Minecraft99/versions/9.9/9.9.json", b"{}"); + let manifest = fs::read_to_string(old.join("manifest.json")).unwrap(); + let manifest = manifest.replacen('{', r#"{"javaVersion":{"majorVersion":25},"#, 1); + put("configs/json/minecraft/9.9.json", manifest.as_bytes()); + let pinned = digest(&atlauncher.join("configs/json/minecraft/9.9.json"), "sha1").unwrap(); + let lock_path = fixture.target.join("research-lock.json"); + let text = fs::read_to_string(&lock_path).unwrap(); + let old_sha1 = digest(&old.join("manifest.json"), "sha1").unwrap(); + fs::write(&lock_path, text.replace(&old_sha1, &pinned)).unwrap(); + let lock = Lock::read(&fixture.target).unwrap(); + let server = old.join("jars/server.jar"); + let prepare = |dir: &Path| { + let _ = fs::remove_dir_all(&lock.directory); + import(&fixture.target, &lock, Some(dir), Some(&server), &|_| {}) + }; + + for chosen in [atlauncher.clone(), atlauncher.join("instances/Minecraft99")] { + prepare(&chosen).unwrap(); + let artifacts = verify(&lock).unwrap(); + assert_eq!(fs::read(&artifacts.jars["client"]).unwrap(), client); + assert_eq!( + client_libraries(&lock, &artifacts.manifest).unwrap().len(), + 1 + ); + } + let files = game_files(Some(&atlauncher), "9.9"); + assert_eq!(files.runtimes, atlauncher.join("runtimes/minecraft")); + + // The pins gate it as they gate the official layout. + put( + "libraries/net/minecraft/client/9.9/client-9.9.jar", + b"other", + ); + assert!(prepare(&atlauncher) + .unwrap_err() + .contains("is not the pinned file")); + put("libraries/net/minecraft/client/9.9/client-9.9.jar", &client); + put( + "configs/json/minecraft/9.9.json", + manifest.replace(',', ", ").as_bytes(), + ); + assert!(prepare(&atlauncher) + .unwrap_err() + .contains("may have rewritten it")); + } + + /// With no launcher's files in the chosen folder, the error names where Horizon looked and + /// the launchers it reads. + #[test] + fn the_error_names_the_folders_looked_in() { + let fixture = Imports::new(); + let empty = fixture.directory.join("instances/empty"); + fs::create_dir_all(&empty).unwrap(); + let lock = Lock::read(&fixture.target).unwrap(); + let error = import(&fixture.target, &lock, Some(&empty), None, &|_| {}).unwrap_err(); + assert!(error.starts_with(&format!( + "Missing {}", + empty.join("versions/9.9/9.9.json").display() + ))); + assert!(error.contains("Horizon looked for 9.9 in:"), "{error}"); + assert!(error.contains(&format!("\n {} (the folder chosen)", empty.display()))); + assert!(error.contains(&format!( + "\n {} (the launcher above it)", + fixture.directory.display() + ))); + assert!(error.contains("ATLauncher")); + } + + #[test] + fn every_launcher_horizon_reads_is_looked_in() { + let launchers: Vec<_> = launcher_folders() + .into_iter() + .map(|(name, _)| name) + .collect(); + for name in ["the official launcher", "ATLauncher", "the CurseForge app"] { + assert!(launchers.contains(&name), "{name}"); + } + } + #[test] fn runs_without_only_netty_native_transports() { assert!(runs_without( diff --git a/crates/horizon-prepare/src/lib.rs b/crates/horizon-prepare/src/lib.rs index 5d71e8448..830bc4118 100644 --- a/crates/horizon-prepare/src/lib.rs +++ b/crates/horizon-prepare/src/lib.rs @@ -434,7 +434,7 @@ fn prepare_impl(options: &Options, log: Log, compile_only: bool) -> Result = options.java_home.iter().cloned().collect(); homes.extend(java::minecraft_runtimes( - &artifacts::minecraft_dir(options.minecraft_dir.as_deref()).join("runtime"), + &artifacts::game_files(options.minecraft_dir.as_deref(), &lock.version).runtimes, )); let jdk = java::find_runtime(lock.java_major, &homes)?; let reused = if options.import { diff --git a/crates/horizon-prepare/src/sounds.rs b/crates/horizon-prepare/src/sounds.rs index fd171ec12..5c34d9504 100644 --- a/crates/horizon-prepare/src/sounds.rs +++ b/crates/horizon-prepare/src/sounds.rs @@ -1,5 +1,5 @@ //! The pinned version's sounds, title panorama, Unifont glyphs and built-in resource packs -//! from the player's own official launcher install, each object checked against the asset index's SHA-1, copied into +//! from the player's own launcher install, each object checked against the asset index's SHA-1, copied into //! `.local/horizon-client//assets` where the game reads them (tools/fetch_sounds.py and //! the tools/lab.py functions it called). Nothing is downloaded. @@ -18,11 +18,11 @@ use std::path::{Path, PathBuf}; fn launcher_assets( lock: &Lock, manifest: &Value, - minecraft: &Path, + files: &artifacts::GameFiles, cached_index: &Path, log: Log, ) -> Result<(PathBuf, PathBuf, Vec), String> { - let assets = minecraft.join("assets"); + let assets = files.folder.join("assets"); let info = manifest .get("assetIndex") .ok_or("The version JSON has no assetIndex")?; @@ -44,7 +44,7 @@ fn launcher_assets( return Err(format!( "Missing {}. {}", index.display(), - artifacts::launcher_hint(version) + files.hint(version) )); } let bytes = fs::read(&index).map_err(|e| format!("{}: {e}", index.display()))?; @@ -240,13 +240,13 @@ pub(crate) struct Assets { impl Assets { pub(crate) fn load(root: &Path, minecraft: Option<&Path>, log: Log) -> Result { let lock = Lock::read(root)?; - let minecraft = artifacts::minecraft_dir(minecraft); - let manifest = artifacts::import_manifest(&lock, &minecraft)?; + let files = artifacts::game_files(minecraft, &lock.version); + let manifest = artifacts::import_manifest(&lock, &files)?; let target = root.join(".local/horizon-client").join(&lock.version); let (store, index, bytes) = launcher_assets( &lock, &manifest, - &minecraft, + &files, &target.join("asset-index.json"), log, )?; @@ -677,7 +677,11 @@ mod tests { for missing in ["store", "install", "last-object"] { let f = Fixture::new(&format!("optional-panorama-{missing}")); // The JARs and manifest were imported earlier; the launcher need not remain. - artifacts::import_manifest(&Lock::read(&f.root).unwrap(), &f.minecraft).unwrap(); + artifacts::import_manifest( + &Lock::read(&f.root).unwrap(), + &artifacts::game_files(Some(&f.minecraft), "9.9"), + ) + .unwrap(); let target = f.root.join(".local/horizon-client/9.9/assets"); for name in PANORAMA { let path = target.join(name); diff --git a/crates/horizon-protocol/src/item.rs b/crates/horizon-protocol/src/item.rs index abc530278..3d5bacfe9 100644 --- a/crates/horizon-protocol/src/item.rs +++ b/crates/horizon-protocol/src/item.rs @@ -35,6 +35,7 @@ pub mod component { pub const MAP_ID: i32 = 48; pub const MAP_POST_PROCESSING: i32 = 50; pub const CHARGED_PROJECTILES: i32 = 51; + pub const BUNDLE_CONTENTS: i32 = 52; pub const POTION_CONTENTS: i32 = 53; pub const WRITABLE_BOOK_CONTENT: i32 = 56; pub const WRITTEN_BOOK_CONTENT: i32 = 57; @@ -163,7 +164,7 @@ pub struct Profile { pub properties: Vec<(String, String, Option)>, } impl Component { - fn read(kind: i32, r: &mut Reader) -> Result { + pub(crate) fn read(kind: i32, r: &mut Reader) -> Result { use component::*; Ok(match kind { MAX_STACK_SIZE | MAX_DAMAGE | DAMAGE | RARITY | REPAIR_COST | MAP_ID @@ -192,7 +193,7 @@ impl Component { resolved: r.bool()?, }) } - CHARGED_PROJECTILES => { + CHARGED_PROJECTILES | BUNDLE_CONTENTS => { let n = r.count(1024)?; Self::Stacks((0..n).map(|_| Template::read(r)).collect::>()?) } @@ -337,7 +338,7 @@ impl Component { } }) } - fn write(&self, kind: i32, w: &mut Writer) { + pub(crate) fn write(&self, kind: i32, w: &mut Writer) { match self { Self::Raw(bytes) => w.bytes(bytes), Self::Trim { material, pattern } => { @@ -784,6 +785,21 @@ mod tests { assert_eq!(w.data, bytes); } + #[test] + fn bundle_contents_are_item_stack_templates() { + // A bundle (id 7) holding 32 of item 9: BundleContents is a list of + // ItemStackTemplate, as ChargedProjectiles is. + let bytes = [1, 7, 1, 0, 52, 1, 9, 32, 0, 0]; + let stack = Slot::read(&mut Reader::new(&bytes)).unwrap().unwrap(); + assert_eq!( + stack.component(component::BUNDLE_CONTENTS), + Some(&Component::Stacks(vec![Stack::new(9, 32)])) + ); + let mut w = Writer::new(); + Slot::write(&Some(stack), &mut w); + assert_eq!(w.data, bytes); + } + #[test] fn filtered_book_pages_are_read_and_dropped() { // A writable book with one page "hi" and its filtered "**". diff --git a/crates/horizon-protocol/src/lib.rs b/crates/horizon-protocol/src/lib.rs index f0bea2ca2..299688560 100644 --- a/crates/horizon-protocol/src/lib.rs +++ b/crates/horizon-protocol/src/lib.rs @@ -11,6 +11,7 @@ pub mod frame; pub mod ids; pub mod item; pub mod packets; +pub mod quiet; pub mod registry; mod resolver; pub mod rsa; diff --git a/crates/horizon-protocol/src/packets/play.rs b/crates/horizon-protocol/src/packets/play.rs index 1bdf43b08..26bc09a84 100644 --- a/crates/horizon-protocol/src/packets/play.rs +++ b/crates/horizon-protocol/src/packets/play.rs @@ -8,7 +8,7 @@ use crate::{ }, chunk::{ChunkData, LightData}, entity_data::{EntityData, Particle, Value}, - item::{Hashed, HashedSlot, Slot, Stack}, + item::{Component, Hashed, HashedSlot, Slot, Stack}, packet, packet_enum, packets::{ Empty, @@ -88,11 +88,31 @@ packet!(ContainerSetContent { carried: Option => Slot, }); /// ItemCost.STREAM_CODEC: item, count, then the exact component predicate -/// (Horizon sends and reads it as a component patch without removals). +/// (a list of typed component values, with no patch removal count). #[derive(Clone, Debug, PartialEq)] pub struct NetCost { pub item: i32, pub count: i32, + pub components: Vec<(i32, Component)>, +} +impl From for NetCost { + fn from(stack: Stack) -> Self { + Self { + item: stack.item, + count: stack.count, + components: stack.added, + } + } +} +impl From for Stack { + fn from(cost: NetCost) -> Self { + Self { + item: cost.item, + count: cost.count, + added: cost.components, + removed: Vec::new(), + } + } } /// MerchantOffer.STREAM_CODEC. #[derive(Clone, Debug, PartialEq)] @@ -114,10 +134,17 @@ impl Codec> for Offers { fn cost(r: &mut Reader) -> Result { let item = r.varint()?; let count = r.varint()?; - if r.varint()? != 0 { - return Err(Error::new("item cost components are not supported")); + let n = r.count(r.remaining())?; + let mut components = Vec::with_capacity(n.min(64)); + for _ in 0..n { + let kind = r.varint()?; + components.push((kind, Component::read(kind, r)?)); } - Ok(NetCost { item, count }) + Ok(NetCost { + item, + count, + components, + }) } let n = r.count(r.remaining())?; let mut out = Vec::with_capacity(n.min(64)); @@ -144,7 +171,11 @@ impl Codec> for Offers { fn cost(c: &NetCost, w: &mut Writer) { w.varint(c.item); w.varint(c.count); - w.varint(0); + w.varint(c.components.len() as i32); + for (kind, value) in &c.components { + w.varint(*kind); + value.write(*kind, w); + } } w.varint(v.len() as i32); for o in v { @@ -2300,6 +2331,39 @@ mod tests { use super::*; use crate::{chunk::BlockEntityInfo, packets::round_trip, text::literal}; + #[test] + fn merchant_cost_predicate_is_a_typed_list_without_patch_counts() { + // ItemCost.STREAM_CODEC: item=7, count=1, one typed component, + // potion_contents=53, potion present (water=0), no color/effects/name. + // Result: count=1, item=8, empty component patch. Secondary cost: + // item=9, count=2, empty predicate, followed by the offer fields. + let mut bytes = vec![1, 7, 1, 1, 53, 1, 0, 0, 0, 0, 1, 8, 0, 0, 1, 9, 2, 0, 0]; + bytes.extend_from_slice(&[0; 4]); // uses + bytes.extend_from_slice(&2i32.to_be_bytes()); // max uses + bytes.extend_from_slice(&[0; 16]); // xp, special price, multiplier, demand + let mut r = Reader::new(&bytes); + let offers = Offers::read(&mut r).unwrap(); + assert_eq!(r.remaining(), 0); + assert_eq!( + offers[0].cost_a.components, + vec![( + 53, + Component::Potion { + potion: Some(0), + color: None, + rest: Vec::new() + } + )] + ); + assert!(offers[0].cost_b.as_ref().unwrap().components.is_empty()); + let mut w = Writer::new(); + Offers::write(&offers, &mut w); + assert_eq!(w.data, bytes); + for len in 0..bytes.len() { + assert!(Offers::read(&mut Reader::new(&bytes[..len])).is_err()); + } + } + #[test] fn serverbound_abilities_carry_only_flying() { // ServerboundPlayerAbilitiesPacket.write: one byte, 2 when flying. @@ -2576,9 +2640,9 @@ mod tests { Clientbound::MerchantOffers(MerchantOffers { container: 3, offers: vec![NetOffer { - cost_a: NetCost { item: 5, count: 24 }, + cost_a: Stack::new(5, 24).into(), result: Stack::new(7, 1), - cost_b: Some(NetCost { item: 9, count: 1 }), + cost_b: Some(Stack::new(9, 1).into()), out_of_stock: false, uses: 2, max_uses: 16, diff --git a/crates/horizon-protocol/src/quiet.rs b/crates/horizon-protocol/src/quiet.rs new file mode 100644 index 000000000..dcf48dbee --- /dev/null +++ b/crates/horizon-protocol/src/quiet.rs @@ -0,0 +1,166 @@ +//! Quiet commands: a client mod's batch of commands that a Horizon server runs +//! as the player who sent them, at that player's own permission level, with +//! no feedback in the chat (docs/mods.md, `command.run-quiet`). +//! +//! The server announces it understands them with an empty [`CHANNEL`] payload +//! in the configuration phase (a vanilla client ignores it); a client that +//! hears it sends each batch as a serverbound [`CHANNEL`] payload, and falls +//! back to chat commands on any other server. A payload is the mod's id, then +//! the lines without their slash. +use crate::{ + Error, Result, + buf::{Reader, Writer}, +}; + +/// The custom payload channel, both ways. +pub const CHANNEL: &str = "horizon:quiet_commands"; +/// Lines in one payload at most; a payload with more is refused whole. +pub const MAX_LINES: usize = 256; +/// Characters in a line at most (a chat command's limit). +pub const MAX_LINE: usize = 256; +/// Characters in a mod id at most. +pub const MAX_MOD_ID: usize = 64; +/// Bytes of a serverbound custom payload's data at most +/// (ServerboundCustomPayloadPacket.MAX_PAYLOAD_SIZE). +pub const MAX_PAYLOAD: usize = 32767; + +/// A batch as the server reads it. +#[derive(Clone, Debug, PartialEq)] +pub struct Batch { + pub mod_id: String, + pub lines: Vec, +} + +/// `lines` as few payloads as fit [`MAX_PAYLOAD`] and [`MAX_LINES`], in +/// order. Lines longer than [`MAX_LINE`] are cut, as a chat command's are. +pub fn encode(mod_id: &str, lines: &[String]) -> Vec> { + let mod_id: String = mod_id.chars().take(MAX_MOD_ID).collect(); + let mut payloads = Vec::new(); + let mut rest = lines + .iter() + .map(|l| -> String { l.chars().take(MAX_LINE).collect() }); + let mut next = rest.next(); + while next.is_some() { + let mut batch = Vec::new(); + // The id, the count (a varint of at most 2 bytes for 256). + let mut size = string_size(&mod_id) + 2; + while let Some(line) = next.take() { + let more = string_size(&line); + if !batch.is_empty() && (batch.len() == MAX_LINES || size + more > MAX_PAYLOAD) { + next = Some(line); + break; + } + size += more; + batch.push(line); + next = rest.next(); + } + let mut w = Writer::new(); + w.string(&mod_id); + w.varint(batch.len() as i32); + for line in &batch { + w.string(line); + } + payloads.push(w.data); + } + payloads +} + +fn string_size(s: &str) -> usize { + crate::buf::varint_size(s.len() as i32) + s.len() +} + +/// A payload's batch; an error for one that breaks a cap. +pub fn decode(data: &[u8]) -> Result { + if data.len() > MAX_PAYLOAD { + return Err(Error::new("quiet commands: payload too big")); + } + let mut r = Reader::new(data); + let mod_id = r.string(MAX_MOD_ID)?; + let count = r.varint()?; + if !(0..=MAX_LINES as i32).contains(&count) { + return Err(Error::new(format!("quiet commands: {count} lines"))); + } + let lines = (0..count) + .map(|_| r.string(MAX_LINE)) + .collect::>>()?; + if r.remaining() > 0 { + return Err(Error::new("quiet commands: trailing bytes")); + } + Ok(Batch { mod_id, lines }) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn a_batch_round_trips() { + let lines = vec!["fill 0 0 0 1 1 1 stone".to_string(), "say hi".to_string()]; + let payloads = encode("orbital", &lines); + assert_eq!(payloads.len(), 1); + assert_eq!( + decode(&payloads[0]).unwrap(), + Batch { + mod_id: "orbital".into(), + lines + } + ); + } + + #[test] + fn big_batches_split_by_lines_and_bytes() { + let lines: Vec = (0..600) + .map(|i| format!("setblock {i} 0 0 stone")) + .collect(); + let payloads = encode("m", &lines); + let decoded: Vec = payloads.iter().map(|p| decode(p).unwrap()).collect(); + assert_eq!( + decoded.iter().map(|b| b.lines.len()).collect::>(), + [256, 256, 88] + ); + assert_eq!( + decoded + .into_iter() + .flat_map(|b| b.lines) + .collect::>(), + lines + ); + let long: Vec = (0..256).map(|_| "x".repeat(300)).collect(); + for p in encode("m", &long) { + assert!(p.len() <= MAX_PAYLOAD); + assert!( + decode(&p) + .unwrap() + .lines + .iter() + .all(|l| l.len() == MAX_LINE) + ); + } + } + + #[test] + fn payloads_over_the_caps_are_refused() { + let mut w = Writer::new(); + w.string("m"); + w.varint(MAX_LINES as i32 + 1); + for _ in 0..=MAX_LINES { + w.string("say"); + } + assert!(decode(&w.data).is_err()); + let mut w = Writer::new(); + w.string("m"); + w.varint(1); + w.string(&"x".repeat(MAX_LINE + 1)); + assert!(decode(&w.data).is_err()); + let mut w = Writer::new(); + w.string("m"); + w.varint(-1); + assert!(decode(&w.data).is_err()); + assert!(decode(&[0xFF]).is_err()); + let mut w = Writer::new(); + w.string("m"); + w.varint(0); + w.u8(1); + assert!(decode(&w.data).is_err()); + } +} diff --git a/crates/horizon-server/panel/panel.css b/crates/horizon-server/panel/panel.css index 7946b5f8f..994f5eac6 100644 --- a/crates/horizon-server/panel/panel.css +++ b/crates/horizon-server/panel/panel.css @@ -1,4 +1,4 @@ -/* The Horizon server panel. Colours and spacing are horizon-theme's tokens (website/src/tokens.css). */ +/* The Horizon server panel. Colours and spacing are horizon-theme's tokens (crates/horizon-theme/tokens.css). */ :root { --page: #fafafc; --plate-soft: #f3f3f8; diff --git a/crates/horizon-shader-api/src/check.rs b/crates/horizon-shader-api/src/check.rs index 6c43718f7..c3ecdd158 100644 --- a/crates/horizon-shader-api/src/check.rs +++ b/crates/horizon-shader-api/src/check.rs @@ -60,6 +60,10 @@ pub struct CheckedStage { pub label: String, pub module: naga::Module, pub info: ModuleInfo, + /// The stage's WGSL without the entry points (the prelude, the shared + /// files, the file), for a renderer that calls the stage function from + /// its own shader (the sky). + pub source: String, pub expressions: usize, pub texture_reads: usize, } @@ -169,6 +173,7 @@ pub fn check_stage(pack: &Pack, kind: StageKind, file: &str) -> Result, } -/// Players' groups of at least `min_installs` installs, as `website/scripts/benchmarks.mjs` makes them. +/// Players' groups of at least `min_installs` installs, as the website's `scripts/benchmarks.mjs` makes them. pub fn groups(uploads: &[Upload], min_installs: usize) -> Vec { let mut by: BTreeMap<(String, String, i64, &str), Group> = BTreeMap::new(); for u in uploads { diff --git a/website/scripts/fixtures/benchmarks/README.md b/crates/horizon-telemetry-server/tests/fixtures/benchmarks/README.md similarity index 72% rename from website/scripts/fixtures/benchmarks/README.md rename to crates/horizon-telemetry-server/tests/fixtures/benchmarks/README.md index 562646a6f..51ebb9aac 100644 --- a/website/scripts/fixtures/benchmarks/README.md +++ b/crates/horizon-telemetry-server/tests/fixtures/benchmarks/README.md @@ -1,7 +1,8 @@ # Benchmark summary fixtures -Shared by the website's aggregator test (`website/scripts/benchmarks.test.mjs`) and the telemetry server's -`GET /v1/benchmarks/summary` test: the same `benchmark` items in, the same groups out. +Used by the telemetry server's `GET /v1/benchmarks/summary` test (`tests/summary.rs`) and, as a copy, by the +website's aggregator test (`scripts/benchmarks.test.mjs` in ludovic111/horizon-site, which checks its copy against +this one on main): the same `benchmark` items in, the same groups out. Change both together. - `items.jsonl`: one stored item per line (`install_id`, `day`, `version`, `data`: a benchmark report). Group RTX 4080 + i7-13700KF at render distance 12 has three installs (one with two runs); the same install at 32, diff --git a/website/scripts/fixtures/benchmarks/expected.json b/crates/horizon-telemetry-server/tests/fixtures/benchmarks/expected.json similarity index 100% rename from website/scripts/fixtures/benchmarks/expected.json rename to crates/horizon-telemetry-server/tests/fixtures/benchmarks/expected.json diff --git a/website/scripts/fixtures/benchmarks/items.jsonl b/crates/horizon-telemetry-server/tests/fixtures/benchmarks/items.jsonl similarity index 100% rename from website/scripts/fixtures/benchmarks/items.jsonl rename to crates/horizon-telemetry-server/tests/fixtures/benchmarks/items.jsonl diff --git a/crates/horizon-telemetry-server/tests/summary.rs b/crates/horizon-telemetry-server/tests/summary.rs index 3232b4f87..88ae2b283 100644 --- a/crates/horizon-telemetry-server/tests/summary.rs +++ b/crates/horizon-telemetry-server/tests/summary.rs @@ -1,5 +1,5 @@ -//! `GET /v1/benchmarks/summary` against the website's fixtures (website/scripts/fixtures/benchmarks/): the same -//! uploads must give the groups `website/scripts/benchmarks.mjs` gives. +//! `GET /v1/benchmarks/summary` against the shared fixtures (tests/fixtures/benchmarks/): the same uploads must +//! give the groups the website's `scripts/benchmarks.mjs` (ludovic111/horizon-site) gives on its copy of them. use std::sync::Arc; use std::sync::atomic::AtomicU32; @@ -15,10 +15,7 @@ use http_body_util::BodyExt; use serde_json::Value; use tower::ServiceExt; -const FIXTURES: &str = concat!( - env!("CARGO_MANIFEST_DIR"), - "/../../website/scripts/fixtures/benchmarks" -); +const FIXTURES: &str = concat!(env!("CARGO_MANIFEST_DIR"), "/tests/fixtures/benchmarks"); fn items() -> Vec { std::fs::read_to_string(format!("{FIXTURES}/items.jsonl")) diff --git a/crates/horizon-theme/icons/pixel/star.svg b/crates/horizon-theme/icons/pixel/star.svg new file mode 100644 index 000000000..a27348730 --- /dev/null +++ b/crates/horizon-theme/icons/pixel/star.svg @@ -0,0 +1,3 @@ + + + diff --git a/crates/horizon-theme/src/lib.rs b/crates/horizon-theme/src/lib.rs index dac5bf8d2..b41536e5e 100644 --- a/crates/horizon-theme/src/lib.rs +++ b/crates/horizon-theme/src/lib.rs @@ -1,6 +1,6 @@ //! Horizon's design tokens, the one source of truth for the launcher (`launcher/src/theme.rs`), -//! the game's on-screen keyboard (`horizon-client`'s `ui_theme`) and the website (`website/src/tokens.css`, -//! generated from [`css`] by `cargo run -p xtask -- tokens`). Change a value here and all three +//! the game's on-screen keyboard (`horizon-client`'s `ui_theme`) and the website (`tokens.css` in this crate, +//! generated from [`css`] by `cargo run -p xtask -- tokens`, which the site's build reads from main). Change a value here and all three //! follow. The system is described in `docs/design-system.md`. //! //! Cool neutrals in two appearances and one violet accent; Geist and Geist Mono only, bundled @@ -67,6 +67,8 @@ pub mod icons { "search", "server", "sliders", + // Not Pixelarticons': drawn for Horizon's ratings, in the same 2-unit grid. + "star", "terminal", "trash", "user", @@ -526,7 +528,7 @@ pub fn contrast(a: u32, b: u32) -> f32 { (x.max(y) + 0.05) / (x.min(y) + 0.05) } -/// `website/src/tokens.css`: every token as a CSS custom property, the light palette by +/// `tokens.css`: every token as a CSS custom property, the light palette by /// default, the dark one when the system asks for it or the page sets `data-theme="dark"`. pub fn css() -> String { let mut s = String::new(); @@ -769,15 +771,15 @@ mod tests { assert!((bezier([0., 0., 1., 1.], 0.3) - 0.3).abs() < 1e-3); } - /// `website/src/tokens.css` is what [`css`] writes; regenerate it with - /// `cargo run -p xtask -- tokens`. + /// `tokens.css` (beside Cargo.toml, read by the website's build) is what [`css`] writes; + /// regenerate it with `cargo run -p xtask -- tokens`. #[test] - fn website_tokens_are_up_to_date() { - let path = concat!(env!("CARGO_MANIFEST_DIR"), "/../../website/src/tokens.css"); + fn tokens_css_is_up_to_date() { + let path = concat!(env!("CARGO_MANIFEST_DIR"), "/tokens.css"); let written = std::fs::read_to_string(path).unwrap_or_default(); assert!( written == css(), - "website/src/tokens.css is out of date: run `cargo run -p xtask -- tokens`" + "crates/horizon-theme/tokens.css is out of date: run `cargo run -p xtask -- tokens`" ); } } diff --git a/website/src/tokens.css b/crates/horizon-theme/tokens.css similarity index 100% rename from website/src/tokens.css rename to crates/horizon-theme/tokens.css diff --git a/crates/horizon-world/examples/probe/main.rs b/crates/horizon-world/examples/probe/main.rs index 479a3ed23..b87e5620a 100644 --- a/crates/horizon-world/examples/probe/main.rs +++ b/crates/horizon-world/examples/probe/main.rs @@ -169,6 +169,7 @@ mod stored_effect_attributes_fixture; mod stored_effect_notifications_fixture; mod structure_density_fixture; mod structure_pieces; +mod structure_start_nbt; mod suffocation_fixture; mod swimming_fixture; mod synced_bytes_fixture; @@ -340,6 +341,7 @@ probes! { stored_effect_notifications_fixture, structure_density_fixture, structure_pieces, + structure_start_nbt, suffocation_fixture, swimming_fixture, synced_bytes_fixture, diff --git a/crates/horizon-world/examples/probe/structure_pieces.rs b/crates/horizon-world/examples/probe/structure_pieces.rs index ebbad9c7a..3b1415da5 100644 --- a/crates/horizon-world/examples/probe/structure_pieces.rs +++ b/crates/horizon-world/examples/probe/structure_pieces.rs @@ -21,7 +21,7 @@ use std::{fs, path::Path}; type Error = Box; -fn registry(resources: &Path) -> Result<&'static BlockRegistry, Error> { +pub fn registry(resources: &Path) -> Result<&'static BlockRegistry, Error> { let facts: Value = serde_json::from_str(&fs::read_to_string(resources.join("facts.json"))?)?; let states = facts["states"].as_array().ok_or("facts states")?; let registry = BlockRegistry::from_nbt(&Tag::compound([ diff --git a/crates/horizon-world/examples/probe/structure_start_nbt.rs b/crates/horizon-world/examples/probe/structure_start_nbt.rs new file mode 100644 index 000000000..daea17314 --- /dev/null +++ b/crates/horizon-world/examples/probe/structure_start_nbt.rs @@ -0,0 +1,74 @@ +//! The structure starts a chunk owns, as `StructureStart.createTag` saves them. +//! +//! structure_start_nbt ... +//! prints `nbt CX CZ TAG` for every start whose chunk is a target, the tag +//! with sorted keys and typed numbers (VanillaStructureStartOracle's +//! `canonical`), or `unsaved CX CZ ID` when Horizon cannot save it yet. +use horizon_core::position::ChunkPos; +use horizon_world::{ + nbt::Tag, + worldgen::generator::{GeneratorData, OverworldGenerator}, +}; + +type Error = Box; + +/// `VanillaStructureStartOracle.canonical`. +fn canonical(tag: &Tag) -> String { + let join = |parts: Vec| parts.join(","); + match tag { + Tag::Compound(c) => { + let mut keys: Vec<_> = c.keys().map(|k| (k.to_string_lossy(), k)).collect(); + keys.sort_by(|a, b| a.0.encode_utf16().cmp(b.0.encode_utf16())); + let parts = keys + .into_iter() + .map(|(name, key)| format!("{name}:{}", canonical(&c[key]))) + .collect(); + format!("{{{}}}", join(parts)) + } + Tag::List(l) => format!("[{}]", join(l.iter().map(canonical).collect())), + Tag::Byte(v) => format!("{v}b"), + Tag::Short(v) => format!("{v}s"), + Tag::Int(v) => v.to_string(), + Tag::Long(v) => format!("{v}L"), + Tag::Float(bits) => format!("{}f", *bits as i32), + Tag::Double(bits) => format!("{}d", *bits as i64), + Tag::String(s) => format!( + "\"{}\"", + s.to_string_lossy() + .replace('\\', "\\\\") + .replace('"', "\\\"") + ), + Tag::IntArray(a) => format!("[I;{}]", join(a.iter().map(i32::to_string).collect())), + Tag::LongArray(a) => format!("[L;{}]", join(a.iter().map(i64::to_string).collect())), + Tag::ByteArray(a) => format!( + "[B;{}]", + join(a.iter().map(|b| (*b as i8).to_string()).collect()) + ), + Tag::End => "END".into(), + } +} + +pub fn main() -> Result<(), Error> { + let mut args = crate::args().skip(1); + let resources = std::path::PathBuf::from(args.next().ok_or("client resource directory")?); + let seed: i64 = args.next().ok_or("seed")?.parse()?; + let dimension = format!("minecraft:{}", args.next().ok_or("dimension")?); + let registry = crate::structure_pieces::registry(&resources)?; + let data = GeneratorData::load(&resources.join("worldgen"), registry)?; + let generator = OverworldGenerator::for_dimension(data, seed, "minecraft:normal", &dimension)?; + let mut worker = generator.worker(); + for target in args { + let (x, z) = target.split_once(',').ok_or("target cx,cz")?; + let chunk = ChunkPos::new(x.parse()?, z.parse()?); + for start in worker.structure_starts(chunk) { + if start.chunk != chunk { + continue; + } + match start.save() { + Some(tag) => println!("nbt {} {} {}", chunk.x, chunk.z, canonical(&tag)), + None => println!("unsaved {} {} {}", chunk.x, chunk.z, start.name), + } + } + } + Ok(()) +} diff --git a/crates/horizon-world/src/level/data.rs b/crates/horizon-world/src/level/data.rs index e0ef0dca1..4635e8b05 100644 --- a/crates/horizon-world/src/level/data.rs +++ b/crates/horizon-world/src/level/data.rs @@ -16,7 +16,7 @@ use serde_json::Value; use std::{ collections::HashMap, fs::{self, File}, - io::{self, BufReader}, + io, path::Path, sync::Arc, }; @@ -582,8 +582,10 @@ fn fail(message: &str) -> io::Error { invalid(message) } +/// From the file's bytes in memory: several times faster than through a +/// reader on gameplay-facts.json (55 MB), which a first start parses. fn read_json(path: &Path) -> io::Result { - serde_json::from_reader(BufReader::new(File::open(path)?)).map_err(|e| invalid(e.to_string())) + serde_json::from_slice(&fs::read(path)?).map_err(|e| invalid(e.to_string())) } fn interned(cache: &mut HashMap>, text: &str) -> Arc { diff --git a/crates/horizon-world/src/level/mod.rs b/crates/horizon-world/src/level/mod.rs index 3831efbd6..41b325768 100644 --- a/crates/horizon-world/src/level/mod.rs +++ b/crates/horizon-world/src/level/mod.rs @@ -114,6 +114,7 @@ mod place; mod portal; pub mod portal_travel; mod query; +pub(crate) use query::data_2d; mod rails; mod redstone; pub mod removal; diff --git a/crates/horizon-world/src/living_motion.rs b/crates/horizon-world/src/living_motion.rs index b44da8b7b..9c496ed63 100644 --- a/crates/horizon-world/src/living_motion.rs +++ b/crates/horizon-world/src/living_motion.rs @@ -122,3 +122,119 @@ pub fn air_drag(world: &mut W) -> Result { }; Ok(modified_friction(drag, world.air_drag_modifier()? as f32)) } + +#[cfg(test)] +mod tests { + use super::*; + use horizon_core::geometry::{Vec3, trig}; + + struct Jumper { + velocity: Vec3, + sprinting: bool, + yaw: f32, + synced: bool, + } + impl LivingMotionWorld for Jumper { + type Error = (); + fn velocity(&self) -> Vec3 { + self.velocity + } + fn set_velocity(&mut self, velocity: Vec3) -> Result<(), ()> { + self.velocity = velocity; + Ok(()) + } + fn jump_strength(&mut self) -> Result { + Ok(0.42) + } + fn block_jump_factor(&mut self) -> Result { + Ok(1.0) + } + fn has_jump_boost(&mut self) -> Result { + Ok(false) + } + fn jump_boost_amplifier(&mut self) -> Result { + Ok(0) + } + fn sprinting(&mut self) -> Result { + Ok(self.sprinting) + } + fn yaw(&mut self) -> Result { + Ok(self.yaw) + } + fn mark_needs_sync(&mut self) { + self.synced = true; + } + fn no_gravity(&mut self) -> Result { + Ok(false) + } + fn gravity_attribute(&mut self) -> Result { + Ok(0.08) + } + fn has_slow_falling(&mut self) -> Result { + Ok(false) + } + fn controlling_passenger_is_player(&mut self) -> Result { + Ok(false) + } + fn speed(&mut self) -> Result { + Ok(0.1) + } + fn omnidirectional_air_mover(&mut self) -> Result { + Ok(false) + } + fn air_drag_modifier(&mut self) -> Result { + Ok(0.0) + } + } + + fn impulse(yaw: f32) -> (f64, f64) { + let angle = f64::from(yaw * trig::DEG_TO_RAD); + ( + f64::from(-trig::sin(angle)) * 0.2, + f64::from(trig::cos(angle)) * 0.2, + ) + } + + /// LivingEntity.jumpFromGround: a sprint adds ~0.2 along look; a walk does not. + #[test] + fn sprint_jump_adds_look_direction_impulse() { + for yaw in [0.0, 45.0, 90.0, 180.0, 270.0, 300.0] { + let before = Vec3::new(0.13, -0.08, -0.05); + let mut sprinting = Jumper { + velocity: before, + sprinting: true, + yaw, + synced: false, + }; + jump_from_ground(&mut sprinting).unwrap(); + let (dx, dz) = impulse(yaw); + let horizontal = ((dx * dx) + (dz * dz)).sqrt(); + assert!( + (horizontal - 0.2).abs() < 1.0e-4, + "yaw {yaw}: impulse length {horizontal}" + ); + assert!( + (sprinting.velocity.x - (before.x + dx)).abs() < 1.0e-9, + "yaw {yaw}: x {:?} expected {}", + sprinting.velocity, + before.x + dx + ); + assert!((sprinting.velocity.z - (before.z + dz)).abs() < 1.0e-9); + // jump_power narrows the 0.42 strength through float, as vanilla does. + let jump_y = f64::from(0.42_f32); + assert!((sprinting.velocity.y - jump_y).abs() < 1.0e-9); + assert!(sprinting.synced); + + let mut walking = Jumper { + velocity: before, + sprinting: false, + yaw, + synced: false, + }; + jump_from_ground(&mut walking).unwrap(); + assert_eq!(walking.velocity.x, before.x); + assert_eq!(walking.velocity.z, before.z); + assert!((walking.velocity.y - jump_y).abs() < 1.0e-9); + } + } +} diff --git a/crates/horizon-world/src/worldgen/generator.rs b/crates/horizon-world/src/worldgen/generator.rs index 316bd837c..7a38608be 100644 --- a/crates/horizon-world/src/worldgen/generator.rs +++ b/crates/horizon-world/src/worldgen/generator.rs @@ -269,6 +269,20 @@ fn quantize_parameter_report(json: &str) -> Result { } Ok(Value::Array(entries).to_string()) } +/// `load` on a thread of its own ("Worldgen loader"). +fn loading( + load: impl FnOnce() -> T + Send + 'static, +) -> io::Result> { + std::thread::Builder::new() + .name("Worldgen loader".into()) + .spawn(load) +} +/// A loading thread's result; its panic goes on in this thread. +fn joined(thread: std::thread::JoinHandle) -> T { + thread + .join() + .unwrap_or_else(|panic| std::panic::resume_unwind(panic)) +} impl GeneratorData { /// Load a worldgen bundle directory. Required files are JSON objects mapping /// resource identifiers to the resource's JSON text: `noises`, `densities`, @@ -290,6 +304,50 @@ impl GeneratorData { let block_tags = build_tags(&read_bundle(dir, "block_tags")?, |id| { registry.default_state(id).is_some() })?; + let fluid_tags = match read_optional_bundle(dir, "fluid_tags")? { + Some(raw) => build_tags(&raw, |id| { + matches!( + id, + "minecraft:water" + | "minecraft:flowing_water" + | "minecraft:lava" + | "minecraft:flowing_lava" + | "minecraft:empty" + ) + })?, + None => BTreeMap::new(), + }; + // The three biggest reads (the block tables, the structure templates + // and the block behaviours) need only the tags: they run on threads of + // their own while this one reads the rest. A new world's first chunks + // wait for all of it, with the chunk workers idle. + let blocks = loading({ + let (dir, tags, fluids) = (dir.join("blocks"), block_tags.clone(), fluid_tags.clone()); + move || super::generator_blocks::BlockBehavior::load(&dir, registry, &tags, &fluids) + })?; + let structures = loading({ + let (dir, tags) = (dir.to_owned(), block_tags.clone()); + move || -> Result<_, GeneratorError> { + let Ok(json) = fs::read_to_string(dir.join("blocks/structure-blocks.json")) else { + return Ok(None); + }; + Ok(Some(Arc::new(super::structure::StructureResources::new( + registry, + super::structure::StateTransforms::from_json(&json, registry.len())?, + &dir.join("structure"), + read_optional_bundle(&dir, "processor_lists")?.unwrap_or_default(), + &tags, + )))) + } + })?; + let behaviours = loading({ + let root = dir.parent().map(Path::to_owned); + move || { + root.filter(|root| root.join("block-behaviours.json").exists()) + .and_then(|root| crate::level::Behaviours::load(registry, &root).ok()) + .map(Arc::new) + } + })?; let tag_set = |name: &str| -> Result, GeneratorError> { Ok(block_tags .get(name) @@ -382,47 +440,17 @@ impl GeneratorData { read_optional_bundle(dir, "features")?, read_optional_bundle(dir, "placed_features")?, ) { - (Some(features), Some(placed)) => { - let fluid_tags = match read_optional_bundle(dir, "fluid_tags")? { - Some(raw) => build_tags(&raw, |id| { - matches!( - id, - "minecraft:water" - | "minecraft:flowing_water" - | "minecraft:lava" - | "minecraft:flowing_lava" - | "minecraft:empty" - ) - })?, - None => BTreeMap::new(), - }; - Some(FeatureResources { - features, - placed, - feature_tags: read_optional_bundle(dir, "feature_tags")?.unwrap_or_default(), - blocks: super::generator_blocks::BlockBehavior::load( - &dir.join("blocks"), - registry, - &block_tags, - &fluid_tags, - )?, - fluid_tags, - state_providers: read_optional_bundle(dir, "state_providers")? - .unwrap_or_default(), - }) - } + (Some(features), Some(placed)) => Some(FeatureResources { + features, + placed, + feature_tags: read_optional_bundle(dir, "feature_tags")?.unwrap_or_default(), + blocks: joined(blocks)?, + fluid_tags, + state_providers: read_optional_bundle(dir, "state_providers")?.unwrap_or_default(), + }), _ => None, }; - let structures = match fs::read_to_string(dir.join("blocks/structure-blocks.json")) { - Ok(json) => Some(Arc::new(super::structure::StructureResources::new( - registry, - super::structure::StateTransforms::from_json(&json, registry.len())?, - &dir.join("structure"), - read_optional_bundle(dir, "processor_lists")?.unwrap_or_default(), - &block_tags, - ))), - Err(_) => None, - }; + let structures = joined(structures)?; let structure_resources = match ( read_optional_bundle(dir, "structures")?, read_optional_bundle(dir, "structure_sets")?, @@ -435,11 +463,7 @@ impl GeneratorData { }), _ => None, }; - let behaviours = dir - .parent() - .filter(|root| root.join("block-behaviours.json").exists()) - .and_then(|root| crate::level::Behaviours::load(registry, root).ok()) - .map(Arc::new); + let behaviours = joined(behaviours); Ok(Arc::new(Self { behaviours, structure_resources, @@ -594,6 +618,15 @@ impl ProtoChunk { pub fn is_decorated(&self) -> bool { self.decorated } + /// The structure starts this chunk holds itself (`structures.starts`). + pub fn own_starts(&self) -> Vec> { + let pos = self.position(); + self.structure_starts + .iter() + .filter(|s| s.chunk == pos) + .cloned() + .collect() + } /// Also restores a saved proto chunk that was decorated before it was saved. pub fn set_decorated(&mut self) { self.decorated = true; diff --git a/crates/horizon-world/src/worldgen/generator_blocks.rs b/crates/horizon-world/src/worldgen/generator_blocks.rs index ed1182f36..7498b9e66 100644 --- a/crates/horizon-world/src/worldgen/generator_blocks.rs +++ b/crates/horizon-world/src/worldgen/generator_blocks.rs @@ -108,15 +108,26 @@ impl BlockBehavior { let json = |name: &str| -> Result { Ok(serde_json::from_str(&fs::read_to_string(dir.join(name))?)?) }; - let collisions = - CachedCollisionRegistry::from_table(read("cached-collision.nbt")?.table("collision")?)?; - let properties = BlockPropertiesRegistry::from_table( - read("block-properties.nbt")?.table("block property")?, - &collisions, - )?; - let support = Arc::new(BlockSupportRegistry::from_table( - read("cached-support.nbt")?.table("support")?, - )?); + // The support table reads on its own thread while the collision and + // property tables (which need the collisions) read on this one. + let (collisions, properties, support) = std::thread::scope(|scope| { + let support = scope.spawn(|| -> Result<_, GeneratorError> { + Ok(BlockSupportRegistry::from_table( + read("cached-support.nbt")?.table("support")?, + )?) + }); + let collisions = CachedCollisionRegistry::from_table( + read("cached-collision.nbt")?.table("collision")?, + )?; + let properties = BlockPropertiesRegistry::from_table( + read("block-properties.nbt")?.table("block property")?, + &collisions, + )?; + let support = support + .join() + .unwrap_or_else(|panic| std::panic::resume_unwind(panic))?; + Ok::<_, GeneratorError>((collisions, properties, Arc::new(support))) + })?; let collision = Arc::new(BlockCollisionRegistry::new(Arc::new(collisions))?); let rules = json("survival-rules.json")? .as_object() diff --git a/crates/horizon-world/src/worldgen/structure.rs b/crates/horizon-world/src/worldgen/structure.rs index e0ac4d9e8..c998cc3be 100644 --- a/crates/horizon-world/src/worldgen/structure.rs +++ b/crates/horizon-world/src/worldgen/structure.rs @@ -79,6 +79,15 @@ impl Rotation { pub fn get_rotated(self, other: Self) -> Self { Self::ALL[(self as usize + other as usize) % 4] } + /// `Rotation.name()`, as structure pieces save it. + pub fn saved_name(self) -> &'static str { + match self { + Self::None => "NONE", + Self::Clockwise90 => "CLOCKWISE_90", + Self::Clockwise180 => "CLOCKWISE_180", + Self::Counterclockwise90 => "COUNTERCLOCKWISE_90", + } + } } #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)] pub enum Mirror { @@ -86,6 +95,16 @@ pub enum Mirror { LeftRight, FrontBack, } +impl Mirror { + /// `Mirror.name()`, as structure pieces save it. + pub fn saved_name(self) -> &'static str { + match self { + Self::None => "NONE", + Self::LeftRight => "LEFT_RIGHT", + Self::FrontBack => "FRONT_BACK", + } + } +} /// Inclusive integer box (vanilla BoundingBox). #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)] diff --git a/crates/horizon-world/src/worldgen/structure/end_city.rs b/crates/horizon-world/src/worldgen/structure/end_city.rs index 225f810f5..b440fc832 100644 --- a/crates/horizon-world/src/worldgen/structure/end_city.rs +++ b/crates/horizon-world/src/worldgen/structure/end_city.rs @@ -381,19 +381,22 @@ pub fn pieces( } else { vec!["minecraft:structure_block".into(), "minecraft:air".into()] }; - EndCityPiece(TemplatePiece::new( - "minecraft:ecp", - &format!("minecraft:end_city/{}", d.name), - d.template, - d.position, - d.rotation, - Mirror::None, - [0; 3], - Arc::new(ProcessorList::default()), - true, - ignore, - TemplateHandler::Plain, - )) + EndCityPiece( + TemplatePiece::new( + "minecraft:ecp", + &format!("minecraft:end_city/{}", d.name), + d.template, + d.position, + d.rotation, + Mirror::None, + [0; 3], + Arc::new(ProcessorList::default()), + true, + ignore, + TemplateHandler::Plain, + ), + d.depth, + ) }) .collect(), ) @@ -401,11 +404,21 @@ pub fn pieces( /// EndCityPieces.EndCityPiece. #[derive(Debug)] -pub struct EndCityPiece(TemplatePiece); +/// The template piece and its genDepth (the collision tag of its batch). +pub struct EndCityPiece(TemplatePiece, i32); impl LegacyPiece for EndCityPiece { fn bounding_box(&self) -> BoundingBox { self.0.bounding_box } + /// `EndCityPiece`: the template piece's tag, `OW` for the pieces that + /// overwrite air (only structure blocks ignored). + fn save(&self) -> Option { + let mut tag = self.0.saved(); + tag.insert("GD".into(), crate::nbt::Tag::Int(self.1)); + let overwrite = self.0.ignore.len() == 1; + tag.insert("OW".into(), crate::nbt::Tag::Byte(i8::from(overwrite))); + Some(tag) + } fn type_name(&self) -> &'static str { "minecraft:ecp" } diff --git a/crates/horizon-world/src/worldgen/structure/enhanced_terrain.rs b/crates/horizon-world/src/worldgen/structure/enhanced_terrain.rs index 24c3b9a82..04f14e969 100644 --- a/crates/horizon-world/src/worldgen/structure/enhanced_terrain.rs +++ b/crates/horizon-world/src/worldgen/structure/enhanced_terrain.rs @@ -294,6 +294,8 @@ mod tests { source_x: junction[0], source_ground_y: junction[1], source_z: junction[2], + delta_y: 0, + dest_projection: Projection::Rigid, }], waterlogging: false, }) @@ -303,6 +305,7 @@ mod tests { Arc::new(PoolElement::Single { template: Arc::new(StructureTemplate::empty()), processors: Default::default(), + processors_source: serde_json::Value::Null, legacy: false, projection, waterlogging: None, diff --git a/crates/horizon-world/src/worldgen/structure/fortress.rs b/crates/horizon-world/src/worldgen/structure/fortress.rs index 4d3704413..521dac872 100644 --- a/crates/horizon-world/src/worldgen/structure/fortress.rs +++ b/crates/horizon-world/src/worldgen/structure/fortress.rs @@ -871,6 +871,29 @@ impl LegacyPiece for FortressPiece { fn bounding_box(&self) -> BoundingBox { self.frame.bounding_box } + fn save(&self) -> Option { + use crate::nbt::Tag; + let mut tag = super::legacy::piece_tag( + self.type_name(), + self.frame.bounding_box, + self.frame.orientation, + self.depth, + ); + let flag = Tag::Byte(i8::from(*self.flag.lock().unwrap())); + match self.kind { + Kind::BridgeEndFiller => { + tag.insert("Seed".into(), Tag::Int(self.seed)); + } + Kind::SmallCorridorLeftTurn | Kind::SmallCorridorRightTurn => { + tag.insert("Chest".into(), flag); + } + Kind::MonsterThrone => { + tag.insert("Mob".into(), flag); + } + _ => {} + } + Some(tag) + } fn type_name(&self) -> &'static str { match self.kind { // StartPiece is built through the BridgeCrossing constructor. diff --git a/crates/horizon-world/src/worldgen/structure/jigsaw.rs b/crates/horizon-world/src/worldgen/structure/jigsaw.rs index a6cf7a22a..6fd935024 100644 --- a/crates/horizon-world/src/worldgen/structure/jigsaw.rs +++ b/crates/horizon-world/src/worldgen/structure/jigsaw.rs @@ -5,6 +5,7 @@ use super::{ }; use crate::{ heightmap::HeightmapType, + nbt::{Compound, Tag}, worldgen::{ DecodeError, block_feature::FeatureBlockBindings, @@ -30,12 +31,24 @@ pub enum Projection { Rigid, TerrainMatching, } +impl Projection { + /// `StructureTemplatePool.Projection.getSerializedName`. + pub fn saved_name(self) -> &'static str { + match self { + Self::Rigid => "rigid", + Self::TerrainMatching => "terrain_matching", + } + } +} #[derive(Clone, Debug)] pub enum PoolElement { Empty, Single { template: Arc, processors: ProcessorList, + /// The element's `processors` as written: a list id or an inline list, + /// saved back as it was. + processors_source: Value, legacy: bool, projection: Projection, waterlogging: Option, @@ -136,6 +149,7 @@ impl PoolElement { resources, bindings, )?, + processors_source: value["processors"].clone(), legacy: kind == "minecraft:legacy_single_pool_element", projection: projection()?, waterlogging: match value @@ -178,6 +192,64 @@ impl PoolElement { _ => return Err(DecodeError::Field("pool element type")), }) } + /// `StructurePoolElement.CODEC`'s encoding, as a jigsaw piece saves it. + pub fn save(&self) -> Tag { + let text = |s: &str| Tag::String(s.into()); + match self { + Self::Empty => Tag::compound([("element_type", text("minecraft:empty_pool_element"))]), + Self::Single { + template, + processors_source, + legacy, + projection, + waterlogging, + .. + } => { + let kind = if *legacy { + "minecraft:legacy_single_pool_element" + } else { + "minecraft:single_pool_element" + }; + let mut entries = vec![ + ("element_type", text(kind)), + ("location", text(&template.location)), + ( + "processors", + super::processor::json_to_nbt(processors_source), + ), + ("projection", text(projection.saved_name())), + ]; + if let Some(apply) = waterlogging { + let settings = if *apply { + "apply_waterlogging" + } else { + "ignore_waterlogging" + }; + entries.push(("override_liquid_settings", text(settings))); + } + Tag::compound(entries) + } + Self::Feature { + feature, + projection, + } => Tag::compound([ + ("element_type", text("minecraft:feature_pool_element")), + ("feature", text(feature)), + ("projection", text(projection.saved_name())), + ]), + Self::List { + elements, + projection, + } => Tag::compound([ + ("element_type", text("minecraft:list_pool_element")), + ( + "elements", + Tag::List(elements.iter().map(Self::save).collect()), + ), + ("projection", text(projection.saved_name())), + ]), + } + } pub fn projection(&self) -> Projection { match self { Self::Empty => Projection::TerrainMatching, @@ -466,6 +538,9 @@ pub struct Junction { pub source_x: i32, pub source_ground_y: i32, pub source_z: i32, + /// Saved only (`JigsawJunction.deltaY`, `destProjection`). + pub delta_y: i32, + pub dest_projection: Projection, } #[derive(Debug)] pub struct PoolPiece { @@ -517,6 +592,12 @@ impl PoolPiece { source_x: int(j, "source_x")?, source_ground_y: int(j, "source_ground_y")?, source_z: int(j, "source_z")?, + delta_y: int(j, "delta_y")?, + dest_projection: match j["dest_proj"].as_str() { + Some("rigid") => Projection::Rigid, + Some("terrain_matching") => Projection::TerrainMatching, + _ => return Err(DecodeError::Field("dest_proj")), + }, }) }) .collect::>()?; @@ -535,6 +616,45 @@ impl PoolPiece { waterlogging: v["liquid_settings"].as_str() != Some("ignore_waterlogging"), }) } + /// `PoolElementStructurePiece`'s tag (always genDepth 0, no orientation). + pub fn save(&self) -> Compound { + let mut tag = super::legacy::piece_tag("minecraft:jigsaw", self.bounding_box, None, 0); + let junctions = self + .junctions + .iter() + .map(|j| { + Tag::compound([ + ("source_x", Tag::Int(j.source_x)), + ("source_ground_y", Tag::Int(j.source_ground_y)), + ("source_z", Tag::Int(j.source_z)), + ("delta_y", Tag::Int(j.delta_y)), + ( + "dest_proj", + Tag::String(j.dest_projection.saved_name().into()), + ), + ]) + }) + .collect(); + for (key, value) in [ + ("PosX", Tag::Int(self.position[0])), + ("PosY", Tag::Int(self.position[1])), + ("PosZ", Tag::Int(self.position[2])), + ("ground_level_delta", Tag::Int(self.ground_level_delta)), + ("pool_element", self.element.save()), + ("rotation", Tag::String(self.rotation.saved_name().into())), + ("junctions", Tag::List(junctions)), + ] { + tag.insert(key.into(), value); + } + // LiquidSettings.APPLY_WATERLOGGING, the default, is not written. + if !self.waterlogging { + tag.insert( + "liquid_settings".into(), + Tag::String("ignore_waterlogging".into()), + ); + } + tag + } pub(super) fn moved(&mut self, dy: i32) { self.position[1] += dy; self.bounding_box = self.bounding_box.moved([0, dy, 0]); @@ -1204,6 +1324,8 @@ impl Placer<'_, '_> { source_x: target_pos[0], source_ground_y: junction_y - local_y + source_ground, source_z: target_pos[2], + delta_y, + dest_projection: target.projection(), }); self.pieces.push(PoolPiece { element: target.clone(), @@ -1215,6 +1337,12 @@ impl Placer<'_, '_> { source_x: jigsaw.pos[0], source_ground_y: junction_y - target_local_y + target_ground, source_z: jigsaw.pos[2], + delta_y: -delta_y, + dest_projection: if source_rigid { + Projection::Rigid + } else { + Projection::TerrainMatching + }, }], waterlogging: self.config.waterlogging, }); diff --git a/crates/horizon-world/src/worldgen/structure/legacy.rs b/crates/horizon-world/src/worldgen/structure/legacy.rs index f558081ee..785b5fb2e 100644 --- a/crates/horizon-world/src/worldgen/structure/legacy.rs +++ b/crates/horizon-world/src/worldgen/structure/legacy.rs @@ -282,6 +282,11 @@ pub trait LegacyPiece: std::fmt::Debug + Send + Sync { fn bounding_box(&self) -> BoundingBox; /// The vanilla StructurePieceType id, for diagnostics and comparisons. fn type_name(&self) -> &'static str; + /// `StructurePiece.createTag`; None while Horizon cannot save this type, + /// and then its start is not saved. + fn save(&self) -> Option { + None + } fn post_process(&self, context: &mut PieceContext<'_>) -> Result<()>; /// Structure.afterPlace, run on the first piece once per chunk after all /// pieces were placed, with every piece's current box. @@ -290,6 +295,31 @@ pub trait LegacyPiece: std::fmt::Debug + Send + Sync { } } +/// `StructurePiece.createTag`'s own fields: the type, `BB`, `O` (the +/// orientation's 2D data value, -1 for none) and `GD` (genDepth). +pub fn piece_tag( + id: &str, + b: BoundingBox, + orientation: Option, + gen_depth: i32, +) -> Compound { + let o = orientation.map_or(-1, crate::level::data_2d); + [ + ("id", Tag::String(id.into())), + ( + "BB", + Tag::IntArray(vec![ + b.min[0], b.min[1], b.min[2], b.max[0], b.max[1], b.max[2], + ]), + ), + ("O", Tag::Int(o)), + ("GD", Tag::Int(gen_depth)), + ] + .into_iter() + .map(|(k, v)| (JavaString::from(k), v)) + .collect() +} + /// StructurePiece's orientation transform and block helpers. #[derive(Clone, Copy, Debug)] pub struct PieceFrame { diff --git a/crates/horizon-world/src/worldgen/structure/mineshaft.rs b/crates/horizon-world/src/worldgen/structure/mineshaft.rs index 1173c03bf..0c2d32c08 100644 --- a/crates/horizon-world/src/worldgen/structure/mineshaft.rs +++ b/crates/horizon-world/src/worldgen/structure/mineshaft.rs @@ -732,6 +732,57 @@ impl LegacyPiece for MineshaftPiece { fn bounding_box(&self) -> BoundingBox { self.frame.bounding_box } + fn save(&self) -> Option { + use crate::nbt::Tag; + let flag = |b: bool| Tag::Byte(i8::from(b)); + let mut tag = super::legacy::piece_tag( + self.type_name(), + self.frame.bounding_box, + self.frame.orientation, + self.depth, + ); + // MineshaftStructure.Type's ordinal: NORMAL, MESA. + let mesa = self.wood.log == MESA.log; + let mut entries = vec![("MST", Tag::Int(i32::from(mesa)))]; + match &self.kind { + Kind::Room(entrances) => entries.push(( + "Entrances", + Tag::List( + entrances + .iter() + .map(|b| { + Tag::IntArray(vec![ + b.min[0], b.min[1], b.min[2], b.max[0], b.max[1], b.max[2], + ]) + }) + .collect(), + ), + )), + Kind::Corridor { + rails, + spider, + sections, + placed_spider, + } => entries.extend([ + ("hr", flag(*rails)), + ("sc", flag(*spider)), + ("hps", flag(*placed_spider.lock().unwrap())), + ("Num", Tag::Int(*sections)), + ]), + Kind::Crossing { + direction, + two_floored, + } => { + let d = crate::level::data_2d(*direction) as i8; + entries.extend([("tf", flag(*two_floored)), ("D", Tag::Byte(d))]); + } + Kind::Stairs => {} + } + for (key, value) in entries { + tag.insert(key.into(), value); + } + Some(tag) + } fn type_name(&self) -> &'static str { match self.kind { Kind::Room(_) => "minecraft:msroom", diff --git a/crates/horizon-world/src/worldgen/structure/monument.rs b/crates/horizon-world/src/worldgen/structure/monument.rs index 39959557e..ababac969 100644 --- a/crates/horizon-world/src/worldgen/structure/monument.rs +++ b/crates/horizon-world/src/worldgen/structure/monument.rs @@ -463,6 +463,16 @@ impl LegacyPiece for MonumentBuilding { fn type_name(&self) -> &'static str { "minecraft:omb" } + /// `MonumentBuilding`: the base fields only; vanilla builds its rooms + /// again after loading (`OceanMonumentStructure.regeneratePiecesAfterLoad`). + fn save(&self) -> Option { + Some(super::legacy::piece_tag( + "minecraft:omb", + self.frame.bounding_box, + self.frame.orientation, + 0, + )) + } fn post_process(&self, c: &mut PieceContext<'_>) -> Result<()> { let sea = c.world.sea_level()?; let water = c.state("water"); diff --git a/crates/horizon-world/src/worldgen/structure/nether_fossil.rs b/crates/horizon-world/src/worldgen/structure/nether_fossil.rs index 48e4de58a..b80b8c1a8 100644 --- a/crates/horizon-world/src/worldgen/structure/nether_fossil.rs +++ b/crates/horizon-world/src/worldgen/structure/nether_fossil.rs @@ -73,6 +73,9 @@ impl LegacyPiece for NetherFossilPiece { fn bounding_box(&self) -> BoundingBox { self.0.bounding_box } + fn save(&self) -> Option { + Some(self.0.saved()) + } fn type_name(&self) -> &'static str { "minecraft:nefos" } diff --git a/crates/horizon-world/src/worldgen/structure/ocean_ruin.rs b/crates/horizon-world/src/worldgen/structure/ocean_ruin.rs index 9d0ce8923..bf15dc372 100644 --- a/crates/horizon-world/src/worldgen/structure/ocean_ruin.rs +++ b/crates/horizon-world/src/worldgen/structure/ocean_ruin.rs @@ -325,6 +325,8 @@ pub fn post_process(piece: &TemplatePiece, c: &mut PieceContext<'_>) -> Result<( new_y = min_y + 1; } position[1] = new_y; + // OceanRuinPiece.postProcess keeps the height in templatePosition. + *piece.state.lock().unwrap() = Some(new_y); if let Some(markers) = piece.place_at(c, position, &[])? { for (marker, pos) in markers { if marker == "chest" { diff --git a/crates/horizon-world/src/worldgen/structure/piece_limited.rs b/crates/horizon-world/src/worldgen/structure/piece_limited.rs index 6977ebc88..8b3a6d7de 100644 --- a/crates/horizon-world/src/worldgen/structure/piece_limited.rs +++ b/crates/horizon-world/src/worldgen/structure/piece_limited.rs @@ -910,6 +910,8 @@ impl Assembler<'_> { source_x: slot.target_pos[0], source_ground_y: junction_y - local_y + source_ground, source_z: slot.target_pos[2], + delta_y, + dest_projection: target.projection(), }); slot.free.borrow_mut().removed.push(target_box); self.pieces.push(PoolPiece { @@ -922,6 +924,12 @@ impl Assembler<'_> { source_x: jigsaw.pos[0], source_ground_y: junction_y - target_local[1] + target_ground, source_z: jigsaw.pos[2], + delta_y: -delta_y, + dest_projection: if source_rigid { + Projection::Rigid + } else { + Projection::TerrainMatching + }, }], waterlogging: self.config.waterlogging, }); @@ -1022,6 +1030,7 @@ mod tests { let element = Arc::new(PoolElement::Single { template, processors: Default::default(), + processors_source: serde_json::Value::Null, legacy: false, projection: Projection::Rigid, waterlogging: None, @@ -1038,6 +1047,8 @@ mod tests { source_x: 1, source_ground_y: 2, source_z: 3, + delta_y: 0, + dest_projection: Projection::Rigid, }], waterlogging: true, }; diff --git a/crates/horizon-world/src/worldgen/structure/processor.rs b/crates/horizon-world/src/worldgen/structure/processor.rs index f6f5d4508..0665f785d 100644 --- a/crates/horizon-world/src/worldgen/structure/processor.rs +++ b/crates/horizon-world/src/worldgen/structure/processor.rs @@ -21,7 +21,7 @@ use horizon_core::{ use serde_json::Value; use std::{collections::BTreeSet, sync::Arc}; -mod lithostitched; +mod litho; mod pillars; mod sea_level; @@ -238,6 +238,23 @@ impl Modifier { ) } } +impl Modifier { + /// RuleBlockEntityModifier.apply: the block entity the output gets. + fn apply(&self, nbt: Option<&Compound>, random: &mut impl ProcessorRandom) -> Option { + match self { + Self::Passthrough => nbt.cloned(), + Self::Clear => Some(Compound::new()), + Self::AppendLoot(table) => { + let mut nbt = nbt.cloned().unwrap_or_default(); + nbt.insert("LootTable".into(), Tag::String(table.as_str().into())); + nbt.insert("LootTableSeed".into(), Tag::Long(random.long())); + Some(nbt) + } + Self::AppendStatic(data) => Some(edited(nbt, &[], data)), + Self::Edit { remove, data } => Some(edited(nbt, remove, data)), + } + } +} /// A block entity with `remove`'s keys taken out and `data` merged in /// (append_static is the one with nothing to remove). fn edited(nbt: Option<&Compound>, remove: &[String], data: &Compound) -> Compound { @@ -292,17 +309,21 @@ pub enum Processor { SpawnerMobs(Box), Pick(Box), CountCap(Box), - /// `horizon:block_swap` (Lithostitched's `block_swap`): blocks by name - /// become others, keeping the properties both have. + /// `lithostitched:block_swap`: blocks by name become others, keeping + /// the properties both have (a block the game lacks is left alone). BlockSwap(std::collections::BTreeMap), - /// `horizon:apply_random` (Lithostitched's `apply_random`): a processor - /// list drawn by weight runs on the block. - ApplyRandom(Box), - /// `horizon:condition` (Lithostitched's `condition`): `then` or `else` + /// `lithostitched:apply_random`: a processor list drawn by weight runs + /// on the block. + ApplyRandom(Box), + /// `lithostitched:reference`: the named lists run on the block in turn. + Reference(Vec), + /// `lithostitched:discard_input`: the world's block stays. + DiscardInput, + /// `lithostitched:condition`: `then` or `else` /// runs on the block, by a test of it. - Condition(Box), - /// `horizon:set_block` (Lithostitched's `set_block`). - SetBlock(Box), + Condition(Box), + /// `lithostitched:set_block`: the block from a state provider. + SetBlock(Box), /// `horizon:pillar` (Repurposed Structures' and Moog's pillars): a /// trigger block starts a column down to the ground. Pillar(Box), @@ -685,7 +706,7 @@ fn holder_set( } Ok(Arc::new(out)) } -fn json_to_nbt(value: &Value) -> Tag { +pub(super) fn json_to_nbt(value: &Value) -> Tag { match value { Value::Bool(b) => Tag::Byte(i8::from(*b)), Value::Number(n) => match n.as_i64() { @@ -786,7 +807,7 @@ impl Processor { })?)) } "horizon:pick" => Self::Pick(Box::new(Pick::decode(value, state)?)), - "horizon:block_swap" => Self::BlockSwap( + "lithostitched:block_swap" => Self::BlockSwap( value["blocks"] .as_object() .ok_or(DecodeError::Field("blocks"))? @@ -801,12 +822,16 @@ impl Processor { .collect::>()?, ), "horizon:count_cap" => Self::CountCap(Box::new(CountCap::decode(value, state)?)), - "horizon:apply_random" => Self::ApplyRandom(Box::new( - lithostitched::ApplyRandom::decode(value, resources, bindings)?, + "lithostitched:apply_random" => Self::ApplyRandom(Box::new( + litho::ApplyRandom::decode(value, resources, bindings)?, )), - "horizon:set_block" => { - Self::SetBlock(Box::new(lithostitched::SetBlock::decode(value, state)?)) + "lithostitched:set_block" => { + Self::SetBlock(Box::new(litho::SetBlock::decode(value, state)?)) } + "lithostitched:reference" => { + Self::Reference(litho::reference(value, resources, bindings)?) + } + "lithostitched:discard_input" => Self::DiscardInput, "horizon:pillar" => Self::Pillar(Box::new(pillars::Pillar::decode( value, resources, bindings, state, )?)), @@ -834,7 +859,7 @@ impl Processor { "horizon:keep_world_block" => { Self::KeepWorldBlock(Box::new(sea_level::KeepWorldBlock::decode(value)?)) } - "horizon:condition" => Self::Condition(Box::new(lithostitched::Conditional::decode( + "lithostitched:condition" => Self::Condition(Box::new(litho::Conditional::decode( value, resources, bindings, )?)), _ => return Err(DecodeError::Field("structure processor type")), @@ -1115,24 +1140,10 @@ fn process_block( if !position_ok { continue; } - let nbt = match &rule.modifier { - Modifier::Passthrough => info.nbt.clone(), - Modifier::Clear => Some(Compound::new()), - Modifier::AppendLoot(table) => { - let mut nbt = info.nbt.clone().unwrap_or_default(); - nbt.insert("LootTable".into(), Tag::String(table.as_str().into())); - nbt.insert("LootTableSeed".into(), Tag::Long(random.next_long())); - Some(nbt) - } - Modifier::AppendStatic(data) => Some(edited(info.nbt.as_ref(), &[], data)), - Modifier::Edit { remove, data } => { - Some(edited(info.nbt.as_ref(), remove, data)) - } - }; return Ok(Some(BlockInfo { pos: info.pos, state: rule.output, - nbt, + nbt: rule.modifier.apply(info.nbt.as_ref(), &mut random), })); } Some(info) @@ -1165,8 +1176,7 @@ fn process_block( false => Some(info), }, Processor::ApplyRandom(apply) => { - let seed = world.world_seed()?; - let mut random = apply.random.create(seed, position, reference, info.pos); + let mut random = apply.draws.random(world.world_seed()?, position, info.pos); match apply.pick(&mut random) { Some(list) => { return process_list( @@ -1176,21 +1186,34 @@ fn process_block( None => Some(info), } } + Processor::Reference(lists) => { + let mut current = info; + for list in lists { + match process_list( + list, world, resources, position, reference, relative, current, settings, + )? { + Some(next) => current = next, + None => return Ok(None), + } + } + Some(current) + } + Processor::DiscardInput => None, Processor::SetBlock(set) => { - let seed = world.world_seed()?; - let state = set.state(seed, position, reference, info.pos); - let state = match set.preserves() { + let mut random = set.draws.random(world.world_seed()?, position, info.pos); + let state = set.state(&mut random); + let state = match set.preserve { true => registry .state(state) .and_then(|s| with_properties_of(registry, &s.name, info.state)) .unwrap_or(state), false => state, }; - Some(BlockInfo { state, ..info }) + let nbt = set.modifier.apply(info.nbt.as_ref(), &mut random); + Some(BlockInfo { state, nbt, ..info }) } Processor::Condition(c) => { - let seed = world.world_seed()?; - let mut random = c.random.create(seed, position, reference, info.pos); + let mut random = c.draws.random(world.world_seed()?, position, info.pos); let location = world.block_state(info.pos)?; let passed = c .condition diff --git a/crates/horizon-world/src/worldgen/structure/processor/litho.rs b/crates/horizon-world/src/worldgen/structure/processor/litho.rs new file mode 100644 index 000000000..6ba006fd6 --- /dev/null +++ b/crates/horizon-world/src/worldgen/structure/processor/litho.rs @@ -0,0 +1,841 @@ +//! Lithostitched's processors (spec-lithostitched §5), read as its data +//! writes them: `lithostitched:block_swap` (in `processor.rs`), `reference`, +//! `apply_random`, `condition`, `set_block` and `discard_input`. +//! +//! The draws of `random_chance`, `apply_random` and `set_block` follow +//! Lithostitched's `random_mode` (per block or per piece), but its seeding is +//! not known (OPEN-L6): a positional random of the world seed, the block's or +//! the piece's position and the processor itself, so the shares match while +//! the blocks chosen do not. +use super::{BlockStateId, DecodeError, Modifier, ProcessorList, ProcessorRandom}; +use crate::worldgen::{block_feature::FeatureBlockBindings, structure::StructureResources}; +use horizon_core::{ + position::BlockPos, + random::{LegacyRandom, position_seed}, +}; +use serde_json::Value; +use std::collections::BTreeSet; + +/// `random_mode` (`condition`, `set_block`) or `mode` (`apply_random`). +#[derive(Clone, Copy, Debug)] +pub(super) struct Draws { + per_piece: bool, + /// The processor's own salt, so two processors on a block draw apart. + salt: i64, +} +impl Draws { + fn decode(mode: Option<&Value>, processor: &Value) -> Result { + let per_piece = match mode.and_then(Value::as_str) { + None | Some("per_block") => false, + Some("per_piece") => true, + _ => return Err(DecodeError::Field("random_mode")), + }; + // FNV-1a over the processor's JSON: the same in every run. + let salt = (processor.to_string().bytes()).fold(0xcbf2_9ce4_8422_2325_u64, |h, b| { + (h ^ u64::from(b)).wrapping_mul(0x0100_0000_01b3) + }) as i64; + Ok(Self { per_piece, salt }) + } + /// The random for the block at `pos` of the piece at `piece`. + pub(super) fn random(self, world_seed: i64, piece: [i32; 3], pos: [i32; 3]) -> LegacyRandom { + let [x, y, z] = if self.per_piece { piece } else { pos }; + LegacyRandom::new(world_seed ^ self.salt ^ position_seed(BlockPos::new(x, y, z))) + } +} + +/// A processor or a list of them (`then`, `else`, `apply_random`'s data): +/// a list holder (`ProcessorList::decode`), or one processor object. +fn processors( + value: &Value, + resources: &StructureResources, + bindings: &FeatureBlockBindings<'_>, +) -> Result { + let one = value.get("processor_type").is_some(); + let holder = if one { + Value::Array(vec![value.clone()]) + } else { + value.clone() + }; + ProcessorList::decode(&holder.to_string(), resources, bindings) +} + +/// `reference`: the named lists, run in turn on the block. +pub(super) fn reference( + value: &Value, + resources: &StructureResources, + bindings: &FeatureBlockBindings<'_>, +) -> Result, DecodeError> { + let names = match &value["processor_lists"] { + Value::Array(a) => a.clone(), + other => vec![other.clone()], + }; + (names.iter()) + .map(|name| match name.as_str() { + Some(n) if n.starts_with('#') => Err(DecodeError::Field("processor list tag")), + Some(_) => ProcessorList::decode(&name.to_string(), resources, bindings), + None => Err(DecodeError::Field("processor_lists")), + }) + .collect() +} + +/// `apply_random`: one list drawn by weight runs on the block. +#[derive(Clone, Debug)] +pub struct ApplyRandom { + pub(super) draws: Draws, + lists: Vec<(i32, ProcessorList)>, + total: i32, +} +impl ApplyRandom { + pub(super) fn decode( + value: &Value, + resources: &StructureResources, + bindings: &FeatureBlockBindings<'_>, + ) -> Result { + let entries = value["processor_lists"] + .as_array() + .ok_or(DecodeError::Field("apply_random processor_lists"))?; + let lists = (entries.iter()) + .map(|e| match e.get("data") { + Some(data) => { + let weight = e["weight"] + .as_i64() + .unwrap_or(1) + .clamp(0, i64::from(i32::MAX)); + Ok((weight as i32, processors(data, resources, bindings)?)) + } + None => Ok((1, processors(e, resources, bindings)?)), + }) + .collect::, DecodeError>>()?; + let total = lists + .iter() + .map(|(w, _)| *w) + .fold(0i32, i32::saturating_add); + Ok(Self { + draws: Draws::decode(value.get("mode"), value)?, + lists, + total, + }) + } + /// The list drawn: one bounded draw over the total weight. + pub(super) fn pick(&self, random: &mut impl ProcessorRandom) -> Option<&ProcessorList> { + if self.total <= 0 { + return None; + } + let mut at = random.int(self.total); + for (weight, list) in &self.lists { + at -= weight; + if at < 0 { + return Some(list); + } + } + None + } +} + +/// Lithostitched's processor conditions. +#[derive(Clone, Debug)] +pub(super) enum Condition { + True, + AllOf(Vec), + AnyOf(Vec), + Not(Box), + Chance(f32), + /// `matching_blocks`: the template's block (`input`) or the world's + /// (`location`) is one of `blocks`, with `properties`. + Matching { + blocks: BTreeSet, + properties: Vec<(String, String)>, + location: bool, + }, +} +impl Condition { + /// One condition, or a list of them that must all pass (`if_true`). + pub(super) fn decode( + value: &Value, + bindings: &FeatureBlockBindings<'_>, + ) -> Result { + let list = |v: &Value| -> Result, DecodeError> { + (v.as_array().ok_or(DecodeError::Field("conditions"))?.iter()) + .map(|c| Self::decode(c, bindings)) + .collect() + }; + if value.is_array() { + return Ok(Self::AllOf(list(value)?)); + } + let kind = value["type"].as_str().unwrap_or_default(); + Ok(match crate::worldgen::tags::identifier(kind)?.as_str() { + "lithostitched:true" => Self::True, + "lithostitched:all_of" => Self::AllOf(list(&value["conditions"])?), + "lithostitched:any_of" => Self::AnyOf(list(&value["conditions"])?), + "lithostitched:not" => { + Self::Not(Box::new(Self::decode(&value["condition"], bindings)?)) + } + "lithostitched:random_chance" => Self::Chance( + value["chance"] + .as_f64() + .ok_or(DecodeError::Field("random_chance chance"))? as f32, + ), + "lithostitched:matching_blocks" => Self::Matching { + blocks: blocks(&value["blocks"], bindings)?, + properties: (value + .get("properties") + .and_then(Value::as_object) + .into_iter()) + .flatten() + .map(|(k, v)| { + ( + k.clone(), + v.as_str().map_or_else(|| v.to_string(), str::to_owned), + ) + }) + .collect(), + location: match value.get("match_type").and_then(Value::as_str) { + None | Some("input") => false, + Some("location") => true, + _ => return Err(DecodeError::Field("matching_blocks match_type")), + }, + }, + _ => return Err(DecodeError::Field("lithostitched condition type")), + }) + } + pub(super) fn test( + &self, + input: BlockStateId, + location: BlockStateId, + registry: &crate::registry::BlockRegistry, + random: &mut impl ProcessorRandom, + ) -> bool { + match self { + Self::True => true, + Self::AllOf(all) => all + .iter() + .all(|c| c.test(input, location, registry, random)), + Self::AnyOf(any) => any + .iter() + .any(|c| c.test(input, location, registry, random)), + Self::Not(c) => !c.test(input, location, registry, random), + Self::Chance(chance) => random.float() < *chance, + Self::Matching { + blocks, + properties, + location: at_location, + } => { + let Some(state) = registry.state(if *at_location { location } else { input }) + else { + return false; + }; + blocks.contains(&state.name) + && (properties.iter()).all(|(k, v)| state.properties.get(k) == Some(v)) + } + } + } +} +/// A block set (an id, a list, `#tag`) by block name. Blocks the game does +/// not have are left out: no template block can be one. +fn blocks( + value: &Value, + bindings: &FeatureBlockBindings<'_>, +) -> Result, DecodeError> { + let names: Vec<&str> = match value { + Value::String(s) => vec![s.as_str()], + Value::Array(a) => a.iter().filter_map(Value::as_str).collect(), + _ => return Err(DecodeError::Field("matching_blocks blocks")), + }; + let registry = bindings.registry(); + let mut out = BTreeSet::new(); + for name in names { + match name.strip_prefix('#') { + Some(tag) => { + let tag = crate::worldgen::tags::identifier(tag)?; + let states = bindings.tags.get(&tag).into_iter().flat_map(|s| s.iter()); + out.extend(states.filter_map(|s| Some(registry.state(*s)?.name.clone()))); + } + None => { + out.insert(crate::worldgen::tags::identifier(name)?.to_string()); + } + } + } + Ok(out) +} + +/// `condition`: `then` when the conditions pass, else `else` (none: the +/// block as it is). +#[derive(Clone, Debug)] +pub struct Conditional { + pub(super) draws: Draws, + pub(super) condition: Condition, + pub(super) then: ProcessorList, + pub(super) otherwise: ProcessorList, +} +impl Conditional { + pub(super) fn decode( + value: &Value, + resources: &StructureResources, + bindings: &FeatureBlockBindings<'_>, + ) -> Result { + let branch = |key| match value.get(key) { + Some(v) => processors(v, resources, bindings), + None => Ok(ProcessorList(Vec::new())), + }; + Ok(Self { + draws: Draws::decode(value.get("random_mode"), value)?, + condition: Condition::decode(&value["if_true"], bindings)?, + then: branch("then")?, + otherwise: branch("else")?, + }) + } +} + +/// `set_block`: the block from a state provider (simple or weighted). +#[derive(Clone, Debug)] +pub struct SetBlock { + pub(super) draws: Draws, + states: Vec<(i32, BlockStateId)>, + total: i32, + /// `preserve_state` (true by default): the template block's properties + /// the new block has too are kept. + pub(super) preserve: bool, + pub(super) modifier: Modifier, +} +impl SetBlock { + pub(super) fn decode( + value: &Value, + state: impl Fn(&Value) -> Result, + ) -> Result { + let provider = &value["state_provider"]; + let kind = provider["type"].as_str().unwrap_or_default(); + let states = match crate::worldgen::tags::identifier(kind)?.as_str() { + "minecraft:simple_state_provider" => vec![(1, state(&provider["state"])?)], + "minecraft:weighted_state_provider" => (provider["entries"].as_array().into_iter()) + .flatten() + .map(|e| { + Ok(( + e["weight"].as_i64().unwrap_or(1).clamp(0, 1 << 30) as i32, + state(&e["data"])?, + )) + }) + .collect::>()?, + _ => return Err(DecodeError::Field("set_block state_provider")), + }; + let total = states.iter().map(|(w, _)| *w).sum(); + if total <= 0 { + return Err(DecodeError::Field("set_block state_provider")); + } + Ok(Self { + draws: Draws::decode(value.get("random_mode"), value)?, + states, + total, + preserve: value + .get("preserve_state") + .and_then(Value::as_bool) + .unwrap_or(true), + modifier: Modifier::decode(value.get("block_entity_modifier"))?, + }) + } + /// The provider's state: WeightedList.getRandom, one bounded draw. + pub(super) fn state(&self, random: &mut impl ProcessorRandom) -> BlockStateId { + let mut at = random.int(self.total); + for (weight, state) in &self.states { + at -= weight; + if at < 0 { + return *state; + } + } + self.states[0].1 + } +} + +#[cfg(test)] +mod tests { + use super::super::{BlockInfo, PlaceSettings, ProcessorList, process_list}; + use crate::{ + heightmap::HeightmapType, + nbt::{JavaString, Tag}, + registry::{BlockRegistry, BlockStateId}, + worldgen::{ + anchor::WorldGenerationContext, + block_feature::FeatureBlockBindings, + placement::{PlacementContext, PlacementQueryError}, + structure::{ + Rotation, StateTransforms, StructureResources, template::parse_state_string, + }, + }, + }; + use serde_json::{Value, json}; + use std::collections::{BTreeMap, BTreeSet}; + + /// Every combination of `properties`' values, the first one the default. + fn states(name: &str, properties: &[(&str, &[&str])]) -> Vec { + let mut out = vec![serde_json::Map::new()]; + for (key, values) in properties { + out = (out.iter()) + .flat_map(|o| { + values.iter().map(move |v| { + let mut o = o.clone(); + o.insert((*key).into(), (*v).into()); + o + }) + }) + .collect(); + } + (out.into_iter()) + .map(|p| json!([name, name.ends_with("air"), false, "", {"id": name, "properties": p}])) + .collect() + } + + /// A registry of the blocks CTOV's lists and the probe pack use. + fn registry() -> &'static BlockRegistry { + let ages: Vec = (0..8).map(|a| a.to_string()).collect(); + let ages: Vec<&str> = ages.iter().map(String::as_str).collect(); + let levels: Vec = (0..16).map(|a| a.to_string()).collect(); + let levels: Vec<&str> = levels.iter().map(String::as_str).collect(); + let water = [("level", &levels[..])]; + let stairs: &[(&str, &[&str])] = + &[("facing", &["north", "east"]), ("half", &["bottom", "top"])]; + let blocks: Vec<(&str, &[(&str, &[&str])])> = vec![ + ("minecraft:air", &[]), + ("minecraft:cave_air", &[]), + ("minecraft:void_air", &[]), + ("minecraft:lava", &water), + ("minecraft:cobblestone", &[]), + ("minecraft:blackstone", &[]), + ("minecraft:deepslate", &[]), + ("minecraft:water", &water), + ("minecraft:spruce_planks", &[]), + ("minecraft:chest", &[]), + ("minecraft:oak_log", &[("axis", &["y", "x"])]), + ("minecraft:stripped_cherry_log", &[("axis", &["y", "x"])]), + ("minecraft:oak_stairs", stairs), + ("minecraft:warped_stairs", stairs), + ]; + let wheat = [("age", &ages[..])]; + let beetroots = [("age", &ages[..4])]; + let mut rows = Vec::new(); + let mut defaults = BTreeMap::new(); + let crops: [(&str, &[(&str, &[&str])]); 3] = [ + ("minecraft:wheat", &wheat), + ("minecraft:carrots", &wheat), + ("minecraft:beetroots", &beetroots), + ]; + for (name, properties) in blocks.into_iter().chain(crops) { + defaults.insert(name, rows.len()); + rows.extend(states(name, properties)); + } + let facts = json!({"states": rows, "defaults": defaults}); + let registry = BlockRegistry::from_facts_json(facts.to_string().as_bytes()).unwrap(); + Box::leak(Box::new(registry)) + } + + /// The world a piece is placed in: one block everywhere. + struct World { + seed: i64, + block: BlockStateId, + } + impl PlacementContext for World { + fn world_seed(&mut self) -> Result { + Ok(self.seed) + } + fn block_state(&mut self, _: [i32; 3]) -> Result { + Ok(self.block) + } + fn generation(&self) -> WorldGenerationContext { + WorldGenerationContext::new(-64, 384, 63) + } + fn min_y(&mut self) -> Result { + Ok(-64) + } + fn height(&mut self, _: HeightmapType, _: i32, _: i32) -> Result { + Err(PlacementQueryError::Unavailable) + } + } + + struct Lists { + registry: &'static BlockRegistry, + resources: StructureResources, + } + impl Lists { + fn new(lists: &[(&str, Value)]) -> Self { + let registry = registry(); + let lists = (lists.iter()) + .map(|(id, list)| ((*id).to_owned(), list.to_string())) + .collect(); + let resources = StructureResources::new( + registry, + StateTransforms::default(), + std::path::Path::new("/nonexistent"), + lists, + &BTreeMap::new(), + ); + Self { + registry, + resources, + } + } + fn id(&self, state: &str) -> BlockStateId { + parse_state_string(self.registry, state).unwrap() + } + fn decode(&self, processors: Value) -> Result { + let bindings = FeatureBlockBindings::new(self.registry, BTreeSet::new()).unwrap(); + ProcessorList::decode(&processors.to_string(), &self.resources, &bindings) + } + /// The block the list makes of template block `state` at `pos` of the + /// piece at `piece`, in a world of `world`: None when it is not placed. + fn run( + &self, + list: &ProcessorList, + world: (i64, &str), + piece: [i32; 3], + pos: [i32; 3], + state: &str, + ) -> Option { + let mut world = World { + seed: world.0, + block: self.id(world.1), + }; + let info = BlockInfo { + pos, + state: self.id(state), + nbt: None, + }; + let mut settings = PlaceSettings::new(Rotation::None); + process_list( + list, + &mut world, + &self.resources, + piece, + piece, + [0; 3], + info, + &mut settings, + ) + .unwrap() + } + fn name(&self, info: Option) -> String { + match info { + None => "none".into(), + Some(info) => { + let s = self.registry.state(info.state).unwrap(); + let props: Vec = s + .properties + .iter() + .map(|(k, v)| format!("{k}={v}")) + .collect(); + match props.is_empty() { + true => s.name.clone(), + false => format!("{}[{}]", s.name, props.join(",")), + } + } + } + } + /// `name(run(...))` for one template block in an air world of seed 0. + fn out(&self, list: &ProcessorList, state: &str) -> String { + self.name(self.run(list, (0, "minecraft:air"), [0; 3], [0; 3], state)) + } + } + + fn swap(blocks: Value) -> Value { + json!({"processor_type": "lithostitched:block_swap", "blocks": blocks}) + } + fn set_block(provider: Value) -> Value { + json!({"processor_type": "lithostitched:set_block", "state_provider": provider}) + } + fn simple(name: &str) -> Value { + json!({"type": "minecraft:simple_state_provider", "state": {"id": name}}) + } + + #[test] + fn block_swap_keeps_the_properties_the_new_block_can_have() { + let t = Lists::new(&[]); + let list = t + .decode(json!([swap(json!({ + "minecraft:wheat": "minecraft:carrots", + "oak_stairs": "minecraft:warped_stairs", + "minecraft:cobblestone": "natures_spirit:missing"}))])) + .unwrap(); + assert_eq!( + t.out(&list, "minecraft:wheat[age=7]"), + "minecraft:carrots[age=7]" + ); + assert_eq!( + t.out(&list, "minecraft:oak_stairs[facing=east,half=top]"), + "minecraft:warped_stairs[facing=east,half=top]" + ); + // A block the game lacks leaves the template's; others pass. + assert_eq!( + t.out(&list, "minecraft:cobblestone"), + "minecraft:cobblestone" + ); + assert_eq!( + t.out(&list, "minecraft:oak_log[axis=x]"), + "minecraft:oak_log[axis=x]" + ); + // Beetroots' age stops at 3: ripe wheat gives the default (spec-ctov §4). + let beet = t + .decode(json!([swap( + json!({"minecraft:wheat": "minecraft:beetroots"}) + )])) + .unwrap(); + assert_eq!( + t.out(&beet, "minecraft:wheat[age=7]"), + "minecraft:beetroots[age=0]" + ); + assert_eq!( + t.out(&beet, "minecraft:wheat[age=2]"), + "minecraft:beetroots[age=2]" + ); + } + + #[test] + fn references_run_the_named_lists_in_turn() { + let t = Lists::new(&[ + ( + "t:logs", + json!({"processors": [swap(json!({"minecraft:oak_log": "minecraft:stripped_cherry_log"}))]}), + ), + ( + "t:stone", + json!([swap( + json!({"minecraft:stripped_cherry_log": "minecraft:cobblestone"}) + )]), + ), + ( + "t:discard", + json!([{"processor_type": "lithostitched:discard_input"}]), + ), + ]); + let reference = |lists: Value| json!([{"processor_type": "lithostitched:reference", "processor_lists": lists}]); + let one = t.decode(reference(json!("t:logs"))).unwrap(); + assert_eq!( + t.out(&one, "minecraft:oak_log[axis=x]"), + "minecraft:stripped_cherry_log[axis=x]" + ); + let both = t.decode(reference(json!(["t:logs", "t:stone"]))).unwrap(); + assert_eq!(t.out(&both, "minecraft:oak_log"), "minecraft:cobblestone"); + let reversed = t.decode(reference(json!(["t:stone", "t:logs"]))).unwrap(); + assert_eq!( + t.out(&reversed, "minecraft:oak_log"), + "minecraft:stripped_cherry_log[axis=y]" + ); + // discard_input: the template block is not placed, and the lists after it do not run. + let discard = t.decode(reference(json!(["t:discard", "t:logs"]))).unwrap(); + assert_eq!(t.out(&discard, "minecraft:oak_log"), "none"); + // The game has no processor list tags; unknown lists are errors. + assert!(t.decode(reference(json!(["#t:palettes"]))).is_err()); + assert!(t.decode(reference(json!("t:missing"))).is_err()); + } + + /// The probe pack's nested condition (spec-lithostitched §7.3): template + /// cobblestone becomes blackstone or deepslate, half each. + #[test] + fn conditions_run_then_or_else() { + let t = Lists::new(&[]); + let inner = json!({"processor_type": "lithostitched:condition", "random_mode": "per_block", + "if_true": {"type": "lithostitched:random_chance", "chance": 0.5}, + "then": set_block(simple("minecraft:blackstone")), + "else": [set_block(simple("minecraft:deepslate"))]}); + let list = t + .decode(json!([{"processor_type": "lithostitched:condition", + "if_true": [{"type": "lithostitched:matching_blocks", "blocks": "minecraft:cobblestone"}], + "then": [inner]}])) + .unwrap(); + let mut counts = BTreeMap::::new(); + for i in 0..4000 { + let out = t.run( + &list, + (1234, "minecraft:air"), + [0; 3], + [i % 64, i / 64, 7], + "minecraft:cobblestone", + ); + *counts.entry(t.name(out)).or_default() += 1; + } + assert_eq!(counts.len(), 2, "{counts:?}"); + assert!( + (1850..2150).contains(&counts["minecraft:blackstone"]), + "{counts:?}" + ); + // Not cobblestone, and no `else`: the block as it is. + assert_eq!( + t.out(&list, "minecraft:oak_log"), + "minecraft:oak_log[axis=y]" + ); + + // `location` tests the world's block, with properties on the input. + let water = t + .decode( + json!([{"processor_type": "lithostitched:condition", "random_mode": "per_piece", + "if_true": {"type": "lithostitched:matching_blocks", "blocks": ["minecraft:water"], + "match_type": "location"}, + "then": set_block(simple("minecraft:spruce_planks"))}]), + ) + .unwrap(); + let at = |world| { + t.name(t.run( + &water, + (0, world), + [0; 3], + [1, 2, 3], + "minecraft:cobblestone", + )) + }; + assert_eq!(at("minecraft:water"), "minecraft:spruce_planks"); + assert_eq!(at("minecraft:air"), "minecraft:cobblestone"); + let ripe = t + .decode(json!([{"processor_type": "lithostitched:condition", + "if_true": {"type": "lithostitched:all_of", "conditions": [ + {"type": "lithostitched:true"}, + {"type": "lithostitched:matching_blocks", "blocks": "minecraft:wheat", "properties": {"age": "7"}}, + {"type": "lithostitched:not", "condition": {"type": "lithostitched:any_of", "conditions": [ + {"type": "lithostitched:random_chance", "chance": 0.0}, + {"type": "lithostitched:matching_blocks", "blocks": "minecraft:water", "match_type": "location"}]}}]}, + "then": swap(json!({"minecraft:wheat": "minecraft:carrots"}))}])) + .unwrap(); + assert_eq!( + t.out(&ripe, "minecraft:wheat[age=7]"), + "minecraft:carrots[age=7]" + ); + assert_eq!( + t.out(&ripe, "minecraft:wheat[age=6]"), + "minecraft:wheat[age=6]" + ); + let bad = json!([{"processor_type": "lithostitched:condition", "random_mode": "per_chunk", + "if_true": {"type": "lithostitched:true"}}]); + assert!(t.decode(bad).is_err()); + } + + /// `apply_random` (spec-lithostitched §7.3: crimson 1 : birch 3, one + /// choice per piece): here blackstone 1 : deepslate 3. + #[test] + fn apply_random_draws_per_piece_or_per_block() { + let t = Lists::new(&[( + "t:deepslate", + json!([swap( + json!({"minecraft:cobblestone": "minecraft:deepslate"}) + )]), + )]); + let random = |mode: &str| { + t.decode(json!([{"processor_type": "lithostitched:apply_random", "mode": mode, + "processor_lists": [ + {"weight": 1, "data": [swap(json!({"minecraft:cobblestone": "minecraft:blackstone"}))]}, + {"weight": 3, "data": "t:deepslate"}]}])) + .unwrap() + }; + let (per_piece, per_block) = (random("per_piece"), random("per_block")); + let outcomes = |list: &ProcessorList, seed: i64, piece: [i32; 3]| -> Vec { + (0..20) + .map(|i| { + let pos = [piece[0] + i, piece[1], piece[2] + 3 * i]; + t.name(t.run( + list, + (seed, "minecraft:air"), + piece, + pos, + "minecraft:cobblestone", + )) + }) + .collect() + }; + let mut blackstone_pieces = 0; + for p in 0..400 { + let piece = [16 * p, 70, -40 * p]; + let blocks = outcomes(&per_piece, 1234, piece); + assert!(blocks.iter().all(|b| *b == blocks[0]), "{blocks:?}"); + blackstone_pieces += u32::from(blocks[0] == "minecraft:blackstone"); + // The same piece and seed give the same blocks. + assert_eq!(outcomes(&per_piece, 1234, piece), blocks); + } + assert!( + (70..130).contains(&blackstone_pieces), + "{blackstone_pieces}" + ); + // Per block, one piece mixes both. + let mixed: BTreeSet = (0..10) + .flat_map(|p| outcomes(&per_block, 1234, [p, 0, 0])) + .collect(); + assert_eq!(mixed.len(), 2, "{mixed:?}"); + // A plain list: every entry weight 1. An entry list holding nothing is a no-op. + let plain = t + .decode( + json!([{"processor_type": "lithostitched:apply_random", "mode": "per_block", + "processor_lists": ["t:deepslate", []]}]), + ) + .unwrap(); + let seen: BTreeSet = (0..10) + .flat_map(|p| outcomes(&plain, 9, [p, 0, 0])) + .collect(); + assert_eq!( + seen, + BTreeSet::from(["minecraft:cobblestone".into(), "minecraft:deepslate".into()]) + ); + } + + #[test] + fn set_block_runs_its_provider() { + let t = Lists::new(&[]); + let stairs = "minecraft:oak_stairs[facing=east,half=top]"; + let warped = |preserve: Value| { + let mut p = set_block(simple("minecraft:warped_stairs")); + if !preserve.is_null() { + p["preserve_state"] = preserve; + } + t.decode(json!([p])).unwrap() + }; + // preserve_state (true by default) keeps the properties both blocks have. + assert_eq!( + t.out(&warped(Value::Null), stairs), + "minecraft:warped_stairs[facing=east,half=top]" + ); + assert_eq!( + t.out(&warped(json!(false)), stairs), + "minecraft:warped_stairs[facing=north,half=bottom]" + ); + + let weighted = t + .decode(json!([set_block( + json!({"type": "minecraft:weighted_state_provider", "entries": [ + {"weight": 1, "data": {"id": "minecraft:blackstone"}}, + {"weight": 3, "data": {"id": "minecraft:deepslate"}}]}) + )])) + .unwrap(); + let blackstone = (0..2000) + .filter(|i| { + let out = t.run( + &weighted, + (42, "minecraft:air"), + [0; 3], + [*i, 0, -*i], + "minecraft:cobblestone", + ); + t.name(out) == "minecraft:blackstone" + }) + .count(); + assert!((420..580).contains(&blackstone), "{blackstone}"); + + // block_entity_modifier gives the output its block entity. + let mut loot = set_block(simple("minecraft:chest")); + loot["block_entity_modifier"] = + json!({"type": "minecraft:append_loot", "loot_table": "t:chests/house"}); + let out = t + .run( + &t.decode(json!([loot])).unwrap(), + (0, "minecraft:air"), + [0; 3], + [0; 3], + "minecraft:air", + ) + .unwrap(); + let table = out + .nbt + .as_ref() + .and_then(|n| n.get(&JavaString::from("LootTable"))); + assert_eq!(table, Some(&Tag::String("t:chests/house".into()))); + + // Providers the game does not run are refused. + assert!( + t.decode(json!([set_block( + json!({"type": "minecraft:noise_provider"}) + )])) + .is_err() + ); + } +} diff --git a/crates/horizon-world/src/worldgen/structure/processor/lithostitched.rs b/crates/horizon-world/src/worldgen/structure/processor/lithostitched.rs deleted file mode 100644 index f0bb1c6ba..000000000 --- a/crates/horizon-world/src/worldgen/structure/processor/lithostitched.rs +++ /dev/null @@ -1,434 +0,0 @@ -//! Lithostitched's processors that pick processors, carried as data -//! (`horizon:apply_random` and `horizon:condition`): one runs a processor -//! list drawn by weight, the other one list or another by a test of the -//! block. Both draw from Lithostitched's RandomSettings: a random seeded from -//! the world seed and a name, at the block, the piece or the structure. -//! `horizon:set_block` is its `set_block`, which the conditions mostly run. -use super::{Processor, ProcessorList}; -use crate::{ - registry::{BlockRegistry, BlockStateId}, - worldgen::{DecodeError, block_feature::FeatureBlockBindings, structure::StructureResources}, -}; -use horizon_core::{ - position::BlockPos, - random::{LegacyRandom, PositionalRandom, RandomSource}, -}; -use serde_json::Value; -use std::{collections::BTreeSet, sync::Arc}; - -/// RandomSettings: where the random is taken, and the name salting it. -#[derive(Clone, Debug, PartialEq)] -pub struct RandomSettings { - mode: Mode, - /// ResourceLocation.hashCode of the name (`lithostitched:default`). - salt: i32, -} -#[derive(Clone, Copy, Debug, PartialEq)] -enum Mode { - Block, - Piece, - Structure, -} -impl RandomSettings { - /// A mode alone, or `{"mode": ..., "name": ...}`; per block when unset. - fn decode(v: Option<&Value>) -> Result { - let mode = Mode::decode; - let (mode, name) = match v { - None => (Mode::Block, "lithostitched:default"), - Some(Value::String(m)) => (mode(Some(m))?, "lithostitched:default"), - Some(o) => ( - mode(o["mode"].as_str())?, - o["name"] - .as_str() - .ok_or(DecodeError::Field("random name"))?, - ), - }; - let (namespace, path) = name.split_once(':').unwrap_or(("minecraft", name)); - Ok(Self { - mode, - salt: java_hash(namespace) - .wrapping_mul(31) - .wrapping_add(java_hash(path)), - }) - } - /// RandomSource.create(seed + hash).forkPositional().at(the chosen - /// position): the piece's position, the structure's pivot or the block. - pub(super) fn create( - &self, - seed: i64, - piece: [i32; 3], - pivot: [i32; 3], - block: [i32; 3], - ) -> LegacyRandom { - let [x, y, z] = self.mode.select(piece, pivot, block); - LegacyRandom::new(seed.wrapping_add(i64::from(self.salt))) - .fork_positional() - .at(BlockPos::new(x, y, z)) - } -} -impl Mode { - fn decode(m: Option<&str>) -> Result { - match m { - None | Some("per_block") => Ok(Self::Block), - Some("per_piece") => Ok(Self::Piece), - Some("per_structure") => Ok(Self::Structure), - _ => Err(DecodeError::Field("random mode")), - } - } - fn select(self, piece: [i32; 3], pivot: [i32; 3], block: [i32; 3]) -> [i32; 3] { - match self { - Self::Block => block, - Self::Piece => piece, - Self::Structure => pivot, - } - } -} - -/// SetBlockProcessor with a simple or weighted state provider and no block -/// entity change: the block becomes the state, keeping the properties it -/// shares with the old one unless `preserve_state` is off. -#[derive(Clone, Debug)] -pub struct SetBlock { - /// The states and their weights; one state alone is a simple provider, - /// which draws nothing. - states: Vec<(BlockStateId, i32)>, - weighted: bool, - preserve: bool, - mode: Mode, -} -impl SetBlock { - pub(super) fn decode( - v: &Value, - state: impl Fn(&Value) -> Result, - ) -> Result { - let provider = &v["state_provider"]; - let (states, weighted) = match provider["type"].as_str() { - Some("minecraft:simple_state_provider") => { - (vec![(state(&provider["state"])?, 1)], false) - } - Some("minecraft:weighted_state_provider") => ( - provider["entries"] - .as_array() - .ok_or(DecodeError::Field("set_block entries"))? - .iter() - .map(|e| { - let weight = e["weight"] - .as_i64() - .ok_or(DecodeError::Field("set_block weight"))?; - Ok((state(&e["data"])?, weight as i32)) - }) - .collect::>()?, - true, - ), - _ => return Err(DecodeError::Field("set_block state_provider")), - }; - if states.is_empty() { - return Err(DecodeError::Field("set_block entries")); - } - Ok(Self { - states, - weighted, - preserve: v["preserve_state"].as_bool().unwrap_or(true), - mode: Mode::decode(v["random_mode"].as_str())?, - }) - } - /// The state to set, before `preserve`: drawn with - /// RandomSource.create(seed).forkPositional().at(the chosen position). - pub(super) fn state( - &self, - seed: i64, - piece: [i32; 3], - pivot: [i32; 3], - block: [i32; 3], - ) -> BlockStateId { - if !self.weighted { - return self.states[0].0; - } - let [x, y, z] = self.mode.select(piece, pivot, block); - let mut random = LegacyRandom::new(seed) - .fork_positional() - .at(BlockPos::new(x, y, z)); - let total: i32 = self.states.iter().map(|s| s.1).sum(); - let mut value = random.next_int_bound(total.max(1)).unwrap_or(0); - for (state, weight) in &self.states { - if value < *weight { - return *state; - } - value -= weight; - } - self.states[0].0 - } - pub(super) fn preserves(&self) -> bool { - self.preserve - } -} - -/// String.hashCode over UTF-16 units. -fn java_hash(s: &str) -> i32 { - s.encode_utf16() - .fold(0i32, |h, c| h.wrapping_mul(31).wrapping_add(i32::from(c))) -} - -fn list( - v: &Value, - resources: &StructureResources, - bindings: &FeatureBlockBindings<'_>, -) -> Result { - ProcessorList::decode(&v.to_string(), resources, bindings) -} - -/// ApplyRandomStructureProcessor: a weighted list of processor lists, one -/// drawn per block with `nextInt(total)`. -#[derive(Clone, Debug)] -pub struct ApplyRandom { - pub(super) random: RandomSettings, - lists: Vec<(ProcessorList, i32)>, - total: i32, -} -impl ApplyRandom { - pub(super) fn decode( - v: &Value, - resources: &StructureResources, - bindings: &FeatureBlockBindings<'_>, - ) -> Result { - let lists = v["processor_lists"] - .as_array() - .ok_or(DecodeError::Field("apply_random processor_lists"))? - .iter() - .map(|e| { - let weight = e["weight"] - .as_i64() - .ok_or(DecodeError::Field("apply_random weight"))?; - Ok((list(&e["data"], resources, bindings)?, weight as i32)) - }) - .collect::, DecodeError>>()?; - Ok(Self { - random: RandomSettings::decode(v.get("mode"))?, - total: lists.iter().map(|l| l.1).sum(), - lists, - }) - } - /// WeightedList.getRandom: none when the weights add up to 0. - pub(super) fn pick(&self, random: &mut impl RandomSource) -> Option<&ProcessorList> { - if self.total <= 0 { - return None; - } - let mut value = random.next_int_bound(self.total).unwrap_or(0); - for (list, weight) in &self.lists { - if value < *weight { - return Some(list); - } - value -= weight; - } - None - } -} - -/// ConditionProcessor: `then` when the condition holds for the block, else -/// `else`. -#[derive(Clone, Debug)] -pub struct Conditional { - pub(super) random: RandomSettings, - pub(super) condition: Condition, - pub(super) then: ProcessorList, - pub(super) otherwise: ProcessorList, -} -impl Conditional { - pub(super) fn decode( - v: &Value, - resources: &StructureResources, - bindings: &FeatureBlockBindings<'_>, - ) -> Result { - // A processor alone or a list of them. - let processors = |key: &str| -> Result { - match v.get(key) { - None => Ok(ProcessorList::default()), - Some(Value::Object(p)) if p.contains_key("processor_type") => Ok(ProcessorList( - vec![Processor::decode(&v[key], resources, bindings)?], - )), - Some(other) => list(other, resources, bindings), - } - }; - Ok(Self { - random: RandomSettings::decode(v.get("random_mode"))?, - condition: Condition::decode(&v["if_true"], bindings)?, - then: processors("then")?, - otherwise: processors("else")?, - }) - } -} - -/// Lithostitched's processor conditions the game runs. -#[derive(Clone, Debug)] -pub(super) enum Condition { - True, - AllOf(Vec), - AnyOf(Vec), - Not(Box), - RandomChance(f32), - /// The block placed (`input`) or the one in the world (`location`) is - /// one of these, with these property values. - MatchingBlocks { - blocks: Arc>, - properties: Vec<(String, String)>, - location: bool, - }, -} -impl Condition { - fn decode(v: &Value, bindings: &FeatureBlockBindings<'_>) -> Result { - let all = |a: &Value| -> Result, DecodeError> { - a.as_array() - .ok_or(DecodeError::Field("processor conditions"))? - .iter() - .map(|c| Self::decode(c, bindings)) - .collect() - }; - if v.is_array() { - return Ok(Self::AllOf(all(v)?)); - } - let kind = v["type"].as_str().unwrap_or_default(); - Ok(match kind.strip_prefix("lithostitched:").unwrap_or(kind) { - "true" => Self::True, - "all_of" => Self::AllOf(all(&v["conditions"])?), - "any_of" => Self::AnyOf(all(&v["conditions"])?), - "not" => Self::Not(Box::new(Self::decode(&v["condition"], bindings)?)), - "random_chance" => Self::RandomChance(super::float(v, "chance")?), - "matching_blocks" => Self::MatchingBlocks { - blocks: super::holder_set(&v["blocks"], bindings)?, - properties: match v.get("properties") { - None => Vec::new(), - Some(p) => p - .as_object() - .ok_or(DecodeError::Field("matching_blocks properties"))? - .iter() - .map(|(k, x)| { - let x = x - .as_str() - .ok_or(DecodeError::Field("matching_blocks property"))?; - Ok((k.clone(), x.to_owned())) - }) - .collect::>()?, - }, - location: match v["match_type"].as_str() { - None | Some("input") => false, - Some("location") => true, - _ => return Err(DecodeError::Field("matching_blocks match_type")), - }, - }, - _ => return Err(DecodeError::Field("processor condition type")), - }) - } - /// ProcessorCondition.test with the block placed and the one there. - pub(super) fn test( - &self, - input: BlockStateId, - location: BlockStateId, - registry: &BlockRegistry, - random: &mut impl RandomSource, - ) -> bool { - match self { - Self::True => true, - Self::AllOf(all) => all - .iter() - .all(|c| c.test(input, location, registry, random)), - Self::AnyOf(any) => any - .iter() - .any(|c| c.test(input, location, registry, random)), - Self::Not(c) => !c.test(input, location, registry, random), - Self::RandomChance(chance) => random.next_float() < *chance, - Self::MatchingBlocks { - blocks, - properties, - location: at_location, - } => { - let state = if *at_location { location } else { input }; - blocks.contains(&state) - && properties.iter().all(|(k, x)| { - registry - .state(state) - .and_then(|s| s.properties.get(k)) - .is_some_and(|v| v == x) - }) - } - } - } -} - -#[cfg(test)] -mod tests { - use super::*; - - #[test] - fn random_settings_salt_and_position() { - // ResourceLocation.hashCode: 31 * namespace + path. - let default = RandomSettings::decode(Some(&"per_piece".into())).unwrap(); - assert_eq!( - default.salt, - java_hash("lithostitched") - .wrapping_mul(31) - .wrapping_add(java_hash("default")) - ); - assert_eq!(java_hash("default"), 1544803905); - let (seed, piece, pivot, block) = (12345, [16, 64, -32], [8, 70, 8], [17, 65, -30]); - let mut ours = default.create(seed, piece, pivot, block); - let mut theirs = LegacyRandom::new(seed + i64::from(default.salt)) - .fork_positional() - .at(BlockPos::new(16, 64, -32)); - assert_eq!(ours.next_long(), theirs.next_long()); - let named: Value = serde_json::json!({"mode": "per_structure", "name": "v:roof"}); - let named = RandomSettings::decode(Some(&named)).unwrap(); - assert_eq!(named.mode, Mode::Structure); - assert_eq!( - named.salt, - java_hash("v") - .wrapping_mul(31) - .wrapping_add(java_hash("roof")) - ); - } - - #[test] - fn apply_random_draws_by_weight() { - let apply = ApplyRandom { - random: RandomSettings { - mode: Mode::Block, - salt: 0, - }, - lists: vec![ - (ProcessorList(vec![Processor::Nop]), 3), - (ProcessorList::default(), 1), - ], - total: 4, - }; - let mut ours = LegacyRandom::new(9); - let mut theirs = LegacyRandom::new(9); - for _ in 0..32 { - let draw = theirs.next_int_bound(4).unwrap(); - let picked = apply.pick(&mut ours).unwrap(); - assert_eq!(picked.0.len(), usize::from(draw < 3)); - } - } - - #[test] - fn set_block_draws_from_the_unsalted_seed() { - let (a, b) = (BlockStateId(1), BlockStateId(2)); - let set = SetBlock::decode( - &serde_json::json!({"state_provider": {"type": "minecraft:weighted_state_provider", - "entries": [{"weight": 1, "data": 1}, {"weight": 2, "data": 2}]}, - "random_mode": "per_piece"}), - |v| Ok(BlockStateId(v.as_u64().unwrap() as u32)), - ) - .unwrap(); - assert!(set.preserves()); - for x in 0..16 { - let mut java = LegacyRandom::new(77) - .fork_positional() - .at(BlockPos::new(x, 5, 3)); - let want = if java.next_int_bound(3).unwrap() < 1 { - a - } else { - b - }; - assert_eq!(set.state(77, [x, 5, 3], [0; 3], [9, 9, 9]), want); - } - } -} diff --git a/crates/horizon-world/src/worldgen/structure/ruined_portal.rs b/crates/horizon-world/src/worldgen/structure/ruined_portal.rs index 76010aa86..4f87cdd10 100644 --- a/crates/horizon-world/src/worldgen/structure/ruined_portal.rs +++ b/crates/horizon-world/src/worldgen/structure/ruined_portal.rs @@ -25,6 +25,17 @@ pub enum Vertical { InNether, } impl Vertical { + /// `RuinedPortalPiece.VerticalPlacement.getSerializedName`. + fn saved_name(self) -> &'static str { + match self { + Self::OnLandSurface => "on_land_surface", + Self::PartlyBuried => "partly_buried", + Self::OnOceanFloor => "on_ocean_floor", + Self::InMountain => "in_mountain", + Self::Underground => "underground", + Self::InNether => "in_nether", + } + } fn heightmap(self) -> HeightmapType { if self == Self::OnOceanFloor { HeightmapType::OceanFloorWg @@ -70,6 +81,9 @@ impl Setup { #[derive(Clone, Copy, Debug)] pub struct PortalProps { placement: Vertical, + mossiness: f32, + air_pocket: bool, + blackstone: bool, cold: bool, overgrown: bool, vines: bool, @@ -182,6 +196,9 @@ pub fn start( }; let props = PortalProps { placement: setup.placement, + mossiness: setup.mossiness, + air_pocket, + blackstone: setup.blackstone, cold, overgrown: setup.overgrown, vines: setup.vines, @@ -379,3 +396,28 @@ pub fn post_process(piece: &TemplatePiece, c: &mut PieceContext<'_>) -> Result<( } Ok(()) } + +impl PortalProps { + /// `RuinedPortalPiece`'s `VerticalPlacement` and `Properties` tags. + pub fn save(&self) -> [(&'static str, crate::nbt::Tag); 2] { + use crate::nbt::Tag; + let flag = |b: bool| Tag::Byte(i8::from(b)); + [ + ( + "VerticalPlacement", + Tag::String(self.placement.saved_name().into()), + ), + ( + "Properties", + Tag::compound([ + ("cold", flag(self.cold)), + ("mossiness", Tag::Float(self.mossiness.to_bits())), + ("air_pocket", flag(self.air_pocket)), + ("overgrown", flag(self.overgrown)), + ("vines", flag(self.vines)), + ("replace_with_blackstone", flag(self.blackstone)), + ]), + ), + ] + } +} diff --git a/crates/horizon-world/src/worldgen/structure/simple.rs b/crates/horizon-world/src/worldgen/structure/simple.rs index 72aab4710..d05aab20f 100644 --- a/crates/horizon-world/src/worldgen/structure/simple.rs +++ b/crates/horizon-world/src/worldgen/structure/simple.rs @@ -18,11 +18,22 @@ fn empty_processors() -> Arc { #[derive(Debug)] pub struct BuriedTreasurePiece { pub position: [i32; 3], + /// Where the chest went: the box vanilla saves once placed. + pub found: Mutex>, } impl LegacyPiece for BuriedTreasurePiece { fn bounding_box(&self) -> BoundingBox { BoundingBox::new(self.position, self.position) } + fn save(&self) -> Option { + let at = self.found.lock().unwrap().unwrap_or(self.position); + Some(super::legacy::piece_tag( + "minecraft:btp", + BoundingBox::new(at, at), + None, + 0, + )) + } fn type_name(&self) -> &'static str { "minecraft:btp" } @@ -58,6 +69,7 @@ impl LegacyPiece for BuriedTreasurePiece { } } } + *self.found.lock().unwrap() = Some(pos); create_chest(c, pos, "minecraft:chests/buried_treasure", None)?; return Ok(()); } @@ -193,10 +205,87 @@ pub fn shipwreck_too_big(template: &StructureTemplate) -> bool { template.size[0] > 32 || template.size[1] > 32 } +impl TemplatePiece { + /// `TemplateStructurePiece.addAdditionalSaveData` and its subclasses', + /// with the height a shipwreck settled on once placed. + pub fn saved(&self) -> crate::nbt::Compound { + use crate::nbt::Tag; + let flag = |b: bool| Tag::Byte(i8::from(b)); + let adjusted = match self.handler { + TemplateHandler::Shipwreck { .. } + | TemplateHandler::OceanRuin { .. } + | TemplateHandler::Igloo => *self.state.lock().unwrap(), + _ => None, + }; + let dy = adjusted.map_or(0, |y| y - self.position[1]); + let template_dy = if matches!(self.handler, TemplateHandler::Igloo) { + 0 + } else { + dy + }; + let mut tag = super::legacy::piece_tag( + self.type_name, + self.bounding_box.moved([0, dy, 0]), + Some(Direction::North), + 0, + ); + // Mansion and End City pieces keep the name inside their folder. + let name = self + .template_name + .strip_prefix("minecraft:woodland_mansion/") + .or_else(|| self.template_name.strip_prefix("minecraft:end_city/")) + .unwrap_or(&self.template_name); + let rotation = || Tag::String(self.rotation.saved_name().into()); + let mut entries = vec![ + ("TPX", Tag::Int(self.position[0])), + ("TPY", Tag::Int(self.position[1] + template_dy)), + ("TPZ", Tag::Int(self.position[2])), + ("Template", Tag::String(name.into())), + ]; + match self.handler { + TemplateHandler::Igloo => entries.push(("Rot", rotation())), + TemplateHandler::Shipwreck { beached } => entries.extend([ + ("isBeached", flag(beached)), + ("Rot", rotation()), + ("height_adjusted", flag(adjusted.is_some())), + ]), + TemplateHandler::OceanRuin { + warm, + large, + integrity, + } => entries.extend([ + ("Rot", rotation()), + ("Integrity", Tag::Float(integrity.to_bits())), + ( + "BiomeType", + Tag::String(if warm { "WARM" } else { "COLD" }.into()), + ), + ("IsLarge", flag(large)), + ]), + TemplateHandler::RuinedPortal(props) => { + entries.push(("Rotation", rotation())); + entries.push(("Mirror", Tag::String(self.mirror.saved_name().into()))); + entries.extend(props.save()); + } + TemplateHandler::Mansion => entries.extend([ + ("Rot", rotation()), + ("Mi", Tag::String(self.mirror.saved_name().into())), + ]), + TemplateHandler::Plain => entries.push(("Rot", rotation())), + } + for (key, value) in entries { + tag.insert(key.into(), value); + } + tag + } +} impl LegacyPiece for TemplatePiece { fn bounding_box(&self) -> BoundingBox { self.bounding_box } + fn save(&self) -> Option { + Some(self.saved()) + } fn after_place(&self, c: &mut PieceContext<'_>, pieces: &[BoundingBox]) -> Result<()> { match self.handler { TemplateHandler::Mansion => super::mansion::after_place(c, pieces), @@ -232,6 +321,8 @@ impl LegacyPiece for TemplatePiece { self.position[1] + height - 90 - 1, self.position[2], ]; + // The box stays moved; templatePosition goes back after placing. + *self.state.lock().unwrap() = Some(position[1]); if let Some(markers) = self.place_at(c, position, &[])? { for (marker, pos) in markers { if marker == "chest" { @@ -362,6 +453,21 @@ impl Scattered { pub fn frame(&self) -> PieceFrame { *self.frame.lock().unwrap() } + /// `ScatteredFeaturePiece`'s tag: the box and the height it settled on. + pub fn saved(&self, id: &str) -> crate::nbt::Compound { + use crate::nbt::Tag; + let f = self.frame(); + let mut tag = super::legacy::piece_tag(id, f.bounding_box, f.orientation, 0); + for (key, value) in [ + ("Width", self.width), + ("Height", self.height), + ("Depth", self.depth), + ("HPos", *self.height_position.lock().unwrap()), + ] { + tag.insert(key.into(), Tag::Int(value)); + } + tag + } /// updateAverageGroundHeight over the part of the box inside the chunk. pub fn average_ground(&self, c: &mut PieceContext<'_>, offset: i32) -> Result { if *self.height_position.lock().unwrap() >= 0 { @@ -419,12 +525,15 @@ impl Scattered { #[derive(Debug)] pub struct SwampHutPiece { pub base: Scattered, + /// spawnedWitch and spawnedCat: both spawn in the same chunk. + spawned: Mutex, } impl SwampHutPiece { pub fn new(random: &mut impl RandomSource, west: i32, north: i32) -> Self { let direction = random_horizontal(random); Self { base: Scattered::new(west, 64, north, 7, 7, 9, direction), + spawned: Mutex::new(false), } } } @@ -432,6 +541,13 @@ impl LegacyPiece for SwampHutPiece { fn bounding_box(&self) -> BoundingBox { self.base.frame().bounding_box } + fn save(&self) -> Option { + let mut tag = self.base.saved("minecraft:tesh"); + let spawned = crate::nbt::Tag::Byte(i8::from(*self.spawned.lock().unwrap())); + tag.insert("Witch".into(), spawned.clone()); + tag.insert("Cat".into(), spawned); + Some(tag) + } fn type_name(&self) -> &'static str { "minecraft:tesh" } @@ -500,6 +616,7 @@ impl LegacyPiece for SwampHutPiece { c.world .entity(super::legacy::spawn_nbt(id, pos, true, true))?; } + *self.spawned.lock().unwrap() = true; } Ok(()) } diff --git a/crates/horizon-world/src/worldgen/structure/start.rs b/crates/horizon-world/src/worldgen/structure/start.rs index ea4549131..810332c61 100644 --- a/crates/horizon-world/src/worldgen/structure/start.rs +++ b/crates/horizon-world/src/worldgen/structure/start.rs @@ -694,6 +694,13 @@ impl Piece { Self::Legacy(p) => p.type_name(), } } + /// `StructurePiece.createTag`; None for a type Horizon cannot save yet. + pub fn save(&self) -> Option { + match self { + Self::Pool(p) => Some(p.save()), + Self::Legacy(p) => p.save(), + } + } } fn legacy(pieces: Vec) -> Vec { pieces @@ -735,6 +742,26 @@ pub struct StructureStart { /// Piece union, inflated by 12 for terrain-adapting structures. pub bounding_box: BoundingBox, } +impl StructureStart { + /// `StructureStart.createTag` in its own chunk; None while one of its + /// pieces cannot be saved. `references` counts `addReference` calls, + /// which only locating structures makes: 0 in a freshly made world. + pub fn save(&self) -> Option { + use crate::nbt::Tag; + let children: Option> = self + .pieces + .iter() + .map(|p| p.save().map(Tag::Compound)) + .collect(); + Some(Tag::compound([ + ("id", Tag::String(self.name.as_str().into())), + ("ChunkX", Tag::Int(self.chunk.x)), + ("ChunkZ", Tag::Int(self.chunk.z)), + ("references", Tag::Int(0)), + ("Children", Tag::List(children?)), + ])) + } +} /// A block of a noise column (ChunkGenerator.getBaseColumn), by what /// structures ask of it. @@ -935,6 +962,7 @@ fn try_generate( let stub = top_of_chunk_center(context, chunk, HeightmapType::OceanFloorWg)?; let piece = super::simple::BuriedTreasurePiece { position: [chunk.x * 16 + 9, 90, chunk.z * 16 + 9], + found: std::sync::Mutex::new(None), }; (stub, legacy(vec![piece])) } diff --git a/crates/horizon-world/src/worldgen/structure/stronghold.rs b/crates/horizon-world/src/worldgen/structure/stronghold.rs index 94042ba6f..29f7cd149 100644 --- a/crates/horizon-world/src/worldgen/structure/stronghold.rs +++ b/crates/horizon-world/src/worldgen/structure/stronghold.rs @@ -1075,6 +1075,48 @@ impl LegacyPiece for StrongholdPiece { fn bounding_box(&self) -> BoundingBox { self.frame.bounding_box } + fn save(&self) -> Option { + use crate::nbt::Tag; + let flag = |b: bool| Tag::Byte(i8::from(b)); + let mut tag = super::legacy::piece_tag( + self.type_name(), + self.frame.bounding_box, + self.frame.orientation, + self.depth, + ); + // SmallDoorType.LEGACY_CODEC: the enum name. + let door = match self.door { + Door::Opening => "OPENING", + Door::Wood => "WOOD_DOOR", + Door::Grates => "GRATES", + Door::Iron => "IRON_DOOR", + }; + let placed = *self.placed.lock().unwrap(); + let [a, b, c, d] = self.flags; + let mut entries = vec![("EntryDoor", Tag::String(door.into()))]; + match self.kind { + Kind::ChestCorridor => entries.push(("Chest", flag(placed))), + Kind::Filler => entries.push(("Steps", Tag::Int(self.value))), + Kind::FiveCrossing => entries.extend([ + ("leftLow", flag(a)), + ("leftHigh", flag(b)), + ("rightLow", flag(c)), + ("rightHigh", flag(d)), + ]), + Kind::Library => entries.push(("Tall", flag(a))), + Kind::PortalRoom => entries.push(("Mob", flag(placed))), + Kind::RoomCrossing => entries.push(("Type", Tag::Int(self.value))), + // StartPiece is a StairsDown that is the source. + Kind::StairsDown => entries.push(("Source", flag(false))), + Kind::Start => entries.push(("Source", flag(true))), + Kind::Straight => entries.extend([("Left", flag(a)), ("Right", flag(b))]), + _ => {} + } + for (key, value) in entries { + tag.insert(key.into(), value); + } + Some(tag) + } fn type_name(&self) -> &'static str { match self.kind { Kind::Straight => "minecraft:shs", diff --git a/crates/horizon-world/src/worldgen/structure/temple.rs b/crates/horizon-world/src/worldgen/structure/temple.rs index 195f37791..c328f0f55 100644 --- a/crates/horizon-world/src/worldgen/structure/temple.rs +++ b/crates/horizon-world/src/worldgen/structure/temple.rs @@ -82,6 +82,16 @@ impl LegacyPiece for DesertPyramidPiece { fn bounding_box(&self) -> BoundingBox { self.base.frame().bounding_box } + fn save(&self) -> Option { + let mut tag = self.base.saved("minecraft:tedp"); + for (i, placed) in self.placed_chest.lock().unwrap().iter().enumerate() { + tag.insert( + format!("hasPlacedChest{i}").as_str().into(), + crate::nbt::Tag::Byte(i8::from(*placed)), + ); + } + Some(tag) + } fn type_name(&self) -> &'static str { "minecraft:tedp" } @@ -448,6 +458,22 @@ impl LegacyPiece for JungleTemplePiece { fn bounding_box(&self) -> BoundingBox { self.base.frame().bounding_box } + fn save(&self) -> Option { + let mut tag = self.base.saved("minecraft:tejp"); + let placed = *self.placed.lock().unwrap(); + for (key, value) in [ + "placedMainChest", + "placedHiddenChest", + "placedTrap1", + "placedTrap2", + ] + .into_iter() + .zip(placed) + { + tag.insert(key.into(), crate::nbt::Tag::Byte(i8::from(value))); + } + Some(tag) + } fn type_name(&self) -> &'static str { "minecraft:tejp" } diff --git a/docs/agent-control.md b/docs/agent-control.md index 903a48b2f..8573bb711 100644 --- a/docs/agent-control.md +++ b/docs/agent-control.md @@ -3,7 +3,7 @@ A player's own AI agent (Claude Code, Codex, Cursor, any MCP client) or a script can do everything a player does with the mouse and keyboard, in the launcher and in the game. This page covers developers: the surfaces, the full inventory, and the rules every new command follows. -Players read [Control Horizon with your AI agent](../website/docs/agents.md) +Players read [Control Horizon with your AI agent](https://playhorizon.dev/docs/agents) (playhorizon.dev/docs/agents). The command lists are generated, so they can't drift: diff --git a/docs/api/README.md b/docs/api/README.md index ef3649105..ce28dc262 100644 --- a/docs/api/README.md +++ b/docs/api/README.md @@ -53,4 +53,4 @@ Every page has the same parts: **Overview** (what you can build), **Guide** (whe The website shows these pages at [playhorizon.dev/docs/api](https://playhorizon.dev/docs/api), built from this folder, and a summary for players and authors at [playhorizon.dev/docs/apis](https://playhorizon.dev/docs/apis) -(`website/docs/apis.md`). +(in the website's repository, ludovic111/horizon-site). diff --git a/docs/api/mod-index.md b/docs/api/mod-index.md index 6b807d950..ea605fbc7 100644 --- a/docs/api/mod-index.md +++ b/docs/api/mod-index.md @@ -1,7 +1,7 @@ # The registry index and `.hpack` Horizon's registry lists what is made for Horizon and reviewed: mods (`.hmod`), modpacks (`.hpack`), resource packs -and, once their format exists, Horizon shader packs. Submissions are pull requests in +and Horizon shader packs (`.hshader`, [shaders.md](../shaders.md)). Submissions are pull requests in [ludovic111/horizon-mods](https://github.com/ludovic111/horizon-mods); merging one publishes it. The launcher and the website read one file, `index.json`, which that repository's CI builds. The Rust types and every check below are `horizon_mods::index` and `horizon_mods::modpack` (feature `index`); the sample is @@ -18,10 +18,10 @@ Level: preview ([stability.md](stability.md)). Schema 1. "projects": [{ "id": "coords_hud", "kind": "mod", "name": "Coordinates HUD", "summary": "One line.", "description": "Markdown.", "authors": ["Horizon"], "owners": ["ludovic111"], - "license": "MIT", "source": "https://github.com/...", "icon": "https://...png", "key": "RWT...", + "license": "MIT", "source": "https://github.com/...", "icon": "https://...png", "key": "RWT...", "downloads": 1234, "versions": [{ "version": "0.1.0", "published": "2026-10-24", "changelog": "", - "api": "0.1", "side": "client", "capabilities": ["game-read", "hud", "chat"], "game": "26.3", + "api": "0.1", "side": "client", "capabilities": ["game-read", "hud", "chat"], "api_level": 0, "game": "26.3", "file": { "name": "coords_hud-0.1.0.hmod", "url": "https://github.com/ludovic111/horizon-mods/releases/download/...", "size": 438, "sha256": "e113...", "signature": "untrusted comment: ...\n...\ntrusted comment: ...\n...\n" } }] @@ -41,8 +41,10 @@ Level: preview ([stability.md](stability.md)). Schema 1. | `icon` | `https://`, optional. | | `key` | The author's [minisign](https://jedisct1.github.io/minisign/) public key. When set, every version must be signed with it; an update signed with another key is refused. Absent: the project is unsigned and the launcher says so. | | `versions` | Newest first, at least one. | +| `downloads` | How many times its files were downloaded, every version together: GitHub's count of each release asset, summed by the publish job, which runs every hour. Absent until a file is downloaded. Read-only: never in an entry. | | `api` | A mod's API line (its manifest's `api`); a modpack's manifest format (`1`). | | `side`, `capabilities` | A mod's, read from its manifest by CI, never typed by hand. | +| `api_level` | The mod API level a mod's code needs ([stability.md](stability.md#mod-api-levels)): its newest imported function's, read from the file by CI. Absent for content-only mods and in indexes built before levels. Installers take the newest version whose level the running game serves. | | `game` | The Minecraft version it is for. | | `requires` | A modpack's mods: `{ id, version, sha256 }`, each a version in this index with that hash. | | `file` | A plain name with the kind's extension (`.hmod`, `.hpack`, `.zip`), an `https://` URL, the size (at most 64 MiB), the lowercase hex SHA-256, and the `.minisig` text when the project has a key. | @@ -57,9 +59,11 @@ changing what one means, makes schema 2. 1. Its size and SHA-256 are the ones the entry lists, and it isn't revoked. 2. With a project key: its signature verifies with that key (minisign's prehashed and legacy signatures both). -3. What the file says matches the entry: a mod's `horizon-mod.toml` (id, version, API, side, capabilities) and its +3. What the file says matches the entry: a mod's `horizon-mod.toml` (id, version, API, side, capabilities), its API + level when the entry lists one, and its content's fence ([mods.md](../mods.md#content-mods-api-02)); a modpack's manifest (id, version, format, game, - mods); a resource pack's `pack.mcmeta`. + mods); a resource pack's `pack.mcmeta`; a shader pack's `horizon_shader_api::check` and manifest (id, version, + shader API). 4. A kind this build can't install is refused with "this Horizon can't install a … yet". The game still checks a mod's component imports against its capabilities when it starts it, as for any mod. @@ -99,7 +103,7 @@ own check (`index::inspect`): a mod's API, side and capabilities, a modpack's mo ```toml id = "coords_hud" # the file's name, and the manifest's id -kind = "mod" # mod | modpack | resourcepack; shader once its format exists +kind = "mod" # mod | modpack | resourcepack | shader name = "Coordinates HUD" summary = "One line, at most 160 characters." description = """Markdown.""" # optional @@ -156,10 +160,15 @@ How the repository runs (its workflows are in `.github/workflows/`): - **Taking a file down** is a pull request adding it to `revoked.toml`. Removing an entry outright (a test, a project nobody installed) fails `registry review` on purpose and needs an administrator's merge. -Kinds open to submissions: `mod`, `modpack`, `resourcepack`. `shader` is in the schema and stays closed until -Horizon's own shader pack format exists (Iris and OptiFine packs are for the Modrinth browser); its check will compile -the pack in a headless Horizon. A new kind gets its own check before it opens. +Kinds open to submissions: `mod`, `modpack`, `resourcepack`, `shader`. A shader pack (`.hshader`) passes +`horizon_shader_api::check`, the check the game runs before it loads one (`horizon-shader check`, [shaders.md](../shaders.md)): +every stage validated by naga and translated for Vulkan, Metal and DirectX 12; its manifest's id, version and shader +API line are its facts. Iris and OptiFine packs are for the Modrinth browser. A new kind gets its own check before it +opens. ## Changelog +- 2026-10-26: `projects[].downloads`, GitHub's download counts of a project's files, refreshed every hour. +- 2026-10-26: the launcher installs `shader` files into `shaderpacks/`; the sample index lists one (`glow`). +- 2026-10-25: `shader` opens, checked by `horizon_shader_api::check`; its files are `.hshader`. - Schema 1 (2026-10-24): kinds `mod`, `modpack`, `resourcepack`, `shader`; `.hpack` format 1. diff --git a/docs/api/mods-reference.md b/docs/api/mods-reference.md index 14c815958..a197b2c04 100644 --- a/docs/api/mods-reference.md +++ b/docs/api/mods-reference.md @@ -1,7 +1,7 @@ # Mod API reference -The contract between Horizon and its mods: the WIT package `horizon:mods@0.1.0`, every interface, type, function and hook in it, and the capabilities a manifest may list. The guide is [mods.md](../mods.md); stability and versions: [stability.md](stability.md). Manifest `api` lines this game serves: `0.1`, `0.2`. +The contract between Horizon and its mods: the WIT package `horizon:mods@0.1.0`, every interface, type, function and hook in it, and the capabilities a manifest may list. The guide is [mods.md](../mods.md); stability and versions: [stability.md](stability.md). Manifest `api` lines this game serves: `0.1`, `0.2`, `0.3`. ## Capabilities @@ -16,12 +16,22 @@ The contract between Horizon and its mods: the WIT package `horizon:mods@0.1.0`, | `ui` | [`ui`](#ui) | show its own screens and a settings page | | `render` | [`render`](#render) | draw on your screen, shake and zoom the camera | | `input` | [`input`](#input) | see the keys you hold and your clicks, take over the use button on its own items and the mouse wheel, and add keys | +| `players` | [`players`](#players) | see who is on the server and message them | ## World `horizon-mod` +A client mod: runs in the player's game. + - Imports (what the game offers): `log`, `game`, `chat`, `hud`, `storage`, `command` - Exports (what the mod provides): `events` +## World `horizon-server-mod` + +A server mod (manifest `side = "server"`, `api = "0.3"`, experimental): runs where the world is simulated, on the dedicated server, a LAN host and single player's own server. + +- Imports (what the game offers): `log`, `storage`, `players` +- Exports (what the mod provides): `server-events` + ## World `horizon-ui-mod` A mod with widgets (capability `ui`): the SDK builds every mod against this world. Mods built for `horizon-mod` alone (no `ui-events` export) still load and simply hear nothing of their widgets. @@ -66,7 +76,7 @@ The mod's log, in the game's log under the mod's id. Always granted. Access: capability `game-read`. -Capability `game-read`: the local player and the world clock. +Capability `game-read`: the local player, the world clock and the block the player looks at. ### record `player` @@ -88,10 +98,25 @@ Capability `game-read`: the local player and the world clock. | `game-time` | `u64` | Ticks since the world was created. | | `day-time` | `u64` | 24000 ticks per day; 0 is 6:00 on the first day. | +### record `hit` + +A block along the player's view. + +| Field | Type | | +| --- | --- | --- | +| `block-x` | `s32` | The block hit. | +| `block-y` | `s32` | | +| `block-z` | `s32` | | +| `x` | `f64` | The point on its face where the view meets it. | +| `y` | `f64` | | +| `z` | `f64` | | +| `block` | `string` | `minecraft:stone`, ... | + | Function | Signature | What it does | | --- | --- | --- | | `get-player` | `func() -> option` | None on the title screen. | | `get-clock` | `func() -> option` | None on the title screen. | +| `raycast` | `func(distance: f32) -> option` | The first block along the player's view (fluids pass), up to `distance` blocks (at most 1024; past the loaded chunks, across the distant terrain when LOD Distance is on), as of this tick. None when nothing is hit, and on the title screen. | ## `chat` @@ -434,3 +459,76 @@ What the game calls. Only the hooks `init` asks for are ever called. | `frame` | `func(seconds: f32)` | Each rendered frame, with the seconds since the last one. | | `command` | `func(name: string, args: string) -> result, string>` | `/name args`: ok(some(text)) is shown as feedback, err(text) in red. | | `chat` | `func(text: string)` | Each chat line the player receives, as plain text. | + +## `players` + +Access: capability `players`. + +Capability `players`, server mods only (manifest `api = "0.3"`, experimental): the players on the server, and messages to them. + +### enum `game-mode` + +| Case | | +| --- | --- | +| `survival` | | +| `creative` | | +| `adventure` | | +| `spectator` | | + +### record `player` + +| Field | Type | | +| --- | --- | --- | +| `id` | `string` | The player's UUID, `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`. | +| `name` | `string` | | +| `x` | `f64` | Feet position, in blocks. | +| `y` | `f64` | | +| `z` | `f64` | | +| `dimension` | `string` | `minecraft:overworld`, `minecraft:the_nether`, ... | +| `game-mode` | `game-mode` | | +| `health` | `f32` | Hit points as vanilla counts them: 20 is full health without effects. | + +| Function | Signature | What it does | +| --- | --- | --- | +| `online` | `func() -> list` | The players online, in the order they joined. | +| `tell` | `func(player: string, text: string) -> bool` | A system message to one player, after the mod's name; false when no player with that id is online. Up to 8 messages per call. | +| `broadcast` | `func(text: string)` | A system message to every player and the server's log, after the mod's name. Counts toward the same 8 per call. | + +## `server-events` + +Access: exported by the mod: the game calls it. + +What the server calls in a server mod (manifest `api = "0.3"`, experimental). Only the hooks `init` asks for are ever called. The player in each event is as the server saw them when it happened. + +### type `player` + +`type player = player` + +### record `registration` + +| Field | Type | | +| --- | --- | --- | +| `commands` | `list` | Commands players may type, without the slash. A name vanilla already uses is refused (vanilla's command runs). | +| `tick` | `bool` | Call `tick` every server tick (20 per second). | +| `joins` | `bool` | Call `player-joined` and `player-left`. | +| `chat` | `bool` | Call `chat` for each chat message a player sends. | +| `blocks` | `bool` | Call `block-broken` and `block-placed`. | + +### record `block-pos` + +| Field | Type | | +| --- | --- | --- | +| `x` | `s32` | | +| `y` | `s32` | | +| `z` | `s32` | | + +| Function | Signature | What it does | +| --- | --- | --- | +| `init` | `func() -> result` | Once, after loading. An error keeps the mod off and is logged. | +| `tick` | `func(tick: u64)` | Each server tick, with the server's tick counter. | +| `player-joined` | `func(player: player)` | A player joined the server; they are in `players.online` already. | +| `player-left` | `func(player: player)` | A player left the server; they are no longer in `players.online`. | +| `chat` | `func(player: player, text: string)` | A chat message a player sent, as plain text. | +| `command` | `func(player: player, name: string, args: string) -> result, string>` | `/name args` typed by `player`: ok(some(text)) is their feedback, err(text) their error in red. | +| `block-broken` | `func(player: player, pos: block-pos, state: string)` | A player broke the block at `pos` in their dimension: `state` is what was there, as `minecraft:oak_log[axis=y]`. | +| `block-placed` | `func(player: player, pos: block-pos, state: string)` | A player placed `state` at `pos` in their dimension. | diff --git a/docs/api/mods.md b/docs/api/mods.md index 211a06f8b..1fc7a834e 100644 --- a/docs/api/mods.md +++ b/docs/api/mods.md @@ -1,7 +1,7 @@ # Mod API -Mods are Rust crates compiled to sandboxed WebAssembly components. They run in the player's game and, once server -mods land, wherever a world is simulated. Design and the runtime: [mods.md](../mods.md). +Mods are Rust crates compiled to sandboxed WebAssembly components. Client mods run in the player's game; server mods +(experimental) run wherever a world is simulated: single player, a LAN host, the dedicated server. Design and the runtime: [mods.md](../mods.md). ## Overview @@ -13,14 +13,14 @@ the player before the mod is turned on, and checked against the component's real | | Count | | --- | --- | -| Interfaces the game offers | 5: `log`, `game`, `chat`, `hud`, `storage` | -| Functions in them | 9 | -| Hooks a mod exports | 5: `init`, `tick`, `frame`, `command`, `chat` | -| Capabilities | 5: `game-read`, `chat`, `hud`, `storage`, `registries` | -| Manifest `api` lines served | 2: `0.1` (code), `0.2` (content) | -| SDK | the `Mod` trait (5 methods), `Registration` (4 builders), `export_mod!`, log helpers | +| Interfaces the game offers | 6: `log`, `game`, `chat`, `hud`, `storage`; `players` for server mods | +| Functions in them | 12 | +| Hooks a mod exports | 5: `init`, `tick`, `frame`, `command`, `chat`; a server mod 8: `init`, `tick`, `player-joined`, `player-left`, `chat`, `command`, `block-broken`, `block-placed` | +| Capabilities | 6: `game-read`, `chat`, `hud`, `storage`, `registries`, `players` | +| Manifest `api` lines served | 3: `0.1` (code), `0.2` (content), `0.3` (server mods, experimental) | +| SDK | the `Mod` trait (5 methods), `Registration` (4 builders), `export_mod!`, log helpers; `server::ServerMod` (8 methods), `server::Registration` (5 builders), `export_server_mod!` | | `cargo horizon-mod` | `new` (templates `code` and `content`), `build`, `run`, `test`, `check` | -| Example mods | `coords-hud` (code), `ruby-content` (content) | +| Example mods | `coords-hud` (code), `ruby-content` (content), `welcome` (server) | ## Guide @@ -49,6 +49,8 @@ call, 4 MiB of storage, fuel per call). - `crates/horizon-mod-sdk/examples/coords-hud`: coordinates, facing and time on the HUD; `/where`, `/coords`; storage. - `crates/horizon-mod-sdk/examples/ruby-content`: no code; a gem and a block of ruby from vanilla templates, with their recipes, loot, tags, models, textures and names. +- `crates/horizon-mod-sdk/examples/welcome`: a server mod; greets players who join, announces newcomers (kept in + storage), `/online` and `/mined`. - `crates/horizon-mods/tests/guest`: a mod that misbehaves on command (spins, panics, grows its memory), for the sandbox tests. @@ -78,15 +80,17 @@ scripting runtime in the game. ## Stability Preview ([stability.md](stability.md)): API 0.1 and content 0.2 are served together; a mod built for 0.1.0 keeps -loading on every 0.1.x game. Server mods come as their own line, `api = "0.3"`, experimental first. +loading on every 0.1.x game. Server mods are their own line, `api = "0.3"`, experimental: they may change in any +release. ## Not there yet What real mods need next, in the order modpacks and servers need it: -- **Server mods** (`api = "0.3"`): the same component running on the server thread and the dedicated server, with world events (block - broken or placed, entity spawned or killed, player joined or left), game rules and server commands with typed - arguments. +- **More for server mods** (`api = "0.3"`, [Server mods](../mods.md#server-mods-api-03-experimental)): they run + on the server thread, a LAN host and the dedicated server today, with joins, chat, commands and players' block + breaking and placing; next entity events, game rules, server commands with typed arguments sent to clients' + command trees. - **World and blocks**: read blocks, block states and biomes in loaded chunks; change them through the server's block log, so clients and the parity harnesses see vanilla's updates. - **Items and inventories**: the player's inventory, held item and open container; item stacks with components. @@ -102,6 +106,9 @@ What real mods need next, in the order modpacks and servers need it: ## Changelog +- Server mods run in the game: single player (server thread and in-frame), LAN hosts, the dedicated server. +- API 0.3 (server mods, experimental): world `horizon-server-mod`, capability `players`, the `server-events` + hooks; SDK `server::ServerMod`; example `welcome`. - SDK: `cargo horizon-mod test` and `horizon_mods::testing`, test scripts in TOML; the template has one. - Experimental: `ui` button widget; `render.set-corner`, `text-width`, `frame-stats`; `input.mapping`, `clicks-per-second` (what the official FPS, keystrokes and zoom mods need). diff --git a/docs/api/shaders.md b/docs/api/shaders.md index 675c5e3fc..faf662b0e 100644 --- a/docs/api/shaders.md +++ b/docs/api/shaders.md @@ -91,11 +91,13 @@ pack exist ([stability.md](stability.md)). ## Not there yet -The stages and everything that runs a pack (the format above is read and checked). The order: the renderer hooks shared with the format loader, then the material and post -stages with options and hot reload, then the overlay, lighting, sky and shadow stages. +Option values other than the defaults (the three stages run, with hot reload), then the overlay, lighting and shadow +stages. ## Changelog +- 2026-10-26: the material stage in the game: terrain's surfaces through the pack's `material`. +- 2026-10-26: the sky stage in the game: the pack's `sky` gets vanilla's colour along each ray. - 2026-10-26: the post stage in the game (`HORIZON_SHADER_PACK`, hot reload with the last good pack kept). - 2026-10-25: `horizon-shader` (`new`, `check`, `pack`), three templates, the example pack and the guide. - 2026-10-25: the check (naga validation, signatures, options, budgets, SPIR-V/Metal/HLSL translation). diff --git a/docs/api/stability.md b/docs/api/stability.md index 5c1b32362..f6b40fabe 100644 --- a/docs/api/stability.md +++ b/docs/api/stability.md @@ -34,6 +34,22 @@ Not breaking: a new function, interface, capability, command, endpoint, tool or argument or JSON field (readers must ignore fields they don't know); a new WIT function or type (mods built earlier don't import it); faster, or fixing behaviour to what the reference already says. +### Mod API levels + +A new WIT function doesn't break older mods, but a mod that calls it can't run on a Horizon from before it. So every +function the game offers mods has an **API level**, the one it arrived at (`crates/horizon-mods/src/api_level.rs`): +level 0 is the contract of Horizon 0.2.67 to 0.2.69, level 1 adds `render.set-minimap` and server mods' `players`, level 2 `game.raycast`. A mod needs the level of +the newest function it imports (a component imports only the functions it calls). The level is read from the file, +never declared: + +- the game refuses a mod that needs a function it doesn't have, with "made for a newer Horizon (it uses + render.set-minimap): update Horizon to run it", instead of a linking error; +- the registry's CI writes each mod version's level into the index (`api_level`), and installers take the newest + version the running game can run. + +A pull request that adds a function lists it in `api_level.rs` at the next level and raises `LEVEL`; the +`api_reference` test fails until it does. + ## Stability levels Every part of an API has one level, shown in its reference and its surface page. @@ -92,7 +108,7 @@ Deprecations and breaking changes are in bold. The release notes of the game rel | Mod API: `render` (HUD shapes, camera shake and zoom; drawn by the game, no mod shaders) | experimental | manifest `experimental = ["render"]` | | Mod API: `input` (claimed items' use, the mod's keys, the mouse wheel) | experimental | manifest `experimental = ["input"]` | | Content mods (`registries`: data-driven blocks and items) | preview | manifest `api = "0.2"` | -| Server mods (events, world, server commands) | not started | manifest `api = "0.3"`, experimental first | +| Server mods: world `horizon-server-mod`, `players`, `server-events` | experimental | manifest `api = "0.3"` | | Script mods (Lua run by an interpreter mod, [mods.md](mods.md#ways-in)) | not started | | | `cargo horizon-mod` (`new`, `build`, `run`), `horizon-mod-sdk` | preview | 0.1.0 | | Shader API | not started | | diff --git a/docs/architecture.md b/docs/architecture.md index f95073e57..0350bd1ea 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -51,7 +51,7 @@ file selects ~103. | 34 | Multiplayer and LAN screens, friends (44) | `L/multiplayer.rs`, `G/lan_screen.rs`, `G/friends.rs`, `L/friends_screen.rs`, `crates/horizon-friends/`, `crates/horizon-relay/` | lan, world_options; `python3 tools/test_friends.py` | | 35 | Dispensers (43) | `G/dispenser.rs`, `G/dispense_fixture.rs` (the harness side) | dispenser | | 36 | Audio and music (38) | `L/audio.rs`, `L/sound_engine.rs`, `L/sound_events.rs`, `L/music.rs`, `G/music.rs`, `L/ambience.rs`, `G/subtitle_hud.rs` | sound_engine, sound_event, music, situational_music, ambient_sound, subtitle | -| 37 | Integrated server and levels (34) | `G/integrated.rs`, `G/levels.rs`, `G/server_travel.rs` | server_dimension_players, `lan_e2e --server-thread` (portals, levels, distance, lava) | +| 37 | Integrated server and levels (34) | `G/integrated.rs`, `G/levels.rs`, `G/server_travel.rs` | server_dimension_players, `lan_e2e` (server-thread by default; portals, levels, distance, lava) | | 38 | Command parsing (34) | `L/command/` (`args.rs`, `selector.rs`, `tree_*.rs`, `vanilla.rs`) | command_parse (corpus `tools/command_parse_corpus.py`) | | 39 | Benchmarks and telemetry (34) | `L/benchmark.rs`, `tools/perf_bench.py`, `L/telemetry.rs`, `crates/horizon-telemetry*/`, `crates/horizon-bench/` | `python3 -m unittest tests.test_perf_bench`; [benchmark.md](benchmark.md) | | 40 | Explosions and TNT (31) | `G/explosion.rs`, `G/tnt.rs` | lan_e2e blast; no dedicated harness yet | diff --git a/docs/design-system.md b/docs/design-system.md index e1417f749..0b171d4c2 100644 --- a/docs/design-system.md +++ b/docs/design-system.md @@ -8,8 +8,8 @@ Horizon's own settings are pages built from vanilla's widgets, the way mods add The tokens live in one place, `crates/horizon-theme`. The launcher (`launcher/src/theme.rs`) and the game (`crates/horizon-client/src/ui_theme.rs`) read them as Rust constants, and the website reads them as CSS custom properties generated from the same crate -(`cargo run -p xtask -- tokens` writes `website/src/tokens.css`; a test fails when the file is -out of date). Change a value in the crate and all three follow. +(`cargo run -p xtask -- tokens` writes `crates/horizon-theme/tokens.css`, which the website's build +reads from main; a test fails when the file is out of date). Change a value in the crate and all three follow. ## Where it comes from @@ -140,7 +140,7 @@ Geist (400, 500, 600) and Geist Mono (400), bundled under the SIL Open Font Lice landscape banner with the hero, the version picker and Play; Mods holds the mod, resource pack and modpack tabs; Versions and Patch notes are lists of panels; Settings is grouped panels of rows. Dark by default, Light or System in Settings (Appearance). -- **Website** (`website/`): the Blocks look below. The same page structure as before (what it +- **Website** (ludovic111/horizon-site): the Blocks look below. The same page structure as before (what it is, screenshots, parity, launcher, patch notes, community), headings in Pixelify Sans, lists as stacks of panels, the stone texture behind the page and Horizon's pixel landscape (a dawn or a sunset) behind the hero. Light and dark follow the system, with a toggle. A giant wordmark in @@ -168,11 +168,16 @@ of the main action. The game's menus keep `LIGHT` and `DARK`. ships no third-party pictures. The Horizon instance shows a grass block drawn from the player's own prepared Minecraft textures. Sources are named in text ("from Modrinth"): Modrinth's logo is all rights reserved, so it is not shown. +- **Partner banner**: the one exception to shipping no third-party pictures. Sculk, a server host, + sponsors Horizon: its banner (`launcher/assets/sculk-banner.webp`, `launcher/src/partner.rs`) sits + under a muted mono "Partner" label at the end of the Servers page and of Home, below Play, and opens + Sculk's page in the browser. The website shows the same banner the same way on Home and the hosting + docs, as a `rel="sponsored"` link. - **Pixel art drawn in code.** The stone behind the pages is close shades of the page colour (`TILE_SHADES`), never Minecraft's stone; the landscape is a banded sky, a sun cut in slices like the mark, hills and square trees (a sunset in dark, a dawn in light). The launcher bakes them in `launcher/src/art.rs` at the window's scale so each texel covers whole device pixels; the website - draws them in `website/scripts/art.mjs`. + draws them in its `scripts/art.mjs`. - **Icons**: Pixelarticons (MIT), 24 unit pixel SVGs in `crates/horizon-theme/icons/pixel/`, tinted with the text colour. - **Contrast**: every text colour meets WCAG AA (4.5:1) on the panels, the page and the lightest diff --git a/docs/extras.md b/docs/extras.md index aa87c1adf..ac0196c17 100644 --- a/docs/extras.md +++ b/docs/extras.md @@ -1,6 +1,6 @@ # Horizon extras -Optional conveniences built into the client: fullbright, dynamic lights, a minimap, auto-reconnect, +Optional conveniences built into the client: fullbright, dynamic lights, 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. @@ -12,8 +12,8 @@ again restores vanilla's behaviour completely. | Settings, parsing and saving | `crates/horizon-client/src/extras.rs` | | 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` | +| HUD drawing (a mod's minimap, corner stacking) | `crates/horizon-client/src/extras_hud.rs` | +| Minimap colours, tiles and image (for `render.set-minimap`) | `crates/horizon-client/src/minimap.rs` | | Reconnect policy and backoff | `crates/horizon-client/src/reconnect.rs` | | Game glue (input hooks, per-frame update) | `crates/horizon-client/src/game/extras.rs` | | Mouse Tweaks-style controls, sort buttons | `crates/horizon-client/src/game/tweaks.rs` | @@ -62,7 +62,7 @@ in Controls, and adding one would put a non-vanilla mapping into `options.txt`. ### Moved to the mod browser -The **FPS counter**, **Keystrokes** and **Zoom** are official mods now (`mods/official/`, [mods.md](mods.md#horizons-official-mods)), +The **FPS counter**, **Keystrokes**, **Zoom** and the **Minimap** 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 (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 @@ -71,19 +71,14 @@ SHA-256, signature, manifest); if it fails (offline), the next start tries again keys and lists what was done in `movedToMods`. Code: `crates/horizon-client/src/moved_extras.rs`, `game/moved_extras.rs`. -### Minimap (`minimap`, default off) -- A corner map (top right by default), square or round, small/medium/large, - zoom 0.5 to 4 blocks per pixel, rotating with the player or north up, with the - player arrow (vanilla's map decoration sprite). -- Colours are vanilla's `MapColor` per block, as map items use, with the map - item's height shading and water-depth dithering. -- Underground, in the Nether and under any roof, it maps the floor around the - player's height instead of the top block, so caves read sensibly. -- Cost: one cached 16x16 tile per loaded chunk (packed map colour and height). - Tiles are filled nearest first and refreshed when blocks change, within a time - budget of 0.3 ms a frame; composing the 128x128 image is a few thousand - lookups, done only when the view moved or a tile changed, and uploaded into a - dedicated atlas slot. With the minimap off nothing runs. +The game still draws the minimap, for the mod (`render.set-minimap`, [mods.md](mods.md)): +- a corner map (top right by default), square or round, small/medium/large, zoom 0.5 to 4 blocks per pixel, rotating + with the player or north up, with the player arrow (vanilla's map decoration sprite); +- vanilla's `MapColor` per block, as map items use, with the map item's height shading and water-depth dithering; +- underground, in the Nether and under any roof, the floor around the player's height instead of the top block; +- one cached 16x16 tile per loaded chunk (packed map colour and height), filled nearest first and refreshed when + blocks change within 0.3 ms a frame; the 128x128 image is recomposed only when the view moved or a tile changed, and + uploaded into a dedicated atlas slot. With no mod showing a map, nothing runs. ### Auto-reconnect (`autoReconnect`, default off) - On the "Connection lost" screen after a multiplayer connection drops, a @@ -140,11 +135,11 @@ and the container screen tests are unchanged). the world, like vanilla's HUD. Extras in the top left corner give way to the debug screen (F3), which shows the FPS anyway. - Corners stack: extras placed in the same corner stack downward (top corners) - or upward (bottom corners) in the order minimap, then mods' panels. The top + or upward (bottom corners) in the order a mod's minimap, then mods' panels. The top right corner starts below the status effect icons. ## Perf budget Off: a flag check per frame per extra (no allocations, no world access). -On: the minimap stays under 0.3 ms of CPU +A mod's minimap stays under 0.3 ms of CPU per frame (tile budget) plus a 64 KiB texture upload when its image changes. diff --git a/docs/graphics.md b/docs/graphics.md index d4261df81..dcba29773 100644 --- a/docs/graphics.md +++ b/docs/graphics.md @@ -21,14 +21,16 @@ Every row has a one-line description and its cost in frame time (none, low, medi | Quality | smooth lighting, mipmap levels, biome blend, clouds, cloud distance, weather radius, particles, entity shadows, cutout leaves | `options.txt` | | | sky, fog, weather, animated textures | `horizon-graphics.txt` | | Display | FOV, max framerate, VSync, fullscreen, GUI scale | `options.txt` | -| | resolution scale, anti-aliasing (FXAA), present mode, frame pacing | `horizon-graphics.txt` | +| | resolution scale, anti-aliasing (FXAA), HDR, paper white, peak brightness, present mode, frame pacing | `horizon-graphics.txt` | | Performance | battery mode, worker threads, upload budget per frame | `horizon-graphics.txt` | | Overlay | performance overlay: FPS, frame/CPU/GPU times, frame-time graph | `horizon-graphics.txt` | -`options.txt` keeps exactly vanilla's keys and values, so the options harness still compares it with vanilla; Horizon's settings live in `horizon-graphics.txt` beside it. Their defaults render as vanilla does: cave culling on, no upload budgets, sky, fog and weather on, 100% resolution, no FXAA, the present mode following VSync. VSync on always waits for the display (Fifo), in a window and in fullscreen, as in vanilla; the present mode setting chooses how frames are shown only while VSync is off. Frame pacing defaults to Efficient: the limiter sleeps through the last half millisecond where vanilla spins, which changes timing, not pixels. +`options.txt` keeps exactly vanilla's keys and values, so the options harness still compares it with vanilla; Horizon's settings live in `horizon-graphics.txt` beside it. Their defaults render as vanilla does: cave culling on, no upload budgets, sky, fog and weather on, 100% resolution, no FXAA, HDR off, the present mode following VSync. VSync on always waits for the display (Fifo), in a window and in fullscreen, as in vanilla; the present mode setting chooses how frames are shown only while VSync is off. Frame pacing defaults to Efficient: the limiter sleeps through the last half millisecond where vanilla spins, which changes timing, not pixels. **Battery mode** (Performance, off by default) is for laptops and handhelds: at most 60 frames per second in a world, 30 in menus without a world or while another window has focus, and half the automatic worker threads (chunks load slower). It changes only when frames are drawn: what they show and the game's 20 ticks per second stay as they are. +**HDR** (Display, off by default) presents to an scRGB swapchain (`Rgba16Float`, extended linear sRGB) on displays and compositors that offer it. The frame is drawn exactly as in SDR, in vanilla's gamma space, and a last pass (`hdr.wgsl`) decodes it to linear light at the **Paper White** and lifts light sources (blocks that emit light, lava, the sun and the moon) towards the **Peak Brightness**; everything else stays as in SDR. The mesher puts the light a block's face emits in its vertex colour's alpha (`EMISSION_BITS`), the frame's alpha carries the mark, and only pixels that still show the world before the hand and HUD are lifted. On Vulkan, `horizon-hdr` sends HDR metadata (MaxCLL, mastering luminance), which wgpu doesn't: without it a compositor may clip everything above SDR white. KWin maps the content's reference white onto the desktop's SDR brightness, so on Linux the default Paper White matches SDR mode. `HORIZON_HDR_DEBUG=1` paints lifted pixels magenta. Not lifted yet: glowing particles, distant LOD terrain. + Which settings each screen shows, their descriptions and costs are in `crates/horizon-client/src/graphics_ui.rs` (`rows`); `graphics_style.rs` draws them. ## Distant terrain diff --git a/docs/launcher-commands.md b/docs/launcher-commands.md index 7c9562441..1e9fb7722 100644 --- a/docs/launcher-commands.md +++ b/docs/launcher-commands.md @@ -132,11 +132,11 @@ MCP: `account_offline`. ## `horizon-launcher settings` -Show the launcher's settings, or set one (the Settings page): selected-version TAG, minecraft-dir PATH, server-dir PATH ("default" resets a folder), install-new-versions on|off, opening-animation on|off. +Show the launcher's settings, or set one (the Settings page): selected-version TAG, minecraft-dir PATH, server-dir PATH ("default" resets a folder), install-new-versions on|off, opening-animation on|off, proxy http://host:port ("default" removes it). horizon-launcher settings [KEY] [VALUE] -- `KEY` (selected-version, minecraft-dir, server-dir, install-new-versions, opening-animation) +- `KEY` (selected-version, minecraft-dir, server-dir, install-new-versions, opening-animation, proxy) - `VALUE`: The new value (with KEY) MCP: `settings`. @@ -321,7 +321,7 @@ Search for packs Horizon loads. horizon-launcher mods search [TEXT]... - `TEXT` -- `--kind` (mod, resource, modpack) +- `--kind` (mod, resource, modpack, shader) - `--everything`: Also what was made for other versions or runs only partly, each marked - `--source` (modrinth, curseforge, horizon) diff --git a/docs/media/banner.html b/docs/media/banner.html index 47037a7e2..2f727e8bd 100644 --- a/docs/media/banner.html +++ b/docs/media/banner.html @@ -1,10 +1,10 @@ + Rendered with Playwright (see docs/media/brand/README.md). --> - - -
- -
HorizonPLAYHORIZON.DEV
-

The game you know, rebuilt in Rust.

-

Minecraft: Java Edition 26.3, checked against vanilla by differential harnesses. Unofficial; not associated with Mojang or Microsoft.

-
- - diff --git a/website/public/og.png b/website/public/og.png deleted file mode 100644 index 1b9f270e7..000000000 Binary files a/website/public/og.png and /dev/null differ diff --git a/website/public/robots.txt b/website/public/robots.txt deleted file mode 100644 index 7cd2cc71e..000000000 --- a/website/public/robots.txt +++ /dev/null @@ -1,4 +0,0 @@ -User-agent: * -Allow: / - -Sitemap: https://playhorizon.dev/sitemap.xml diff --git a/website/railway.json b/website/railway.json deleted file mode 100644 index 3bbe9dfb3..000000000 --- a/website/railway.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "$schema": "https://railway.com/railway.schema.json", - "build": { - "builder": "DOCKERFILE", - "dockerfilePath": "Dockerfile", - "watchPatterns": ["/website/**", "/README.md", "/launcher/links.json", "/docs/api/**"] - }, - "deploy": { - "healthcheckPath": "/", - "healthcheckTimeout": 60, - "restartPolicyType": "ON_FAILURE", - "restartPolicyMaxRetries": 5 - } -} diff --git a/website/scripts/art.mjs b/website/scripts/art.mjs deleted file mode 100644 index 160d64914..000000000 --- a/website/scripts/art.mjs +++ /dev/null @@ -1,151 +0,0 @@ -// Horizon's pixel art for the website, drawn in code like the launcher's (launcher/src/art.rs): -// the stone tile behind the pages and the landscape behind the hero, in both appearances. -// Each texel is one pixel of the PNG; the CSS scales them up with `image-rendering: pixelated`. -// Written by `npm run assets` (or `node scripts/art.mjs`) into public/media/. -import { readFile } from "node:fs/promises"; -import { join, dirname } from "node:path"; -import { fileURLToPath } from "node:url"; -import sharp from "sharp"; - -const site = join(dirname(fileURLToPath(import.meta.url)), ".."); -const repo = join(site, ".."); - -// The same small fixed random sequence as art.rs (xorshift), so the art is the same every time. -function rng(seed) { - let x = seed >>> 0; - return () => { - x = (x ^ (x << 13)) >>> 0; - x = (x ^ (x >>> 17)) >>> 0; - x = (x ^ (x << 5)) >>> 0; - return Math.fround((x >>> 8) / (1 << 24)); - }; -} - -const channels = (c) => [(c >> 16) & 255, (c >> 8) & 255, c & 255]; -const shade = (c, by) => channels(c).reduce((out, v) => (out << 8) | Math.min(255, Math.max(0, v + by)), 0); -const mix = (a, b, t) => { - const [x, y] = [channels(a), channels(b)]; - return x.reduce((out, v, i) => (out << 8) | Math.round(v + (y[i] - v) * t), 0); -}; - -// `n` by `n` texels of stone: the page colour in a few close shades, with darker flecks. -export function stone(page, shades, n) { - const s = shades.map((by) => shade(page, by)); - const next = rng(0x9e3779b9); - const out = Array.from({ length: n * n }, () => { - const v = next(); - return s[v < 0.5 ? 0 : v < 0.78 ? 1 : v < 0.93 ? 2 : 3]; - }); - for (let k = 0; k < Math.floor((n * n) / 50); k++) { - const x = Math.floor(next() * n); - const y = Math.floor(next() * n); - const len = 1 + Math.floor(next() * 3); - for (let i = 0; i < len; i++) { - out[y * n + ((x + i) % n)] = s[4]; - out[((y + 1) % n) * n + ((x + i + 1) % n)] = s[4]; - } - } - return out; -} - -export const SUNSET = { - sky: [0x0a0f2c, 0x26206a, 0x4b2a7e, 0x7c3a88, 0xc4527a, 0xee6e5a, 0xffb25e], - sun: [0xfff6cf, 0xffd272, 0xff9a44], - far: 0x4a2f7e, mid: 0x2b1f5e, near: 0x151a45, top: 0x3d2f80, trees: 0x0e1236, -}; -export const DAWN = { - sky: [0x8d7fd8, 0xa596e2, 0xbcaeea, 0xd2c4f0, 0xe7d2ee, 0xf6dce4, 0xffe6d6], - sun: [0xffffff, 0xfff1d0, 0xffd9a8], - far: 0xa898dc, mid: 0x8676c8, near: 0x6a5ab4, top: 0x9a8ae0, trees: 0x4c3e94, -}; - -// A blocky landscape, `w` by `h` texels: banded sky, a sun half set behind the far hills and cut -// into slices like Horizon's mark, flat clouds, three ridges of hills and a few square trees. -export function scene(p, seed, w, h) { - const next = rng((Math.imul(seed, 0x2545f491) | 1) >>> 0); - const out = new Array(w * h).fill(0); - const horizon = Math.floor((h * 62) / 100); - const band = horizon / p.sky.length; - for (let y = 0; y < h; y++) { - const f = y / band; - const i = Math.min(Math.floor(f), p.sky.length - 1); - const dither = f - i > 0.88 && i + 1 < p.sky.length; - for (let x = 0; x < w; x++) out[y * w + x] = dither && (x + y) % 2 === 1 ? p.sky[i + 1] : p.sky[i]; - } - const rect = (x, y, rw, rh, c) => { - for (let yy = Math.max(y, 0); yy < Math.min(y + rh, h); yy++) - for (let xx = Math.max(x, 0); xx < Math.min(x + rw, w); xx++) out[yy * w + xx] = c; - }; - for (let k = 0; k < 4; k++) { - const cx = Math.floor(next() * w); - const cy = Math.floor(horizon * (0.12 + next() * 0.4)); - const cw = 10 + Math.floor(next() * 14); - const under = p.sky[Math.min(Math.floor(cy / band) + 1, p.sky.length - 1)]; - const c = mix(under, 0xffffff, 0.12); - rect(cx, cy, cw, 2, c); - rect(cx + 3, cy - 2, Math.max(cw - 6, 0), 2, c); - } - const r = Math.floor(h * 0.2); - const [cx, cy] = [Math.floor(w * 0.68), horizon - Math.floor(h * 0.11)]; - for (let dy = -r; dy <= 0; dy++) { - const half = Math.round(Math.sqrt(r * r - dy * dy)); - const t = (dy + r) / r; - const c = p.sun[t < 0.4 ? 0 : t < 0.75 ? 1 : 2]; - if ((cy + dy) % 5 !== 0 || dy < -r * 0.6) rect(cx - half, cy + dy, half * 2, 1, c); - } - const ridge = (base, amp, rough) => { - let [y, v] = [base, 0]; - return Array.from({ length: w }, (_, x) => { - if (x % 2 === 0) { - v = (v + (next() - 0.5) * rough) * 0.86; - y += v + (base - y) * 0.06; - } - return Math.max(Math.round(Math.min(Math.max(y, base - amp), base + amp)), 0); - }); - }; - const layers = [ - [p.far, horizon - h * 0.1, h * 0.12, 3.2, null], - [p.mid, horizon + h * 0.02, h * 0.09, 2.6, null], - [p.near, horizon + h * 0.18, h * 0.07, 2.2, p.top], - ]; - let near = []; - for (const [c, base, amp, rough, top] of layers) { - const hs = ridge(base, amp, rough); - hs.forEach((y, x) => { - for (let yy = Math.min(y, h); yy < h; yy++) out[yy * w + x] = c; - if (top !== null && y < h) out[y * w + x] = top; - }); - near = hs; - } - for (let k = 0; k < Math.floor(w / 26); k++) { - const tx = 4 + Math.floor(next() * (w - 10)); - const ty = near[tx]; - rect(tx - 2, ty - 8, 5, 5, p.trees); - rect(tx - 1, ty - 10, 3, 2, p.trees); - rect(tx, ty - 3, 1, 3, p.trees); - } - return out; -} - -const png = (texels, w, h, file) => - sharp(Buffer.from(texels.flatMap(channels)), { raw: { width: w, height: h, channels: 3 } }) - .png({ compressionLevel: 9, palette: true }) - .toFile(file); - -// The page colours and the stone's shades come from crates/horizon-theme, like tokens.css. -export async function writeArt(media) { - const theme = await readFile(join(repo, "crates/horizon-theme/src/lib.rs"), "utf8"); - const page = (name) => parseInt(theme.match(new RegExp(`pub const ${name}: Blocks = Blocks \\{\\s*page: 0x([0-9a-f]{6})`))[1], 16); - const shades = JSON.parse(`[${theme.match(/TILE_SHADES: \[i16; 5\] = \[([^\]]*)\]/)[1]}]`); - const texels = Number(theme.match(/TILE_TEXELS: usize = (\d+)/)[1]) * 4; - await png(stone(page("BLOCKS_DARK"), shades, texels), texels, texels, join(media, "stone-dark.png")); - await png(stone(page("BLOCKS_LIGHT"), shades, texels), texels, texels, join(media, "stone-light.png")); - const [w, h] = [240, 72]; - await png(scene(SUNSET, 3, w, h), w, h, join(media, "scene-dark.png")); - await png(scene(DAWN, 3, w, h), w, h, join(media, "scene-light.png")); -} - -if (process.argv[1] === fileURLToPath(import.meta.url)) { - await writeArt(join(site, "public", "media")); - console.log("pixel art written to public/media/"); -} diff --git a/website/scripts/assets.mjs b/website/scripts/assets.mjs deleted file mode 100644 index 92b197e7e..000000000 --- a/website/scripts/assets.mjs +++ /dev/null @@ -1,60 +0,0 @@ -// Copies the launcher's fonts and the repo's screenshots into public/, draws the pixel art, -// converted for the web (woff2, webp in two widths). Run it after any of them change: -// `npm run assets`. Its output is committed, because Railway builds only website/. -import { mkdir, readFile, writeFile, copyFile } from "node:fs/promises"; -import { join, dirname } from "node:path"; -import { fileURLToPath } from "node:url"; -import sharp from "sharp"; -import wawoff2 from "wawoff2"; -import { writeArt } from "./art.mjs"; - -const site = join(dirname(fileURLToPath(import.meta.url)), ".."); -const repo = join(site, ".."); -const pub = join(site, "public"); - -const fonts = [ - "Geist-Regular.ttf", - "Geist-Medium.ttf", - "Geist-SemiBold.ttf", - "GeistMono-Regular.ttf", - "PixelifySans-Medium.ttf", - "PixelifySans-SemiBold.ttf", - "PixelifySans-Bold.ttf", -]; - -// [source, name]; every image becomes media/.webp and media/-800.webp. -export const images = [ - ["docs/media/sunset.jpg", "sunset"], - ["docs/media/village.jpg", "village"], - ["docs/media/survival.jpg", "survival"], - ["docs/media/nether.jpg", "nether"], - ["docs/media/night.jpg", "night"], - ["docs/media/underwater.jpg", "underwater"], - ["docs/media/settings-simple.png", "settings"], - ["docs/media/launcher-play.png", "launcher"], -]; - -await mkdir(join(pub, "fonts"), { recursive: true }); -await mkdir(join(pub, "media"), { recursive: true }); - -for (const font of fonts) { - const ttf = await readFile(join(repo, "crates/horizon-theme/fonts", font)); - await writeFile(join(pub, "fonts", font.replace(".ttf", ".woff2")), await wawoff2.compress(ttf)); -} -for (const licence of ["OFL-Geist.txt", "OFL-PixelifySans.txt"]) { - await copyFile(join(repo, "crates/horizon-theme/fonts", licence), join(pub, "fonts", licence)); -} - -for (const [source, name] of images) { - const input = join(repo, source); - await sharp(input).resize({ width: 1600, withoutEnlargement: true }).webp({ quality: 82 }).toFile(join(pub, "media", `${name}.webp`)); - await sharp(input).resize({ width: 800 }).webp({ quality: 78 }).toFile(join(pub, "media", `${name}-800.webp`)); -} - -// The stone tile and the hero's landscape, drawn in code (scripts/art.mjs). -await writeArt(join(pub, "media")); - -// The icons (favicon.svg, favicon-32.png, apple-touch-icon.png) come from Horizon's mark: -// `cargo run -p xtask -- icons` writes them with the rest of the brand (docs/media/brand). - -console.log("assets written to public/"); diff --git a/website/scripts/benchmarks.mjs b/website/scripts/benchmarks.mjs deleted file mode 100644 index 724834ea7..000000000 --- a/website/scripts/benchmarks.mjs +++ /dev/null @@ -1,240 +0,0 @@ -// Benchmark results for the site: benchmark reports (docs/benchmark-report.md) in, the summary the Benchmarks page -// reads out (public/benchmarks.json, and the telemetry server's GET /v1/benchmarks/summary in the same shape). -// -// node scripts/benchmarks.mjs --ours fleet.json [--telemetry items.jsonl] [-o public/benchmarks.json] -// -// --ours lists our own runs (tools/perf_bench.py reports, Horizon and vanilla, one machine each); --telemetry holds -// players' `benchmark` items as the server stores them ({ install_id, day, version, data: } per line). -// Players' results are grouped by GPU, CPU, render distance and game, and a group is published only with at least -// MIN_INSTALLS installs, so nobody can be picked out. install_id is used to count installs and to weigh each install -// once, and never leaves this script; neither do the day, OS version, driver, the exact RAM and VRAM, or the screen. -// A group also says how its installs split by hardware class (RAM, VRAM, drive, OS, integrated or discrete GPU), -// each class only with at least MIN_INSTALLS installs. The classes are the server's (src/classes.rs). -import { readFile, writeFile } from "node:fs/promises"; -import { dirname, resolve } from "node:path"; -import { fileURLToPath } from "node:url"; - -export const FORMAT = "horizon-benchmark-summary"; -export const MIN_INSTALLS = 3; -export const SCENES = ["village", "forest", "ocean", "mountain"]; -export const FIELDS = ["avg_fps", "low_1pct_fps", "p95_ms", "world_ms", "chunk_load_ms", "rss_peak_mb", "rss_steady_mb"]; - -const mean = (xs) => (xs.length ? xs.reduce((a, b) => a + b, 0) / xs.length : null); -const finite = (x) => typeof x === "number" && Number.isFinite(x); -export function median(xs) { - const v = xs.filter(finite).sort((a, b) => a - b); - if (!v.length) return null; - const m = v.length >> 1; - return v.length % 2 ? v[m] : (v[m - 1] + v[m]) / 2; -} -// fps to integers, milliseconds to a tenth under 10 and to integers above, megabytes to integers. -export function round(field, x) { - if (!finite(x)) return null; - if (field.endsWith("_ms")) return x < 10 ? Math.round(x * 10) / 10 : Math.round(x); - return Math.round(x); -} -const trim = (s) => (typeof s === "string" ? s.replace(/\(R\)|\(TM\)|\(tm\)/g, "").replace(/\s+/g, " ").trim() : ""); -const gameOf = (app) => (app?.name === "horizon-client" ? "horizon" : app?.name === "minecraft" && !(app.mods || []).some((m) => m.name !== "fabric-loader") ? "vanilla" : null); - -// --- Hardware classes: coarse, so that a class holds many machines --------------------------- - -export const DIMENSIONS = ["ram", "vram", "storage", "os", "gpu_kind"]; -export function ramClass(gb) { - if (!(gb > 0)) return null; - return gb <= 5 ? "4 GB or less" : gb <= 10 ? "8 GB" : gb <= 20 ? "16 GB" : gb <= 40 ? "32 GB" : "64 GB or more"; -} -export function gpuKindClass(s) { - return s === "integrated" || s === "IntegratedGpu" ? "integrated" : s === "discrete" || s === "DiscreteGpu" ? "discrete" : null; -} -// A GPU's own memory in MiB; an integrated GPU shares the system's. -export function vramClass(mb, kind) { - if (gpuKindClass(kind) === "integrated") return "shared"; - if (!(mb > 0)) return null; - for (const [max, name] of [[2560, "2 GB or less"], [4608, "4 GB"], [6656, "6 GB"], [8704, "8 GB"], [12800, "12 GB"], [16896, "16 GB"]]) if (mb <= max) return name; - return "more than 16 GB"; -} -const oneOf = (list) => (s) => (list.includes(s) ? s : null); -export const storageClass = oneOf(["nvme", "ssd", "hdd"]); -export const osClass = oneOf(["linux", "macos", "windows"]); -// A report's classes, in DIMENSIONS order. -export function classesOf(report) { - const hw = report?.hardware || {}; - const kind = hw.gpu?.kind; - return [ramClass(finite(hw.ram_mb) ? hw.ram_mb / 1024 : 0), vramClass(hw.gpu?.vram_mb, kind), storageClass(hw.storage), osClass(hw.os), gpuKindClass(kind)]; -} -// Per dimension, the classes with at least minInstalls installs, most first; dimensions without one are left out. -export function breakdowns(classes, minInstalls) { - const out = {}; - DIMENSIONS.forEach((dim, i) => { - const cells = [...classes[i]].map(([c, set]) => ({ class: c, installs: set.size })).filter((c) => c.installs >= minInstalls); - cells.sort((a, b) => b.installs - a.installs || (a.class < b.class ? -1 : a.class > b.class ? 1 : 0)); - if (cells.length) out[dim] = cells; - }); - return out; -} - -// Why a report can't be compared with the others, or null when it can: the standard flight over the four scenes, -// VSync off, no frame cap, drawn on a screen. -export function rejection(report) { - if (!report || report.format !== "horizon-benchmark-report" || report.version !== 1) return "not a version 1 benchmark report"; - if (report.kind !== "game") return "not a game run"; - if (!gameOf(report.app)) return "not Horizon or plain vanilla"; - const c = report.conditions || {}; - if (!(c.scenario === "standard" || c.scenario === "flight" || String(c.scenario || "").startsWith("perf_bench:"))) return "not the standard flight"; - if (c.vsync !== false) return "VSync on or unknown"; - if (c.fps_cap != null) return "frame rate capped"; - if (c.offscreen === true) return "offscreen"; - if (!finite(c.render_distance)) return "no render distance"; - const phases = new Set((report.frames || []).map((f) => f.phase)); - if (!SCENES.every((s) => phases.has(s))) return "not every scene"; - if (!trim(report.hardware?.gpu?.name) || !trim(report.hardware?.cpu)) return "no GPU or CPU name"; - return null; -} - -// One report's figures: frame figures averaged over every flight (scene and repeat), the rest from its metrics. -export function figures(report) { - const frames = report.frames || []; - const m = report.metrics || {}; - const metric = (name) => (finite(m[name]?.mean) ? m[name].mean : null); - const loads = Object.keys(m).filter((k) => /^chunks\.[^.]+\.load_ms$/.test(k)).map(metric).filter(finite); - const avg = (key) => mean(frames.map((f) => f[key]).filter(finite)); - return { - avg_fps: avg("avg_fps"), - low_1pct_fps: avg("low_1pct_fps"), - p95_ms: avg("p95_ms"), - world_ms: metric("startup.world_ms"), - chunk_load_ms: mean(loads), - rss_peak_mb: metric("memory.rss_peak_mb"), - rss_steady_mb: metric("memory.rss_steady_mb"), - cpu_p50_ms: avg("cpu_p50_ms"), - gpu_p50_ms: avg("gpu_p50_ms"), - }; -} - -const roundAll = (fig, fields) => Object.fromEntries(fields.map((f) => [f, round(f, fig[f])])); - -// Players' items -> groups of at least minInstalls installs. Each install counts once: its median first, then the -// median across installs. -export function aggregatePlayers(items, { minInstalls = MIN_INSTALLS } = {}) { - const groups = new Map(); - for (const item of items) { - const report = item?.data; - if (!item?.install_id || rejection(report)) continue; - const key = JSON.stringify([trim(report.hardware.gpu.name), trim(report.hardware.cpu), report.conditions.render_distance, gameOf(report.app)]); - if (!groups.has(key)) groups.set(key, { installs: new Map(), reports: 0, versions: new Set(), classes: DIMENSIONS.map(() => new Map()) }); - const g = groups.get(key); - g.reports++; - if (item.version) g.versions.add(item.version); - if (!g.installs.has(item.install_id)) g.installs.set(item.install_id, []); - g.installs.get(item.install_id).push(figures(report)); - classesOf(report).forEach((c, i) => { - if (!c) return; - if (!g.classes[i].has(c)) g.classes[i].set(c, new Set()); - g.classes[i].get(c).add(item.install_id); - }); - } - const out = []; - for (const [key, g] of groups) { - if (g.installs.size < minInstalls) continue; - const [gpu, cpu, render_distance, game] = JSON.parse(key); - const perInstall = [...g.installs.values()].map((runs) => Object.fromEntries(FIELDS.map((f) => [f, median(runs.map((r) => r[f]))]))); - const medians = Object.fromEntries(FIELDS.map((f) => [f, round(f, median(perInstall.map((r) => r[f])))])); - out.push({ gpu, cpu, render_distance, game, source: "players", installs: g.installs.size, reports: g.reports, versions: [...g.versions].sort(byVersionDesc).slice(0, 3), medians, breakdowns: breakdowns(g.classes, minInstalls) }); - } - // Most installs first, then by GPU, CPU, render distance and game, compared as plain strings (as the server does). - const cmp = (x, y) => (x < y ? -1 : x > y ? 1 : 0); - return out.sort((a, b) => b.installs - a.installs || cmp(a.gpu, b.gpu) || cmp(a.cpu, b.cpu) || a.render_distance - b.render_distance || cmp(a.game, b.game)); -} - -// "v0.2.10" after "v0.2.9", dated tags by their numbers; good enough to list the newest three. -function byVersionDesc(a, b) { - const n = (v) => (v.match(/\d+/g) || []).map(Number); - const [x, y] = [n(a), n(b)]; - for (let i = 0; i < Math.max(x.length, y.length); i++) if ((x[i] ?? -1) !== (y[i] ?? -1)) return (y[i] ?? -1) - (x[i] ?? -1); - return 0; -} - -// Our own runs: one row per machine, game and render distance, with what was measured and how. An entry holds one -// report (its runs are the report's repeats) or several (one game each); figures are medians over the reports. -export function ourRows(runs) { - const rows = []; - for (const { report, reports, machine, note, version, capped_fps } of runs) { - const list = reports || [report]; - for (const r of list) { - const why = rejection(r); - if (why) throw new Error(`${machine}: ${r?.label || "report"} can't be published: ${why}`); - } - const [first] = list; - const c = first.conditions; - if (list.some((r) => r.conditions.render_distance !== c.render_distance || gameOf(r.app) !== gameOf(first.app) || r.app.version !== first.app.version)) - throw new Error(`${machine}: reports of different games, versions or render distances in one entry`); - const figs = list.map(figures); - const fig = Object.fromEntries(Object.keys(figs[0]).map((k) => [k, median(figs.map((f) => f[k]))])); - const scenes = Object.fromEntries( - SCENES.map((s) => { - const fs = list.flatMap((r) => r.frames.filter((f) => f.phase === s)); - const loads = list.map((r) => r.metrics?.[`chunks.${s}.load_ms`]?.mean); - return [s, { avg_fps: round("avg_fps", mean(fs.map((f) => f.avg_fps))), low_1pct_fps: round("low_1pct_fps", mean(fs.map((f) => f.low_1pct_fps))), chunk_load_ms: round("chunk_load_ms", median(loads)) }]; - }), - ); - rows.push({ - gpu: trim(first.hardware.gpu.name), - cpu: trim(first.hardware.cpu), - render_distance: c.render_distance, - game: gameOf(first.app), - source: "us", - machine, - measured: list.map((r) => (r.created || "").slice(0, 10)).sort().at(-1), - // A release build reports its crate version; the entry can name the release it was. - version: version || first.app.version, - backend: first.hardware.gpu.backend || null, - os: first.hardware.os || null, - window: c.window || null, - repeats: list.reduce((n, r) => n + (r.conditions.repeats || 1), 0), - load_avg_1m: Math.max(...list.map((r) => r.conditions.load_avg_1m ?? 0)), - ...(note ? { note } : {}), - // The frame rate the display held this game to (a present mode VSync off doesn't lift): its average is a floor. - ...(capped_fps ? { capped_fps } : {}), - // A split of 0 means the backend gave no timing (Metal has no GPU timer here): unknown, not free. - medians: { ...roundAll(fig, FIELDS), cpu_p50_ms: fig.cpu_p50_ms > 0 ? round("cpu_p50_ms", fig.cpu_p50_ms) : null, gpu_p50_ms: fig.gpu_p50_ms > 0 ? round("gpu_p50_ms", fig.gpu_p50_ms) : null }, - scenes, - }); - } - return rows; -} - -export function summary({ ours = [], players = [], generated = new Date() } = {}) { - return { format: FORMAT, version: 1, generated: generated.toISOString().replace(/\.\d+Z$/, "Z"), min_installs: MIN_INSTALLS, groups: [...ours, ...players] }; -} - -// --- The command line ---------------------------------------------------------------------- - -async function main(argv) { - const arg = (name) => { - const i = argv.indexOf(name); - return i >= 0 ? argv[i + 1] : null; - }; - const site = resolve(dirname(fileURLToPath(import.meta.url)), ".."); - const out = arg("-o") || resolve(site, "public/benchmarks.json"); - let ours = []; - if (arg("--ours")) { - // [{ "machine": "Mac mini", "reports": ["path/to/report.json", ...], "version": "v…", "note": "..." }], paths - // relative to the list; "version" names the release when the report only has the crate version. - const listPath = resolve(arg("--ours")); - const list = JSON.parse(await readFile(listPath, "utf8")); - const load = async (path) => JSON.parse(await readFile(resolve(dirname(listPath), path), "utf8")); - const runs = []; - for (const entry of list) runs.push({ ...entry, reports: await Promise.all((entry.reports || [entry.report]).map(load)), report: undefined }); - ours = ourRows(runs); - } - let players = []; - if (arg("--telemetry")) { - const text = await readFile(resolve(arg("--telemetry")), "utf8"); - players = aggregatePlayers(text.split("\n").filter((l) => l.trim()).map((l) => JSON.parse(l))); - } - const result = summary({ ours, players }); - await writeFile(out, JSON.stringify(result, null, 1) + "\n"); - console.log(`${out}: ${ours.length} rows measured by us, ${players.length} player groups`); -} - -if (process.argv[1] && resolve(process.argv[1]) === fileURLToPath(import.meta.url)) await main(process.argv.slice(2)); diff --git a/website/scripts/benchmarks.test.mjs b/website/scripts/benchmarks.test.mjs deleted file mode 100644 index 87aec484b..000000000 --- a/website/scripts/benchmarks.test.mjs +++ /dev/null @@ -1,91 +0,0 @@ -// node --test (npm test in website/). The fixtures are shared with the telemetry server's summary test. -import { test } from "node:test"; -import assert from "node:assert/strict"; -import { readFileSync } from "node:fs"; -import { aggregatePlayers, median, osClass, ourRows, ramClass, rejection, round, storageClass, summary, vramClass, gpuKindClass } from "./benchmarks.mjs"; - -const fixture = (name) => new URL(`./fixtures/benchmarks/${name}`, import.meta.url); -const items = readFileSync(fixture("items.jsonl"), "utf8").split("\n").filter(Boolean).map((l) => JSON.parse(l)); -const expected = JSON.parse(readFileSync(fixture("expected.json"), "utf8")); - -test("players' items give the expected groups", () => { - const s = summary({ players: aggregatePlayers(items) }); - assert.equal(s.format, "horizon-benchmark-summary"); - assert.equal(s.min_installs, expected.min_installs); - assert.deepEqual(s.groups, expected.groups); -}); - -test("nothing that identifies an install is published", () => { - const text = JSON.stringify(aggregatePlayers(items, { minInstalls: 1 })); - for (const secret of ["a1", "a2", "install_id", "secret-os-version", "secret-driver", "20394", "ram_mb", "2560", "16376", "32768", "vram_mb"]) assert.ok(!text.includes(secret), secret); -}); - -test("a group needs three installs, not three runs", () => { - const one = items.filter((i) => i.install_id === "a1"); - assert.equal(aggregatePlayers([...one, ...one, ...one]).length, 0); - assert.equal(aggregatePlayers(items, { minInstalls: 2 }).length, 2); -}); - -test("hardware classes are coarse, as the server's", () => { - assert.equal(ramClass(15.6), "16 GB"); - assert.equal(ramClass(31), "32 GB"); - assert.equal(ramClass(64), "64 GB or more"); - assert.equal(ramClass(0), null); - assert.equal(vramClass(16376, "discrete"), "16 GB"); - assert.equal(vramClass(8192, "DiscreteGpu"), "8 GB"); - assert.equal(vramClass(0, "integrated"), "shared"); - assert.equal(vramClass(0, ""), null); - assert.equal(storageClass("nvme"), "nvme"); - assert.equal(storageClass("tape"), null); - assert.equal(osClass("windows"), "windows"); - assert.equal(gpuKindClass("virtual"), null); -}); - -test("a breakdown cell needs three installs too", () => { - const [group] = aggregatePlayers(items); - assert.equal(group.breakdowns.ram, undefined); // 32 GB has two installs, 16 GB one - assert.equal(group.breakdowns.storage, undefined); - const [all] = aggregatePlayers(items, { minInstalls: 1 }); - assert.deepEqual(all.breakdowns.ram, [{ class: "32 GB", installs: 2 }, { class: "16 GB", installs: 1 }]); - assert.deepEqual(all.breakdowns.storage, [{ class: "nvme", installs: 2 }, { class: "ssd", installs: 1 }]); -}); - -test("only comparable runs count", () => { - const reasons = items.map((i) => rejection(i.data)); - assert.deepEqual(reasons.filter(Boolean), ["VSync on or unknown", "offscreen", "frame rate capped", "not every scene", "not the standard flight", "not a version 1 benchmark report"]); -}); - -test("medians and rounding", () => { - assert.equal(median([3, 1, 2]), 2); - assert.equal(median([4, 1, 2, 3]), 2.5); - assert.equal(median([null, NaN]), null); - assert.equal(round("p95_ms", 3.46), 3.5); - assert.equal(round("world_ms", 4512.4), 4512); - assert.equal(round("avg_fps", 99.5), 100); -}); - -test("our runs keep the machine and how it was measured", () => { - const [row] = ourRows([{ machine: "Desktop", report: items[0].data }]); - assert.equal(row.source, "us"); - assert.equal(row.machine, "Desktop"); - assert.equal(row.game, "horizon"); - assert.equal(row.medians.avg_fps, 415); - assert.equal(row.scenes.ocean.avg_fps, 420); - assert.throws(() => ourRows([{ machine: "x", report: items[4].data }]), /VSync/); - // Several one-game reports: medians over them. - const [both] = ourRows([{ machine: "Desktop", reports: [items[0].data, items[1].data] }]); - assert.equal(both.medians.avg_fps, 515); - assert.equal(both.repeats, 2); - assert.throws(() => ourRows([{ machine: "x", reports: [items[0].data, items[9].data] }]), /different/); -}); - -test("a display cap on our run is kept, and the comparison says at least", async () => { - const [row] = ourRows([{ machine: "Mac", report: items[0].data, capped_fps: 144, version: "v1" }]); - assert.equal(row.capped_fps, 144); - assert.equal(row.version, "v1"); - const { compareRows, METRICS } = await import("../src/bench.js"); - const fps = METRICS[0]; - const h = { capped_fps: 144, medians: { avg_fps: 144 } }; - assert.equal(compareRows(fps, h, { medians: { avg_fps: 120 } }).text, "at least 1.2x faster"); - assert.equal(compareRows(fps, h, { medians: { avg_fps: 200 } }).wins, "none"); -}); diff --git a/website/scripts/shots.mjs b/website/scripts/shots.mjs deleted file mode 100644 index c0b86f40d..000000000 --- a/website/scripts/shots.mjs +++ /dev/null @@ -1,99 +0,0 @@ -// Full-page screenshots of the built site at every width that matters, plus the social -// preview image. Run `npm run build` first; `npm run shots` serves dist/ and writes -// shots/*.png (gitignored: full-page PNGs are too heavy for the repo), 390-menu.png (the open -// menu) and 1440-hero.png, and public/og.png (rebuild after). It also checks each width for -// horizontal scroll, small tap targets and line lengths. `SHOTS=dir` writes them elsewhere. -import { chromium } from "playwright"; -import { spawn } from "node:child_process"; -import { mkdir } from "node:fs/promises"; -import { join, dirname, resolve } from "node:path"; -import { fileURLToPath } from "node:url"; - -const site = join(dirname(fileURLToPath(import.meta.url)), ".."); -const port = 4199; -const url = `http://localhost:${port}/`; -const server = spawn(process.execPath, [join(site, "serve.mjs")], { env: { ...process.env, PORT: String(port) }, stdio: "ignore" }); -await new Promise((r) => setTimeout(r, 400)); - -const widths = [360, 390, 430, 768, 1024, 1180, 1250, 1280, 1366, 1440, 1680, 1920]; -const sizes = [...widths.map((w) => [w, w < 900 ? 800 : 900]), [1250, 700]]; -const only = process.argv.slice(2); -const out = process.env.SHOTS ? resolve(process.env.SHOTS) : join(site, "shots"); - -await mkdir(out, { recursive: true }); -const browser = await chromium.launch(); -let problems = 0; - -for (const [width, height] of sizes) { - const name = height === 700 ? `${width}x${height}` : `${width}`; - if (only.length && !only.includes(name)) continue; - const touch = width < 900; - const page = await browser.newPage({ viewport: { width, height }, deviceScaleFactor: 1, hasTouch: touch, isMobile: touch }); - await page.goto(url, { waitUntil: "networkidle" }); - // Reveal every section, as scrolling would, and let the fades finish. - await page.evaluate(async () => { - for (let y = 0; y < document.body.scrollHeight; y += 400) { - scrollTo({ top: y, behavior: "instant" }); - await new Promise((r) => setTimeout(r, 30)); - } - scrollTo({ top: 0, behavior: "instant" }); - }); - await page.waitForTimeout(800); - const report = await page.evaluate((touch) => { - const out = []; - const doc = document.documentElement; - if (doc.scrollWidth > innerWidth) out.push(`horizontal scroll: ${doc.scrollWidth} > ${innerWidth}`); - for (const el of document.querySelectorAll("body *")) { - const r = el.getBoundingClientRect(); - if (r.width && r.right > innerWidth + 1 && !el.closest(".lightbox, .menu, .hero-media, .footer-word")) { - out.push(`overflows: ${el.tagName.toLowerCase()}.${el.className} right ${Math.round(r.right)}`); - } - } - if (touch) { - for (const el of document.querySelectorAll("a, button, summary")) { - if (el.closest(".menu, .lightbox, .skip") || el.closest(".prose, .footer-cols, .fact p, .system-detail, .download-meta, .meta")) continue; - const r = el.getBoundingClientRect(); - if (r.width && r.height < 44) out.push(`small target: ${el.textContent.trim().slice(0, 30)} (${Math.round(r.height)}px)`); - } - } - // Characters per line of the longest running-text paragraphs. - const lengths = [...document.querySelectorAll(".prose p, .lede, .hero-line, .fact p, .features p, .system-detail, .count-label, .footer-cols p")] - .filter((p) => p.textContent.length > 160) - .map((p) => { - const lh = parseFloat(getComputedStyle(p).lineHeight); - const n = Math.round(p.textContent.length / Math.max(1, Math.round(p.getBoundingClientRect().height / lh))); - return [n, `${p.parentElement.id || p.parentElement.className}>${p.className || p.tagName}`]; - }) - .sort((a, b) => a[0] - b[0]); - const [lo, hi] = [lengths[0], lengths[lengths.length - 1]]; - out.push(`chars per line: ${lo[0]} (${lo[1]})–${hi[0]} (${hi[1]})`); - return out.slice(0, 12); - }, touch); - const issues = report.filter((l) => !l.startsWith("chars")); - problems += issues.length; - console.log(`${name}: ${issues.length ? issues.join("; ") : "ok"} · ${report.find((l) => l.startsWith("chars"))}`); - await page.screenshot({ path: join(out, `${name}.png`), fullPage: height !== 700 }); - if (width === 1440) await page.screenshot({ path: join(out, "1440-hero.png") }); - if (width === 390) { - await page.click(".menu-button"); - await page.waitForTimeout(800); - await page.screenshot({ path: join(out, "390-menu.png") }); - } - await page.close(); -} - -if (!only.length || only.includes("og")) { - const page = await browser.newPage({ viewport: { width: 1200, height: 630 } }); - await page.goto(`${url}og.html`, { waitUntil: "networkidle" }); - await page.waitForTimeout(700); - await page.screenshot({ path: join(site, "public/og.png") }); - await page.close(); -} - -await browser.close(); -server.kill(); - -if (problems) { - console.log(`${problems} problems`); - process.exitCode = 1; -} diff --git a/website/serve.mjs b/website/serve.mjs deleted file mode 100644 index 553a3ff9b..000000000 --- a/website/serve.mjs +++ /dev/null @@ -1,42 +0,0 @@ -// A dependency-free static server for dist/, for local checks (`npm run dev`). -// Railway uses Caddy instead (see Dockerfile). -import { createServer } from "node:http"; -import { readFile, stat } from "node:fs/promises"; -import { join, extname, normalize } from "node:path"; -import { fileURLToPath } from "node:url"; - -const root = join(fileURLToPath(new URL(".", import.meta.url)), "dist"); -const types = { ".html": "text/html; charset=utf-8", ".css": "text/css", ".js": "text/javascript", ".webp": "image/webp", ".png": "image/png", ".svg": "image/svg+xml", ".woff2": "font/woff2", ".txt": "text/plain; charset=utf-8", ".md": "text/plain; charset=utf-8", ".json": "application/json", ".xml": "application/xml" }; -const port = Number(process.env.PORT) || 4173; - -createServer(async (req, res) => { - let path = normalize(decodeURIComponent(new URL(req.url, "http://x").pathname)).replace(/^(\.\.[/\\])+/, ""); - if (path === "/docs/api/") { - res.writeHead(301, { Location: "/docs/api" }); - return res.end(); - } - if (path.endsWith("/")) path += "index.html"; - // The server guide is part of the docs now, as the Caddyfile redirects it. - if (path === "/server" || path === "/server.html") { - res.writeHead(301, { Location: "/docs/hosting" }); - return res.end(); - } - // The roadmap page became the hub's Roadmap tab. - if (path === "/roadmap") { - res.writeHead(301, { Location: "/hub#roadmap" }); - return res.end(); - } - if (path === "/docs") path = "/docs/index.html"; - // /privacy, /docs/ and /docs/api/ are .html files, as the Caddyfile rewrites them. - if (!extname(path)) path += ".html"; - let file = join(root, path); - let status = 200; - try { - if (!(await stat(file)).isFile()) throw 0; - } catch { - file = join(root, "404.html"); - status = 404; - } - res.writeHead(status, { "Content-Type": types[extname(file)] || "application/octet-stream" }); - res.end(await readFile(file)); -}).listen(port, () => console.log(`http://localhost:${port}`)); diff --git a/website/src/404.html b/website/src/404.html deleted file mode 100644 index 3ac1e017a..000000000 --- a/website/src/404.html +++ /dev/null @@ -1,27 +0,0 @@ - - - - - - Not found · Horizon - - - - - - - - - -
-
-

404Not found

-

Not here.

-

This page doesn't exist. The rest of Horizon is one page away.

- -

Not an official Minecraft product. Not approved by or associated with Mojang or Microsoft.

-
-
- - - diff --git a/website/src/bench.js b/website/src/bench.js deleted file mode 100644 index 40185c79d..000000000 --- a/website/src/bench.js +++ /dev/null @@ -1,167 +0,0 @@ -// The Benchmarks page's tables, from the summary (public/benchmarks.json, or the telemetry server's -// GET /v1/benchmarks/summary in the same shape). Shared by build.mjs (baked) and benchmarks-page.js (live). -import { escape } from "./markdown.js"; - -export const METRICS = [ - { key: "avg_fps", label: "Average FPS", kind: "fps", better: "high" }, - { key: "low_1pct_fps", label: "1% low FPS", kind: "fps", better: "high", hint: "the slowest 1% of frames, as FPS" }, - { key: "p95_ms", label: "Frame time, 95th percentile", kind: "ms", better: "low" }, - { key: "world_ms", label: "Start to in-world", kind: "ms", better: "low", hint: "process start to the spawn area loaded and drawn" }, - { key: "chunk_load_ms", label: "Chunk load after a teleport", kind: "ms", better: "low", hint: "the four scenes' average" }, - { key: "rss_steady_mb", label: "Memory while playing", kind: "mb", better: "low" }, - { key: "rss_peak_mb", label: "Memory, peak", kind: "mb", better: "low" }, -]; - -export function format(kind, x) { - if (x == null || !Number.isFinite(x)) return "–"; - if (kind === "fps") return x >= 100 ? Math.round(x).toLocaleString("en") : x.toFixed(x >= 10 ? 0 : 1); - if (kind === "ms") return x >= 1000 ? `${(x / 1000).toFixed(x >= 10000 ? 0 : 1)} s` : `${x < 10 ? x.toFixed(1) : Math.round(x)} ms`; - if (kind === "mb") return x >= 1000 ? `${(x / 1024).toFixed(1)} GB` : `${Math.round(x)} MB`; - return String(x); -} - -// "2.4x faster", "1.3x slower", "2.0x less" (memory), from Horizon's side. -export function compare(metric, horizon, java) { - if (horizon == null || java == null || !horizon || !java) return null; - const ratio = metric.better === "high" ? horizon / java : java / horizon; - if (Math.abs(ratio - 1) < 0.05) return { text: "about the same", wins: "tie" }; - const word = metric.kind === "mb" ? (ratio > 1 ? "less" : "more") : ratio > 1 ? "faster" : "slower"; - const r = ratio > 1 ? ratio : 1 / ratio; - return { text: `${r.toFixed(r >= 10 ? 0 : 1)}x ${word}`, wins: ratio > 1 ? "horizon" : "java" }; -} - -// The game's average frame rate sat at a display cap (`capped_fps`): the real one is at least that. -export const capped = (row) => Boolean(row?.capped_fps && row.medians?.avg_fps >= row.capped_fps * 0.97); - -// compare() between two rows, saying "at least" where Horizon's average sat at a cap. -export function compareRows(metric, h, j) { - const c = compare(metric, h?.medians?.[metric.key], j?.medians?.[metric.key]); - if (!c || metric.key !== "avg_fps" || !capped(h)) return c; - return c.wins === "horizon" ? { ...c, text: `at least ${c.text}` } : { text: "capped, can't tell", wins: "none" }; -} - -export const cell = (metric, row) => { - const v = format(metric.kind, row?.medians?.[metric.key]); - return metric.key === "avg_fps" && capped(row) ? `${v} (cap)` : v; -}; - -const machines = (groups) => { - const by = new Map(); - for (const g of groups.filter((g) => g.source === "us")) { - if (!by.has(g.machine)) by.set(g.machine, []); - by.get(g.machine).push(g); - } - return by; -}; - -const pick = (rows, game, rd) => rows.find((r) => r.game === game && r.render_distance === rd); - -// One machine we measured: Horizon and Java side by side at each render distance. -export function machineHtml(name, rows) { - const first = rows[0]; - const distances = [...new Set(rows.map((r) => r.render_distance))].sort((a, b) => a - b); - const horizon = rows.find((r) => r.game === "horizon"); - const java = rows.find((r) => r.game === "vanilla"); - const head = distances.map((rd) => `Render distance ${rd}`).join(""); - const sub = distances.map(() => `HorizonJavaHorizon against Java`).join(""); - const body = METRICS.map((m) => { - const cells = distances - .map((rd) => { - const h = pick(rows, "horizon", rd); - const j = pick(rows, "vanilla", rd); - const c = compareRows(m, h, j); - return `${cell(m, h)}${cell(m, j)}${c ? escape(c.text) : ""}`; - }) - .join(""); - return `${escape(m.label)}${m.hint ? `${escape(m.hint)}` : ""}${cells}`; - }).join(""); - const javaWins = METRICS.flatMap((m) => - distances.filter((rd) => compareRows(m, pick(rows, "horizon", rd), pick(rows, "vanilla", rd))?.wins === "java").map((rd) => `${m.label.toLowerCase()} at ${rd}`), - ); - // Per scene too: an average that Horizon wins can hide a scene where Java is faster. - const sceneName = { village: "the village", forest: "the forest", ocean: "the ocean", mountain: "the mountain" }; - for (const rd of distances) { - const h = pick(rows, "horizon", rd); - const j = pick(rows, "vanilla", rd); - for (const [scene, js] of Object.entries(j?.scenes || {})) { - const hs = h?.scenes?.[scene]; - if (!hs?.avg_fps || !js?.avg_fps || (h.capped_fps && hs.avg_fps >= h.capped_fps * 0.97)) continue; - if (js.avg_fps > hs.avg_fps * 1.05) javaWins.push(`average FPS over ${sceneName[scene] || scene} at ${rd} (${format("fps", js.avg_fps)} against ${format("fps", hs.avg_fps)})`); - } - } - const facts = [ - ["CPU", first.cpu], - ["GPU", first.gpu], - ["Horizon", horizon ? `${horizon.version} · ${horizon.backend || "?"}` : "not measured"], - ["Java", java ? `${java.version} (vanilla) · ${java.backend || "?"}` : "not measured"], - ["Measured", `${first.measured}${first.repeats ? ` · ${first.repeats} runs of each` : ""}${first.window ? ` · ${first.window.join("x")} window` : ""}`], - ]; - return `
-
-

Measured by us

-

${escape(name)}

-
${facts.map(([k, v]) => `
${k}
${escape(String(v))}
`).join("")}
- ${rows.find((r) => r.note) ? `

${escape(rows.find((r) => r.note).note)}

` : ""} -
-
- ${head}${sub} - ${body} -
- ${javaWins.length ? `

Where Java is ahead: ${escape(javaWins.join("; "))}.

` : `

Horizon is ahead on every figure here.

`} -
`; -} - -export function machinesHtml(summary) { - const by = machines(summary?.groups || []); - if (!by.size) return `

No measurements are published yet.

`; - return [...by].map(([name, rows]) => machineHtml(name, rows)).join("\n"); -} - -// The hardware breakdowns (the server's classes), in words. -export const DIMENSIONS = [ - { key: "ram", label: "Memory", word: (c) => `${c} RAM` }, - { key: "vram", label: "Graphics memory", word: (c) => (c === "shared" ? "shared graphics memory" : `${c} graphics memory`) }, - { key: "storage", label: "Drive", word: (c) => ({ nvme: "NVMe", ssd: "SSD", hdd: "hard disk" })[c] || c }, - { key: "os", label: "System", word: (c) => ({ linux: "Linux", macos: "macOS", windows: "Windows" })[c] || c }, - { key: "gpu_kind", label: "Graphics", word: (c) => (c === "integrated" ? "integrated GPU" : c === "discrete" ? "separate GPU" : c) }, -]; - -// A group's breakdowns in one line: "32 GB RAM (3) · NVMe (3) · Linux (3)". Empty without any. -export function breakdownLine(breakdowns) { - return DIMENSIONS.flatMap((d) => (breakdowns?.[d.key] || []).map((c) => `${d.word(c.class)} (${c.installs})`)).join(" · "); -} - -// GET /v1/aggregate's breakdowns: players' play sessions per hardware class. Empty without any. -export function hardwareHtml(aggregate) { - const b = aggregate?.breakdowns || {}; - const dims = DIMENSIONS.filter((d) => b[d.key]?.length); - if (!dims.length) return ""; - const rows = dims - .flatMap((d) => - b[d.key].map( - (c, i) => - `${i === 0 ? `${escape(d.label)}` : ""}${escape(d.word(c.class))}${c.installs}${Math.round(c.hours).toLocaleString("en")}${format("ms", c.p50_ms)}${format("ms", c.p99_ms)}`, - ), - ) - .join(""); - return `
- - ${rows} -
ByClassInstallsHours playedFrame time, medianFrame time, 99th percentile
`; -} - -// Players' groups: one row each, at least `min_installs` installs. -export function playersHtml(summary) { - const groups = (summary?.groups || []).filter((g) => g.source === "players"); - if (!groups.length) - return `

No player results yet. A GPU and CPU pair shows here once at least ${summary?.min_installs || 3} different installs have shared a benchmark with it.

`; - const rows = groups - .map( - (g) => `${escape(g.gpu)}${escape(g.cpu)}${g.render_distance}${g.game === "vanilla" ? "Java" : "Horizon"}${["avg_fps", "low_1pct_fps", "p95_ms", "world_ms", "rss_steady_mb"].map((k) => `${format(METRICS.find((m) => m.key === k).kind, g.medians?.[k])}`).join("")}From ${g.installs} players${breakdownLine(g.breakdowns) ? `${escape(breakdownLine(g.breakdowns))}` : ""}`, - ) - .join(""); - return `
- - ${rows} -
GPU and CPURender distanceGameAverage FPS1% lowp95To in-worldMemorySource
`; -} diff --git a/website/src/benchmarks-page.js b/website/src/benchmarks-page.js deleted file mode 100644 index 5d05848e3..000000000 --- a/website/src/benchmarks-page.js +++ /dev/null @@ -1,108 +0,0 @@ -// The Benchmarks page: players' results from the telemetry server (the baked summary when it doesn't answer) -// and the hardware picker (a measurement when there is one, else an estimate from src/estimate.js). -import { escape } from "./markdown.js"; -import { METRICS, cell, compareRows, format, hardwareHtml, playersHtml } from "./bench.js"; -import { estimate, measured, memoryNotes } from "./estimate.js"; -import { findCpu, findGpu } from "./hardware.js"; -import { setUpMenu, setUpTheme } from "./chrome.js"; - -const TELEMETRY = "https://telemetry.playhorizon.dev"; -const baked = JSON.parse(document.getElementById("bench-data").textContent); -let groups = baked.groups || []; - -async function live() { - try { - const res = await fetch(`${TELEMETRY}/v1/benchmarks/summary`, { signal: AbortSignal.timeout(3000) }); - if (!res.ok) throw new Error(String(res.status)); - const summary = await res.json(); - if (summary.format !== "horizon-benchmark-summary" || summary.version !== 1 || !Array.isArray(summary.groups)) throw new Error("format"); - // Our own rows stay the baked ones; players' come from the server. - const players = summary.groups.filter((g) => g.source === "players" && g.installs >= (summary.min_installs || 3)); - groups = [...groups.filter((g) => g.source === "us"), ...players]; - document.getElementById("players-table").innerHTML = playersHtml({ ...summary, groups: players }); - document.querySelector("[data-players-source]").textContent = `Live from the telemetry server, aggregated ${summary.generated.slice(0, 16).replace("T", " ")} UTC.`; - render(); - } catch { - // The baked results stay; the line under the heading already says when they were made. - } -} - -// Players' play sessions per hardware class (last 30 days); the section stays hidden until there are some. -async function hardware() { - try { - const res = await fetch(`${TELEMETRY}/v1/aggregate?days=30`, { signal: AbortSignal.timeout(3000) }); - if (!res.ok) return; - const html = hardwareHtml(await res.json()); - if (!html) return; - document.getElementById("players-hardware-table").innerHTML = html; - document.getElementById("players-hardware").hidden = false; - } catch { - // Nothing to show. - } -} - -const picker = document.getElementById("picker"); -const out = document.getElementById("pick-result"); - -const range = (kind, e) => { - if (!e) return "–"; - if (e.atLeast) return `at least ${format(kind, e.low)}`; - return e.low != null ? `${format(kind, e.low)} to ${format(kind, e.high)}` : format(kind, e.value); -}; - -function sourceBadge(row) { - return row.source === "us" ? `Measured by us · ${escape(row.machine)}` : `From ${row.installs} players`; -} - -function measuredTable(h, j) { - return `${METRICS.map((m) => { - const c = compareRows(m, h, j); - return ``; - }).join("")}
HorizonJavaHorizon against Java
${escape(m.label)}${cell(m, h)}${cell(m, j)}${c ? escape(c.text) : ""}
`; -} - -function estimateTable(h, j) { - return `${METRICS.map( - (m) => ``, - ).join("")}
Horizon (estimate)Java (estimate)
${escape(m.label)}${range(m.kind, h?.[m.key])}${range(m.kind, j?.[m.key])}
`; -} - -function render() { - const gpu = findGpu(picker.gpu.value); - const cpu = findCpu(picker.cpu.value); - const rd = Number(picker.rd.value); - const ramGb = Number(picker.ram.value) || null; - if (!gpu || !cpu) return; - // Horizon's and Java's notes, each once (the players' hardware is the same for both). - const notesHtml = (...lists) => { - const notes = [...new Set(lists.flat())]; - return notes.length ? `
    ${notes.map((n) => `
  • ${escape(n)}
  • `).join("")}
` : ""; - }; - const mh = measured(groups, gpu, cpu, rd, "horizon"); - const mj = measured(groups, gpu, cpu, rd, "vanilla"); - if (mh.length || mj.length) { - const h = mh[0]; - const j = mj[0]; - out.innerHTML = `

${[h, j].filter(Boolean).map(sourceBadge).join(" ")}

${measuredTable(h, j)}${notesHtml(...[h, j].filter(Boolean).map((row) => memoryNotes(row, gpu, ramGb)))}${ - h && h.source === "us" && h.measured ? `

Measured ${escape(h.measured)} with Horizon ${escape(h.version)}. The full table is under Measured by us.

` : "" - }`; - return; - } - const h = estimate(groups, gpu, cpu, rd, "horizon", { ramGb }); - const j = estimate(groups, gpu, cpu, rd, "vanilla", { ramGb }); - if (!h && !j) { - out.innerHTML = `

Nothing measured at render distance ${rd} to estimate from yet.

`; - return; - } - const base = (h || j).base; - const f = (h || j).factors; - const times = (x) => `${x >= 1 ? x.toFixed(x >= 10 ? 0 : 1) : x.toFixed(2)}x`; - out.innerHTML = `

Estimate From ${escape(base.source === "us" ? base.machine : `${base.gpu} with ${base.cpu}`)} (${escape(base.gpu)}, ${escape(base.cpu)}): GPU factor ${times(f.gpu)}, CPU factor ${times(f.cpu)}. How

${estimateTable(h, j)}${notesHtml(h?.notes || [], j?.notes || [])}

Ranges, not measurements: the real figure depends on drivers, the graphics API and cooling too. Memory is the measured machine's.

`; -} - -setUpTheme(); -setUpMenu(); -picker.addEventListener("change", render); -render(); -live(); -hardware(); diff --git a/website/src/benchmarks.html b/website/src/benchmarks.html deleted file mode 100644 index 41e270c5b..000000000 --- a/website/src/benchmarks.html +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - Benchmarks: Horizon against Java Edition · Horizon - - - - - - - - - - - - - - - - - - - - -{{SITE_NAV}} -
-
-

BenchmarksHorizon against Java Edition 26.3

-

Same machine, same world, same flight.

-

We run Horizon and vanilla Minecraft: Java Edition 26.3 one after the other on the same computer: a fresh world from the same seed, the same settings, and the same four flights over a village, a forest, the ocean and a mountain. Every figure comes from the same code for both games. Where Java does better, the tables say so.

- -
-

Measured by us

-

The project's own machines, at render distance 12 (vanilla's default) and 32. VSync off, no frame cap, a 1280x720 window, simulation distance 12, everything else at vanilla's defaults. Each figure is the median over the runs; the frame figures are averaged over the four flights.

-
-{{MACHINES}} -
-
- -
-

Your hardware

-

Pick a graphics card, a processor and, if you know it, your memory. If we or at least three players have measured that pair, you see what was measured; otherwise an estimate from the nearest measured machine, as a range.

-
- - - -
Render distance - - -
-
-

The picker needs JavaScript; the tables above and the method below work without it.

-
- -
-

From players

-

Players who allow benchmark uploads in the launcher's data collection settings share the report of horizon-client --benchmark standard. Results are grouped by graphics card, processor and render distance, and a group shows only once at least 3 different installs are in it, so no one can be picked out. Only medians are published, with how the group's installs split by memory, graphics memory, drive and system in coarse classes (each class only with at least 3 installs too): no install ID, date, driver, exact memory or screen.

-

{{PLAYERS_SOURCE}}

-
-{{PLAYERS}} -
-
- - - -
-

How the estimates work

-
-

An estimate starts from the measured machine closest to the one you picked, then scales its figures with a small table of specifications we wrote ourselves (no benchmark database):

-
    -
  • GPU factor: the geometric mean of the two graphics cards' ratio of FP32 shader throughput (TFLOPS) and of memory bandwidth (GB/s), as their makers state them.
  • -
  • CPU factor: the ratio of the two processors' single-thread scores: top boost clock times a rough factor per chip generation (Zen 4 = 1).
  • -
  • Frame rate: when the measured run split each frame into CPU and GPU time, the slower side is scaled by its factor; otherwise by the geometric mean of both. Whatever the split, the real figure lies between the measured one scaled by the smaller and by the larger factor; we widen that by 15% for the roughness of the table, and show it as the range.
  • -
  • Load times are CPU work (generating, lighting and meshing chunks), scaled by the CPU factor. Memory is not scaled: it follows the world and the settings, not the speed.
  • -
  • Memory size: when players' results say how much memory and graphics memory their machines have, a measured group whose players have neither yours counts as further away, and the estimate says what they had. With your memory picked, it also says when the game's peak use is a large share of it.
  • -
-

Estimates ignore drivers, the graphics API, thermal limits and the operating system, which can matter as much as the chip. Treat them as a rough idea, and run horizon-client --benchmark standard on your own machine for the real figure.

-
-
- The specification table -
{{SPEC_TABLE}}
-
-
- -
-

How we measure

-
-

tools/perf_bench.py starts each game from a fresh world (seed 1234, creative), waits until every chunk around the spawn is loaded and drawn, then for each scene teleports, waits for the chunks, holds for 2 seconds and flies a straight 192-block path in 12 seconds. Every frame is recorded. Vanilla runs as players get it (your own client, the official launcher's Java options, Java 25), driven by a small development-only mod that only calls the game's own code; nothing of Minecraft is shipped. The full method and its caveats are in docs/benchmark.md, and every raw report is in the repository.

-

Measure your own computer with horizon-client --benchmark standard --render-distance 12: it writes a report to the benchmarks folder of the game folder.

-
-
-

Not an official Minecraft product. Not approved by or associated with Mojang or Microsoft.

-
-
-{{SITE_FOOTER}} - - - diff --git a/website/src/chrome.js b/website/src/chrome.js deleted file mode 100644 index d11eb3370..000000000 --- a/website/src/chrome.js +++ /dev/null @@ -1,90 +0,0 @@ -// What every page with the site's top bar shares: the light and dark switch and the phone menu. -// Used by Home, Releases, Benchmarks and Docs. -const reducedMotion = matchMedia("(prefers-reduced-motion: reduce)").matches; - -// The page follows the system; the toggle picks the other appearance and remembers it. -export function setUpTheme() { - const root = document.documentElement; - const button = document.querySelector(".theme-toggle"); - if (!button) return; - const label = button.querySelector("[data-theme-label]"); - const system = matchMedia("(prefers-color-scheme: dark)"); - const dark = () => (root.dataset.theme ? root.dataset.theme === "dark" : system.matches); - const show = () => (label.textContent = dark() ? "Light" : "Dark"); - button.addEventListener("click", () => { - root.dataset.theme = dark() ? "light" : "dark"; - try { - localStorage.setItem("theme", root.dataset.theme); - } catch {} - show(); - }); - system.addEventListener("change", show); - show(); -} - -// The phone menu: a full-screen sheet; the page behind it is inert while it is open. -export function setUpMenu() { - const bar = document.querySelector(".nav"); - const button = document.querySelector(".menu-button"); - const menu = document.getElementById("menu"); - const content = document.querySelector("[data-menu-content]") || document.getElementById("main"); - if (!bar || !button || !menu) return; - const label = button.querySelector(".menu-label"); - const items = [...menu.querySelectorAll("nav a")]; - items.forEach((a, i) => a.style.setProperty("transition-delay", `${60 + i * 35}ms`)); - let closing; - const setOpen = (open) => { - clearTimeout(closing); - button.setAttribute("aria-expanded", String(open)); - label.textContent = open ? "Close" : "Menu"; - bar.classList.toggle("is-menu", open); - content.inert = open; - document.body.style.overflow = open ? "hidden" : ""; - if (open) { - menu.hidden = false; - requestAnimationFrame(() => requestAnimationFrame(() => menu.classList.add("is-open"))); - items[0].focus({ preventScroll: true }); - } else { - menu.classList.remove("is-open"); - closing = setTimeout(() => (menu.hidden = true), reducedMotion ? 0 : 320); - } - }; - button.addEventListener("click", () => setOpen(button.getAttribute("aria-expanded") !== "true")); - items.forEach((a) => a.addEventListener("click", () => setOpen(false))); - addEventListener("keydown", (e) => { - if (e.key === "Escape" && button.getAttribute("aria-expanded") === "true") { - setOpen(false); - button.focus(); - } - }); - matchMedia("(min-width: 1280px)").addEventListener("change", (e) => e.matches && setOpen(false)); -} - -// GitHub answers, cached for ten minutes in the tab. -export async function cached(key, load) { - try { - const hit = JSON.parse(sessionStorage.getItem(key) || "null"); - if (hit && Date.now() - hit.at < 10 * 60 * 1000) return hit.value; - } catch {} - const value = await load(); - try { - sessionStorage.setItem(key, JSON.stringify({ at: Date.now(), value })); - } catch {} - return value; -} - -export async function get(url, as = "json") { - const res = await fetch(url, { headers: as === "json" ? { Accept: "application/vnd.github+json" } : {} }); - if (!res.ok) throw new Error(`${res.status}`); - return as === "json" ? res.json() : res.text(); -} - -export const slim = (r) => ({ - tag_name: r.tag_name, - name: r.name, - published_at: r.published_at, - html_url: r.html_url, - prerelease: r.prerelease, - body: r.body || "", - assets: (r.assets || []).map((a) => ({ name: a.name, browser_download_url: a.browser_download_url, size: a.size })), -}); diff --git a/website/src/contributors.js b/website/src/contributors.js deleted file mode 100644 index 12bce9457..000000000 --- a/website/src/contributors.js +++ /dev/null @@ -1,39 +0,0 @@ -// The contributors: GitHub's list for the repository, without bots, the owner first. Shared by -// build.mjs (baked into the page) and main.js (refreshed from GitHub). -import { escape } from "./markdown.js"; - -const OWNER = "ludovic111"; -const AVATARS = "https://avatars.githubusercontent.com/"; - -// Reduces GitHub's contributor objects to what the page shows; bots (type Bot, or a login -// ending in [bot]) and anything without a login or a profile address are dropped. -export function contributorsFrom(list) { - if (!Array.isArray(list)) return []; - return list - .filter((c) => c && typeof c.login === "string" && c.login && c.type !== "Bot" && !/\[bot\]$/i.test(c.login)) - .map((c) => ({ - login: c.login, - html_url: typeof c.html_url === "string" ? c.html_url : `https://github.com/${c.login}`, - avatar_url: typeof c.avatar_url === "string" ? c.avatar_url : "", - contributions: Number(c.contributions) || 0, - })) - .sort((a, b) => (b.login === OWNER) - (a.login === OWNER) || b.contributions - a.contributions); -} - -// GitHub serves avatars at any size: 96 px is twice what the page draws, for sharp screens. -export function avatar(url) { - if (!url.startsWith(AVATARS)) return ""; - const u = new URL(url); - u.searchParams.set("s", "96"); - return u.href; -} - -export function contributorsHtml(list) { - return list - .map((c) => { - const src = avatar(c.avatar_url); - const count = `${c.contributions.toLocaleString("en-US")} ${c.contributions === 1 ? "commit" : "commits"}`; - return `
  • ${src ? `` : ``}${escape(c.login)}${count}
  • `; - }) - .join(""); -} diff --git a/website/src/docs-page.js b/website/src/docs-page.js deleted file mode 100644 index 99da35187..000000000 --- a/website/src/docs-page.js +++ /dev/null @@ -1,5 +0,0 @@ -// The Docs pages share the site's theme switch and phone menu. -import { setUpMenu, setUpTheme } from "./chrome.js"; - -setUpTheme(); -setUpMenu(); diff --git a/website/src/docs.html b/website/src/docs.html deleted file mode 100644 index 56ba89c09..000000000 --- a/website/src/docs.html +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - {{DOC_TITLE}} · Horizon docs - - - - - - - - - - - - - - - - - - - - -{{SITE_NAV}} - -
    -
    - Docs menu - -
    - - -
    -

    {{DOC_GROUP}}

    -

    {{DOC_TITLE}}

    -

    {{DOC_LEDE}}

    -{{DOC_TOC}} -
    -{{DOC_BODY}} -
    - -

    Edit this page on GitHub · Spotted something wrong? Open an issue or ask on Discord.

    -

    Not an official Minecraft product. Not approved by or associated with Mojang or Microsoft.

    -
    -
    - - - diff --git a/website/src/estimate.js b/website/src/estimate.js deleted file mode 100644 index ccd053cc0..000000000 --- a/website/src/estimate.js +++ /dev/null @@ -1,110 +0,0 @@ -// Estimates for hardware nobody has measured yet, from the nearest measured machine and the spec table -// (src/hardware.js). The method, which the Benchmarks page explains: -// -// - GPU factor: the geometric mean of the two GPUs' FP32 throughput ratio and memory bandwidth ratio. -// - CPU factor: the ratio of the two CPUs' single-thread scores (boost clock x generation factor). -// - Frames: when the measured run split each frame into CPU and GPU time, the slower of the two is scaled by its -// own factor; otherwise the frame rate is scaled by the geometric mean of both factors. Whatever the split, the -// true figure lies between the measured one scaled by the smaller and by the larger factor, widened by 15% for -// the roughness of the table: that is the range shown. -// - World and chunk load times are CPU work (generation, lighting, meshing): scaled by the CPU factor. -// - Memory is not scaled: it depends on the world and settings, not on speed. -// - Memory size: players' groups say how their installs split by RAM and by the GPU's own memory (breakdowns). A -// base whose players have neither the picked RAM nor the picked GPU's memory class counts as further away, and -// the estimate says what the base's players had, and when the game's peak memory is a large share of the RAM. -import { findCpu, findGpu, ramClass, singleThread, vramClass } from "./hardware.js"; - -const MARGIN = 0.15; - -export function factors(fromGpu, fromCpu, toGpu, toCpu) { - const gpu = Math.sqrt((toGpu.tflops / fromGpu.tflops) * (toGpu.gbps / fromGpu.gbps)); - const cpu = singleThread(toCpu) / singleThread(fromCpu); - return { gpu, cpu }; -} - -const distance = (f) => Math.abs(Math.log(f.gpu)) + Math.abs(Math.log(f.cpu)); -// Added to the distance per memory class (RAM, VRAM) the base's players don't have: about a 20% speed gap. -const MEMORY_MISMATCH = 0.2; - -// The classes a row's installs have in a breakdown, or null when it has none (our own rows, older summaries). -const classesIn = (row, dim) => (row.breakdowns?.[dim]?.length ? row.breakdowns[dim].map((c) => c.class) : null); - -function mismatch(row, gpu, ramGb) { - let d = 0; - const vram = classesIn(row, "vram"); - if (vram && !vram.includes(vramClass(gpu))) d += MEMORY_MISMATCH; - const ram = classesIn(row, "ram"); - if (ram && ramGb && !ram.includes(ramClass(ramGb))) d += MEMORY_MISMATCH; - return d; -} - -// What to say about memory: the base's players' RAM and VRAM when they differ from the pick, and the game's peak -// memory against the picked RAM. -export function memoryNotes(row, gpu, ramGb) { - const notes = []; - const list = (dim) => row.breakdowns[dim].map((c) => `${c.class} (${c.installs})`).join(", "); - const vram = classesIn(row, "vram"); - if (vram && gpu && !vram.includes(vramClass(gpu))) notes.push(`The measured players' graphics cards have ${list("vram")} of their own memory; this one has ${gpu.vram_gb ? `${gpu.vram_gb} GB` : "none (it shares the system's)"}.`); - const ram = classesIn(row, "ram"); - if (ram && ramGb && !ram.includes(ramClass(ramGb))) notes.push(`The measured players have ${list("ram")} of memory, not ${ramGb} GB.`); - const peak = row.medians?.rss_peak_mb; - if (ramGb && peak && peak / 1024 > ramGb * 0.4) - notes.push(`${row.game === "vanilla" ? "Java" : "Horizon"} used up to ${(peak / 1024).toFixed(1)} GB here: with ${ramGb} GB, close other programs, or the system may swap and stutter.`); - return notes; -} - -// The rows (benchmarks.json groups) usable as a base: a known GPU and CPU. -function known(rows) { - return rows.map((row) => ({ row, gpu: findGpu(row.gpu), cpu: findCpu(row.cpu) })).filter((r) => r.gpu && r.cpu); -} - -// The measured row for exactly this GPU and CPU, players' first when there are some (more installs), or null. -export function measured(rows, gpu, cpu, rd, game) { - const hits = known(rows).filter((r) => r.gpu === gpu && r.cpu === cpu && r.row.render_distance === rd && r.row.game === game); - hits.sort((a, b) => (b.row.installs || 0) - (a.row.installs || 0)); - return hits.map((r) => r.row); -} - -// The nearest measured machine for a target GPU and CPU, for one game and render distance. -export function nearest(rows, gpu, cpu, rd, game, { ramGb } = {}) { - let best = null; - for (const r of known(rows)) { - if (r.row.render_distance !== rd || r.row.game !== game) continue; - const f = factors(r.gpu, r.cpu, gpu, cpu); - const d = distance(f) + mismatch(r.row, gpu, ramGb); - if (!best || d < best.d) best = { ...r, f, d }; - } - return best; -} - -export function estimate(rows, gpu, cpu, rd, game, { ramGb } = {}) { - const base = nearest(rows, gpu, cpu, rd, game, { ramGb }); - if (!base) return null; - const m = base.row.medians; - const { gpu: g, cpu: c } = base.f; - const lo = Math.min(g, c) * (1 - MARGIN); - const hi = Math.max(g, c) * (1 + MARGIN); - let scale = Math.sqrt(g * c); - if (m.cpu_p50_ms && m.gpu_p50_ms) { - const worst = Math.max(m.cpu_p50_ms, m.gpu_p50_ms); - scale = worst / Math.max(m.cpu_p50_ms / c, m.gpu_p50_ms / g); - } - scale = Math.min(hi, Math.max(lo, scale)); - const fps = (x) => (x == null ? null : { value: x * scale, low: x * lo, high: x * hi }); - // A base held to its display's refresh rate gives only a floor for the average. - const avg = fps(m.avg_fps); - if (avg && base.row.capped_fps && m.avg_fps >= base.row.capped_fps * 0.97) Object.assign(avg, { value: null, high: null, atLeast: true }); - const time = (x, f) => (x == null ? null : { value: x / f, low: x / (f * (1 + MARGIN)), high: x / (f * (1 - MARGIN)) }); - return { - base: base.row, - factors: base.f, - avg_fps: avg, - low_1pct_fps: fps(m.low_1pct_fps), - p95_ms: m.p95_ms == null ? null : { value: m.p95_ms / scale, low: m.p95_ms / hi, high: m.p95_ms / lo }, - world_ms: time(m.world_ms, c), - chunk_load_ms: time(m.chunk_load_ms, c), - rss_steady_mb: m.rss_steady_mb == null ? null : { value: m.rss_steady_mb }, - rss_peak_mb: m.rss_peak_mb == null ? null : { value: m.rss_peak_mb }, - notes: memoryNotes(base.row, gpu, ramGb), - }; -} diff --git a/website/src/estimate.test.mjs b/website/src/estimate.test.mjs deleted file mode 100644 index d46f9c4b5..000000000 --- a/website/src/estimate.test.mjs +++ /dev/null @@ -1,101 +0,0 @@ -// node --test website/src/ (npm test in website/) -import { test } from "node:test"; -import assert from "node:assert/strict"; -import { estimate, factors, measured, nearest } from "./estimate.js"; -import { CPUS, GPUS, findCpu, findGpu } from "./hardware.js"; - -const row = (gpu, cpu, medians, extra = {}) => ({ gpu, cpu, render_distance: 12, game: "horizon", source: "us", medians, ...extra }); -const mac = row("Apple M4 Pro", "Apple M4 Pro", { avg_fps: 500, low_1pct_fps: 100, p95_ms: 3, world_ms: 4000, chunk_load_ms: 1000, rss_peak_mb: 1500, rss_steady_mb: 1200 }); -const laptop = row("Mesa Intel HD Graphics 620 (KBL GT2)", "Intel Core i7-7500U CPU @ 2.70GHz", { avg_fps: 100, low_1pct_fps: 20, p95_ms: 15, world_ms: 12000, chunk_load_ms: 5000, rss_peak_mb: 1400, rss_steady_mb: 1100, cpu_p50_ms: 4, gpu_p50_ms: 9 }); - -test("every reported name of our machines is in the table", () => { - assert.equal(findGpu("Apple M4 Pro").name, "Apple M4 Pro (20-core GPU)"); - assert.equal(findGpu("Mesa Intel HD Graphics 620 (KBL GT2)").name, "Intel HD Graphics 620"); - assert.equal(findGpu("NVIDIA GeForce RTX 4080").name, "NVIDIA GeForce RTX 4080"); - assert.equal(findGpu("NVIDIA GeForce RTX 4080 SUPER"), null); - assert.equal(findCpu("13th Gen Intel Core i7-13700KF").name, "Intel Core i7-13700K / KF"); - assert.equal(findCpu("Intel Core i7-7500U CPU @ 2.70GHz").name, "Intel Core i7-7500U"); - for (const g of GPUS) assert.equal(findGpu(g.name), g, g.name); - for (const c of CPUS) assert.equal(findCpu(c.name), c, c.name); -}); - -test("an exact match is a measurement, not an estimate", () => { - assert.deepEqual(measured([mac, laptop], findGpu("Apple M4 Pro"), findCpu("Apple M4 Pro"), 12, "horizon"), [mac]); - assert.deepEqual(measured([mac], findGpu("Apple M4 Pro"), findCpu("Apple M4 Pro"), 32, "horizon"), []); -}); - -test("the nearest machine is the base, and the range holds the estimate", () => { - const gpu = findGpu("Intel Iris Xe Graphics (96 EU)"); - const cpu = findCpu("Intel Core i5-1135G7"); - assert.equal(nearest([mac, laptop], gpu, cpu, 12, "horizon").row, laptop); - const e = estimate([mac, laptop], gpu, cpu, 12, "horizon"); - const f = factors(findGpu(laptop.gpu), findCpu(laptop.cpu), gpu, cpu); - assert.ok(f.gpu > 1 && f.cpu > 1); - for (const key of ["avg_fps", "low_1pct_fps", "p95_ms", "world_ms", "chunk_load_ms"]) { - const { value, low, high } = e[key]; - assert.ok(low <= value && value <= high, key); - } - // GPU-bound frames (9 ms GPU, 4 ms CPU) follow the GPU factor. - assert.ok(Math.abs(e.avg_fps.value - 100 * Math.min(f.gpu, 9 / (4 / f.cpu))) < 1e-9); - assert.ok(Math.abs(e.world_ms.value - 12000 / f.cpu) < 1e-9); - assert.equal(e.rss_steady_mb.value, 1100); -}); - -test("no base, no estimate", () => { - assert.equal(estimate([mac], findGpu("Apple M4"), findCpu("Apple M4"), 32, "horizon"), null); - assert.equal(estimate([mac], findGpu("Apple M4"), findCpu("Apple M4"), 12, "vanilla"), null); -}); - -test("a base held to its display's refresh rate gives only a floor for the average", () => { - const held = { ...mac, capped_fps: 144, medians: { ...mac.medians, avg_fps: 144 } }; - const e = estimate([held], findGpu("NVIDIA GeForce RTX 4060"), findCpu("AMD Ryzen 5 5600X"), 12, "horizon"); - assert.equal(e.avg_fps.atLeast, true); - assert.equal(e.avg_fps.high, null); - assert.ok(e.avg_fps.low > 0); - // The lows sit under the cap: still a range. - assert.ok(e.low_1pct_fps.high > e.low_1pct_fps.low); -}); - -test("a release title of issue numbers falls back to its notes", async () => { - const { parts } = await import("./releases.js"); - const r = { tag_name: "v2026.10.22.07", name: "Horizon 2026.10.22.07: #1255, mob pushes, fix, #1222", body: "### Fixed\n- Fix #1222: single player runs in the frame again (#1257, fixes #1222)\n- Mob pushes: one list per mob (#1205)\n" }; - assert.equal(parts(r).line, "Single player runs in the frame again and 1 more"); - assert.equal(parts({ ...r, name: "Horizon 2026.10.22.05: Hoppers, mob tick, server tick" }).line, "Hoppers, mob tick, server tick"); -}); - -test("players' memory classes steer the base and the notes", async () => { - const { memoryNotes } = await import("./estimate.js"); - const { ramClass, vramClass } = await import("./hardware.js"); - assert.equal(vramClass(findGpu("NVIDIA GeForce RTX 4080")), "16 GB"); - assert.equal(vramClass(findGpu("NVIDIA GeForce RTX 3080")), "12 GB"); - assert.equal(vramClass(findGpu("Apple M4 Pro")), "shared"); - assert.equal(ramClass(16), "16 GB"); - // Two equally near groups: the one whose players have the picked GPU's memory class wins. - const players = (vram, ram, fps) => - row("NVIDIA GeForce RTX 4070", "AMD Ryzen 5 7600X", { avg_fps: fps, rss_peak_mb: 3600 }, { source: "players", installs: 3, breakdowns: { vram: [{ class: vram, installs: 3 }], ram: [{ class: ram, installs: 3 }] } }); - const a = players("8 GB", "16 GB", 400); - const b = { ...players("12 GB", "32 GB", 500), cpu: "AMD Ryzen 7 7800X3D" }; - const gpu = findGpu("NVIDIA GeForce RTX 4070 Ti"); - const cpu = findCpu("AMD Ryzen 5 7600X"); - assert.equal(nearest([a, b], gpu, cpu, 12, "horizon").row, b, "12 GB like the 4070 Ti, though the CPU differs"); - assert.equal(nearest([a, b], gpu, cpu, 12, "horizon", { ramGb: 16 }).row, a, "both classes count"); - assert.deepEqual(memoryNotes(b, gpu, 32), []); - const notes = memoryNotes(a, gpu, 8); - assert.equal(notes.length, 3); - assert.match(notes[0], /8 GB \(3\) of their own memory; this one has 12 GB/); - assert.match(notes[1], /16 GB \(3\) of memory, not 8 GB/); - assert.match(notes[2], /Horizon used up to 3\.5 GB/); - // Our own rows have no breakdowns: only the peak memory note. - assert.deepEqual(memoryNotes(mac, gpu, 32), []); - assert.equal(estimate([a], gpu, cpu, 12, "horizon", { ramGb: 8 }).notes.length, 3); -}); - -test("breakdowns read as words, and the hardware table shows only with data", async () => { - const { breakdownLine, hardwareHtml } = await import("./bench.js"); - assert.equal(breakdownLine({ ram: [{ class: "32 GB", installs: 3 }], storage: [{ class: "nvme", installs: 4 }], gpu_kind: [{ class: "discrete", installs: 3 }] }), "32 GB RAM (3) · NVMe (4) · separate GPU (3)"); - assert.equal(breakdownLine(undefined), ""); - assert.equal(hardwareHtml({ breakdowns: {} }), ""); - const html = hardwareHtml({ breakdowns: { os: [{ class: "linux", installs: 5, sessions: 9, hours: 4.5, p50_ms: 6.2, p99_ms: 14 }] } }); - assert.match(html, /Linux/); - assert.match(html, /6\.2 ms/); -}); diff --git a/website/src/hardware.js b/website/src/hardware.js deleted file mode 100644 index bf4c8bbbd..000000000 --- a/website/src/hardware.js +++ /dev/null @@ -1,88 +0,0 @@ -// The hardware the Benchmarks page can estimate for, from specifications only (our own table, no benchmark -// database): each GPU's FP32 shader throughput in TFLOPS and its memory bandwidth in GB/s as its maker states them, -// its own memory in GB (vram_gb; 0 for a GPU that shares the system's: integrated, Apple silicon), -// and each CPU's single-thread score = its top boost clock (GHz) x our rough per-generation factor (instructions per -// clock, Zen 4 = 1). The factors are round numbers, so estimates are ranges, and the page says so. -// `match` finds a reported name (the GPU and CPU strings in benchmark reports) in this table. - -export const GPUS = [ - { name: "NVIDIA GeForce RTX 4090", tflops: 82.6, gbps: 1008, vram_gb: 24, match: /RTX 4090/i }, - { name: "NVIDIA GeForce RTX 4080", tflops: 48.7, gbps: 717, vram_gb: 16, match: /RTX 4080(?! SUPER)/i }, - { name: "NVIDIA GeForce RTX 4070 Ti", tflops: 40.1, gbps: 504, vram_gb: 12, match: /RTX 4070 Ti/i }, - { name: "NVIDIA GeForce RTX 4070", tflops: 29.1, gbps: 504, vram_gb: 12, match: /RTX 4070(?! Ti)/i }, - { name: "NVIDIA GeForce RTX 4060 Ti", tflops: 22.1, gbps: 288, vram_gb: 8, match: /RTX 4060 Ti/i }, - { name: "NVIDIA GeForce RTX 4060", tflops: 15.1, gbps: 272, vram_gb: 8, match: /RTX 4060(?! Ti)/i }, - { name: "NVIDIA GeForce RTX 3080", tflops: 29.8, gbps: 760, vram_gb: 10, match: /RTX 3080(?! Ti)/i }, - { name: "NVIDIA GeForce RTX 3070", tflops: 20.3, gbps: 448, vram_gb: 8, match: /RTX 3070(?! Ti)/i }, - { name: "NVIDIA GeForce RTX 3060", tflops: 12.7, gbps: 360, vram_gb: 12, match: /RTX 3060(?! Ti)/i }, - { name: "NVIDIA GeForce RTX 3050", tflops: 9.1, gbps: 224, vram_gb: 8, match: /RTX 3050/i }, - { name: "NVIDIA GeForce RTX 2060", tflops: 6.5, gbps: 336, vram_gb: 6, match: /RTX 2060(?! SUPER)/i }, - { name: "NVIDIA GeForce GTX 1660 SUPER", tflops: 5.0, gbps: 336, vram_gb: 6, match: /GTX 1660 SUPER/i }, - { name: "NVIDIA GeForce GTX 1060 6GB", tflops: 4.4, gbps: 192, vram_gb: 6, match: /GTX 1060/i }, - { name: "NVIDIA GeForce GTX 1050 Ti", tflops: 2.1, gbps: 112, vram_gb: 4, match: /GTX 1050 Ti/i }, - { name: "AMD Radeon RX 7900 XTX", tflops: 61.4, gbps: 960, vram_gb: 24, match: /RX 7900 XTX/i }, - { name: "AMD Radeon RX 7800 XT", tflops: 37.3, gbps: 624, vram_gb: 16, match: /RX 7800 XT/i }, - { name: "AMD Radeon RX 7600", tflops: 21.8, gbps: 288, vram_gb: 8, match: /RX 7600(?! XT)/i }, - { name: "AMD Radeon RX 6700 XT", tflops: 13.2, gbps: 384, vram_gb: 12, match: /RX 6700 XT/i }, - { name: "AMD Radeon RX 6600", tflops: 8.9, gbps: 224, vram_gb: 8, match: /RX 6600(?! XT)/i }, - { name: "AMD Radeon RX 580", tflops: 6.2, gbps: 256, vram_gb: 8, match: /RX 580/i }, - { name: "AMD Radeon 780M (integrated)", tflops: 8.6, gbps: 89, vram_gb: 0, match: /780M/i }, - { name: "Steam Deck (AMD Van Gogh)", tflops: 1.6, gbps: 88, vram_gb: 0, match: /VanGogh|Van Gogh|Custom GPU 0405/i }, - { name: "Intel Arc A770", tflops: 19.7, gbps: 560, vram_gb: 16, match: /Arc.*A770/i }, - { name: "Intel Iris Xe Graphics (96 EU)", tflops: 2.1, gbps: 68, vram_gb: 0, match: /Iris\(?R?\)? Xe/i }, - { name: "Intel HD Graphics 620", tflops: 0.4, gbps: 34, vram_gb: 0, match: /\bU?HD Graphics 620\b/i }, - { name: "Apple M1", tflops: 2.6, gbps: 68, vram_gb: 0, match: /^Apple M1$/i }, - { name: "Apple M2", tflops: 3.6, gbps: 100, vram_gb: 0, match: /^Apple M2$/i }, - { name: "Apple M3", tflops: 4.1, gbps: 100, vram_gb: 0, match: /^Apple M3$/i }, - { name: "Apple M4", tflops: 4.3, gbps: 120, vram_gb: 0, match: /^Apple M4$/i }, - { name: "Apple M1 Pro (16-core GPU)", tflops: 5.2, gbps: 200, vram_gb: 0, match: /^Apple M1 Pro$/i }, - { name: "Apple M4 Pro (20-core GPU)", tflops: 8.5, gbps: 273, vram_gb: 0, match: /^Apple M4 Pro$/i }, - { name: "Apple M4 Max (40-core GPU)", tflops: 17.0, gbps: 546, vram_gb: 0, match: /^Apple M4 Max$/i }, -]; - -// ghz: top single-core boost clock; ipc: our per-generation factor (Zen 4 = 1). -export const CPUS = [ - { name: "Intel Core i7-7500U", ghz: 3.5, ipc: 0.62, match: /i7-7500U/i }, - { name: "Intel Core i5-7200U", ghz: 3.1, ipc: 0.62, match: /i5-7200U/i }, - { name: "Intel Core i5-8250U", ghz: 3.4, ipc: 0.62, match: /i5-8250U/i }, - { name: "Intel Core i5-9400F", ghz: 4.1, ipc: 0.62, match: /i5-9400/i }, - { name: "Intel Core i7-9700K", ghz: 4.9, ipc: 0.62, match: /i7-9700K/i }, - { name: "Intel Core i5-10400", ghz: 4.3, ipc: 0.62, match: /i5-10400/i }, - { name: "Intel Core i5-1135G7", ghz: 4.2, ipc: 0.78, match: /i5-1135G7/i }, - { name: "Intel Core i5-12400", ghz: 4.4, ipc: 0.95, match: /i5-12400/i }, - { name: "Intel Core i5-13600K", ghz: 5.1, ipc: 0.95, match: /i5-13600K/i }, - { name: "Intel Core i7-13700K / KF", ghz: 5.4, ipc: 0.95, match: /i7-13700K/i }, - { name: "Intel Core i9-14900K", ghz: 6.0, ipc: 0.95, match: /i9-14900K/i }, - { name: "AMD Ryzen 5 3600", ghz: 4.2, ipc: 0.72, match: /Ryzen 5 3600/i }, - { name: "AMD Ryzen 5 5600X", ghz: 4.6, ipc: 0.88, match: /Ryzen 5 5600X?\b/i }, - { name: "AMD Ryzen 7 5800X3D", ghz: 4.5, ipc: 0.88, match: /5800X3D/i }, - { name: "AMD Ryzen 5 7600X", ghz: 5.3, ipc: 1.0, match: /Ryzen 5 7600/i }, - { name: "AMD Ryzen 7 7800X3D", ghz: 5.0, ipc: 1.0, match: /7800X3D/i }, - { name: "AMD Ryzen 9 7950X", ghz: 5.7, ipc: 1.0, match: /Ryzen 9 7950X(?!3D)/i }, - { name: "AMD Ryzen 7 9700X", ghz: 5.5, ipc: 1.12, match: /Ryzen 7 9700X/i }, - { name: "AMD Ryzen 7 7840U / HS", ghz: 5.1, ipc: 1.0, match: /7840(U|HS)/i }, - { name: "Steam Deck (AMD Zen 2, 4 cores)", ghz: 3.5, ipc: 0.72, match: /AMD Custom APU 0405|Van ?Gogh/i }, - { name: "Apple M1", ghz: 3.2, ipc: 1.25, match: /^Apple M1$/i }, - { name: "Apple M2", ghz: 3.5, ipc: 1.28, match: /^Apple M2$/i }, - { name: "Apple M3", ghz: 4.05, ipc: 1.38, match: /^Apple M3$/i }, - { name: "Apple M4", ghz: 4.4, ipc: 1.5, match: /^Apple M4$/i }, - { name: "Apple M4 Pro", ghz: 4.5, ipc: 1.5, match: /^Apple M4 Pro$/i }, -]; - -export const singleThread = (cpu) => cpu.ghz * cpu.ipc; -export const findGpu = (name) => GPUS.find((g) => g.name === name || g.match.test(name || "")) || null; -export const findCpu = (name) => CPUS.find((c) => c.name === name || c.match.test(name || "")) || null; - -// The telemetry server's hardware classes (crates/horizon-telemetry-server/src/classes.rs), which players' -// results are broken down by: memory and a GPU's own memory in coarse steps. -export function ramClass(gb) { - if (!(gb > 0)) return null; - return gb <= 5 ? "4 GB or less" : gb <= 10 ? "8 GB" : gb <= 20 ? "16 GB" : gb <= 40 ? "32 GB" : "64 GB or more"; -} -export function vramClass(gpu) { - if (!gpu) return null; - if (!gpu.vram_gb) return "shared"; - const mb = gpu.vram_gb * 1024; - for (const [max, name] of [[2560, "2 GB or less"], [4608, "4 GB"], [6656, "6 GB"], [8704, "8 GB"], [12800, "12 GB"], [16896, "16 GB"]]) if (mb <= max) return name; - return "more than 16 GB"; -} diff --git a/website/src/hub-page.js b/website/src/hub-page.js deleted file mode 100644 index 9115c5ca4..000000000 --- a/website/src/hub-page.js +++ /dev/null @@ -1,270 +0,0 @@ -// The hub page (/hub): its tabs (one per #hash, so /hub#roadmap and /hub# can be linked), the -// Simple / Technical switch (remembered in localStorage), the area filter, and the live state of every -// linked issue and pull request, refreshed from GitHub's public API. Without JavaScript, every tab reads -// one after the other with what was baked at build time. -import { cached, get, setUpMenu, setUpTheme } from "./chrome.js"; -import { REPO, boardFilterHtml, boardFrom, boardHtml, journalFrom, journalHtml, overviewHtml, roadmapHtml, slimIssue } from "./hub.js"; - -const root = document.documentElement; -const data = JSON.parse(document.getElementById("hub-data").textContent); -const tabs = [...document.querySelectorAll('.hub-tabs [role="tab"]')]; -const pill = document.querySelector(".hub-tabs .tab-pill"); -let area = "all"; - -// --- Tabs ------------------------------------------------------------------------------------------------------ - -const panelOf = (tab) => document.getElementById(tab.getAttribute("aria-controls")); -const place = (tab) => { - pill.style.width = `${tab.offsetWidth}px`; - pill.style.height = `${tab.offsetHeight}px`; - pill.style.transform = `translate(${tab.offsetLeft}px, ${tab.offsetTop}px)`; -}; -function choose(tab, { focus = false, push = false } = {}) { - for (const t of tabs) { - const on = t === tab; - t.setAttribute("aria-selected", String(on)); - t.tabIndex = on ? 0 : -1; - panelOf(t).classList.toggle("is-active", on); - } - place(tab); - if (focus) tab.focus(); - if (push && location.hash !== `#${panelOf(tab).id}`) history.replaceState(null, "", `#${panelOf(tab).id}`); -} -// "#roadmap" opens its tab; "#" or "#help-wanted" opens the tab holding it and scrolls there. -function follow() { - const target = location.hash && document.getElementById(decodeURIComponent(location.hash.slice(1))); - const tab = tabs.find((t) => target && (panelOf(t) === target || panelOf(t).contains(target))) || tabs[0]; - choose(tab); - if (target && target !== panelOf(tab)) { - if (target.dataset.area && area !== "all" && target.dataset.area !== area) filter("all"); - requestAnimationFrame(() => target.scrollIntoView({ block: "start" })); - } -} -tabs.forEach((tab, i) => { - tab.addEventListener("click", () => choose(tab, { push: true })); - tab.addEventListener("keydown", (e) => { - const step = { ArrowRight: 1, ArrowLeft: -1 }[e.key]; - if (step) choose(tabs[(i + step + tabs.length) % tabs.length], { focus: true, push: true }); - }); -}); -// Links inside the page ("Help wanted", an item of the overview) switch tabs through the hash. -addEventListener("hashchange", follow); -addEventListener("resize", () => place(tabs.find((t) => t.getAttribute("aria-selected") === "true"))); -document.fonts?.ready.then(() => place(tabs.find((t) => t.getAttribute("aria-selected") === "true"))); - -// --- Simple / Technical ---------------------------------------------------------------------------------------- - -const detailButtons = [...document.querySelectorAll("[data-detail]")]; -function detail(mode) { - if (mode === "dev") root.dataset.detail = "dev"; - else delete root.dataset.detail; - detailButtons.forEach((b) => b.setAttribute("aria-pressed", String(b.dataset.detail === mode))); -} -detailButtons.forEach((b) => - b.addEventListener("click", () => { - detail(b.dataset.detail); - try { - localStorage.setItem("hub:detail", b.dataset.detail); - } catch {} - }), -); -detail(root.dataset.detail === "dev" ? "dev" : "plain"); - -// --- Area filter ----------------------------------------------------------------------------------------------- - -const areaButtons = [...document.querySelectorAll("[data-area-filter]")]; -function filter(to) { - area = to; - areaButtons.forEach((b) => b.setAttribute("aria-pressed", String(b.dataset.areaFilter === area))); - for (const section of document.querySelectorAll("[data-roadmap] .hub-section")) { - let shown = 0; - for (const item of section.querySelectorAll(".hub-item")) { - item.hidden = area !== "all" && item.dataset.area !== area; - if (!item.hidden) shown++; - } - section.hidden = shown === 0; - } -} -areaButtons.forEach((b) => b.addEventListener("click", () => filter(b.dataset.areaFilter))); - -// --- The board: a roadmap item's cards, and the long columns' "Show more" ---------------------------------------- - -const boardSelect = document.querySelector("[data-board-item]"); -function showItem() { - const want = boardSelect.value; - for (const card of document.querySelectorAll("[data-board] .hub-card")) { - card.hidden = want === "-" ? !card.dataset.item : want ? card.dataset.item !== want : false; - } - for (const column of document.querySelectorAll("[data-board] .hub-column")) { - column.querySelector("[data-count]").textContent = column.querySelectorAll(".hub-card:not([hidden])").length; - // A filtered column shows all its cards. - column.classList.toggle("is-open", Boolean(want) || column.classList.contains("was-opened")); - } -} -boardSelect?.addEventListener("change", showItem); -document.querySelector("[data-board]")?.addEventListener("click", (e) => { - const button = e.target.closest("[data-more-button]"); - if (!button) return; - button.closest(".hub-column").classList.add("is-open", "was-opened"); - button.remove(); -}); - -// --- Live state from GitHub ------------------------------------------------------------------------------------ - -// The open issues and pull requests, and those closed or merged lately: four requests at most, kept ten minutes. -async function loadLive() { - const list = []; - for (let page = 1; page <= 3; page++) { - const batch = await get(`https://api.github.com/repos/${REPO}/issues?state=open&per_page=100&page=${page}`); - list.push(...batch.map(slimIssue)); - if (batch.length < 100) break; - } - const closed = await get(`https://api.github.com/repos/${REPO}/issues?state=closed&sort=updated&direction=desc&per_page=100`); - return list.concat(closed.map(slimIssue)); -} -const loadReleases = () => get(`https://api.github.com/repos/${REPO}/releases?per_page=40`); - -async function refresh() { - const fresh = await cached("horizon:hub-live", loadLive).catch(() => null); - if (!fresh) return; - // What the build knew about older links stays; GitHub's answer wins for the rest. - const live = new Map([...data.live, ...fresh].map((i) => [i.n, i])); - document.querySelector("[data-overview]").innerHTML = overviewHtml(data.roadmap, live); - document.querySelector("[data-roadmap]").innerHTML = roadmapHtml(data.roadmap, live); - filter(area); - showVotes(); - const board = boardFrom(fresh, data.roadmap); - const chosen = boardSelect.value; - boardSelect.innerHTML = boardFilterHtml(board, data.roadmap); - boardSelect.value = [...boardSelect.options].some((o) => o.value === chosen) ? chosen : ""; - document.querySelector("[data-board]").innerHTML = boardHtml(board, data.roadmap); - showItem(); - const releases = await cached("horizon:hub-releases", loadReleases).catch(() => null); - if (releases) document.querySelector("[data-journal]").innerHTML = journalHtml(journalFrom(releases, fresh, data.roadmap), data.roadmap); - const note = document.querySelector("[data-live-note]"); - if (note) note.textContent = "Pull request and issue states are live from GitHub."; -} - -// --- Votes, bug reports and suggestions: the hub's server (crates/horizon-telemetry-server) -------------------- - -const saved = (key, fallback) => { - try { - return JSON.parse(localStorage.getItem(key)) ?? fallback; - } catch { - return fallback; - } -}; -const save = (key, value) => { - try { - localStorage.setItem(key, JSON.stringify(value)); - } catch {} -}; -const post = (path, body) => fetch(`${data.api}${path}`, { method: "POST", headers: { "content-type": "application/json" }, body: JSON.stringify(body) }); - -// This browser's random id (one vote per item per browser) and the items it voted for. Nothing else identifies it. -function voter() { - let id = saved("hub:voter", ""); - if (typeof id !== "string" || id.length < 16) { - id = crypto.randomUUID ? crypto.randomUUID() : [...crypto.getRandomValues(new Uint8Array(16))].map((b) => b.toString(16).padStart(2, "0")).join(""); - save("hub:voter", id); - } - return id; -} -const mine = new Set(saved("hub:voted", [])); -let counts = null; // { item: votes } once the server answered; until then the buttons stay hidden - -function showVotes() { - if (!counts) return; - for (const button of document.querySelectorAll("[data-vote]")) { - const id = button.dataset.vote; - button.hidden = false; - button.setAttribute("aria-pressed", String(mine.has(id))); - button.querySelector(".hub-vote-label").textContent = mine.has(id) ? "Wanted" : "Want it"; - button.querySelector("[data-votes]").textContent = counts[id] ? String(counts[id]) : ""; - } -} - -async function vote(id) { - const up = !mine.has(id); - const apply = (on, step) => { - if (on) mine.add(id); - else mine.delete(id); - counts[id] = Math.max(0, (counts[id] || 0) + step); - save("hub:voted", [...mine]); - showVotes(); - }; - apply(up, up ? 1 : -1); - try { - const res = await post("/hub/vote", { item: id, voter: voter(), up }); - if (!res.ok) throw new Error(res.status); - counts[id] = (await res.json()).votes; - showVotes(); - } catch { - apply(!up, up ? -1 : 1); - } -} -document.addEventListener("click", (e) => { - const button = e.target.closest("[data-vote]"); - if (button && counts) vote(button.dataset.vote); -}); - -const LABELS = { title: "the title", did: "what you did", happened: "what happened", expected: "what you expected", version: "the version", system: "OS, CPU, GPU", text: "your idea", name: "your name" }; -// The server's answer in words: "did: 3 to 2000 characters" becomes "Check what you did: 3 to 2000 characters." -function trouble(code, answer) { - if (code === 429) return "Too many sent from your connection: try again in a few minutes."; - const said = typeof answer.error === "string" ? answer.error : ""; - const field = said.match(/^(\w+): (.+)$/); - if (code === 400 && field) return `Check ${LABELS[field[1]] || field[1]}: ${field[2]}.`; - return said ? `${said[0].toUpperCase()}${said.slice(1)}.` : "That didn't go through: try again in a moment."; -} - -function setUpForm(form, path, thanks) { - const status = form.querySelector("[data-status]"); - form.hidden = false; - form.parentElement.querySelector("[data-closed]").hidden = true; - form.addEventListener("submit", async (e) => { - e.preventDefault(); - if (!form.reportValidity()) return; - const button = form.querySelector('[type="submit"]'); - button.disabled = true; - status.textContent = "Sending…"; - try { - const res = await post(path, Object.fromEntries(new FormData(form))); - const answer = await res.json().catch(() => ({})); - if (res.ok) { - thanks(status, answer); - // A new report starts with the version filled in again; the name stays for the next one. - for (const field of form.querySelectorAll("textarea, input:not([name='version']):not([name='name'])")) field.value = ""; - } else status.textContent = trouble(res.status, answer); - } catch { - status.textContent = "Couldn't reach the server: try again, or use GitHub or Discord."; - } - button.disabled = false; - }); -} - -// The forms and the votes show once the server answers; without it the page points to GitHub and Discord. -async function connect() { - try { - // Revalidated: the server keeps the counts a minute, a browser's copy would miss this browser's own vote. - const res = await fetch(`${data.api}/hub/votes`, { cache: "no-cache" }); - if (!res.ok) return; - counts = (await res.json()).votes || {}; - } catch { - return; - } - showVotes(); - setUpForm(document.querySelector('[data-form="report"]'), "/hub/report", (status, answer) => { - const issue = typeof answer.issue === "string" && answer.issue.match(/^https:\/\/github\.com\/ludovic111\/horizon\/issues\/(\d+)$/); - status.innerHTML = issue ? `Thanks! It's issue #${issue[1]} on GitHub: follow it there.` : "Thanks! It will be on GitHub in a few minutes."; - }); - setUpForm(document.querySelector('[data-form="suggest"]'), "/hub/suggest", (status) => { - status.textContent = "Thanks! The maintainers read every suggestion."; - }); -} - -setUpTheme(); -setUpMenu(); -connect(); -follow(); -refresh().then(() => data.roadmap.items.some((i) => `#${i.id}` === location.hash) && follow()); diff --git a/website/src/hub.html b/website/src/hub.html deleted file mode 100644 index 167ffc15e..000000000 --- a/website/src/hub.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - Hub · Horizon - - - - - - - - - - - - - - - - - - - - - -{{SITE_NAV}} -
    -
    -

    HubNow, next and how to help

    -

    Where Horizon is going

    -

    What is being done, what comes next, what shipped and where you can help. No dates: things are Now, Next or Later. Read it in plain words, or switch to the technical picture.

    -
    -
    - - - - - - -
    -
    - - -
    -
    - -
    -{{HUB_OVERVIEW}} -
    - -
    -
    -{{HUB_AREAS}} -
    -
    -{{HUB_ROADMAP}} -
    -

    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

    -

    Each one is a small difference from vanilla, with an issue that says how to see it.

    -

    Each links its issue; the technical text says where in the code and in vanilla to start.

    -
      {{HUB_HELP_WANTED}}
    -
    -
    -

    Ways to help

    -
    -
    -

    Tell us what differs

    -

    Something that doesn't play like vanilla is a bug. Say what you did, what happened and what vanilla does, with your Horizon version and system.

    -

    Report a bugSuggest something

    -
    -
    -

    Take a task

    -

    Pick a good first task or an open issue. On Discord, /claim 1234 tells everyone you are on issue 1234, so nobody starts the same work; /unclaim frees it.

    -

    Open issues

    -
    -
    -

    Bring your AI agent

    -

    On Discord, /agent connect gives your coding agent a personal token for Kira's MCP server: it reads the work board, claims tasks and posts its progress in your name.

    -

    Join the Discord

    -
    -
    -

    Benchmark your computer

    -

    Run the built-in benchmark and share the report: every new machine makes the performance work more accurate. No coding needed.

    -

    How to

    -
    -
    -
    -
    -

    Report a bug

    -

    One bug per report: something that breaks, or doesn't play like vanilla. It becomes an issue on GitHub, public, and you get its link to follow it. Search the open bugs first.

    - -

    Report it on GitHub or in #horizon-bugs on Discord, where Kira turns your post into an issue.

    -
    -
    -

    Suggest something

    -

    An idea for Horizon, or about something on the roadmap. The maintainers read every one, and the good ones become roadmap items. Nothing you send here is published.

    - -

    Post it in #horizon-ideas on Discord, or send it to Kira with /suggest.

    -
    -
    -

    The rules

    -
      -
    1. Vanilla is the specification. Wherever Minecraft 26.3 has the feature, Horizon does exactly what it does: read vanilla's code, then match it.
    2. -
    3. Small pull requests, proven. One change each, under about 500 lines, with the block python3 tools/pr_ready.py prints: formatting, Clippy, tests and the harnesses your change can affect.
    4. -
    5. Say who wrote it. If an AI agent wrote or posts it, the pull request says so, and commits keep its co-author line.
    6. -
    7. Never commit Mojang's files. No game jars, assets, decompiled code or prepared resources, and nothing taken from other mods' code.
    8. -
    -

    The contributing guideCONTRIBUTING.md

    -
    -
    -

    Contributors

    -

    Everyone with commits in Horizon. On Discord, /link-github <your login> credit:True adds your Discord name next to yours.

    -
      {{HUB_CREDIT}}
    -

    All contributors on GitHub

    -
    -
    -

    Not an official Minecraft product. Not approved by or associated with Mojang or Microsoft.

    -
    -
    -{{SITE_FOOTER}} - - - diff --git a/website/src/hub.js b/website/src/hub.js deleted file mode 100644 index f11668d8c..000000000 --- a/website/src/hub.js +++ /dev/null @@ -1,457 +0,0 @@ -// The hub (/hub): the roadmap from website/data/roadmap.json (generated from roadmap/roadmap.toml by -// tools/roadmap.py), with each item's issues and pull requests in their live GitHub state. Shared by build.mjs -// (baked into the page) and hub-page.js (refreshed from GitHub in the browser). Every item says the same thing -// 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"; -import { avatar } from "./contributors.js"; - -export const REPO = "ludovic111/horizon"; -const issueUrl = (n) => `https://github.com/${REPO}/issues/${n}`; -const fileUrl = (path) => `https://github.com/${REPO}/blob/main/${path}`; - -// The issues a pull request closes when merged: "Fixes #12", "closes #3, resolves #4" (as Kira's board reads them). -export function fixesIn(text) { - const out = new Set(); - for (const m of String(text ?? "").matchAll(/\b(?:fix(?:e[sd])?|close[sd]?|resolve[sd]?)\s*:?\s+((?:#\d+(?:\s*(?:,|and)\s*)?)+)/gi)) { - for (const n of m[1].matchAll(/#(\d+)/g)) out.add(Number(n[1])); - } - return [...out].sort((a, b) => a - b); -} - -// A GitHub issue or pull request (from /issues, which lists both) reduced to what the hub shows. -export function slimIssue(raw) { - const pr = Boolean(raw.pull_request); - const merged = pr && raw.pull_request.merged_at; - return { - n: raw.number, - title: String(raw.title || ""), - kind: pr ? "pr" : "issue", - state: merged ? "merged" : raw.state === "open" ? "open" : raw.state_reason === "not_planned" ? "dropped" : "closed", - draft: Boolean(raw.draft), - user: raw.user?.login || "", - labels: (raw.labels || []).map((l) => (typeof l === "string" ? l : l.name)).filter(Boolean), - assigned: (raw.assignees || []).length > 0, - fixes: pr ? fixesIn(raw.body) : [], - at: merged || raw.closed_at || raw.updated_at || "", - url: raw.html_url || issueUrl(raw.number), - }; -} - -const number = (link) => Number((String(link).match(/^#(\d+)$/) || [])[1]) || null; - -// "#12 in review", "#13 merged": a link's state, when GitHub told us. -function linkState(issue) { - if (!issue) return null; - if (issue.kind === "pr") return issue.state === "open" ? (issue.draft ? "in progress" : "in review") : issue.state; - return issue.state === "open" ? "open" : "closed"; -} - -function linkHtml(link, live) { - const n = number(link); - if (!n) { - const url = link.startsWith("https://") ? link : fileUrl(link); - return `${escape(link.replace(/^https:\/\//, ""))}`; - } - const issue = live.get(n); - const state = linkState(issue); - const label = issue ? `${issue.kind === "pr" ? "Pull request" : "Issue"} #${n}: ${issue.title}` : `#${n}`; - return `#${n}${state ? ` ${state}` : ""}`; -} - -// The technical text with its #N and the item's own paths as links. -function devHtml(item) { - let text = item.dev.replace(/(^|[^\w[/`])#(\d+)\b/g, (_, before, n) => `${before}[#${n}](${issueUrl(n)})`); - for (const link of item.links || []) { - if (!number(link) && !link.startsWith("https://")) text = text.replace(link, `[${link}](${fileUrl(link)})`); - } - return inline(text); -} - -// "2 pull requests in review · 3 merged · 1 issue open", from the item's links. -export function progress(item, live) { - const known = (item.links || []).map(number).filter(Boolean).map((n) => live.get(n)).filter(Boolean); - const pulls = known.filter((i) => i.kind === "pr"); - const count = (list, word) => (list.length ? `${list.length} ${word}` : ""); - const parts = [ - count(pulls.filter((p) => p.state === "open" && !p.draft), pulls.filter((p) => p.state === "open" && !p.draft).length === 1 ? "pull request in review" : "pull requests in review"), - count(pulls.filter((p) => p.state === "open" && p.draft), "in progress"), - count(pulls.filter((p) => p.state === "merged"), "merged"), - count(known.filter((i) => i.kind === "issue" && i.state === "open"), known.filter((i) => i.kind === "issue" && i.state === "open").length === 1 ? "issue open" : "issues open"), - ].filter(Boolean); - return parts.join(" · "); -} - -const areaName = (roadmap, id) => roadmap.areas.find((a) => a.id === id)?.name || id; - -// An item's vote button: hidden until the page has the counts from the hub's server (hub-page.js). -export function voteHtml(item) { - return ``; -} - -export function itemHtml(item, roadmap, live) { - const done = item.status === "shipped"; - const state = done ? "" : progress(item, live); - return `
    -

    ${escape(areaName(roadmap, item.area))}${done ? `${escape(item.shipped_in)}` : ""}${item.ongoing ? `Ongoing` : ""}${done ? "" : voteHtml(item)}

    -

    ${escape(item.title)}

    -

    ${inline(item.plain)}

    -

    ${devHtml(item)}

    - ${state ? `

    ${escape(state)}

    ` : ""} - -
    `; -} - -const SECTION_LEDE = { - now: "Being worked on, with pull requests open or just merged.", - next: "Decided, and up after what is being done now.", - later: "Decided, further out.", - "help-wanted": "Good first contributions: a clear vanilla behaviour, an issue with the steps, a place to start.", - shipped: "Out in a release. The journal has every change.", -}; - -// The Roadmap tab: one section per status, the items in the file's order (areas by priority). -export function roadmapHtml(roadmap, live = new Map()) { - const order = new Map(roadmap.areas.map((a, i) => [a.id, i])); - return roadmap.statuses - .map(({ id, name }) => { - const items = roadmap.items.filter((i) => i.status === id); - if (!items.length) return ""; - // Shipped stays newest first; the others go by the areas' priority. - if (id !== "shipped") items.sort((a, b) => order.get(a.area) - order.get(b.area)); - return `
    -

    ${escape(name)}

    ${escape(SECTION_LEDE[id] || "")}

    -
    -${items.map((item) => itemHtml(item, roadmap, live)).join("\n")} -
    -
    `; - }) - .join("\n"); -} - -// The area filter's buttons: every area that has an item. -export function areaFilterHtml(roadmap) { - const used = roadmap.areas.filter((a) => roadmap.items.some((i) => i.area === a.id)); - return [``] - .concat(used.map((a) => ``)) - .join("\n"); -} - -// The Overview tab: where Horizon is, the 3 to 5 things in focus, what is next, what shipped last, how to help. -export function overviewHtml(roadmap, live = new Map()) { - const o = roadmap.overview; - const focus = roadmap.items.filter((i) => i.focus); - const next = roadmap.items.filter((i) => i.status === "next"); - const shipped = roadmap.items.filter((i) => i.status === "shipped").slice(0, 3); - const row = (item, i, meta) => `
  • ${String(i + 1).padStart(2, "0")}${escape(item.title)}${inline(item.plain)}${inline(item.dev)}${escape(meta(item))}
  • `; - return `
    -

    ${inline(o.today_plain)}

    -

    ${inline(o.today_dev)}

    -
    -
    -

    Being done now

    -
      ${focus.map((item, i) => row(item, i, (x) => progress(x, live))).join("")}
    -
    -
    -

    Next

    -
      ${next.map((item, i) => row(item, i, (x) => areaName(roadmap, x.area))).join("")}
    -
    -
    -

    Recently shipped

    -
      ${shipped.map((item, i) => row(item, i, (x) => `In ${x.shipped_in}`)).join("")}
    -
    -
    -

    How to help

    -

    ${inline(o.help_plain)}

    -

    ${inline(o.help_dev)}

    -

    ContributeHelp wantedReport a bugSuggest something

    -
    `; -} - -// The Contribute tab's list of good first tasks. -export function helpWantedHtml(roadmap) { - return roadmap.items - .filter((i) => i.status === "help-wanted") - .map((item, i) => { - const first = (item.links || []).map(number).find(Boolean); - const href = first ? issueUrl(first) : `#${item.id}`; - return `
  • ${String(i + 1).padStart(2, "0")}${escape(item.title)}${inline(item.plain)}${inline(item.dev)}${first ? `#${first}` : ""}
  • `; - }) - .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); -} - -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" }; - -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"); -} - -// --- Contribute: the suggestion form's items and the contributors ------------------------------------------------ - -// The suggestion form's "About" choices: the items still to come. -export function suggestItemsHtml(roadmap) { - const open = roadmap.items.filter((i) => i.status !== "shipped"); - return [``] - .concat(open.map((i) => ``)) - .join(""); -} - -// The contributors, from GitHub (contributors.js's list), with the Discord name of those who linked their accounts -// on Kira and agreed to be credited (Kira's /contributors.json: { contributors: [{ github, discord }] }). -export function creditFrom(github, kira) { - const discord = new Map( - (Array.isArray(kira?.contributors) ? kira.contributors : []) - .filter((c) => c && typeof c.github === "string" && typeof c.discord === "string") - .map((c) => [c.github.toLowerCase(), c.discord]), - ); - return github.map((c) => ({ ...c, discord: discord.get(c.login.toLowerCase()) || "" })); -} - -export function creditHtml(list) { - return list - .map((c) => { - const src = avatar(c.avatar_url); - const count = `${c.contributions.toLocaleString("en-US")} ${c.contributions === 1 ? "commit" : "commits"}`; - return `
  • ${src ? `` : ``}${escape(c.login)}${count}${c.discord ? ` · ${escape(c.discord)} on Discord` : ""}
  • `; - }) - .join(""); -} diff --git a/website/src/hub.test.mjs b/website/src/hub.test.mjs deleted file mode 100644 index 4213d8a87..000000000 --- a/website/src/hub.test.mjs +++ /dev/null @@ -1,159 +0,0 @@ -import { test } from "node:test"; -import assert from "node:assert/strict"; -import { readFileSync } from "node:fs"; -import { boardFrom, boardHtml, creditFrom, creditHtml, fixesIn, itemOf, journalFrom, journalHtml, journalJson, overviewHtml, progress, roadmapHtml, slimIssue, suggestItemsHtml } from "./hub.js"; - -const roadmap = JSON.parse(readFileSync(new URL("../data/roadmap.json", import.meta.url), "utf8")); - -const pr = (number, extra = {}) => ({ number, title: `PR ${number}`, state: "open", pull_request: { merged_at: null }, user: { login: "a" }, labels: [], assignees: [], body: "", ...extra }); -const issue = (number, extra = {}) => ({ number, title: `Issue ${number}`, state: "open", user: { login: "b" }, labels: [{ name: "bug" }], assignees: [], ...extra }); - -test("pull requests and issues reduce to their hub state", () => { - assert.deepEqual(fixesIn("Fixes #12, #13 and closes #4. Mentions #9."), [4, 12, 13]); - const merged = slimIssue(pr(5, { state: "closed", pull_request: { merged_at: "2030-01-01T00:00:00Z" }, body: "Fixes #3" })); - assert.equal(merged.kind, "pr"); - assert.equal(merged.state, "merged"); - assert.deepEqual(merged.fixes, [3]); - assert.equal(slimIssue(issue(6, { state: "closed", state_reason: "not_planned" })).state, "dropped"); - assert.deepEqual(slimIssue(issue(7)).labels, ["bug"]); -}); - -test("an item's progress counts its pull requests and issues", () => { - const live = new Map([ - [1, slimIssue(pr(1))], - [2, slimIssue(pr(2, { draft: true }))], - [3, slimIssue(pr(3, { state: "closed", pull_request: { merged_at: "2030-01-01T00:00:00Z" } }))], - [4, slimIssue(issue(4))], - ]); - const item = { links: ["#1", "#2", "#3", "#4", "#99", "docs/x.md"] }; - assert.equal(progress(item, live), "1 pull request in review · 1 in progress · 1 merged · 1 issue open"); - assert.equal(progress(item, new Map()), ""); -}); - -test("the roadmap renders every item once, with both texts, in its status's section", () => { - const html = roadmapHtml(roadmap); - for (const item of roadmap.items) { - assert.equal(html.split(`id="${item.id}"`).length, 2, item.id); - } - assert.ok(html.indexOf('id="now"') < html.indexOf('id="next"')); - assert.ok(html.includes('class="hub-plain"') && html.includes('class="hub-dev"')); - // Shipped items say which release had them. - assert.ok(html.includes(`>${roadmap.items.find((i) => i.status === "shipped").shipped_in}<`)); -}); - -test("an item is its own anchor (hub#, as Kira links it) and takes no other id of the page", () => { - 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); -}); - -test("the overview lists the focus items and never nests links", () => { - const html = overviewHtml(roadmap); - 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 html = journalHtml(entries, roadmap); - 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); - } -}); - -test("items still to come take votes and suggestions; shipped ones don't", () => { - const html = roadmapHtml(roadmap); - for (const item of roadmap.items) { - assert.equal(html.includes(`data-vote="${item.id}"`), item.status !== "shipped", item.id); - assert.equal(suggestItemsHtml(roadmap).includes(`value="${item.id}"`), item.status !== "shipped", item.id); - } - // Hidden until the hub's server answers. - assert.ok(html.includes('aria-pressed="false" hidden>')); -}); - -test("the contributors carry the Discord name of those who agreed on Kira", () => { - const github = [{ login: "Alex", html_url: "https://github.com/Alex", avatar_url: "", contributions: 3 }, { login: "sam", html_url: "https://github.com/sam", avatar_url: "", contributions: 1 }]; - const kira = { contributors: [{ github: "alex", discord: "Alex " }, { github: 5 }, null] }; - const credit = creditFrom(github, kira); - assert.deepEqual(credit.map((c) => c.discord), ["Alex ", ""]); - const html = creditHtml(credit); - assert.ok(html.includes("3 commits · Alex <b> on Discord") && html.includes("1 commit")); - assert.deepEqual(creditFrom(github, "not json").map((c) => c.discord), ["", ""]); -}); diff --git a/website/src/index.html b/website/src/index.html deleted file mode 100644 index 3776733c6..000000000 --- a/website/src/index.html +++ /dev/null @@ -1,216 +0,0 @@ - - - - - - Horizon: a Rust rewrite for Minecraft: Java Edition 26.3 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -{{SITE_NAV}} - -
    -
    -
    -

    Minecraft: Java Edition 26.3Rust

    -

    Horizon: The game you know, rebuilt in Rust.

    -

    The Minecraft: Java Edition 26.3 client and its game logic, rewritten in Rust and checked against the vanilla game by {{HARNESSES}} differential harnesses.

    - -

    For Linux x86-64, macOS on Apple Silicon and Windows x64.

    -
    -
    -
    -
      -
    1. 01Matches vanilla{{PERCENT}}
    2. -
    3. 02Differential harnesses{{HARNESSES}}
    4. -
    5. 03Drawn by Horizon5 shots
    6. -
    7. 04Recently addedReleases
    8. - -
    -

    Unofficial. Not an official Minecraft product. Not approved by or associated with Mojang or Microsoft.

    -
    - -
    -
    -

    01What it is

    -

    Horizon rebuilds Minecraft: Java Edition 26.3 in Rust, one subsystem at a time, and holds every piece to the same inputs as the vanilla game until the outputs are identical.

    -
    -
    - -

    Your own copy

    -

    Install Java Edition with the official launcher and play 26.3 once. Horizon builds its resources from those files on your machine, and never downloads or shares game files.

    -
    -
    - -

    Native on three platforms

    -

    Linux, macOS on Apple Silicon and Windows. Worlds come from a Rust port of the vanilla generators, drawn with vanilla's block models, lighting, sky and fog.

    -
    -
    - -

    Open source

    -

    Horizon's code is MIT. It contains no Minecraft code, assets or data; those belong to Mojang and Microsoft under the Minecraft EULA.

    -
    -
    -
    -
    - -
    -
    -
    -

    02In game

    -

    Drawn by Horizon

    -

    Captured in the Rust client itself, with vanilla assets from the player's own copy and no mods or shaders.

    -
    -
    -
    01A plains village
    -
    02Moonrise
    -
    03A crimson forest in the Nether
    -
    04A coral reef
    -
    05Survival at dusk
    -
    -
    -
    - -
    -
    -

    03Parity

    -
    -
    - -

    {{HARNESSES}} differential harnesses drive the same inputs through Horizon and through the vanilla client and server, and compare what comes out.

    -
    -
    -

    {{PARITY_HEADLINE}}

    -
    {{PARITY_INTRO}}
    -

    Last audited {{AUDITED}}{{PERCENT}} of what the harnesses comparefrom the README on main

    -
    -
    -
      - {{PARITY_CELLS}} -
    -

    Each subsystem scores 0 (absent), 0.25 (started), 0.5 (playable, major features missing), 0.75 (mostly complete) or 1 (complete and verified against vanilla by differential tests).

    -
    -
    - -
    -
    -
    -

    04The launcher

    -

    One small app, then play

    -

    The launcher installs Horizon, prepares it from your copy of the game and keeps both up to date.

    -
      -
    • One-click install

      Pick a release and it installs the build for your platform into its own folder, then prepares the resources from your Java Edition 26.3 install.

    • -
    • Updates on its own

      It looks for a new Horizon release when it starts and every four hours, and updates itself from the launcher's own releases.

    • -
    • Client or server

      Start the client, or host a server from the Servers page: create it, start it, watch players and the console, change its settings and keep backups.

    • -
    • Logs and crash reports

      The Settings page shows where the game's logs and crash reports are, and horizon-launcher logs prints them.

    • -
    • Modpacks and packs

      The Modpacks page reads a Modrinth or CurseForge pack and carries over the mods Horizon can run. The Mods page installs resource packs and modpacks from Modrinth.

    • -
    -
    - Download the launcher -

    {{LAUNCHER_META}}

    -
    -
    - -
    -
    - - - -
    -
    -
    The launcher's Play page: the version, Client and Server, the version picker and Play, the prepared resources and the Minecraft folder as a numbered list
    -
    Vanilla's Video Settings screen with Horizon's own buttons at the top: Horizon Graphics and Advanced Graphics
    -
    -

    The launcher, and Horizon's graphics settings in the game: vanilla's menus, with Horizon's pages added the way mods add theirs.

    -
    -
    -
    - -
    -
    -
    -

    05Releases

    -

    Recently added

    -

    New versions come out many times a day, as changes land, and the launcher installs each one once it has passed its test. The newest, and what they added:

    -
    -
    - {{RECENT}} -
    -
    -
    - -
    -
    -

    06Community

    -

    Built in the open

    - -
    -

    Contributors

    -

    Everyone who has committed to Horizon on GitHub, with how many commits.

    -
      {{CONTRIBUTORS}}
    -
    -
    -
    -
    - -
    -
    - - - -
    - -
    - - -
    - - -
    - - - - diff --git a/website/src/main.js b/website/src/main.js deleted file mode 100644 index 72e8577a5..000000000 --- a/website/src/main.js +++ /dev/null @@ -1,265 +0,0 @@ -// The page's behaviour: the download buttons for this platform, the latest releases, the -// links and contributors, how many play now, the navigation, the menus' tabs, the lightbox -// and the motion. -// Everything degrades to the baked-in content when GitHub can't be reached. -import { escape } from "./markdown.js"; -import { recentHtml } from "./releases.js"; -import { contributorsFrom, contributorsHtml } from "./contributors.js"; -import { isGame, isLauncher as isLauncherTag, launcherVersion, newestFirst } from "./versions.js"; -import { cached, get, setUpMenu, setUpTheme, slim } from "./chrome.js"; - -const REPO = "ludovic111/horizon"; -const RELEASES_PAGE = `https://github.com/${REPO}/releases?q=launcher&expanded=true`; -const baked = JSON.parse(document.getElementById("baked").textContent); -const reducedMotion = matchMedia("(prefers-reduced-motion: reduce)").matches; - -// --- GitHub -------------------------------------------------------------------------- - -const isLauncher = (r) => isLauncherTag(r.tag_name) && !r.prerelease; - -// The newest 100 releases (GitHub's most per page). The newest game release that is not a pre-release (the old -// Alpha channel's, docs/release-flow.md) and the newest launcher release can be older than all of them. The game -// release is then GitHub's "latest" (pre-releases and launcher releases never are); the launcher release is looked up by its -// tag (the newest launcher@ tag with a published release, or launcher-v before 0.2: docs/versioning.md). -async function loadReleases() { - const list = (await get(`https://api.github.com/repos/${REPO}/releases?per_page=100`)).filter((r) => !r.draft).map(slim); - if (!list.some((r) => isGame(r.tag_name) && !r.prerelease)) { - const latest = await get(`https://api.github.com/repos/${REPO}/releases/latest`).catch(() => null); - if (latest && !latest.draft) list.push(slim(latest)); - } - if (list.some(isLauncher)) return list; - let tags = []; - for (const prefix of ["launcher@", "launcher-v"]) { - if (tags.length) break; - const refs = await get(`https://api.github.com/repos/${REPO}/git/matching-refs/tags/${prefix}`).catch(() => []); - tags = refs.map((r) => r.ref.replace("refs/tags/", "")).filter(isLauncherTag).sort(newestFirst); - } - for (const tag of tags.slice(0, 3)) { - const release = await get(`https://api.github.com/repos/${REPO}/releases/tags/${tag}`).catch(() => null); - if (release && !release.draft) return [...list, slim(release)]; - } - return list; -} - -const releases = cached("horizon:releases", loadReleases).catch(() => baked.releases); - -async function setUpContributors() { - let list = baked.contributors || []; - try { - list = contributorsFrom(await cached("horizon:contributors", () => get(`https://api.github.com/repos/${REPO}/contributors?per_page=100`))); - } catch {} - if (list.length) document.getElementById("contributors-list").innerHTML = contributorsHtml(list); - // With nobody to show, the block and its menu entries go, as an empty link's card does. - document.querySelectorAll("[data-contributors]").forEach((el) => (el.hidden = !list.length)); -} - -// --- Download ------------------------------------------------------------------------ - -function platform() { - const ua = navigator.userAgent; - const hint = (navigator.userAgentData && navigator.userAgentData.platform) || navigator.platform || ""; - if (/iPhone|iPad|iPod|Android/i.test(ua) || (navigator.maxTouchPoints > 1 && /Mac/.test(hint))) return null; - if (/Win/i.test(hint) || /Windows/.test(ua)) return { key: "windows-x64", label: "Windows x64" }; - if (/Mac/i.test(hint) || /Mac OS X/.test(ua)) return { key: "macos-arm64", label: "macOS on Apple Silicon" }; - if (/Linux|X11/i.test(hint) || /Linux/.test(ua)) return { key: "linux-x86_64", label: "Linux x86-64" }; - return null; -} - -async function setUpDownload() { - const os = platform(); - const list = await releases; - const launcher = list.filter(isLauncher).sort((a, b) => newestFirst(a.tag_name, b.tag_name))[0]; - if (!launcher) return; - const version = launcherVersion(launcher.tag_name); - const asset = os && launcher.assets.find((a) => a.name.includes(os.key)); - const others = `Other platforms`; - document.querySelectorAll("[data-download]").forEach((a) => (a.href = asset ? asset.browser_download_url : launcher.html_url || RELEASES_PAGE)); - const mb = asset && asset.size ? ` · ${(asset.size / 1e6).toFixed(0)} MB` : ""; - const meta = asset - ? `For ${escape(os.label)} · launcher ${escape(version)}${mb} · ${others}` - : `Launcher ${escape(version)} for Linux x86-64, macOS on Apple Silicon and Windows x64. It runs on a computer, not on phones or tablets.`; - document.querySelectorAll("[data-download-meta]").forEach((p) => (p.innerHTML = meta)); -} - -// --- Recently added and the links from main --------------------------------- - -// "Recently added": the newest game releases. -async function setUpRecent() { - const html = recentHtml((await releases).filter((r) => isGame(r.tag_name))); - if (html) document.getElementById("recent-releases").innerHTML = html; -} - -async function setUpLinks() { - let links = baked.links; - try { - const remote = await cached("horizon:links", () => get(`https://raw.githubusercontent.com/${REPO}/main/launcher/links.json`, "text").then(JSON.parse)); - links = { ...links }; - for (const key of Object.keys(links)) if (typeof remote[key] === "string") links[key] = remote[key].trim(); - } catch {} - document.querySelectorAll("[data-link]").forEach((a) => { - const url = links[a.dataset.link]; - // An empty address hides its card, as the launcher hides its button. - if (!url) a.hidden = true; - else if (/^https:\/\//.test(url)) a.href = url; - }); -} - -// --- Playing now --------------------------------------------------------------------- - -const TELEMETRY = "https://telemetry.playhorizon.dev"; - -// How many play right now, from the games' anonymous "I'm playing" pings (Privacy explains them). The -// server rounds it and makes it again at most every 15 seconds; the row stays hidden while nobody plays -// or the server doesn't answer. -async function setUpLive() { - const row = document.querySelector("[data-live]"); - if (!row) return; - const update = async () => { - try { - const res = await fetch(`${TELEMETRY}/v1/live`, { signal: AbortSignal.timeout(3000) }); - if (!res.ok) throw new Error(String(res.status)); - const { playing } = await res.json(); - if (!Number.isInteger(playing) || playing < 1) throw new Error("nobody"); - row.querySelector("[data-live-count]").textContent = playing.toLocaleString("en"); - row.hidden = false; - // It shows up after the others came in, so it skips their entrance. - row.classList.add("is-visible"); - } catch { - row.hidden = true; - } - }; - await update(); - setInterval(() => document.visibilityState === "visible" && update(), 60_000); -} - -// --- Navigation ---------------------------------------------------------------------- - -function setUpNav() { - // The home sections use the same root-relative links in every page's header. - const links = [...document.querySelectorAll('.nav-links a[href^="/#"]')]; - const sections = links.map((a) => document.querySelector(a.hash)); - - let current = null; - const update = () => { - const line = innerHeight * 0.4; - let index = -1; - sections.forEach((s, i) => { - if (s.getClientRects().length && s.getBoundingClientRect().top <= line) index = i; - }); - if (index !== current) { - current = index; - links.forEach((a, i) => (i === index ? a.setAttribute("aria-current", "true") : a.removeAttribute("aria-current"))); - } - }; - onScroll(update); - update(); -} - -// One rAF-throttled scroll listener for everything that follows the scroll. -const scrollers = []; -function onScroll(fn) { - scrollers.push(fn); -} -let queued = false; -const run = () => ((queued = false), scrollers.forEach((fn) => fn())); -addEventListener("scroll", () => !queued && ((queued = true), requestAnimationFrame(run)), { passive: true }); -addEventListener("resize", () => requestAnimationFrame(run)); - -// --- The menus' tabs ------------------------------------------------------------------ - -function setUpTabs() { - const list = document.querySelector(".tabs"); - const tabs = [...list.querySelectorAll('[role="tab"]')]; - const pill = list.querySelector(".tab-pill"); - const selected = () => tabs.find((t) => t.getAttribute("aria-selected") === "true"); - const place = (tab) => { - pill.style.width = `${tab.offsetWidth}px`; - pill.style.height = `${tab.offsetHeight}px`; - pill.style.transform = `translate(${tab.offsetLeft}px, ${tab.offsetTop}px)`; - }; - const choose = (tab, focus) => { - tabs.forEach((t) => { - const on = t === tab; - t.setAttribute("aria-selected", String(on)); - t.tabIndex = on ? 0 : -1; - const panel = document.getElementById(t.getAttribute("aria-controls")); - panel.classList.toggle("is-active", on); - panel.inert = !on; - panel.setAttribute("aria-hidden", String(!on)); - }); - place(tab); - if (focus) tab.focus(); - }; - tabs.forEach((tab, i) => { - tab.addEventListener("click", () => choose(tab)); - tab.addEventListener("keydown", (e) => { - const step = { ArrowRight: 1, ArrowLeft: -1 }[e.key]; - if (step) choose(tabs[(i + step + tabs.length) % tabs.length], true); - if (e.key === "Home") choose(tabs[0], true); - if (e.key === "End") choose(tabs[tabs.length - 1], true); - }); - }); - choose(selected()); - addEventListener("resize", () => place(selected())); - document.fonts?.ready.then(() => place(selected())); -} - -function setUpLightbox() { - const dialog = document.querySelector(".lightbox"); - const big = dialog.querySelector("img"); - const caption = dialog.querySelector(".lightbox-caption"); - document.querySelectorAll(".zoom").forEach((button) => { - button.addEventListener("click", () => { - const img = button.querySelector("img"); - big.src = img.currentSrc.replace("-800.webp", ".webp"); - big.alt = img.alt; - caption.textContent = img.alt; - dialog.showModal(); - }); - }); - dialog.addEventListener("click", (e) => { - if (e.target === dialog) dialog.close(); - }); -} - -// --- Motion --------------------------------------------------------------------------- - -function setUpReveal() { - // Siblings that enter together come in one after another. - const stagger = (els, step) => els.forEach((el, i) => el.style.setProperty("--d", `${i * step}ms`)); - document.querySelectorAll(".facts, .features, .cards, .mosaic, .hero-index").forEach((group) => stagger([...group.children], 40)); - document.querySelectorAll(".hero .container, .section-head, .parity-count, .parity-copy, .launcher-copy").forEach((group) => stagger([...group.querySelectorAll(":scope > .reveal")], 60)); - stagger([...document.querySelectorAll(".system")], 40); - - const count = document.querySelector("[data-digits]"); - count.innerHTML = [...count.textContent].map((c) => `${escape(c)}`).join(""); - - const items = document.querySelectorAll(".reveal, .reveal-media, .systems"); - if (reducedMotion || !("IntersectionObserver" in window)) { - items.forEach((el) => el.classList.add("is-visible")); - return; - } - const observer = new IntersectionObserver( - (entries) => - entries.forEach((e) => { - if (e.isIntersecting) { - e.target.classList.add("is-visible"); - observer.unobserve(e.target); - } - }), - { rootMargin: "0px 0px -10% 0px" }, - ); - items.forEach((el) => observer.observe(el)); -} - -setUpReveal(); -setUpTheme(); -setUpNav(); -setUpMenu(); -setUpTabs(); -setUpLightbox(); -setUpDownload(); -setUpRecent(); -setUpLinks(); -setUpContributors(); -setUpLive(); diff --git a/website/src/markdown.js b/website/src/markdown.js deleted file mode 100644 index 1735f7304..000000000 --- a/website/src/markdown.js +++ /dev/null @@ -1,203 +0,0 @@ -// A small Markdown renderer for release notes, the README and the docs: headings, paragraphs, -// lists (nested by indentation), fenced code, quotes, rules, tables, and inline code, bold, -// italic and links. Everything is escaped first, so its output never carries raw HTML. -// Shared by build.mjs (Node) and main.js (browser). - -const REPO_BLOB = "https://github.com/ludovic111/horizon/blob/main/"; - -export function escape(text) { - return text.replace(/[&<>"']/g, (c) => ({ "&": "&", "<": "<", ">": ">", '"': """, "'": "'" })[c]); -} - -function href(url, site) { - url = url.trim(); - if (/^(https?:|mailto:)/i.test(url)) return url; - // The docs pages (`site`) link each other and their own headings; the README's anchors have no target here. - if (site && (/^\/(?!\/)/.test(url) || url.startsWith("#"))) return url; - if (url.startsWith("#")) return null; - if (/^[a-z]+:/i.test(url)) return null; // javascript: and the like - return REPO_BLOB + url.replace(/^\.?\//, ""); -} - -export function inline(text, site = false) { - const codes = []; - let out = text.replace(/`([^`]+)`/g, (_, code) => { - codes.push(code); - return `\u0000${codes.length - 1}\u0000`; - }); - const links = []; - out = out.replace(/\[([^\]]+)\]\(([^)\s]+)\)/g, (_, label, url) => { - links.push([label, url]); - return `\u0001${links.length - 1}\u0001`; - }); - out = escape(out) - .replace(/\*\*([^*]+)\*\*/g, "$1") - .replace(/(^|[^\w*])\*([^*\s][^*]*)\*/g, "$1$2") - .replace(/(^|[^\w])_([^_\s][^_]*)_(?!\w)/g, "$1$2") - .replace(/<(https?:\/\/[^\s&]+)>/g, (_, u) => `${u}`); - out = out.replace(/\u0001(\d+)\u0001/g, (_, i) => { - const [label, url] = links[i]; - const target = href(url, site); - // The label's code spans are already placeholders: put them back for its own pass. - const body = inline(label.replace(/\u0000(\d+)\u0000/g, (_, c) => `\`${codes[c]}\``), site); - return target ? `${body}` : body; - }); - return out.replace(/\u0000(\d+)\u0000/g, (_, i) => `${escape(codes[i])}`); -} - -// A table: a row of cells, a rule row (`| --- | :-: |`), then body rows, until a line that isn't a row. -const ROW = /^\s*\|.*\|\s*$/; -const RULE = /^\s*\|(\s*:?-+:?\s*\|)+\s*$/; - -/** A row's cells: split on `|` outside code spans; `\|` is a literal bar. */ -function cells(row) { - const s = row.trim().slice(1, -1); - const out = [""]; - let code = false; - for (let i = 0; i < s.length; i++) { - if (s[i] === "\\" && s[i + 1] === "|") out[out.length - 1] += s[++i]; - else if (s[i] === "|" && !code) out.push(""); - else { - if (s[i] === "`") code = !code; - out[out.length - 1] += s[i]; - } - } - return out.map((c) => c.trim()); -} - -function table(lines, start, site) { - const row = (line, tag) => `${cells(line).map((c) => `<${tag}>${inline(c, site)}`).join("")}`; - let i = start + 2; - const body = []; - while (i < lines.length && ROW.test(lines[i])) body.push(row(lines[i++], "td")); - return [`
    ${row(lines[start], "th")}${body.join("")}
    `, i]; -} - -const indentOf = (line) => line.match(/^ */)[0].length; -const ITEM = /^(\s*)([-*+]|\d+[.)])\s+(.*)$/; - -function list(lines, start, site) { - // Collects the items at this list's indentation; deeper lines belong to the item above. - const base = indentOf(lines[start]); - const ordered = /\d/.test(lines[start].match(ITEM)[2]); - const items = []; - let i = start; - while (i < lines.length) { - const line = lines[i]; - if (!line.trim()) { - const next = lines.slice(i + 1).find((l) => l.trim()); - if (next && ITEM.test(next) && indentOf(next) >= base) { - i++; - continue; - } - break; - } - const m = line.match(ITEM); - if (m && indentOf(line) === base) { - items.push({ text: [m[3]], children: [] }); - } else if (m && indentOf(line) > base) { - const [html, end] = list(lines, i, site); - items[items.length - 1].children.push(html); - i = end; - continue; - } else if (indentOf(line) > base && items.length) { - items[items.length - 1].text.push(line.trim()); - } else { - break; - } - i++; - } - const tag = ordered ? "ol" : "ul"; - const body = items.map((it) => `
  • ${inline(it.text.join(" "), site)}${it.children.join("")}
  • `).join(""); - return [`<${tag}>${body}`, i]; -} - -const slug = (text) => - text - .toLowerCase() - .replace(/`/g, "") - .replace(/[^a-z0-9]+/g, "-") - .replace(/^-|-$/g, ""); - -/** - * Renders Markdown; `shift` moves headings down (a `#` becomes `h{1 + shift}`). - * `site` is for the docs pages: links to the site's own pages and anchors stay as they are, `##` and `###` - * headings get an id (and are pushed onto `headings`, for a table of contents), and a line holding only - * `![caption](/media/…)` becomes a figure. - */ -export function markdown(source, { shift = 0, site = false, headings = null } = {}) { - const lines = source.replace(/\r\n?/g, "\n").split("\n"); - const out = []; - let i = 0; - while (i < lines.length) { - const line = lines[i]; - if (!line.trim() || /^\s*<\/?[a-z][^>]*>\s*$/i.test(line)) { - i++; // blank lines and lone HTML tags (the README's layout tables) are skipped - continue; - } - let m; - if ((m = line.match(/^(#{1,6})\s+(.*?)\s*#*$/))) { - const level = Math.min(6, m[1].length + shift); - let id = ""; - if (site && (m[1].length === 2 || m[1].length === 3)) { - const base = slug(m[2]); - id = base; - for (let n = 2; headings && headings.some((h) => h.id === id); n++) id = `${base}-${n}`; - headings?.push({ level: m[1].length, text: m[2].replace(/`/g, ""), id }); - } - out.push(`${inline(m[2], site)}`); - i++; - } else if (site && (m = line.match(/^!\[([^\]]*)\]\((\/media\/[\w./-]+)\)\s*$/))) { - out.push(`
    ${escape(m[1])}
    ${inline(m[1], true)}
    `); - i++; - } else if ((m = line.match(/^\s*(```|~~~)/))) { - const fence = m[1]; - const code = []; - i++; - while (i < lines.length && !lines[i].trim().startsWith(fence)) code.push(lines[i++]); - i++; - out.push(`
    ${escape(code.join("\n"))}
    `); - } else if (/^\s*([-*_])(\s*\1){2,}\s*$/.test(line)) { - out.push("
    "); - i++; - } else if (ROW.test(line) && RULE.test(lines[i + 1] || "")) { - const [html, end] = table(lines, i, site); - out.push(html); - i = end; - } else if (ITEM.test(line)) { - const [html, end] = list(lines, i, site); - out.push(html); - i = end; - } else if (line.startsWith(">")) { - const quote = []; - while (i < lines.length && lines[i].startsWith(">")) quote.push(lines[i++].replace(/^>\s?/, "")); - out.push(`
    ${markdown(quote.join("\n"), { shift, site })}
    `); - } else { - const para = []; - while ( - i < lines.length && - lines[i].trim() && - !/^(#{1,6}\s|>|\s*```|\s*~~~)/.test(lines[i]) && - !ITEM.test(lines[i]) - ) { - para.push(lines[i++].trim()); - } - out.push(`

    ${inline(para.join(" "), site)}

    `); - } - } - return out.join("\n"); -} - -/** The body of the section titled `title` (any heading level), up to the next heading at its level or above. */ -export function section(source, title) { - const lines = source.replace(/\r\n?/g, "\n").split("\n"); - const level = (l) => (l.match(/^(#{1,6})\s/) || [, ""])[1].length; - const start = lines.findIndex((l) => level(l) > 0 && l.replace(/^#+/, "").trim() === title); - if (start < 0) return null; - const depth = level(lines[start]); - const end = lines.findIndex((l, i) => i > start && level(l) > 0 && level(l) <= depth); - return lines - .slice(start + 1, end < 0 ? undefined : end) - .join("\n") - .trim(); -} diff --git a/website/src/markdown.test.mjs b/website/src/markdown.test.mjs deleted file mode 100644 index 171348e45..000000000 --- a/website/src/markdown.test.mjs +++ /dev/null @@ -1,25 +0,0 @@ -// node --test src/: the Markdown the docs pages and release notes are rendered from. -import { test } from "node:test"; -import assert from "node:assert/strict"; -import { markdown } from "./markdown.js"; - -test("a table renders with its header, cells and inline Markdown", () => { - const html = markdown("| Way in | Status |\n| --- | :-: |\n| Rust | `cargo horizon-mod` |\n| Lua | planned \\| soon |\n\nAfter."); - assert.equal( - html, - '
    ' + - "
    Way inStatus
    Rustcargo horizon-mod
    Luaplanned | soon
    \n

    After.

    ", - ); -}); - -test("a bar inside a code span stays in its cell", () => { - assert.match(markdown("| a | b |\n|---|---|\n| `x | y` | z |"), /x \| y<\/code><\/td>z<\/td>/); -}); - -test("rows without a rule line are a paragraph", () => { - assert.equal(markdown("| a | b |\n| c | d |"), "

    | a | b | | c | d |

    "); -}); - -test("a link whose label is code keeps it", () => { - assert.equal(markdown("See [`AGENTS.md`](/docs/agents).", { site: true }), '

    See AGENTS.md.

    '); -}); diff --git a/website/src/mods-page.js b/website/src/mods-page.js deleted file mode 100644 index 121ba8067..000000000 --- a/website/src/mods-page.js +++ /dev/null @@ -1,66 +0,0 @@ -// /mods and /mods/: the registry's list (kind filter, search) and a project's page. The pages are baked from -// the index at build time; this fetches the published index again so a project merged since shows at once. -import { INDEX_URL, KINDS, listHtml, matches, projectHtml, readIndex } from "./mods.js"; -import { cached, setUpMenu, setUpTheme } from "./chrome.js"; - -const root = document.getElementById("mods"); -const baked = readIndex(JSON.parse(document.getElementById("mods-index").textContent || "null")) || []; -let projects = baked; -let kind = "all"; -let text = ""; - -const id = (location.pathname.match(/^\/mods\/([a-z0-9_]+)\/?$/) || [])[1]; - -function showList() { - const list = root.querySelector("#mod-list"); - if (!list) return; - const shown = projects.filter((p) => matches(p, kind, text)); - list.innerHTML = listHtml(shown); - root.querySelector("[data-mod-count]").textContent = `${shown.length} of ${projects.length}`; - root.querySelectorAll("[data-kind-filter]").forEach((b) => b.setAttribute("aria-pressed", String(b.dataset.kindFilter === kind))); -} - -function showProject() { - const p = projects.find((x) => x.id === id); - const page = root.querySelector(".mod-page, .mod-missing"); - if (!page) return; - if (p) { - page.outerHTML = projectHtml(p); - document.title = `${p.name} · Horizon`; - } else { - page.outerHTML = `

    Not in the registry

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

    Every mod
    `; - } -} - -function render() { - if (id) showProject(); - else showList(); -} - -if (!id) { - root.querySelectorAll("[data-kind-filter]").forEach((b) => - b.addEventListener("click", () => { - kind = b.dataset.kindFilter; - showList(); - }), - ); - root.querySelector("#mod-search")?.addEventListener("input", (e) => { - text = e.target.value; - showList(); - }); - const wanted = new URLSearchParams(location.search).get("kind"); - if (KINDS.some(([k]) => k === wanted)) kind = wanted; -} - -setUpTheme(); -setUpMenu(); -render(); -cached("horizon:mod-index", () => fetch(INDEX_URL).then((r) => (r.ok ? r.json() : Promise.reject(new Error(`${r.status}`))))) - .then((index) => { - const fresh = readIndex(index); - if (fresh) { - projects = fresh; - render(); - } - }) - .catch(() => {}); diff --git a/website/src/mods-submit.js b/website/src/mods-submit.js deleted file mode 100644 index c1024495b..000000000 --- a/website/src/mods-submit.js +++ /dev/null @@ -1,80 +0,0 @@ -// /mods/submit: signs in with GitHub through the registry's service, then sends the page and the file. The service -// checks the file and answers with the pull request it opened, or with what to fix. -import { API, entryFrom } from "./mods.js"; -import { setUpMenu, setUpTheme } from "./chrome.js"; -import { escape } from "./markdown.js"; - -const auth = document.getElementById("submit-auth"); -const form = document.getElementById("submit-form"); -const result = document.getElementById("submit-result"); -let csrf = ""; -// The form's own controls by name (form.id and form.name are the form's attributes). -const control = (name) => form.elements.namedItem(name); - -function signedOut(message) { - auth.innerHTML = `

    ${message}

    Sign in with GitHub

    It only reads your public profile: your GitHub name goes on the pull request and in the project's owners.

    `; - form.hidden = true; -} - -async function start() { - let me; - try { - const r = await fetch(`${API}/me`, { credentials: "same-origin" }); - if (r.status === 401) return signedOut("Sign in to submit: reviewers and updates go through your GitHub account."); - if (!r.ok) throw new Error(String(r.status)); - me = await r.json(); - } catch { - auth.innerHTML = `

    The form isn't open right now. You can open a pull request by hand.

    `; - return; - } - csrf = me.csrf; - auth.innerHTML = `

    Signed in as ${escape(me.login)}.

    `; - document.getElementById("sign-out").addEventListener("click", async () => { - await fetch(`${API}/auth/logout`, { method: "POST", credentials: "same-origin" }); - signedOut("Signed out."); - }); - form.hidden = false; -} - -// A file named -. fills in the two fields and the kind. -form.querySelector("#f-file").addEventListener("change", (e) => { - const name = e.target.files[0]?.name || ""; - const m = name.match(/^([a-z0-9_]{1,64})-([A-Za-z0-9][A-Za-z0-9._-]*)\.(hmod|hpack|zip)$/); - const kind = { hmod: "mod", hpack: "modpack", zip: "resourcepack" }[name.split(".").pop()]; - if (kind) control("kind").value = kind; - if (m) { - if (!control("id").value) control("id").value = m[1]; - if (!control("version").value) control("version").value = m[2]; - } -}); - -form.addEventListener("submit", async (e) => { - e.preventDefault(); - const send = form.querySelector("#f-send"); - const values = Object.fromEntries(["id", "kind", "name", "summary", "description", "authors", "license", "source", "icon", "key", "version", "game", "changelog"].map((k) => [k, control(k).value])); - const sig = form.querySelector("#f-signature").files[0]; - values.signature = sig ? await sig.text() : ""; - const body = new FormData(); - body.append("entry", JSON.stringify(entryFrom(values))); - body.append("file", form.querySelector("#f-file").files[0]); - send.disabled = true; - result.innerHTML = `

    Checking the file and opening the pull request…

    `; - try { - const r = await fetch(`${API}/submit`, { method: "POST", body, credentials: "same-origin", headers: { "X-CSRF-Token": csrf } }); - const json = await r.json().catch(() => ({})); - if (r.ok && /^https:\/\/github\.com\//.test(json.pull_request || "")) { - result.innerHTML = `

    Submitted. Follow the review in its pull request: the checks' report is there, and reviewers answer there.

    `; - form.reset(); - } else { - result.innerHTML = `

    ${escape(json.error || `The service answered ${r.status}.`)}

    `; - } - } catch { - result.innerHTML = `

    The service didn't answer. Try again in a minute.

    `; - } finally { - send.disabled = false; - } -}); - -setUpTheme(); -setUpMenu(); -start(); diff --git a/website/src/mods.html b/website/src/mods.html deleted file mode 100644 index 0c0e5eea2..000000000 --- a/website/src/mods.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - {{MODS_TITLE}} · Horizon - - - - - - - - - - - - - - - - - - - - -{{SITE_NAV}} -
    -
    -{{MODS_MAIN}} -

    Not an official Minecraft product. Not approved by or associated with Mojang or Microsoft.

    -
    -
    -{{SITE_FOOTER}} - - - diff --git a/website/src/mods.js b/website/src/mods.js deleted file mode 100644 index 414db7396..000000000 --- a/website/src/mods.js +++ /dev/null @@ -1,189 +0,0 @@ -// Horizon's registry on the site (/mods): the list with its kind filter and search, and a page per project. -// Shared by build.mjs (baked into the pages) and mods-page.js (refreshed from the published index). -// The index's format is docs/api/mod-index.md in the repository. -import { markdown, escape } from "./markdown.js"; - -export const INDEX_URL = "https://ludovic111.github.io/horizon-mods/index.json"; -const REGISTRY = "https://github.com/ludovic111/horizon-mods"; -export const SUBMIT = "/mods/submit"; -// The submission form's service (crates/horizon-mod-registry), behind the site's own address. -export const API = "/api/mods"; -export const SCHEMA = 1; - -// The kinds the site shows, in the filter's order. Kinds a newer index adds are left out until the site knows them. -export const KINDS = [ - ["mod", "Mods"], - ["modpack", "Modpacks"], - ["resourcepack", "Resource packs"], - ["shader", "Shader packs"], -]; -const KIND_NAMES = { mod: "Mod", modpack: "Modpack", resourcepack: "Resource pack", shader: "Shader pack" }; - -// What a capability lets a mod do, as the game and the launcher say it (horizon_mods::Capability::describe). -export const CAPABILITIES = { - "game-read": "see your position, health and the time", - chat: "show you chat messages", - hud: "draw text on your screen", - storage: "save its own settings to disk", - registries: "add blocks and items to your worlds", -}; - -// The index's projects this site can show, or null when it isn't an index it reads. -export function readIndex(index) { - if (!index || typeof index !== "object" || index.schema > SCHEMA || !Array.isArray(index.projects)) return null; - const known = new Set(KINDS.map(([k]) => k)); - return index.projects.filter((p) => known.has(p.kind) && /^[a-z0-9_]{1,64}$/.test(p.id) && p.versions?.length); -} - -const https = (url) => (typeof url === "string" && url.startsWith("https://") ? url : ""); -const size = (bytes) => (bytes >= 1 << 20 ? `${(bytes / (1 << 20)).toFixed(1)} MB` : `${Math.max(1, Math.round(bytes / 1024))} KB`); -const trust = (p) => - p.key ? `Signed` : `Unsigned`; -const initial = (p) => escape((p.name || p.id).trim().charAt(0).toUpperCase()); -const icon = (p) => - https(p.icon) ? `` : ``; - -export function matches(p, kind, text) { - if (kind !== "all" && p.kind !== kind) return false; - const hay = `${p.id} ${p.name} ${p.summary} ${(p.authors || []).join(" ")}`.toLowerCase(); - return text.toLowerCase().split(/\s+/).filter(Boolean).every((w) => hay.includes(w)); -} - -// The list: a row per project, newest version and kind on the right. -export function listHtml(projects) { - if (!projects.length) return `

    Nothing here yet. Submit yours.

    `; - return projects - .map( - (p) => ` - ${icon(p)} - ${escape(p.name)}${escape(p.summary || "")} - ${escape(KIND_NAMES[p.kind] || p.kind)}${escape(p.versions[0].version)} · ${escape((p.authors || []).join(", "))} -`, - ) - .join("\n"); -} - -function installHtml(p, v) { - const file = escape(v.file.name); - const cli = `horizon-launcher mods install --source horizon ${p.id}`; - const where = { - mod: `put it in horizon-mods/ beside options.txt in the game folder, then turn it on in the game: Options > Mods`, - resourcepack: `put it in resourcepacks/ beside options.txt, then turn it on in Options > Resource Packs`, - modpack: `a modpack lists registry mods: install them one by one, or wait for the launcher to install modpacks`, - shader: `Horizon's own shader packs aren't installed yet`, - }[p.kind]; - return `
      -
    1. In the launcher: Mods, pick Horizon beside Modrinth, find ${escape(p.name)} and press Install. It checks the file's checksum${p.key ? " and signature" : ""} first.
    2. -
    3. From a terminal or an agent: ${escape(cli)}
    4. -
    5. By hand: download ${file} (${size(v.file.size)}), check its SHA-256 below, and ${where}.
    6. -
    `; -} - -// 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]; - const caps = v.capabilities || []; - const capsHtml = caps.length - ? `
      ${caps.map((c) => `
    • May ${escape(CAPABILITIES[c] || c)}
    • `).join("")}
    ` - : `

    It asks for nothing beyond writing its own log.

    `; - const requires = (v.requires || []).length - ? `

    Its mods

    ` - : ""; - const versions = p.versions - .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(", "))}

    ${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)}
    ` : ""} - ${p.kind === "mod" ? `

    What it may do

    ${capsHtml}

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

    ` : ""} - ${requires} -

    Install

    - ${installHtml(p, v)} -

    File

    -
    Name
    ${escape(v.file.name)}
    Size
    ${size(v.file.size)}
    SHA-256
    ${escape(v.file.sha256)}
    ${p.key ? `
    Signing key
    ${escape(p.key)}
    ` : ""}
    -

    Versions

    -
      ${versions}
    - -
    `; -} - -// /mods/submit: the form. Its script (mods-submit.js) signs in, then sends the page and the file to the service, which -// checks the file and opens the pull request the reviewers read. -const field = (name, label, input, hint = "") => - ``; -const text = (name, attrs = "") => ``; - -export function submitHtml() { - return `

    ModsSubmit

    -

    Submit to the registry

    -

    A mod, a modpack of registry mods, or a resource pack made for Horizon. The form checks the file and opens a pull request; a reviewer reads it, its source and the checks' report, and merging publishes it to this site and the launcher.

    -

    First time? Publish a mod walks through building, checking and signing the file, and Make a mod starts from the beginning.

    -
    -

    The form needs JavaScript. You can also open a pull request by hand.

    -
    - `; -} - -// The service's "entry" from the form's values (strings), as it reads it. -export function entryFrom(v) { - const optional = (x) => (x && x.trim() ? x.trim() : undefined); - return { - id: v.id.trim(), - kind: v.kind, - name: v.name.trim(), - summary: v.summary.trim(), - description: v.description || "", - authors: (v.authors || "").split(",").map((a) => a.trim()).filter(Boolean), - license: v.license.trim(), - source: v.source.trim(), - icon: optional(v.icon), - key: optional(v.key), - signature: optional(v.signature), - version: v.version.trim(), - game: v.game.trim(), - changelog: v.changelog || "", - }; -} diff --git a/website/src/mods.test.mjs b/website/src/mods.test.mjs deleted file mode 100644 index c5ff2e783..000000000 --- a/website/src/mods.test.mjs +++ /dev/null @@ -1,63 +0,0 @@ -import { test } from "node:test"; -import assert from "node:assert/strict"; -import { CAPABILITIES, entryFrom, listHtml, matches, projectHtml, readIndex, submitHtml } from "./mods.js"; - -const project = (over = {}) => ({ - id: "coords_hud", kind: "mod", name: "Coordinates HUD", summary: "Where you are.", authors: ["Horizon"], - license: "MIT", source: "https://example.org/src", - versions: [{ version: "0.1.0", api: "0.1", side: "client", capabilities: ["game-read", "hud"], game: "26.3", - file: { name: "coords_hud-0.1.0.hmod", url: "https://github.com/ludovic111/horizon-mods/releases/download/x/coords_hud-0.1.0.hmod", size: 438, sha256: "e".repeat(64) } }], - ...over, -}); - -test("reads schema 1, keeps the kinds it knows and refuses a newer schema", () => { - const index = { schema: 1, projects: [project(), project({ id: "map", kind: "world" }), project({ id: "Bad id" })] }; - assert.deepEqual(readIndex(index).map((p) => p.id), ["coords_hud"]); - assert.equal(readIndex({ schema: 2, projects: [project()] }), null); - assert.equal(readIndex(null), null); -}); - -test("filters by kind and every word", () => { - const p = project(); - assert.ok(matches(p, "all", "coordinates horizon")); - assert.ok(matches(p, "mod", "")); - assert.ok(!matches(p, "modpack", "")); - assert.ok(!matches(p, "all", "zoom")); -}); - -test("escapes what authors wrote and only links https addresses", () => { - const evil = project({ name: "", source: "javascript:alert(1)", summary: '">' }); - const html = listHtml([evil]) + projectHtml(evil); - assert.ok(!html.includes(" - - -
    -
    -

    PrivacyData collection

    -

    Nothing leaves without your yes.

    -

    The Horizon launcher can send a few things that help make the game faster and steadier. It asks first, each kind has its own switch, and every switch is off until you turn it on.

    -
    -

    What can be sent

    -

    Only the kinds you allow, from the launcher's first-run question or Settings → Data collection:

    -
      -
    • Performance statistics, after each play session of a minute or more. These are the frame-time and tick-time percentiles and a 14-bucket histogram (never a recording of each frame), the peak memory, how long the game took to start and to load the world, and the settings that change performance (render and simulation distance, frame limit, VSync, fullscreen, graphics mode).
    • -
    • Crash reports, when the game crashes. They hold the error, where it happened in Horizon's code, your graphics adapter and settings. They hold no log, no world, no server and no resource packs.
    • -
    • Bug reports that you write and send yourself. The end of the game's log goes with one only if you add it after reading it, and lines of chat are removed first.
    • -
    • Benchmark uploads of the benchmarks you run. They are shown publicly on the Benchmarks page, only as medians of groups of at least 3 different installs with the same graphics card, processor and render distance; never one by one, and never with your install ID, the day, your OS version, driver, exact memory or screen.
    • -
    -

    Each one also carries the Horizon version, the day it was made (not the time), and a description of your machine, because that is what explains how fast the game runs on it:

    -
      -
    • the operating system, its version and the processor architecture;
    • -
    • the processor model, its cores and threads, and its base and boost clock where the system gives them;
    • -
    • the memory, rounded to the gigabyte;
    • -
    • the graphics card the game draws with: its model, maker, whether it is built into the processor or separate, its own memory, its driver version and the graphics interface (Vulkan, Metal, DirectX 12);
    • -
    • the kind of drive the game folder is on (NVMe, SSD or hard disk);
    • -
    • the screen the game opened on: its size in pixels, refresh rate and scaling;
    • -
    • whether the computer is a laptop or a desktop, and whether it runs on battery.
    • -
    -

    No serial number, computer name, user name, network address or file path is read. Each item also carries a random install ID. The launcher makes that ID the first time you allow something; it says nothing about you and exists only so that your data can be deleted.

    -

    Never sent: your Microsoft or Minecraft account name or UUID, world names, server or LAN addresses, chat, and your user name or home folder in file paths. Before anything is kept, those are replaced with placeholders, along with e-mail and IP addresses. The server does not store the IP address requests come from.

    -

    The launcher shows exactly what would be sent: Settings → Data collection → View what would be sent, or horizon-launcher data show. Every field is listed in docs/telemetry.md.

    - -

    The "I'm playing" ping

    -

    The game sends an anonymous "I'm playing" ping, so the launcher can show how many people play Horizon right now. It is sent once a minute while you play, whatever the switches say.

    -

    It holds: a random number made when the game starts and forgotten when it closes, the Horizon version, your operating system (Linux, macOS or Windows), and whether you have a world open to LAN or to friends. It does not hold: your account, your install ID, world or server names, your hardware or settings, or anything you do in the game. The random number changes every time you start the game, so two of your sessions can't be linked to each other or to you.

    -

    The server keeps the pings in memory only, never on disk, and not with the address they came from (that is used only to stop abuse, as below). A session counts while it pinged in the last two minutes and is then forgotten. What it shows is the number playing now, per version and with a world open, rounded.

    - -

    Why

    -

    To find what is slow or crashes on which machines, and fix it. The ping shows players, and Horizon, how many people play right now. Benchmark uploads also show other players how Horizon runs on hardware like theirs. Nothing is sold, shared for advertising, or used to identify you.

    - -

    On what basis

    -

    For the switches: your consent (Article 6(1)(a) of the EU's General Data Protection Regulation). It is given kind by kind, recorded on your computer with the version of the question you answered and when, and withdrawn at any time with the same switches. Withdrawing deletes what was waiting to be sent. When what is collected changes, the launcher asks again, and nothing new is sent until you answer. The ping holds nothing that identifies you; the address it comes from is used only to limit how often one address may send, kept in memory for an hour at most and never stored.

    - -

    Where and how long

    -

    Items wait on your computer (telemetry/ in the game folder) and are sent compressed when the launcher starts or closes, to Horizon's own server, telemetry.playhorizon.dev, hosted by Railway in the European Union (Amsterdam, the Netherlands). The server keeps them for 180 days, then deletes them. What stays after that are anonymous totals per day, Horizon version, operating system, GPU maker and render distance (for example "120 sessions on macOS with Apple GPUs at render distance 12"). They hold no install ID, and groups too small to be anonymous are never shown. Published results also show how players split by memory size (in steps: 8, 16, 32 GB…), graphics memory, drive type, operating system and built-in or separate graphics, each class only once it holds at least 3 different installs; the exact values, the driver, the clocks and the screen are never published.

    - -

    Deleting your data

    -

    Settings → Data collection → Delete my data, or horizon-launcher data delete. The server deletes everything sent under your install ID, your share of the totals is recomputed, anything waiting on your computer is removed, and you get a new install ID. You can also turn everything off, or delete the telemetry/ folder.

    - -

    Your rights and contact

    -

    Horizon is made by Ludovic Marie, who is responsible for this data. To ask for a copy of what was sent under your install ID, have it corrected or deleted, or ask anything about it, write through lu4ovic.com (give your install ID, shown in Settings → Data collection). You can also complain to the data protection authority where you live.

    -

    This website itself sets no cookies and has no analytics; its footer says what it loads from GitHub.

    -
    - -

    Not an official Minecraft product. Not approved by or associated with Mojang or Microsoft.

    -
    -
    - - - diff --git a/website/src/releases-page.js b/website/src/releases-page.js deleted file mode 100644 index ace84f63d..000000000 --- a/website/src/releases-page.js +++ /dev/null @@ -1,78 +0,0 @@ -// The Releases page: the list baked at build time, refreshed from GitHub when a newer release is out, and the -// channel filter. Without JavaScript the baked list reads as it is. -import { releasesPageHtml } from "./releases.js"; -import { isGame, isLauncher, newestFirst } from "./versions.js"; -import { cached, get, setUpMenu, setUpTheme, slim } from "./chrome.js"; - -const REPO = "ludovic111/horizon"; -const list = document.getElementById("release-list"); -const counter = document.querySelector("[data-release-count]"); -const buttons = [...document.querySelectorAll("[data-filter]")]; -let filter = "all"; - -const ours = (r) => !r.draft && (isGame(r.tag_name) || isLauncher(r.tag_name)); - -// Every release, a page of 100 at a time (GitHub's most), up to 500. -async function loadAll() { - const all = []; - for (let page = 1; page <= 5; page++) { - const batch = await get(`https://api.github.com/repos/${REPO}/releases?per_page=100&page=${page}`); - all.push(...batch.filter(ours).map(slim)); - if (batch.length < 100) break; - } - return all; -} - -function apply() { - const entries = [...list.querySelectorAll(".release-entry")]; - let shown = 0; - for (const el of entries) { - const on = filter === "all" || el.dataset.channel === filter; - el.hidden = !on; - if (on) shown++; - } - counter.textContent = `${shown} release${shown === 1 ? "" : "s"}`; - buttons.forEach((b) => b.setAttribute("aria-pressed", String(b.dataset.filter === filter))); -} - -async function refresh() { - // One small request first: the full list only when GitHub has something newer than the page. - const newest = await cached("horizon:releases-newest", () => get(`https://api.github.com/repos/${REPO}/releases?per_page=5`)).catch(() => null); - if (!newest) return; - const top = newest.filter(ours).map((r) => r.tag_name).sort(newestFirst)[0]; - if (!top || top === list.dataset.newest) return; - const all = await cached("horizon:releases-all", loadAll).catch(() => null); - if (!all || !all.length) return; - const open = new Set([...list.querySelectorAll(".release-entry[open]")].map((el) => el.id)); - list.innerHTML = releasesPageHtml(all); - list.dataset.newest = top; - // Keep what the reader opened open. - open.forEach((id) => document.getElementById(id)?.setAttribute("open", "")); - apply(); -} - -// A link to one release (/releases#release-v0.2.1) opens it. -function openTarget() { - const el = location.hash && document.getElementById(location.hash.slice(1)); - if (el && el.classList.contains("release-entry")) { - if (el.hidden) { - filter = "all"; - apply(); - } - el.open = true; - el.scrollIntoView(); - } -} - -buttons.forEach((b) => - b.addEventListener("click", () => { - filter = b.dataset.filter; - apply(); - }), -); -addEventListener("hashchange", openTarget); -setUpTheme(); -setUpMenu(); -apply(); -openTarget(); -refresh().then(openTarget); diff --git a/website/src/releases.html b/website/src/releases.html deleted file mode 100644 index 989164653..000000000 --- a/website/src/releases.html +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - Releases · Horizon - - - - - - - - - - - - - - - - - - - - - -{{SITE_NAV}} -
    -
    -

    ReleasesEvery version, newest first

    -

    What's new in Horizon

    -

    Each release lists what it adds and fixes, then its full notes and its downloads. New versions come out many times a day as changes land, and the launcher installs each one once it has passed its test. The launcher has its own releases.

    -
    - - - -
    -

    {{RELEASE_COUNT}}

    -
    -{{RELEASE_LIST}} -
    -

    The releases on GitHub

    -

    Not an official Minecraft product. Not approved by or associated with Mojang or Microsoft.

    -
    -
    -{{SITE_FOOTER}} - - diff --git a/website/src/releases.js b/website/src/releases.js deleted file mode 100644 index d4932e7f7..000000000 --- a/website/src/releases.js +++ /dev/null @@ -1,156 +0,0 @@ -// The release notes on the site: the home page's "Recently added" block and the Releases page (every release, -// newest first). Shared by build.mjs (baked into the pages) and the pages' scripts (refreshed from GitHub). -// Tags: the game's vX.Y.Z and the launcher's launcher@X.Y.Z from 0.2, vYYYY.MM.DD[.N] and launcher-vX.Y.Z before -// (src/versions.js). One channel (docs/release-flow.md, "One channel"): a release is the game's or the launcher's. -import { markdown, inline, escape } from "./markdown.js"; -import { isLauncher, launcherVersion, newestFirst } from "./versions.js"; - -const REPO = "ludovic111/horizon"; - -export const channel = (r) => (isLauncher(r.tag_name) ? "Launcher" : "Game"); -const anchor = (r) => `release-${r.tag_name.replace(/[^\w.-]/g, "-")}`; - -// "Horizon 0.2.3: Cave culling, weather" (before 0.2, "Horizon 2026.10.13: …") reads as the version and its line. -export function parts(r) { - const version = launcherVersion(r.tag_name) ?? r.tag_name.replace(/^v/, ""); - const name = (r.name || "").trim(); - let line = name.includes(": ") ? name.slice(name.indexOf(": ") + 2) : name.replace(/^Horizon( launcher)?\s*/i, "").replace(version, "").trim(); - if (junk(line)) line = fromNotes(r.body) || line; - return { version, line: line.charAt(0).toUpperCase() + line.slice(1), date: (r.published_at || "").slice(0, 10) }; -} - -// A title made of issue numbers and "fix" ("#1255, mob pushes, fix, #1222") says nothing. -const junk = (line) => { - const bits = line.split(",").map((b) => b.trim()).filter(Boolean); - return bits.length > 1 && bits.filter((b) => /^(#\d+|fix(es)?|fixed)$/i.test(b)).length * 2 >= bits.length; -}; - -// The first item that isn't a bare "Fix #123:" prefix, as the line: "Mob pushes: one list per mob… and 3 more fixes". -function fromNotes(body) { - const s = sections(body); - const items = [...s.filter((x) => /^new|what's new/i.test(x.title)), ...s.filter((x) => /^fixed/i.test(x.title))].flatMap((x) => x.items).map(plainItem); - const clean = items.map((i) => i.replace(/^(fix|fixes)\s+#\d+:\s*/i, "").replace(/^\w+\([^)]*\):\s*/, "")).filter(Boolean); - if (!clean.length) return ""; - const first = clean[0].replace(/[.]$/, ""); - return clean.length > 1 ? `${first} and ${clean.length - 1} more` : first; -} - -// The notes' "### Heading" sections and their top-level items, in order. -export function sections(body) { - const out = []; - let current = null; - for (const raw of (body || "").replace(/\r\n?/g, "\n").split("\n")) { - const heading = raw.match(/^#{2,3}\s+(.+?)\s*$/); - if (heading) out.push((current = { title: heading[1], items: [] })); - else if (current && /^[-*]\s+/.test(raw)) current.items.push(raw.replace(/^[-*]\s+/, "").trim()); - } - return out; -} - -// An item without its pull request references: "Riptide (#123, fixes #45)" -> "Riptide". -export const plainItem = (item) => item.replace(/\s*\((?:#\d+|fixes #\d+|[^()]*#\d+[^()]*)\)\s*/g, " ").replace(/\s+/g, " ").trim(); - -// A game release's notes open with an HTML block sending people to the launcher (PLAYERS in tools/release_train.py): -// GitHub's latest release is the game's. This site has its own download button, so it leaves the block out. -export const notesText = (body) => (body || "").replace(/^

    Want to play\?[^\n]*(?:\r?\n)*/, ""); - -// The notes' first sentence, for a release with no title line and no sections ("Rebuilt from the latest main."). -const firstLine = (body) => (notesText(body).split(/\r?\n/).find((l) => l.trim() && !/^#/.test(l)) || "").trim().replace(/[.:]$/, ""); - -const count = (n, one, many) => `${n} ${n === 1 ? one : many}`; - -// What a release changes, in a line: "12 new, 30 fixed, 2 known issues". -export function overview(r) { - const s = sections(r.body); - const by = (re) => s.filter((x) => re.test(x.title)).reduce((n, x) => n + x.items.length, 0); - const added = by(/^new|what's new/i); - const fixed = by(/^fixed/i); - const known = by(/^known/i); - const bits = []; - if (added) bits.push(count(added, "new feature", "new features")); - if (fixed) bits.push(count(fixed, "fix", "fixes")); - if (known) bits.push(count(known, "known issue", "known issues")); - return { added, fixed, known, text: bits.join(", ") }; -} - -export function highlights(r, n = 3) { - const added = sections(r.body).filter((x) => /^new|what's new/i.test(x.title)).flatMap((x) => x.items); - return added.slice(0, n).map(plainItem); -} - -const byTag = (a, b) => newestFirst(a.tag_name, b.tag_name); -const badge = (r) => `${channel(r)}`; - -// The home page: the newest releases on a line each, and what the newest ones added. -export function recentHtml(list, { rows = 5, picks = 3 } = {}) { - const sorted = [...list].sort(byTag); - const game = sorted.filter((r) => !isLauncher(r.tag_name)); - if (!game.length) return ""; - const lines = game - .slice(0, rows) - .map((r) => { - const p = parts(r); - return `
  • ${escape(p.version)}${escape(p.line || overview(r).text || firstLine(r.body) || "Release notes")}${badge(r)}
  • `; - }) - .join(""); - // What landed last: the "New" items of the newest releases with the highest pull request numbers (a release's - // notes list everything since the release before it, oldest first). - const pr = (item) => Math.max(0, ...[...item.matchAll(/#(\d+)/g)].map((m) => Number(m[1]))); - const seen = new Set(); - const picked = game - .slice(0, rows) - .flatMap((r) => sections(r.body).filter((x) => /^new|what's new/i.test(x.title)).flatMap((x) => x.items).map((raw) => ({ raw, item: plainItem(raw), r }))) - .filter(({ item }) => !seen.has(item) && seen.add(item)) - .sort((a, b) => pr(b.raw) - pr(a.raw)) - .slice(0, picks); - const picks_ = picked - .map(({ item, r }) => `
  • ${inline(item)}

    ${escape(parts(r).version)}
  • `) - .join(""); - return `
      ${lines}
    - ${picks_ ? `

    New lately

      ${picks_}
    ` : ""} -

    Every release, with its full notes

    `; -} - -const ASSET_LABELS = [ - [/linux-x86_64/, "Linux x86-64"], - [/macos-arm64/, "macOS, Apple Silicon"], - [/macos-x86_64/, "macOS, Intel"], - [/windows-x64/, "Windows x64"], -]; -function assetLabel(name) { - if (/^SHA256SUMS/.test(name)) return name.endsWith(".sig") ? "Checksums signature" : "Checksums"; - const os = ASSET_LABELS.find(([re]) => re.test(name)); - const what = /server/.test(name) ? "Server" : /launcher/.test(name) ? "Launcher" : /smoke-test/.test(name) ? "Smoke test" : "Game"; - return os ? `${what}, ${os[1]}` : name; -} -const size = (bytes) => (bytes >= 1e6 ? `${(bytes / 1e6).toFixed(0)} MB` : bytes >= 1e3 ? `${(bytes / 1e3).toFixed(0)} kB` : `${bytes} B`); - -function releaseHtml(r, open) { - const p = parts(r); - const o = overview(r); - const top = highlights(r, 4); - const downloads = (r.assets || []) - .map((a) => `
  • ${escape(assetLabel(a.name))}${escape(a.name)} · ${size(a.size || 0)}
  • `) - .join(""); - return `
    - ${escape(p.version)}${badge(r)}${escape(p.line)} -
    - ${o.text || top.length ? `
    - ${o.text ? `

    ${escape(o.text)}

    ` : ""} - ${top.length ? `
      ${top.map((t) => `
    • ${inline(t)}
    • `).join("")}
    ` : ""} -
    ` : ""} -
    ${markdown(notesText(r.body)) || "

    No notes for this release.

    "}
    - ${downloads ? `

    Downloads

      ${downloads}
    ` : ""} -

    This release on GitHub

    -
    -
    `; -} - -// The Releases page: every release, newest first; the newest few open. -export function releasesPageHtml(list, { open = 3 } = {}) { - const sorted = [...list].sort(byTag); - if (!sorted.length) return ""; - return sorted.map((r, i) => releaseHtml(r, i < open)).join("\n"); -} - -export const releasesUrl = `https://github.com/${REPO}/releases`; diff --git a/website/src/releases.test.mjs b/website/src/releases.test.mjs deleted file mode 100644 index acd1a0965..000000000 --- a/website/src/releases.test.mjs +++ /dev/null @@ -1,13 +0,0 @@ -// node --test src/: the release notes as the site shows them. -import { test } from "node:test"; -import assert from "node:assert/strict"; -import { notesText } from "./releases.js"; - -const players = '

    Want to play? Download the Horizon launcher, not the files below

    It installs this version.

    '; - -test("the block sending people to the launcher is left out, the notes stay", () => { - assert.equal(notesText(`${players}\n\n### Fixed\n- A fix (#1)\n`), "### Fixed\n- A fix (#1)\n"); - assert.equal(notesText(`${players}\r\n\r\nRebuilt from the latest main.\r\n`), "Rebuilt from the latest main.\r\n"); - assert.equal(notesText("

    Other HTML

    \n\n### New\n- A thing (#2)\n"), "

    Other HTML

    \n\n### New\n- A thing (#2)\n"); - assert.equal(notesText(undefined), ""); -}); diff --git a/website/src/style.css b/website/src/style.css deleted file mode 100644 index 1de2a3d3d..000000000 --- a/website/src/style.css +++ /dev/null @@ -1,918 +0,0 @@ -/* Horizon's design language (docs/design-system.md), set as a page. The tokens come from - crates/horizon-theme through src/tokens.css, which build.mjs puts before this file: the - launcher's Blocks palettes, type, spacing and motion. The base below lays out the page; the - "Blocks" section at the end gives it the launcher's blocky, Minecraft-like look. */ - -@font-face { font-family: "Geist"; src: url("/fonts/Geist-Regular.woff2") format("woff2"); font-weight: 400; font-display: swap; } -@font-face { font-family: "Geist"; src: url("/fonts/Geist-Medium.woff2") format("woff2"); font-weight: 500; font-display: swap; } -@font-face { font-family: "Geist"; src: url("/fonts/Geist-SemiBold.woff2") format("woff2"); font-weight: 600; font-display: swap; } -@font-face { font-family: "Geist Mono"; src: url("/fonts/GeistMono-Regular.woff2") format("woff2"); font-weight: 400; font-display: swap; } - -:root { - --g: clamp(var(--gutter-narrow), 4.5vw, var(--gutter)); - --max: 1440px; - --nav: 72px; -} - -*, *::before, *::after { box-sizing: border-box; } - -html { - background: var(--page); - color: var(--ink); - font: 400 var(--text-body) / var(--text-body-line) var(--font); - font-synthesis: none; - -webkit-font-smoothing: antialiased; - -moz-osx-font-smoothing: grayscale; - text-rendering: optimizeLegibility; - scroll-behavior: smooth; - scroll-padding-top: calc(var(--nav) + 16px); - transition: background-color var(--move) var(--ease-move), color var(--move) var(--ease-move); -} -body { margin: 0; min-height: 100vh; overflow-x: clip; } -img { display: block; max-width: 100%; height: auto; } -h1, h2, h3 { margin: 0; font-weight: var(--text-heading-weight); } -p { margin: 0; } -ol, ul { margin: 0; padding: 0; list-style: none; } -::selection { background: var(--accent); color: var(--on-accent); } - -a { color: var(--accent); text-decoration: none; transition: color var(--quick) var(--ease-quick); } -a:hover { color: var(--ink); } -[hidden] { display: none !important; } -/* Links inside running text are underlined, so they don't rely on colour alone. */ -p a:not(.button):not(.link-arrow), li > p a, .prose a { - color: inherit; text-decoration: underline; text-decoration-color: var(--rule); - text-decoration-thickness: 1px; text-underline-offset: 3px; - transition: text-decoration-color var(--quick) var(--ease-quick); -} -p a:not(.button):not(.link-arrow):hover, li > p a:hover, .prose a:hover { text-decoration-color: currentColor; } -:focus-visible { outline: 2px solid var(--accent); outline-offset: 3px; border-radius: var(--radius); } - -code { - font: 0.86em/1.5 var(--mono); - background: var(--plate-soft); - border-radius: 4px; - padding: 1px 5px; - overflow-wrap: anywhere; -} - -.sr-only { - position: absolute; width: 1px; height: 1px; overflow: hidden; - clip: rect(0 0 0 0); clip-path: inset(50%); white-space: nowrap; -} -.skip { - position: fixed; left: var(--g); top: 12px; z-index: 50; padding: 8px 14px; - background: var(--ink); color: var(--page); border-radius: var(--radius-pill); - transform: translateY(-200%); -} -.skip:focus { transform: none; } - -.container { width: 100%; max-width: var(--max); margin: 0 auto; padding: 0 var(--g); } - -/* --- Type ----------------------------------------------------------------------------- */ - -.display { - font-size: var(--text-display); line-height: var(--text-display-line); - letter-spacing: var(--text-display-tracking); font-weight: var(--text-display-weight); - text-wrap: balance; -} -.title { - font-size: var(--text-title); line-height: var(--text-title-line); - letter-spacing: var(--text-title-tracking); font-weight: var(--text-title-weight); - text-wrap: balance; -} -.lede { max-width: var(--measure); color: var(--muted); text-wrap: pretty; } -.kicker, .meta, .download-meta, .eyebrow, .row-index, .row-meta, .disclaimer { - font: var(--text-micro-weight) var(--text-micro) / var(--text-micro-line) var(--mono); - letter-spacing: var(--text-micro-tracking); - color: var(--muted); -} -.kicker { display: flex; gap: 16px; text-transform: uppercase; margin-bottom: 24px; } -.kicker span { color: var(--ink); } -.meta { margin-top: 16px; } -.download-meta { margin-top: 12px; } -.download-meta a { color: inherit; } - -/* --- Buttons --------------------------------------------------------------------------- */ - -.button { - display: inline-flex; align-items: center; justify-content: center; gap: 8px; - height: var(--control); padding: 0 16px; border: 0; border-radius: var(--radius-pill); - font: 500 var(--text-label) / 1 var(--font); cursor: pointer; white-space: nowrap; - transition: background-color var(--quick) var(--ease-quick), color var(--quick) var(--ease-quick), opacity var(--quick) var(--ease-quick); -} -.button.large { height: var(--control-large); padding: 0 22px; font-size: var(--text-ui); } -.button.small { height: 30px; padding: 0 14px; } -.button.primary { background: var(--accent); color: var(--on-accent); } -.button.primary:hover { color: var(--on-accent); opacity: 0.88; } -.button.secondary { background: var(--plate-soft); color: var(--ink); } -.button.secondary:hover { background: var(--plate); color: var(--ink); } -.button.ghost { background: transparent; color: var(--muted); } -.button.ghost:hover { background: var(--plate-soft); color: var(--ink); } -.button:active { opacity: 0.85; } - -.link-arrow { display: inline-flex; gap: 8px; color: var(--accent); font-weight: 500; } -.link-arrow span { transition: transform var(--quick) var(--ease-quick); } -.link-arrow:hover span { transform: translateX(3px); } - -/* --- Navigation ------------------------------------------------------------------------- */ - -.nav { - position: fixed; inset: 0 0 auto; z-index: 20; height: var(--nav); max-width: 100vw; - background: color-mix(in srgb, var(--page) 88%, transparent); - -webkit-backdrop-filter: blur(16px) saturate(1.2); backdrop-filter: blur(16px) saturate(1.2); - box-shadow: 0 1px 0 var(--rule); - transition: background-color var(--move) var(--ease-move), box-shadow var(--move) var(--ease-move); -} -.nav-inner { display: flex; align-items: center; gap: 24px; height: 100%; max-width: var(--max); margin: 0 auto; padding: 0 var(--g); } -.nav-mark { display: inline-flex; align-items: center; gap: 10px; color: var(--ink); font-weight: 500; font-size: var(--text-label); } -.nav-mark:hover { color: var(--ink); } -.mark { width: 18px; height: 18px; } -.mark-stem { fill: var(--ink); } -.mark-low { fill: var(--ink); opacity: 0.36; } -.mark-line { fill: var(--accent); } -.nav-links { display: flex; gap: 2px; margin-left: auto; white-space: nowrap; } -.nav-links a, .nav-github, .theme-toggle { - display: inline-flex; align-items: center; height: 32px; padding: 0 12px; - border-radius: var(--radius-pill); color: var(--muted); font-size: var(--text-label); - transition: background-color var(--quick) var(--ease-quick), color var(--quick) var(--ease-quick); -} -.nav-links a:hover, .nav-github:hover, .theme-toggle:hover { color: var(--ink); background: var(--plate-soft); } -.nav-links a[aria-current] { color: var(--ink); background: var(--plate-soft); } -.nav-end { display: flex; align-items: center; gap: 2px; } -.theme-toggle { - border: 0; background: none; cursor: pointer; - font: var(--text-micro) / 1 var(--mono); letter-spacing: var(--text-micro-tracking); text-transform: uppercase; -} -.nav-end .button { margin-left: 8px; } -.menu-button { - display: none; align-items: center; gap: 10px; height: 44px; padding: 0 4px 0 14px; margin-left: 4px; - border: 0; background: none; color: var(--ink); font: 500 var(--text-label) / 1 var(--font); cursor: pointer; -} -.menu-icon { position: relative; width: 18px; height: 10px; } -.menu-icon::before, .menu-icon::after { - content: ""; position: absolute; left: 0; right: 0; height: 1.5px; border-radius: 1px; background: currentColor; - transition: transform var(--move) var(--ease-move), top var(--move) var(--ease-move); -} -.menu-icon::before { top: 0; } -.menu-icon::after { top: 8px; } -.is-menu .menu-icon::before { top: 4px; transform: rotate(45deg); } -.is-menu .menu-icon::after { top: 4px; transform: rotate(-45deg); } - -.menu { - position: fixed; inset: var(--nav) 0 0; z-index: 19; display: flex; flex-direction: column; max-width: 100vw; - justify-content: space-between; gap: 24px; overflow-y: auto; padding: 24px var(--g) 32px; background: var(--page); - opacity: 0; transition: opacity var(--move) var(--ease-move); -} -.menu.is-open { opacity: 1; } -.menu nav { display: flex; flex-direction: column; flex-shrink: 0; } -.menu nav a { - display: flex; align-items: baseline; gap: 16px; padding: 12px 0; border-bottom: 1px solid var(--rule); - color: var(--ink); font-size: var(--text-title); line-height: var(--text-title-line); - letter-spacing: var(--text-title-tracking); font-weight: 500; - opacity: 0; transform: translateY(var(--rise)); - transition: opacity var(--enter) var(--ease-enter), transform var(--enter) var(--ease-enter); -} -.menu.is-open nav a { opacity: 1; transform: none; } -.menu-foot { display: flex; flex-direction: column; gap: 16px; flex-shrink: 0; } -.menu-foot p { font-size: var(--text-caption); color: var(--muted); } - -@media (max-width: 1279px) { - .nav-links, .nav-github { display: none; } - .menu-button { display: inline-flex; } - .nav-end { margin-left: auto; } -} -@media (max-width: 520px) { - .nav-end .button { display: none; } -} - -/* --- Index lists: the signature component ------------------------------------------------ */ - -.index { border-top: 1px solid var(--rule); } -.row { position: relative; border-bottom: 1px solid var(--rule); } -.row > a, .row.card { - position: relative; display: grid; grid-template-columns: var(--index) 1fr auto; align-items: baseline; - column-gap: 16px; padding: 18px 0; color: var(--ink); -} -.row-index { transition: color var(--quick) var(--ease-quick); } -.row-name { font-size: var(--text-title); line-height: var(--text-title-line); letter-spacing: var(--text-title-tracking); font-weight: 500; } -.row-meta { text-align: right; } -/* Hover: a soft plate fades in behind the row and reaches past it; the index turns to ink. */ -.row > a::before, .row.card::before { - content: ""; position: absolute; inset: 0 calc(-1 * var(--plate-bleed)); z-index: -1; - border-radius: var(--radius-plate); background: var(--plate-soft); opacity: 0; - transition: opacity var(--quick) var(--ease-quick); -} -.row > a, .row.card { z-index: 0; } -.row > a:hover::before, .row.card:hover::before { opacity: 1; } -.row > a:hover .row-index, .row.card:hover .row-index { color: var(--ink); } -.row > a:hover, .row.card:hover { color: var(--ink); } - -/* --- Hero -------------------------------------------------------------------------------- */ - -.hero { padding: calc(var(--nav) + clamp(48px, 9vw, 120px)) 0 clamp(64px, 8vw, 112px); } -.hero-title { max-width: 14ch; margin-bottom: 20px; } -.hero .lede { font-size: var(--text-body); } -.hero-actions { display: flex; flex-wrap: wrap; gap: 8px; margin-top: 32px; } -.hero-index { margin-top: clamp(48px, 7vw, 88px); } -.hero .disclaimer { margin-top: 24px; } - -/* --- Sections ------------------------------------------------------------------------------- */ - -.section { padding: clamp(72px, 10vw, 144px) 0; } -.section-head { display: grid; grid-template-columns: minmax(0, 1fr) minmax(0, 1fr); gap: 16px 48px; align-items: end; margin-bottom: 48px; } -.section-head .kicker { grid-column: 1 / -1; margin-bottom: 0; } -.section .title { font-size: var(--text-display); line-height: var(--text-display-line); letter-spacing: var(--text-display-tracking); } - -.statement { - max-width: 28ch; font-size: var(--text-title); line-height: 1.15; - letter-spacing: var(--text-title-tracking); font-weight: 500; text-wrap: balance; -} -.facts { margin-top: 56px; } -.fact, .features li { - display: grid; grid-template-columns: var(--index) minmax(0, 18rem) minmax(0, 1fr); column-gap: 16px; - align-items: baseline; padding: 20px 0; -} -.fact h3, .features h3 { font-size: var(--text-heading); line-height: var(--text-heading-line); letter-spacing: var(--text-heading-tracking); } -.fact p, .features p { max-width: var(--measure); color: var(--muted); } - -/* Screenshots: no frames, the images themselves. */ -.mosaic { display: grid; grid-template-columns: repeat(6, 1fr); gap: 12px; } -.tile { margin: 0; grid-column: span 2; } -.tile-wide { grid-column: span 4; } -.tile-tall { grid-column: span 2; } -.tile-wide, .tile-tall { grid-row: span 1; } -.zoom { display: block; width: 100%; padding: 0; border: 0; background: var(--plate-soft); border-radius: var(--radius-plate); overflow: hidden; cursor: zoom-in; } -.zoom img { width: 100%; aspect-ratio: 16 / 9; object-fit: cover; transition: transform var(--enter) var(--ease-enter); } -.zoom:hover img { transform: scale(1.02); } -figcaption { display: flex; gap: 12px; margin-top: 10px; font-size: var(--text-caption); color: var(--muted); } -figcaption span { font-family: var(--mono); font-size: var(--text-micro); letter-spacing: var(--text-micro-tracking); padding-top: 1px; } - -/* Parity: the count, then every subsystem as an index row. */ -.parity-hero { display: grid; grid-template-columns: minmax(0, 1fr) minmax(0, 1fr); gap: 48px; align-items: end; margin-bottom: 64px; } -.count { font-size: clamp(96px, 16vw, 220px); line-height: 0.85; letter-spacing: -0.05em; font-weight: 500; } -.count .digits span { display: inline-block; } -.count-label { margin-top: 20px; max-width: 32ch; color: var(--muted); } -.parity-copy .title { margin-bottom: 16px; } -.prose { color: var(--ink-soft); max-width: var(--measure); } -.prose > * + * { margin-top: 12px; } -.systems { border-top: 1px solid var(--rule); } -.system { - display: grid; grid-template-columns: var(--index) minmax(0, 1fr) auto; column-gap: 16px; row-gap: 6px; - padding: 20px 0; border-bottom: 1px solid var(--rule); position: relative; -} -.system-head { display: contents; } -.system-index { grid-column: 1; grid-row: 1; font: var(--text-micro) / var(--text-micro-line) var(--mono); letter-spacing: var(--text-micro-tracking); color: var(--muted); padding-top: 0.6em; } -.system h3 { grid-column: 2; grid-row: 1; font-size: var(--text-heading); line-height: var(--text-heading-line); letter-spacing: var(--text-heading-tracking); } -.system-state { - grid-column: 3; grid-row: 1; display: inline-flex; align-items: center; gap: 6px; padding-top: 0.5em; - font: var(--text-micro) / var(--text-micro-line) var(--mono); letter-spacing: var(--text-micro-tracking); - text-transform: uppercase; color: var(--muted); -} -.system.is-full .system-state { color: var(--success); } -.check { width: 12px; height: 12px; fill: none; stroke: currentColor; stroke-width: 1.6; } -.system-detail { grid-column: 2 / 4; max-width: 72ch; font-size: var(--text-caption); line-height: 1.6; color: var(--muted); } -.gap { color: var(--ink); font-weight: 500; } -.legend { max-width: 80ch; } - -/* The launcher: copy and features on the left, the menus on the right. */ -.launcher-grid { display: grid; grid-template-columns: minmax(0, 5fr) minmax(0, 7fr); gap: clamp(32px, 5vw, 80px); align-items: start; } -.launcher-copy .title { margin-bottom: 16px; } -.launcher-copy .features { margin-top: 40px; } -.features li { grid-template-columns: var(--index) minmax(0, 1fr); row-gap: 4px; } -.features li p { grid-column: 2; font-size: var(--text-ui); } -.launcher-actions { margin-top: 32px; } -.screens { position: sticky; top: calc(var(--nav) + 24px); } -.tabs { position: relative; display: inline-flex; padding: 2px; gap: 2px; margin-bottom: 16px; border-radius: var(--radius-pill); background: var(--plate-soft); } -.tabs button { - position: relative; z-index: 1; height: var(--segment); padding: 0 14px; border: 0; background: none; - border-radius: var(--radius-pill); color: var(--muted); font: 500 var(--text-label) / 1 var(--font); cursor: pointer; - transition: color var(--quick) var(--ease-quick); -} -.tabs button:hover { color: var(--ink); } -.tabs button[aria-selected="true"] { color: var(--page); } -.tab-pill { position: absolute; top: 0; left: 0; border-radius: var(--radius-pill); background: var(--ink); transition: transform var(--move) var(--ease-move), width var(--move) var(--ease-move); } -.screen { position: relative; aspect-ratio: 16 / 10; border-radius: var(--radius-plate); overflow: hidden; background: var(--plate-soft); } -.screen-panel { position: absolute; inset: 0; opacity: 0; transition: opacity var(--move) var(--ease-move); } -.screen-panel.is-active { opacity: 1; } -.screen-panel img { width: 100%; height: 100%; object-fit: cover; } -.screen-caption { margin-top: 12px; font-size: var(--text-caption); color: var(--muted); } - -/* Patch notes. */ -.eyebrow { text-transform: uppercase; } -.prose h2, .prose h3, .prose h4 { font-size: var(--text-heading); line-height: var(--text-heading-line); color: var(--ink); margin-top: 28px; } -.prose ul, .prose ol { padding-left: 18px; list-style: disc; } -.prose li + li { margin-top: 6px; } -.prose li::marker { color: var(--muted); } -.prose strong { color: var(--ink); font-weight: 500; } -.prose pre { padding: 16px; border-radius: var(--radius-plate); background: var(--plate-soft); overflow-x: auto; } -.prose pre code { background: none; padding: 0; } -.release { border-top: 1px solid var(--rule); } -.release:last-of-type { border-bottom: 1px solid var(--rule); } -.release summary { - display: grid; grid-template-columns: minmax(0, 12rem) minmax(0, 1fr) auto; gap: 16px; align-items: baseline; - padding: 18px 0; cursor: pointer; list-style: none; -} -.release summary::-webkit-details-marker { display: none; } -.release-tag { font-size: var(--text-heading); font-weight: 500; letter-spacing: var(--text-heading-tracking); } -.release-sub { color: var(--muted); font-size: var(--text-ui); } -.release time { font: var(--text-micro) / 1 var(--mono); letter-spacing: var(--text-micro-tracking); color: var(--muted); } -.release[open] summary .release-tag { color: var(--accent); } -.release .prose { padding: 0 0 24px 12rem; margin-left: 16px; font-size: var(--text-ui); } -.release-more { margin-top: 24px; } - -/* Community. */ -.cards { margin-top: 48px; } -.row.card { grid-template-columns: var(--index) minmax(0, 1fr) minmax(0, 1.4fr) auto; } -.card-title { font-size: var(--text-title); line-height: var(--text-title-line); letter-spacing: var(--text-title-tracking); font-weight: 500; } -.card-text { color: var(--muted); } -.card-arrow { color: var(--muted); transition: transform var(--quick) var(--ease-quick), color var(--quick) var(--ease-quick); } -.card:hover .card-arrow { color: var(--accent); transform: translateX(4px); } -.contributors { margin-top: 96px; } -.contributors-title { font-size: var(--text-heading); line-height: var(--text-heading-line); } -.contributors-text { margin-top: 8px; color: var(--muted); } -.contributors-list { margin-top: 24px; display: grid; grid-template-columns: repeat(auto-fill, minmax(220px, 1fr)); gap: 0 24px; border-top: 1px solid var(--rule); } -.contributor { display: grid; grid-template-columns: 32px 1fr; column-gap: 12px; align-items: center; padding: 14px 0; border-bottom: 1px solid var(--rule); color: var(--ink); } -.contributor-avatar { grid-row: span 2; width: 32px; height: 32px; border-radius: 50%; background: var(--plate); } -.contributor-name { font-weight: 500; } -.contributor-count { font: var(--text-micro) / 1.4 var(--mono); letter-spacing: var(--text-micro-tracking); color: var(--muted); } -.contributor:hover .contributor-name { color: var(--accent); } - -/* --- Footer: small print, then the giant faint wordmark --------------------------------- */ - -.footer { padding: clamp(72px, 9vw, 120px) 0 0; overflow: hidden; } -.footer-disclaimer { max-width: 24ch; font-size: var(--text-heading); line-height: var(--text-heading-line); letter-spacing: var(--text-heading-tracking); font-weight: 500; } -.footer-cols { display: grid; grid-template-columns: repeat(3, minmax(0, 1fr)); gap: 32px; margin-top: 40px; } -.footer-cols p { font-size: var(--text-caption); line-height: 1.7; color: var(--muted); } -.footer-bar { display: flex; justify-content: space-between; align-items: center; gap: 24px; margin-top: 56px; font-size: var(--text-caption); color: var(--muted); } -.footer-links { display: flex; flex-wrap: wrap; gap: 20px; } -.footer-links a { color: var(--muted); } -.footer-links a:hover { color: var(--ink); } -.footer-word { - box-sizing: border-box; width: 100%; margin: 24px auto 0; padding: 0 var(--g); max-width: var(--max); - font-size: var(--text-wordmark); line-height: var(--text-wordmark-line); letter-spacing: var(--text-wordmark-tracking); - font-weight: var(--text-wordmark-weight); color: var(--plate); white-space: nowrap; user-select: none; - translate: -0.05em 0.12em; -} -:root[data-theme="dark"] .footer-word { color: var(--plate-soft); } -@media (prefers-color-scheme: dark) { :root:not([data-theme="light"]) .footer-word { color: var(--plate-soft); } } - -/* --- Lightbox ---------------------------------------------------------------------------- */ - -.lightbox { width: min(1400px, 94vw); max-height: 92vh; padding: 0; border: 0; border-radius: var(--radius-plate); background: var(--surface); color: var(--ink); } -.lightbox::backdrop { background: color-mix(in srgb, var(--page) 86%, transparent); -webkit-backdrop-filter: blur(8px); backdrop-filter: blur(8px); } -.lightbox img { width: 100%; } -.lightbox form { position: absolute; top: 12px; right: 12px; } -.lightbox-caption { padding: 14px 16px; font-size: var(--text-caption); color: var(--muted); } - -/* --- 404 --------------------------------------------------------------------------------- */ - -.lost { min-height: 100vh; display: flex; flex-direction: column; justify-content: space-between; } -.lost .hero { padding-top: clamp(96px, 16vh, 200px); } - -/* --- Motion: content arrives with a fade and a short rise, a few tens of ms apart --------- */ - -.js .reveal, .js .reveal-media { - opacity: 0; transform: translateY(var(--rise)); filter: blur(4px); - transition: opacity var(--enter) var(--ease-enter) var(--d, 0ms), transform var(--enter) var(--ease-enter) var(--d, 0ms), filter var(--enter) var(--ease-enter) var(--d, 0ms); -} -.js .reveal.is-visible, .js .reveal-media.is-visible { opacity: 1; transform: none; filter: none; } -.js .systems .system { opacity: 0; transform: translateY(var(--rise)); transition: opacity var(--enter) var(--ease-enter) var(--d, 0ms), transform var(--enter) var(--ease-enter) var(--d, 0ms); } -.js .systems.is-visible .system { opacity: 1; transform: none; } -@media (prefers-reduced-motion: reduce) { - html { scroll-behavior: auto; } - .js .reveal, .js .reveal-media, .js .systems .system { transform: none; filter: none; transition: opacity 200ms linear; } - .menu nav a { transform: none; } -} - -/* --- Touch: every target at least 44 px high ------------------------------------------- */ - -@media (pointer: coarse) { - .button, .button.large, .button.small, .tabs button { height: 44px; } - .nav-mark, .theme-toggle, .nav-github { min-height: 44px; } - .link-arrow, .footer-links a { display: inline-flex; align-items: center; min-height: 44px; } -} - -/* --- Narrow screens ------------------------------------------------------------------------ */ - -@media (max-width: 900px) { - .section-head, .parity-hero, .launcher-grid { grid-template-columns: minmax(0, 1fr); } - .section-head { gap: 16px; } - .screens { position: static; } - .fact { grid-template-columns: var(--index) minmax(0, 1fr); row-gap: 6px; } - .fact p { grid-column: 2; } - .mosaic { grid-template-columns: minmax(0, 1fr); } - .tile, .tile-wide, .tile-tall { grid-column: auto; } - .row.card { grid-template-columns: var(--index) minmax(0, 1fr) auto; row-gap: 4px; } - .card-text { grid-column: 2; grid-row: 2; font-size: var(--text-ui); } - .card-arrow { grid-row: 1; grid-column: 3; } - .release summary { grid-template-columns: minmax(0, 1fr) auto; } - .release-sub { grid-column: 1 / -1; grid-row: 2; } - .release .prose { padding-left: 0; margin-left: 0; } - .footer-cols { grid-template-columns: minmax(0, 1fr); } - .footer-bar { flex-direction: column; align-items: flex-start; } - .system { grid-template-columns: var(--index) minmax(0, 1fr); } - .system-state { grid-column: 2; grid-row: 2; padding-top: 0; } - .system-detail { grid-column: 2; } - .row > a { grid-template-columns: 28px 1fr auto; padding: 16px 0; } - :root { --index: 28px; } -} - -/* The privacy page: one long read under the hero type. */ -.privacy h1 { margin-bottom: 16px; } -.privacy .prose { margin: 40px 0; } -.privacy .disclaimer { margin-top: 32px; } - -/* --- Documentation (/docs): a left navigation and one page at a time --------------------- */ - -.docs { - display: grid; grid-template-columns: 248px minmax(0, 1fr); gap: clamp(32px, 6vw, 96px); - max-width: var(--max); margin: 0 auto; padding: calc(var(--nav) + 48px) var(--g) 0; align-items: start; -} -.docs-nav-wrap { position: sticky; top: calc(var(--nav) + 24px); max-height: calc(100vh - var(--nav) - 48px); overflow-y: auto; padding-bottom: 24px; } -.docs-nav-wrap summary { display: none; } -.docs-nav-group { margin: 28px 0 8px; font: var(--text-micro) / var(--text-micro-line) var(--mono); letter-spacing: var(--text-micro-tracking); text-transform: uppercase; color: var(--muted); } -.docs-nav-group:first-child { margin-top: 0; } -.docs-nav li a { display: block; padding: 6px 12px; margin-left: -12px; border-radius: var(--radius); color: var(--ink-soft); font-size: var(--text-ui); } -.docs-nav li a:hover { background: var(--plate-soft); color: var(--ink); } -.docs-nav li a[aria-current] { background: var(--plate-soft); color: var(--ink); font-weight: 500; } -.docs-main { min-width: 0; padding-bottom: 48px; } -.docs-main .title { margin-bottom: 16px; } -.docs-main .lede { max-width: 64ch; font-size: var(--text-heading); line-height: 1.45; } -.docs-toc { margin-top: 28px; max-width: 72ch; } -.docs-toc p { font: var(--text-micro) / var(--text-micro-line) var(--mono); letter-spacing: var(--text-micro-tracking); text-transform: uppercase; color: var(--muted); margin-bottom: 8px; } -.docs-toc ul { display: flex; flex-wrap: wrap; gap: 6px; } -.docs-toc a { display: block; padding: 4px 12px; border-radius: var(--radius-pill); background: var(--plate-soft); color: var(--ink-soft); font-size: var(--text-label); } -.docs-toc a:hover { background: var(--plate); color: var(--ink); } -.docs-prose { max-width: 72ch; margin-top: 40px; font-size: var(--text-body); } -.docs-prose > * + * { margin-top: 14px; } -.docs-prose h2 { margin-top: 56px; padding-top: 24px; border-top: 1px solid var(--rule); font-size: clamp(24px, 2.4vw, 30px); line-height: 1.2; letter-spacing: var(--text-title-tracking); scroll-margin-top: 80px; } -.docs-prose h2:first-child { margin-top: 0; padding-top: 0; border-top: 0; } -.docs-prose h3 { margin-top: 32px; scroll-margin-top: 80px; } -.docs-prose ol { list-style: decimal; } -.docs-prose pre { font: 0.86em/1.6 var(--mono); } -.docs-prose blockquote { padding: 2px 0 2px 16px; border-left: 2px solid var(--accent); color: var(--ink-soft); } -.docs-prose blockquote > * + * { margin-top: 8px; } -.docs-prose figure { margin: 28px 0; } -.docs-prose figure img { width: 100%; border-radius: var(--radius-plate); box-shadow: 0 0 0 1px var(--rule); } -.docs-prose figcaption { margin-top: 10px; font-size: var(--text-caption); color: var(--muted); } -.docs-pager { display: grid; grid-template-columns: repeat(2, minmax(0, 1fr)); gap: 16px; max-width: 72ch; margin-top: 56px; } -.docs-pager a { display: flex; flex-direction: column; gap: 2px; padding: 14px 16px; border-radius: var(--radius-plate); box-shadow: 0 0 0 1px var(--rule); color: var(--ink); font-weight: 500; } -.docs-pager a:hover { background: var(--plate-soft); color: var(--ink); } -.docs-pager a span { font: var(--text-micro) / var(--text-micro-line) var(--mono); letter-spacing: var(--text-micro-tracking); text-transform: uppercase; color: var(--muted); font-weight: 400; } -.docs-pager-next { grid-column: 2; text-align: right; } -.docs-edit { margin-top: 32px; font-size: var(--text-caption); color: var(--muted); } -.docs-edit a { color: inherit; text-decoration: underline; text-decoration-color: var(--rule); text-underline-offset: 3px; } -.docs-main .disclaimer { margin-top: 24px; } - -@media (max-width: 900px) { - .docs { grid-template-columns: minmax(0, 1fr); gap: 0; padding-top: calc(var(--nav) + 12px); } - .docs-nav-wrap { position: static; max-height: none; overflow: visible; margin-bottom: 24px; border-bottom: 1px solid var(--rule); } - .docs-nav-wrap summary { display: flex; align-items: center; min-height: 44px; cursor: pointer; font-weight: 500; list-style: none; } - .docs-nav-wrap summary::-webkit-details-marker { display: none; } - .docs-nav-wrap summary::after { content: "+"; margin-left: auto; color: var(--muted); } - .docs-nav-wrap[open] summary::after { content: "\2212"; } - .docs-pager { grid-template-columns: minmax(0, 1fr); } - .docs-pager-next { grid-column: 1; } -} -@media (pointer: coarse) { - .docs-nav li a, .docs-toc a { display: flex; align-items: center; min-height: 44px; } -} - -/* --- Blocks: the launcher's look on the page (docs/design-system.md, "Blocks") ------------- - Pixel type for headings and controls, square panels with a dark outline, a light bevel on top - and a darker lip below, the violet face for the main action, sunk wells, a stone texture - behind the page and Horizon's pixel landscape behind the hero. The art is drawn in code - (scripts/art.mjs, like launcher/src/art.rs); nothing in it comes from Minecraft. */ - -@font-face { font-family: "Pixelify Sans"; src: url("/fonts/PixelifySans-Medium.woff2") format("woff2"); font-weight: 500; font-display: swap; } -@font-face { font-family: "Pixelify Sans"; src: url("/fonts/PixelifySans-SemiBold.woff2") format("woff2"); font-weight: 600; font-display: swap; } -@font-face { font-family: "Pixelify Sans"; src: url("/fonts/PixelifySans-Bold.woff2") format("woff2"); font-weight: 700; font-display: swap; } - -:root { - --stone: url("/media/stone-light.png"); - --scene: url("/media/scene-light.png"); - --sky: #8d7fd8; - --panel-edges: inset 0 var(--block-bevel) 0 var(--bevel), inset 0 calc(-1 * var(--block-bevel)) 0 var(--lip); - --radius: 0px; --radius-plate: 0px; --radius-pill: 0px; -} -:root[data-theme="dark"] { --stone: url("/media/stone-dark.png"); --scene: url("/media/scene-dark.png"); --sky: #0a0f2c; } -@media (prefers-color-scheme: dark) { - :root:not([data-theme="light"]) { --stone: url("/media/stone-dark.png"); --scene: url("/media/scene-dark.png"); --sky: #0a0f2c; } -} - -/* The stone: 64 texels of the page colour in close shades, each texel 4 px. */ -body { position: relative; isolation: isolate; } -body::before { - content: ""; position: fixed; inset: 0; z-index: -1; pointer-events: none; - background: var(--stone) 0 0 / 256px 256px repeat; image-rendering: pixelated; -} - -/* Pixel type for what names and what you act on; paragraphs stay in Geist. */ -.display, .title, .statement, .row-name, .card-title, .release-tag, .count, -.fact h3, .features h3, .system h3, .contributors-title, .footer-disclaimer, .footer-word, -.nav-mark, .docs-prose h2, .docs-prose h3, .prose h2, .prose h3, .prose h4, .menu nav a { - font-family: var(--pixel); font-weight: 600; letter-spacing: 0; -} -.display, .count, .footer-word { font-weight: 700; } -.nav-mark { font-size: 18px; font-weight: 700; text-transform: uppercase; letter-spacing: 0.04em; } -code { border-radius: 0; background: var(--well); box-shadow: 0 0 0 1px var(--outline); } - -/* Buttons: blocks with an outline, a bevel and a lip; they sink a pixel when pressed. */ -.button { - border: var(--block-outline) solid var(--outline); border-radius: 0; - font: 500 var(--text-ui) / 1 var(--pixel); - box-shadow: inset 0 var(--block-bevel) 0 var(--button-bevel), inset 0 calc(-1 * var(--block-lip)) 0 var(--lip); - padding-bottom: 2px; -} -.button.large { font-size: 18px; } -.button.primary { background: var(--face); color: var(--on-face); box-shadow: inset 0 var(--block-bevel) 0 var(--face-bevel), inset 0 calc(-1 * var(--block-lip)) 0 var(--face-lip); } -.button.primary:hover { opacity: 1; filter: brightness(1.08); } -.button.secondary { background: var(--button); } -.button.secondary:hover { background: var(--button); filter: brightness(1.06); } -.button.ghost { border-color: transparent; box-shadow: none; } -.button:active { opacity: 1; transform: translateY(1px); box-shadow: inset 0 var(--block-bevel) 0 var(--lip); } -:focus-visible { border-radius: 0; } - -/* The top bar: the sidebar colour with an outline under it, tabs with an accent underline. */ -.nav { background: var(--side); -webkit-backdrop-filter: none; backdrop-filter: none; box-shadow: 0 var(--block-outline) 0 var(--outline); } -.nav-links a, .nav-github, .theme-toggle { border-radius: 0; font-family: var(--pixel); font-weight: 500; font-size: 15px; } -.nav-links a:hover, .nav-github:hover, .theme-toggle:hover { background: var(--raised); } -.nav-links a[aria-current] { background: var(--raised); box-shadow: inset 0 -3px 0 var(--accent); } -.theme-toggle { text-transform: none; letter-spacing: 0; } -.menu { background: var(--side); } -.menu nav a { border-bottom: 0; } - -/* Lists become stacks of panels. */ -.index, .systems, .contributors-list { border-top: 0; display: grid; gap: 8px; } -.row, .system, .release, .release:last-of-type, .contributor { border-bottom: 0; border-top: 0; } -.row > a, .row.card, .fact.row, .features li, .system, .release, .contributor, .docs-pager a { - background: var(--panel); border: var(--block-outline) solid var(--outline); box-shadow: var(--panel-edges); - border-radius: 0; -} -.row > a, .row.card, .fact.row, .features li, .system { padding-left: 20px; padding-right: 20px; } -.row > a::before, .row.card::before { display: none; } -.row > a:hover, .row.card:hover, .contributor:hover, .docs-pager a:hover { background: var(--raised); } -.row > a:hover .row-index { color: var(--accent); } -.row-name { font-size: clamp(20px, 2.2vw, 28px); } -.release { padding: 0 20px; } -.release + .release { margin-top: 8px; } -.release .prose { padding-left: 12rem; } -.contributor { padding: 12px 14px; } -.contributors-list { grid-template-columns: repeat(auto-fill, minmax(220px, 1fr)); gap: 8px; } -.contributor-avatar { border-radius: 0; box-shadow: 0 0 0 2px var(--outline); image-rendering: pixelated; } -.system.is-full .system-state { color: var(--success); } - -/* Screenshots and the launcher's screens: square, outlined. */ -.zoom, .screen, .lightbox, .prose pre, .docs-prose figure img { border-radius: 0; box-shadow: 0 0 0 var(--block-outline) var(--outline); } -.tabs { border-radius: 0; background: var(--well); box-shadow: 0 0 0 var(--block-outline) var(--outline); } -.tabs button { border-radius: 0; font-family: var(--pixel); font-weight: 500; font-size: 15px; } -.tabs button[aria-selected="true"] { color: var(--on-face); } -.tab-pill { border-radius: 0; background: var(--face); box-shadow: inset 0 var(--block-bevel) 0 var(--face-bevel), inset 0 calc(-1 * var(--block-bevel)) 0 var(--face-lip); } - -/* The hero: Horizon's landscape under a veil of the page colour, the words on the left. */ -.hero { - position: relative; isolation: isolate; overflow: hidden; - background: var(--scene) 70% 100% / clamp(1200px, 135vw, 2400px) auto no-repeat, var(--sky); image-rendering: pixelated; - border-bottom: var(--block-outline) solid var(--outline); -} -.hero::before { - content: ""; position: absolute; inset: 0; z-index: -1; - background: - linear-gradient(90deg, color-mix(in srgb, var(--page) 92%, transparent) 0%, color-mix(in srgb, var(--page) 78%, transparent) 45%, color-mix(in srgb, var(--page) 0%, transparent) 78%), - linear-gradient(180deg, color-mix(in srgb, var(--page) 0%, transparent) 55%, color-mix(in srgb, var(--page) 70%, transparent) 100%); -} -.hero .kicker span, .hero .kicker { color: var(--ink-soft); } -.hero .lede { color: var(--ink-soft); } -.hero { padding-bottom: clamp(160px, 18vw, 280px); } -.hero-after { padding-top: 40px; } -.hero-after .hero-index { margin-top: 0; max-width: 860px; } -.hero-after .disclaimer { margin-top: 24px; } -@media (max-width: 900px) { - .hero::before { background: color-mix(in srgb, var(--page) 84%, transparent); } -} - -/* Documentation. */ -.docs-nav li a { border-radius: 0; } -.docs-nav li a[aria-current] { background: var(--raised); box-shadow: inset 4px 0 0 var(--accent); } -.docs-toc a { border-radius: 0; background: var(--button); box-shadow: 0 0 0 var(--block-outline) var(--outline); } -.docs-pager a { box-shadow: var(--panel-edges); } -.docs-prose h2 { border-top: var(--block-outline) solid var(--outline); } -.docs-prose blockquote { border-left: 4px solid var(--accent); background: var(--panel); padding: 10px 16px; box-shadow: 0 0 0 var(--block-outline) var(--outline); } - -/* The footer: the giant wordmark in pixels. */ -.footer { background: var(--side); border-top: var(--block-outline) solid var(--outline); margin-top: 48px; } -.footer-word { color: var(--raised); letter-spacing: 0.02em; } -:root[data-theme="dark"] .footer-word { color: var(--panel); } -@media (prefers-color-scheme: dark) { :root:not([data-theme="light"]) .footer-word { color: var(--panel); } } - -/* --- Releases and Benchmarks pages, and the home page's "Recently added" ------------------ */ - -/* Pixelify Sans' "fi" ligature draws as "A" ("8 Axes"): no common ligatures anywhere. */ -:root { font-variant-ligatures: no-common-ligatures; } - -.page-main { padding-top: calc(var(--nav) + clamp(40px, 6vw, 80px)); } -.page-title { max-width: 18ch; margin-bottom: 20px; } -.page-main > .container > .lede { font-size: var(--text-body); } -.page-main .disclaimer { margin-top: 48px; } - -/* Release and source badges: small square tags. */ -.badge { - display: inline-flex; align-items: center; height: 22px; padding: 0 8px; margin-right: 10px; vertical-align: 2px; - font: 500 12px / 1 var(--pixel); letter-spacing: 0.02em; text-transform: uppercase; white-space: nowrap; - border: var(--block-outline) solid var(--outline); background: var(--well); color: var(--ink-soft); -} -.badge-game { background: color-mix(in srgb, var(--success) 22%, var(--panel)); color: var(--ink); } -.badge-launcher { background: color-mix(in srgb, var(--accent) 20%, var(--panel)); color: var(--ink); } -.badge-us { background: color-mix(in srgb, var(--accent) 20%, var(--panel)); color: var(--ink); } -.badge-players { background: color-mix(in srgb, var(--success) 22%, var(--panel)); color: var(--ink); } -.badge-estimate { background: color-mix(in srgb, var(--warn) 24%, var(--panel)); color: var(--ink); } - -/* Home: the newest releases on a line each, then what they added. */ -.recent-list .row > a { grid-template-columns: 8.5rem minmax(0, 13rem) minmax(0, 1fr) auto; align-items: baseline; } -.recent-line { color: var(--muted); min-width: 0; overflow: hidden; text-overflow: ellipsis; white-space: nowrap; } -.recent-list .row-name { font-size: clamp(18px, 1.8vw, 22px); } -.recent-list .badge { margin-right: 0; } -.recent-picks { margin-top: 32px; } -.recent-picks .eyebrow { margin-bottom: 12px; } -.highlights { display: grid; grid-template-columns: repeat(3, minmax(0, 1fr)); gap: 8px; } -.highlight { - display: flex; flex-direction: column; justify-content: space-between; gap: 16px; padding: 18px 20px; - background: var(--panel); border: var(--block-outline) solid var(--outline); box-shadow: var(--panel-edges); -} -.highlight p { color: var(--ink); } -.highlight-from { font: var(--text-micro) / 1 var(--mono); letter-spacing: var(--text-micro-tracking); color: var(--muted); } -.highlight-from:hover { color: var(--accent); } - -/* Releases: a filter, then every release as a panel that opens. */ -.release-filter { display: flex; flex-wrap: wrap; gap: 8px; margin-top: 32px; } -.release-filter .button[aria-pressed="true"], .hub-detail .button[aria-pressed="true"], .button.hub-vote[aria-pressed="true"] { background: var(--face); color: var(--on-face); box-shadow: inset 0 var(--block-bevel) 0 var(--face-bevel), inset 0 calc(-1 * var(--block-lip)) 0 var(--face-lip); } -.release-count { margin: 16px 0 12px; } -.release-list { display: grid; gap: 8px; } -.release-list .release + .release { margin-top: 0; } -.release-entry summary { grid-template-columns: minmax(0, 11rem) minmax(0, 1fr) auto; } -.release-entry .release-sub { display: flex; align-items: baseline; flex-wrap: wrap; row-gap: 4px; } -.release-detail { padding: 0 0 24px 11rem; margin-left: 16px; display: grid; gap: 20px; max-width: calc(11rem + 16px + var(--measure) + 120px); } -.release-detail .prose { padding: 0; margin: 0; font-size: var(--text-ui); max-width: none; } -.release-overview { padding: 16px 18px; background: var(--well); box-shadow: 0 0 0 var(--block-outline) var(--outline); } -.release-counts { font-family: var(--pixel); font-weight: 600; color: var(--ink); margin-bottom: 8px; } -.release-overview ul { list-style: square; padding-left: 18px; color: var(--ink-soft); font-size: var(--text-ui); } -.release-overview li + li { margin-top: 4px; } -.release-downloads ul { display: grid; grid-template-columns: repeat(auto-fill, minmax(240px, 1fr)); gap: 8px; margin-top: 8px; } -.release-downloads li { display: flex; flex-direction: column; gap: 2px; padding: 10px 12px; background: var(--button); box-shadow: 0 0 0 var(--block-outline) var(--outline); } -.release-downloads li a { font-weight: 500; } -.release-downloads li span { font: var(--text-micro) / 1.4 var(--mono); color: var(--muted); overflow-wrap: anywhere; } -.release-github { font-size: var(--text-caption); } -.release-entry:target { box-shadow: var(--panel-edges), 0 0 0 3px var(--accent); } - -/* Benchmarks. */ -.bench-section { margin-top: clamp(64px, 8vw, 112px); } -.bench-section > .title { margin-bottom: 16px; } -.bench-section > .lede { margin-bottom: 32px; } -.machines { display: grid; grid-template-columns: minmax(0, 1fr); gap: 24px; } -.machine { min-width: 0; padding: 24px; background: var(--panel); border: var(--block-outline) solid var(--outline); box-shadow: var(--panel-edges); } -.machine-head { display: grid; gap: 10px; margin-bottom: 20px; } -.machine-name { font-family: var(--pixel); font-weight: 600; font-size: var(--text-title); line-height: var(--text-title-line); } -.machine-facts { display: flex; flex-wrap: wrap; gap: 6px 28px; margin: 0; } -.machine-facts div { display: flex; gap: 8px; min-width: 0; } -.machine-facts dt { font: var(--text-micro) / 1.6 var(--mono); letter-spacing: var(--text-micro-tracking); text-transform: uppercase; color: var(--muted); } -.machine-facts dd { margin: 0; min-width: 0; overflow-wrap: anywhere; font-size: var(--text-caption); color: var(--ink-soft); } -.machine-note { font-size: var(--text-caption); color: var(--muted); max-width: 90ch; } -/* relative: the screen-reader-only labels inside are absolute and would escape the scroll box otherwise. */ -.table-wrap { position: relative; overflow-x: auto; } -.bench-table { width: 100%; border-collapse: collapse; font-size: var(--text-ui); } -.bench-table th, .bench-table td { padding: 9px 12px; text-align: left; border-bottom: 1px solid var(--rule); vertical-align: baseline; } -.bench-table thead th { font: var(--text-micro) / 1.4 var(--mono); letter-spacing: var(--text-micro-tracking); text-transform: uppercase; color: var(--muted); font-weight: 400; } -.bench-table thead tr:first-child th { color: var(--ink); } -.bench-table tbody th { font-weight: 500; color: var(--ink); } -.bench-table td.num { font-variant-numeric: tabular-nums; white-space: nowrap; } -.bench-table td.wins { color: var(--ink); font-weight: 600; } -.bench-table td.vs { font-size: var(--text-caption); white-space: nowrap; } -.md-table { width: 100%; border-collapse: collapse; font-size: var(--text-ui); } -.md-table th, .md-table td { padding: 8px 12px 8px 0; text-align: left; border-bottom: 1px solid var(--rule); vertical-align: baseline; } -.md-table th { font-weight: 500; color: var(--ink); } -.md-table td code, .md-table th code { overflow-wrap: anywhere; } -.vs-horizon { color: var(--success); } -.vs-java { color: var(--danger); } -.vs-tie, .vs-none { color: var(--muted); } -.capped { font: var(--text-micro) / 1 var(--mono); color: var(--warn); cursor: help; } -.metric-hint { display: block; font: var(--text-micro) / 1.4 var(--mono); color: var(--muted); font-weight: 400; } -.java-wins { margin-top: 16px; font-size: var(--text-caption); color: var(--ink-soft); } -.picker { display: flex; flex-wrap: wrap; gap: 16px 24px; align-items: end; padding: 20px; background: var(--panel); border: var(--block-outline) solid var(--outline); box-shadow: var(--panel-edges); } -.picker label { display: grid; gap: 6px; } -.picker label > span, .picker legend { font: var(--text-micro) / 1.4 var(--mono); letter-spacing: var(--text-micro-tracking); text-transform: uppercase; color: var(--muted); } -.picker select { - min-width: min(320px, 80vw); height: var(--control); padding: 0 10px; font: inherit; font-size: var(--text-ui); color: var(--ink); - background: var(--well); border: var(--block-outline) solid var(--outline); border-radius: 0; -} -.picker-rd { display: flex; gap: 16px; align-items: center; border: 0; padding: 0; margin: 0; } -.picker-rd legend { margin-bottom: 6px; } -.picker-rd label { display: inline-flex; align-items: center; gap: 6px; font-family: var(--pixel); font-weight: 500; height: var(--control); } -.picker-rd input { accent-color: var(--accent); width: 18px; height: 18px; } -.pick-result { margin-top: 16px; padding: 20px; background: var(--panel); border: var(--block-outline) solid var(--outline); box-shadow: var(--panel-edges); } -.pick-head { margin-bottom: 12px; font-size: var(--text-caption); color: var(--ink-soft); line-height: 1.8; } -.pick-result .meta { margin-top: 12px; } -.pick-notes { margin: 12px 0 0; padding-left: 20px; font-size: var(--text-caption); color: var(--ink-soft); line-height: 1.6; } -.players-hardware th[scope="rowgroup"] { vertical-align: top; } -.empty { color: var(--muted); } -.prose-section .prose { max-width: 80ch; } -.spec-table { margin-top: 24px; } -.spec-table summary { cursor: pointer; font-family: var(--pixel); font-weight: 600; } -.spec-table .bench-table { margin-top: 16px; max-width: 760px; } - -@media (max-width: 900px) { - .recent-list .row > a { grid-template-columns: minmax(0, 1fr) auto; row-gap: 4px; } - .recent-list .row-index { grid-column: 1; grid-row: 1; } - .recent-list .row-name { grid-column: 1; grid-row: 2; } - .recent-line { grid-column: 1 / -1; grid-row: 3; white-space: normal; } - .recent-list .row-meta { grid-column: 2; grid-row: 1; } - .highlights { grid-template-columns: minmax(0, 1fr); } - .release-entry summary { grid-template-columns: minmax(0, 1fr) auto; } - .release-detail { padding-left: 0; margin-left: 0; } - .machine { padding: 16px; } -} - -/* --- The hub (/hub): tabs, the Simple / Technical switch, roadmap items as panels ------------------- */ - -.hub-bar { display: flex; flex-wrap: wrap; align-items: center; justify-content: space-between; gap: 16px; margin-top: 32px; } -.hub-tabs { margin-bottom: 0; } -.hub-detail { display: flex; gap: 8px; } -/* A link to a tab (/hub#roadmap) lands with the tabs in view under the top bar. */ -.hub-panel { margin-top: 40px; scroll-margin-top: calc(var(--nav) + 120px); } -.js .hub-panel:not(.is-active) { display: none; } -/* Simple shows `plain`, Technical shows `dev`; without the switch (no JavaScript) Simple reads. */ -.hub .hub-dev { display: none; } -:root[data-detail="dev"] .hub .hub-dev { display: block; } -:root[data-detail="dev"] .hub .hub-plain { display: none; } -.hub-lead { max-width: 60ch; font-size: var(--text-heading); line-height: var(--text-heading-line); color: var(--ink); } -.hub-block { margin-top: 56px; } -.hub-block > .title { margin-bottom: 16px; } -.hub-intro { margin-bottom: 16px; color: var(--ink-soft); max-width: var(--measure); } -.hub-rows .row > a { grid-template-columns: var(--index) minmax(0, 1fr) auto; align-items: baseline; } -.hub-row-body { display: grid; gap: 4px; min-width: 0; } -.hub-row-title { font-size: clamp(18px, 1.8vw, 22px); font-weight: 500; color: var(--ink); } -.hub-row-body .hub-plain, .hub-row-body .hub-dev { color: var(--ink-soft); font-size: var(--text-ui); max-width: 80ch; } -.hub-rows .row-meta { max-width: 16rem; } -.hub-section { margin-top: 48px; } -.hub-section-head { display: flex; flex-wrap: wrap; align-items: baseline; gap: 8px 20px; } -.hub-items { display: grid; grid-template-columns: repeat(auto-fill, minmax(min(100%, 340px), 1fr)); gap: 8px; margin-top: 16px; } -.hub-item { - display: flex; flex-direction: column; gap: 10px; padding: 18px 20px; scroll-margin-top: calc(var(--nav) + 24px); - background: var(--panel); border: var(--block-outline) solid var(--outline); box-shadow: var(--panel-edges); -} -.hub-item:target { box-shadow: var(--panel-edges), 0 0 0 3px var(--accent); } -.hub-item-meta { display: flex; flex-wrap: wrap; align-items: center; gap: 6px; } -.hub-item-meta .badge { margin-right: 0; } -.hub-ongoing { font: var(--text-micro) / 1 var(--mono); letter-spacing: var(--text-micro-tracking); color: var(--muted); } -.hub-item-title { font-size: var(--text-heading); line-height: var(--text-heading-line); } -.hub-item .hub-plain, .hub-item .hub-dev { font-size: var(--text-ui); color: var(--ink-soft); } -.hub-progress { font: var(--text-micro) / 1.4 var(--mono); letter-spacing: var(--text-micro-tracking); color: var(--ink); } -.hub-links { display: flex; flex-wrap: wrap; gap: 6px; margin-top: auto; padding-top: 4px; } -.hub-link { - display: inline-flex; gap: 6px; align-items: baseline; padding: 3px 7px; font: var(--text-micro) / 1.3 var(--mono); - color: var(--ink-soft); background: var(--well); box-shadow: 0 0 0 var(--block-outline) var(--outline); -} -.hub-link span { color: var(--muted); } -.hub-link:hover { color: var(--accent); } -.hub-link.is-merged { background: color-mix(in srgb, var(--success) 18%, var(--well)); } -.hub-link.is-in-review { background: color-mix(in srgb, var(--accent) 18%, var(--well)); } -.hub-link.is-in-progress { background: color-mix(in srgb, var(--warn) 22%, var(--well)); } -.hub-link.is-merged span, .hub-link.is-in-review span, .hub-link.is-in-progress span { color: var(--ink); } -.hub-cards { display: grid; grid-template-columns: repeat(auto-fill, minmax(min(100%, 260px), 1fr)); gap: 8px; } -.hub-cards .highlight { justify-content: flex-start; } -.hub-cards h3 { font-size: var(--text-heading); line-height: var(--text-heading-line); } -.hub-cards p { color: var(--ink-soft); font-size: var(--text-ui); } -.hub-actions { display: flex; flex-wrap: wrap; gap: 8px; margin-top: 16px; } -.hub-cards .hub-actions { margin-top: auto; } -.hub-rules { list-style: decimal; padding-left: 20px; max-width: var(--measure); } -.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; } -} - -/* --- Hub: votes, the report and suggestion forms, the contributors ---------------------- */ -.hub-vote { margin-left: auto; } -.hub-vote-count { margin-left: -2px; } -.hub-vote-count:empty { display: none; } -.hub-form { display: grid; gap: 16px; max-width: 46rem; margin-top: 8px; } -.hub-form-pair { display: grid; grid-template-columns: repeat(2, minmax(0, 1fr)); gap: 16px; } -.hub-field { display: grid; gap: 6px; font-size: var(--text-label); color: var(--ink-soft); } -.hub-field input, .hub-field textarea, .hub-field select { - width: 100%; min-height: 36px; padding: 8px 10px; font: var(--text-ui) / 1.4 var(--font); color: var(--ink); - background: var(--well); border: 0; box-shadow: 0 0 0 var(--block-outline) var(--outline); -} -.hub-field textarea { resize: vertical; } -.hub-field input:focus-visible, .hub-field textarea:focus-visible, .hub-field select:focus-visible { outline: 1px solid var(--accent); outline-offset: 2px; } -.hub-field input::placeholder, .hub-field textarea::placeholder { color: var(--muted); } -.hub-trap { position: absolute; left: -10000px; width: 1px; height: 1px; overflow: hidden; } -.hub-form-foot { display: flex; flex-wrap: wrap; align-items: center; gap: 8px 16px; } -.hub-form-foot [data-status] { color: var(--ink); } -.hub-form-foot .button:disabled { opacity: 0.4; cursor: default; } -.hub-form-closed { color: var(--ink-soft); } -@media (max-width: 720px) { - .hub-form-pair { grid-template-columns: minmax(0, 1fr); } -} - -/* The registry (/mods): a search and the kind filter, rows as panels, then a page per project. */ -.mod-actions { display: flex; flex-wrap: wrap; gap: 8px; margin-top: 24px; } -.mod-tools { display: flex; flex-wrap: wrap; align-items: center; gap: 16px; margin-top: 32px; } -.mod-tools .release-filter { margin-top: 0; } -.mod-search { - height: 36px; min-width: min(320px, 100%); padding: 0 12px; font: var(--text-ui) / 1 var(--sans); color: var(--ink); - background: var(--well); border: var(--block-outline) solid var(--outline); border-radius: 0; -} -.mod-search:focus-visible { outline: 2px solid var(--accent); outline-offset: 0; } -.mod-list { display: grid; gap: 8px; } -.mod-row { - display: grid; grid-template-columns: 48px minmax(0, 1fr) auto; align-items: center; gap: 16px; padding: 14px 20px; - background: var(--panel); border: var(--block-outline) solid var(--outline); box-shadow: var(--panel-edges); color: var(--ink); text-decoration: none; -} -.mod-row:hover { background: var(--raised); } -.mod-row:hover .mod-name { color: var(--accent); } -.mod-icon { - display: grid; place-items: center; width: 48px; height: 48px; flex: none; image-rendering: pixelated; - font: 600 22px / 1 var(--pixel); color: var(--ink); background: var(--well); box-shadow: 0 0 0 var(--block-outline) var(--outline); -} -.mod-text { display: grid; gap: 4px; min-width: 0; } -.mod-name { font: 500 var(--text-heading) / 1.2 var(--pixel); } -.mod-summary { color: var(--muted); font-size: var(--text-ui); overflow: hidden; text-overflow: ellipsis; white-space: nowrap; } -.mod-side { display: grid; justify-items: end; gap: 6px; } -.mod-side .badge { margin-right: 0; } -.mod-version { font: var(--text-micro) / 1.4 var(--mono); letter-spacing: var(--text-micro-tracking); color: var(--muted); } -.mod-empty a { color: var(--accent); } -.badge-signed { background: color-mix(in srgb, var(--success) 22%, var(--panel)); color: var(--ink); } -.badge-unsigned { background: color-mix(in srgb, var(--warn) 24%, var(--panel)); color: var(--ink); } -.mod-page { display: grid; gap: 16px; max-width: calc(var(--measure) + 240px); } -.mod-page .heading { margin-top: 24px; } -.mod-head { display: grid; grid-template-columns: 96px minmax(0, 1fr); gap: 24px; align-items: start; } -.mod-owners { display: flex; flex-wrap: wrap; align-items: center; gap: 8px; margin: 4px 0 0; } -.mod-owner { display: inline-flex; align-items: center; gap: 6px; } -.mod-owner img { border-radius: 50%; } -.mod-head .mod-icon { width: 96px; height: 96px; font-size: 44px; } -.mod-head .page-title { margin-top: 0; } -.mod-badges { margin-top: 16px; } -.mod-caps, .mod-steps, .mod-versions { display: grid; gap: 8px; padding-left: 20px; font-size: var(--text-ui); } -.mod-caps li::marker, .mod-steps li::marker { color: var(--accent); } -.mod-file { display: grid; grid-template-columns: max-content minmax(0, 1fr); gap: 8px 16px; font-size: var(--text-ui); } -.mod-file dt { color: var(--muted); } -.mod-file code, .mod-steps code { font-family: var(--mono); font-size: 13px; overflow-wrap: anywhere; } -.mod-links { display: flex; flex-wrap: wrap; gap: 24px; margin-top: 24px; } -/* /mods/submit */ -.mod-form { display: grid; gap: 24px; max-width: var(--measure); margin-top: 32px; } -.mod-form fieldset { display: grid; gap: 16px; margin: 0; padding: 0; border: 0; } -.mod-form legend { padding: 0; margin-bottom: 8px; } -.mod-field { display: grid; gap: 6px; } -.mod-label { font-size: var(--text-ui); font-weight: 500; } -.mod-form .mod-search { width: 100%; } -.mod-form textarea.mod-search { height: auto; padding: 10px 12px; line-height: 1.5; resize: vertical; } -.mod-check { display: flex; gap: 10px; align-items: flex-start; font-size: var(--text-ui); } -.mod-auth { margin-top: 24px; } -.mod-error { color: var(--danger); font-size: var(--text-ui); } -.js .no-script { display: none; } -@media (max-width: 640px) { - .mod-row { grid-template-columns: 40px minmax(0, 1fr); } - .mod-side { grid-column: 2; justify-items: start; } - .mod-icon { width: 40px; height: 40px; } - .mod-head { grid-template-columns: 1fr; } -} diff --git a/website/src/versions.js b/website/src/versions.js deleted file mode 100644 index b2483b4ed..000000000 --- a/website/src/versions.js +++ /dev/null @@ -1,59 +0,0 @@ -// Horizon's release tags (docs/versioning.md). From 0.2 the game is vX.Y.Z and the launcher launcher@X.Y.Z; -// before, vYYYY.MM.DD[.N] and launcher-vX.Y.Z. Every 0.2 tag is newer than every tag from before. Shared by -// build.mjs and main.js, and the same order as the launcher's and tools/release_train.py's. - -const SEMVER = /^(\d+)\.(\d+)\.(\d+)(?:-([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?$/; -// Semver's majors stay below this; a date tag's first number is a year. -const FIRST_YEAR = 1000; - -const semver = (version) => { - const m = SEMVER.exec(version); - return m && Number(m[1]) < FIRST_YEAR ? m : null; -}; - -export const isGame = (tag) => /^v\d{4}\.\d{1,2}\.\d{1,2}(\.\d+)?$/.test(tag) || (tag.startsWith("v") && !!semver(tag.slice(1))); - -// The version in a launcher tag (launcher@0.2.0, launcher-v0.16.0), or null. -export function launcherVersion(tag) { - if (tag.startsWith("launcher@") && semver(tag.slice(9))) return tag.slice(9); - const old = /^launcher-v(\d+\.\d+\.\d+)$/.exec(tag); - return old ? old[1] : null; -} - -export const isLauncher = (tag) => launcherVersion(tag) !== null; - -// [line, numbers, pre-release]: tags from before 0.2 by their numbers, then 0.2 tags in semver's order. -function key(tag) { - const version = tag.startsWith("launcher@") ? tag.slice(9) : tag.startsWith("v") ? tag.slice(1) : null; - const m = version !== null && semver(version); - if (!m) return [0, (tag.match(/\d+/g) || []).map(Number), []]; - const pre = m[4] ? m[4].split(".").map((id) => (/^\d+$/.test(id) ? [0, Number(id)] : [1, id])) : null; - return [1, [m[1], m[2], m[3]].map(Number), pre]; -} - -const cmpList = (a, b, cmp) => { - for (let i = 0; i < Math.min(a.length, b.length); i++) { - const d = cmp(a[i], b[i]); - if (d) return d; - } - return a.length - b.length; -}; -const cmpNumbers = (a, b) => { - const strip = (l) => { const c = [...l]; while (c.length && c[c.length - 1] === 0) c.pop(); return c; }; - return cmpList(strip(a), strip(b), (x, y) => x - y); -}; -const cmpId = ([ka, va], [kb, vb]) => ka - kb || (ka ? (va < vb ? -1 : va > vb ? 1 : 0) : va - vb); - -// Negative when tag a is older than tag b. -export function compareTags(a, b) { - const [la, na, pa] = key(a); - const [lb, nb, pb] = key(b); - if (la !== lb) return la - lb; - const d = cmpNumbers(na, nb); - if (d || !la) return d; - // A release follows its pre-releases. - if (!pa || !pb) return (pa ? -1 : 0) - (pb ? -1 : 0); - return cmpList(pa, pb, cmpId); -} - -export const newestFirst = (a, b) => compareTags(b, a); diff --git a/website/src/versions.test.mjs b/website/src/versions.test.mjs deleted file mode 100644 index eed334429..000000000 --- a/website/src/versions.test.mjs +++ /dev/null @@ -1,21 +0,0 @@ -// node --test website/src/ (npm test in website/) -import { test } from "node:test"; -import assert from "node:assert/strict"; -import { compareTags, isGame, isLauncher, launcherVersion, newestFirst } from "./versions.js"; - -test("0.2 tags follow every tag from before", () => { - const order = ["v2026.10.19.15", "v2026.10.21", "v0.2.0-beta.1", "v0.2.0", "v0.2.1-beta", "v0.2.1-beta.2", - "v0.2.1-beta.11", "v0.2.1-rc.1", "v0.2.1", "v0.2.9", "v0.2.10", "v0.3.0-1", "v0.3.0-alpha", "v0.3.0", "v1.0.0"]; - assert.deepEqual([...order].reverse().sort(compareTags), order); - assert.deepEqual(["launcher-v0.16.0", "launcher@0.2.0", "launcher-v0.17.0", "launcher@0.2.1"].sort(newestFirst), - ["launcher@0.2.1", "launcher@0.2.0", "launcher-v0.17.0", "launcher-v0.16.0"]); - assert.equal(compareTags("v2026.10.19", "v2026.10.19.0"), 0); -}); - -test("game and launcher tags never mix", () => { - for (const tag of ["v0.2.0", "v0.3.0-rc.1", "v2026.10.21", "v2026.10.19.15"]) assert.ok(isGame(tag), tag); - for (const tag of ["launcher@0.2.0", "launcher-v0.16.0", "v0.2", "vnext", "v2026.10.21-x"]) assert.ok(!isGame(tag), tag); - assert.equal(launcherVersion("launcher@0.2.0"), "0.2.0"); - assert.equal(launcherVersion("launcher-v0.16.0"), "0.16.0"); - assert.ok(!isLauncher("v0.2.0") && !isLauncher("launcher-vnext")); -}); diff --git a/xtask/src/main.rs b/xtask/src/main.rs index 2682b1f82..b71910da4 100644 --- a/xtask/src/main.rs +++ b/xtask/src/main.rs @@ -10,7 +10,7 @@ //! (`cargo build --release -p horizon-client --no-default-features`, without sound or controllers) //! as horizon-engine, with horizon-prepare and horizon-server from beside it and the same sources. //! -//! `tokens`: writes `website/src/tokens.css`, the design tokens of `crates/horizon-theme` as CSS +//! `tokens`: writes `crates/horizon-theme/tokens.css`, the design tokens of `crates/horizon-theme` as CSS //! custom properties (a horizon-theme test fails when the file is out of date). //! //! `icons`: renders the icon masters in `docs/media/brand` (with `rsvg-convert`, from librsvg) @@ -79,9 +79,9 @@ fn git(repo: &Path, args: &[&str]) -> Result, String> { } fn tokens() -> Result<(), String> { - let path = Path::new(env!("CARGO_MANIFEST_DIR")).join("../website/src/tokens.css"); + let path = Path::new(env!("CARGO_MANIFEST_DIR")).join("../crates/horizon-theme/tokens.css"); fs::write(&path, horizon_theme::css()).map_err(|e| format!("{}: {e}", path.display()))?; - println!("wrote website/src/tokens.css"); + println!("wrote crates/horizon-theme/tokens.css"); Ok(()) } @@ -195,7 +195,7 @@ fn icons() -> Result<(), String> { &repo.join("crates/horizon-theme/icons/horizon-64.png"), &render(&square, (64, 64))?, )?; - // Avatars and the website's icons. + // Avatars, and the website's icons (horizon-site copies docs/media/brand/web/ into its public/). let avatar = brand.join("avatar.svg"); for (svg, size, out) in [ ( @@ -203,15 +203,15 @@ fn icons() -> Result<(), String> { 500, "docs/media/brand/social/github-avatar-500.png", ), - (&avatar, 180, "website/public/apple-touch-icon.png"), - (&square, 32, "website/public/favicon-32.png"), + (&avatar, 180, "docs/media/brand/web/apple-touch-icon.png"), + (&square, 32, "docs/media/brand/web/favicon-32.png"), (&square, 1024, "docs/media/brand/icon-1024.png"), (&macos, 1024, "docs/media/brand/icon-macos-1024.png"), ] { write(&repo.join(out), &render(svg, (size, size))?)?; } write( - &repo.join("website/public/favicon.svg"), + &repo.join("docs/media/brand/web/favicon.svg"), &fs::read(&square).map_err(|e| format!("{}: {e}", square.display()))?, )?; println!("wrote packaging/icons, the window icon, the avatars and the website's icons");