メインコンテンツへスキップ

【Godot】ゲーム開発初心者による個人開発日記10

    今週も週1回のゲーム開発の進捗状況などについて投稿していきます。
    以下の記事の続きです。

    今週の主な進捗

    • 設定画面の全体的なUI調整

    • グラフィック設定タブが完成

    • ゲームパッドのキーコンフィグタブがほぼ完成

      • 表示するキーアイコンをXbox, PlayStation, Steam Deck, Switchの4種類から選べる機能も実装

      • 各アクションに対し、キーバインドをクリアするボタンを追加で実装予定

    • UI上で汎用的に使用できる「ページ送り」と「一番上/下に移動する」、「ダイアログを閉じる」機能の追加

    • 設定画面に関する全体的なリファクタリングの実施

    • 画面に表示されるテキストを全てCSVで管理するように修正

    • UTが実装されていなかったメソッドについて、可能な限りUTを追加

    • GitHubでプルリクエストの作成とプッシュによる更新を行った際に、CSVの静的解析とUTを自動実行するようなワークフローを追加

    • GitHub Copilotで作業を指示する際に読み込まれるSKILL.mdの追加と、instructions.mdの調整

    • Godot SQLiteの導入

      • アイテムの情報やインベントリをデータベース(SQLite)で管理するために利用予定

    画像
    GitHubのプルリクエストで表示される、GitHub Actions関連のチェック。
    CSV LintとUnit Testsが今回追加したもので、それ以外はCopilotレビューに関するもの。
    画像
    UI操作に関するキーコンフィグ画面。
    UIについては、フォントが大きすぎる箇所を少し小さくしつつ、下の説明文の表示箇所を真ん中寄りに変更した。目線移動を抑えられるようになり、プレイヤーの負荷を減らすことができる。

    設定画面の実装も終わりが見えてきた

    今週でグラフィック設定、オーディオ設定、ゲームパッドのキーコンフィグの3つがほぼ完成しました。これで設定画面に関する残りの作業は、キーボードのキーコンフィグの実装と、ゲーム関連の設定項目の追加だけになります。

    コードはテストコードを除いて既に5000行に達しました。その他、テキストを管理しているCSVに対して静的解析を行うワークフローと、UTを全ケース実行するワークフローを用意し、プルリクエスト作成時に動く仕組みを作ったりと、開発環境も最適化が進んでいます。今週は3連休だったこともあり、進捗状況が非常に良くて気分も最高です。

    UTやCSVの静的解析をGitHub Actionsで実行する方法

    CIツールに関する知識があまりない方も多いと思うので、GitHubで自動実行できるようにするやり方を書いておきます。

    ymlファイルを用意し、.github/workflows/に格納するだけ

    ymlファイルでワークフローの設定を定義し、決められたディレクトリにymlファイルを格納するだけで、GitHub Actionsが動くようになります。実際にUTを動かすために使用しているymlファイルは以下の通りです。

    name: GUT Tests
    
    on: [pull_request]
    
    jobs:
      unit-tests:
        runs-on: ubuntu-latest
        container:
            image: barichello/godot-ci:4.6.1
    
        steps:
          - name: Checkout
            uses: actions/checkout@v4
    
          - name: Install GUT addon if missing
            run: |
                if [ ! -f addons/gut/gut_cmdln.gd ]; then
                  git clone --depth 1 --branch godot_4_6 https://github.com/bitwes/Gut.git /tmp/gut
                  mkdir -p addons
                  cp -R /tmp/gut/addons/gut addons/gut
                fi
    
          - name: Initialize Godot imports
            timeout-minutes: 5
            run: |
                mkdir -p ~/.config/godot
                godot --headless --path . --import --quit --display-driver headless
    
          - name: Prepare report directory
            run: mkdir -p reports/gut
    
          - name: Run GUT unit tests
            run: >-
              godot --headless --path .
              -s res://addons/gut/gut_cmdln.gd
              -gconfig=res://.gutconfig.json
              -gjunit_xml_file=reports/gut/junit.xml
              -gexit
    
          - name: Upload JUnit report
            if: always()
            uses: actions/upload-artifact@v4
            with:
              name: gut-junit
              path: reports/gut/junit.xml
              if-no-files-found: ignore

    ymlファイルを格納した状態でプルリクエストを作成することで、自動的にUTが走るようになります。以下のように全てのテストが完走したらOK。

    画像
    UTのログ

    UTが失敗したら、プルリクエスト上で失敗したことが分かるようになっているので、問題のあるコードが含まれている状態でリリースされたり、developブランチにマージされることを防いでくれます。

    ちなみに、CSV Lintの方は以下のようになっています。

    name: CSV Lint
    
    on: [pull_request]
    
    jobs:
      csv-lint:
        runs-on: ubuntu-latest
    
        steps:
          - name: Checkout
            uses: actions/checkout@v4
    
          - name: Run CSV lint
            run: python .github/scripts/csv_lint.py
    

    pythonファイルが読み込まれるようになっており、CSVが規約に沿った内容になっているかをpythonで確認できるようになっています。

    """
    CSV lint script for Resources/Texts/**/*.csv
    Validates:
      0. Column count matches header
      1. ID naming: ^[A-Z0-9_]+$ (uppercase alphanumeric + underscore only)
      2. ID order: each file's IDs must be in ascending (lexicographic) order
      3. ID uniqueness: IDs must be unique across all CSV files
    """
    
    import csv
    import os
    import re
    import sys
    from pathlib import Path
    
    SCRIPT_DIR = Path(__file__).resolve().parent
    REPO_ROOT = SCRIPT_DIR.parent.parent
    CSV_ROOT = REPO_ROOT / "Resources" / "Texts"
    ID_PATTERN = re.compile(r"^[A-Z0-9_]+$")
    
    
    def collect_csv_files() -> list[Path]:
        return sorted(CSV_ROOT.rglob("*.csv"))
    
    
    def lint_csv(path: Path, all_ids: dict[str, tuple[Path, int]]) -> list[str]:
        errors: list[str] = []
        prev_id: str | None = None
    
        with path.open(encoding="utf-8", newline="") as f:
            reader = csv.reader(f)
            try:
                header = next(reader)
            except StopIteration:
                errors.append(f"{path.relative_to(REPO_ROOT)}: ファイルが空です")
                return errors
    
            if not header or header[0] != "id":
                errors.append(
                    f"{path.relative_to(REPO_ROOT)}: ヘッダー行の最初の列が 'id' ではありません (actual: '{header[0]}')"
                )
    
            expected_col_count = len(header)
    
            for line_num, row in enumerate(reader, start=2):
                if not row:
                    continue
                current_id = row[0]
    
                # Rule 0: column count matches header
                if len(row) != expected_col_count:
                    errors.append(
                        f"{path.relative_to(REPO_ROOT)}:{line_num}: "
                        f"カラム数がヘッダーと異なります: 期待値={expected_col_count}, 実際={len(row)}"
                    )
    
                # Rule 1: naming convention
                if not ID_PATTERN.match(current_id):
                    errors.append(
                        f"{path.relative_to(REPO_ROOT)}:{line_num}: "
                        f"命名規則違反 (大文字英数字とアンダースコアのみ使用可): '{current_id}'"
                    )
    
                # Rule 2: ascending order within file
                if prev_id is not None and current_id <= prev_id:
                    errors.append(
                        f"{path.relative_to(REPO_ROOT)}:{line_num}: "
                        f"IDが昇順になっていません: '{prev_id}' -> '{current_id}'"
                    )
    
                # Rule 3: uniqueness across all files
                if current_id in all_ids:
                    conflicting_path, conflicting_line = all_ids[current_id]
                    errors.append(
                        f"{path.relative_to(REPO_ROOT)}:{line_num}: "
                        f"IDが重複しています: '{current_id}' "
                        f"(先出: {conflicting_path.relative_to(REPO_ROOT)}:{conflicting_line})"
                    )
                else:
                    all_ids[current_id] = (path, line_num)
    
                prev_id = current_id
    
        return errors
    
    
    def write_step_summary(errors: list[str]) -> None:
        summary_file = os.environ.get("GITHUB_STEP_SUMMARY")
        if not summary_file:
            return
    
        with open(summary_file, "a", encoding="utf-8") as f:
            if errors:
                f.write("## CSV Lint: FAILED\n\n")
                f.write(f"**{len(errors)}件のエラーが検出されました。**\n\n")
                f.write("| # | エラー内容 |\n")
                f.write("|---|---|\n")
                for i, error in enumerate(errors, start=1):
                    escaped = error.replace("|", "\\|")
                    f.write(f"| {i} | {escaped} |\n")
            else:
                f.write("## CSV Lint: PASSED\n\n")
                f.write("全てのCSVファイルが命名規則に準拠しています。\n")
    
    
    def main() -> None:
        csv_files = collect_csv_files()
        if not csv_files:
            print(f"CSVファイルが見つかりません: {CSV_ROOT}")
            sys.exit(1)
    
        all_ids: dict[str, tuple[Path, int]] = {}
        all_errors: list[str] = []
    
        for csv_file in csv_files:
            errors = lint_csv(csv_file, all_ids)
            all_errors.extend(errors)
    
        if all_errors:
            for error in all_errors:
                print(error, file=sys.stderr)
            print(f"\n{len(all_errors)}件のエラーが検出されました。", file=sys.stderr)
        else:
            print(f"{len(csv_files)}個のCSVファイルを検証しました。エラーはありません。")
    
        write_step_summary(all_errors)
        sys.exit(1 if all_errors else 0)
    
    
    if __name__ == "__main__":
        main()
    

    ちなみにこの手のymlやpythonファイルは、生成AIに指示すれば作ってくれます。GUTのymlは自分で調整が必要でしたが、CSV Lintの方はちゃんと動くものを一発で作ってくれました。便利な世の中になったものです。

    SKILL.mdについて

    SKILL.mdとは

    SKILL.mdはGitHub Copilotで生成AIによる各種作業を行う際に、特定の作業をする時だけ読み込んでほしいルールや作業手順などを指定するファイルです。

    これまで使ってきたinstructions.mdは、コード生成やファイル読み込みを行う際のファイル形式やディレクトリを指定して、特定のファイルを使う時だけコンテキストを読み込むようにできました。それに対してSKILL.mdは、作業単位でコンテキストを読み込むタイミングを指定できます。

    生成AIは読み込めるコンテキストに限界があるのですが、これらのファイルを活用することによって、生成AIが読み込むコンテキストを減らすことができます。これにより、AIエージェントが行う多くの作業に対してルールを指定しながらも、コンテキストが増えることによる作業の質の低下を回避できます。

    実際の構成

    実際に私が使っているinstructions.mdとSKILL.mdは以下の通りです。これらのファイルをうまく調整することが、開発を効率的に進める上で必要不可欠です。

    copilot-instructions.md

    # プロジェクトの概要
    
    ## リポジトリについて
    
    このリポジトリはGodot 4.6以上で開発されたゲームのソースコードを含みます。コードは主にGDScriptで記述されています。
    
    ## ゲームの概要
    
    このゲームは3DダンジョンクローラーRPGです。ゲームバランスやシステムは異なるものの、概ねウィザードリィシリーズをベースとしたゲーム性となります。
    
    ## プロジェクトの構成
    
    - `res://addons/`: Godotのアドオンを格納
    - `res://Scenes/`: シーンファイル(.tscn)と、それに紐づくスクリプト(.gd)を格納
    - `res://Scripts/`: シーンファイルに紐づかない汎用的なスクリプトを格納
    - `res://Assets/`: 画像、音声、3Dモデルなどのアセットを格納
    - `res://Resources/`: マップデータなどの各種リソースを格納
    - `res://test/`: GUTのテストコードを格納
    
    ## アドオン一覧
    
    - GUT
      - 単体テスト用のアドオン
    - Godot-SQLite
      - SQLiteデータベース操作用のアドオン
      - 主にアイテムのデータ管理目的で使用
    
    ## その他
    
    ### 対応デバイス
    
    - キーボード
    - ゲームパッド
    - マウス
    
    # 全般的なルール
    
    - 日本語で表現しにくい場合を除いて、基本的に日本語で応答すること
    - 上記プロジェクトの概要や既存の実装を踏まえて、矛盾のない回答やコード生成を行うこと
    - 必要なリファクタリングは積極的に行うこと
    
    # 質問への回答・調査時のルール
    
    - 極力Godotの公式ドキュメントを引用すること
    - 参考にした資料のうち、主要なもののURLを可能な限り添付すること
    

    gdscript.instructions.md

    ---
    applyTo: "**/*.gd"
    ---
    
    # スタイルガイドについて
    
    公式のリファレンスに記載されているGDScriptスタイルガイドを順守してコード生成を行ってください。
    当プロジェクトでは以下の追加ルールを適用します。スタイルガイドと矛盾する場合、追加ルールが優先されます。
    
    - Code orderについて、シグナルで呼び出されるメソッドはoverridden custom methodsとremaining methodsの間に配置すること
    - 変数宣言の際は型指定、または型推論を可能な限り使用すること
    - マジックナンバーの使用は極力避けること
    - フィールド変数はprivateにすること。外部からアクセスが必要な場合、getter/setterを設定したpublicの変数を定義すること
    - 1行当たりの文字数は100文字以内に収めること。100文字を超える場合、適切な箇所で改行すること
    - 改行をする際は、極力"\"を使わないようにすること。括弧が使えない場合のみ、"\"を使用して改行すること
    - 自分で定義したメソッドの前にドキュメンテーションコメントを追加すること
      - _ready()などのGodotが提供しているメソッドには、ドキュメンテーションコメントを追加する必要はない
    - ファイルの最終行の末尾に改行(CRLF)を入れること
    
    # GDScriptの仕様上の注意点
    
    - 入れ子の型指定はサポートされていないため、必要に応じて型指定を省略すること
      - 例: 本来はDictionary[String, Array[String]]と型指定するのが望ましいが、コンパイルエラーになるため、Dictionary[String, Array]と書く必要がある
    - 入れ子の型指定ができない影響で、入れ子になった配列の中身をそのまま取り出すと、型安全性を保証できない。そのため、入れ子の中身だけを型指定付きで定義し、その後入れ子の配列や辞書に格納して型安全性を確保すること
      - 例: var my_array: Array[String] = ["a", "b", "c"]と定義した後、var my_nested_array: Array[Array] = [my_array]とする
    - 型指定や型推論された変数は、デフォルト値も含めて型が変わらないようにすること
      - 例: var my_array: Array[String, Dictionary]について、入れ子の辞書の型がDictionary[Integer, String]という前提で実装されている場合、my_array.get("key", {} as Dictionary[Integer, String])とする
    - Enumのキー一覧を取得する際、Enum.keys()を使うとStringで取得してしまうことに注意すること。Enum型を維持したい場合、Enumのキーを格納した配列を定義するか、Enumのキーが全て含まれる辞書からキー一覧を取得するメソッドを実装すること
    

    SKILL.md (テキスト関連)

    ---
    name: text
    description: テキスト操作に関するガイド。画面上に表示させる文字列の生成や翻訳の際に使用すること。
    ---
    
    # テキスト操作ガイド
    
    ## テキストの管理方針
    
    画面上に表示させる全ての文字列は、可能な限りGodotが提供する多言語対応の仕組みを利用して管理してください。つまり、CSVファイルで文字列を管理し、Godotで自動生成されるtranslationファイルを利用して、ゲーム内で文字列を取得するようにしてください。
    
    ## ディレクトリ構成
    
    - `res://Resources/Texts/`: CSVファイルを格納するディレクトリ
    
    ## テキストの取得方法
    
    - `res://Scripts/Utilities/text_service.gd`のTextServiceクラスを利用してテキストの取得を行うこと
    
    ## CSVファイルの管理方法
    
    - シーンや用途ごとにCSVファイルを分けること
    - IDの命名規則について
      - IDは全てのCSVを通して一意にすること
      - IDは大文字英数字とアンダースコア(_)のみを使用すること
      - IDは[CSVのファイル名]\_\_[グループ名]\_\_[ノード名]の形式にすること
        - ノード名が長すぎる場合は、ノード名を短縮して良い
        - グループに属するノードが多い場合、さらに\_\_[サブグループ名]をノード名の前に追加して良い
        - 例: UI_SETTINGS\_\_GRAPHICS\_\_ANTI_ALIASING
      - 会話文などの長い文章を格納する場合、一度に表示する文章を1つの行に格納し、複数行に分割させること。その際は、IDの末尾を\_\_[0から始まる連番]とすること
        - 例: NPC_DIALOGUE\_\_VILLAGER\_\_GREETING\_\_0, NPC_DIALOGUE\_\_VILLAGER\_\_GREETING\_\_1, ...
    - IDの昇順で並べること
    - 文章の中で改行が必要な場合、\nを使って改行すること
    - ファイルの最終行の末尾に改行(CRLF)を入れること
    - UTF-8 without BOMで保存すること
    
    # テキスト作成のガイド
    
    ## 全般的なルール
    
    - 当ゲーム特有の固有名詞に表記ゆれがないこと。使用する固有名詞の一覧と説明は今後追加予定
    - 過度に暴力的、性的な表現や、差別的な表現、または特定の人種、性別、宗教、国籍などに対する偏見を助長する表現を避けること
    
    ## 翻訳に関するルール
    
    - 原文の意味を正確に伝えること。特に会話文は、キャラクターの性格や口調が反映されるように翻訳すること
    - 翻訳文の長さが原文と乖離しすぎないようにすること
      - 表示するスペースが限られている箇所では、翻訳の正確性よりも、無理のない範囲で短く翻訳することを優先すること
    - 会話文の場合、文章の分割回数を原文と同じにすること。余程違和感がある場合を除き、分割する箇所も原文と同じにすること
    

    SKILL.md (UT用)

    ---
    name: testing
    description: GUTによるテスト運用に関するガイド。UTの作成や実行、ログ確認と、それらに関する計画を立てる際に使用すること。
    ---
    
    # テスト運用ガイド
    
    ## UTの実装方針
    
    現実的な範囲内で、品質担保の最大化を目指してUTの実装を行ってください。
    
    ## ディレクトリ構成
    
    - `test/unit`: 通常の単体テスト
    - `test/integration`: シーン・複数コンポーネント連携のテスト
    - `test/helpers`: テスト共通ヘルパー
    
    ## GUTの仕様による制約
    
    - テスト用のスクリプトは必ずtest_で始まる名前にすること
    - インナークラス名は必ずTestから始まる文字列にし、GutTestを継承すること
    
    ## コーディング規約
    
    - テスト対象のメソッドごとにインナークラスを作り、その中でテストを実装すること
    - autofreeやadd_child_autofreeなどを使い、テストコード内で生成したオブジェクトやノードはテスト終了後に解放すること。これらの解放漏れに関するログが出た場合、テストが全て成功したとしても、無視せず修正を行うこと
    
    ## UTの実行と結果確認
    
    ### 概要
    
    GUTの実行方法と結果の確認方法についてのガイドです。VS Codeでの実行時にクラッシュする事象があるため、標準出力・標準エラーを破棄して、XMLファイルで結果を確認する方法を推奨しています。
    
    ### 実行方法
    
    - 以下のコマンドでUTを実行すること。実行結果(`Tests=N Failures=N ...`)はコマンド終了時に自動で表示される
    
    ```powershell
    powershell -ExecutionPolicy Bypass -File "test\run_gut_unit.ps1"
    ```
    
    - 実行結果の詳細を確認する場合は、以下のコマンドでXMLをエディタで開く
    
    ```powershell
    code -r "reports/gut/junit.xml"
    ```
    
    # 補足
    
    - テストの運用方法の背景は`res://test/README.md`に記載。

    SKILL.md (コードレビュー用)

    ---
    name: code-review
    description: コードレビューに関するガイド。
    ---
    
    # コードレビューのルール
    
    - .gdファイルと.csvファイルに対してのみ指摘を行うこと
    - 以下のディレクトリ内のファイルはコードレビュー時に一切確認しないこと
      - `res://addons/`配下のファイル
    - 以下の優先順位で指摘を行うこと
      1. クラッシュや進行不能になり得るコード
      2. セキュリティ上の問題を引き起こすコード
      3. パフォーマンスに重大な影響を与えるコード
      4. 可読性や保守性に影響を与えるコード
      5. その他の改善点
    

    Godot SQLiteについて

    SQLiteはサーバーレスで動作するリレーショナルデータベースです。SQLiteをGodotで動かせるアドオンがGodot SQLiteです。

    設定関連などの小規模なデータはResourceで管理すれば事足りますし、テキストデータも全てCSV管理で問題ありません。しかし、多くの種類の敵やアイテムが存在する場合や、アイテムに多数の設定値があるような場合、セーブデータに多くの情報を詰め込まないといけない場合などでは、それらの情報をResource上で管理するには無理があります。

    これらのデータをデータベース(DB)で管理することで、多数の情報を持つデータを効率よく管理することができるだけでなく、メモリ使用量を抑え、ソート機能を簡単かつ高速で実行できるようになります。

    設定画面しか作っていない現状では、まだSQLiteを使う場面がありませんが、ゲームの中身を作っていく段階から徐々にSQLiteにお世話になることでしょう。

    Godot SQLiteは、GUTに次いで、ゲーム開発ではほぼ導入必須となるアドオンと言えます。

    その他の話題

    Claude Sonnet 4.6が発表

    2026/02/17にSonnet 4.6が発表されました。性能については、普段使いはほぼこれ一択と言えるほど高性能で、GPT-5.2を引き離している印象です。

    コーディングではGPT-5.3-Codexの存在感が強く、特にコーディングを完了させるまでの時間は圧倒的にGPT-5.3-Codexが早いです。しかし、出力の質自体はSonnet 4.6とそこまで大差なく、むしろより深く推論してくれるSonnet 4.6の方が使いやすい場面すらあります。

    より多くの人が効率的にゲームを開発できるようになってほしい

    生成AIの高性能化が高速で進んでいますが、これによってinstructions.mdやSKILL.mdを整備する重要度が増したり、生成AIをうまく使う技術や言語化能力がより求められているようになっていると思います。開発効率が格段に上がることは嬉しい反面、言語化能力や新しいツールを扱う能力の優劣から生じる格差がどんどん広がっていくのを肌で感じます。

    そのような背景もあって、技術に関することや生成AIの扱い方などは積極的に記事で取り上げて、効率的な開発手法を真似しやすいようにしていきたいと思っています。

     
     
    カードゲームやボードゲーム、RPGなどが好きなソフトウェアエンジニア。 現在は3DダンジョンRPGを自作するためにGodotを勉強中。

    あなたへのおすすめ