ruby_rpg 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bb1056bb375c7c3ebbbdf7b2b23f1b5ad1fd6ddec9c0f2e63713aef56f345f7
-  data.tar.gz: bead66754d17fafe491808aa0cef827cbc789ea718e61e114b53599b2c619b43
+  metadata.gz: b56f66eb45701f903472f4d948d42e1a67a9bf051c59e0515ee8df1195503d7e
+  data.tar.gz: 35e50569d84181202098fd7425025ef73bdc54d0d7eae16bef0ad0acbe1fb6fb
 SHA512:
-  metadata.gz: c3560e6b6aad6e80b3ace11b49c86a671eea0634b05b57383358921520502c476f0147f4aa39a21852149a8c4c866888cdd23aeee28fcb90517d5da975f385a5
-  data.tar.gz: 55c62ec5c13331a3bef15c3badac233bb23d66fca4c3d3cd273161e66c256ba6032ccc47c552c1c474ba9f3ff21e12fb0211de215aaa10e200283829f19a85fb
+  metadata.gz: '08ec8719dae3c6788e4aa692059706ed9635b540974164339c4a5887dc0a0a420b48d8b7abc4022f87b899b8e2c02674d060107ec8c3dad06dcd6431add8f433'
+  data.tar.gz: a65cadf65c339c7b656c825dfa1ea6365e6fb2c94f090396b3e11c4e515d78b45819447bd186ebfb79424ed5fc25689d66cb4ed4a59b76c7e0ad7b5d943a187d

data/README.md

@@ -5,10 +5,12 @@ It is designed to be easy to use and easy to extend.
 It is still in the early stages of development, but it is already capable of rendering both 2D and 3D graphics.
 
 ## Installation
