rgame 0.2.0 → 0.3.0

data/examples/menu_navigation/main.rb

@@ -0,0 +1,365 @@
+# frozen_string_literal: true
+
+# Menu navigation — more than one screen, and settings that are real.
+#
+# Run it:
+#
+#   ruby examples/menu_navigation/main.rb
+#
+# Up and down move the focus, Enter or A chooses, Escape goes back. On the
+# settings screen **left and right change the value under the cursor**. Quit,
+# run it again, and the settings are where you left them. It exercises:
+#   - Scene::SceneStack — push, pop and replace, and the difference between them;
+#   - UI::OptionButton — a menu row whose value is chosen from a list;
+#   - Util::SaveFile holding settings rather than a saved game;
+#   - RGame::Game's fullscreen, scale_mode and audio volume, driven from a menu.
+#
+# ## Push and replace are different questions, and this file asks both
+#
+# A SceneStack updates only its top scene but **draws all of them**, and that is
+# what makes it a stack rather than a variable holding the current screen. So
+# the choice between pushing and replacing is really one question: *should the
+# thing underneath still be there?*
+#
+# Settings is **pushed** over the title, and the title keeps drawing behind the
+# panel — that is why the settings screen needs a panel at all. Choosing Back
+# **pops**, and the title is still exactly as it was, because it was never taken
+# apart. Play **replaces** the title, because a title screen behind a running
+# game is nothing but a thing to draw.
+#
+# ## Nothing switches scenes while the tree is being walked
+#
+# `Shell#go` records a request and `Shell#on_update` carries it out. A menu item
+# activates during `control`, which is the middle of a traversal of the very
+# subtree the switch is about to take apart, and unbuilding a tree while walking
+# it is the sort of bug that shows up somewhere else entirely.
+#
+# Deferring costs one line and buys a second thing for free: two requests in one
+# tick — the Back item and Escape both firing — collapse into one transition
+# rather than two pops.
+#
+# ## Settings apply now and persist immediately
+#
+# Each row applies its change the moment it is made: the volume you hear is the
+# volume shown, and the window changes as you move the cursor. That is what a
+# settings screen is *for*, and it removes the whole apply/cancel/revert
+# question this example has no business answering.
+#
+# The file is written on every change too. A settings screen changes a handful
+# of values a handful of times, and `SaveFile` writes atomically, so there is
+# nothing to be gained by batching it and one less rule about when a save
+# happens.
+#
+# ## A settings file is untrusted input
+#
+# `Settings#load` checks every value against the list the menu actually offers
+# and falls back to the default for anything else. That is not defensive habit.
+# `Game#scale_mode=` raises on a mode it does not know, so a hand-edited file,
+# a copy from a newer version of the game, or a `null` where a number should be
+# is otherwise a game that cannot be started — and the player's only fix is to
+# find and delete a file nobody told them about.
+#
+# `UI::OptionButton#value=` has the same shape for the same reason: a value the
+# list no longer offers leaves the row where it is instead of raising.
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __dir__)
+require 'rgame/game'
+
+UI = RGame::Engine::UI
+
+# The same 8:5 `examples/fullscreen` uses, and for the same reason: this screen
+# offers a scale mode as a setting, so the four choices have to look like four
+# different things. A logical size that matched the display's aspect ratio would
+# make `:stretch` and `:letterbox` identical, and one that divided it evenly
+# would bring `:integer` in with them.
+WIDTH  = 512
+HEIGHT = 320
+ASSETS = File.expand_path('../assets', __dir__)
+LOCALES = File.expand_path('locales', __dir__) # the text on screen: locales/en.yml
+
+BLIP = 'blip.ogg'
+
+# The game's settings, backed by one JSON file.
+#
+# Plain Ruby and no node: settings are a value a scene reads, not a thing in the
+# tree. It is handed to the scenes that need it rather than reached for through
+# a global, which is also what lets a spec build one over a temporary directory.
+class Settings
+  # Everything about a setting in one place: what it is called, what it may be,
+  # what each value is written as, and what it falls back to. The menu builds
+  # its rows from this and `load` validates the file against it, so a row can
+  # never offer a value the file would reject, or the other way round.
+  #
+  # A label and what `display` returns are translation keys; a percentage is a
+  # number rather than a word, so it is a literal. The captions are made once
+  # per value, when a row is built, rather than inside a draw method — see
+  # UI::OptionButton, and Game/NoInterpolationInHotPath for why a label built
+  # while drawing is a bug rather than a style.
+  #
+  # **These live in a class rather than at the top of the file, and a proc is
+  # why.** A block written at the top level of a script captures that script's
+  # local variables — `game`, down at the bottom, among them — and a constant
+  # holding that block keeps them for the life of the process. The window is
+  # then never released, which shows up not as a leak but as a crash on the way
+  # out. Inside a class body there is no such scope to capture.
+  ROWS = {
+    fullscreen: { label: 'fullscreen', default: false,
+                  values: [false, true].freeze,
+                  display: ->(on) { on ? 'on' : 'off' } },
+    scale: { label: 'scale', default: :letterbox,
+             values: RGame::Engine::Presentation::MODES,
+             display: RGame::Engine::UI::OptionButton::DISPLAY },
+    volume: { label: 'volume', default: 75,
+              values: [0, 25, 50, 75, 100].freeze,
+              display: ->(percent) { RGame::Engine::Text.literal("#{percent}%") } }
+  }.freeze
+
+  def initialize(save)
+    @save = save
+    @values = load
+  end
+
+  def [](key) = @values.fetch(key)
+
+  # Writes the whole file on every change. See the note at the top of this file.
+  def []=(key, value)
+    @values[key] = value
+    @save.write(@values)
+  end
+
+  # Volume reaches the device as a gain, where 1.0 is unchanged.
+  def volume_gain = @values.fetch(:volume) / 100.0
+
+  private
+
+  # Anything the menu does not offer becomes the default. See "A settings file
+  # is untrusted input".
+  def load
+    stored = @save.read
+    ROWS.to_h do |key, row|
+      value = coerce(key, stored[key])
+      [key, row.fetch(:values).include?(value) ? value : row.fetch(:default)]
+    end
+  end
+
+  # JSON has no Symbol, so `:letterbox` comes back as `"letterbox"`. Converting
+  # here rather than at the call site keeps the rest of the file working in the
+  # values the game actually uses.
+  def coerce(key, value) = key == :scale && value.is_a?(String) ? value.to_sym : value
+end
+
+# The root: scene navigation, and the settings every screen shares.
+class Shell < RGame::Engine::Node2D
+  def initialize(settings:)
+    super()
+    @settings = settings
+    @stack = add_component(RGame::Engine::Scene::SceneStack.new)
+    @pending = nil
+  end
+
+  def on_add = show(:title)
+
+  # `push` keeps what is under it; `replace` does not; `pop` returns to it. Each
+  # one records the request and returns, for the reason at the top of this file.
+  def show(name) = @pending = [:push, name]
+  def swap(name) = @pending = [:replace, name]
+  def back = @pending = [:pop, nil]
+
+  # Runs after the active scene's own update has unwound, so the tree being
+  # rebuilt is not one the traversal is standing in.
+  def on_update(_dt)
+    return unless @pending
+
+    action, name = @pending
+    @pending = nil
+    case action
+    when :push then @stack.push(build(name))
+    when :replace then @stack.replace(build(name))
+    when :pop then @stack.pop
+    end
+  end
+
+  private
+
+  def build(name)
+    case name
+    when :title then TitleScene.new
+    when :settings then SettingsScene.new(settings: @settings)
+    when :play then PlayScene.new
+    end
+  end
+end
+
+# The title: a heading and three choices.
+#
+# The menu sits at a fixed inset rather than centred, which is the same
+# limitation `examples/game_menu` runs into — centring needs the region's size
+# and that only arrives at draw time. See docs/api/ui.md, "What this is not".
+class TitleScene < RGame::Engine::Node2D
+  MENU_X = 56
+  MENU_Y = 104
+  ITEM_WIDTH = 240
+  ITEM_HEIGHT = 34
+
+  def initialize(**)
+    super
+    @heading = RGame::Engine::Text.new('title.heading')
+    @help = RGame::Engine::Text.new('title.help')
+  end
+
+  def on_add
+    menu = add_node(UI::Menu.new(x: MENU_X, y: MENU_Y, scope: 'title',
+                                 layout: UI::Column.new(item_width: ITEM_WIDTH, item_height: ITEM_HEIGHT)))
+    menu.add(UI::PanelButton.new(label: 'play')).on_activated { root.swap(:play) }
+    menu.add(UI::PanelButton.new(label: 'settings')).on_activated { root.show(:settings) }
+    menu.add(UI::PanelButton.new(label: 'quit')).on_activated { root.context.close }
+  end
+
+  def on_draw(renderer, _view)
+    renderer.text(@heading, MENU_X, 44)
+    renderer.text(@help, MENU_X, 68)
+  end
+end
+
+# The settings screen, pushed over the title.
+#
+# It draws a panel because the title is still drawing behind it — that is the
+# visible half of what pushing rather than replacing means.
+class SettingsScene < RGame::Engine::Node2D
+  PANEL_X = 28
+  PANEL_Y = 28
+  PANEL_WIDTH = WIDTH - (PANEL_X * 2)
+  PANEL_HEIGHT = HEIGHT - (PANEL_Y * 2)
+  PADDING = 18
+  ITEM_WIDTH = PANEL_WIDTH - (PADDING * 2)
+  ITEM_HEIGHT = 34
+
+  def initialize(settings:, **)
+    super(**)
+    @settings = settings
+    @heading = RGame::Engine::Text.new('settings.heading')
+  end
+
+  def on_add
+    @menu = add_node(UI::Menu.new(x: PANEL_X + PADDING, y: PANEL_Y + PADDING + 30, scope: 'settings',
+                                  layout: UI::Column.new(item_width: ITEM_WIDTH, item_height: ITEM_HEIGHT)))
+    Settings::ROWS.each { |key, row| option(key, row) }
+    @menu.add(UI::PanelButton.new(label: 'back')).on_activated { root.back }
+  end
+
+  # Escape does what Back does, because that is what every player will try
+  # first. Both go through the same deferred request, so pressing one on the
+  # same tick as the other is still one pop.
+  def on_control(actions)
+    root.back if actions.pressed?(:ui_cancel)
+  end
+
+  def on_draw(renderer, _view)
+    renderer.nine_slice(:panel, PANEL_X, PANEL_Y, PANEL_WIDTH, PANEL_HEIGHT)
+    renderer.text(@heading, PANEL_X + PADDING, PANEL_Y + PADDING, z: 1)
+  end
+
+  private
+
+  # One row per setting, built from the same table the file is validated
+  # against, and starting on whatever is currently in force.
+  def option(key, row)
+    values = row.fetch(:values)
+    button = @menu.add(UI::OptionButton.new(label: row.fetch(:label), values: values, display: row.fetch(:display),
+                                            index: values.index(@settings[key]) || 0))
+    button.on_changed { |value| change(key, value) }
+  end
+
+  def change(key, value)
+    @settings[key] = value
+    apply(key, value)
+  end
+
+  # `root.context` is the Game. A node may not *name* RGame::Core, but it may
+  # call methods on an object it is handed — the same duck-typing it uses on a
+  # renderer, and what `examples/fullscreen` does with the same object.
+  def apply(key, value)
+    game = root.context
+    case key
+    when :fullscreen then game.fullscreen = value
+    when :scale then game.scale_mode = value
+    when :volume then game.audio.volume = value / 100.0
+    end
+  end
+end
+
+# Somewhere for the settings to be true: a marker sweeping the view, and a sound
+# on demand so the volume is something you can hear rather than read.
+class PlayScene < RGame::Engine::Node2D
+  MARGIN = 34
+  RADIUS = 16
+  SPEED = 0.6 # sweeps per second
+  DISC = RGame::Util::Color.new(180, 160, 240)
+  EDGE = RGame::Util::Color.new(120, 200, 255)
+  THICK = 3
+
+  def initialize(**)
+    super
+    @phase = 0.0
+    @help = RGame::Engine::Text.new('play.help')
+  end
+
+  def on_control(actions)
+    RGame::Engine::AudioBus.play_sound(BLIP) if actions.pressed?(:ui_confirm)
+    root.swap(:title) if actions.pressed?(:ui_cancel)
+  end
+
+  # The sweep is state advanced by dt, and where it lands on screen is worked
+  # out from the view at draw time — so it follows a window that grew without
+  # anything here listening for the change.
+  def on_update(dt)
+    @phase = (@phase + (dt * SPEED)) % 2.0
+  end
+
+  def on_draw(renderer, view)
+    right = view.width - MARGIN
+    bottom = view.height - MARGIN
+    renderer.line(MARGIN, MARGIN, right, MARGIN, thickness: THICK, color: EDGE)
+    renderer.line(MARGIN, bottom, right, bottom, thickness: THICK, color: EDGE)
+
+    travelled = @phase > 1.0 ? 2.0 - @phase : @phase # there, then back
+    renderer.circle(MARGIN + (travelled * (right - MARGIN)), view.height / 2,
+                    RADIUS, color: DISC)
+
+    renderer.text(@help, MARGIN, 16)
+  end
+end
+
+# `dir:` is normally left out and the file lands in the platform's own data
+# directory. It is overridable so a driven run writes somewhere disposable
+# instead of into the home directory of whoever is running it.
+settings = Settings.new(
+  RGame::Util::SaveFile.new('settings.json', game: 'rgame-examples',
+                                             dir: ENV.fetch('RGAME_SAVE_DIR', nil))
+)
+
+# Fullscreen and the scale mode are **constructor arguments**, not something
+# applied on the first tick: a window switched after it is up shows one windowed
+# frame first, and that flash reads as a broken startup. See
+# `examples/fullscreen`. Volume has no such problem — there is no first frame of
+# sound — so it is set on the device below.
+game = RGame::Game.new(
+  root: Shell.new(settings: settings),
+  caption: 'Menu navigation',
+  width: WIDTH,
+  height: HEIGHT,
+  media_root: ASSETS,
+  locales: LOCALES,
+  fullscreen: settings[:fullscreen],
+  scale_mode: settings[:scale]
+)
+
+game.audio.volume = settings.volume_gain
+
+# A nine-slice id names an *element of an atlas* rather than a file, so there is
+# nothing for the asset manager to resolve `:panel` to on demand. Registering
+# the atlas binds every element in it, which is what the menu rows draw
+# themselves from as well.
+game.renderer.register_ui_atlas(game.assets.ui_atlas('ui.json'))
+
+game.start

