HN 日本語サマリー

← 一覧へ戻る
プログラミング

GTFO VR Mod Postmortem

GTFO VR Mod Postmortem (dsprtn.dev)

4 pointsby Dsprtn1 コメント

要約

この記事は、人気ホラーシューターゲーム「GTFO」のVR Mod開発における5年以上にわたるポストモーテム(開発後分析)です。開発者は、Unityのデコンパイルとランタイムパッチング技術(Harmony、BepInEx)を駆使して、ゲームプレイ体験をVRに最適化しました。VR特有の課題(エイム、UI、インタラクション)を克服し、コミュニティの協力も得ながらModを完成させた経緯が語られています。

全文翻訳

GTFO VR Mod Postmortem

Intro

5年以上前、500回のコミット、そして1000時間近くを費やして、私はある退屈な午後にGTFOがVRでどのように見えるだろうかと考え始めました。そして、その答えを見つけようという過ちを犯してしまったのです。

2017年のGame Awardsでゲームのトレーラーを見て以来、私はGTFOに注目してきました。サバイバルホラー、協力プレイ、シューター、そして(謳われている通りの)極端な難易度という、私にとってすべてが理想的な要素を備えていました。

私はすべてのプレイテストに参加することができ、そのたびにゲームに夢中になりました。GTFOの世界観である「Complex」は見る者を魅了し、そこに生息するモンスターたちはユニークで興味深いものでした。ゲームは約束通り、非常に難しく、そして非常に楽しかったのです。

First Foray Into Modding

最初のアルファテストが終わる前から、私はGTFOの改造に着手しました。Unityゲームのデコンパイルと改造が非常に簡単であることをすぐに発見しました。DnSpy/DotPeekを使えば、Mono(Unityのデフォルトスクリプティングバックエンド)は.NETバイトコードにコンパイルされるため、元のソースコードを再構築するために必要なほとんどすべてを保持しており、ゲームのほぼソースコードを覗くことができます。

例えば、これは私が素早くまとめたUnityプロジェクトから取得できるものです:

Decompiled code

public class DeleteIfNear : MonoBehaviour {
  [SerializeField]
  private GameObject Offender;
  [SerializeField]
  private float Distance = 50f;

  private void Update() {
    if (!((Object) this.Offender != (Object) null) || (double) (this.transform.position - this.Offender.transform.position).sqrMagnitude >= (double) this.Distance * (double) this.Distance)
      return;
    Debug.Log((object) ("Deleting offender " + this.Offender.name));
    Object.Destroy((Object) this.Offender);
    this.Offender = (GameObject) null;
  }
}

元のソースから:

Source code

/// <summary>
/// Deletes an object if it gets close enough
/// </summary>
public class DeleteIfNear : MonoBehaviour
{
  [SerializeField]
  private GameObject Offender;

  [SerializeField]
  private float Distance = 50.0f;

  void Update()
  {
    // If distance to target is less than Distance, we delete the offender
    if (Offender != null)
    {
      Vector3 toOffender = transform.position - Offender.transform.position;
      if (toOffender.sqrMagnitude < Distance * Distance)
      {
        Debug.Log($"Deleting offender {Offender.name}");
        Destroy(Offender);
        Offender = null;
      }
    }
  }
}

コメントは削除され、キャストは明示的になり、コードは一般的に「最適化」されています。それでも、十分に読みやすいです。そもそもGTFOのような大規模なコードベースをナビゲートするのは簡単ではありませんが、これは生の逆アセンブリを眺めるよりはるかにましです。

最初は、DnSpyを使ってアセンブリをインプレースで変更するだけでした。すぐに、ゲームのアルファバージョン向けの最初の(未公開)Modを作成することができました。それは、カスタムコードと「借り物」のアセットを使用して、当時のゲームで最も危険な敵であるスカウトをより「効率的に」処理するものでした。

[画像: Blowing up a scout with the BFG9000]
We blow up a scout with the BFG9000

ゲームの正式リリースがすぐに続き、再び、すべてのコンテンツを遊び終えても、私はまだ飽き足らない状態でした。次のアップデートが見えない中、あの運命の、退屈な午後がやってきました。

日中の仕事で培ったUnityとVR開発の知識、初心者レベルのModding知識、そしてSteamVRの経験を武器に、GTFOのモンスター図鑑を間近でじっくり鑑賞できるようなものを作り始めました。

