rubyboy 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1065bd051087c47a5b6a73fdde2887b92a4eaceef15b73fb1ed0f0fc5d6ad2f
-  data.tar.gz: 0e3f57c3c7258170c58c7ce855fa51352c989e1b07fbe3755d1c1bdf6134715d
+  metadata.gz: 4d92d323c7cf2886b1808eb6e8e2aabb786f5f4a4c66069e2788924ffa7ce72e
+  data.tar.gz: e0d5c4e1f1039f54283a5cd307c8fabe29f9dc019516501f9075560c16612af4
 SHA512:
-  metadata.gz: 64e5b3e5fa9a54dee5f153a264816e9e1d307d7c95b349d9d92e717cb4f6725307e0d992c3294e4c9c06bee9f22c5ca04cc3257e756e453df432e8b02f244655
-  data.tar.gz: 9b1ace44a5900036efabd776686cbf41bb68d8696176922fcbae445a0b2db84469f4383aae9299ddb3df12cbe70f89f703c6828c647a20b52628a0fdfd328a83
+  metadata.gz: 6960fa54f9150fafd79388eb9dafc9f787188a7ac1b097885ce3c8cbfe59ea7fbac84f3b8d3008f36c818ae3925b8965fbefaf8793d9211b37e8eb214dbbf9ca
+  data.tar.gz: 814ee8ce6c307828dde433847eabbb6d681c37d7bf424b6a0e90731c5bc3869060bc6baeaa79f15dfe5364532f070e02f97d4fb99844f115e8d341cc678ee0c4

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [Unreleased]
 
+## [1.3.2] - 2024-05-04
+
+- Revert "Enable YJIT when initialize"
+- Add rubyboy-bench command
+- Refactor Console class to use Emulator class
+- Add option parsing and update default ROM path
+
 ## [1.3.1] - 2024-03-17
 
 - Enable YJIT when initialize

data/README.md

@@ -6,6 +6,12 @@
 
 A Game Boy emulator written in Ruby
 
