はじめに
このページは、クラウドゲーミングで TapFun にゲームを提供するパブリッシャー・開発者向けの接続仕様書です。Windows 向け exe をクラウド上の Windows サーバーで実行し、プレイヤーのブラウザへストリーミング配信します。主にプレイ時間課金で、アセットの追加ダウンロードが無いタイトルに適しています。
ブラウザで動作するゲームを提供する場合は Web App 向けの仕様書 を参照してください。
テストプレイまで
- 実行可能な exe が格納された zip ファイルを提出いただきます。
- テスト環境でのプレイ用のリンクをお送りしますので、手触りなどをお試しください。
- 無料プレイ時間の終了後もテストされる場合は、エナジーやタイトルパスの購入が必要です。決済手段には「AmazonPay」を選択してください(テスト環境での決済方法)。
テストプレイの結果、大きな問題が無ければ以下に進みます。
コミュニケーション手段の確立
- 基本はメールで行います。
- 必要に応じて、両社が参加する Slack コネクトチャネルを TapFun 側で発行します。
- Slack コネクトチャネルへの参加ができない場合は、御社のコミュニケーションツールへ参加させていただきます。
Publisher Console へのログイン
exe のアップデートや各種設定は、テスト環境の Publisher Console(https://<TEST_HOST>/publisher)で行えます。担当者がログイン権限を付与しますので、ログインされる方のメールアドレスをお伝えください。
リリース内容の調整
動作上の問題の解決の目処が立ちましたら、リリース時期や提供価格を調整します。
開発中の問題発生時の対応
「操作が反応しない」「意図しない動作がある」といった問題が発生した際は、以下を添えてコミュニケーションチャネルでお知らせください。
- 問題が再現したアプリ名(テスト環境上に同一ゲームが複数ある場合は、アプリ ID など識別できる情報)
- 問題が発生したテスト環境の TapFun ユーザーアカウント(ゲスト状態でのみ発生する場合を除く)
- 発生状況が把握できるスクリーンショット
- スクリーンショットで不足する場合は、再現手順全体の録画
- 問題の再現手順
問題が正常な仕様に起因する場合、双方協議のうえで機能追加や変更を行う場合があります。
TapFun のプラットフォーム側(起動、セーブデータの保存復元、ストリーミング)の問題と判断した場合は、TapFun が対応します。クラウド上の Windows(Tencent CAR)での exe の実行上の問題の場合は、TapFun が行う作業とサポート範囲のとおり、exe の改修や回避策の作成・検証をパブリッシャー様に行っていただきます。
提出する exe の要件
- ゲームエンジンは問いません。Windows で起動できる exe であれば対象です。実際に動くかどうかは、非公開のテスト環境で確認します(13 GB のタイトルでも動作実績があります)。
- インストール工程はありません。 zip を展開して exe を直接起動します。同梱のランタイムのインストーラー(Visual C++ 再頒布可能パッケージ、OpenAL など)は実行されないため、必要な DLL は exe と同じフォルダに置いて同梱してください。
- exe からファイルを絶対パスで参照しないでください。ローカル PC とクラウド上ではパスが異なります。相対パスを使ってください。
- Steam などのクライアントが無くても起動する必要があります。 Steamworks を使っている場合は、外したビルドにするか、初期化に失敗してもそのまま続行するようにしてください(Steam が無い環境では、初期化が失敗したり起動時に止まったりしがちです)。そのほかの SDK・DRM・ランチャーへの対応は不要です。
- 検証には exe そのものが必要です。Steam キーでの検証はできません。
- zip のファイル名は、タイトルが分かる名前にしてください(例:
MyGame_Demo.zip)。 - zip の直下にはフォルダを 1 つだけ置き、その中に exe とファイル一式を入れてください。 フォルダの中身ではなく、フォルダごと zip にします。readme などのファイルも、直下には置かずフォルダの中に入れてください(例:
MyGame/MyGame.exeは可。MyGame.exeとMyGame_Data/が zip の直下に並ぶ形や、MyGame/とREADME.txtが直下に並ぶ形は不可)。 - zip 内のフォルダ名と exe のファイル名は固定してください。 ビルドを更新するときも、最初に提出したときと同じフォルダ名・ファイル名にしてください。フォルダ名や exe 名に、ビルド番号・日付・バージョンを含めないでください(例:
MyGame/MyGame.exeは可。260819_1353/MyGame.exeは避けてください)。zip のファイル名は変えてもかまいません。- 起動する exe とセーブデータディレクトリは、このフォルダ名を含むパスで TapFun が設定しています。名前が変わると、アップロードできないか、アップロードできても起動しなくなります。
- zip 内のフォルダ名と exe のファイル名には、半角英数字と記号だけを使ってください。 日本語などのマルチバイト文字を含む名前では、クラウド上で正しく動作しません(例:
MyGame/MyGame.exeは可。マイゲーム/マイゲーム.exeは不可)。
exe の調整作業
リリースに向けて、exe の調整を行っていただきます。
- セーブデータのディレクトリは 保存できるパス のいずれかである必要があります。該当していれば、そのディレクトリを TapFun までお伝えください。該当しない場合は exe 側の変更が必要です。レジストリは使用できません。
- Unity の
PlayerPrefsは、Windows では既定でレジストリ(HKEY_CURRENT_USER\Software\<会社名>\<製品名>)に保存されるため、そのままでは保存されません。ファイルに保存するよう変更してください。
- Unity の
- ウィンドウで起動してしまう場合は、フルスクリーンで起動するようにしてください。
- 起動オプションでフルスクリーン起動ができる場合は、Publisher Console の「exe 起動パラメータ」で指定してください(基本情報)。
- ゲーム内の設定でフルスクリーンの切り替えが可能な場合は、切り替えできなくすることが望ましいです。
- ゲーム内でユーザーが任意にゲームを終了(= exe プロセスの終了)できる場合は、できないようにすることが望ましいです。
- ゲーム内の外部リンク(ストアページやクレジットの URL など)は、プレイヤーのブラウザではなくクラウド上で開こうとするため動作しません。外部の URL を開くときは openUrl を使ってください。
- 「セーブフォルダを開く」のように、Windows の別アプリやフォルダを開く機能は動作しません。表示しないようにしてください。
- 本番環境用のビルドでは、画面上のデバッグ表示を消してください。
- ゲーム側でマウスカーソルをキャプチャする場合(FPS など)は、メニューの表示を Esc 以外のキーにすることを推奨します(マウスカーソルのキャプチャ)。
テストからリリースまで
- テスト環境で確認する: テスト環境では、メールアドレスの確認の後に、ご自身で作成した TapFun アカウントでログインします(プレイにはログインが必要です)。Publisher Console のバージョン一覧の「このバージョンで起動」からも起動できます。
- 本番環境で最終確認する: 本番の Publisher Console の権限は別途付与します。リリース前は非公開の状態で、本番でのテストプレイの方法で確認してください。
- 公開する: 公開作業は TapFun が行います。公開時刻は 10:00〜17:00(JST)の間で調整できます。
- exe を受け取ってから公開までの目安は約 1 か月です(クラウド環境の準備と、クラウド版での確認・調整を含みます)。
- Publisher Console には権限の区別がありません。ログインできる方は全員が同じ操作をできます。ログインできる方を追加する場合は、メールアドレスを TapFun にお知らせください。
デバッグ
ゲーム実行ページの URL に次のパラメータを付けると、クライアント API のやり取りを確認できます。
| パラメータ | 内容 |
|---|---|
?debugLog=1 |
ゲーム画面の上にログ表示領域を出します。TapFun が受け取ったクライアント API のリクエスト(consoleLog を含む)が表示されます。2 行目にはプレイ中のプレイヤーの TapFun ユーザー ID が表示されます。 |
?verbose=1 |
ブラウザのデベロッパーツールのコンソールに詳細なログを出します。consoleLog の data もここに出力されます。 |
ログの取得
クラウド上の exe が出力するログを取得するには、ログファイルをセーブデータディレクトリの中に書き出してください。Publisher Console の「バイナリ」タブの「ツール → セーブデータダウンロード」で TapFun ユーザー ID を入力すると、セーブデータと一緒にダウンロードできます。
- 入力する TapFun ユーザー ID は、Publisher Console で「ログ表示」にチェックを入れて「アプリページ」を開き、ゲームを起動すると、画面上のログの 2 行目に
TapFunUserId: <ID>の形で表示されます(URL に?debugLog=1を付けて起動しても同じです)。 - ダウンロードは、ゲーム終了から 1 時間以上空けて行ってください。
- セーブデータディレクトリへのログの出力は、開発中のビルドだけにしてください。
- Unity の
Player.logはApplication.persistentDataPath(C:\Users\%UserName%\AppData\LocalLow\<会社名>\<製品名>)に出力されます。セーブデータディレクトリがこのフォルダであれば、本番用のビルドでもそのまま含まれます。
- Unity の
- 例外的に本番用のビルドでも出力する場合は、古いログを削除する、上書きする、サイズの上限を設けるなどして、ログが大きくならないようにしてください。ログもセーブデータとして保存・復元されるため、セーブデータの合計が 100 MB を超えると、セーブデータの巻き戻りなどの不具合が起きる場合があります。
プレイヤーからの問い合わせ
- TapFun のプラットフォームに関する問い合わせ(ログイン、決済、起動できないなど)は TapFun が対応します。必要に応じて、プレイヤー ID を添えてパブリッシャー様に共有します。
- ゲームの内容に関する問い合わせは、パブリッシャー様の窓口へご案内します。問い合わせ窓口(フォームなど)をご用意いただき、TapFun にお知らせください。
TapFun が行う作業とサポート範囲
TapFun が行う作業と、パブリッシャー様に行っていただく作業の分担です。ゲームの内容の確認と exe の改修は、パブリッシャー様にお願いしています。
TapFun が行う作業
次の作業は Publisher Console では行えません。必要な場合は TapFun までご依頼ください。
- 起動する exe の設定・変更。zip 内のフォルダ名と exe のファイル名は固定とし、変更は必要な場合だけご依頼ください(提出する exe の要件)。
- セーブデータディレクトリの設定・変更。セーブデータディレクトリも固定とし、変更は必要な場合だけご依頼ください。
- 解像度とサーバー性能の変更
- Steam AppID の変更(Steam)
- Publisher Console にログインできる方の追加
- 本番環境での公開作業と、公開日時の調整
- Publisher Console からアップロードできない場合の、ビルドの受け取り
- TapFun のプラットフォーム側(起動、セーブデータの保存復元、ストリーミング)の不具合の調査
初回の登録時の確認: 最初のビルドを登録するときに限り、TapFun が次のことを簡易的に確認します。ゲームの内容の確認ではありません。ビルドの更新時には行いません。
- 起動: AI を使って、ゲームが起動することと、AI で操作できる範囲でゲームの入口(タイトル画面からプレイの開始前後)まで進めることを確認します。ゲームによっては AI で操作できず、入口まで進めない場合もあります。
- セーブデータディレクトリ: AI を使って、お知らせいただいたディレクトリか、ゲームが書き込む場所からセーブデータディレクトリを特定してテスト環境に設定し、セーブデータがクラウドに保存されることを確認します。ゲーム内で正しく読み込まれるか(進行や設定が引き継がれるか)は確認しません。セーブデータの引き継ぎの確認の方法でご確認ください。保存できる場所に無い場合(レジストリに保存している場合など)は、その旨をお知らせします。
Publisher Console で行っていただく作業
次の作業は、Publisher Console でパブリッシャー様ご自身が行えます。TapFun へのご依頼は不要です。
- 「exe 起動パラメータ」の設定(フルスクリーンで起動するオプションや、TapFun と API 連携するための起動パラメータなど。基本情報)
- 「ゲームパッド対応」「ゲームパッド入力方式」「バーチャルパッドデフォルト」「ポインターデバイス対応」「マウスカーソル常時表示」の切り替え(基本情報)
- 紹介ページの文章と画像の編集(詳細情報)
- Steam ストアへのリンクに付ける「追跡用パラメータ (utm)」の設定(Steam)
- バイナリのアップロード、リリース、以前のバージョンへの切り戻し(バイナリ更新方法)
- セーブデータとログのダウンロード(ログの取得)
- テスト環境でテストプレイする方の追加(「テストプレイヤー」。テスト環境に入れる方)
- テスト環境でのエナジー・タイトルパスの購入(テスト環境での決済方法)。TapFun からテスト用のアカウントにエナジーを付与することはありません。
サポート範囲外
次のことは TapFun では行いません。
- ゲームを起動・プレイして確かめること全般(翻訳の文言、ゲームの進行、ステージごとの動作、操作感など)。テスト環境でご確認ください。
- ゲーム内でセーブデータが正しく読み込まれるか(進行や設定が引き継がれるか)の確認。セーブデータの引き継ぎの確認の方法でご確認ください。
- exe の改修や、回避策の作成・検証(Steamworks を外す、セーブ先をファイルに変えるなど)。回避策を入れたビルドは、テスト環境にアップロードしてご確認ください。起動する exe を変える必要があれば TapFun が設定します。
- ゲームエンジンやツールに固有の挙動の調査
- ゲーム自体の不具合の原因調査。ログの取得の方法でログを取得してご確認ください。
- セキュリティ体制についての個別の質問への回答(セキュリティ)
セキュリティ
- クラウドゲーミングの基盤には Tencent CAR を使用しています(動作概要)。
- TapFun の Web サービスは AWS 上で運用しています。
- 紹介ページの画像などの保存と配信には Cloudflare を使用しています。
- ゲームを実行するサーバーは日本国内にあります。
- セーブデータは TapFun アカウントごとに保存します(ユーザーデータの保存復元)。
- 秘密保持契約(NDA)の締結をご希望の場合は、ご相談ください。
上記以外のセキュリティ体制の具体的な事項(ビルドの暗号化や、データの抽出を防ぐ仕組みなど)には、原則として個別には回答していません。
FAQ
Q. 翻訳の文言やゲームの進行を確認してもらえますか?
A. サポート範囲外です(サポート範囲外)。テスト環境でご確認ください。
Q. exe のファイル名や zip 内のフォルダ名を変えたビルドをアップロードしたら、起動しなくなりました。
A. 起動する exe とセーブデータディレクトリは、zip 内のフォルダ名を含むパスで TapFun が設定しています。フォルダ名と exe のファイル名は変えずにアップロードしてください(提出する exe の要件)。どうしても変える必要がある場合は、アップロードの前に TapFun までご相談ください。
Q. すぐに起動し直すとセーブデータが引き継がれていたのに、時間を空けて起動すると引き継がれていません。
A. ゲーム終了から 1 時間以内に起動し直すと、前回のプレイの環境がそのまま使われるため、セーブデータディレクトリが正しくなくても引き継がれたように見えることがあります。セーブデータディレクトリが正しくない可能性があるので、TapFun までご連絡ください。引き継ぎの確認は、1 時間以上空けて行ってください(セーブデータの引き継ぎの確認)。
Q. 起動のたびにシェーダーのコンパイルが行われます。コンパイル結果を保存して、次回から省けませんか?
A. できません。クラウド上の PC 環境は固定されておらず、セッションごとに同じ環境で起動するとは限らないため、コンパイル結果をセーブデータとして保存しても再利用できる保証がありません(シェーダーのコンパイル結果)。
Q. フルスクリーンで起動するように設定してもらえますか?
A. 起動オプションでフルスクリーンにできる場合は、Publisher Console の「exe 起動パラメータ」でご自身で設定できます(基本情報)。
Q. テスト用のアカウントにエナジーを付与してもらえますか?
A. 付与していません。テスト環境での決済方法で購入してください。
Q. 回避策を入れたビルド(別の起動用 exe など)を試してもらえますか?
A. テスト環境にアップロードして、ご自身でご確認ください。起動する exe を変える必要がある場合は、TapFun までお知らせください。
Q. ゲームが落ちる原因を調べてもらえますか?
A. ゲーム自体の不具合の調査はサポート範囲外です。ログの取得の方法でログを取得してご確認ください。
Q. ビルドの暗号化など、セキュリティ体制について教えてください。
A. お答えできる内容はセキュリティのとおりです。それ以外の事項には、原則として個別には回答していません。
Q. ゲーム画面をクリックするまで音が出ません。
A. ブラウザの制約による挙動(仕様)です。
Q. ゲームパッドが反応しません。
A. ゲーム画面をクリックした後に反応します。状況によってはクリックしなくても反応しますが、基本として最初にゲーム画面のクリックが必要です。
Q. iPhone でほかのアプリから戻ると、音が出なくなります。
A. 毎回ではありませんが、すべてのタイトルで起きることがあります。
Q. ゲーム内で、プレイヤーのウォレット残高や、購入時に足りない金額を取得できますか?
A. できません。TapFun ウォレットの残高と購入時の不足金額は、クライアント API・Web API・起動パラメータのどれからも取得できません。
Q. ゲーム内で、プレイヤーの言語や国を知ることはできますか?
A. できます。起動パラメータの {lang}(プレイヤーの言語)と {country}(接続元の国)で exe に渡せます。どちらもデフォルト起動パラメータには含まれないので、使う場合は「exe 起動パラメータ」に書き足してください(起動パラメータ)。ゲームの実行中は、getPlayerEnvironment の language と country でも取得できます。
環境
ホスト名
| TapFun 環境 | ホスト名 | Web UI の認証 |
|---|---|---|
| テスト | 担当者にお問い合わせください(本ドキュメントでは <TEST_HOST> と表記) |
紹介ページやプレイ画面: メールアドレスの確認 / Publisher Console: Basic 認証(ID / パスワードは担当者にお問い合わせください) |
| 本番 | https://tapfun.co.jp |
なし |
テスト環境のホスト名と、Publisher Console の Basic 認証の ID / パスワードは秘匿情報です。このドキュメントには記載していませんので、TapFun の担当者にお問い合わせください。コード例などの <TEST_HOST> はテスト環境のホスト名に置き換えてください。社外や公開の場(公開リポジトリ、公開チャンネルなど)には記載しないでください。
テスト環境に入れる方
テスト環境で紹介ページやプレイ画面を開くと、メールアドレスの確認画面が表示されます。入力したメールアドレスに届く確認コードを入力すると、ページが表示されます。ゲームをプレイするには、その後に TapFun アカウントでのログインが必要です。
メールアドレスの確認を通れるのは、次の方です。
- 御社の Publisher Console にログインできる方
- Publisher Console の「テストプレイヤー」に登録したメールアドレスの方。Publisher Console にログインしない方(QA 会社の方など)は、こちらに登録してください
- 1 行に 1 件書きます。
@example.comのように @ から書くと、そのドメインのメールアドレス全部が対象になります - 保存した直後から入れます
- テスト環境だけの仕組みです。本番環境の Publisher Console には「テストプレイヤー」はありません
- 1 行に 1 件書きます。
テスト環境では、御社のアプリだけが表示されます。
テスト環境での決済方法
テスト環境でエナジーやタイトルパスを購入する際は、次のいずれかを使用してください。
- AmazonPay: 選択すると「マルチペイメントサービス テスト環境」に遷移します。「決済する」を選択すると決済できます。
- テスト用クレジットカード: 番号
4111111111111111、有効期限は未来の任意の年月、セキュリティコードは任意の 3 桁の数字。
本番でのテストプレイ
リリース前のアプリにアクセスするには、Publisher Console の基本情報でメンテナンスモードを有効にし、「メンテナンス例外メールアドレス」にテストプレイするユーザーのメールアドレスを入力してください。
本番で購入を伴うテストを行う場合は、TapFun 側でアプリごとにテストプレイ用アカウントを登録します。このアカウントには対象アプリでのみ使える TapFun クレジットが付与されます。テストプレイ用アカウントの購入は即座に取り消され、売上から相殺されます。
Publisher Console
基本情報
| 項目 | 説明 |
|---|---|
| アプリ ID | アプリの内部 ID です。 |
| name | 内部名です。 |
| apiKey | Web API を呼ぶ際の API キーです。 |
| Bearer token | Web API を呼ぶ際の Authorization: Bearer の値です(アプリID_apiKey の形式)。 |
| メンテナンスモード | 有効にすると、新しくゲームを起動できなくなり、プレイ中のゲームも終了します(メンテナンスモードの動作)。 |
| メンテナンス例外メールアドレス | メンテナンス中でもプレイできるユーザーのメールアドレスです(改行区切り)。リリース前の非公開アプリでも、メンテナンスモードを有効にするとこのアドレスのアカウントからアクセスできます。 |
| folder | アップロードするバイナリの zip 内のフォルダ名です。 |
| exe | zip 内で実行する exe のファイル名です。 |
| exe 起動パラメータ | コマンドライン起動オプションです。例: --debug=on --verbose。{userId} などのプレースホルダは、起動時にプレイヤーごとの値に置き換わります。「デフォルト起動パラメータを設定」ボタンで、TapFun と API 連携するための標準の値に置き換えられます(起動パラメータ)。255 文字まで入力できます。 |
| セーブデータディレクトリ | セーブデータのディレクトリです。中のファイルはすべてセーブデータとして保存・復元されるため、セーブデータとログ以外のファイルを入れないでください。変更はご相談ください(ユーザーデータの保存復元)。 |
| ゲームパッド対応 | スマートフォン・タブレットのバーチャルパッドやタップで遊べるタイトルで有効にします。無効にすると、スマートフォン・タブレットの紹介ページにプレイボタンを表示しません(プレイできる端末)。 |
| ゲームパッド入力方式 | ゲームがゲームパッドを読み取る方式に合わせて、「XInput」か「WGI」を選びます(ゲームパッド)。既定は「XInput」です。 |
| バーチャルパッドデフォルト | スマートフォン・タブレットで、画面上のバーチャルパッドを最初から表示するかどうかです。タップ操作だけで遊べるタイトルは無効にしてください。 |
| ポインターデバイス対応 | マウスで操作できるタイトルで有効にします。 |
| マウスカーソル常時表示 | 有効にすると、マウスカーソルを常に表示します。FPS などでゲーム側がマウスカーソルをキャプチャして視点を操作させる場合は無効にしてください(マウスカーソルのキャプチャ)。 |
メンテナンスモードの動作
「メンテナンスモード 有効」にして保存すると、次のようになります。
- 新しい起動: プレイ画面に「現在「〇〇」はメンテナンス中です。少しお時間をおいてから、再度お試しください。」と表示され、ゲームは起動しません。プレイ画面からの再起動もできません。
- プレイ中のゲーム: 予告なく終了し、同じメッセージを表示します。セーブデータディレクトリに書き込まれている内容は保存されますが、ゲーム内でまだセーブしていない進行は失われます。
- 保存時の確認: 無効から有効に変えて保存するときは、「メンテナンスモードを有効にすると、現在実行中のセッションの切断処理が行われます。有効にしてもよろしいですか?」と確認します。キャンセルすると保存しません。
- 例外: 「メンテナンス例外メールアドレス」のアカウントは、メンテナンス中も起動でき、プレイ中のゲームも終了しません。
- 紹介ページ: 通常どおり表示され、メンテナンス中の表示は出ません。
無効にして保存すると、プレイヤーはプレイ画面を開き直して起動できます。
詳細情報(紹介ページ)
「詳細情報」タブでは、TapFun 上のゲーム紹介ページに表示する内容を編集します。
| 項目 | 説明 |
|---|---|
| アイコン画像 | ゲームのアイコンです。推奨解像度は 512x512(正方形)です。 |
| 2:1 画像 | 一覧や紹介ページで使う横長の画像です。推奨解像度は 1920x960 です。 |
| 操作説明画像 | プレイ中に TapFun の画面から開ける操作説明の画像です(任意)。 |
| スクリーンショット画像 | 紹介ページに表示するスクリーンショットです。 |
| ゲームタイトル | 紹介ページなどに表示するゲームの名前です。 |
| 開発元 / パブリッシャー | 紹介ページに表示する開発元とパブリッシャーの名前です。 |
| ゲーム詳細紹介文 | 紹介ページの本文です。Markdown 形式で書けます。 |
| サードパーティー EULA | ゲームに含まれるサードパーティーの使用許諾など、紹介ページに表示する規約の文面です。 |
操作説明画像とスクリーンショット画像は、ドラッグで並べ替えられます。削除するときは、画像をクリックして削除マークを付けたあと、「追加アップロード & 順序を保存」を押すと反映されます。
販売情報
「販売情報」は表示のみです。DLC 以外の変更は TapFun にご相談ください。
| 項目 | 説明 |
|---|---|
| お試し分数 | 1 回あたりの無料プレイ時間です。1 回分は 12 時間後に回復します。 |
| パス未所有時 1 エナジープレイ分数 | タイトル利用パスを持っていないプレイヤーが、エナジー 1 つでプレイできる時間です。 |
| タイトル利用パス価格 | タイトル利用パスの価格です。 |
| タイトル利用パス購入後無料時間 | タイトル利用パスの購入後に、無料でプレイできる時間です。 |
| タイトルパス所有時 1 エナジープレイ分数 | タイトル利用パスを持っているプレイヤーが、エナジー 1 つでプレイできる時間です。 |
| DLC (YAML) | DLC の定義です。 |
DLC
- Publisher Console 上で、TapFun のウェブページで販売する DLC を管理します。
- タイトル利用パス販売時には、DLC は「タイトル利用パス同梱版」および「通常版購入後の単体 DLC」として販売されます。
- DLC の内容は YAML 形式で記述します。複数登録できます(数の制限はありませんが、複数登録する際は事前にご相談ください)。
- 購入済みの DLC がある場合、「exe 起動パラメータ」に
{dlcs}を書いておくと、exe 起動時に DLC の識別子をカンマ区切りで渡します。デフォルト起動パラメータでは--dlcs 識別子,識別子,...になります(起動パラメータ)。
- name: Digital Deluxe Upgrade
code: digital_deluxe_upgrade
price: 3270
bundlePrice: 2000
archived: false
description: |
通常版を Digital Deluxe Upgrade 版にアップグレードします。
・コラボ衣装(6 着)
・撮影機能「フォトフレーム」(6 種)| キー | 型 | 説明 |
|---|---|---|
name |
string | 商品名です。 |
code |
string | DLC の識別子です。{dlcs} に入る値です。 |
price |
number | DLC 単体の金額です。 |
bundlePrice |
number | タイトルパス同梱版として販売する際の金額です。タイトルパス価格+この金額が同梱版の価格になります。 |
archived |
bool | true にすると追加コンテンツ(および同梱版)として非表示になります。 |
description |
string | 通常版購入者向けの説明文です。改行が反映されます。 |
Steam
Steam のストアページがあるタイトルでは、PC 幅のプレイ画面に Steam ストアの購入ウィジェットを表示します。
| 項目 | 説明 |
|---|---|
| Steam AppID | 表示する Steam のアプリ ID です。変更は TapFun にご相談ください。 |
| 追跡用パラメータ (utm) | Steam ストアへのリンクに付ける utm_source / utm_medium / utm_campaign / utm_term / utm_content です(各 100 文字まで)。Steam が引き継ぐのはこの 5 種類だけです。 |
アクセス解析(Google Analytics)
Publisher Console の「アクセス解析」で「Google Analytics 測定 ID」を設定すると、TapFun 上の紹介ページとプレイ画面の閲覧と購入を、御社の Google アナリティクス 4(GA4)のプロパティに送ります。空欄の場合は何も送りません。
設定方法
- GA4 の管理画面で、ウェブのデータストリームに表示される「測定 ID」(
G-で始まる ID)を確認します。数字だけの「プロパティ ID」とは別のものです。 - Publisher Console の「アクセス解析」の「Google Analytics 測定 ID」に入力し、「保存」を押します。
- 前後の空白は取り除き、英字は大文字にそろえて保存します。
G-で始まらない値は保存できません。
- GA4 のデータストリームの拡張計測で、「ブラウザの履歴イベントに基づくページの変更」をオフにします。オンのままだと、プレイ画面の表示が二重に数えられます。
送信するページ
- 紹介ページ(
https://tapfun.co.jp/p/<アプリ>) - プレイ画面(
https://tapfun.co.jp/p/<アプリ>/play)。新しいタブで開くプレイ画面も含みます。
TapFun のほかのページ(トップ、アカウント、チャージなど)からは送りません。この 2 画面から別のページへ移ると、拡張計測のイベント(スクロールなど)も送らなくなります。
送信するイベント
| イベント | 送るタイミング |
|---|---|
page_view |
紹介ページ・プレイ画面を開いたとき。それぞれ 1 回送ります。 |
purchase |
購入が完了したとき(対象の購入)。 |
すべてのイベントに次の値を付けます。
| パラメータ | 内容 |
|---|---|
user_id |
TapFun ユーザー ID です。 |
page_location |
ページの URL です。クエリ文字列は utm_ で始まるものだけを残し、ほかは取り除きます。 |
page_view には、ページのタイトルを page_title として付けます。
purchase には、次の値を付けます。
| パラメータ | 内容 |
|---|---|
transaction_id |
購入ごとのユニークキーです。 |
value |
購入金額(円)です。 |
currency |
JPY(固定)です。 |
items |
購入した商品 1 件です。item_id・item_name・item_category・price(value と同じ金額)・quantity(常に 1)を持ちます。 |
ログイン状態(login_status)
プレイヤーがログインしているかどうかを、ユーザー プロパティ login_status として送ります。
| 値 | 意味 |
|---|---|
logged_in |
TapFun にログインしているプレイヤー |
guest |
ゲスト(ログインしていないプレイヤー) |
- ページを開いたときのログイン状態を、最初の
page_viewから付けます。 - 画面の中でゲストがログインすると、それ以降は
logged_inになります。ログアウトするとguestに戻ります。
login_status を GA4 のレポートで使うには、ユーザー スコープのカスタム ディメンションとして登録してください。登録する前に送られたデータはレポートでは使えないので、測定 ID を設定したら続けて登録することをおすすめします。
送信しないもの
- テストプレイ用アカウントの閲覧と購入
- エナジーの購入
- 購入の取り消し・返金。正確な売上は Publisher Console の「月別売上」で確認してください。
TapFun の決済画面や Google ログインから同じタブで戻ってきたときは、その外部サイトを参照元として扱いません。
対象の購入
タイトル利用パスと DLC の購入を送ります。items の値は次のとおりです。
| 購入 | item_id |
item_name |
item_category |
|---|---|---|---|
| タイトル利用パス | pass |
基本情報の name(内部名)の後ろに「 タイトルパス」を付けたもの | pass |
| DLC | DLC の code |
DLC の name |
dlc |
DLC 同梱のタイトル利用パスは、タイトル利用パス 1 件の購入として送ります。value はタイトル利用パス価格と DLC の bundlePrice の合計です。
バイナリ更新方法
- 使用中のバージョンを含めて 5 つまでアップロードできます。使用中以外のバージョンは削除できます。
- アップロード後、バージョン一覧から「First Release」を選択してリリースします(リリース時のセッションの扱い)。
- アップロード済みのバージョンを選んでゲームを起動できます。
- 新しくアップロードしたバージョンを一度リリースするまで、追加のバージョンはアップロードできません。
- テスト環境・本番環境ともに同じ操作で更新できます。
- 「First Release」にしたバージョンが、プレイヤーが起動するバージョンになります。以前のバージョンを「First Release」にすれば、前のビルドに戻せます。
- アップロード後、使えるようになるまでに処理時間がかかります。目安は 1〜5 GB で 30 分以内です。複数のバージョンを同時にアップロードしないでください。
- アップロード後に状態が「失敗」になる場合があります。削除して再試行しても成功しない場合は TapFun までご連絡ください。
リリース時のセッションの扱い
| 状況 | 挙動 |
|---|---|
| アップロード中・アップロード直後 | プレイヤーには影響しません。プレイヤーが起動するのは「First Release」にしたバージョンだけです。 |
| 「First Release」を押したとき | 新しいバージョンが使われるのは、リリース後に新しく開始したセッションからです。TapFun 側から、実行中のセッションを終了させることはありません。 |
| 実行中のセッション | リリース前に開始したセッションは、そのまま続きます。プレイヤーが新しいバージョンを遊ぶには、ゲームを終了して起動し直す必要があります。すべてのプレイヤーを新しいバージョンにしたいときは、メンテナンスモードでプレイ中のゲームを終了できます。 |
| セーブデータ | TapFun アカウントごとに保持され、バージョンを切り替えても引き継がれます。新旧のバージョンで同じセーブデータを読めるようにしてください。 |
| 前のバージョンに戻す | 戻したいバージョンの「Revert Version」を押します。挙動は「First Release」と同じで、戻したあとに開始したセッションから適用されます。 |
| リリース前に動作を確認する | バージョン一覧の「このバージョンで起動」で、リリースしていないバージョンも新しいセッションで起動できます(ほかのプレイヤーには影響しません)。 |
「バイナリ」タブの画面:
- zip の構造: zip の中に「folder」のフォルダがあり、その中に「exe」があるようにします(
<folder>/<exe>)。ビルドを更新するときも、同じ folder と exe の zip をアップロードしてください。異なると「zip 内に<folder>/<exe>が含まれていません」と表示され、アップロードできません。zip の直下に「folder」のフォルダ以外のもの(readme などのファイルや別のフォルダ)があるときも、「zip の直下に<folder>/以外のものがあります」と表示され、アップロードできません(提出する exe の要件)。 - アップロードできない場合の表示: 「失敗したバージョンを削除してください」「不要なバージョンを削除してください」(5 つに達している)「First Release 待ちのバージョンがあります」のいずれかが表示されたら、その指示に従ってください。
- ApplicationVersions: アップロード済みのバージョンの一覧です。バージョンごとに「First Release」(リリース)、「Revert Version」(以前のバージョンに戻す)、「削除」、「このバージョンで起動」を操作できます。
- ツール → セーブデータダウンロード: TapFun ユーザー ID を入力すると、そのプレイヤーのセーブデータをダウンロードできます(ゲーム終了から 1 時間以上空けて行ってください)。TapFun ユーザー ID の確認方法はログの取得を参照してください。
ゲームの起動
アプリ画面上部の「アプリページ」から、次のオプションを付けてゲームを起動できます(デバッグ)。リリース前のアプリには「非公開状態」と表示されます。
| オプション | 説明 |
|---|---|
| 新規セッション | 既存のセッションを使わず、新しいセッションでゲームを起動し直します。前回のプレイの環境が使われることがあるため、セーブデータの引き継ぎの確認には使えません(セーブデータの引き継ぎの確認)。 |
| パフォーマンスモニタ | PC のプレイ画面にパフォーマンスモニタを表示します。 |
| ログ表示 | 画面上に consoleLog API などのログを表示します(URL の ?debugLog=1 と同じ)。 |
| verbose | ブラウザのコンソールに出すログの量を増やします(URL の ?verbose=1 と同じ)。 |
そのほかのタブ
| タブ | 内容 |
|---|---|
| 月別売上 | 日ごとの購入回数・売上・取消と、売上区分(Platform / Publisher)ごとの内訳です。 |
| CustomEvents | クライアント API で送られたリクエスト(custom_event)の記録です。 |
| Leaderboards | リーダーボードとエントリーの一覧です。 |
| Times | プレイヤーごとのプレイ時間(無料・お試し・エナジー・合計)と、タイトル利用パスの購入日時などの記録です。 |
| 紹介ページ | TapFun 上のゲーム紹介ページを別タブで開きます。 |
クラウド実行環境
動作概要【重要】
TapFun は「リモートデスクトップ方式」でゲームをサーバー内で起動し、ブラウザからリモート操作します。クラウドゲーミングの基盤には Tencent CAR を使用しています。
- クラウド上の Windows サーバー(Windows Server 2019 / 2022)で exe を実行します。
- デスクトップ画面のグラフィックとオーディオ出力をキャプチャし、ブラウザ(tapfun.co.jp)内の canvas 要素へストリーミングします。ゲーム画面はフルスクリーンで起動してください。
- canvas 内のマウス操作・キーボード操作は Windows サーバー上の exe に送られます。
- ゲームの容量に制限はありません。
- リフレッシュレートは最大 60 fps です。
- Windows Media Foundation 経由で再生できる動画形式は H.264 / H.265 です。VP9 は使用できません。
- アセットの追加ダウンロードは通常行えません(ユーザー単位のデータとして保存されるため、容量次第でご相談になります)。
- Tencent CAR の各種機能・API の使用を希望される場合はご連絡ください。
サーバー性能
| プラン | CPU | メモリ | GPU 性能 | Furmark 2 1080p スコア |
|---|---|---|---|---|
| S | 4 コア | 8 GB | 2TF SP/30T | 2600〜3200 |
| M | 4 コア | 16 GB | 4TF SP/30T | 2600〜3200 |
表の性能は観測時点での目安です。タイミングや時期によって変わります。
ネットワーク要件
ゲーム実行環境からゲームサーバーへ通信する場合の要件です。
- 受信の許可: すべての送信元から UDP 8000 および 60000〜60100 への受信を許可してください。
- 接続元 IP: exe を実行するサーバーから外部へ HTTP 等で通信する際の接続元 IP は非公開です。
ユーザーデータの保存復元
ユーザーデータは起動時に自動で復元され、終了時に自動で保存されます。保存復元には Tencent CAR のアプリケーションアーカイブの保存の機能を使用しています。保存できるパスなど TapFun での設定は、このページの記載に従ってください。
- 保存復元するディレクトリはゲームタイトルごとに設定でき、ディレクトリは 1 つ のみです。保存容量は合計 100 MB 以内 を推奨します。
- セーブデータは TapFun アカウントごとに保持され、ビルドを更新してもそのまま引き継がれます。
- クラウドストレージへの保存はゲーム終了後に行われます。Publisher Console からセーブデータをダウンロードする場合は、ゲーム終了から 1 時間以上空けて行ってください。
- 保存できるパスは次のいずれかの配下です。
C:\Users\%UserName%\AppData\Local\<任意のディレクトリ>C:\Users\%UserName%\AppData\LocalLow\<任意のディレクトリ>C:\Users\%UserName%\AppData\Roaming\<任意のディレクトリ>C:\Users\%UserName%\Documents\<任意のディレクトリ>C:\Users\Public\Documents\<任意のディレクトリ><アップロードした zip のルートディレクトリ>\<任意のディレクトリ>(非推奨)
- セーブデータディレクトリは、基本的には変えないでください。変更すると、変更前のディレクトリに保存されていた内容が、変更後のディレクトリに展開されます。ゲームの動作不具合の原因となる場合があるため、変更後は TapFun アカウントを退会するなどして、別のアカウントでテストをやり直してください。
- アップロードした zip 内のディレクトリは、セーブデータディレクトリとしては推奨しません。 動作が不安定になるため、上記の
C:\Users\配下のディレクトリに保存してください。exe 側で保存先を変更できない場合に限り、zip 内のディレクトリを指定できます。その場合は、exe と同じフォルダから 1 階層以上下のフォルダを作り、その中に保存してください(exe と同じフォルダに直接置いたファイルは保存されません)。 - セーブデータディレクトリには、セーブデータとログ以外のファイルを入れないでください。 ディレクトリ内のファイルはすべてセーブデータとして保存・復元されます。DLL やアセットなどが入っていると、アップロードした zip の最新のファイルではなく、保存されていた古いファイルが復元され、不具合の原因になります。ログを置く場合はログの取得の注意を守ってください。
%UserName%は Windows のログインユーザー名です。ある程度固定的ですが基本的にランダムなため、参照は 1 セッション内に留めてください。- 任意のディレクトリ名は TapFun までお知らせください。レジストリへの保存は復元されません。Unity の
PlayerPrefsは Windows ではレジストリに保存されるため、ファイルに保存するよう変更してください。 - セーブデータを初期化する機能はありません。初回だけの動作(チュートリアルなど)は、別の TapFun アカウントで確認してください。
- 保存先の設定が終わるまでは、セーブの挙動は正しく動きません。セーブまわりの確認は、保存先の設定後に行ってください。確認の方法はセーブデータの引き継ぎの確認を参照してください。
保存先の例:
| ゲームエンジンなど | 保存先の例 |
|---|---|
Unity(Application.persistentDataPath) |
C:\Users\%UserName%\AppData\LocalLow\<会社名>\<製品名> |
| Godot 4 | C:\Users\%UserName%\AppData\Roaming\Godot\app_userdata\<プロジェクト名> |
| Electron(localStorage を含む) | C:\Users\%UserName%\AppData\Roaming\<アプリ名> |
| アクションゲームツクールMV | C:\Users\%UserName%\AppData\Local\<フォルダ名>\save |
セーブデータの引き継ぎの確認
セーブデータが引き継がれるか(セーブデータディレクトリが正しく設定されているか)は、パブリッシャー様ご自身でご確認ください。
ゲーム終了から 1 時間以内に起動し直すと、前回のプレイの環境がそのまま使われることがあります。その場合は、セーブデータディレクトリが正しく設定されていなくても、セーブデータが引き継がれたように見えます。「アプリページ」の「新規セッション」を付けて起動した場合も同じです。確認は、ゲームを終了してから 1 時間以上空けて行ってください。
- テスト環境でゲームを起動し、ゲーム内でセーブします(進行を進める、設定を変えるなど)。
- ゲームを終了します。
- 1 時間以上空けてから、次のどちらかで確認します。
- セーブデータをダウンロードして確認する: Publisher Console の「バイナリ」タブの「ツール → セーブデータダウンロード」で TapFun ユーザー ID を入力してダウンロードし、手順 1 でセーブした内容が含まれていることを確認します。TapFun ユーザー ID の確認方法はログの取得を参照してください。
- ゲームを起動し直して確認する: もう一度ゲームを起動し、手順 1 の進行や設定が引き継がれていることを確認します。
- 1 時間以内に起動し直して引き継がれていても、セーブデータディレクトリが正しいとは限りません。
- 1 時間以上空けると引き継がれていない場合は、セーブデータディレクトリが正しくない可能性があります。TapFun までご連絡ください。
シェーダーのコンパイル結果
シェーダーのコンパイル結果(シェーダーキャッシュ)は、セッションをまたいで保存できません。起動時にシェーダーをコンパイルするゲームでは、セッションごとに毎回コンパイルが行われる前提で調整してください。
- クラウド上の PC 環境は固定されておらず、セッションごとに同じ環境で起動するとは限りません。
- そのため TapFun では、シェーダーキャッシュをセッション間で保持したり、サーバー単位で共有したりしていません。
- ゲーム側でシェーダーキャッシュをセーブデータディレクトリに書き込み、セーブデータとして保存・復元しても、再利用できる保証はありません。保存する場合は、セーブデータの容量(合計 100 MB 以内を推奨)に含まれます。
ユーザーデータの保存期間
| データ | 保存期間 |
|---|---|
| セーブデータ | プレイヤーが TapFun を退会するまで保持します。アプリの公開を終了した場合は削除します。 |
| Photos API で保存した画像 | プレイヤーが TapFun を退会するまで保持します。プレイヤーが TapFun 上で削除した画像と、1,000 枚を超えた画像は除きます。 |
対応する入力
プレイヤーの操作は、クラウド上の Windows に次の入力として届きます。
| プレイヤーの操作 | exe から見える入力 |
|---|---|
| キーボード(PC) | Windows の通常のキーボード入力 |
| マウス(PC) | Windows の通常のマウス入力。Publisher Console の「ポインターデバイス対応」を有効にしたタイトルで使えます |
| タッチ(スマートフォン・タブレット) | マウスクリック |
| ゲームパッド(PC)・バーチャルパッド(スマートフォン・タブレット) | 仮想ゲームパッド(ゲームパッド入力方式で選んだ種類) |
- スマートフォン・タブレット(iOS / Android)からプレイできるのは、Publisher Console の「ゲームパッド対応」を有効にしたタイトルです(プレイできる端末)。プレイヤーは画面上のバーチャルパッド(スティック・十字キー・各ボタン、Esc キーのボタン)またはタップで操作します。タップ操作だけで遊べるタイトルは、「ゲームパッド対応」を有効にし、「バーチャルパッドデフォルト」を無効にしてください。
- バーチャルパッドの入力はゲームパッドとして届くため、ゲーム側の追加の実装は不要です(Unreal Engine では、エンジンのゲームパッド設定がそのまま使えます)。
- スマートフォン・タブレットからはキーボード入力を送れません。キーを押さないと先に進めない場面(「A キーで開始」など)があると、スマートフォン・タブレットでは進めなくなります。タップかゲームパッドでも操作できるようにしてください。
- タッチ端末に仮想のマウスカーソルはありません。タッチはその位置へのマウスクリックとして届きます。2 本目以降の指(マルチタッチ)は区別できない場合があります。
- ゲームパッドの振動には対応していません。
- ゲームパッドとバーチャルパッドは、ゲーム画面を一度クリック(タップ)してから反応します(FAQ)。
プレイできる端末
プレイヤーが紹介ページを開くと、TapFun はブラウザの情報から端末を「PC」か「スマートフォン・タブレット」に分けます。Publisher Console の「ゲームパッド対応」の有効・無効によって、次のように変わります(基本情報)。
| 端末の判定 | 有効 | 無効 |
|---|---|---|
| PC | プレイできます | プレイできます |
| スマートフォン・タブレット | プレイできます | プレイできません |
- 「ゲームパッド対応」が無効のタイトルでは、スマートフォン・タブレットと判定した端末の紹介ページにプレイボタンを表示せず、「このタイトルはPCブラウザ(キーボード・マウス)でのプレイ専用です。」と表示します。
- スマートフォン・タブレットでは、バーチャルパッドとタップで操作します(対応する入力)。
- タイトルの一覧には、「ゲームパッド対応」に関係なくすべてのタイトルを表示します。
紹介ページの表示も、どの端末で開いても次のように変わります。
| 紹介ページの項目 | 有効 | 無効 |
|---|---|---|
| 対応環境 | PC・スマートフォン・WiFi | PC・WiFi |
| 対応デバイス | キーボード(& マウス)or ゲームパッド | キーボード(& マウス) |
- 「対応デバイス」のマウスは、「ポインターデバイス対応」を有効にしたタイトルでだけ表示します。
端末の判定
| 端末・ブラウザ | 判定 |
|---|---|
| Windows(タッチ対応の PC・タブレットを含む) | PC |
| Mac | PC |
| Chromebook・Linux | PC |
| iPhone | スマートフォン・タブレット |
| iPad(Safari の「デスクトップ用Webサイトを表示」のオン・オフによらない) | スマートフォン・タブレット |
| Android スマートフォン・タブレット | スマートフォン・タブレット |
| Android の Chrome で「PC 版サイト」をオンにしている場合 | PC |
判定は次の順に行い、最初に当てはまったもので決めます。
- User-Agent(
navigator.userAgent)にWindowsを含む → PC navigator.userAgentData.platformがiOSかAndroid→ スマートフォン・タブレット- User-Agent に
iPhoneかAndroidを含む → スマートフォン・タブレット - User-Agent に
iPadを含む、またはMacintoshを含みタッチ操作に対応している → スマートフォン・タブレット(iPad) - どれにも当てはまらない → PC
- この判定は isSP とは別です。Android タブレットと、「デスクトップ用Webサイトを表示」がオンの iPad は、
isSPが0でも、ここではスマートフォン・タブレットに分けます。
スマートフォン・タブレットからのプレイを止めたい場合
「ゲームパッド対応」は、スマートフォン・タブレットのバーチャルパッドやタップで遊べるタイトルかどうかを表す設定です。スマートフォン・タブレットでのプレイを禁止するための設定ではありません。無効にすると、スマートフォン・タブレットの紹介ページからはプレイを始められなくなります。ただし、次の場合はプレイできます。
- PC と判定される状態の端末(端末の判定の Android の「PC 版サイト」など)
- プレイ画面の URL を直接開いた場合(PC で開いたプレイ画面の URL をスマートフォンで開いた場合など)。端末を判定するのは紹介ページだけで、プレイ画面とサーバーでは判定しません。
exe 側でも止める場合は、起動パラメータの {isSp} か、getPlayerEnvironment の isSP・userAgent で判定してください。ただし、isSP はタブレットで 0 になることがあります。また、「デスクトップ用Webサイトを表示」がオンの iPad は、User-Agent では Mac と見分けられません(isSP の判定)。
マウスカーソルのキャプチャ(FPS など)
FPS などでゲーム側がマウスカーソルをキャプチャする場合は、Publisher Console の「マウスカーソル常時表示」を無効にします。
- このとき、プレイヤーがマウスカーソルをゲームから自分の PC 側に戻すには、Esc キーの長押しが必要です。
- Esc キーは、多くのゲームでメニューの表示などに割り当てられています。可能であれば、メニューの表示を Esc 以外のキーに変更することを推奨します。
ゲームパッド
PC のゲームパッドとスマートフォン・タブレットのバーチャルパッドの入力は、クラウド上の Windows に仮想ゲームパッド 1 台として届きます。ゲームがゲームパッドを読み取る方式に合わせて、Publisher Console の「ゲームパッド入力方式」を選んでください(基本情報)。
| ゲームパッド入力方式 | クラウド上の Windows でのパッドの種類 | ゲームが読み取る方式 |
|---|---|---|
| XInput(既定) | Xbox 360 コントローラー | XInput |
| WGI | DualShock 4 | Windows.Gaming.Input(WGI) |
- 「XInput」を選ぶと WGI からは読み取れず、「WGI」を選ぶと XInput からは読み取れません。両方から読み取れるようにはできません。
- 変更は、保存したあとにプレイ画面を開き直して起動したときから反映されます。
起動パラメータ
exe には、Publisher Console の「exe 起動パラメータ」の値が渡ります(基本情報)。値の中に次の表のプレースホルダを書くと、起動するたびにプレイヤーごとの値に置き換えて渡します。TapFun と API 連携するアプリ(クライアント API や Web API を使うアプリ)は、必要なプレースホルダを「exe 起動パラメータ」に書いてください。
「デフォルト起動パラメータを設定」ボタンを押すと、「exe 起動パラメータ」が次の値に置き換わります。すでに値が入っている場合は、置き換えてよいかの確認が出ます。押しただけでは保存されないので、「保存」ボタンを押してください。
--type car --tapfun-user-id {userId} --api-host {apiHost} --bearer-token {bearerToken} --sig-key {sigKey} --port {port} --username {username} --is-paid-timer {isPaidTimer} --is-sp {isSp} --dlcs {dlcs}この値の場合、exe は次のように起動します。
C:\Apps\%UserName%\TapFunDebugConsoleApp.exe --type car --tapfun-user-id PLYR01HE2R3JV6Y2NEGRMS4KZQB861DBG --api-host <TEST_HOST> --bearer-token 123_AAABBBCCC --sig-key FFFGGGHHH --port 10100 --username %E3%81%82%E3%81%84 --is-paid-timer 0 --is-sp 0 --dlcs delux_upgrade,special_upgrade| プレースホルダ | デフォルト起動パラメータでのオプション | 説明 |
|---|---|---|
{userId} |
--tapfun-user-id |
TapFun ユーザー ID です。秘匿データではありませんが、画面上には表示しないでください。 |
{apiHost} |
--api-host |
Web API のホスト名です(例: 本番は tapfun.co.jp)。 |
{bearerToken} |
--bearer-token |
Web API および クライアント API の送信 で使う Bearer token です。 |
{sigKey} |
--sig-key |
Publisher Console の署名用キー(sigKey)です。 |
{port} |
--port |
CAR Data Channel 用の UDP ポート番号です。通常は 10100 固定です。 |
{username} |
--username |
ユーザー名です。URL エンコード済みの UTF-8、デコード後 1〜12 文字、絵文字不可です。 |
{isPaidTimer} |
--is-paid-timer |
1: 有料タイマーユーザー / 0: 無料タイマーユーザー |
{isSp} |
--is-sp |
getPlayerEnvironment の isSP と同じ値です。判定方法とタブレットの扱いは isSP の判定 を参照してください。 |
{dlcs} |
--dlcs |
購入済みの DLC の code をカンマ区切りで渡します。 |
{lang} |
— | プレイヤーのブラウザで最も優先される言語です(BCP 47 の言語タグ。例: ja、en-US)。取得できない場合は空になります。 |
{country} |
— | 接続元の国です(例: JP)。判定方法と判定できる国は country の判定 を参照してください。 |
- デフォルト起動パラメータの
--type carは、置き換えのない固定の文字列です。 {lang}と{country}はデフォルト起動パラメータに含まれません。使う場合は--lang {lang} --country {country}のように書き足してください。- オプションの名前や順番は変えられます。使わないものは書かなくてかまいません(例:
-screen-fullscreen 1 --user {userId})。 --user={userId}のように、ほかの文字とつなげて書いても置き換わります。- 購入済みの DLC が無いプレイヤーでは
{dlcs}が空になります。このように値が空になる場合は、直前のオプション名(--dlcsなど)ごと渡しません。--dlcs={dlcs}のようにつなげて書いた場合は、--dlcs=のまま渡します。 - 上の表に無い
{...}は、置き換えずにそのまま渡します。
クライアント API
exe と、プレイヤーのブラウザ上の TapFun との通信用 API です。送信データは一旦ユーザーのブラウザを通るため、秘匿情報は含めないでください。
| API | 概要 |
|---|---|
| openUrl | 別タブで URL を開く |
| inputTextSingleLine | 1 行文字入力モーダル |
| inputTextMultiLine | 複数行文字入力モーダル |
| inputTextMultiLineChunkText | 複数行入力の初期テキストを分割送信 |
| copyText | クリップボードへコピーできるモーダル |
| showText | テキストモーダル |
| getPlayerEnvironment | プレイヤー環境の取得 |
| launchSuccessNotice | 起動成功通知 |
| consoleLog | ログ表示 |
| clientStatus | クライアント状態の通知(自動送信) |
通信仕様
送信は TapFun の HTTP API への POST、受信は exe 内での UDP 待ち受けです。送信には TapFun ユーザー ID と Bearer token が必要です。「exe 起動パラメータ」に {userId} と {bearerToken} を書いて受け取ってください(起動パラメータ)。
送信
| 項目 | 内容 |
|---|---|
| 送信先 | https://<環境のホスト名>/api/v1/custom_event?userId=<TapFunユーザーID> |
| メソッド | HTTP POST |
| Content-Type | application/x-www-form-urlencoded |
| 認証 | Authorization: Bearer <Bearer token>(例: Authorization: Bearer 123_NWU0MjlkY2ViYTVkOTdiYjIw) |
| 文字コード | UTF-8 |
| 最大サイズ | 10 MB |
| ブラウザへの伝達 | WebSocket |
受信
| 項目 | 内容 |
|---|---|
| 方式 | CAR Data Channel。ローカル UDP ポート 10100(--port)で LISTEN |
| 文字コード | UTF-8 |
| データ形式 | クエリストリング形式(例: from=getPlayerEnvironment&isSP=0)。半角スペースは %20 でエンコードされます。 |
起動直後のリクエスト
2026-11-10 時点で、exe の起動から数秒以内に送ったリクエストは、応答が exe に届かないことがあります。リクエストは TapFun に届くので、launchSuccessNotice など応答のないリクエストは起動直後に送ってかまいません。
- 応答を使うリクエスト(getPlayerEnvironment、inputTextSingleLine、inputTextMultiLine)は、exe の起動から 5 秒以上たってから送ってください。
- getPlayerEnvironment は、3 秒待っても応答が届かなければ送り直してください。
- inputTextSingleLine などプレイヤーに表示するリクエストは、送り直さないでください。
サンプルコード
Unity・Godot・.NET 向けに、起動パラメータの読み取りと、クライアント API・Web API の呼び出しをまとめたサンプルです。ライセンスは MIT-0 です。
送信のサンプル(Unity / C#):
public IEnumerator SendCustomEventToCar(string userId, WWWForm formData)
{
// config.apiHost = --api-host, config.bearerToken = --bearer-token
string url = $"https://{config.apiHost}/api/v1/custom_event?userId={userId}";
using (UnityWebRequest www = UnityWebRequest.Post(url, formData))
{
www.SetRequestHeader("Authorization", $"Bearer {config.bearerToken}");
yield return www.SendWebRequest();
}
}受信のサンプル(Unity / C#):
private UdpClient udpServer;
private IPEndPoint udpEndPoint;
private Thread serverThread;
private int udpServerPort = 10100; // --port
private bool isDataChannelReceiveLoopRunning = false;
public void CarHandleDataChannel()
{
try
{
udpEndPoint = new IPEndPoint(IPAddress.Parse("127.0.0.1"), udpServerPort);
udpServer = new UdpClient(udpEndPoint);
isDataChannelReceiveLoopRunning = true;
serverThread = new Thread(CarDataChannelReceiveLoop);
serverThread.IsBackground = true;
serverThread.Start();
}
catch (Exception e)
{
Debug.LogError($"Failed to start UDP server: {e.Message}");
}
}
private void CarDataChannelReceiveLoop()
{
while (isDataChannelReceiveLoopRunning)
{
try
{
byte[] receivedBytes = udpServer.Receive(ref udpEndPoint);
string receivedMessage = Encoding.UTF8.GetString(receivedBytes); // クエリストリング形式
byte[] responseBytes = Encoding.UTF8.GetBytes("OK");
udpServer.Send(responseBytes, responseBytes.Length, udpEndPoint);
lock (queueLock)
{
receivedMessagesQueue.Enqueue(receivedMessage);
}
}
catch (Exception e)
{
Debug.LogError($"Unexpected error in receive loop: {e.Message}");
Thread.Sleep(1000); // 予期しないエラーの場合は少し待ってから継続
}
}
}openUrl
指定した URL を別タブで開きます。
| パラメータ | 必須 | 説明 |
|---|---|---|
req |
✓ | openUrl(固定) |
url |
✓ | 別タブで開く URL |
レスポンス通知: なし
inputTextSingleLine
1 行の文字入力モーダルを表示します。
| パラメータ | 必須 | 説明 |
|---|---|---|
req |
✓ | inputTextSingleLine(固定) |
label |
レスポンス識別用ラベル | |
title |
モーダルのタイトル | |
placeholder |
プレースホルダー | |
text |
デフォルト文字列(最大 128 文字) | |
submit |
入力完了ボタンの文字列 | |
cancel |
キャンセルボタンの文字列 | |
position |
表示位置。省略時は中央、bottom で下部 |
|
maxlength |
最大文字数(デフォルト 128、最大 128) | |
pattern |
HTML input 要素の pattern 属性 の値 | |
invalid |
pattern に一致しない場合のメッセージ(setCustomValidity に渡されます) |
レスポンス通知:
| キー | 入力完了 | 入力キャンセル |
|---|---|---|
from |
inputTextSingleLine |
inputTextSingleLine |
label |
リクエストの label |
リクエストの label |
result |
submit |
cancel |
text |
入力文字列(最大 128 文字) | 入力文字列 |
inputTextMultiLine
複数行の文字入力モーダルを表示します。
| パラメータ | 必須 | 説明 |
|---|---|---|
req |
✓ | inputTextMultiLine(固定) |
label |
レスポンス識別用ラベル | |
title |
モーダルのタイトル | |
placeholder |
プレースホルダー | |
submit |
入力完了ボタンの文字列 | |
cancel |
キャンセルボタンの文字列 | |
position |
表示位置。省略時は中央、bottom で下部 |
|
maxlength |
最大文字数(デフォルト 128、最大 10000。改行は 1 文字) | |
text |
デフォルト文字列 | |
end |
inputTextMultiLineChunkText で送信したシーケンスの終了番号 |
レスポンス通知: 入力が 128 文字を超える場合は、最大 128 文字ずつのシーケンスに分割して複数回通知されます。
| キー | 入力完了 | 入力キャンセル |
|---|---|---|
from |
inputTextMultiLine |
inputTextMultiLine |
label |
リクエストの label |
リクエストの label |
result |
submit |
cancel |
text |
入力文字列(最大 128 文字) | — |
seq |
シーケンス番号(1〜end) |
— |
end |
シーケンス最終番号 | — |
inputTextMultiLineChunkText
inputTextMultiLine の初期テキストを分割して事前送信します。すべて送信した後に inputTextMultiLine を end 付きで送ると、分割した文字列を結合してモーダルを開きます。長いテキストを分けて送りたい場合に使用します。
| パラメータ | 必須 | 説明 |
|---|---|---|
req |
✓ | inputTextMultiLineChunkText(固定) |
text |
✓ | 文字列 |
seq |
✓ | シーケンス番号(最大 100) |
レスポンス通知: なし
copyText
テキストをクリップボードにコピーできるモーダルを表示します。
| パラメータ | 必須 | 説明 |
|---|---|---|
req |
✓ | copyText(固定) |
title |
モーダルのタイトル | |
text |
✓ | コピーする文字列 |
レスポンス通知: なし
showText
テキストモーダルを表示します。
| パラメータ | 必須 | 説明 |
|---|---|---|
req |
✓ | showText(固定) |
text |
✓ | 表示する文字列 |
レスポンス通知: なし
getPlayerEnvironment
プレイヤーの環境を取得します。exe の起動直後に送ると、応答が届かないことがあります(起動直後のリクエスト)。
| パラメータ | 必須 | 説明 |
|---|---|---|
req |
✓ | getPlayerEnvironment(固定) |
レスポンス通知:
| キー | 説明 |
|---|---|
from |
getPlayerEnvironment |
userAgent |
ブラウザの navigator.userAgent |
isSP |
1 / 0。判定方法とタブレットの扱いは isSP の判定 を参照してください。 |
authenticated |
1: ログイン中 / 0: ゲスト状態 |
isPaidTimer |
1: 有料残り時間の利用ユーザー(1 秒以上の残り時間がある) / 0: それ以外 |
language |
プレイヤーのブラウザで最も優先される言語です(BCP 47 の言語タグ。例: ja、en-US)。取得できない場合は空になります。 |
country |
接続元の国です(例: JP)。判定方法と判定できる国は country の判定 を参照してください。 |
isSP の判定
isSP は、ブラウザの User-Agent(navigator.userAgent)の文字列だけで判定します。画面サイズ、タッチ操作への対応、端末の向きは見ません。
User-Agent に次のいずれかが含まれると 1、どれも含まれないと 0 です。
iPhoneiPodiPadAndroidとMobileの両方
| 端末・ブラウザ | User-Agent | isSP |
|---|---|---|
| iPhone | iPhone を含む |
1 |
| iPad(Safari の「デスクトップ用Webサイトを表示」がオン) | Mac と同じ(Macintosh を含み、iPad を含まない) |
0 |
| iPad(Safari の「デスクトップ用Webサイトを表示」がオフ) | iPad を含む |
1 |
| Android スマートフォン | Android と Mobile を含む |
1 |
| Android タブレット | Android を含み Mobile を含まない、または PC 版サイトの表示で Android を含まない |
0 |
| Windows / Mac(タッチ対応の PC を含む) | 上のいずれも含まない | 0 |
- iPad の「デスクトップ用Webサイトを表示」(設定 → アプリ → Safari)の既定値は、機種によって異なります。そのため iPad の
isSPは、設定を変えていなくても0と1のどちらにもなります。 - Safari 以外のブラウザも、User-Agent に
iPadが含まれるかどうかで決まります。 - タブレットかどうかを表す値はありません。タブレットを見分けたい場合は、getPlayerEnvironment の
userAgentを使ってゲーム側で判定してください。ただし、「デスクトップ用Webサイトを表示」がオンの iPad は Mac と同じ User-Agent を送るため、User-Agent だけでは iPad と Mac を見分けられません。
country の判定
country は、接続元の IP アドレスから AWS WAF で判定した国です。値は ISO 3166-1 alpha-2 の国コード(例: JP)です。判定できる国は、AWS WAF の GeoMatchStatement の CountryCodes に載っている国です。国を判定できない場合は空になります。
launchSuccessNotice
起動成功をプラットフォームに通知します。送信すると「ストリーミングを開始しています」のダイアログを早めに消せます。
起動成功通知待ちが有効なアプリでは、この通知を受信するか一定以上のストリーミングが持続するまで、マウス操作を受け付けません(プロセス起動完了前のマウス操作で応答待ちが発生するのを避けるため)。操作できない間はタイマーを消費しません。対象のアプリかどうかは事前にお伝えします。
| パラメータ | 必須 | 説明 |
|---|---|---|
req |
✓ | launchSuccessNotice(固定) |
レスポンス通知: なし
consoleLog
ログを出力します。ゲーム実行ページの URL に ?verbose=1 を付けるとブラウザのデベロッパーツールのコンソールに、?debugLog=1 を付けると画面上のログ表示領域に表示されます(デバッグ)。
| パラメータ | 必須 | 説明 |
|---|---|---|
req |
✓ | consoleLog(固定) |
data |
✓ | 文字列または JSON 文字列。JSON.parse() できた場合は JSON オブジェクトとしてコンソールに表示します。 |
レスポンス通知: なし
clientStatus
クライアント側の状態変化を通知します(リクエスト不要、自動送信)。
result |
発生タイミング | 追加キー |
|---|---|---|
lastTimeRemain |
プレイ残り時間が 90 秒前に達した | second: 秒数(90) |
purchaseSelectModalOpen |
プレイ時間購入モーダルを表示した | — |
lastTimeInfoModalOpen |
残り時間モーダルを表示した | — |
manualOpen |
操作説明を表示した | — |
isPaidTimer |
有料タイマーユーザーになった | — |
isFreeTimer |
無料タイマーユーザーになった | — |
すべての通知に req=clientStatus が付きます。例: req=clientStatus&result=lastTimeRemain&second=90
Web API
パブリッシャー様のサーバー、または exe から呼び出す HTTP API です。
共通仕様
| 項目 | 内容 |
|---|---|
| ベース URL | https://<環境のホスト名>/api/v1(ホスト名) |
| メソッド | HTTP GET / POST |
| 文字コード | UTF-8 |
| リクエストヘッダー | User-Agent は必須です(値は任意。例: ExampleGames-Server/1.0)。付いていないリクエストは受け付けません |
| リクエスト形式 | URL パス、クエリストリング、POST データ(application/x-www-form-urlencoded。個別に記載があるものを除く) |
| レスポンス形式 | JSON。配列の結果が 0 件の場合は空配列。HTTP ステータスは記載が無い限り 200 |
| 日時 | UTC、yyyy-mm-ddThh:mm:ss.sssZ |
認証
HTTP ヘッダー Authorization: Bearer <アプリID>_<APIキー>(Publisher Console の Bearer token)で認証します。
Authorization: Bearer 123_NWU0MjlkY2ViYTVkOTdiYjIwNThmZTkxMDMzYWM4Y2JmNGUyMTQ0Ng認証失敗時は HTTP 403 で次を返します。
{"error":"no authorization"}User-Agent ヘッダーが無い場合は、上の JSON ではなく HTML の 403 Forbidden が返ります。
POST /api/v1/photos
TapFun フォトストレージに画像を保存します。ユーザーは TapFun 上で、ゲームから保存された画像を閲覧・ダウンロードできます。認証: 必要。
| 項目 | 内容 |
|---|---|
| Content-Type | multipart/form-data |
クエリストリング userId |
TapFun ユーザー ID(必須) |
POST データ file |
PNG / JPEG / WebP の画像バイナリ(必須)。part の Content-Disposition の filename は任意の値で必須(例: form-data; name="file"; filename="sample.jpg") |
制約:
- 最大保存枚数: 1,000 枚。TapFun の一覧に表示するのは新しい順に 1,000 枚までです。1,000 枚を超えた画像は順次削除されます。
- 保存期間: プレイヤーが TapFun を退会するまで保持します。プレイヤーが TapFun 上で削除した画像と、1,000 枚を超えた画像は除きます。
- 最大容量: 1 枚あたり 10 MB(全体の容量制限はありません)
- 最大の高さ・幅: 12,000 ピクセル
- 最大画像サイズ: 100M ピクセル(例: 10,000 × 10,000)
- 連続呼び出しの待機時間・呼び出し回数の制限: なし
curl -F "file=@sample.jpg;type=image/jpeg" \
-H "Authorization: Bearer 1_8an4dAfsIyEEvBbaKxd55P2Wgf" \
"https://<TEST_HOST>/api/v1/photos?userId=PLYR01JY39A09EE40YQZRHWTT9EM1VDBG"// 成功
{ "result": "success" }
// 失敗(404): ユーザー ID が無い
{ "result": "failure", "message": "userId is not found" }
// 失敗(400): その他(file が無い、大きすぎる、形式が不正など)
{ "result": "failure", "message": "other problems." }GET /api/v1/leaderboard/entries
リーダーボードのエントリー一覧を取得します。認証: 必要。
| クエリストリング | 必須 | 説明 |
|---|---|---|
name |
✓ | リーダーボード名 |
sort |
asc: 昇順 / desc: 降順(デフォルト) |
|
userId |
ユーザー ID | |
arround |
指定ユーザーの周辺のエントリーを取得します(1〜100)。userId 指定時に機能します |
|
offset |
表示開始位置(0〜9999)。範囲外は 0 | |
limit |
件数(1〜1000、デフォルト 100)。範囲外は 100 |
// 成功
{
"result": "success",
"entries": [
{
"position": 1,
"userId": "PLYR01HE2R3JV6Y2NEGRMS4KZQB861DBG",
"userName": "ユーザー名", // UTF-8、絵文字不可、1〜12 文字
"score": 12345,
"note": "追加情報", // 最大 8192 文字
"createdAt": "2025-09-24T00:00:00.000Z",
"updatedAt": "2025-09-24T00:00:00.000Z"
}
]
}
// 失敗(404): ユーザー ID が無い
{ "result": "failure", "message": "userId is not found" }
// 失敗(400): その他
{ "result": "failure", "message": "other problems." }POST /api/v1/leaderboard/entries
リーダーボードのエントリーを作成・更新します。既存のスコア値以下(同値を含む)の場合は更新しません。リーダーボードは name ごとに自動で作られます。認証: 必要。
| POST データ | 必須 | 説明 |
|---|---|---|
name |
✓ | リーダーボード名。英数字・_・- の 1〜64 文字(/^[0-9a-zA-Z_-]{1,64}$/) |
userId |
✓ | ユーザー ID |
score |
✓ | スコア値(0〜9,223,372,036,854,775,807) |
note |
追加情報(UTF-8、0〜8192 文字) | |
force |
1 を渡すと、既存のスコア値を下回る場合でも登録します |
// 成功
{ "result": "success" }
// 失敗(404): ユーザー ID が無い
{ "result": "failure", "message": "userId is not found" }
// 失敗(400): その他
{ "result": "failure", "message": "other problems." }POST /api/v1/leaderboard/entries/delete
リーダーボードのエントリーを削除します。エントリーが無い場合も成功を返します。認証: 必要。
| POST データ | 必須 | 説明 |
|---|---|---|
name |
✓ | リーダーボード名(/^[0-9a-zA-Z_-]{1,64}$/) |
userId |
✓ | ユーザー ID |
// 成功
{ "result": "success" }
// 失敗(404): ユーザー ID が無い
{ "result": "failure", "message": "userId is not found" }
// 失敗(400): その他
{ "result": "failure", "message": "other problems." }用語
実行環境
exe を実行し配信するクラウドストリーミングサーバーです。
TapFun ユーザー ID
- ユーザーを特定する最大 64 桁のユニーク ID です。アプリごとに発行されます。
- 文字種は
0-9,a-z,A-Zです。 - 形式は
PLYR+ ULID + アプリごとの suffix(3〜7 文字。例:DBG,XENO,MOCODVLP)です。
アプリ ID
アプリを特定する unsigned int 型の ID です。
API キー
アプリごとに発行される 26 桁の文字列です。文字種は 0-9, A-Z です。
Publisher Console
パブリッシャー様向けの管理画面です。アプリの設定、紹介ページ、売上の確認などを行います。テスト環境と本番環境で別々にあり、ログインできる方は TapFun が登録します。
紹介ページ
TapFun 上のゲームのページです(https://tapfun.co.jp/p/<アプリ>)。ゲームのプレイ画面は https://tapfun.co.jp/p/<アプリ>/play です。内容は Publisher Console の詳細情報で編集します。
ゲスト
TapFun にログインしていない状態のプレイヤーです。
TapFun ウォレット
プレイヤーが TapFun でチャージする残高です。TapFun 上での購入に使います。
TapFun クレジット
本番環境のテストプレイ用アカウントに付与される、対象のアプリでのみ使えるウォレット残高です(本番でのテストプレイ)。
セッション
クラウド上でゲームを起動してから終了するまでの 1 回分のプレイです。セッションの終了時にセーブデータが保存され、次のセッションの開始時に復元されます。
お試し時間
タイトルごとに設定された、無料でプレイできる時間です(Publisher Console の「お試し分数」)。1 回分は 12 時間後に回復します。
エナジー
プレイ時間を延長するためにプレイヤーが購入する単位です。エナジー 1 つで遊べる時間はタイトルごとに設定され、タイトル利用パスを持っているかどうかで別々の値になります(販売情報)。
タイトル利用パス
タイトルごとに販売する利用権です(「タイトルパス」とも書きます)。購入後、設定された時間は無料でプレイできます。DLC を同梱した版も販売できます(DLC)。
有料タイマーユーザー / 無料タイマーユーザー
有料のプレイ時間(エナジーやタイトル利用パスで得た残り時間)が 1 秒以上あるプレイヤーが有料タイマーユーザー、それ以外が無料タイマーユーザーです。起動パラメータの {isPaidTimer} や getPlayerEnvironment の isPaidTimer で分かります。
First Release
Publisher Console で、アップロード済みのバージョンを、プレイヤーが起動するバージョンにする操作です(リリース時のセッションの扱い)。
バーチャルパッド
スマートフォン・タブレットのプレイ画面に表示する仮想のゲームパッドです。入力はゲームパッドの入力として exe に届きます(対応する入力)。
変更履歴
| 日付 | 内容 |
|---|---|
| 2026-11-19 | POST /api/v1/leaderboard/entries の score は 0 以上になりました。負の値を送ると 400 を返します。 |
| 2026-11-18 | ユーザーデータの保存復元に、Tencent CAR のアプリケーションアーカイブの保存の機能を使用していることと、その仕様へのリンクを追記しました。 |
| 2026-11-16 | 提出する exe の要件に、readme などのファイルも zip の直下に置かず、フォルダの中に入れることを追記しました。Publisher Console でも、zip の直下にフォルダ以外のものがあるとアップロードできなくなりました(バイナリ更新方法)。 |
| 2026-11-12 | 提出する exe の要件に、zip の直下にはフォルダを 1 つだけ置き、その中に exe とファイル一式を入れることを追記しました。 |
| 2026-11-11 | テスト環境の紹介ページやプレイ画面で、Basic 認証の代わりにメールアドレスの確認を行うようになりました。テストプレイする方は Publisher Console の「テストプレイヤー」で追加できます(テスト環境に入れる方)。 |
| 2026-11-10 | サンプルコードを、公開リポジトリ tapfun-sample-car(Unity・Godot・.NET)に差し替えました。GitHub アカウント名のご連絡なしで閲覧できます。 |
| 2026-11-10 | 起動直後のリクエストを追記しました。exe の起動から数秒以内に送ったリクエストの応答が届かないことがある件と、その対処を記載しています。 |
| 2026-11-09 | 起動パラメータのプレースホルダに {lang}(プレイヤーの言語)と {country}(接続元の国)を追加しました。getPlayerEnvironment も language と country を返すようになりました(country の判定)。 |
| 2026-11-05 | プレイできる端末を追記しました。「ゲームパッド対応」の有効・無効で、どの端末からプレイできるかを記載しています。 |
| 2026-11-05 | サーバー性能から具体的な GPU 名(GPU の機種と性能の目安)を削除しました。あわせて、表の性能は観測時点での目安で、タイミングや時期によって変わることを追記しました。 |
| 2026-11-05 | シェーダーのコンパイル結果をセッションをまたいで保存できない理由を追記しました。 |
| 2026-11-04 | isSP の判定を追記しました。タブレットでの値も記載しています。 |
| 2026-11-04 | セーブデータの引き継ぎの確認を追記しました。あわせて、Publisher Console からのセーブデータのダウンロードは、ゲーム終了から数分後ではなく 1 時間以上空けて行うように変えました。 |
| 2026-11-02 | ユーザーデータの保存期間を追記し、Photos API の最大保存枚数の説明を更新しました。 |
| 2026-11-02 | Publisher Console のメンテナンスモードを有効にすると、プレイ中のゲームも終了するようになりました(メンテナンスモードの動作)。 |
| 2026-10-30 | Publisher Console の「ゲームパッド入力方式」で、「XInput」か「WGI」を選べるようになりました。これに伴い、ゲームパッドの既知の問題を削除しました。 |
| 2026-10-28 | 開発中の問題発生時の対応に、TapFun が対応する問題とパブリッシャー様に対応していただく問題の分担を追記しました。 |
| 2026-10-28 | 提出する exe の要件に、zip 内のフォルダ名と exe のファイル名を固定することを追記しました。 |
| 2026-10-27 | ?debugLog=1(「ログ表示」)のログの 2 行目に TapFun ユーザー ID が表示されるようになりました。セーブデータやログのダウンロードに使う ID の確認方法をログの取得に追記しました。 |
| 2026-10-26 | 起動パラメータを、Publisher Console の「exe 起動パラメータ」にプレースホルダ({userId} など)で書く方式に変えました。TapFun への依頼は不要です。「デフォルト起動パラメータを設定」ボタンで標準の値を入れられます。 |
| 2026-10-26 | TapFun が行う作業とサポート範囲とログの取得を追加し、FAQ に事例を追加しました。 |
| 2026-10-23 | ゲームパッドの 1 回の入力が 2 回分になる問題が解消しました。あわせて、ゲームパッドは現在 XInput でだけ読み取れることを既知の問題に記載しました。 |
| 2026-10-21 | Web API の共通仕様に、User-Agent ヘッダーが必須であることを追記しました。 |
| 2026-10-14 | Publisher Console の「アクセス解析(Google Analytics)」を追加しました。 |
| 2026-10-07 | セーブデータの保存先に C:\Users\%UserName%\Documents と C:\Users\Public\Documents を追加しました。 |
| 2026-10-02 | このドキュメントを公開しました。 |