Ruby/SDLで始めるゲームプログラミング【前編】
初稿:2007-02-28
はじめに
本稿では Ruby/SDL を使って簡単なゲームを作ってみます。
Ruby on Rails など Web 系の用途で知名度を上げている Ruby ですが、
Ruby でこんなこともできるんだ!と思ってもらえれば幸いです。
準備
テキストエディタ
Ruby スクリプトの編集用に何かひとつテキストエディタを
用意しておいてください (Windows 付属の「メモ帳」でも良いですが、もう少し高機能なものを使ったほうが何かと便利です)。
Ruby/SDL のインストール
あなたは……
- Linux や FreeBSD など、Unix 系 OS を使っている→ (A) へ
- Windows を使っていて、
- Ruby は既にインストールしている→ (B) へ
- Ruby はまだインストールしていない
- インストールは面倒だから嫌いだ→ (C) へ
- インストールは嫌いじゃない→ (D) へ
- Mac OS X を使っている→ (E) へ
(A) Unix 系 OS へのインストール
ディストリビューションによってはパッケージが用意されているので、
それを利用するのが簡単です (例えば Debian GNU/Linux なら libsdl-ruby1.8)。
その他のディストリビューションでは
Download Ruby/SDL から「source of Ruby/SDL 1.3.0」
をダウンロードし、README.ja に従ってインストールしてください。
SDL 関係のライブラリを一つずつインストールしなければならないので多少面倒ですが、とりあえずは
SDL、SDL_mixer、SDL_ttf、SDL_image があれば OK です。
(B) Windows へのインストール
Download Ruby/SDL
から「Win32’s binary(ver 1.3.0) for Ruby 1.8」をダウンロードし、同梱の install_rubysdl.rb を実行してください。
(C) Ruby/SDL スターターキットを使う
Windows 用に、インストールなしに Ruby/SDL を使ったゲーム開発ができるパッケージを公開しています。
Ruby/SDL スターターキットから zip ファイルをダウンロードし、好きなところに展開してください。
(D) Windows に Ruby をインストールする
まず、FirstStepRubyを参考に Ruby をインストールしてください。Windows 版の Ruby にはいろいろなパッケージが用意されていますが、
ActiveScriptRuby が人気があるようです。
インストールできたら (B) に進んでください。
(E) Mac OS X について
MacPorts を利用するのが一番簡単なようです。以下の順にインストールを行ってください。
- XCodeTools (OS のインストールディスク等から入手可能)
- MacPorts
- 各種ライブラリ
サンプルパック
インストールできたら、
ゲームに必要なデータが入ったサンプルパックをダウンロードし、好きなところに解凍してください。
ただし (C) の Ruby/SDL スターターキットには同じデータが既に同梱されているのでダウンロードの必要はありません。
Q&A
本稿では Q&A 形式で「ちょっとした疑問」に答えていきます。豆知識なので、お急ぎの方は読み飛ばしても構いません。
- Q. SDL って何ですか?
- A. SDL は「クロスプラットフォームなマルチメディアアプリケーションを書くためのライブラリ」です。
- なんだか仰々しいですね (笑)。簡単に言うと、「いろんな OS で動くゲームが作れるライブラリ」だと思ってもらえれば良いと思います。SDL の公式サイトに書かれているように、Windows や Linux、Mac OS X などいろいろな OS に対応しています。SDL 本体は C 言語のためのライブラリですが、有志の手によって Perl や Python など他のいろいろな言語から SDL を使うためのライブラリが公開されています。そのうちの、Ruby から SDL を使うためのライブラリが Ruby/SDL であるというわけです。
ウィンドウを出してみよう
では早速、初めての Ruby/SDL アプリケーションを書いてみましょう。
サンプルパックを展開した中に main.rb というファイルがあるので、これをテキストエディタで開き、以下のように
書き換えてください。
実行方法
このスクリプトを実行するには、以下のようにします。
- Ruby/SDL スターターキットを使っている場合
- debug.exe をダブルクリック
- それ以外の場合
- ターミナルや MS-DOS プロンプトを開いて
新しいウィンドウが開いて、2 秒後に閉じれば成功です。Ruby/SDL の世界へようこそ!
初期化
Ruby/SDL では、一番最初に SDL.init を呼び出します。
引数には、SDL のさまざまな機能のうちどれを初期化するかを指定します。通常は INIT_EVERYTHING (全て初期化) で
問題ないでしょう。
次に、SDL.set_video_mode
で画面を初期化しています。
多くのゲームは VGA サイズで作られるので、ここでも幅 640 ピクセル、高さ 480 ピクセルを指定しています。
SCREEN_W、SCREEN_H の W、H はそれぞれ Width (幅)、Height (高さ) の略です。
何か描いてみよう
さて、真っ黒なウィンドウを出すだけでは寂しいので、何か描いてみましょうか。
main.rb を以下のように書き換えて保存してください。
(以下では、前のスクリプトから変更する部分にはコメントを付けてあります。
スクリプトを写すときにはまず「#」を探してみてください。)
空と大地が表示されましたか?:-)
画面への描画
SDL.set_video_mode を実行すると、「画面」を表す
SDL::Screen クラスのオブジェクトが返ってきます。上では screen という変数に代入しています。
画面に何か表示するにはいつもこのオブジェクトを使います。
次に、SDL::Surface#fill_rect というメソッドを使って四角形の範囲を塗りつぶしています。
引数の意味はそれぞれ「左上の x 座標、y 座標、幅、高さ、色」です。
色は 0〜255 の間の 3 つの数字で指定します (それぞれ赤、緑、青の明るさです)。
ただし、fill_rect を呼び出しただけではまだ画面には何も表示されません。
画面の更新には時間がかかるので、SDL では
SDL::Screen.update_rect
を呼んだ時にまとめて更新されるという仕様になっています。引数には fill_rect と同じく
「左上の x 座標、y 座標、幅、高さ、色」を指定します。4 つとも 0 を指定すると画面全体が更新されます。
画像を表示してみよう
ゲームには主人公が必要ですよね。 次はビットマップ画像を表示してみましょう。
image というディレクトリにサンプル画像 (nos_front.png) が入っていることを確認してください。
main.rb を以下のように書き換えてください。
実行すると、地面の上にキャラクターが表示されます。少しゲームらしくなってきました。
画像の読み込み
SDL::Surface.load
というメソッドにファイル名を渡すことで画像ファイルを読み込むことができます。
読み込み可能なフォーマットは bmp, png, gif, jpg などです。
読み込んだ画像は SDL::Surface のインスタンス
になります。Ruby/SDL で画像を扱うときはいつもこの Surface クラスを使います。
SDL::Surface#w で画像の横幅が、
SDL::Surface#h で画像の縦幅が得られます。
上では、キャラクターが地面の上に立っている用に見せるために、「HOLIZON - chara.h」でキャラクターの
y 座標を計算しています。
カラーキーの設定
その次の行では、読みこんだ画像に対し SDL::Surface#set_color_key でカラーキー (色抜き) を設定しています。
カラーキーを使うと、図のように画像のある色の部分だけ背景に溶け込ませることができます。
ここでは白 (255,255,255) をカラーキーに設定しています。
関数を使ってみよう
さて、画像の読み込みはよく使うので、関数にまとめておきましょう。
main.rb を以下のように書き換えてください。
実行結果は前と変わらないはずです。
Q&A
- Q. あれ、値を返すのに return はいらないの?
- A. 付けても構いません。
- Ruby では関数の「最後に評価した値」が自動的に返り値になるので、「return image」のように return をつける必要はありません。
画像を動かしてみよう
次はビットマップ画像を動かしてみましょう。
キャラクターを少しずつ位置をずらしながら描画することで、パラパラマンガのように
絵を動かすことができます。
main.rb を以下のように書き換えてください。
実行するとキャラクターが左から右まで動いて終了します。少しゲームらしくなってきました。
ゲームの動く仕組み
このように、ゲームプログラミングでは
- キーボードやジョイパッドの入力を受け付ける (入力)
- キャラクターの座標を少し動かす (移動)
- キャラクターを描画する (描画)
- 画面を更新する (更新)
という手順を何度も繰り返すことでゲームを進めていきます。この「入力→移動→描画→更新」 1 回分を
1 フレームと呼びます。
しかし、このままだと 1 フレームにかかる時間はコンピュータのスペックによって異なります。
自分のコンピュータではゆっくり飛んでくる弾が友達のコンピュータではものすごい速さで飛んでくる……
なんてことでは困りますよね。
そこで、1 秒間のフレーム数を 60 回なら 60 回に固定してしまい
- 1 フレームにかかる時間が 1/60 秒より短いときは、適当にウェイトを入れて調整する
- 1 フレームにかかる時間が 1/60 秒より長いときは、描画や更新をスキップして調整する
という処理を行うことで、どの環境でも同じ速度でゲームを動かすことができます。
fpstimer.rb
この処理を行うためのライブラリが、Ruby/SDL 公式サイトの
チュートリアルの最後で公開されています。
これをダウンロードしたものが lib/fpstimer.rb に入っています。
これを使った main.rb は以下のようになります。
最近のコンピュータは処理速度が速いので、実行すると大抵の環境ではさっきのバージョンよりもキャラクターがゆっくり動く
ようになったと思います。
FPSTimerLight
fpstimer.rb では FPSTimerLight というクラスが定義されています。
このタイマーの wait_frame というメソッドにブロックを渡してやると、
- 時間に余裕があるときはブロックを実行し、定時まで待つ
- 時間に余裕がないときはブロックを実行しない
という風に時間を調整してくれます。
ゲームプログラミングにおいて一番時間がかかるのは画面の更新処理なので、上では update_rect のみを
wait_frame で囲んでいます。
処理速度の遅いコンピュータではときどき画面の更新をスキップすることで、
(見た目は多少カクカクしますが) 秒間 60 フレームを守ることができます。
Q&A
- Q. どうして require “lib/fpstimer.rb”のように拡張子を付けないの?
- A. つけても構いません。
- Ruby のライブラリには C 言語で書かれたもの (.so) と Ruby で書かれたもの (.rb) の 2 種類があります。拡張子を省略した場合は*.rb の方が優先されます。
キーボードから操作できるようにしよう
次はキーボードの矢印キーでキャラクターが左右に移動するようにしてみましょう。
入力の処理
SDL では、キーが「押されたかどうか」と「押されているかどうか」を区別して調べることができます。
これによって、例えばシューティングゲームで
- ショットはボタンが「押されている」間ずっと発射される
- ボムはボタンが「押された」瞬間に一度だけ発射される
というような仕様を簡単に実装することができます。
Ruby/SDL では、SDL::Event2 というクラスで
「キーが押された」などのイベントを、
SDL::Key.scan
というメソッドで「キーが押されているか」という状態を取得することができます。
上では ESCAPE キーが「押されたら」ゲームを終了し、矢印キーが「押されていたら」キャラクターを
動かすようにしています。
上ではキーボードの入力のみを受け付けていますが、
ゲームの入力デバイスには他にもジョイパッドなどいろいろなものがあります。
これらに対応するコードをいちいち書くのは面倒なので、本稿では input.rb というライブラリを用意しました。
input.rb を使うと、上のスクリプトはこんな風に書けます。
だいぶすっきりしました。
もしパソコンに繋げられるジョイパッドをお持ちなら、ぜひジョイパッドで操作してみてください。
input.rb は Ruby の高度な (マニアックな、とも言う) 機能をいろいろ使っているので、中身の解説は省略します。
興味のある人は lib/input.rb の解読に挑戦してみてください。
クラスを定義してみよう
さて、主人公の次は敵キャラ出して、アイテム出して……と行きたいところですが、変数名に「x」を使っているのが
ちょっと気になります。
例えば敵キャラを出すなら、プレイヤーの座標は player_x、敵キャラの座標は teki_x のように改名しないといけないですよね。
さらにアイテムの座標も……と考えると、似たような変数がたくさんあって混乱してしまいそうです。
せっかく Ruby を使うのですから、ここはひとつ自分でクラスを定義してみましょう。
main.rb と同じディレクトリに player.rb というファイルを作って、以下のように書いてください。
initialize は Player.new でプレイヤーが生成されるときに自動的に呼ばれるメソッドです。
initialize ではキャラクターの座標や画像といった情報を「@」から始まる変数 (インスタンス変数) にセットしています。
インスタンス変数は基本的に外からアクセスすることができませんが、attr_reader :x のように書いておくと
player.x で @x の値を取得できるようになります。また書き込みを可能にする attr_writer や、
読み書き両方を可能にする attr_accessor もあります。
また center ではプレイヤーの画像の「中心の座標」を返しています (あとで使います)。
このクラスを使うと、main.rb はこんな風に書けます。
まず、require で player.rb を読み込んでいます。player.rb の中では関数 load_image や定数 SCREEN_W を使っているので、
それらの定義より後に読み込まないといけません。
また Player クラスには act (移動) と render (描画) という 2 つのメソッドが定義されていて、メインループの中で
これらのメソッドを 1 フレーム毎に呼び出しています。
Q&A
- Q. クラスごとにファイルを分けないといけないの?
- A. 別に分けなくても構いません。
- Ruby では、Java のように 1 ファイル 1 クラスのような制限がありません。1 つのファイルで複数のクラスを定義しても良いし、逆に 1 つのクラスの定義を複数のファイルに分けて書くこともできます (Input クラスがそうですね)。
アイテムを降らせてみよう
さて、主人公だけでは寂しいので、他の物も描画してみましょう。
手元にリンゴと爆弾の絵があるので、「爆弾を避けつつリンゴを集める」ゲームにしてみましょうか。
main.rb と同じディレクトリに items.rb というファイルを作り、
以下のように書いてください。
リンゴを表す Apple クラスと、爆弾を表す Bomb クラスを定義しています。
また Apple と Bomb はほとんど同じ実装になるので、「空から降ってくるもの」全体を現す Item クラスを作り、
Apple と Bomb は Item のサブクラスにしてみました。最後に、アイテムの管理を行う Items クラスを定義しています。
メインループから使うのはこの Items クラスのみです。
アイテムの処理を追加した main.rb は以下のようになります。前のバージョンとほとんど変わりませんね。
このようにプログラムをクラスに分割することで、表示するものを増やしてもメインループをシンプルに保つことができます。
Q&A
- Q. クラスをどういう風に分けたらいいのかよく分かりません。
- A. 僕にもよく分かりません。:-P
- クラスをどのように設計すべきか?という話はそれだけで本が書けてしまうくらいで、ここに書くにはちょっと余白が狭すぎます。基本的には「リンゴ」や「爆弾」などの「物」をひとつづつクラスにすれば良いと思いますが、Items のように物でないものをクラスにすることもあります。いろいろなパターンでプログラムを書いて、試行錯誤するのが良いと思います。
当たり判定を付けてみよう
上から落ちてきたものがすり抜けてしまうのではゲームになりませんね。ここでは、
- 爆弾に当たったらゲーム終了 (爆弾に当たってはいけない)
- リンゴに当たったらリンゴは消える (リンゴには当たっても良い)
という風にしてみましょう。
当たり判定を実装する方法にはいろいろありますが、ここでは単純に「中心どうしの距離が一定以下か」で
判定することにしましょう。この方法は当たり判定の範囲 (下図の青線) が円形になるので丸い画像に向いていますが、
Math.sqrt(平方根) を利用しているので物体が多いと重くなる可能性があります (その場合は四角形で判定するのが
良いでしょう)。
items.rb を以下のように書き換えてください。
collides?というメソッドで、アイテムとプレイヤーが接触しているかどうかを判定しています。
判定には、中心間の距離と半径の和を比べればよい……のですが、どの画像も完全な円ではないので、
プレイしてみて違和感がないように数値を手で調整しています。できれば、リンゴの当たり判定は大きめに、
爆弾の当たり判定は小さめにするとより楽しいゲームになると思います。
また、爆弾に当たったときは act が true を返すようにしました。
これに対応した main.rb は以下のようになります。item.act が true を返したらゲームを終了するように変更しました。
おわりに
何となくゲームらしくなってきたところで、今回はお別れです。
次回は点数表示や効果音など、ゲームとしての完成度をより高めていきたいと思います。お楽しみに!
補足:フルスクリーンについて
本文では説明しませんでしたが、
のように SDL::FULLSCREEN というフラグを指定することで、アプリケーションを全画面で動かすことができます。
ゲームをフルスクリーンで動かすと迫力がある反面、起動に時間がかかるのでデバッグが少し面倒になります。
開発中はウィンドウモードにしておき、リリースするときにフルスクリーンで動くように変更するのが良いと思います。
Ruby/SDL スターターキットの場合
Ruby/SDL スターターキットでは、main.rb を実行するための exe を debug.exe と game.exe という 2 種類用意しています。
main.rb の中では「SDL::RELEASE_MODE という変数が定義されているかどうか」を調べることで
どちらの exe から起動されたかを判別することができるので、例えば以下のようにすると game.exe から起動されたときだけフルスクリーンにすることができます。
なお、フルスクリーン/ウィンドウモードを選択できるのは set_video_mode で画面を初期化するときのみで、
ゲームの実行中に切り替えることはできません。
関連リンク
- Ruby/SDL
- Ruby/SDL の公式サイトです。
- Ruby/SDL Reference
- Ruby/SDL の日本語リファレンスです。
- Ruby/SDL Users
- Ruby/SDL の関連情報についてまとめたページです。まだ出来立てですが、Ruby/SDL を利用した作品へのリンク集などがあります。
筆者について
- yhara
- 京大マイコンクラブに所属する大学院生。好きなゲームのジャンルは音ゲーと落ちゲー。