Support reading VBX files in cart

Reviewed-on: #6

Cargo.toml

@@ -4,7 +4,7 @@ description = "An emulator for the Virtual Boy."
 repository = "https://git.virtual-boy.com/PVB/lemur"
 publish = false
 license = "MIT"
-version = "0.5.0"
+version = "0.7.1"
 edition = "2024"
 
 [dependencies]
@@ -16,11 +16,11 @@ bytemuck = { version = "1", features = ["derive"] }
 clap = { version = "4", features = ["derive"] }
 cpal = { git = "https://github.com/sidit77/cpal.git", rev = "66ed6be" }
 directories = "6"
-egui = { version = "0.30", features = ["serde"] }
+egui = { version = "0.32", features = ["serde"] }
-egui_extras = { version = "0.30", features = ["image"] }
+egui_extras = { version = "0.32", features = ["image"] }
-egui-toast = { git = "https://github.com/urholaukkarinen/egui-toast.git", rev = "d0bcf97" }
+egui-notify = "0.20"
-egui-winit = "0.30"
+egui-winit = "0.32"
-egui-wgpu = { version = "0.30", features = ["winit"] }
+egui-wgpu = { version = "0.32", features = ["winit"] }
 fixed = { version = "1.28", features = ["num-traits"] }
 gilrs = { version = "0.11", features = ["serde-serialize"] }
 hex = "0.4"
@@ -30,20 +30,23 @@ num-derive = "0.4"
 num-traits = "0.2"
 oneshot = "0.1"
 pollster = "0.4"
+rand = "0.9"
 rfd = { version = "0.15", default-features = false, features = ["xdg-portal", "async-std"]}
 rtrb = "0.3"
 rubato = "0.16"
 serde = { version = "1", features = ["derive"] }
 serde_json = "1"
-thread-priority = "1"
+sha2 = "0.10"
+thread-priority = "2"
 tokio = { version = "1", features = ["io-util", "macros", "net", "rt", "sync", "time"] }
 tracing = { version = "0.1", features = ["release_max_level_info"] }
 tracing-subscriber = { version = "0.3", features = ["env-filter"] }
-wgpu = "23"
+wgpu = "25"
 winit = { version = "0.30", features = ["serde"] }
+zip = "4"
 
 [target.'cfg(windows)'.dependencies]
-windows = { version = "0.59", features = ["Win32_System_Threading"] }
+windows = { version = "0.61", features = ["Win32_System_Threading"] }
 
 [build-dependencies]
 cc = "1"

src/app.rs

@@ -24,7 +24,8 @@ use crate::{
     persistence::Persistence,
     window::{
         AboutWindow, AppWindow, BgMapWindow, CharacterDataWindow, FrameBufferWindow, GameWindow,
-        GdbServerWindow, HotkeysWindow, InputWindow, ObjectWindow, RegisterWindow, WorldWindow,
+        GdbServerWindow, HotkeysWindow, InputWindow, ObjectWindow, RegisterWindow, TerminalWindow,
+        WorldWindow,
     },
 };
 
@@ -243,6 +244,10 @@ impl ApplicationHandler<UserEvent> for Application {
                 let registers = RegisterWindow::new(sim_id, &self.memory);
                 self.open(event_loop, Box::new(registers));
             }