+## Screenshots
+<div align="center">
+  <img src="/resource/screenshots/pokemon.png" width="400px"/>
+  <img src="/resource/screenshots/puyopuyo.png" width="400px"/>
+</div>
+
 ## Requirements
 [SDL2](https://wiki.libsdl.org/SDL2/Installation)
 
@@ -26,7 +32,18 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-    $ rubyboy <rom_path>
+    $ RUBYOPT=--yjit rubyboy <rom_path>
+
+| Key   | Button |
+| :---: | :----: |
+| `W`   | ↑      |
+| `A`   | ←      |
+| `S`   | ↓      |
+| `D`   | →      |
+| `J`   | A      |
+| `K`   | B      |
+| `U`   | Select |
+| `I`   | Start  |
 
 ## Contributing
 

data/exe/rubyboy

@@ -2,14 +2,30 @@
 # frozen_string_literal: true
 
 require 'rubyboy'
-require 'bench'
+require 'optparse'
 
-arg = ARGV[0]
+begin
+  OptionParser.new do |opts|
+    opts.banner = "Usage: #{File.basename($PROGRAM_NAME)} ROM_PATH"
 
-if arg == 'bench'
-  Rubyboy::Bench.new.bench
-elsif arg == 'stackprof'
-  Rubyboy::Bench.new.stackprof
+    opts.on('-h', '--help', 'Displays this help') do
+      puts opts
+      exit
+    end
+  end.parse!
+rescue OptionParser::ParseError => e
+  puts e.message
+  puts "Usage: #{File.basename($PROGRAM_NAME)} ROM_PATH"
+  exit 1
+end
+
+rom_path = ARGV.shift || 'lib/roms/tobu.gb'
+
+puts "Ruby: #{RUBY_VERSION}"
+if defined?(RubyVM::YJIT)
+  puts "YJIT: #{RubyVM::YJIT.enabled?}"
 else
-  Rubyboy::Console.new(arg).start
+  puts 'YJIT is not available in this environment.'
 end
+
+Rubyboy::Emulator.new(rom_path).start

data/exe/rubyboy-bench

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'rubyboy'
+require 'bench'
+require 'optparse'
+
+options = {}
+begin
+  OptionParser.new do |opts|
+    opts.banner = "Usage: #{File.basename($PROGRAM_NAME)} [options]"
+
+    opts.on('--count COUNT', Integer, 'Number of counts for the benchmark') do |count|
+      options[:count] = count
+    end
+
+    opts.on('--frames FRAMES', Integer, 'Number of frames to process') do |frames|
+      options[:frames] = frames
+    end
+
+    opts.on('--rom-path ROM_PATH', String, 'Path to the ROM file') do |rom_path|
+      options[:rom_path] = rom_path
+    end
+
+    opts.on('-h', '--help', 'Displays this help') do
+      puts opts
+      exit
+    end
+  end.parse!
+rescue OptionParser::ParseError => e
+  puts e.message
+  puts "Usage: #{File.basename($PROGRAM_NAME)} --count NUM --frames NUM --rom-path FILEPATH"
+  exit 1
+end
+
+puts "Ruby: #{RUBY_VERSION}"
+if defined?(RubyVM::YJIT)
+  puts "YJIT: #{RubyVM::YJIT.enabled?}"
+else
+  puts 'YJIT is not available in this environment.'
+end
+
+Rubyboy::Bench.new.bench(**options)

data/lib/bench.rb

@@ -7,20 +7,19 @@ module Rubyboy
   class Bench
     def stackprof
       StackProf.run(mode: :cpu, out: 'stackprof-cpu-myapp.dump', raw: true) do
-        Rubyboy::Console.new('lib/roms/tobu.gb').bench
+        Rubyboy::Emulator.new('lib/roms/tobu.gb').bench
       end
     end
 
-    def bench
-      bench_cnt = 3
+    def bench(count: 3, frames: 1500, rom_path: 'lib/roms/tobu.gb')
       time_sum = 0
-      bench_cnt.times do |i|
-        time = Rubyboy::Console.new('lib/roms/tobu.gb').bench
+      count.times do |i|
+        time = Rubyboy::Emulator.new(rom_path).bench(frames)
         time_sum += time
-        puts "#{i + 1}: #{time} sec"
+        puts "#{i + 1}: #{time / 1_000_000_000.0} sec"
       end
 
-      puts "FPS: #{1500 * bench_cnt / time_sum}"
+      puts "FPS: #{frames * count * 1_000_000_000.0 / time_sum}"
     end
   end
 end

data/lib/rubyboy/emulator.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Rubyboy
+  class Emulator
+    CPU_CLOCK_HZ = 4_194_304
+    CYCLE_NANOSEC = 1_000_000_000 / CPU_CLOCK_HZ
+
+    def initialize(rom_path)
+      rom_data = File.open(rom_path, 'r') { _1.read.bytes }
+      rom = Rom.new(rom_data)
+      ram = Ram.new
+      mbc = Cartridge::Factory.create(rom, ram)
+      interrupt = Interrupt.new
+      @ppu = Ppu.new(interrupt)
+      @timer = Timer.new(interrupt)
+      @joypad = Joypad.new(interrupt)
+      @apu = Apu.new
+      @bus = Bus.new(@ppu, rom, ram, mbc, @timer, interrupt, @joypad, @apu)
+      @cpu = Cpu.new(@bus, interrupt)
+      @lcd = Lcd.new
+    end
+
+    def start
+      SDL.InitSubSystem(SDL::INIT_KEYBOARD)
+
+      start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC, :nanosecond)
+      elapsed_machine_time = 0
+      catch(:exit_loop) do
+        loop do
+          elapsed_real_time = Process.clock_gettime(Process::CLOCK_MONOTONIC, :nanosecond) - start_time
+          while elapsed_real_time > elapsed_machine_time
+            cycles = @cpu.exec
+            @timer.step(cycles)
+            @apu.step(cycles)
+            if @ppu.step(cycles)
+              @lcd.draw(@ppu.buffer)
+              key_input_check
+              throw :exit_loop if @lcd.window_should_close?
+            end
+
+            elapsed_machine_time += cycles * CYCLE_NANOSEC
+          end
+        end
+      end
+      @lcd.close_window
+    rescue StandardError => e
+      puts e.to_s[0, 100]
+      raise e
+    end
+
+    def bench(frames)
+      @lcd.close_window
+      frame_count = 0
+      start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC, :nanosecond)
+      while frame_count < frames
+        cycles = @cpu.exec
+        @timer.step(cycles)
+        if @ppu.step(cycles)
+          key_input_check
+          frame_count += 1
+        end
+      end
+
+      Process.clock_gettime(Process::CLOCK_MONOTONIC, :nanosecond) - start_time
+    end
+
+    private
+
+    def key_input_check
+      SDL.PumpEvents
+      keyboard = SDL.GetKeyboardState(nil)
+      keyboard_state = keyboard.read_array_of_uint8(229)
+
+      direction = (keyboard_state[SDL::SDL_SCANCODE_D]) | (keyboard_state[SDL::SDL_SCANCODE_A] << 1) | (keyboard_state[SDL::SDL_SCANCODE_W] << 2) | (keyboard_state[SDL::SDL_SCANCODE_S] << 3)
+      action = (keyboard_state[SDL::SDL_SCANCODE_K]) | (keyboard_state[SDL::SDL_SCANCODE_J] << 1) | (keyboard_state[SDL::SDL_SCANCODE_U] << 2) | (keyboard_state[SDL::SDL_SCANCODE_I] << 3)
+      @joypad.direction_button(15 - direction)
+      @joypad.action_button(15 - action)
+    end
+  end
+end

data/lib/rubyboy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rubyboy
-  VERSION = '1.3.1'
+  VERSION = '1.3.2'
 end

data/lib/rubyboy.rb

@@ -4,6 +4,7 @@ require 'rubyboy/sdl'
 require_relative 'rubyboy/apu'
 require_relative 'rubyboy/bus'
 require_relative 'rubyboy/cpu'