そして、それはまさに間近で個人的な体験でした。VRでは、画面上ではそれほど大きく見えなかった敵が、突然頭上にそびえ立つようになりました。恐ろしいディテールがはるかに顕著になり、Complexの中で迷子になることがこれほど簡単だったことはありませんでした。それは私の期待のすべてを満たすものでした。

その後数週間かけて、VRで完全な試合をプレイできるようにする修正を追加しました。

コミュニティは公開リリースに興味を示しました。その間、DnSpyは私に問題を引き起こしていました。アセンブリを繰り返しインプレースで変更するのは、あまり安定しないことが判明しました。また、私の変更を追跡するのも煩雑になってきました。あまりにも多くのランダムなクラッシュと、ゲームアセンブリを変更したままModを合法的に配布できないことから、私は解決策を必要としていました。

Harmony and BepInEx to the rescue

解決策はランタイムパッチングでした。Harmonyは、既存のメソッドにランタイムでコードをプリペンド(追加)、アペンド(追記)、あるいは置き換えることができるライブラリです。名前が示すように、コードのプリペンド/アペンドが主なパラダイムであるため、ほとんどのModはデフォルトで共存できます。BepInExは、HarmonyベースのModをロードすることを中心に構築されたUnityゲーム用のModマネージャーです。

/// <summary>
/// Add event calls for the player shooting weapons
/// </summary>

[HarmonyPatch(typeof(Weapon), nameof(Weapon.ApplyRecoil))]
internal class InjectPlayerWeaponFireEvents
{
  private static void Postfix(Weapon __instance)
  {
    if(__instance.Owner.IsLocallyOwned)
    {
      PlayerFireWeaponEvents.WeaponFired(__instance);
    }
  }
}

ゲームが起動すると、このコードはGTFOのコード内のWeapon.ApplyRecoilメソッドの末尾に追加されます。

主な考え方は、変更されたゲームコードを配布することは、ほとんどが著作権で保護されたものを配布することになるため、合法ではないということです。しかし、ユーザーのPC上でゲームコードを変更するコードを配布することは問題ありません。Harmony/BepInExスタックに切り替えたことで、Modを適切な、整理されたプロジェクトにアップグレードし、ソース管理に入れ、GitHubに公開することができました。それが最初のコミット、2020年2月1日です。

プロジェクトが保守可能な状態になり、一般公開された後も、機能追加を続けました。最初の目標は、ゲームを完全にVR内でプレイ可能にすることでした。特に、モーションコントロール、ゲームメニュー、インゲームUI、そしてインゲームのターミナル操作を機能させる必要がありました。その後数ヶ月かけて、これらすべてがModに組み込まれました。そして、その後の数年間、Modはゲームのアップデートに合わせて更新され続けました。多くのシステムに様々な改善が加えられ、他の開発者からの大きな貢献もありました(!)。

The Gameplay in VR

VRへの切り替えには独自の課題が伴いました。GTFOは難易度と協力プレイがすべてなので、私の主な考え方は、プレイヤーが非VRプレイヤーに対して過度に不利でも有利でもないようにすることでした。

VR版では正確な射撃が困難でした。長らく、アイアンサイト/スコープはVRで正しくレンダリングされなかったり、エイム方向と一致しなかったりしました。このため、すべての武器に内蔵レーザーポインターを含めることにしました。最終的に、開発者自身がサイトが(見た目も)きれいに揃うようなシェーダーに切り替えたため、レーザーポインターはトグル可能にしました。

不正行為との戦いにもある程度の労力が必要でした。VRでは、ルームスケールでドアを通り抜けて覗いたり、銃をドアの後ろに突き出して撃ったりすることが容易でした。幸いなことに、頭がコリジョン内に入った場合に画面をブラックアウトすることで、これは簡単に緩和されました。これをしなかったら、プレイヤーは自分たちの楽しみを最適化する方法を見つけていたでしょう。

UIは一般的に挑戦的でした。没入感を高めるために、可能な限り2D UIをコピーしないようにしました。結局、他の多くのVRシューターと同様に、カスタムの腕時計型UIを作成しました。ダイエジェティック(作中世界の設定に沿った)であることは非常にクールですが、アーティストやデザイナーのタッチがもっと必要だったと思います。MrKeragが腕時計のより良いモデルを作成してくれたので、少なくともフィットビットでComplexをさまよう必要はなくなりました。

