Merge pull request #10 from YushiOMOTE/actions

Actions

.github/workflows/rust.yml

@@ -0,0 +1,34 @@
+name: Rust
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: Prepare
+        run: sudo apt install libasound2-dev libxcursor-dev
+      - name: Build (stable)
+        run: cargo build --verbose
+      - name: Build examples (stable)
+        run: cargo build --verbose --examples
+      - name: Test (stable)
+        run: cargo test --verbose
+      - name: Install nightly
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: nightly
+          override: true
+      - name: Build (nightly)
+        run: |
+          cd core
+          cargo build --verbose --features readme
+      - name: Build examples (nightly)
+        run: |
+          cd core
+          cargo build --verbose --examples --features readme
+      - name: Test (nightly)
+        run: |
+          cd core
+          cargo test --verbose --features readme

README.md

@@ -1,6 +1,11 @@
-# rGB
+# rgy
 
-Try emulating Game Boy in Rust
+No-std cross-platform Rust GameBoy emulator library. Rust GameboY (RGY, or Real GaY).
+
+[![Latest version](https://img.shields.io/crates/v/rgy.svg)](https://crates.io/crates/rgy)
+[![Documentation](https://docs.rs/rgy/badge.svg)](https://docs.rs/rgy)
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![Actions Status](https://github.com/YushiOMOTE/rgy/workflows/Rust/badge.svg)](https://github.com/YushiOMOTE/rgy/actions)
 
 ![demo](https://raw.github.com/wiki/YushiOMOTE/gbr/media/demo.gif)
 ![screens](https://raw.github.com/wiki/YushiOMOTE/gbr/media/demo_screens.jpg)

codegen/templates/root.rs

@@ -201,10 +201,12 @@ fn op_{{i.code | hex}}(arg: u16, cpu: &mut Cpu, mmu: &mut Mmu) -> (usize, usize)
 }
 {% endfor %}
 
+/// Return the mnemonic string for the given opcode.
 pub fn mnem(code: u16) -> &'static str {
     MNEMONICS.get(&code).unwrap_or(&"(unknown opcode)")
 }
 
+/// Decodes the opecode and actually executes one instruction.
 pub fn decode(code: u16, arg: u16, cpu: &mut Cpu, mmu: &mut Mmu) -> (usize, usize) {
     trace!("{:04x}: {:04x}: {}", cpu.get_pc(), code, mnem(code));
 

core/Cargo.toml

@@ -3,6 +3,13 @@ name = "rgy"
 version = "0.1.0"
 authors = ["Yushi Omote <yushiomote@gmail.com>"]
 edition = "2018"
+keywords = ["gameboy", "emulator"]
+description = "No-std Rust GameBoy emulator library"
+homepage = "https://github.com/yushiomote/rgy"
+repository = "https://github.com/yushiomote/rgy"
+documentation = "https://docs.rs/rgy"
+license = "MIT"
+readme = "README.md"
 
 [dependencies]
 lazy_static = { version = "1.2", features = ["spin_no_std"] }
@@ -22,3 +29,4 @@ core_affinity = "0.5"
 [features]
 default = []
 color = []
+readme = []

core/examples/empty.rs

@@ -0,0 +1,81 @@
+use rgy::{Config, Key, Stream, VRAM_HEIGHT, VRAM_WIDTH};
+
+struct Hardware {
+    display: Vec<Vec<u32>>,
+}
+
+impl Hardware {
+    fn new() -> Self {
+        // Create a frame buffer with the size VRAM_WIDTH * VRAM_HEIGHT.
+        let display = vec![vec![0u32; VRAM_HEIGHT]; VRAM_WIDTH];
+
+        Self { display }
+    }
+}
+
+impl rgy::Hardware for Hardware {
+    fn vram_update(&mut self, line: usize, buffer: &[u32]) {
+        // `line` corresponds to the y coordinate.
+        let y = line;
+
+        for (x, col) in buffer.iter().enumerate() {
+            self.display[x][y] = *col;
+        }
+    }
+
+    fn joypad_pressed(&mut self, key: Key) -> bool {
+        // Read a keyboard device and check if the `key` is pressed or not.
+        println!("Check if {:?} is pressed", key);
+        false
+    }
+
+    fn sound_play(&mut self, _stream: Box<dyn Stream>) {
+        // Play the wave provided `Stream`.
+    }
+
+    fn clock(&mut self) -> u64 {
+        // Return the epoch in microseconds.
+        let epoch = std::time::SystemTime::now()
+            .duration_since(std::time::UNIX_EPOCH)
+            .expect("Couldn't get epoch");
+        epoch.as_micros() as u64
+    }
+
+    fn send_byte(&mut self, _b: u8) {
+        // Send a byte to a serial port.
+    }
+
+    fn recv_byte(&mut self) -> Option<u8> {
+        // Try to read a byte from a serial port.
+        None
+    }
+
+    fn sched(&mut self) -> bool {
+        // `true` to continue, `false` to stop the emulator.
+        println!("It's running!");
+        true
+    }
+
+    fn load_ram(&mut self, size: usize) -> Vec<u8> {
+        // Return save data.
+        vec![0; size]
+    }
+
+    fn save_ram(&mut self, _ram: &[u8]) {
+        // Store save data.
+    }
+}
+
+fn main() {
+    // Create the default config.
+    let cfg = Config::new();
+
+    // Create the hardware instance.
+    let hw = Hardware::new();
+
+    // The content of a ROM file, which can be downloaded from the Internet.
+    let rom = vec![0u8; 1024];
+
+    // Run the emulator.
+    rgy::run(cfg, &rom, hw);
+}

core/examples/pc/hardware.rs

@@ -11,7 +11,7 @@ use std::sync::{
 };
 use std::time::{Duration, SystemTime, UNIX_EPOCH};
 
-use rgy::hardware::{self, Key, Stream, VRAM_HEIGHT, VRAM_WIDTH};
+use rgy::{Key, Stream, VRAM_HEIGHT, VRAM_WIDTH};
 
 #[derive(Clone)]
 pub struct Hardware {
@@ -153,7 +153,7 @@ impl Hardware {
     }
 }
 
-impl hardware::Hardware for Hardware {
+impl rgy::Hardware for Hardware {
     fn vram_update(&mut self, line: usize, buf: &[u32]) {
         let mut vram = self.vram.lock().unwrap();
         for i in 0..buf.len() {

core/examples/pc/main.rs

@@ -77,9 +77,9 @@ fn main() {
         set_affinity();
 
         if opt.debug {
-            rgy::run_debug(to_cfg(opt), rom, hw1, Debugger::new());
+            rgy::run_debug(to_cfg(opt), &rom, hw1, Debugger::new());
         } else {
-            rgy::run(to_cfg(opt), rom, hw1);
+            rgy::run(to_cfg(opt), &rom, hw1);
         }
     });
 

core/src/cgb.rs

@@ -12,6 +12,7 @@ pub struct Cgb {
     wram_bank: Vec<Vec<u8>>,
 }
 
+#[allow(unused)]
 impl Cgb {
     pub fn new() -> Self {
         Self {