dxruby64 1.4.7 → 1.4.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09456faf82b816e3acb5ab3134ac5062e9453e3f821c9f83835357ae334af644'
-  data.tar.gz: 18f08cc9f7139915b9f334e1ad12a44fef3f4db94b82c773dfe0d458cf123091
+  metadata.gz: '08d94a581f72caf876b0bb2091e2476db409abc3d2533d35f068a6bfad2001aa'
+  data.tar.gz: fad534cf63dbd0b2745074ff7e60d9e2472956dbdb6469912ccb3d6920d3f7ab
 SHA512:
-  metadata.gz: 4c8a65bd3b7a8f3f7c6aca47b8098e897877614dee52ffeb76ec06e6c23522c7e8ad32fc950015097d61a1f5bedd02aec854f09e4ba975212ceea99143870712
-  data.tar.gz: af52610d33f31cdf2846dcffcff4e3b4e62e64fdefd66ff52a2c481cccddb14339ebdd34faeedd50f8d11d082bd42cf6764612f76699f52b1d34a6ceebb147b7
+  metadata.gz: d6abd1acc491d74b2c07cc1af34b2d56a9110da011f918971de1299383c4e43f3951b19dce44309d00f2fc00fd14e77a8d27528bccf98ae9bd0f30204c1daa47
+  data.tar.gz: 90a4c29b14d2ed2761f99c620e749cd765dee04ad6e028ad50056ac94ef8a0800d26508276feaa50183722f5f96ec11524ec6bf4a52b2f4e7efe02908b178660

data/README-ja.md