-TODO: Write installation instructions here
+You can find full instructions on th [wiki](https://github.com/rubyrpg/ruby_rpg/wiki/Installation).
 
 ## Usage
-TODO: Write usage instructions here
+You can find docs and guides on the [wiki](https://github.com/rubyrpg/ruby_rpg/wiki).
+For a basic example to get you up off the ground take a look at [hello_ruby_rpg](https://github.com/rubyrpg/hello_ruby_rpg).
+For some more complex examples you can take a look in the samples folder of this repo.
 
 ## Contributing
 1. Fork it

data/{lib → bin}/build.bash

@@ -5,8 +5,9 @@ output_file=$2
 
 export BUILDING=true
 
+parent_path=$( cd "$(dirname "${BASH_SOURCE[0]}")" ; pwd -P )
+glfw_path=$parent_path/../glfw-3.4.bin.WIN64
+
 ocran $input_file \
-      **/*.png **/*.obj **/*.glsl **/*.vertex_data **/*.index_data **/*.json **/*.csv glfw-3.4.bin.WIN64/**/* src/**/*.rb \
+      **/*.png **/*.obj **/*.glsl **/*.vertex_data **/*.index_data **/*.json **/*.csv $glfw_path/**/* src/**/*.rb \
       --output $output_file
-
-

data/lib/engine/autoloader.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Engine
+  module AutoLoader
+    def self.load(load_path = nil)
+      base_dir = File.expand_path(load_path || File.dirname($PROGRAM_NAME))
+      Dir[File.join(base_dir, "components", "**/*.rb")].each { |file| require file }
+      Dir[File.join(base_dir, "game_objects", "**/*.rb")].each { |file| require file }
+    end
+  end
+end

data/lib/engine/component.rb

@@ -30,8 +30,12 @@ module Engine
     end
 
     def destroy!
+      Component.destroyed_components << self unless @destroyed
+      destroy unless @destroyed
       @destroyed = true
-      destroy
+    end
+
+    def _erase!
       game_object.components.delete(self)
       class_name = self.class.name.split('::').last
       self.class.instance_variable_get(:@methods).each do |method|
@@ -42,7 +46,18 @@ module Engine
       end
     end
 
+    def self.erase_destroyed_components
+      destroyed_components.each do |object|
+        object._erase!
+      end
+      @destroyed_components = []
+    end
+
     def destroy
     end
+
+    def self.destroyed_components
+      @destroyed_components ||= []
+    end
   end
 end

data/lib/engine/components/audio_source.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Engine::Components
+  class AudioSource < Engine::Component
+    def initialize(clip, radius: 1000)
+      @clip = clip
+      @radius = radius
+      @source = NativeAudio::AudioSource.new(clip)
+    end
+
+    def play
+      @source.play
+    end
+
+    def stop
+      @source.stop
+    end
+
+    def pause
+      @source.pause
+    end
+
+    def resume
+      @source.resume
+    end
+
+    def volume=(volume)
+      @source.set_volume(volume)
+    end
+
+    def update(delta_time)
+      camera = Engine::Camera.instance
+      local_pos = camera.game_object.world_to_local_coordinate(game_object.pos)
+      angle = Math.atan2(local_pos[0], -local_pos[2]) * 180 / Math::PI
+      angle = (angle + 360) % 360
+      distance = (local_pos.magnitude * 255 / @radius).clamp(0, 255)
+      
+      @source.set_pos(angle, distance)
+    end
+  end
+end

data/lib/engine/debugging.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Engine
+  module Debugging
+
+    # Hit a breakpoint within the context of where the breakpoint is defined, assuming a block is passed
+    # with a `binding.pry` (or an alternative debugger), otherwise hit a breakpoint within this method.
+    def self.breakpoint(&block)
+      orig_fullscreen = Window.full_screen?
+      if orig_fullscreen
+        Window.set_to_windowed
+        GLFW.PollEvents # Required to trigger the switch from fullscreen to windowed within this breakpoint
+      end
+
+      orig_cursor_mode = Cursor.get_input_mode
+      Cursor.enable
+
+      block_given? ? yield : binding.pry
+      Cursor.restore_input_mode(orig_cursor_mode)
+      Window.set_to_full_screen if orig_fullscreen
+      Window.focus_window
+
+      # Reset the time, otherwise delta_time will be off for the next frame, and teleporting occurs
+      @time = Time.now
+    end
+
+    def self.debug_opengl_call
+      errors = []
+      until GL.GetError == 0; end
+      yield
+      until (error = GL.GetError) == 0
+        errors += error.to_s(16)
+      end
+    end
+
+    def self.print_opengl_version
+      puts "OpenGL Version: #{GL.GetString(GL::VERSION)}"
+      puts "GLSL Version: #{GL.GetString(GL::SHADING_LANGUAGE_VERSION)}"
+    end
+  end
+end

data/lib/engine/engine.rb

@@ -1,55 +1,10 @@
-require 'opengl'
-require 'glfw'
-require 'concurrent'
-require 'os'
-
-require_relative 'rendering/render_pipeline'
-require_relative 'rendering/instance_renderer'
-require_relative 'screenshoter'
-require_relative 'input'
-require_relative "quaternion"
-require_relative 'game_object'
-require_relative 'texture'
-require_relative 'material'
-require_relative 'mesh'
-require_relative "font"
-require_relative 'path'
-require_relative 'polygon_mesh'
-require_relative 'importers/obj_file'
-require_relative 'tangent_calculator'
-require_relative 'shader'
-require_relative 'component'
-require_relative "camera"
-require_relative "window"
-require_relative "video_mode"
-require_relative "cursor"
-
-require_relative "components/orthographic_camera"
-require_relative "components/perspective_camera"
-require_relative "components/sprite_renderer"
-require_relative "components/ui_sprite_renderer"
-require_relative "components/mesh_renderer"
-require_relative "components/font_renderer"
-require_relative "components/ui_font_renderer"
-require_relative "components/point_light"
-require_relative "components/direction_light"
-
-require_relative "physics/physics_resolver"
-require_relative 'physics/collision'
-require_relative "physics/components/sphere_collider"
-require_relative "physics/components/cube_collider"
-require_relative "physics/components/rigidbody"
-
-if OS.windows?
-  GLFW.load_lib(File.expand_path(File.join(__dir__, "..", "..", "glfw-3.4.bin.WIN64", "lib-static-ucrt", "glfw3.dll")))
-elsif OS.mac?
-  GLFW.load_lib(File.expand_path(File.join(__dir__, "..", "..", "glfw-3.3.9.bin.MACOS", "lib-arm64", "libglfw.3.dylib")))
-end
-GLFW.Init
+# frozen_string_literal: true
+
+GAME_DIR = File.expand_path(File.dirname($PROGRAM_NAME))
 
 module Engine
-  def self.start(base_dir:, &first_frame_block)
-    load(base_dir)
+  def self.start(&first_frame_block)
+    Engine::AutoLoader.load
     return if ENV["BUILDING"] == "true"
 
     open_window
@@ -61,12 +16,6 @@ module Engine
     @engine_started
   end
 
-  def self.load(base_dir)
-    base_dir = File.expand_path(base_dir)
-    Dir[File.join(base_dir, "components", "**/*.rb")].each { |file| require file }
-    Dir[File.join(base_dir, "game_objects", "**/*.rb")].each { |file| require file }
-  end
-
   def self.open_window
     @old_time = Time.now
     @time = Time.now
@@ -144,13 +93,10 @@ module Engine
     @fps
   end
 
-  def self.terminate
-    GLFW.DestroyWindow(Window.window)
-    GLFW.Terminate
-  end
-
   def self.close
     GameObject.destroy_all
+    Component.erase_destroyed_components
+    GameObject.erase_destroyed_objects
     GLFW.SetWindowShouldClose(Window.window, 1)
   end
 
@@ -158,31 +104,17 @@ module Engine
     @game_stopped = true
     @swap_buffers_promise.wait! if @swap_buffers_promise && !@swap_buffers_promise.complete?
     GameObject.destroy_all
+    Component.erase_destroyed_components
+    GameObject.erase_destroyed_objects
   end
 
-  # Hit a breakpoint within the context of where the breakpoint is defined, assuming a block is passed
-  # with a `binding.pry` (or an alternative debugger), otherwise hit a breakpoint within this method.
-  def self.breakpoint(&block)
-    orig_fullscreen = Window.full_screen?
-    if orig_fullscreen
-      Window.set_to_windowed
-      GLFW.PollEvents # Required to trigger the switch from fullscreen to windowed within this breakpoint
-    end
-
-    orig_cursor_mode = Cursor.get_input_mode
-    Cursor.enable
-
-    block_given? ? yield : binding.pry
-    Cursor.restore_input_mode(orig_cursor_mode)
-    Window.set_to_full_screen if orig_fullscreen
-    Window.focus_window
+  private
 
-    # Reset the time, otherwise delta_time will be off for the next frame, and teleporting occurs
-    @time = Time.now
+  def self.terminate
+    GLFW.DestroyWindow(Window.window)
+    GLFW.Terminate
   end
 
-  private
-
   def self.print_fps(delta_time)
     @time_since_last_fps_print = (@time_since_last_fps_print || 0) + delta_time
     @frame = (@frame || 0) + 1
@@ -204,18 +136,4 @@ module Engine
       Input.key_callback(key, action)
     end
   end
-
-  def self.debug_opengl_call
-    errors = []
-    until GL.GetError == 0; end
-    yield
-    until (error = GL.GetError) == 0
-      errors += error.to_s(16)
-    end
-  end
-
-  def self.print_opengl_version
-    puts "OpenGL Version: #{GL.GetString(GL::VERSION)}"
-    puts "GLSL Version: #{GL.GetString(GL::SHADING_LANGUAGE_VERSION)}"
-  end
 end

data/lib/engine/font.rb

@@ -15,7 +15,7 @@ module Engine
     def texture
       @texture ||=
         begin
-          path = File.expand_path(File.join(ROOT, "_imported", @font_file_path.gsub(".ttf", ".png")))
+          path = File.join("_imported", @font_file_path.gsub(".ttf", ".png"))
           Engine::Texture.for(path)
         end
     end
@@ -35,7 +35,7 @@ module Engine
       scale_factor = 1 / (1024.0 * 2)
       horizontal_offset = 0.0
       vertical_offset = 0.0
-      font_path = File.expand_path(File.join(ROOT, "_imported", @font_file_path.gsub(".ttf", ".json")))
+      font_path = File.expand_path(File.join(GAME_DIR, "_imported", @font_file_path.gsub(".ttf", ".json")))
       font_metrics = JSON.parse File.read(font_path)
       string.chars.each do |char|
         if char == "\n"

data/lib/engine/game_object.rb

@@ -132,17 +132,30 @@ module Engine
 
     def destroy!
       return unless GameObject.objects.include?(self)
-      @destroyed = true
+      children.each(&:destroy!)
       components.each(&:destroy!)
       ui_renderers.each(&:destroy!)
       renderers.each(&:destroy!)
+
+      GameObject.destroyed_objects << self unless @destroyed
+      @destroyed = true
+    end
+
+    def _erase!
       GameObject.objects.delete(self)
       parent.children.delete(self) if parent
-      children.each(&:destroy!)
+      name = @name
       self.class.instance_variable_get(:@methods).each do |method|
         singleton_class.send(:undef_method, method)
-        singleton_class.send(:define_method, method) { raise "This object has been destroyed.  Object ID: #{self.object_id}" }
+        singleton_class.send(:define_method, method) { raise "This object has been destroyed: #{name}" }
+      end
+    end
+
+    def self.erase_destroyed_objects
+      destroyed_objects.each do |object|
+        object._erase!
       end
+      @destroyed_objects = []
     end
 
     def up
@@ -173,6 +186,9 @@ module Engine
       GameObject.objects.each do |object|
         object.components.each { |component| component.update(delta_time) }
       end
+      
+      Component.erase_destroyed_components
+      GameObject.erase_destroyed_objects
     end
 
     def self.mesh_renderers
@@ -194,5 +210,9 @@ module Engine
     def self.objects
       @objects ||= []
     end
+
+    def self.destroyed_objects
+      @destroyed_objects ||= []
+    end
   end
 end

data/lib/engine/input.rb

@@ -21,7 +21,7 @@ module Engine
       end
 
       if key == GLFW::KEY_BACKSPACE
-        Engine.breakpoint { binding.pry }
+        Engine::Debugging.breakpoint { binding.pry }
         # Engine.breakpoint { debugger }
       end
 

data/lib/engine/mesh.rb

@@ -21,7 +21,7 @@ module Engine
     end
 
     def self.open_vertex(mesh_file)
-      vertex_cache[File.join(ROOT, "_imported", mesh_file + ".vertex_data")]
+      vertex_cache[File.join(GAME_DIR, "_imported", mesh_file + ".vertex_data")]
     end
 
     def self.vertex_cache
@@ -31,7 +31,7 @@ module Engine
     end
 
     def self.open_index(mesh_file)
-      index_cache[File.join(ROOT, "_imported", mesh_file + ".index_data")]
+      index_cache[File.join(GAME_DIR, "_imported", mesh_file + ".index_data")]
     end
 
     def self.index_cache

data/lib/engine/texture.rb

@@ -12,8 +12,9 @@ module Engine
       load_texture
     end
 
-    def self.for(file_path, flip: false)
-      texture_cache[[file_path, flip]]
+    def self.for(path, flip: false)
+      full_path = File.expand_path(File.join(GAME_DIR, path))
+      texture_cache[[full_path, flip]]
     end
 
     def self.texture_cache

data/lib/ruby_rpg.rb

@@ -1,3 +1,56 @@
 # frozen_string_literal: true
 
+require 'opengl'
+require 'glfw'
+require 'concurrent'
+require 'os'
+require 'native_audio'
+
+require_relative 'engine/autoloader'
+require_relative "engine/debugging"
+require_relative 'engine/rendering/render_pipeline'
+require_relative 'engine/rendering/instance_renderer'
+require_relative 'engine/screenshoter'
+require_relative 'engine/input'
+require_relative "engine/quaternion"
+require_relative 'engine/game_object'
+require_relative 'engine/texture'
+require_relative 'engine/material'
+require_relative 'engine/mesh'
+require_relative "engine/font"
+require_relative 'engine/path'
+require_relative 'engine/polygon_mesh'
+require_relative 'engine/importers/obj_file'
+require_relative 'engine/tangent_calculator'
+require_relative 'engine/shader'
+require_relative 'engine/component'
+require_relative "engine/camera"
+require_relative "engine/window"
+require_relative "engine/video_mode"
+require_relative "engine/cursor"
+
+require_relative "engine/components/orthographic_camera"
+require_relative "engine/components/perspective_camera"
+require_relative "engine/components/sprite_renderer"
+require_relative "engine/components/ui_sprite_renderer"
+require_relative "engine/components/mesh_renderer"
+require_relative "engine/components/font_renderer"
+require_relative "engine/components/ui_font_renderer"
+require_relative "engine/components/point_light"
+require_relative "engine/components/direction_light"
+require_relative "engine/components/audio_source"
+
+require_relative "engine/physics/physics_resolver"
+require_relative 'engine/physics/collision'
+require_relative "engine/physics/components/sphere_collider"
+require_relative "engine/physics/components/cube_collider"
+require_relative "engine/physics/components/rigidbody"
+
+if OS.windows?
+  GLFW.load_lib(File.expand_path(File.join(__dir__, "..", "glfw-3.4.bin.WIN64", "lib-static-ucrt", "glfw3.dll")))
+elsif OS.mac?
+  GLFW.load_lib(File.expand_path(File.join(__dir__, "..", "glfw-3.3.9.bin.MACOS", "lib-arm64", "libglfw.3.dylib")))
+end
+GLFW.Init
+
 require_relative 'engine/engine'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ruby_rpg
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Max Hatfull
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-27 00:00:00.000000000 Z
+date: 2024-11-04 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: native_audio
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: opengl-bindings2
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- bin/build.bash
 - bin/import
 - glfw-3.3.9.bin.MACOS/LICENSE.md
 - glfw-3.3.9.bin.MACOS/README.md
@@ -537,9 +552,10 @@ files:
 - glfw-3.4.bin.WIN64/lib-vc2022/glfw3.lib
 - glfw-3.4.bin.WIN64/lib-vc2022/glfw3_mt.lib
 - glfw-3.4.bin.WIN64/lib-vc2022/glfw3dll.lib
-- lib/build.bash
+- lib/engine/autoloader.rb
 - lib/engine/camera.rb
 - lib/engine/component.rb
+- lib/engine/components/audio_source.rb
 - lib/engine/components/direction_light.rb
 - lib/engine/components/font_renderer.rb
 - lib/engine/components/mesh_renderer.rb
@@ -550,6 +566,7 @@ files:
 - lib/engine/components/ui_font_renderer.rb
 - lib/engine/components/ui_sprite_renderer.rb
 - lib/engine/cursor.rb
+- lib/engine/debugging.rb
 - lib/engine/engine.rb
 - lib/engine/font.rb
 - lib/engine/game_object.rb