hemi 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3840aa088a24e90ff6a1e10d139624c38ecced3a7676aa2f4f11fb46fc433854
+  data.tar.gz: 3c36fcc6e2eb00cdee1fad4c188c4c3ee3c1ea685ff35a6143daa2d2a565d00c
+SHA512:
+  metadata.gz: 6c67aee68830d5607901848659891a56330b6dbecc8c2a5ed06ac83bf911359735635b3e7a9aed1a260898ff0a654e0bbc45ee3d3c5c228cc49c34d982c25494
+  data.tar.gz: 4c2687fb05a4d4ac2f22c3378fb991494c36ad5fb64b46f6d769ac22dc0683bd62efac113d07cf8bb8e65dec0f0a0810eea542f2b8dedd8ee5a4469ce700083c

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+.DS_store
+.bundle/
+.yardoc/
+
+vendor/bundle/
+examples/
+

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper --format doc -I src
+--color
+--order random

data/.rubocop.yml

@@ -0,0 +1,50 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+# METRICS
+MethodLength:
+  CountComments: false
+  Max: 15
+  Exclude:
+    - 'spec/**/*'
+Metrics/LineLength:
+  Enabled: false
+Metrics/AbcSize:
+  Max: 25
+  Exclude:
+    - 'spec/**/*'
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+# LAYOUT
+Layout/DotPosition:
+  EnforcedStyle: leading
+  Enabled: true
+Layout/ExtraSpacing:
+  Enabled: false
+Layout/SpaceAroundOperators:
+  Enabled: false
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+Layout/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+# STYLE
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+
+# RSPEC
+RSpec/ContextWording:
+  Enabled: false
+RSpec/NamedSubject:
+  Enabled: false
+RSpec/NestedGroups:
+  Max: 5

data/.ruby-version

@@ -0,0 +1 @@
+2.6.6

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    hemi (0.0.1)
+      ruby-sdl2 (= 0.3.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.4)
+    method_source (0.9.2)
+    parallel (1.19.1)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.77.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.5.1)
+      rubocop (>= 0.71.0)
+    rubocop-rspec (1.37.0)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    ruby-sdl2 (0.3.5)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  hemi!
+  pry (~> 0.12)
+  rspec (~> 3.9)
+  rubocop (~> 0.77)
+  rubocop-performance (~> 1.5)
+  rubocop-rspec (~> 1.37)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,20 @@
+# Hemi
+
+## Whatshisface
+This is a _Work In Progress_ simplistic game engine based on SDL2.
+
+Made for self-educational purposes.
+
+## Setup
+
+#### 1. Required libraries
+
+Install `sdl2`, `sdl2_image`, `sdl2_mixer` and `sdl2_ttf` libraries. For MacOS you can simply `brew install` all of them.
+
+#### 2. Install Ruby and gems
+
+Install specific ruby version using Rbenv (`rbenv install`) or RVM (yuck)
+
+Make sure you have Bundler gem installed for this revsion (`gem install bundler -v=1.17.3`)
+
+And `bundle install` away.

data/hemi.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hemi/version"
+
+ERR_RG_2_REQUIRED = "RubyGems 2.0 or newer is required to protect against public gem pushes.".freeze
+
+Gem::Specification.new do |spec|
+  # RubyGems < 2.0 does not allow to specify metadata. We do not want to use RubyGems < 2.0
+  raise ERR_RG_2_REQUIRED unless spec.respond_to?(:metadata)
+
+  spec.name     = "hemi"
+  spec.version  = Hemi::VERSION.dup
+  spec.date     = "2020-12-21"
+  spec.summary  = "A simplistic game engine based on SDL2. Because I can."
+  spec.authors  = ["Jakub Żuchowski"]
+  spec.email    = "ellmo@ellmo.net"
+  spec.homepage = "https://github.com/ellmo/hemi"
+  spec.license  = "MIT"
+  # Fetch all git-versioned files, excluding all vendor, test, demo and example locations.
+  spec.files    = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(.bundle|demo|examples|spec|features|vendor|assets)/})
+  end
+
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.add_dependency "pry", "~> 0.12"
+  spec.add_dependency "ruby-sdl2", "0.3.5"
+
+  spec.add_development_dependency "rspec", "~> 3.9"
+  spec.add_development_dependency "rubocop", "~> 0.77"
+  spec.add_development_dependency "rubocop-performance", "~> 1.5"
+  spec.add_development_dependency "rubocop-rspec", "~> 1.37"
+end