data/examples/music/locales/en.yml

@@ -0,0 +1,7 @@
+# The English table: every string this example draws.
+en:
+  help:
+    keys: Enter / A starts, Escape / B stops
+  status:
+    stopped: stopped — press Enter
+    playing: playing — press Enter again; listen for whether it restarts

data/examples/music/main.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+# Music — a looping track, started and stopped.
+#
+# Run it:
+#
+#   ruby examples/music/main.rb
+#
+# Enter or Space starts it; Escape stops it. Press start again while it is
+# already playing and **nothing happens** — that is deliberate, and the reason
+# is below. It exercises:
+#   - Core::Song — a streamed track with one voice, which can be stopped and
+#     asked whether it is playing, named by its path;
+#   - Engine::AudioBus play_music / stop_music;
+#   - Engine::AudioDirector, the same one `examples/sound` uses, subscribed by
+#     RGame::Game.
+#
+# ## A Song is not a Sample
+#
+# The two types exist so that this distinction is in the type rather than in a
+# convention. A `Sample` (see `examples/sound`) is decoded up front and gets a
+# fresh voice per play, so it layers and `playing?` would be meaningless. A
+# `Song` is *streamed* and has exactly one voice: it can be stopped, and it can
+# be asked whether it is running.
+#
+# ## Starting it twice does not restart it
+#
+# `Audio#play_music` returns early when the song is already playing. That is not
+# a nicety — a scene that emits `play_music` from `on_add` every time it is
+# entered would otherwise chop the track back to zero each time the player
+# walked through a door.
+#
+# **You confirm that by ear, not from this window.** Press Enter again while it
+# is playing: the bar below carries on, but that only proves *this scene* did
+# not reset its own timer. Whether the audio restarted is a fact about the
+# device, and the only honest way to check it is to listen for the track
+# jumping back to its opening bar.
+#
+# ## The bar is state, not a clock
+#
+# Nothing on a draw path reads a clock — `draw` is not called on a schedule and
+# a wall clock cannot be paused or reproduced (CLAUDE.md, "`draw` renders
+# state"). So the seconds below are accumulated from `dt` in `update`. It is a
+# rough playhead, not a reading off the song: it says how long ago this scene
+# *asked* for music, which is close enough to watch the 24s loop point go past
+# and listen for whether the wrap clicks. `tools/shrink_ogg.c` measures the seam
+# at 2.3% of the music's own largest step *and* the silence at each end at zero
+# — this is where you find out whether those numbers were telling the truth.
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __dir__)
+require 'rgame/game'
+
+WIDTH  = 640
+HEIGHT = 480
+ASSETS = File.expand_path('../assets', __dir__)
+LOCALES = File.expand_path('locales', __dir__) # the text on screen: locales/en.yml
+
+LOOP_SECONDS = 24.05 # the length of music.ogg; see examples/assets/README.md
+
+class Scene < RGame::Engine::Node2D
+  BAR_X = 60
+  BAR_Y = 260
+  BAR_W = 520
+  BAR_H = 26
+  TRACK  = RGame::Util::Color.new(40, 48, 66)
+  FILL   = RGame::Util::Color.new(120, 200, 255)
+
+  def initialize
+    super
+    @playing = false
+    @elapsed = 0.0
+    @help = RGame::Engine::Text.new('help.keys')
+    @stopped = RGame::Engine::Text.new('status.stopped')
+    @started = RGame::Engine::Text.new('status.playing')
+    @status = @stopped
+  end
+
+  def on_control(actions)
+    start if actions.pressed?(:ui_confirm)
+    stop if actions.pressed?(:ui_cancel)
+  end
+
+  def on_update(dt)
+    return unless @playing
+
+    @elapsed += dt
+  end
+
+  def on_draw(renderer, _view)
+    renderer.text(@help, 12, 12)
+    renderer.text(@status, 12, 34)
+
+    # Where the playhead sits inside one pass of the loop. It wraps at
+    # LOOP_SECONDS, so the bar resetting is the loop point going past.
+    renderer.rect(BAR_X, BAR_Y, BAR_W, BAR_H, color: TRACK)
+    position = @elapsed % LOOP_SECONDS
+    renderer.rect(BAR_X, BAR_Y, BAR_W * (position / LOOP_SECONDS), BAR_H, color: FILL)
+  end
+
+  private
+
+  # The bus call is unconditional on purpose: this node has no idea whether the
+  # track is already going, and does not need one. The guard lives in
+  # Audio#play_music, which owns the state that answers it.
+  #
+  # `@playing` below is *not* that state duplicated — it only drives the bar and
+  # the label, which is why the bar carrying on through a second press proves
+  # nothing about the device.
+  def start
+    RGame::Engine::AudioBus.play_music('music.ogg')
+    return if @playing
+
+    @playing = true
+    @status = @started
+  end
+
+  def stop
+    RGame::Engine::AudioBus.stop_music
+    @playing = false
+    @elapsed = 0.0
+    @status = @stopped
+  end
+end
+
+game = RGame::Game.new(
+  root: Scene.new,
+  caption: 'Music',
+  width: WIDTH,
+  height: HEIGHT,
+  media_root: ASSETS,
+  locales: LOCALES
+)
+
+game.start

data/examples/pathfinding/locales/en.yml

@@ -0,0 +1,17 @@
+# The English table: every string this example draws.
+en:
+  help:
+    cursor: Arrows / d-pad move the cursor; Return / Space / A sends the hero
+    route: "Dots: the route the search found. Lines: the route the hero walks"
+  status:
+    idle: Move the cursor to a tile and confirm
+    walking: "walking: %{waypoints}, %{cells}"
+    arrived: "arrived: %{waypoints}, %{cells}"
+    waypoints:
+      one: "%{count} waypoint"
+      other: "%{count} waypoints"
+    cells:
+      one: "%{count} cell"
+      other: "%{count} cells"
+    refused: no route there
+    refused_after: "no route there; %{route}"