@@ -2,7 +2,8 @@
 
 **DXRuby64** は 64ビット版の Ruby 3.1以降用にカスタムビルドされた **DXRuby** で、Universal C Runtime(UCRT)でビルドできるように[本家DXRuby](https://github.com/mirichi/dxruby)のソースにパッチを当てたものです。DXRuby64により、64ビット版の Rubyでも DirectX9をベースにした 2Dゲームを開発できるようになります。
 
-**注意：** この gem は個人によって作成された非公式バージョンであり、オリジナルの DXRubyプロジェクトではメンテナンスされていません。
+**注意：**
+この gem は個人によって作成された非公式バージョンであり、本家DXRubyのプロジェクトでメンテナンスされているものではありません。
 
 [English README here](README.md)
 
@@ -14,6 +15,10 @@ gem をインストールするには、以下のコマンドを実行してく
 gem install dxruby64
 ```
 
+**注意：**
+DXRuby64の動作に影響が出る可能性がありますので、[本家DXRuby](https://github.com/mirichi/dxruby) がインストールされていない状態で上記のコマンドを実行してください。
+([本家DXRuby](https://github.com/mirichi/dxruby)は Ruby 3.1以降のバージョンには対応していないため、基本的に gemがインストールされていることはないと思われます)
+
 ## 使用方法
 インストール後、従来どおり DXRubyの機能を使うことができます。
 
@@ -41,13 +46,13 @@ gem contents dxruby64
 ```
 
 ## 必要条件
-- **Ruby 3.1 以降 (64ビット版)** が Windows にインストールされていること。
+- **Ruby 3.1 以降 (64ビット版)** が Windowsにインストールされていること。
 
-- `d3dx9_40.dll` が必要です。これは DirectX 9 ランタイムの一部です。もしインストールされていない場合は、[Microsoft の公式サイト](https://www.microsoft.com/en-us/download/details.aspx?id=8109)からダウンロードできます。
+- **`d3dx9_40.dll`** が配置されていること。これは DirectX 9 ランタイムの一部で、[Microsoft の公式サイト](https://www.microsoft.com/en-us/download/details.aspx?id=8109)からダウンロードすることができます。
 
-#### 【`d3dx9_40.dll` の入手方法】
+#### 【`d3dx9_40.dll` の入手および配置方法】
 
-1. [DirectX End-User Runtimes (June 2010)](https://www.microsoft.com/en-us/download/details.aspx?id=8109) をダウンロードします。
+1. [DirectX End-User Runtimes (June 2010)](https://www.microsoft.com/en-us/download/details.aspx?id=8109) に掲載されているファイル(`directx_Jun2010_redist.exe`)をダウンロードします。
 
 2. ダウンロードした `directx_Jun2010_redist.exe` をダブルクリックして、任意のディレクトリにファイルを展開します。
 
@@ -55,11 +60,66 @@ gem contents dxruby64
 
 4. `Nov2008_d3dx9_40_x64.cab` の中にある `d3dx9_40.dll` を見つけ、Ruby のインストールフォルダ内の `bin` フォルダにコピー(または移動)します。（例：C:\Ruby34-x64\bin）
 
+## Soundクラスの改修について
+
+### 経緯など
+[本家DXRuby](https://github.com/mirichi/dxruby) の Soundクラスは `DirectMusic` というライブラリを使用していましたが、
+Windows 10/11 の 64bit 環境ではこの `DirectMusic` は正しく動作せず、以下のようなエラーが発生することが確認されています。
+
+```
+`DXRuby::Sound#initialize': DirectMusic initialize error - CoCreateInstance (DXRuby::DXRubyError)  
+```
+このため、DXRuby64では `DirectMusic` の代替として `DirectSound` というライブラリを使用するように改修をおこないました。
+(`DirectSound` は SoundEffectクラスでもすでに使用されており、実績のあるライブラリです)
+
+### 改修版 Soundクラスのサンプル
+
+前述のサンプルファイルの中に `wav_sample/`ディレクトリに改修版の Soundクラスを用いたサンプルを追加しましたのでお試しください。
+なお、下記の制限事項などについてもあわせてご確認ください。
+
+### 制限事項など
+
+`DirectSound` の機能上の制約などから、改修に伴って以下のような仕様変更をおこないました。
+
+- Soundクラスで扱うことができるファイル形式は `.wav` および `.mp3` 
+([本家DXRuby](https://github.com/mirichi/dxruby) では `.wav` および `.mid`)
+
+- 再生時のループ回数の指定はできず、「１回のみ再生」または「無限ループ」のいずれか
+
+- ゲームなどで利用される効果音や BGMなどの再生を念頭に、以下に記載の最小限のメソッドのみを実装
+
+```
+■使用できるメソッド(新規にアレンジしたものも含む)
+
+ .new             オブジェクトの生成
+ #play            再生
+ #stop            停止
+ #volume=         音量設定(0～255)
+ #set_volume      音量設定(上記 #volume= のエイリアス)  ※ただし従来の第2引数による音量フェード機能はなし
+ #loop=           ループ再生の採否設定(下記 #loop_count と同じ機能で、trueまたは falseで設定するもの)
+ #loop_count=     ループ回数設定(ただし、前述のように「１回のみ再生(0)」または「無限ループ(-1)」のみ可)
+ #dispose         オブジェクトの破棄
+ #disposed?       オブジェクト破棄状況のチェック
+```
+
+```
+■使用できないメソッド(本家DXRubyでは実装されていたもの)
+
+ .load_from_memory
+ #start=
+ #loop_start=
+ #loop_end=
+ #pan
+ #pan=
+ #frequency
+ #frequency=
+```
+
 ## ライセンス
 この gem は zlib/libpngライセンスの下で提供されています。
 
 ## 免責事項
-この gem は DXRubyの公式な後継ではなく、元の DXRubyプロジェクトによってメンテナンスされていません。これは、新しいバージョンの Ruby用に UCRT環境で動作することを目的としたカスタムビルドです。
+この gem は DXRubyの公式な後継ではなく、新しいバージョンの Ruby用に UCRT環境で動作することを目的としたカスタムビルドです。
 
 ## リポジトリ
 ソースコードや詳細情報は、以下のリポジトリで確認できます。

data/README.md

@@ -2,7 +2,8 @@
 
 **DXRuby64** is a custom-built version of DXRuby for 64-bit Ruby 3.1 and later, created by patching the original DXRuby source to allow building with the Universal C Runtime (UCRT). With DXRuby64, you can develop 2D games using DirectX 9 even on 64-bit Ruby environments.
 
-**Note:** This gem is an unofficial version created by an individual and is not maintained by the original DXRuby project.
+**Note:**
+This gem is an unofficial version created by an individual and is not maintained by the original DXRuby project.
 
 [日本語の README はこちら](README-ja.md)
 
@@ -14,6 +15,10 @@ To install the gem, simply run:
 gem install dxruby64
 ```
 
+**Note:**
+Please run the above command only when the original DXRuby is not installed, as it may interfere with the operation of DXRuby64.
+(The original DXRuby does not support Ruby versions 3.1 and later, so the gem is unlikely to be installed in most environments.)
+
 ## Usage
 Once installed, you can use DXRuby features as usual:
 
@@ -43,11 +48,11 @@ gem contents dxruby64
 ## Requirements
 - **Ruby 3.1 or later (64-bit)** installed on Windows.
 
-- `d3dx9_40.dll` is required. This is part of the DirectX 9 runtime. If it's not already installed, you can download it from [Microsoft's official site](https://www.microsoft.com/en-us/download/details.aspx?id=8109).
+- Ensure that **`d3dx9_40.dll`** is present. This DLL is part of the DirectX 9 runtime and can be downloaded from [the official Microsoft website](https://www.microsoft.com/en-us/download/details.aspx?id=8109).
 
-#### How to get `d3dx9_40.dll`
+#### How to obtain and place `d3dx9_40.dll`
 
-1. Download the [DirectX End-User Runtimes (June 2010)](https://www.microsoft.com/en-us/download/details.aspx?id=8109).
+1. Download the file (`directx_Jun2010_redist.exe`) from [DirectX End-User Runtimes (June 2010)](https://www.microsoft.com/en-us/download/details.aspx?id=8109).
 
 2. Double-click the downloaded `directx_Jun2010_redist.exe` and extract the files to a directory of your choice.
 
@@ -55,6 +60,63 @@ gem contents dxruby64
 
 4. Inside the `Nov2008_d3dx9_40_x64.cab` file, locate `d3dx9_40.dll` and copy (or move) it to the `bin` directory of your Ruby installation folder. (e.g. C:\Ruby34-x64\bin)
 
+
+
+
+
+## About the Sound Class Revision
+### Background
+The [original DXRuby](https://github.com/mirichi/dxruby) Sound class used a library called `DirectMusic`.
+However, on 64-bit environments of Windows 10/11, `DirectMusic` does not function correctly, and the following error has been confirmed:
+
+```
+`DXRuby::Sound#initialize': DirectMusic initialize error - CoCreateInstance (DXRuby::DXRubyError)  
+```
+
+Therefore, in DXRuby64, we replaced `DirectMusic` with a library called `DirectSound`.
+(`DirectSound` is already used in the SoundEffect class and is a proven library.)
+
+### Sample of the Revised Sound Class
+A sample using the revised Sound class has been added to the `wav_sample/` directory within the sample files mentioned earlier.
+Please give it a try.
+Also, be sure to review the following limitations and changes.
+
+### Limitations and Specification Changes
+Due to functional constraints of `DirectSound`, the following changes were made as part of the revision:
+
+- The Sound class supports `.wav` and `.mp3` file formats
+(The [original DXRuby](https://github.com/mirichi/dxruby) supports `.wav` and `.mid`)
+
+- Loop count cannot be specified; only "play once" or "infinite loop" are supported
+
+- Designed with use cases like sound effects and BGM for games in mind, only a minimal set of methods (listed below) is implemented
+
+```
+Available Methods (including newly arranged ones)
+
+ .new             Create an object
+ #play            Play
+ #stop            Stop
+ #volume=         Set volume (0 to 255)
+ #set_volume      Set volume (alias of #volume=, but the old fade effect via a second argument is not supported)
+ #loop=           Set loop mode (same as #loop_count; accepts true or false)
+ #loop_count=     Set loop count (only two options supported: 0 = play once, -1 = loop infinitely)
+ #dispose         Dispose the object
+ #disposed?       Check if the object has been disposed
+```
+```
+Unsupported Methods (implemented in the original DXRuby)
+
+ .load_from_memory
+ #start=
+ #loop_start=
+ #loop_end=
+ #pan
+ #pan=
+ #frequency
+ #frequency=
+```
+
 ## License
 This gem is licensed under the zlib/libpng license.
 

data/sample/wav_sample/desktop.ini

@@ -0,0 +1,4 @@
+[ViewState]
+Mode=
+Vid=
+FolderType=Generic

data/sample/wav_sample/dispose.rb

@@ -0,0 +1,17 @@
+require 'dxruby'
+
+sound = Sound.new("gameover.wav")   # gameover.wav読み込み
+
+puts sound.disposed?
+
+Window.loop do
+  if Input.key_push?(K_Z)           # [Z]キーで効果音を再生
+    sound.play
+    break
+  end
+end
+
+sleep 1
+sound.dispose
+puts sound.disposed?
+

data/sample/wav_sample/sound.rb

@@ -0,0 +1,34 @@
+require 'dxruby'
+
+sound = Sound.new("gameover.wav")   # gameover.wav読み込み
+sound.loop_count = 0                # 効果音は繰り返さない(「.loop_count = -1|0」形式での設定)
+sound.set_volume(255)               # 効果音の音量(最大)(「.set_volume(値)」形式での設定)
+
+bgm = Sound.new("backg.mp3")        # backg.mp3読み込み
+bgm.loop = true                     # BGMは繰り返す(「.loop = true|false」形式での設定)
+bgm.play                            # BGB再生
+bgm.volume = 200                    # BGMの音量(「.volume = 値」形式での設定」)
+
+Window.loop do
+  Window.draw_font(20,  20, "[SPACE]  BGM停止", Font.default)
+  Window.draw_font(20,  80, "[↑]     BGM音量上げ", Font.default)
+  Window.draw_font(20, 110, "[↓]     BGM音量下げ", Font.default)
+  Window.draw_font(20, 140, "音量 : #{bgm.volume}", Font.default, color: [255, 255, 0])
+  Window.draw_font(20, 200, "[Z]      効果音 再生", Font.default)
+  Window.draw_font(20, 350, "[ESCAPE] 終了", Font.default)
+
+  if Input.key_push?(K_Z)           # [Z]キーで効果音を再生
+    sound.play
+  end
+  if Input.key_push?(K_SPACE)       # SPACEキーでBGM終了
+    bgm.stop
+  end
+  if Input.key_push?(K_UP)          # [↑]キーでBGMの音量を上げる
+    bgm.volume = bgm.volume + 5     #「.volume = 値」形式
+  end
+  if Input.key_push?(K_DOWN)        # [↓]キーでBGMの音量を下げる
+    bgm.volume = bgm.volume - 5     #「.volume = 値」形式
+  end
+
+  break if Input.key_push?(K_ESCAPE)
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dxruby64
 version: !ruby/object:Gem::Version
-  version: 1.4.7
+  version: 1.4.7.2
 platform: ruby
 authors:
 - Koki Kitamura
@@ -117,10 +117,16 @@ files:
 - sample/shader_sample/sample_vertexshader.rb
 - sample/shader_sample/sample_wingman.rb
 - sample/shader_sample/turn_transition.rb
+- sample/wav_sample/backg.mp3
+- sample/wav_sample/desktop.ini
+- sample/wav_sample/dispose.rb
+- sample/wav_sample/gameover.wav
+- sample/wav_sample/sound.rb
 homepage: https://github.com/spoolkitamura/dxruby64
 licenses:
 - Zlib
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/spoolkitamura/dxruby64
 rdoc_options: []
 require_paths:
 - lib