data/lib/hemi/engine.rb

@@ -0,0 +1,58 @@
+require "singleton"
+require "sdl2"
+
+require_relative "loader"
+
+module Hemi
+  module Engine
+    @debug = false
+
+    def initialize
+      sdl_init
+      super
+    end
+
+    attr_reader :window
+
+    def sdl_init
+      SDL2.init(SDL2::INIT_EVERYTHING)
+    end
+
+    class << self
+      attr_reader :debug
+
+      def prepended(klass)
+        klass.include Singleton
+
+        Loader.load_tree "helpers"
+        Loader.load_tree "render"
+        Loader.load_tree "input"
+        Loader.load_tree "event"
+      end
+
+      def debug_on!
+        @debug = true
+      end
+
+      def debug_off!
+        @debug = false
+      end
+    end
+
+    def run
+      super if defined?(super)
+      init_window
+      start_loop
+    end
+
+  private
+
+    def init_window
+      @window = Hemi::Render::Window.instance
+    end
+
+    def start_loop
+      Hemi::Event::LoopMachine.instance.call
+    end
+  end
+end

data/lib/hemi/event/event_loop.rb

@@ -0,0 +1,52 @@
+module Hemi::Event
+  class EventLoop
+
+    def initialize(logic, events)
+      @logic  = logic
+      @events = events.each_with_object({}) do |(key, action), hsh|
+        hsh[SDL2::Key::Scan.const_get(key.upcase)] = action
+      end
+    end
+
+    attr_reader :logic, :events, :event
+
+    def handle(event)
+      @event = event
+
+      case event
+      when SDL2::Event::KeyDown
+        handle_key
+      end
+
+      @event = nil
+    end
+
+    def process
+      logic.call
+    end
+
+  private
+
+    def handle_key
+      if (action = events[event.scancode]).is_a? Symbol
+        instance_eval action.to_s
+      else
+        action.call
+      end
+    end
+
+    def key_event?
+      event.is_a?
+    end
+
+    def key_down
+      return unless key_event?
+
+      SDL2::Key::Scan.const_get(event.scancode).downcase
+    end
+
+    def debug!
+      Hemi::Engine.debug_on!
+    end
+  end
+end

data/lib/hemi/event/loop_machine.rb

@@ -0,0 +1,62 @@
+module Hemi::Event
+  class LoopMachine
+    include Singleton
+
+    @loops   = {}
+    @current = nil
+
+    attr_reader :event
+
+    def call
+      loop do
+        Hemi::Render::Window.wipe_screen
+
+        handle_events while poll_event
+        process_logic
+
+        Hemi::Render::Window.renderer.present
+        debug!
+        sleep 0.1
+      end
+    end
+
+    class << self
+      attr_reader :loops, :current
+
+      def register(name, logic, events)
+        event_loop   = EventLoop.new(logic, events)
+        @current     = event_loop if loops.empty?
+        @loops[name] = event_loop
+
+        event_loop
+      end
+
+      def [](name)
+        @loops[name]
+      end
+
+      def switch(name)
+        @current = LoopMachine[name]
+      end
+    end
+
+  private
+
+    def handle_events
+      LoopMachine.current.handle event
+    end
+
+    def process_logic
+      LoopMachine.current.process
+    end
+
+    def poll_event
+      @event = SDL2::Event.poll
+    end
+
+    def debug!
+      binding.pry if Hemi::Engine.debug # rubocop:disable Lint/Debugger
+      Hemi::Engine.debug_off!
+    end
+  end
+end

data/lib/hemi/helpers/simple.rb

@@ -0,0 +1,2 @@
+Size     = Struct.new(:width, :height, keyword_init: true)
+Position = Struct.new(:x, :y, keyword_init: true)

data/lib/hemi/loader.rb

@@ -0,0 +1,13 @@
+module Hemi
+  module Loader
+    def self.load_tree(tree_dir)
+      if File.exist?(manifest_file = File.join(__dir__, tree_dir, "_manifest.rb"))
+        require manifest_file
+      else
+        Dir[File.join(__dir__, tree_dir, "**", "*.rb")].sort.each do |file|
+          require file
+        end
+      end
+    end
+  end
+end

data/lib/hemi/render/_manifest.rb

@@ -0,0 +1,4 @@
+require_relative "window"
+require_relative "texture"
+require_relative "sprite"
+require_relative "font"

data/lib/hemi/render/font.rb

@@ -0,0 +1,55 @@
+module Hemi::Render
+  class Font < Texture
+    SDL2::TTF.init
+
+    ALLOWED_MODES = %i[solid blended shaded].freeze
+    FONT_FILE_PATTERN = /([\w-]*)_([\d]*)/.freeze
+
+    # ERR__INVALID_FONT_NAME = "Invalid font name format. :font_name_size expected".freeze
+    # ERR__INVALID_TEXTURE_SIZE = "Invalid texture size.".freeze
+    # ERR__INVALID_POSITION     = "Ivalid position.".freeze
+
+    @fonts = {}
+
+    def initialize(name_size)
+      name, size = *name_size.to_s.scan(FONT_FILE_PATTERN).flatten
+      @font_path = "assets/fonts/#{name}.ttf"
+      @font      = SDL2::TTF.open(font_path, size.to_i)
+
+      Font.register(name_size, self)
+    rescue SDL2::Error => _e
+      raise ArgumentError, format(ERR__FONT_NOT_FOUND, font_path)
+    end
+
+    attr_reader :font_path, :size, :font
+
+    def render(text, position: nil, mode: :blended)
+      @texture = Hemi::Render::Window
+                 .renderer
+                 .create_texture_from(surface(text, mode: mode))
+      Hemi::Render::Window.renderer.copy(texture, nil, rectangle(position: position))
+    end
+
+    class << self
+      attr_reader :fonts
+
+      def bucket
+        :fonts
+      end
+    end
+
+  private
+
+    def surface(text, color: [255, 255, 255], mode: :blended, shade: [0, 0, 0])
+      raise(ERR__INVALID_MODE) unless ALLOWED_MODES.include? mode
+
+      case mode
+      when :blended, :solid
+        font.send("render_#{mode}", text, color)
+      when :shaded
+        font.render_shaded(text, color, shade)
+      end
+    end
+
+  end
+end

data/lib/hemi/render/sprite.rb

@@ -0,0 +1,26 @@
+module Hemi::Render
+  class Sprite < Texture
+    ERR__IMAGE_NOT_FOUND = "Image %s not found.".freeze
+
+    @sprites = {}
+
+    def initialize(name)
+      @texture = Hemi::Render::Window.renderer.load_texture("assets/img/#{name}.bmp")
+      Sprite.register(name, self)
+    rescue SDL2::Error => _e
+      raise ArgumentError, format(ERR__IMAGE_NOT_FOUND, font_path)
+    end
+
+    def render(position: nil, size: nil)
+      Hemi::Render::Window.renderer.copy(texture, nil, rectangle(position: position, size: size))
+    end
+
+    class << self
+      attr_reader :sprites
+
+      def bucket
+        :sprites
+      end
+    end
+  end
+end

data/lib/hemi/render/texture.rb