+            UserEvent::OpenTerminal(sim_id) => {
+                let terminal = TerminalWindow::new(sim_id, &self.client);
+                self.open(event_loop, Box::new(terminal));
+            }
             UserEvent::OpenDebugger(sim_id) => {
                 let debugger =
                     GdbServerWindow::new(sim_id, self.client.clone(), self.proxy.clone());
@@ -293,10 +298,10 @@ impl ApplicationHandler<UserEvent> for Application {
 }
 
 struct WgpuState {
-    instance: Arc<wgpu::Instance>,
+    instance: wgpu::Instance,
-    adapter: Arc<wgpu::Adapter>,
+    adapter: wgpu::Adapter,
-    device: Arc<wgpu::Device>,
+    device: wgpu::Device,
-    queue: Arc<wgpu::Queue>,
+    queue: wgpu::Queue,
 }
 
 impl WgpuState {
@@ -304,21 +309,21 @@ impl WgpuState {
         #[allow(unused_variables)]
         let egui_wgpu::WgpuConfiguration {
             wgpu_setup:
-                egui_wgpu::WgpuSetup::CreateNew {
+                egui_wgpu::WgpuSetup::CreateNew(egui_wgpu::WgpuSetupCreateNew {
-                    supported_backends,
+                    instance_descriptor: wgpu::InstanceDescriptor { backends, .. },
                     device_descriptor,
                     ..
-                },
+                }),
             ..
         } = egui_wgpu::WgpuConfiguration::default()
         else {
             panic!("required fields not found")
         };
         #[cfg(windows)]
-        let supported_backends = wgpu::util::backend_bits_from_env()
+        let backends = wgpu::Backends::from_env()
             .unwrap_or((wgpu::Backends::PRIMARY | wgpu::Backends::GL) - wgpu::Backends::VULKAN);
-        let instance = wgpu::Instance::new(wgpu::InstanceDescriptor {
+        let instance = wgpu::Instance::new(&wgpu::InstanceDescriptor {
-            backends: supported_backends,
+            backends,
             ..wgpu::InstanceDescriptor::default()
         });
 
@@ -329,17 +334,14 @@ impl WgpuState {
         }))
         .expect("could not create adapter");
 
-        let trace_path = std::env::var("WGPU_TRACE");
+        let (device, queue) =
-        let (device, queue) = pollster::block_on(adapter.request_device(
+            pollster::block_on(adapter.request_device(&(*device_descriptor)(&adapter)))
-            &(*device_descriptor)(&adapter),
+                .expect("could not request device");
-            trace_path.ok().as_ref().map(std::path::Path::new),
-        ))
-        .expect("could not request device");
         Self {
-            instance: Arc::new(instance),
+            instance,
-            adapter: Arc::new(adapter),
+            adapter,
-            device: Arc::new(device),
+            device,
-            queue: Arc::new(queue),
+            queue,
         }
     }
 }
@@ -377,24 +379,30 @@ impl Viewport {
         ctx.set_fonts(fonts);
         ctx.style_mut(|s| {
             s.wrap_mode = Some(TextWrapMode::Extend);
-            s.visuals.menu_rounding = Default::default();
+            s.visuals.menu_corner_radius = Default::default();
             s.spacing.scroll = ScrollStyle::thin();
         });
         egui_extras::install_image_loaders(&ctx);
 
         let wgpu_config = egui_wgpu::WgpuConfiguration {
             present_mode: wgpu::PresentMode::AutoNoVsync,
-            wgpu_setup: egui_wgpu::WgpuSetup::Existing {
+            wgpu_setup: egui_wgpu::WgpuSetup::Existing(egui_wgpu::WgpuSetupExisting {
                 instance: wgpu.instance.clone(),
                 adapter: wgpu.adapter.clone(),
                 device: wgpu.device.clone(),
                 queue: wgpu.queue.clone(),
-            },
+            }),
             ..egui_wgpu::WgpuConfiguration::default()
         };
 
-        let mut painter =
+        let mut painter = pollster::block_on(egui_wgpu::winit::Painter::new(
-            egui_wgpu::winit::Painter::new(ctx.clone(), wgpu_config, 1, None, false, true);
+            ctx.clone(),
+            wgpu_config,
+            1,
+            None,
+            false,
+            true,
+        ));
 
         let mut info = ViewportInfo::default();
         let mut builder = app.initial_viewport();
@@ -513,6 +521,7 @@ pub enum UserEvent {
     OpenWorlds(SimId),
     OpenFrameBuffers(SimId),
     OpenRegisters(SimId),
+    OpenTerminal(SimId),
     OpenDebugger(SimId),
     OpenInput,
     OpenHotkeys,

src/emulator.rs

@@ -1,24 +1,24 @@
 use std::{
     collections::HashMap,
     fmt::Display,
-    fs::{self, File},
-    io::{Read, Seek, SeekFrom, Write},
     path::{Path, PathBuf},
     sync::{
         Arc, Weak,
         atomic::{AtomicBool, Ordering},
         mpsc::{self, RecvError, TryRecvError},
     },
+    time::Duration,
 };
 
 use anyhow::Result;
 use atomic::Atomic;
 use bytemuck::NoUninit;
-use egui_toast::{Toast, ToastKind, ToastOptions};
+use egui_notify::Toast;
 use tracing::{error, warn};
 
 use crate::{
     audio::Audio,
+    emulator::cart::Cart,
     graphics::TextureSink,
     memory::{MemoryRange, MemoryRegion},
 };
@@ -26,6 +26,7 @@ use shrooms_vb_core::{EXPECTED_FRAME_SIZE, Sim, StopReason};
 pub use shrooms_vb_core::{VBKey, VBRegister, VBWatchpointType};
 
 mod address_set;
+mod cart;
 mod shrooms_vb_core;
 
 #[derive(PartialEq, Eq, Hash, Clone, Copy, Debug)]
@@ -43,6 +44,13 @@ impl SimId {
             Self::Player2 => 1,
         }
     }
+    pub const fn from_index(index: usize) -> Option<Self> {
+        match index {
+            0 => Some(Self::Player1),
+            1 => Some(Self::Player2),
+            _ => None,
+        }
+    }
 }
 impl Display for SimId {
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
@@ -53,43 +61,6 @@ impl Display for SimId {
     }
 }
 
-struct Cart {
-    rom_path: PathBuf,
-    rom: Vec<u8>,
-    sram_file: File,
-    sram: Vec<u8>,
-}
-
-impl Cart {
-    fn load(rom_path: &Path, sim_id: SimId) -> Result<Self> {
-        let rom = fs::read(rom_path)?;
-
-        let mut sram_file = File::options()
-            .read(true)
-            .write(true)
-            .create(true)
-            .truncate(false)
-            .open(sram_path(rom_path, sim_id))?;
-        sram_file.set_len(8 * 1024)?;
-
-        let mut sram = vec![];
-        sram_file.read_to_end(&mut sram)?;
-        Ok(Cart {
-            rom_path: rom_path.to_path_buf(),
-            rom,
-            sram_file,
-            sram,
-        })
-    }
-}
-
-fn sram_path(rom_path: &Path, sim_id: SimId) -> PathBuf {
-    match sim_id {
-        SimId::Player1 => rom_path.with_extension("p1.sram"),
-        SimId::Player2 => rom_path.with_extension("p2.sram"),
-    }
-}
-
 pub struct EmulatorBuilder {
     rom: Option<PathBuf>,
     commands: mpsc::Receiver<EmulatorCommand>,
@@ -169,8 +140,9 @@ pub struct Emulator {
     renderers: HashMap<SimId, TextureSink>,
     messages: HashMap<SimId, mpsc::Sender<Toast>>,
     debuggers: HashMap<SimId, DebugInfo>,
+    stdouts: HashMap<SimId, mpsc::Sender<String>>,
     watched_regions: HashMap<MemoryRange, Weak<MemoryRegion>>,
-    eye_contents: Vec<u8>,
+    eye_contents: [Vec<u8>; 2],
     audio_samples: Vec<f32>,
     buffer: Vec<u8>,
 }
@@ -195,8 +167,9 @@ impl Emulator {
             renderers: HashMap::new(),
             messages: HashMap::new(),
             debuggers: HashMap::new(),
+            stdouts: HashMap::new(),
             watched_regions: HashMap::new(),
-            eye_contents: vec![0u8; 384 * 224 * 2],
+            eye_contents: [vec![0u8; 384 * 224 * 2], vec![0u8; 384 * 224 * 2]],
             audio_samples: Vec::with_capacity(EXPECTED_FRAME_SIZE),
             buffer: vec![],
         })
@@ -209,12 +182,12 @@ impl Emulator {
     }
 
     pub fn start_second_sim(&mut self, rom: Option<PathBuf>) -> Result<()> {
-        let rom_path = if let Some(path) = rom {
+        let file_path = if let Some(path) = rom {
             Some(path)
         } else {
-            self.carts[0].as_ref().map(|c| c.rom_path.clone())
+            self.carts[0].as_ref().map(|c| c.file_path.clone())
         };
-        let cart = match rom_path {
+        let cart = match file_path {
             Some(rom_path) => Some(Cart::load(&rom_path, SimId::Player2)?),
             None => None,
         };
@@ -228,8 +201,15 @@ impl Emulator {
 
         let index = sim_id.to_index();
         while self.sims.len() <= index {
+            let new_index = self.sims.len();
             self.sims.push(Sim::new());
-            self.sim_state[index].store(SimState::NoGame, Ordering::Release);
+            if self
+                .stdouts
+                .contains_key(&SimId::from_index(new_index).unwrap())
+            {
+                self.sims[new_index].watch_stdout(true);
+            }
+            self.sim_state[new_index].store(SimState::NoGame, Ordering::Release);
         }
         let sim = &mut self.sims[index];
         sim.reset();
@@ -320,8 +300,7 @@ impl Emulator {
         let cart = self.carts[sim_id.to_index()].as_mut();
         if let (Some(sim), Some(cart)) = (sim, cart) {
             sim.read_sram(&mut cart.sram);
-            cart.sram_file.seek(SeekFrom::Start(0))?;
+            cart.save_sram()?;
-            cart.sram_file.write_all(&cart.sram)?;
         }
         Ok(())
     }
@@ -471,6 +450,20 @@ impl Emulator {
             self.state.store(EmulatorState::Paused, Ordering::Release);
         }
 
+        // stdout
+        self.stdouts.retain(|sim_id, stdout| {
+            let Some(sim) = self.sims.get_mut(sim_id.to_index()) else {
+                return true;
+            };
+            if let Some(text) = sim.take_stdout() {
+                if stdout.send(text).is_err() {
+                    sim.watch_stdout(false);
+                    return false;
+                }
+            }
+            true
+        });
+
         // Debug state
         if state == EmulatorState::Debugging {
             for sim_id in SimId::values() {
@@ -498,9 +491,12 @@ impl Emulator {
             let Some(sim) = self.sims.get_mut(sim_id.to_index()) else {
                 continue;
             };
-            if sim.read_pixels(&mut self.eye_contents) {
+            if sim.read_pixels(&mut self.eye_contents[sim_id.to_index()]) {
                 idle = false;
-                if renderer.queue_render(&self.eye_contents).is_err() {
+                if renderer
+                    .queue_render(&self.eye_contents[sim_id.to_index()])
+                    .is_err()
+                {
                     self.renderers.remove(&sim_id);
                 }
             }
@@ -645,6 +641,13 @@ impl Emulator {
                 };
                 sim.remove_watchpoint(address, length, watch);
             }
+            EmulatorCommand::WatchStdout(sim_id, stdout_sink) => {
+                self.stdouts.insert(sim_id, stdout_sink);
+                let Some(sim) = self.sims.get_mut(sim_id.to_index()) else {
+                    return;
+                };
+                sim.watch_stdout(true);
+            }
             EmulatorCommand::SetAudioEnabled(p1, p2) => {
                 self.audio_on[SimId::Player1.to_index()].store(p1, Ordering::Release);
                 self.audio_on[SimId::Player2.to_index()].store(p2, Ordering::Release);
@@ -665,6 +668,10 @@ impl Emulator {
                     sim.set_keys(keys);
                 }
             }
+            EmulatorCommand::Screenshot(sim_id, sender) => {
+                let contents = self.eye_contents[sim_id.to_index()].clone();
+                let _ = sender.send(contents);
+            }
             EmulatorCommand::Exit(done) => {
                 for sim_id in SimId::values() {
                     if let Err(error) = self.save_sram(sim_id) {
@@ -682,10 +689,8 @@ impl Emulator {
             .get(&sim_id)
             .or_else(|| self.messages.get(&SimId::Player1));
         if let Some(msg) = messages {
-            let toast = Toast::new()
+            let mut toast = Toast::error(&message);
-                .kind(ToastKind::Error)
+            toast.duration(Some(Duration::from_secs(5)));
-                .options(ToastOptions::default().duration_in_seconds(5.0))
-                .text(&message);
             if msg.send(toast).is_ok() {
                 return;
             }
@@ -718,11 +723,13 @@ pub enum EmulatorCommand {
     RemoveBreakpoint(SimId, u32),
     AddWatchpoint(SimId, u32, usize, VBWatchpointType),
     RemoveWatchpoint(SimId, u32, usize, VBWatchpointType),
+    WatchStdout(SimId, mpsc::Sender<String>),
     SetAudioEnabled(bool, bool),
     Link,
     Unlink,
     Reset(SimId),
     SetKeys(SimId, VBKey),
+    Screenshot(SimId, oneshot::Sender<Vec<u8>>),
     Exit(oneshot::Sender<()>),
 }
 

src/emulator/cart.rs

@@ -0,0 +1,155 @@
+use anyhow::{Context, Result, bail};
+use rand::Rng;
+use serde::Deserialize;
+use sha2::Digest;
+use std::{
+    ffi::OsStr,
+    fs,
+    io::{Read, Seek as _, SeekFrom, Write as _},
+    path::{Path, PathBuf},
+};
+
+use crate::emulator::SimId;
+
+pub struct Cart {
+    pub file_path: PathBuf,
+    pub rom: Vec<u8>,
+    sram_file: fs::File,
+    pub sram: Vec<u8>,
+}
+
+impl Cart {
+    pub fn load(file_path: &Path, sim_id: SimId) -> Result<Self> {
+        let vbx_extension = OsStr::new("vbx");
+        let contents = if file_path.extension() == Some(vbx_extension) {
+            read_bundle(file_path)
+        } else {
+            read_rom(file_path)
+        }?;
+
+        let mut sram_file = fs::File::options()
+            .read(true)
+            .write(true)
+            .create(true)
+            .truncate(false)
+            .open(sram_path(file_path, sim_id))?;
+
+        let sram_file_size = if contents.sram_small_bus {
+            contents.sram_size * 2
+        } else {
+            contents.sram_size
+        };
+        let sram = if sram_file.metadata()?.len() == 0 {
+            // new SRAM file, randomize the contents
+            let mut sram = vec![0; sram_file_size];
+            let mut rng = rand::rng();
+            for dst in sram
+                .iter_mut()
+                .step_by(if contents.sram_small_bus { 2 } else { 1 })
+            {
+                *dst = rng.random();
+            }
+            sram
+        } else {
+            let mut sram = Vec::with_capacity(sram_file_size);
+            sram_file.read_to_end(&mut sram)?;
+            sram.resize(sram_file_size, 0);
+            sram
+        };
+
+        Ok(Cart {
+            file_path: file_path.to_path_buf(),
+            rom: contents.rom,
+            sram_file,
+            sram,
+        })
+    }
+
+    pub fn save_sram(&mut self) -> Result<()> {
+        self.sram_file.seek(SeekFrom::Start(0))?;
+        self.sram_file.write_all(&self.sram)?;
+        Ok(())
+    }
+}
+
+struct CartContents {
+    rom: Vec<u8>,
+    sram_size: usize,
+    sram_small_bus: bool,
+}
+
+fn read_bundle(file_path: &Path) -> Result<CartContents> {
+    let file = fs::File::open(file_path)?;
+    let mut archive = zip::ZipArchive::new(file).context("invalid VBX")?;
+    let manifest_reader = archive
+        .by_name("manifest.json")
+        .context("manifest.json not found")?;
+    let manifest: Manifest =
+        serde_json::from_reader(manifest_reader).context("malformed manifest")?;
+    let rom = {
+        let mut rom_file = archive
+            .by_name(&manifest.rom.file)
+            .context("ROM file not found")?;
+        let mut buffer = Vec::with_capacity(rom_file.size() as usize);
+        rom_file
+            .read_to_end(&mut buffer)
+            .context("could not read ROM")?;
+        buffer
+    };
+    if let Some(hash) = manifest.rom.sha256 {
+        let expected_hash = hex::decode(hash)?;
+        let actual_hash = sha2::Sha256::digest(&rom);
+        if expected_hash[..] != actual_hash[..] {
+            bail!("Incorrect ROM hash");
+        }
+    }
+
+    let sram_size = manifest.sram.as_ref().map(|s| s.size).unwrap_or(8192);
+    if !sram_size.is_power_of_two() {
+        bail!("Invalid SRAM size, must be power of two")
+    }
+    let sram_small_bus = manifest.sram.and_then(|s| s.bus_width).unwrap_or_default() < 16;
+
+    Ok(CartContents {
+        rom,
+        sram_size,
+        sram_small_bus,
+    })
+}
+
+#[derive(Deserialize)]
+#[serde(rename_all = "camelCase")]
+struct Manifest {
+    rom: ManifestRom,
+    sram: Option<ManifestSram>,
+}
+
+#[derive(Deserialize)]
+#[serde(rename_all = "camelCase")]
+struct ManifestRom {
+    file: String,
+    sha256: Option<String>,
+}
+
+#[derive(Deserialize)]
+#[serde(rename_all = "camelCase")]
+struct ManifestSram {
+    size: usize,
+    bus_width: Option<usize>,
+}
+
+fn read_rom(rom_path: &Path) -> Result<CartContents> {
+    let rom = fs::read(rom_path)?;
+    Ok(CartContents {
+        rom,
+        sram_size: 8192,
+        sram_small_bus: true,
+    })
+}
+
+fn sram_path(file_path: &Path, sim_id: SimId) -> PathBuf {
+    match sim_id {
+        SimId::Player1 => file_path.with_extension("p1.sram"),
+        SimId::Player2 => file_path.with_extension("p2.sram"),
+    }
+}

src/emulator/shrooms_vb_core.rs

@@ -230,7 +230,7 @@ extern "C" fn on_write(
     sim: *mut VB,
     address: u32,
     _type: VBDataType,
-    _value: *mut i32,
+    value: *mut i32,
     _cycles: *mut u32,
     _cancel: *mut c_int,
 ) -> c_int {
@@ -238,6 +238,14 @@ extern "C" fn on_write(
     // There is no way for the userdata to be null or otherwise invalid.
     let data: &mut VBState = unsafe { &mut *vb_get_user_data(sim).cast() };
 
+    // If we're monitoring stdout, track this write
+    if let Some(stdout) = data.stdout.as_mut() {
+        let normalized_hw_address = address & 0x0700003f;
+        if normalized_hw_address == 0x02000030 {
+            stdout.push(unsafe { *value } as u8);
+        }
+    }
+
     if let Some(start) = data.write_watchpoints.start_of_range_containing(address) {
         let watch = if data.read_watchpoints.contains(address) {
             VBWatchpointType::Access
@@ -263,6 +271,7 @@ struct VBState {
     breakpoints: Vec<u32>,
     read_watchpoints: AddressSet,
     write_watchpoints: AddressSet,
+    stdout: Option<Vec<u8>>,
 }
 
 impl VBState {
@@ -306,6 +315,7 @@ impl Sim {
             breakpoints: vec![],
             read_watchpoints: AddressSet::new(),
             write_watchpoints: AddressSet::new(),
+            stdout: None,
         };
         unsafe { vb_set_user_data(sim, Box::into_raw(Box::new(state)).cast()) };
         unsafe { vb_set_frame_callback(sim, Some(on_frame)) };
@@ -564,7 +574,9 @@ impl Sim {
         state.write_watchpoints.remove(address, length);
         let needs_execute = state.needs_execute_callback();
         if state.write_watchpoints.is_empty() {
-            unsafe { vb_set_write_callback(self.sim, None) };
+            if state.stdout.is_none() {
+                unsafe { vb_set_write_callback(self.sim, None) };
+            }
             if !needs_execute {
                 unsafe { vb_set_execute_callback(self.sim, None) };
             }
@@ -586,11 +598,40 @@ impl Sim {
         data.breakpoints.clear();
         data.read_watchpoints.clear();
         data.write_watchpoints.clear();
+        let needs_write = data.stdout.is_some();
         unsafe { vb_set_read_callback(self.sim, None) };
-        unsafe { vb_set_write_callback(self.sim, None) };
+        if !needs_write {
+            unsafe { vb_set_write_callback(self.sim, None) };
+        }
         unsafe { vb_set_execute_callback(self.sim, None) };
     }
 
+    pub fn watch_stdout(&mut self, watch: bool) {
+        let data = self.get_state();
+        if watch {
+            if data.stdout.is_none() {
+                data.stdout = Some(vec![]);
+                unsafe { vb_set_write_callback(self.sim, Some(on_write)) };
+            }
+        } else {
+            data.stdout.take();
+            if data.write_watchpoints.is_empty() {
+                unsafe { vb_set_write_callback(self.sim, None) };
+            }
+        }
+    }
+
+    pub fn take_stdout(&mut self) -> Option<String> {
+        let data = self.get_state();
+        let stdout = data.stdout.take()?;
+        let string = match String::from_utf8(stdout) {
+            Ok(str) => str,
+            Err(err) => String::from_utf8_lossy(err.as_bytes()).into_owned(),
+        };
+        data.stdout = Some(vec![]);
+        Some(string)
+    }
+
     pub fn stop_reason(&mut self) -> Option<StopReason> {
         let data = self.get_state();
         let reason = data.stop_reason.take();

src/gdbserver/registers.rs

@@ -12,7 +12,7 @@ impl RegisterInfo {
     pub fn to_description(&self) -> String {
         let mut string = format!("name:{}", self.name);
         if let Some(alt) = self.alt_name {
-            string.push_str(&format!(";alt-name:{}", alt));
+            string.push_str(&format!(";alt-name:{alt}"));
         }
         string.push_str(&format!(
             ";bitsize:32;offset:{};encoding:uint;format:hex;set:{};dwarf:{}",
@@ -21,7 +21,7 @@ impl RegisterInfo {
             self.dwarf
         ));
         if let Some(generic) = self.generic {
-            string.push_str(&format!(";generic:{}", generic));
+            string.push_str(&format!(";generic:{generic}"));
         }
         string
     }

src/graphics.rs

@@ -10,7 +10,7 @@ use std::{
 use anyhow::{Result, bail};
 use itertools::Itertools as _;
 use wgpu::{
-    Device, Extent3d, ImageCopyTexture, ImageDataLayout, Origin3d, Queue, Texture,
+    Device, Extent3d, Origin3d, Queue, TexelCopyBufferLayout, TexelCopyTextureInfo, Texture,
     TextureDescriptor, TextureFormat, TextureUsages, TextureView, TextureViewDescriptor,
 };
 
@@ -21,7 +21,7 @@ pub struct TextureSink {
 }
 
 impl TextureSink {
-    pub fn new(device: &Device, queue: Arc<Queue>) -> (Self, TextureView) {
+    pub fn new(device: &Device, queue: Queue) -> (Self, TextureView) {
         let texture = Self::create_texture(device);
         let view = texture.create_view(&TextureViewDescriptor::default());
         let buffers = Arc::new(BufferPool::new());
@@ -72,7 +72,7 @@ impl TextureSink {
     }
 
     fn write_texture(queue: &Queue, texture: &Texture, bytes: &[u8]) {
-        let texture = ImageCopyTexture {
+        let texture = TexelCopyTextureInfo {
             texture,
             mip_level: 0,
             origin: Origin3d::ZERO,
@@ -83,7 +83,7 @@ impl TextureSink {
             height: 224,
             depth_or_array_layers: 1,
         };
-        let data_layout = ImageDataLayout {
+        let data_layout = TexelCopyBufferLayout {
             offset: 0,
             bytes_per_row: Some(384 * 2),
             rows_per_image: Some(224),

src/images.rs

@@ -193,8 +193,8 @@ struct ImageState {
 impl ImageState {
     fn new(size: [usize; 2]) -> Self {
         let buffers = [
-            Arc::new(ColorImage::new(size, Color32::BLACK)),
+            Arc::new(ColorImage::filled(size, Color32::BLACK)),
-            Arc::new(ColorImage::new(size, Color32::BLACK)),
+            Arc::new(ColorImage::filled(size, Color32::BLACK)),
         ];
         let sink = buffers[0].clone();
         Self {

src/input.rs

@@ -227,7 +227,7 @@ impl Mappings for InputMapping {
         for (keyboard_key, keys) in &self.keys {
             let name = match keyboard_key {
                 PhysicalKey::Code(code) => format!("{code:?}"),
-                k => format!("{:?}", k),
+                k => format!("{k:?}"),
             };
             for key in keys.iter() {
                 results.entry(key).or_default().push(name.clone());
@@ -471,11 +471,12 @@ pub enum Command {
     FastForward(u32),
     Reset,
     PauseResume,
+    Screenshot,
     // if you update this, update Command::all and add a default
 }
 
 impl Command {
-    pub fn all() -> [Self; 6] {
+    pub fn all() -> [Self; 7] {
         [
             Self::OpenRom,
             Self::Quit,
@@ -483,6 +484,7 @@ impl Command {
             Self::Reset,
             Self::FrameAdvance,
             Self::FastForward(0),
+            Self::Screenshot,
         ]
     }
 
@@ -494,6 +496,7 @@ impl Command {
             Self::Reset => "Reset",
             Self::FrameAdvance => "Frame Advance",
             Self::FastForward(_) => "Fast Forward",
+            Self::Screenshot => "Screenshot",
         }
     }
 }
@@ -539,6 +542,10 @@ impl Default for Shortcuts {
             Command::FastForward(0),
             KeyboardShortcut::new(Modifiers::NONE, Key::Space),
         );
+        shortcuts.set(
+            Command::Screenshot,
+            KeyboardShortcut::new(Modifiers::NONE, Key::F12),
+        );
         shortcuts
     }
 }

src/main.rs

@@ -44,9 +44,9 @@ fn set_panic_handler() {
     std::panic::set_hook(Box::new(|info| {
         let mut message = String::new();
         if let Some(msg) = info.payload().downcast_ref::<&str>() {
-            message += &format!("{}\n", msg);
+            message += &format!("{msg}\n");
         } else if let Some(msg) = info.payload().downcast_ref::<String>() {
-            message += &format!("{}\n", msg);
+            message += &format!("{msg}\n");
         }
         if let Some(location) = info.location() {
             message += &format!(
@@ -56,9 +56,9 @@ fn set_panic_handler() {
             );
         }
         let backtrace = std::backtrace::Backtrace::force_capture();
-        message += &format!("stack trace:\n{:#}\n", backtrace);
+        message += &format!("stack trace:\n{backtrace:#}\n");
 
-        eprint!("{}", message);
+        eprint!("{message}");
 
         let Some(project_dirs) = directories::ProjectDirs::from("com", "virtual-boy", "Lemur")
         else {
@@ -72,7 +72,7 @@ fn set_panic_handler() {
             .duration_since(SystemTime::UNIX_EPOCH)
             .unwrap()
             .as_millis();
-        let logfile_name = format!("crash-{}.txt", timestamp);
+        let logfile_name = format!("crash-{timestamp}.txt");
         let _ = std::fs::write(data_dir.join(logfile_name), message);
     }));
 }

src/window.rs

@@ -4,6 +4,7 @@ pub use game::GameWindow;
 pub use gdb::GdbServerWindow;
 pub use hotkeys::HotkeysWindow;
 pub use input::InputWindow;
+pub use terminal::TerminalWindow;
 pub use vip::{
     BgMapWindow, CharacterDataWindow, FrameBufferWindow, ObjectWindow, RegisterWindow, WorldWindow,
 };
@@ -17,6 +18,7 @@ mod game_screen;
 mod gdb;
 mod hotkeys;
 mod input;
+mod terminal;
 mod utils;
 mod vip;
 

src/window/game.rs

@@ -1,4 +1,4 @@
-use std::sync::mpsc;
+use std::{sync::mpsc, time::Duration};
 
 use crate::{
     app::UserEvent,
@@ -6,11 +6,12 @@ use crate::{
     input::{Command, ShortcutProvider},
     persistence::Persistence,
 };
+use anyhow::Context as _;
 use egui::{
-    Align2, Button, CentralPanel, Color32, Context, Direction, Frame, TopBottomPanel, Ui, Vec2,
+    Align2, Button, CentralPanel, Color32, Context, Frame, MenuBar, TopBottomPanel, Ui, Vec2,
-    ViewportBuilder, ViewportCommand, ViewportId, Window, menu,
+    ViewportBuilder, ViewportCommand, ViewportId, Window,
 };
-use egui_toast::{Toast, Toasts};
+use egui_notify::{Anchor, Toast, Toasts};
 use serde::{Deserialize, Serialize};
 use winit::event_loop::EventLoopProxy;
 
@@ -42,6 +43,7 @@ pub struct GameWindow {
     shortcuts: ShortcutProvider,
     sim_id: SimId,
     config: GameConfig,
+    toasts: Toasts,
     screen: Option<GameScreen>,
     messages: Option<mpsc::Receiver<Toast>>,
     color_picker: Option<ColorPickerState>,
@@ -56,6 +58,10 @@ impl GameWindow {
         sim_id: SimId,
     ) -> Self {
         let config = load_config(&persistence, sim_id);
+        let toasts = Toasts::new()
+            .with_anchor(Anchor::BottomLeft)
+            .with_margin((10.0, 10.0).into())
+            .reverse(true);
         Self {
             client,
             proxy,
@@ -63,6 +69,7 @@ impl GameWindow {
             shortcuts,
             sim_id,
             config,
+            toasts,
             screen: None,
             messages: None,
             color_picker: None,
@@ -113,6 +120,16 @@ impl GameWindow {
                     self.client
                         .send_command(EmulatorCommand::SetSpeed(speed as f64));
                 }
+                Command::Screenshot => {
+                    let autopause = state == EmulatorState::Running && can_pause;
+                    if autopause {
+                        self.client.send_command(EmulatorCommand::Pause);
+                    }
+                    pollster::block_on(self.take_screenshot());
+                    if autopause {
+                        self.client.send_command(EmulatorCommand::Resume);
+                    }
+                }
             }
         }
 
@@ -128,7 +145,6 @@ impl GameWindow {
                     self.client
                         .send_command(EmulatorCommand::LoadGame(self.sim_id, path));
                 }
-                ui.close_menu();
             }
             if ui
                 .add(self.button_for(ui.ctx(), "Quit", Command::Quit))
@@ -147,7 +163,6 @@ impl GameWindow {
                     .clicked()
                 {
                     self.client.send_command(EmulatorCommand::Pause);
-                    ui.close_menu();
                 }
             } else if ui
                 .add_enabled(
@@ -157,7 +172,6 @@ impl GameWindow {
                 .clicked()
             {
                 self.client.send_command(EmulatorCommand::Resume);
-                ui.close_menu();
             }
             if ui
                 .add_enabled(is_ready, self.button_for(ui.ctx(), "Reset", Command::Reset))
@@ -165,7 +179,6 @@ impl GameWindow {
             {
                 self.client
                     .send_command(EmulatorCommand::Reset(self.sim_id));
-                ui.close_menu();
             }
             ui.separator();
             if ui
@@ -176,7 +189,16 @@ impl GameWindow {
                 .clicked()
             {
                 self.client.send_command(EmulatorCommand::FrameAdvance);
-                ui.close_menu();
+            }
+            ui.separator();
+            if ui
+                .add_enabled(
+                    is_ready,
+                    self.button_for(ui.ctx(), "Screenshot", Command::Screenshot),
+                )
+                .clicked()
+            {
+                pollster::block_on(self.take_screenshot());
             }
         });
         ui.menu_button("Options", |ui| self.show_options_menu(ctx, ui));
@@ -189,73 +211,108 @@ impl GameWindow {
                 self.client
                     .send_command(EmulatorCommand::StartSecondSim(None));
                 self.proxy.send_event(UserEvent::OpenPlayer2).unwrap();
-                ui.close_menu();
             }
             if has_player_2 {
                 let linked = self.client.are_sims_linked();
                 if linked && ui.button("Unlink").clicked() {
                     self.client.send_command(EmulatorCommand::Unlink);
-                    ui.close_menu();
                 }
                 if !linked && ui.button("Link").clicked() {
                     self.client.send_command(EmulatorCommand::Link);
-                    ui.close_menu();
                 }
             }
         });
         ui.menu_button("Tools", |ui| {
+            if ui.button("Terminal").clicked() {
+                self.proxy
+                    .send_event(UserEvent::OpenTerminal(self.sim_id))
+                    .unwrap();
+            }
             if ui.button("GDB Server").clicked() {
                 self.proxy
                     .send_event(UserEvent::OpenDebugger(self.sim_id))
                     .unwrap();
-                ui.close_menu();
             }
             ui.separator();
             if ui.button("Character Data").clicked() {
                 self.proxy
                     .send_event(UserEvent::OpenCharacterData(self.sim_id))
                     .unwrap();
-                ui.close_menu();
             }
             if ui.button("Background Maps").clicked() {
                 self.proxy
                     .send_event(UserEvent::OpenBgMap(self.sim_id))
                     .unwrap();
-                ui.close_menu();
             }
             if ui.button("Objects").clicked() {
                 self.proxy
                     .send_event(UserEvent::OpenObjects(self.sim_id))
                     .unwrap();
-                ui.close_menu();
             }
             if ui.button("Worlds").clicked() {
                 self.proxy
                     .send_event(UserEvent::OpenWorlds(self.sim_id))
                     .unwrap();
-                ui.close_menu();
             }
             if ui.button("Frame Buffers").clicked() {
                 self.proxy
                     .send_event(UserEvent::OpenFrameBuffers(self.sim_id))
                     .unwrap();
-                ui.close_menu();
             }
             if ui.button("Registers").clicked() {
                 self.proxy
                     .send_event(UserEvent::OpenRegisters(self.sim_id))
                     .unwrap();
-                ui.close_menu();
             }
         });
         ui.menu_button("Help", |ui| {
             if ui.button("About").clicked() {
                 self.proxy.send_event(UserEvent::OpenAbout).unwrap();
-                ui.close_menu();
             }
         });
     }
 
+    async fn take_screenshot(&mut self) {
+        match self.try_take_screenshot().await {
+            Ok(Some(path)) => {
+                let mut toast = Toast::info(format!("Saved to {path}"));
+                toast.duration(Some(Duration::from_secs(5)));
+                self.toasts.add(toast);
+            }
+            Ok(None) => {}
+            Err(error) => {
+                let mut toast = Toast::error(format!("{error:#}"));
+                toast.duration(Some(Duration::from_secs(5)));
+                self.toasts.add(toast);
+            }
+        }
+    }
+
+    async fn try_take_screenshot(&self) -> anyhow::Result<Option<String>> {
+        let (tx, rx) = oneshot::channel();
+        self.client
+            .send_command(EmulatorCommand::Screenshot(self.sim_id, tx));
+        let bytes = rx.await.context("Could not take screenshot")?;
+        let file = rfd::FileDialog::new()
+            .add_filter("PNG images", &["png"])
+            .set_file_name("screenshot.png")
+            .save_file();
+        let Some(path) = file else {
+            return Ok(None);
+        };
+        if bytes.len() != 384 * 224 * 2 {
+            anyhow::bail!("Unexpected screenshot size");
+        }
+        let mut screencap = image::GrayImage::new(384 * 2, 224);
+        for (index, pixel) in bytes.into_iter().enumerate() {
+            let x = (index / 2) % 384 + ((index % 2) * 384);
+            let y = (index / 2) / 384;
+            screencap.put_pixel(x as u32, y as u32, image::Luma([pixel]));
+        }
+        screencap.save(&path).context("Could not save screenshot")?;
+        Ok(Some(path.display().to_string()))
+    }
+
     fn show_options_menu(&mut self, ctx: &Context, ui: &mut Ui) {
         ui.menu_button("Video", |ui| {
             ui.menu_button("Screen Size", |ui| {
@@ -273,7 +330,6 @@ impl GameWindow {
                         .clicked()
                     {
                         ctx.send_viewport_cmd(ViewportCommand::InnerSize(dims));
-                        ui.close_menu();
                     }
                 }
             });
@@ -310,13 +366,11 @@ impl GameWindow {
                     c.display_mode = display_mode;
                     c.dimensions = current_dims * scale;
                 });
-                ui.close_menu();
             });
             ui.menu_button("Colors", |ui| {
                 for preset in COLOR_PRESETS {
                     if ui.color_pair_button(preset[0], preset[1]).clicked() {
                         self.update_config(|c| c.colors = preset);
-                        ui.close_menu();
                     }
                 }
                 ui.with_layout(ui.layout().with_cross_align(egui::Align::Center), |ui| {
@@ -337,7 +391,6 @@ impl GameWindow {
                             just_opened: true,
                             unpause_on_close: is_running,
                         });
-                        ui.close_menu();
                     }
                 });
             });
@@ -348,23 +401,19 @@ impl GameWindow {
             if ui.selectable_button(p1_enabled, "Player 1").clicked() {
                 self.client
                     .send_command(EmulatorCommand::SetAudioEnabled(!p1_enabled, p2_enabled));
-                ui.close_menu();
             }
             if ui.selectable_button(p2_enabled, "Player 2").clicked() {
                 self.client
                     .send_command(EmulatorCommand::SetAudioEnabled(p1_enabled, !p2_enabled));
-                ui.close_menu();
             }
         });
         ui.menu_button("Input", |ui| {
             if ui.button("Bind Inputs").clicked() {
                 self.proxy.send_event(UserEvent::OpenInput).unwrap();
-                ui.close_menu();
             }
         });
         if ui.button("Hotkeys").clicked() {
             self.proxy.send_event(UserEvent::OpenHotkeys).unwrap();
-            ui.close_menu();
         }
     }
 
@@ -460,18 +509,15 @@ impl AppWindow for GameWindow {
         };
         self.update_config(|c| c.dimensions = dimensions);
 
-        let mut toasts = Toasts::new()
-            .anchor(Align2::LEFT_BOTTOM, (10.0, 10.0))
-            .direction(Direction::BottomUp);
         if let Some(messages) = self.messages.as_mut() {
             while let Ok(toast) = messages.try_recv() {
-                toasts.add(toast);
+                self.toasts.add(toast);
             }
         }
         TopBottomPanel::top("menubar")
             .exact_height(22.0)
             .show(ctx, |ui| {
-                menu::bar(ui, |ui| {
+                MenuBar::new().ui(ui, |ui| {
                     self.show_menu(ctx, ui);
                 });
             });
@@ -491,7 +537,7 @@ impl AppWindow for GameWindow {
                 ui.add(screen);
             }
         });
-        toasts.show(ctx);
+        self.toasts.show(ctx);
     }
 
     fn on_init(&mut self, _ctx: &Context, render_state: &egui_wgpu::RenderState) {

src/window/game_screen.rs

@@ -71,7 +71,7 @@ impl GameScreen {
                     module: &shader,
                     entry_point: Some(entry_point),
                     targets: &[Some(wgpu::ColorTargetState {
-                        format: wgpu::TextureFormat::Bgra8Unorm,
+                        format: render_state.target_format,
                         blend: Some(wgpu::BlendState::REPLACE),
                         write_mask: wgpu::ColorWrites::ALL,
                     })],

src/window/terminal.rs

@@ -0,0 +1,79 @@
+use std::{collections::VecDeque, sync::mpsc};
+
+use egui::{
+    Align, CentralPanel, Context, FontFamily, Label, RichText, ScrollArea, ViewportBuilder,
+    ViewportId,
+};
+
+use crate::emulator::{EmulatorClient, EmulatorCommand, SimId};
+
+use super::AppWindow;
+
+const SCROLLBACK: usize = 1000;
+
+pub struct TerminalWindow {
+    sim_id: SimId,
+    receiver: mpsc::Receiver<String>,
+    lines: VecDeque<String>,
+}
+
+impl TerminalWindow {
+    pub fn new(sim_id: SimId, client: &EmulatorClient) -> Self {
+        let (sender, receiver) = mpsc::channel();
+        client.send_command(EmulatorCommand::WatchStdout(sim_id, sender));
+        let mut lines = VecDeque::new();
+        lines.push_back(String::new());
+        Self {
+            sim_id,
+            receiver,
+            lines,
+        }
+    }
+}
+
+impl AppWindow for TerminalWindow {
+    fn viewport_id(&self) -> ViewportId {
+        ViewportId::from_hash_of(format!("terminal-{}", self.sim_id))
+    }
+
+    fn sim_id(&self) -> SimId {
+        self.sim_id
+    }
+
+    fn initial_viewport(&self) -> ViewportBuilder {
+        ViewportBuilder::default()
+            .with_title(format!("Terminal ({})", self.sim_id))
+            .with_inner_size((640.0, 480.0))
+    }
+
+    fn show(&mut self, ctx: &Context) {
+        if let Ok(text) = self.receiver.try_recv() {
+            let mut rest = text.as_str();
+            while let Some(index) = rest.find('\n') {
+                let (line, lines) = rest.split_at(index);
+                let current = self.lines.back_mut().unwrap();
+                current.push_str(line);
+                self.lines.push_back(String::new());
+                if self.lines.len() > SCROLLBACK {
+                    self.lines.pop_front();
+                }
+                rest = &lines[1..];
+            }
+            self.lines.back_mut().unwrap().push_str(rest);
+        }
+        CentralPanel::default().show(ctx, |ui| {
+            ScrollArea::vertical()
+                .stick_to_bottom(true)
+                .auto_shrink([false, false])
+                .animated(false)
+                .show(ui, |ui| {
+                    for line in &self.lines {
+                        let label = Label::new(RichText::new(line).family(FontFamily::Monospace))
+                            .halign(Align::LEFT)
+                            .wrap();
+                        ui.add(label);
+                    }
+                });
+        });
+    }
+}

src/window/utils.rs

@@ -6,8 +6,8 @@ use std::{
 
 use atoi::FromRadix16;
 use egui::{
-    Align, Color32, CursorIcon, Event, Frame, Key, Layout, Margin, Rect, Response, RichText,
+    Align, Color32, CornerRadius, CursorIcon, Event, Frame, Key, Layout, Margin, Rect, Response,
-    Rounding, Sense, Shape, Stroke, TextEdit, Ui, UiBuilder, Vec2, Widget, WidgetText,
+    RichText, Sense, Shape, Stroke, StrokeKind, TextEdit, Ui, UiBuilder, Vec2, Widget, WidgetText,
     ecolor::HexColor,
 };
 use num_traits::{CheckedAdd, CheckedSub, One};
@@ -37,8 +37,8 @@ impl UiExt for Ui {
     fn section(&mut self, title: impl Into<String>, add_contents: impl FnOnce(&mut Ui)) {
         let title: String = title.into();
         let mut frame = Frame::group(self.style());
-        frame.outer_margin.top += 10.0;
+        frame.outer_margin.top += 10;
-        frame.inner_margin.top += 2.0;
+        frame.inner_margin.top += 2;
         let res = self.push_id(&title, |ui| {
             frame.show(ui, |ui| {
                 ui.set_max_width(ui.available_width());
@@ -49,7 +49,7 @@ impl UiExt for Ui {
         let old_rect = res.response.rect;
         let mut text_rect = old_rect;
         text_rect.min.x += 6.0;
-        self.allocate_new_ui(UiBuilder::new().max_rect(text_rect), |ui| ui.label(text));
+        self.scope_builder(UiBuilder::new().max_rect(text_rect), |ui| ui.label(text));
         if old_rect.width() > 0.0 {
             self.advance_cursor_after_rect(old_rect);
         }
@@ -73,7 +73,8 @@ impl UiExt for Ui {
         self.painter().rect_filled(right_rect, 0.0, right);
 
         let style = self.style().interact(&response);
-        self.painter().rect_stroke(rect, 0.0, style.fg_stroke);
+        self.painter()
+            .rect_stroke(rect, 0.0, style.fg_stroke, StrokeKind::Inside);
         response
     }
 
@@ -265,10 +266,10 @@ impl<T: Number> Widget for NumberEdit<'_, T> {
             .id(id)
             .desired_width(desired_width)
             .margin(Margin {
-                left: 4.0,
+                left: 4,
-                right: if self.arrows { 20.0 } else { 4.0 },
+                right: if self.arrows { 20 } else { 4 },
-                top: 2.0,
+                top: 2,
-                bottom: 2.0,
+                bottom: 2,
             });
         let mut res = if valid {
             ui.add(text)
@@ -337,7 +338,7 @@ impl<T: Number> Widget for NumberEdit<'_, T> {
             }
             str = to_string(self.value);
             stale = true;
-        } else if res.changed {
+        } else if res.changed() {
             if let Some(new_value) = from_string(&str).filter(in_range) {
                 if *self.value != new_value {
                     res.mark_changed();
@@ -355,27 +356,20 @@ impl<T: Number> Widget for NumberEdit<'_, T> {
 
 fn draw_arrow(ui: &mut Ui, rect: Rect, up: bool) -> Response {
     let arrow_res = ui
-        .allocate_rect(
+        .allocate_rect(rect, Sense::all())
-            rect,
-            Sense {
-                click: true,
-                drag: true,
-                focusable: false,
-            },
-        )
         .on_hover_cursor(CursorIcon::Default);
     let visuals = ui.style().visuals.widgets.style(&arrow_res);
     let painter = ui.painter_at(arrow_res.rect);
 
     let rounding = if up {
-        Rounding {
+        CornerRadius {
-            ne: 2.0,
+            ne: 2,
-            ..Rounding::ZERO
+            ..CornerRadius::ZERO
         }
     } else {
-        Rounding {
+        CornerRadius {
-            se: 2.0,
+            se: 2,
-            ..Rounding::ZERO
+            ..CornerRadius::ZERO
         }
     };
     painter.rect_filled(arrow_res.rect, rounding, visuals.bg_fill);