Skip to main content

Changelog

One line per feature. Nothing has been released yet, so everything is under Unreleased; a release is a v* tag whose notes become that version's section.

Unreleased​

Scripting​

  • Rune is the only scripting language; a deterministic libm-backed math module.
  • Exported script properties: pub fn exports(), script = { source, props }, edited in the inspector.
  • Script debugger: breakpoints, stepping, call frames with locals.
  • Debug Adapter Protocol on balaur run --debug <port>; --debug-wait holds the boot.
  • Component handles: node.body2d.apply_impulse(x, y), plus get/set/has/remove.
  • script.attempt, mod files from disk and packs, balaur api.
  • ScriptHost::call_in(path, function, args) for project-level hooks.
  • The script API documents itself: every module, function, component and asset type.

Scenes and assets​

  • Prefabs: instance builds another scene as a node's children, with overrides per path.
  • Prefab ids are prefixed by the instance's, so two instances never collide.
  • Overrides patch rather than replace, and reach components, the transform and script props.
  • Component tags and presets, project-defined in presets.toml.
  • Binary assets in packs (format 2, sha256-verified); assets mode in project.toml.
  • mesh (OBJ, .glb, .gltf, inline) and heightfield asset types.
  • scene.component_properties(name, params): what a component's apply would receive.
  • Node paths accept ..; node:set_parent(other) keeps the world pose.

Rendering and animation​

  • Shaders in WESL, linked to WGSL at run time; material asset type; sprite takes a material.
  • sprite component: textured 2D quads with sheets.
  • polygon component: a textured 2D polygon, GPU-skinned to a rig.
  • 2D and 3D skeletal animation: bone2d, bone3d, the skeleton module, CPU skinning.
  • modifier2d: look_at and two_bone_ik, run after the clip.
  • rotation clip tracks take quaternion keys.
  • examples/rig is one figure: the arm's bone chain branches off the body's top bone rather than hanging beside it from the character root, so one clip drives one skeleton.
  • New 3D shapes (capsule, cylinder, cone, plane, mesh) and 2D shapes (capsule, polyline).

Physics​

  • The rest of Rapier, in both dimensions (docs/PLAN-rapier.md): every rigid-body property rapier has — damping, gravity scale, axis locks, CCD, dominance, mass, per-body sleep, forces and torques.
  • Joints: fixed, revolute, prismatic, spherical, rope, spring, pin-slot and generic, with motors, limits, break_force, and impulse or reduced-coordinate solvers.
  • Inverse kinematics on a reduced-coordinate chain: physics3d.solve_ik.
  • Character controllers: character3d / character2d and move_character, sliding, stepping, slope limits, ground snapping, and pushing what they walk into.
  • The whole query pipeline: raycasts, shape casts, point, shape and box queries, pairwise distance and time of impact, filtered by body kind, layers, an excluded node or a script predicate.
  • Collision and contact-force events reach the node's script as on_collision_start, on_collision_stop and on_contact_force; a broken joint as on_joint_break.
  • The three physics hooks — filter_contact, filter_overlap, modify_contacts — and one-way platforms.
  • New colliders: 3D capsule, cylinder, cone, triangle, segment, halfspace, trimesh, convex hull, convex decomposition, polyline, heightfield, voxels, voxelized and mesh-fitted; 2D gained all of them but the solids.
  • Colliders carry offsets, 32 collision layers, solver layers, combine rules, contact skin and per-collider mass; one on a child node belongs to the body above it, which is how a body carries several shapes.
  • Voxel terrain is editable while the game runs: physics3d.set_voxel, and collider_mesh tessellates any grid for drawing.
  • A ray-cast vehicle: vehicle3d with wheel3d children, suspension tuning, engine force, brake and steering.
  • geometry3d: convex hulls, convex decomposition, voxelising, cutting a mesh with a plane, boolean intersection, and separating a mesh into its pieces.
  • Physics debug draw (physics.set_debug_draw), the solver's own tuning through [physics] in project.toml or physics.set_tuning, quarantine reporting and step counters.
  • Two build-time choices: parallel runs rapier's coloured solver on rayon, and f64 swaps in double precision for worlds tens of kilometres across.

Determinism and networking​

  • One fixed 60 Hz step (Stage::FixedUpdate, --fixed-tick).
  • Per-tick digest with first_divergence, --trace-digest, and a cross-OS CI check.
  • Record and replay: run --record, replay --verify / --entries-at.
  • Rollback on one machine: snapshot ring, input journal, re-simulation from a late input.
  • Rollback across spawns: run-time nodes get stable ids and the node set is restored.
  • Two engines play in lockstep over a socket: NetSession over a Transport trait.
  • Websockets carry binary frames and negotiate permessage-deflate.
  • App::add_replay_setup: loaded state goes in the recording's header, restored before tick one.

Batteries​

  • Input actions: [input.actions] binds a name to keys, mouse, pad buttons, axes and key pairs.
  • Rebinding through input.bind, saved per user; a recording carries the bindings it used.
  • Save games: save.write / read / slots / remove, atomic, versioned, with migrations.
  • Localization: strings/<locale>.toml, strings.tr with interpolation and plural forms.
  • Game UI containers: row, column and a panel that lays out, with padding, gap, align.
  • Widget focus, keyboard and pad, with focusable, on_focus and the ui.focus_* verbs.
  • widget_theme asset: fill, stroke, radius and padding per widget kind, inherited.
  • Audio buses: [audio.buses], routing per sound, audio.set_bus_volume.
  • Audio events: audio/events.toml, variations taken in turn.

Editor​

  • Undo/redo, collapsible inspector sections, node copy and paste, --state dock:<name>.
  • Prefabs: instance rows in the tree, edits written as overrides, placed from the palette.
  • Rig and Polygon tools; bones pick and grow in the 3D viewport.
  • Ray picking, the Assets dock's filesystem verbs, in-editor linting with a language server.
  • Profiler dock; balaur run --timings prints per-stage mean, worst and share of a frame.
  • Showcase pipeline: scripts/showcase.sh retakes the website's images and clips.

Breaking​

  • shape/body/collider are now shape3d/body3d/collider3d; script APIs moved to physics3d.
  • color is a property of shape3d, shape2d, sprite and particles, not a component.
  • Luau is removed: .luau, language = "luau"/"mixed" and balaur_script_luau are gone.
  • animation.is_running is animation.is_tween_running.
  • ui.select is ui.dropdown.