+require_relative 'rubyboy/emulator'
 require_relative 'rubyboy/ppu'
 require_relative 'rubyboy/rom'
 require_relative 'rubyboy/ram'
@@ -12,86 +13,3 @@ require_relative 'rubyboy/lcd'
 require_relative 'rubyboy/joypad'
 require_relative 'rubyboy/interrupt'
 require_relative 'rubyboy/cartridge/factory'
-
-module Rubyboy
-  class Console
-    CPU_CLOCK_HZ = 4_194_304
-    CYCLE_NANOSEC = 1_000_000_000 / CPU_CLOCK_HZ
-
-    def initialize(rom_path)
-      rom_data = File.open(rom_path, 'r') { _1.read.bytes }
-      rom = Rom.new(rom_data)
-      ram = Ram.new
-      mbc = Cartridge::Factory.create(rom, ram)
-      interrupt = Interrupt.new
-      @ppu = Ppu.new(interrupt)
-      @timer = Timer.new(interrupt)
-      @joypad = Joypad.new(interrupt)
-      @apu = Apu.new
-      @bus = Bus.new(@ppu, rom, ram, mbc, @timer, interrupt, @joypad, @apu)
-      @cpu = Cpu.new(@bus, interrupt)
-      @lcd = Lcd.new
-
-      RubyVM::YJIT.enable
-
-      puts "Ruby: #{RUBY_VERSION}"
-      puts "YJIT: #{RubyVM::YJIT.enabled?}"
-    end
-
-    def start
-      SDL.InitSubSystem(SDL::INIT_KEYBOARD)
-
-      start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC, :nanosecond)
-      elapsed_machine_time = 0
-      catch(:exit_loop) do
-        loop do
-          elapsed_real_time = Process.clock_gettime(Process::CLOCK_MONOTONIC, :nanosecond) - start_time
-          while elapsed_real_time > elapsed_machine_time
-            cycles = @cpu.exec
-            @timer.step(cycles)
-            @apu.step(cycles)
-            if @ppu.step(cycles)
-              @lcd.draw(@ppu.buffer)
-              key_input_check
-              throw :exit_loop if @lcd.window_should_close?
-            end
-
-            elapsed_machine_time += cycles * CYCLE_NANOSEC
-          end
-        end
-      end
-      @lcd.close_window
-    rescue StandardError => e
-      puts e.to_s[0, 100]
-      raise e
-    end
-
-    def bench
-      cnt = 0
-      start_time = Time.now
-      while cnt < 1500
-        cycles = @cpu.exec
-        @timer.step(cycles)
-        if @ppu.step(cycles)
-          key_input_check
-          cnt += 1
-        end
-      end
-
-      Time.now - start_time
-    end
-
-    private
-
-    def key_input_check
-      SDL.PumpEvents
-      keyboard = SDL.GetKeyboardState(nil)
-      keyboard_state = keyboard.read_array_of_uint8(229)
-
-      direction = (keyboard_state[SDL::SDL_SCANCODE_D]) | (keyboard_state[SDL::SDL_SCANCODE_A] << 1) | (keyboard_state[SDL::SDL_SCANCODE_W] << 2) | (keyboard_state[SDL::SDL_SCANCODE_S] << 3)
-      action = (keyboard_state[SDL::SDL_SCANCODE_K]) | (keyboard_state[SDL::SDL_SCANCODE_J] << 1) | (keyboard_state[SDL::SDL_SCANCODE_U] << 2) | (keyboard_state[SDL::SDL_SCANCODE_I] << 3)
-      @joypad.direction_button(15 - direction)
-      @joypad.action_button(15 - action)
-    end
-  end
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubyboy
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - sacckey
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-17 00:00:00.000000000 Z
+date: 2024-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -34,6 +34,7 @@ description:
 email:
 executables:
 - rubyboy
+- rubyboy-bench
 extensions: []
 extra_rdoc_files: []
 files:
@@ -45,6 +46,7 @@ files:
 - README.md
 - Rakefile
 - exe/rubyboy
+- exe/rubyboy-bench
 - lib/bench.rb
 - lib/opcodes.json
 - lib/roms/bgbtest.gb
@@ -78,6 +80,7 @@ files:
 - lib/rubyboy/cartridge/mbc1.rb
 - lib/rubyboy/cartridge/nombc.rb
 - lib/rubyboy/cpu.rb
+- lib/rubyboy/emulator.rb
 - lib/rubyboy/interrupt.rb
 - lib/rubyboy/joypad.rb
 - lib/rubyboy/lcd.rb
@@ -93,6 +96,8 @@ files:
 - lib/rubyboy/version.rb
 - resource/logo/logo.png
 - resource/logo/logo.svg
+- resource/screenshots/pokemon.png
+- resource/screenshots/puyopuyo.png
 - sig/rubyboy.rbs
 homepage: https://github.com/sacckey/rubyboy
 licenses: