conjuration 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1a2cd4153fd1fe67cf858245a3337a12f28e3bf0383a14c4ca5a98021eb446e6
+  data.tar.gz: 0b1975cf3fb9baf67802f204faaef6a91e71a2d080064eb922d22cee2ffc78ec
+SHA512:
+  metadata.gz: f655cf37edfa05b1ab4b6256a19486b31c3a406ae68c8447f02683b1b946fc13a34266c88017f6c5c332b4603187b2346e58e5988ffde8f41f8009aef4064446
+  data.tar.gz: cecba3e7696c57a11662dce317652bae03b6be7c0addd4d71ac0a2c11a1875de083709305eba38df6a22e3343f4a09fa4a44fa40841e3c0679e4668a2e823364

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,28 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  NewCops: disable
+  TargetRubyVersion: 3.3.0
+
+Metrics/AbcSize:
+  AllowedPatterns:
+    - draw_
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+Naming/MethodParameterName:
+  AllowedNames:
+    - x
+    - y
+    - id
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/.rubocop_todo.yml

@@ -0,0 +1,21 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2024-05-16 10:06:07 UTC using RuboCop version 1.63.5.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 7
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/conjuration/concerns/attributes.rb'
+    - 'lib/conjuration/game.rb'
+    - 'lib/conjuration/game_object.rb'
+    - 'lib/conjuration/managers/asset_manager.rb'
+    - 'lib/conjuration/managers/debug_manager.rb'
+    - 'lib/conjuration/managers/input_manager.rb'
+    - 'lib/conjuration/managers/scene_manager.rb'

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-05-15
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Daniel Dye
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,82 @@
+# Conjuration
+
+A Ruby 2d game engine built on [gosu/gosu](https://github.com/gosu/gosu).
+
+## Inspiration & Goals
+
+As a Ruby developer, I want a toolset that allows me to prototype games quickly and easily. I want to be able to experiment with game mechanics and ideas without having to worry about the complexities of a full game engine.
+
+- Provide a opinionated set of tools to build 2d games in Ruby.
+- Focus on simplicity and ease of experimentation.
+- Provide clear examples and documentation to help new developers get started.
+
+## Installation
+
+As the gem is based on gosu, you will need to install the gosu dependencies.
+
+- [Gosu: Getting Started on OS X](https://github.com/gosu/gosu/wiki/Getting-Started-on-OS-X)
+- [Gosu: Getting Started on Windows](https://github.com/gosu/gosu/wiki/Getting-Started-on-Windows)
+- [Gosu: Getting Started on Linux](https://github.com/gosu/gosu/wiki/Getting-Started-on-Linux)
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "conjuration"
+```
+
+> TODO: Add project generator. `conjuration new my_game`
+
+## Usage
+
+You should setup your project with the following file structure:
+
+```
+.
+├── src/
+│   ├── assets
+│   ├── game_objects
+│   ├── scenes
+│   └── game.rb
+└── main.rb
+```
+
+- `main.rb`
+
+  The entrypoint for your game. This is where you require the game file and start the game.
+
+  > TODO: Pull this into a bin script. `conjuration run`
+
+- `src/game.rb`
+
+  The main game class. This is where you add your initial scene.
+
+  ```ruby
+  class Game < Conjuration::Game
+    def initialize
+      super(title: "My Game")
+
+      scene_manager.add_scene(:main_menu, MainMenuScene)
+      scene_manager.set_scene(:main_menu)
+    end
+  end
+  ```
+
+- `src/scenes`
+
+  This is where you define each of your game scenes. Each scene should inherit from `Conjuration::Scene`.
+
+- `src/game_objects`
+
+  This is where you define your game objects. Each game object should inherit from `Conjuration::GameObject`.
+
+- `src/assets`
+
+  This is where you store your game assets. This can include images, sounds, and other resources.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Nitemaeric/conjuration.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/conjuration/concerns/attributes.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+# Attributes
+#
+# This module provides a way to define inspectable attributes for a class.
+# It provides readers and writers for each attribute, and an inspect method that
+# displays only defined attributes.
+#
+# Instance variables are not added to the inspect output.
+#
+# Usage:
+#
+#   class Person
+#     include Attributes
+#
+#     attribute :name
+#     attribute :age
+#   end
+#
+# person = Person.new
+# person.name = "Alice"
+# person.age = 30
+# person.inspect # => "<Person name: \"Alice\", age: 30>"
+#
+module Attributes
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  def initialize(...)
+    super()
+
+    @attributes = {}
+  end
+
+  def inspect
+    "<#{self.class} #{@attributes.map { |attribute_name, value| "#{attribute_name}: #{value.inspect}" }.join(", ")}>"
+  end
+
+  module ClassMethods
+    def attribute(attribute_name)
+      define_method(attribute_name) do
+        @attributes[attribute_name]
+      end
+
+      define_method("#{attribute_name}=") do |value|
+        @attributes[attribute_name] = value
+      end
+    end
+
+    def boolean_attribute(attribute_name)
+      attribute(attribute_name)
+
+      define_method("#{attribute_name}?") do
+        !!@attributes[attribute_name]
+      end
+    end
+  end
+end

data/lib/conjuration/game.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Conjuration
+  class Game < ::Gosu::Window
+    attr_reader :debug_manager, :scene_manager, :input_manager, :target_fps
+
+    def initialize(title:, target_fps: 120, **options)
+      super(1920, 1080, update_interval: 1000.0 / target_fps, **options)
+
+      self.caption = title
+
+      @debug_manager = DebugManager.new
+      @scene_manager = SceneManager.new(self)
+      @input_manager = InputManager.new
+
+      @target_fps = target_fps
+    end
+
+    def update
+      @scene_manager.update(self)
+    end
+
+    def draw
+      @scene_manager.draw(self)
+      @debug_manager.draw(self)
+    end
+
+    def button_down(id)
+      @scene_manager.button_down(self, @input_manager.map_button(id))
+      @debug_manager.button_down(self, id)
+    end
+
+    def button_up(id)
+      @scene_manager.button_up(self, @input_manager.map_button(id))
+    end
+  end
+end

data/lib/conjuration/game_object.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Conjuration
+  class GameObject
+    include Attributes
+
+    attribute :name
+    attribute :x
+    attribute :y
+    attribute :width
+    attribute :height
+
+    boolean_attribute :hovering
+    attribute :clicking
+
+    boolean_attribute :visible
+
+    def initialize(x:, y:, width:, height:)
+      super
+
+      self.x = x
+      self.y = y
+      self.width = width
+      self.height = height
+      self.hovering = false
+      self.clicking = Hash.new(false)
+    end
+
+    def self.create(*args, scene:, **kwargs, &block)
+      game_object = new(*args, **kwargs, &block)
+      scene.add_object(game_object)
+      game_object
+    end
+
+    def mouse_position(context)
+      mouse_exited(context)
+      mouse_entered(context)
+    end
+
+    # =====
+    # Helpers
+    # =====
+
+    def in_bounds?(context)
+      context.mouse_x >= x &&
+        context.mouse_x <= x + width &&
+        context.mouse_y >= y &&
+        context.mouse_y <= y + height
+    end
+
+    # ==========
+    # Abstract Methods
+    # ==========
+
+    def draw(context); end
+    def on_click(context, key); end
+    def on_mouse_down(context, key); end
+    def on_mouse_up(context, key); end
+
+    # ==========
+    # Hovering
+    # ==========
+
+    def mouse_exited(context)
+      return unless hovering && !in_bounds?(context)
+
+      self.hovering = false
+    end
+
+    def mouse_entered(context)
+      return unless !hovering && in_bounds?(context)
+
+      self.hovering = true
+    end
+
+    # ==========
+    # Clicking
+    # ==========
+
+    def mouse_down(context, key)
+      on_mouse_down(context, key)
+
+      return unless !clicking[key] && context.input_manager.button_down?(key) && in_bounds?(context)
+
+      clicking[key] = true
+    end
+
+    def mouse_up(context, key)
+      on_mouse_up(context, key)
+
+      on_click(context, key) if clicking[key] && !context.input_manager.button_down?(key) && in_bounds?(context)
+
+      clicking[key] = false
+    end
+  end
+end

data/lib/conjuration/managers/asset_manager.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Conjuration
+  class AssetManager
+    def self.load_image(asset_path)
+      Gosu::Image.new(asset_path)
+    end
+  end
+end

data/lib/conjuration/managers/debug_manager.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Conjuration
+  class DebugManager
+    include Attributes
+
+    boolean_attribute :enabled
+
+    boolean_attribute :show_fps
+    boolean_attribute :show_grid
+    boolean_attribute :show_coordinates
+
+    def initialize
+      super
+
+      self.enabled = false
+
+      self.show_fps = false
+      self.show_grid = false
+      self.show_coordinates = false
+    end
+
+    def draw(window)
+      return unless enabled?
+
+      draw_menu(window)
+
+      draw_fps(window) if show_fps?
+      draw_grid(window) if show_grid?
+      draw_coordinates(window) if show_coordinates?
+    end
+
+    def button_down(_window, id)
+      self.enabled = !enabled if id == Gosu::KB_F12
+
+      return unless enabled?
+
+      case id
+      when Gosu::KB_F1
+        self.show_fps = !show_fps
+      when Gosu::KB_F2
+        self.show_grid = !show_grid
+      when Gosu::KB_F3
+        self.show_coordinates = !show_coordinates
+      end
+    end
+
+    private
+
+    def font
+      @font ||= Gosu::Font.new(12)
+    end
+
+    def draw_menu(window)
+      font.draw_text("Debug Menu", window.width - 5 - font.text_width("Debug Menu"), 20, 1, 1, 1, Gosu::Color::GREEN)
+      font.draw_text("F1: Toggle FPS", window.width - 5 - font.text_width("F1: Toggle FPS"), 35, 1, 1, 1,
+                     Gosu::Color::GREEN)
+      font.draw_text("F2: Toggle Grid", window.width - 5 - font.text_width("F2: Toggle Grid"), 50, 1, 1, 1,
+                     Gosu::Color::GREEN)
+      font.draw_text("F3: Toggle Coordinates", window.width - 5 - font.text_width("F3: Toggle Coordinates"), 65, 1, 1,
+                     1, Gosu::Color::GREEN)
+    end
+
+    def draw_fps(window)
+      font.draw_text(Gosu.fps, window.width - 5 - font.text_width(Gosu.fps), 5, 1, 1, 1, Gosu::Color::GREEN)
+    end
+
+    def draw_grid(window)
+      (window.width / 20).times do |column|
+        window.draw_line(column * 20, 0, Gosu::Color::GREEN, column * 20, window.height, Gosu::Color::GREEN)
+      end
+
+      (window.height / 20).times do |row|
+        window.draw_line(0, row * 20, Gosu::Color::GREEN, window.width, row * 20, Gosu::Color::GREEN)
+      end
+    end
+
+    def draw_coordinates(window)
+      label = "#{window.mouse_x.to_i}, #{window.mouse_y.to_i}"
+      label_width = font.text_width(label)
+
+      label_x = if window.mouse_x + 5 + label_width > window.width
+                  window.mouse_x - 5 - label_width
+                else
+                  window.mouse_x + 5
+                end
+
+      label_y = window.mouse_y - 5
+
+      font.draw_text(label, label_x, label_y, 1, 1, 1, Gosu::Color::GREEN)
+    end
+  end
+end

data/lib/conjuration/managers/input_manager.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Conjuration
+  class InputManager
+    LEFT_CLICK = :left_click
+    RIGHT_CLICK = :right_click
+
+    UP = :up
+    LEFT = :left
+    DOWN = :down
+    RIGHT = :right
+
+    def map_button(key_id)
+      input_map[key_id]
+    end
+
+    def button_down?(action)
+      action_map[action].any? { |key_id| Gosu.button_down?(key_id) }
+    end
+
+    # Returns a hash of actions mapped to key bindings.
+    #
+    # { action => [key_id] }
+    def action_map
+      @action_map ||= {
+        LEFT_CLICK => [Gosu::MsLeft],
+        RIGHT_CLICK => [Gosu::MsRight],
+
+        UP => [Gosu::KbUp, Gosu::GpUp, Gosu::KB_W],
+        LEFT => [Gosu::KbLeft, Gosu::GpLeft, Gosu::KB_A],
+        DOWN => [Gosu::KbDown, Gosu::GpDown, Gosu::KB_S],
+        RIGHT => [Gosu::KbRight, Gosu::GpRight, Gosu::KB_D]
+      }
+    end
+
+    # Returns a hash of key bindings mapped to actions.
+    #
+    # { key_id => action }
+    def input_map
+      @input_map ||= action_map.each_with_object({}) do |(action, key_ids), hash|
+        key_ids.each do |key_id|
+          hash[key_id] = action
+        end
+      end
+    end
+  end
+end

data/lib/conjuration/managers/scene_manager.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Conjuration
+  class SceneManager
+    def initialize(window)
+      @scenes = {}
+      @window = window
+    end
+
+    def add_scene(key, scene_class)
+      @scenes[key] = scene_class
+    end
+
+    def set_scene(_scene_class, options = {})
+      @current_scene = @scenes[key].new(@window, options)
+    end
+
+    attr_reader :current_scene
+
+    # ====================
+
+    def update(window)
+      current_scene.update(window)
+    end
+
+    def draw(window)
+      current_scene.draw(window)
+    end
+
+    def button_down(window, id)
+      current_scene.button_down(window, id)
+    end
+
+    def button_up(window, id)
+      current_scene.button_up(window, id)
+    end
+  end
+end

data/lib/conjuration/scene.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Conjuration
+  # Keeps track of game objects and manages their updates, draws, mouse, and keyboard events.
+  class Scene
+    include Attributes
+
+    attr_reader :window
+
+    def initialize(window, options = {})
+      super
+
+      @window = window
+      @game_objects = []
+      @asset_manager = AssetManager.new
+    end
+
+    def add_object(game_object)
+      @game_objects << game_object
+    end
+
+    def set_background(asset_path)
+      @background_image = AssetManager.load_image(asset_path)
+    end
+
+    # ==========
+    # Abstract Methods
+    # ==========
+
+    def update(context)
+      @game_objects.each { |game_object| game_object.mouse_position(context) }
+    end
+
+    def draw(context)
+      @background_image&.draw(0, 0, 0, context.width.to_f / @background_image.width,
+                              context.height.to_f / @background_image.height)
+      @game_objects.each { |game_object| game_object.draw(context) }
+    end
+
+    def button_down(context, key)
+      @game_objects.each { |game_object| game_object.mouse_down(context, key) }
+    end
+
+    def button_up(context, key)
+      @game_objects.each { |game_object| game_object.mouse_up(context, key) }
+    end
+  end
+end

data/lib/conjuration/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Conjuration
+  VERSION = "0.1.2"
+end

data/lib/conjuration.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "gosu"
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+module Conjuration
+  class Error < StandardError; end
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: conjuration
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Daniel Dye
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gosu
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.14
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.6.14
+description:
+email:
+- dnitemaeric@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/conjuration.rb
+- lib/conjuration/concerns/attributes.rb
+- lib/conjuration/game.rb
+- lib/conjuration/game_object.rb
+- lib/conjuration/managers/asset_manager.rb
+- lib/conjuration/managers/debug_manager.rb
+- lib/conjuration/managers/input_manager.rb
+- lib/conjuration/managers/scene_manager.rb
+- lib/conjuration/scene.rb
+- lib/conjuration/version.rb
+homepage: https://github.com/nitemaeric/conjuration
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nitemaeric/conjuration
+  source_code_uri: https://github.com/nitemaeric/conjuration
+  changelog_uri: https://github.com/nitemaeric/conjuration/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
+summary: A Ruby game engine built on top of Gosu.
+test_files: []