[画像: The original, fitbit-looking watch.] 問題のフィットビット

[画像: The improved version of the watch.] そして改善版

メニューUIについては、2Dゲームメニューを貼り付けたインタラクティブな湾曲SteamVRオーバーレイを表示するという、シンプルで使い捨てのハックを採用しました。これはかなりうまくいったので、そのまま使用しました。SteamオーバーレイAPIは扱いやすく、それにレイキャスティングしてインゲームカーソルを配置するのは簡単でした。何よりも、カスタムメニューUIレンダリングや関連する問題に対処することを完全に回避できました。

[画像: The main menu as seen in VR.] VRゲームメニュー

GTFOにはインタラクティブなコンピュータターミナルもあり、これはゲームの非常に重要な部分です。最初は、VRランタイム内に存在する仮想キーボードを使用していました。大文字キーとしていくつかのひどいショートカットを内蔵していました。それは十分に機能しましたが、ユーザーフレンドリーとは程遠いものでした。幸いなことに、Nordskoggの勇敢な努力により、驚くべき機能(画面上でのテキスト選択など)を備えた、フルでユーザーフレンドリーなインゲームキーボードを備えたターミナル操作の新しいバージョンが登場しました。

[画像: Nordskogg's improved in-game terminal UI.] Nordskoggによる改善されたターミナル

さらに、QoL(Quality of Life)や「クール」な機能も考慮に入れました。

  • 左利きサポート。
  • 実際にしゃがむとゲーム内でもしゃがむ機能。
  • 様々な3D/2D UIトグル。
  • VRコントローラーメカニクス(主に両手持ちエイム関連の設定)。
  • VR固有のグラフィックオプション。
  • レーザーポインターの色(なぜなら、なぜダメなのか?)。

もう一つの注目すべき設定は、高さオフセットです。一部のレベルには首の高さまで有毒な霧があり、背の低いプレイヤーはVRで頭が霧の上に届かないことがありました。同様に、オプションの弾薬表示ホログラムを追加しました。戦闘中に腕時計を見て弾薬数を確認するのは、必ずしも魅力的なアイデアではありませんでした。

[画像: The in-game ammo hologram UI.] よりUXフレンドリーな弾薬表示。

これらの設定はすべて、プレイヤーがModを好みに合わせて調整できる設定フレームワーク内にあります。フレームワークは事前に作成されたため、上記のアクセシビリティ機能のような新しいオプションを追加するのは簡単でした。また、インゲームのランタイムUIデバッグフラグによるデバッグも容易になりました。時間投資の価値は十分にありました。

The Architecture

ゲームが早期アクセスであったため、ゲームのアップデートごとに物事が基本的に壊れていました。このため、(そして当時の私の経験不足から)アーキテクチャと保守性はプロジェクトの初期段階ではある程度後回しにされていました。

コードベースの各主要部分のデザインは広範囲にわたって反復されましたが、当初は実装時点での最も理にかなったものから生まれました。このため、途中で自己完結型のプレイヤー関連機能をコンポーネントに分割するための大規模なリファクタリングを行い、ゲームがIL2CPPに切り替わった際には、物事を再び整理するために別の書き直しを行いました。

時間が経つにつれて、Modコード全般の最大の課題は、ゲームへの変更がゲームコードと非常に暗黙的に結合されているため、しばしば両方のコードベースを考慮する必要があることに気づきました。これは当然のことのように聞こえますが、Modがより多くのゲームシステムと相互作用するにつれて悪化するだけです。ゲームシステムがアップデートによって変更されると、物事は非常に急速に混乱します。

しかし、自己完結型のオブジェクトから機能を作成し、コードインジェクションをコードベースの異なる部分に明示的に分離することで、この問題から私たちを保護しました。これは、Risk of Rain 2のようなゲームでModderによって作成および使用される一般的なModding APIほどではありませんでしたが、同様の利点がありました。

簡単に言うと、ゲームコードと対話するには多くの認知的なオーバーヘッドが必要です。例えば、さまざまなハプティクス強化イベント(異なる武器の発射、ダメージを受ける、弾薬を受け取るなど)のために、さまざまなチェックやデータ取得をどこに注入するかを決定することは、毎回行うのは面倒なだけです。これを私たちに代わって処理する、中間のレイヤー(または2つ)を一度書く方が簡単です。

[画像: A diagram of multiple game systems, connecting to a weapon fire event, which then connects to weapon haptics code.] プレイヤーは両手でエイムしていますか? しゃがんでいますか? 現在の銃の「キック」はどれくらいですか? 私たちの内部「API」が教えてくれます!

特定の「API」が一度しか使用されない場合でも、コードベース内で物事を非常に明確にし、それは私の意見では、バグ耐性があり理解しやすい状態を保つための鍵です。さらに、ゲームのアップデートによって物事が壊れた場合、しばしば私たちの「API」を修正するだけで済みます。

最終的に、コードベースはおおよそ以下の分割で構成されました。

  • レンダリング、ゲームプレイ、UI、入力、イベントなどのカテゴリごとのインジェクションコード。ゲームコードと相互作用したり、直接変更したりします。
  • インジェクトされたコードによって呼び出され、ダメージを受ける、発砲するなどの行為をブロードキャストするゲームイベント。
  • プレイヤーや武器などの対応するGameObjectに結合されたり、ゲームイベントに反応したりする自己完結型のビヘイビア。
  • 上記すべてをサポートするためのヘルパーシステム、データ構造など。

[画像: An overview of the project folder structure.] プロジェクトのフォルダ構造全体。

他の開発者があまり手がかからずに意味のある貢献をすることができたのは、分割がある程度合理的であった兆候だと考えています。

nameof(Class.Method)を使用してインジェクションポイントをマークするなど、文字列の代わりにコンパイル時に欠落メソッドをキャッチする、より単純なトリックや一般的なパターンが現れました。

hindsight(後から考えると)、開発者体験は後回しになりました。イテレーション時間はあまり良くありませんでした。ゲームの起動からゲーム内に入るまで、毎回少なくとも2〜3分かかりました。そのため、既存の機能をイテレートしたりテストしたりするのが遅く、煩雑になることがありました。

同様に、機能レベルの自動テストを作成することも考えましたが、結局手をつけられませんでした。ゲームのアップデートがあまり頻繁ではなかったため、機能が頻繁に壊れることはないだろうと推測し、時間投資は常に期待されるリターンよりも大きいように思えました。これはある程度真実でしたが、特に自分であまり使用しない設定オプションではバグが入り込みました。

実際に行ったのは、プロジェクトのビルド/GitHubリリースアーカイブの作成を自動化することでした。これにより、各リリースを手動でテストする必要がなくなり、多くの時間と手間が省けました。それを行ってよかったと思っていますし、一般的に自動化にもっと時間を投資すればよかったと願っています。

長いイテレーション時間を軽減する一つの方法は、何らかのライブコードリローディングを検討することかもしれません。理論的には、それほど難しくないはずです。有名な最後の言葉です。

IL2CPP

ゲームのフルリリース近くでのIL2CPPへの切り替えは重要な言及事項です。IL2CPPは基本的に、C#コードがC++に変換されることを意味します。IL2CPPには、未使用のコードを削除するなどの、あまり楽しくない機能もいくつかあります。これにより、ModdingツールがIL2CPP Unityゲームへのインジェクションを可能にするまで、Mod(および他のGTFO Mod)は6〜8ヶ月ほど壊滅状態になりました。

その数ヶ月間、私はKnahと協力して、IL2CPPに対する主要な推進力の一つであり、GTFO VR固有の問題を解決しました。Knahのおかげで、GTFO VRは他のModよりもかなり早く復活しました。称賛に値します!

(私は彼を私の個人的なAIエージェントのように酷使しました。ごめんね、Knah!)

今日に至るまで、IL2CPPはソースコードに近いアクセスを不可能にしています。コードベースの多くの部分はMono時代からあまり変わっていませんが、他の多くの部分は変わりました。これは、ゲームのコードベースの「間違った」部分にいる場合、IDA ProまたはGhidraを起動して手動でコードを逆コンパイルする必要があることを意味します。あまり楽しくありません。

Performance

Modのパフォーマンスは常にまあまあでした。主なボトルネックはGPUです。現在、各目のレンダリング間で多くの二重作業(シャドウ、カリングなど)がスキップされていますが、ゲームは基本的にフレームごとに2回レンダリングする必要があります。もちろん、これはこの目的のために設計または最適化されていませんでした。

2020年にGTFOが最初にリリースされたとき、VRでは最も強力なハードウェアでしかうまく動作しませんでした。1070でプレイ可能でしたが、2080Tiが推奨されました。現在では、ゲームのレンダリング複雑さはアップデートで増加しましたが、最新のGPUはそれをかなりうまく処理できます。それでも、Modで即座に対処が必要なものがあるとすれば、それは間違いなくフレームペーシングとパフォーマンスでしょう。

私はこの点について別の記事を書くことを強く検討しています。長年グラフィックスプログラミングにますます深く入り込んでおり、私の新しい経験でGTFO VRのレンダリングを探求し(そして改善する)ことは興味深いでしょう。

Open-Source

オープンソースプロジェクトをリリースし、保守することは私にとって初めてでした。Modをプレイすることだけでなく、寄付したり貢献したりすることへの関心の高さに驚きました。このプロジェクトは数年間私のコーヒー代をすべて賄ってくれ、多くの開発者が主要な機能や修正に貢献してくれました。彼らはModを多くの側面で大きく改善しました。

人々がModを公然とサポートしてくれたことは、非常にモチベーションになりました。私はこれに非常に駆り立てられ、Modを自分だけでなく、プレイしてサポートしてくれるすべての人々のために改善しました。

長年、ゲームへの私の関心は少し薄れてきました。新しい興味深いゲームが登場しました。他のサイドプロジェクトが優先されました。ほとんどの場合、私の友人グループと私はGTFOをプレイしなくなりました。いくつかの転職があり、それに伴う必要な準備と面接がありました。しかし、バグレポート、プルリクエスト、提案は引き続き寄せられました。長期間、私はそれらに対応していましたが、時間とエネルギーは不足していました。

複雑な要因(控えめに言っても)は、IL2CPPへの切り替えです。コードベースでの作業は、多くの場合、IDA/Ghidraの逆アセンブリを何時間も眺めることを意味するようになりました。大規模なシステム変更はほとんど不可能になりました。Modを改善するという壁ははるかに高くなりました。GTFO開発者がMonoアセンブリをModdingコミュニティに引き渡してくれるかもしれないというかすかな希望がありますが、それはおそらく彼らの法務部門にとって大きな問題の種でしょう。

最終的に、私はGTFO VR関連の作業を、R&R(休息とリフレッシュ)や、より興味深い、またはキャリアに役立つ他のサイドプロジェクトのために保留しました。私はこれについてまだ非常に葛藤しています。一方ではModを永遠にサポートしたいですが、他方では他の願望や目標があります。ここで理想的なのは、誰かに引き継ぐことですが、それは私がまだできていないことでもあり、誰かに仕事を押し付けるのは気が引けます。

The Numbers

驚くことではありませんが、ややニッチなゲームのModを作成することは、生計を立てるためのものではありません。しかし、寄付の量、特に総寄付額の約半分が単一の人物から寄付されたという事実に、私はまだ驚いています。エンジェル投資家に神のご加護を。

また、GTFOは比較的ニッチなゲームであることを考えると、プロジェクトに貢献してくれた人の数にも驚いています。それでは、まとめられた数字を以下に示します。

  • ダウンロード数: 約6K
  • 受け取ったコーヒー代: 約€1K
  • コミット数: 500件以上
  • 費やした時間(非常に大まかに): 800時間以上(他者の貢献は除く)
  • ユニークコントリビューター: 6名以上(一部PR保留中)
    • Nordskogg - パフォーマンス、ターミナル、サーマルレーザー、Pimaxバグ修正、UI、ボットコマンド、武器サイト、近接攻撃判定改善、適切なルームスケール移動など。
    • NicolasAubinet - BHaptics、Shockwave
    • Astienth - BHapticsバグ修正、タクティビザーサポート
    • MrKerag - 腕時計モデル
    • MRono - Readmeセットアップ書き直し/更新
    • Spartan(私です!) - その他すべて

Closing words

GTFO VRの開発は非常に楽しかったですし、作成できたことを嬉しく思います。今日に至るまで、GTFOは私のお気に入りのゲームであり、そのコミュニティに貢献できたことを嬉しく思います。驚くべきことに、VR Modの存在によってこのゲームを知った人も多くいました。

このプロジェクトで多くの経験を積むことができ、それは私のキャリアの初期に大いに役立ちました。履歴書の良いアピールポイントになり、面接での興味深い話題となりました。何よりも、プログラミングとゲーム開発が私にとって正しいキャリアであるという信念を強化してくれました。


まだの方は、ぜひMod(そしてGTFO自体)をチェックしてみてください!