Files
horizon-airdef/crates/horizon-mod-sdk/wit/horizon.wit
T
Ludovic Marie 670e055f4a Horizon mod SDK: the horizon:mods WIT contract, a Rust SDK and an example mod
horizon-mod-sdk wraps wit-bindgen: a Mod trait with default hooks and export_mod!.
coords-hud shows coordinates, facing and the time of day, with /where and /coords.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-15 14:01:57 +02:00

98 lines
2.8 KiB
Plaintext

/// The contract between Horizon and its mods (docs/mods.md).
///
/// A mod is a WebAssembly component targeting the `mod` world. Each imported
/// interface but `log` is a capability: the mod's manifest lists the ones it
/// uses, the player sees them before turning the mod on, and the game refuses
/// a component that imports one its manifest does not declare.
package horizon:mods@0.1.0;
/// The mod's log, in the game's log under the mod's id. Always granted.
interface log {
enum level {
debug,
info,
warn,
error,
}
write: func(level: level, message: string);
}
/// Capability `game-read`: the local player and the world clock.
interface game {
record player {
x: f64,
y: f64,
z: f64,
/// Degrees, as F3 shows them.
yaw: f32,
pitch: f32,
health: f32,
food: u32,
/// `minecraft:overworld`, `minecraft:the_nether`, ...
dimension: string,
}
record clock {
/// Ticks since the world was created.
game-time: u64,
/// 24000 ticks per day; 0 is 6:00 on the first day.
day-time: u64,
}
/// None on the title screen.
get-player: func() -> option<player>;
get-clock: func() -> option<clock>;
}
/// Capability `chat`: messages only the local player sees.
interface chat {
/// Shown in chat after the mod's name, like a system message.
show: func(text: string);
}
/// Capability `hud`: one panel of text lines per mod, drawn by the game
/// every frame until the mod changes or clears it (no call per frame).
interface hud {
enum corner {
top-left,
top-right,
bottom-left,
bottom-right,
}
record line {
text: string,
/// 0xRRGGBB.
color: u32,
}
set-panel: func(corner: corner, lines: list<line>);
clear: func();
}
/// What the game calls. Only the hooks `init` asks for are ever called.
interface events {
record registration {
/// Chat commands, without the slash. A name vanilla already uses is
/// refused (vanilla's command runs).
commands: list<string>,
/// Call `tick` every game tick (20 per second while playing).
tick: bool,
/// Call `frame` every rendered frame. Budget: 0.1 ms.
frame: bool,
/// Call `chat` for each chat line the player receives.
chat: bool,
}
/// Once, after loading. An error keeps the mod off and is shown.
init: func() -> result<registration, string>;
tick: func(tick: u64);
frame: func(seconds: f32);
/// `/name args`: ok(some(text)) is shown as feedback, err(text) in red.
command: func(name: string, args: string) -> result<option<string>, string>;
chat: func(text: string);
}
world horizon-mod {
import log;
import game;
import chat;
import hud;
export events;
}