ゆめくろで効率的な開発をするためのデバッグ機能紹介【CAGC2024】

本セッションでは、ジークレストで運用中のタイトル『夢職人と忘れじの黒い妖精』の開発時および運用シーンで使われている各種デバッグ機能の紹介となります。
デバッグ機能は、QAや機能実装担当者のことを考慮した作りにしないと業務を効率化することができず、サービスの品質を担保するためにも軽視できないものです。
特にインゲームとなるバトルやメインコンテンツのシナリオ部分は手厚く実装しており、どういう画面になっているかも事例を用いてご紹介します。
再現性を高めるために細かなところまで実装を行っているので是非参考にしていただければと思います。

https://cagc.cyberagent.co.jp/2024/session/index.html?id=i4PJmwez

©bilibili ©GCREST

Transcript

1. 木原 康剛 クライアントエンジニア 藤城 隆志 サーバーサイドエンジニア 角 威希 クライアントエンジニア ゆめくろで効率的な開発をするための デバッグ機能紹介 夢職人と忘れじの黒い妖精
2. ゆめくろとは 2
3. 夢職人と忘れじの黒い妖精 (ゆめくろ) 3 iOS、Androidで2022年2月18日リリース 夢世界シリーズの最新作で現在も運用中のタイトル
4. リリースしてから2年ほど運用してきて 4 この期間、さまざまな新規機能の追加や、機能改善を行ってきました。 もちろんそれに合わせてたくさんのデバッグもです。 今回はこのデバッグについて有用だったことや、細かいけれども しっかりやってよかったことなどを紹介していきます。 もし、参考になる機能があったら嬉しく思います。
5. クライアントデバッグ機能紹介 5
6. 6 ゆめくろのデバッグ機能について ゆめくろには主に以下の3種類のデバッグ機能が存在する 　⚫ 画面単位で簡単にデバッグ機能が実装できる汎用メニュー 　⚫ SRDebugger 　⚫ ブラウザで動作するサーバーデバッグ機能
7. 7 ゆめくろのデバッグ機能について ゆめくろには主に以下の3種類のデバッグ機能が存在する 　⚫ 画面単位で簡単にデバッグ機能が実装できる汎用メニュー 　⚫ SRDebugger 　⚫ ブラウザで動作するサーバーデバッグ機能
8. 8 ゆめくろにはエンジニアがデバッグ機能を 簡単に追加できる仕組みが存在する 画面単位で簡単にデバッグ機能が実装できる汎用メニュー
9. 9 画面単位で簡単にデバッグ機能が実装できる汎用メニュー 追加するためのコードを一部抜粋して紹介するとこんな感じ もちろん更に入れ子にしてページを作ったりもできます この部分に該当
10. 10 SRDebugger 各種ログの出力やアプリ全体に影響のあるデバッグ機能を実装
11. 11 ゆめくろではこれらの仕組みを活用して 様々な画面で デバッグ機能が実装されています
12. 12 その中でも今回はバトルとシナリオの デバッグ機能について紹介します
13. 13 バトルのデバッグ機能 クライアントデバッグ機能紹介
14. 14 キャラが攻撃やスキルをオートで発動する キャラアイコン右側のゲージが溜まると、プレイヤーは 必殺技を任意のタイミングで発動することができる ゆめくろのバトル
15. 15 ゆめくろのバトルには日々のデバッグや開発に 効果的なデバッグ機能が多数用意されている バトルのデバッグ機能
16. 16 　【代表的な機能】 　⚫ 各キャラのステータス表示と疑似ステータスアップ 　⚫ アクションの効果や範囲、対象や発生フレームを表示 　⚫ 特定のクエストに特定のキャラを選択してバトル 　⚫ 各キャラごとに特定の状態異常／スキル効果を付与 　⚫ バトルの完全停止／アクションのみ停止 　⚫ 敵味方含め全てのキャラを単体操作 　⚫ 好きなカットイン／スキル演出を再生 　⚫ 特定の敵を指定してバトル 　⚫ 特定のWAVEに移行 　⚫ まだまだあります バトルのデバッグ機能
17. 17 　【代表的な機能】 　⚫ 各キャラのステータス表示と疑似ステータスアップ 　⚫ アクションの効果や範囲、対象や発生フレームを表示 　⚫ 特定のクエストに特定のキャラを選択してバトル 　⚫ 各キャラごとに特定の状態異常／スキル効果を付与 　⚫ バトルの完全停止／アクションのみ停止 　⚫ 敵味方含め全てのキャラを単体操作 　⚫ 好きなカットイン／スキル演出を再生 　⚫ 特定の敵を指定してバトル 　⚫ 特定のWAVEに移行 　⚫ まだまだあります バトルのデバッグ機能
18. 18 更にSRDebuggerに詳細なバトルロジックなども出力 『ダメージ = 攻撃力(1234) - 防御力(567)』の様な計算式だったり、 実際の計算から回避やクリティカルが発生したかなど バトル中の詳細な情報がリアルタイムにログに出力されるので、 デバッガーでも実装と仕様書を照らし合わせた チェックが可能になっている 実際のログには各キャラの数値と一緒に計算 式が細かく出力されている バトルのデバッグ機能
19. 19 設定されている細かいパラメータやスキルを 実機で動かしながら確認できるので、 デバッグはもちろんバランス調整にも活用できる 特定のキャラを選んでバトルを行ったり、 一時停止しながらキャラごとの行動を選んで発動できるので 特定の組み合わせの検証や状況再現が容易 上記に加えて、SRDebuggerに詳細なログを出力することで 画面上の見え方だけでなくロジックレベルのデバッグも可能に バトルのデバッグ機能
20. クライアントデバッグ機能紹介 20 シナリオのデバッグ機能
21. 21 ゆめくろはかなりシナリオの多いタイトルのため、 日々シナリオのデバッグにも多くの時間が使われている シナリオのデバッグ機能
22. 22 　⚫ シナリオの数が膨大なので一つ一つストーリーを解放しながら 　　チェックしたり、ゲーム内から探すのが大変 サーバーデバッグ機能から特定のストーリーを 読める状態にすることもできるが、 そのストーリーを探したり解放したりで手間がかかる 　⚫ シナリオ内で問題を発見して報告する際に 　　簡潔に情報が伝えられなかったり、 　　該当箇所の修正／確認に時間がかかる 『◯◯のキャラのストーリーの第△話の 中盤ちょっと前にある「▢▢」の台詞の部分で...』のように 　　　共有する情報が多くなって報告にも確認にも時間がかかる シナリオのデバッグ機能
23. 23 シナリオの数が膨大 →全てのシナリオを一覧から選んで簡単に再生可能 　特定のシナリオを面倒な手順を踏まずすぐに確認できる シナリオのデバッグ機能
24. 24 シナリオ中の不具合の簡潔な報告や確認が難しい →シナリオ再生中にスクリプトに設定されているシナリオのIDと 　インデックス番号を確認することができる 　インデックス番号を指定して該当箇所にジャンプも可能 シナリオのデバッグ機能
25. 25 シナリオ中のインデックス番号はスクリプトで設定されている ものなので、スクリプターが報告や修正を行う際も 該当箇所がすぐ分かる 起票者以外が修正確認する際もいちいちシナリオを 頭から読んで該当箇所を探す必要がなく、チケットに記載されている インデックス番号を指定してジャンプするだけで簡単に確認が行える シナリオのデバッグ機能
26. 26 クライアントデバッグ機能のまとめ
27. 27 クライアントデバッグ機能のまとめ 　⚫ ゆめくろのクライアントには画面ごとに簡単に 　　デバッグ機能を追加できる仕組みが存在する 　⚫ 不具合が起きた際の再現／検証が誰でも容易に行えるため、 　　テスト実行準備の時短だけでなく、その先の修正確認まで 　　含めたテストプロセスの効率化が狙える作りになっている
28. サーバーデバッグ機能 28
29. 29 ゆめくろのデバッグ機能について ゆめくろには主に以下の3種類のデバッグ機能が存在する 　⚫ 画面単位で簡単にデバッグ機能が実装できる汎用メニュー 　⚫ SRDebugger 　⚫ ブラウザで動作するサーバーデバッグ機能
30. 30 ゆめくろのデバッグ機能について ゆめくろには主に以下の3種類のデバッグ機能が存在する 　⚫ 画面単位で簡単にデバッグ機能が実装できる汎用メニュー 　⚫ SRDebugger 　⚫ ブラウザで動作するサーバーデバッグ機能
31. サーバーデバッグ機能の基本思想 31 ゆめくろにおけるサーバーデバッグ機能は 状況再現を素早く行えること ことを意識し管理画面を構築しています。 データベース上のユーザーデータを直接書き換えるだけではなく、 想定されるテストケースに応じた環境を素早く再現することで、 デバッグにかかる時間/コストを抑える作りを意識しています。
32. サーバーデバッグ機能の一例 32 例)　キャラクターのレベルアップ時のデバッグを行いたい 管理画面からレベルを直接変更する機能はよくあると思われますが、 1つのレベルをあげるためには実際にプレイするには手間がかかり、 経験値を直接指定するには経験値テーブルの理解が必要です。 そこでレベル指定に加え 「経験値をギリギリまで貯める」という選択ができ、 １つのアクションでレベルアップを実現できる オプションを付随しています。
33. 33 例)　他のプレイヤーを簡単に作成したい ゆめくろには他のユーザーとフレンドになったり、スタジアムでユーザー同士で対戦する 機能を備えていますが、1件ずつユーザー作成することは現実的ではありません。 進行度やパラメータをランダムに一括作成することで、 ランキング機能のチェックなどにかける時間を軽減させることに成功しています。 サーバーデバッグ機能の一例
34. 34 ゆめくろにおけるサーバーデバッグ機能は 状況再現を素早く行えること デバッガーや開発メンバーなど 使う人を理解した設計・実装となっている サーバーデバッグ機能のまとめ
35. その他 シナリオ検索ツールについて 35
36. シナリオ内検索ツール 36 ゆめくろでは全てのストーリー内容を容易に検索できるツールが存在し ており、シナリオ職・デバッガーの方達に重宝されています ※一部モザイクをかけています
37. 　⚫ 基本機能 ◦ 話者、本文、タイトル内容を検索可能 ◦ 内部のマスターデータのIDで検索可能 ◦ メインシナリオ、キャラごとのシナリオ、イベントシナリオなどでフィルタ リング可能 ◦ ほぼ全てのキャラの話すセリフの検索が可能 ▪ ホーム画面やログイン時など各機能で話す内容も検索可能 　⚫ 細かな機能 ◦ 除外ワードの指定 ◦ 検索結果のCSVの吐き出し ◦ AND、OR検索 機能紹介
38. 38 このツールは毎日業務で常に使われるほどで、 　⚫ キャラごとの話し方のチェック 　⚫ 世界観に沿った表現のチェック 　⚫ いつ、誰がどういった内容を話していたかをすぐに検索 　⚫ そういえば、あの表現がどこかの話にあったかな...の解決 　⚫ あのセリフの前後の内容を把握したい 　⚫ 誤字脱字のチェック など、さまざまな用途で役に立っています シナリオ内検索ツールの需要
39. 39 実は量産を進めていた、リリースする数ヶ月前からシナリオチームから 業務効率改善のため検索できるツールが欲しいという要望が上がっていました。 ゆめくろでは1話ごとのデータは最初はWord形式のファイルになっており、そこから 変換をかけてスクリプトファイルを生成し、Unityで再生する仕組みになっています。 さまざまなストーリーがある中で、以前の内容を確認するために何十もの wordファイルを開いて検索することが非常に手間がかかっていました (メインストーリーが1章約20話ほどで、2023年12月時点で8章まであるので 160ファイル。また、イベント用のストーリーも存在するのでさらに物量はあります) 開発した経緯
40. 40 物語の整合性や、世界観の統一、各々のキャラの個性のブレ防止など、 品質の担保と物量が要求されている中でより効率的によいストーリーを ユーザーにお届けするには必須ということで、開発に着手しました。 あのストーリーの内容確認したいけ ど、どこだっけ？ ▪▪▪ってキャラ、 こういうこと言うだっけ？ ▲▲▲のキャラはあのとき どういう反応してたっけ？ 開発した経緯
41. 前提として要求されることとして 　⚫ 誰でも容易に検索ができる 　⚫ NDAを結んでいるパートナー会社にも容易に共有が可能 　⚫ 内部のID(マスターデータ)での索引、IDの確認ができる 　⚫ 誰がいつ、どのストーリーで話しているかが分かる 　⚫ 運用が楽 このあたりをクリアする必要がありました 仕組みと流れ
42. 　⚫誰でも容易に検索ができる 　⚫NDAを結んでいるパートナー会社にも容易に共有が可能 　⚫内部のID(マスターデータ)での索引、IDの確認ができる 　⚫誰がいつ、どのストーリーで話しているかが分かる 　⚫運用が楽 解決の方針として、 　⚫ブラウザから使え、社内アクセス・VPN接続でアクセスできる 　⚫すでにストーリー再生で使っているスクリプトファイルからデータを吐き出す 　⚫吐き出したデータはブラウザからもDLできるようにする 　⚫アプリ開発のフローの延長、もしくは途中に組み込む というアプローチでやってみました 仕組みと流れ
43. wordの中身のストーリーテキストをUnityのEditor拡張した ツールで解析し、再生可能なテキスト(スクリプトファイル)に変換 さらにもう一度Unityで中身をテキスト検索用にcsv形式に変換し、 amazon S3へデプロイ。変換時、マスターデータの参照も可能なので、必要に応じて追加 aws s3 Icons by icons8.com 仕組みと流れ
44. wordからスクリプトファイルに変換するまでは通常の開発フロー csv変換とデプロイの 部分を追加で開発 aws s3 Icons by icons8.com 仕組みと流れ
45. シナリオの方からは、 これがないと業務が回らないとまで言ってくれており、 やって良かったと実感しています また、実装フローの延長にしていることから、 検索結果に表示されるモノが本番に限りなく近く、 テキストの中の誤字脱字などのデバッグにも使え、 いい副作用もありました 作ってみて
46. 46 ご清聴ありがとうございました