@@ -0,0 +1,75 @@
+module Hemi::Render
+  class Texture
+    ERR__INVALID_POSITION = "Ivalid position.".freeze
+
+    def initialize(name)
+      raise NotImplementedError
+    end
+
+    attr_reader :texture
+
+    def render
+      raise NotImplementedError
+    end
+
+    class << self
+      def register(name, texture)
+        public_send(bucket)[name] ||= texture
+      end
+
+      def [](name)
+        public_send(bucket)[name] || new(name)
+      end
+
+      def purge!
+        instance_variable_set "@#{bucket}", {}
+      end
+
+      def bucket
+        raise NotImplementedError
+      end
+    end
+
+  private
+
+    def rectangle(size: nil, position: nil)
+      SDL2::Rect.new(*calculate_position(position), *calculate_size(size))
+    end
+
+    def calculate_size(size = nil)
+      size_obj = Size.new(height: nil, width: nil)
+
+      if size.is_a? Array
+        size_obj.height = size[0]
+        size_obj.width  = size[1]
+      elsif size.is_a? Hash
+        size_obj.height = size[:height]
+        size_obj.width  = size[:width]
+      else
+        size_obj.height = texture.h
+        size_obj.width  = texture.w
+      end
+
+      size_obj
+    end
+
+    def calculate_position(position = nil)
+      position_obj = Position.new(x: nil, y: nil)
+
+      if position.nil?
+        position_obj.x = 0
+        position_obj.y = 0
+      elsif position.is_a? Array
+        position_obj.x = position[0]
+        position_obj.y = position[1]
+      elsif position.is_a? Hash
+        position_obj.x = position[:x]
+        position_obj.y = position[:y]
+      else
+        raise ArgumentError(ERR__INVALID_POSITION)
+      end
+
+      position_obj
+    end
+  end
+end

data/lib/hemi/render/window.rb

@@ -0,0 +1,37 @@
+module Hemi::Render
+  class Window
+    include Singleton
+
+    DEFAULT_WINDOW_WIDTH  = 640
+    DEFAULT_WINDOW_HEIGHT = 480
+
+    def initialize(width = DEFAULT_WINDOW_WIDTH, height = DEFAULT_WINDOW_HEIGHT)
+      @size = Size.new(width: width, height: height)
+    end
+
+    attr_reader :size
+
+    def renderer
+      @renderer ||= sdl_window.create_renderer(-1, 0)
+    end
+
+    def sdl_window
+      @sdl_window ||= SDL2::Window.create(
+        "Hemi",
+        SDL2::Window::POS_CENTERED,
+        SDL2::Window::POS_CENTERED,
+        *size,
+        0
+      )
+    end
+
+    def self.wipe_screen
+      instance.renderer.draw_color = [0, 0, 0]
+      instance.renderer.fill_rect(SDL2::Rect.new(0, 0, *instance.size))
+    end
+
+    def self.renderer
+      instance.renderer
+    end
+  end
+end

data/lib/hemi/version.rb

@@ -0,0 +1,3 @@
+module Hemi
+  VERSION = "0.0.2".freeze
+end

data/lib/hemi.rb

@@ -0,0 +1,4 @@
+require "sdl2"
+require "pry"
+require "hemi/version"
+require "hemi/engine"

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: hemi
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Jakub Żuchowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: ruby-sdl2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.5
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.77'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.77'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.37'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.37'
+description: 
+email: ellmo@ellmo.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- README.md
+- hemi.gemspec
+- lib/hemi.rb
+- lib/hemi/engine.rb
+- lib/hemi/event/event_loop.rb
+- lib/hemi/event/loop_machine.rb
+- lib/hemi/helpers/self_manager.rb
+- lib/hemi/helpers/simple.rb
+- lib/hemi/loader.rb
+- lib/hemi/render/_manifest.rb
+- lib/hemi/render/font.rb
+- lib/hemi/render/sprite.rb
+- lib/hemi/render/texture.rb
+- lib/hemi/render/window.rb
+- lib/hemi/version.rb
+homepage: https://github.com/ellmo/hemi
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A simplistic game engine based on SDL2. Because I can.
+test_files: []