Flappy Birdで学ぶ、ゲームループとアニメーション

# 概要
本稿では、おもに普段ゲーム開発に従事していない開発者(とくにRailsユーザー)を想定読者に、ゲームの実装パターンの典型である **ゲームループ** が、ゲームの各オブジェクトの状態を経時的に変化させる仕組みについて解説します。
また、オブジェクト状態の経時的変化が、 **アニメーション** としてアウトプットされるまでの過程も確認します。題材として、RubyKaigi 2024でデモ披露された **Rails版Flappy Bird** を扱います。

# Rails版FlappyBird
2024年5月の RubyKaigi 2024 の [Samuel Williams](https://github.com/ioquatix) さんの基調講演で、**Ruby on RailsでのFlappyBird実装** のデモがありました。

ビデオゲームが要求するようなリアルタイムなインタラクティブ性を、Railsサーバーでも効率的に実現できる環境が整いつつあるようです。

<iframe width="560" height="315" src="https://www.youtube.com/embed/YacN_phi_ME?si=TADuO3hbr7H4gupy" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>

(各社のブログ等でレポートもあります)
- https://developers.techouse.com/entry/RubyKaigi-2024-ioquatix-day2
- https://gihyo.jp/article/2024/06/rubykaigi-2024-keynote-report-day2

# 本稿のモチベーション: ビデオゲームの実装パターン？
この **Rails版FlappyBird** の実装を読み解くにあたり、**前提となるビデオゲームの実装パターン**についての理解があれば、Railsでそれを実現するフレームワークの優位性がより理解しやすくなると考えます。

他方、RailsはWebアプリケーション開発の文脈での利用が多数派であると推定すると、ユーザー操作をリアルタイムにアニメーションへ昇華するビデオゲームの実装に、馴染みのないユーザーが多いかもしれません。

筆者も普段Railsに触れていますが、ゲーム開発には従事していません。ただ、プログラミングを始めたきっかけはゲームです。過去に [Game Programming Patterns](https://www.amazon.co.jp/Game-Programming-Patterns-%E3%82%BD%E3%83%95%E3%83%88%E3%82%A6%E3%82%A7%E3%82%A2%E9%96%8B%E7%99%BA%E3%81%AE%E5%95%8F%E9%A1%8C%E8%A7%A3%E6%B1%BA%E3%83%A1%E3%83%8B%E3%83%A5%E3%83%BC-impress/dp/4844338900) くらいは読みました。Rails版FlappyBird の登場は、筆者自身の理解の整理にも都合が良さそうです。これを機にまとめます。

# ビデオゲームで「絵を動かす」
「絵を動かす」ことは、差分を作ったキャラクターや背景画像を用意し、それらを連続的に切り替えることで実現できます。

たとえばテレビアニメーションは、制作側が固定したカメラワーク・カットに対応する大量の一枚絵、で構成されます。

他方、ビデオゲームでは、ユーザーの操作によってプレイヤーやカメラの位置が自由に変更されます。プレイヤー、エネミー、背景…など諸要素の組み合わせを考慮すると、すべてのシーンについて、事前に一枚絵を用意することは現実的ではありません。

## 状態演算と絵の生成
組み合わせ爆発の問題は回避できます。起こりうる全てのシーンの一枚絵の用意を諦め、プレイヤーやエネミーの状態、ユーザーのボタン操作等から、表示すべき絵を**都度演算**するのです。

すなわち「**時間経過やユーザー操作を元に、ゲーム内の各要素の状態を演算する**」「**現在のゲーム状態から、一枚絵の情報を生成する**」を高速に繰り返すことで、テレビアニメーションのような「動く一枚絵」が得られるはずです。

# イベントループ
ユーザー操作の受付、ゲーム内の時間経過、グラフィック情報の生成…これらの高速な反復実行は、[イベントループ](https://ja.wikipedia.org/wiki/%E3%82%A4%E3%83%99%E3%83%B3%E3%83%88%E3%83%AB%E3%83%BC%E3%83%97)というプログラム構造によって実現が可能です。

## ゲーム状態の経時的変化 - ゲームループ
FlappyBirdをはじめ多くのアクションゲームでは、現実の世界と同様、ゲームの世界の中にも時間が流れます。画面上の要素は、ユーザーの操作が無くともに常に変化します。

ユーザー操作から独立したゲーム内の状態更新ループは、「**ゲームループ**」と呼称されることがあります。[^1]

### 単純化したゲームループの実装例

```rb
while true
    経過時間 = 現在時刻 - 前回の実行時刻
    関数_時間の経過処理(経過時間)
end

def 関数_時間の経過処理(経過時間)
    enemyのx座標 += 経過時間 * 補正定数
    # etc...
end
```

この実装例では、`enemy` のx座標が、ループ実行のたびに加算される…つまりゲーム内時間の経過により、ある敵のオブジェクトが(勝手に)一定距離横に移動する結果となります。

## ユーザー操作の待ち受け
多くのアクションゲームにおいては、ユーザー操作を待つ間も、ゲーム内の時間は流れます。見方を変えれば、操作の待ち受けが、ゲーム時間の経過を止めてはなりません。
ユーザー操作は、ゲームループから独立したループでハンドリングすることになります。[^2]

```rb
while true # 永遠に繰り返し
    ユーザー操作 = 関数_ユーザーの操作を待ち受け
    関数_ユーザー操作をハンドリング(ユーザー操作)
end

def 関数_ユーザー操作をハンドリング(ユーザー操作)
    case ユーザー操作
    when 右ボタン
        プレイヤーの移動速度 += 1
    # etc...
end
```

## グラフィック情報の生成・表示
ゲームループやユーザー操作よって変更されたゲーム状態は、最終的にプレイヤーやエネミーといった画面上の要素として描画可能な様式(以降「グラフィック情報」)に変換される必要があります。

各種ループによるゲーム状態の更新に並列して、一定間隔でグラフィック情報を生成すれば、状態が少しずつ変化した大量の一枚絵、ひいてはアニメーションが得られます。

```rb
while true # 永遠に繰り返し
    if 前回実行から 1/60秒 経過したら
        グラフィック情報 = 関数_状態をグラフィック情報に変換(現在のゲーム状態)
        関数_グラフィック情報を画面に表示(グラフィック情報)
    end
end
```
上記の単純化された疑似コードでは、1/60秒の経過ごとに、現在のゲーム内の状態をもとにグラフィック情報を生成し、画面描画します。
(理論上は、1/60 秒などの閾値が細かいほど滑らかなアニメーションとなる)


# Anatomy of Flappy Bird
ここからは、[socketry / flappy-bird](https://github.com/t407o/oss-traversal/issues/18) のコードと、利用ライブラリである [socketry / live](https://github.com/socketry/live) の内容を横断しつつ、各種のイベントループによるアニメーション描画の実際を追います。

(ブラウザ側の実装には踏み込まず、サーバー側の解説にとどめます。また、socketry / live による ruby クラスと html のバインディングのおおまかな仕組みについては、[基調講演](https://www.youtube.com/watch?v=YacN_phi_ME)を参照ください)

## socketry / flappy-bird について
- Ruby on Rails で実装された、Webブラウザで遊べる Flappy Bird
- ゲーム画面はほぼ HTML と CSS で構成
- 通信にWebSocketを利用し、ユーザー操作のサーバー処理 / サーバーで生成したHTMLのブラウザ描画 をリアルタイムに実現

## ２つのイベントループ
Rails版Flappy Birdは、大まかには２つのイベントループから構成されます。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/1353793/2e596363-8f3e-8bc0-852b-1c9f6d3eba35.png)

:::note warn
記載のコンポーネント・イベント名は筆者による便宜上のものであり、公式なものではありません。
:::


### 1. メインループ (Main Loop)
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/1353793/aa3508f1-7865-2502-0bbd-80459f2ba858.png)

ゲームのWebページの描画後、起動した状態を維持するループです。

クライアント(ブラウザ) / サーバー 双方で発生するイベントを待ち受け、発生の検出時に後続処理へ中継します。前掲の「**ユーザー操作のハンドリング**」「**グラフィック情報の作成・表示**(の一部)」を担います。

ライブラリである[socketry / live の Live::Page#run](https://github.com/socketry/live/blob/v0.17.0/lib/live/page.rb#L117-L148)の実装が相当し、FlappyBird側のControllerでWebSocket通信の確立時にコールされます。

```rb:socketry / flapy-bird > game_controller.rb
def live
    self.response = Async::WebSocket::Adapters::Rails.open(request) do |connection|
      Live::Page.new(RESOLVER).run(connection)
    end
end
```
https://github.com/socketry/flappy-bird/blob/main/app/controllers/game_controller.rb#L14

#### ブラウザ -> サーバー 方向のイベント
WebSocketにより、主にはユーザーのキー操作を受け取ります。

```rb:socketry / live > page.rb
while message = connection.read # 筆者注: WebSocketのconnectionのmessage受信を待機
	last_update = Async::Clock.now
	process_message(message.parse)	
end
```
https://github.com/socketry/live/blob/v0.17.0/lib/live/page.rb#L145-L148

キー操作を受け取った `process_message` は、操作に対応した処理の呼び出し、自機の「ジャンプ」状態への更新などが実行されます。
```rb:socketry / flapy-bird > flappy_view.rb
def handle(event)
    detail = event[:detail]
    
    case event[:type]
    when "keypress", "touchstart"
        if @game.nil?
            self.start_game!
        elsif detail[:key] == " " || detail[:touch]
            self.jump
        end
    end
end
```
https://github.com/socketry/flappy-bird/blob/9628e947d28185ee4aa8ff7012e6eba9a57dba76/lib/flappy_view.rb#L340-L351


#### サーバー -> ブラウザ 方向のイベント
生成された最新のグラフィック情報(HTML)をWebSocket経由でブラウザに送信します。

HTMLはゲームループにより逐次キューに蓄積されます。メインループはキュー経由で最新のグラフィック情報を受け取り、WebSocketのメッセージに変換のうえブラウザに送信します。

```rb:socketry / live > page.rb
queue_task = task.async do
    while update = @updates.dequeue
        update.send(connection) # 筆者注: queue に新しいhtmlが存在した場合、websocket経由で送信
        
        # Flush the output if there are no more updates:
        if @updates.empty?
            connection.flush
        end
    end
end
```
https://github.com/socketry/live/blob/v0.17.0/lib/live/page.rb#L121-L130


### 2. ゲームループ (Game Loop)
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/1353793/83c3136d-c45c-aaec-7f94-ab9d84f7034f.png)

タイトル画面でユーザーがゲームの開始操作をした場合に開始するループです。
自機や土管などのオブジェクトの状態を、時間経過を踏まえて再計算します。状態計算後、状態からグラフィック情報(HTML)を生成してキューにenqueueします。

:::note info
Rails版FlappyBirdでは、グラフィック情報の作成ループとゲームループの実装が一致しているようです。
Steamで配信されるPCゲームなどユーザーの動作環境が不定の場合、レンダリングの頻度がゲームループと結合していると不都合がありそうですが、シンプルなブラウザゲームのため簡略化しているものと考えられます。
:::


```rb:socketry / flapy-bird > flappy_view.rb
def run!(dt = 1.0/30.0) # 筆者注: デフォルトでは 秒間 30 回の描画
    Async do
        start_time = Async::Clock.now
        
        while true
            self.step(dt) # 筆者注: 経過時間を踏まえて、自機や土管の座標情報を更新
            
            self.update! # 筆者注: 現在の各オブジェクト状態をベースに HTML の生成を実行、メインループの更新キューにenqueue
            
            duration = Async::Clock.now - start_time
            if duration < dt
                sleep(dt - duration)
            else
                Console.info(self, "Running behind by #{duration - dt} seconds")
            end
            start_time = Async::Clock.now
        end
    end
end
```
https://github.com/socketry/flappy-bird/blob/main/lib/flappy_view.rb#L513-L531

- `self.step!(dt)`
  - 更新後の状態で自機と土管の[接触判定](https://github.com/socketry/flappy-bird/blob/main/lib/flappy_view.rb#L282)を実施し、接触したら [game_over!](https://github.com/socketry/flappy-bird/blob/main/lib/flappy_view.rb#L416-L425) (ゲームループ停止)
- `self.update!`
  - `Live::Element` の [update!](https://github.com/socketry/live/blob/v0.17.0/lib/live/element.rb#L110) メソッドが対応
  - update! 内でコールされる [rpc](https://github.com/socketry/live/blob/v0.17.0/lib/live/element.rb#L98) 内でHTMLがenqueue
  - HTML の生成の本体はFlappyViewクラスで定義の [render](https://github.com/socketry/flappy-bird/blob/main/lib/flappy_view.rb#L533)メソッドが相当。 呼び出しは `update!` のコール経由で実施される

２つのループが並行しつつ相互作用することで、現在のゲーム状態に対応するHTMLが、デフォルトで秒間 30パターン程度ブラウザに送信される結果となります。

# おわりに
元々、大量接続・大量通信におけるFalconサーバー利用の優位性を掘り下げようとしたのですが、イベントループまわりの実装サンプルとして単純に面白いなと思い、こういう切り口に落ち着きました。

イベントループのような低レベルの制御機構は、実際のゲーム開発ではフレームワーク化・隠蔽化されることが予想されますが、Rails版FlappyBirdのように、プログラミング言語の基本的な制御構文で自前実装することも可能そうです。

普段RailsでWeb開発に携わっている方々が面白がって読める内容になれば幸甚です。

![画面収録 2024-12-23 3.40.11.gif](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/1353793/b39c2d0f-83d8-bf7d-76a9-7b9656d8462a.gif)
Flappy Bird!

[^1]: ゲームループという呼称は[Game Programming Patterns ソフトウェア開発の問題解決メニュー](https://www.amazon.co.jp/Game-Programming-Patterns-%E3%82%BD%E3%83%95%E3%83%88%E3%82%A6%E3%82%A7%E3%82%A2%E9%96%8B%E7%99%BA%E3%81%AE%E5%95%8F%E9%A1%8C%E8%A7%A3%E6%B1%BA%E3%83%A1%E3%83%8B%E3%83%A5%E3%83%BC-impress/dp/4844338900)で紹介されているデザインパターンからの引用です。
[^2]: ゲームループというデザインパターン自体「ユーザー操作の待ち受けやレンダリングからゲーム状態演算のループを分離する」というものなので、"ユーザー操作はゲームループから独立したループでハンドリングする"と書くのは頭痛が痛い感じがあります。