Playable! Mobile Unity Plugin 導入手順

以下の手順で任意のゲームにプラグインを導入可能です。

導入すると uGUI を外部ツールから操作することが可能になります。

事前準備

OpenUPM 依存のパッケージを使えるようにする

Playable! Mobile Unity Plugin は OpenUPM でバージョン管理されているパッケージに依存しています。
あらかじめ、以下の手順で Unity プロジェクトの Project Settings を編集しておいてください。

  1. 対象の Unity のプロジェクトを開く
  2. メニューの Edit > Project Settings を開く
  3. Package Manager の項目を選択する
  4. Scoped Registories に以下を登録する
    • Name: OpenUPM
    • URL: https://package.openupm.com
    • Scope(s): com.endel.nativewebsocket

image

カスタムパッケージの導入

OpenUPM の設定を終えた後に以下の手順でカスタムパッケージをインストールしてください。

事前にプラグインの zip ファイルを任意のディレクトリに展開しておいてください。

  1. メニューの Window > Package Manager を開く
  2. Package Manager の Add Package From disk を選択
  3. PlayableMobile/package.json を選択

ゲーム起動時に Playable! Mobile が起動するようにする

Package Manager でカスタムパッケージを導入すると、以下の条件で Playable! Mobile Unity Plugin の機能が自動で有効となります。

  UnityEditor Development Build Release Build
機能 有効 有効 無効 (ENABLE_PLAYABLE_MOBILE シンボルがある場合は有効)
  • リリースビルドに Playable! Mobile Unity Plugin の機能が含まれないように基本的には Development Build でのみ有効となっています。
  • リリースビルドで実行したい場合にも、 ENABLE＿PLAYABLE_MOBILE シンボルを定義しておけば機能を有効にできます。
    • Development Build だとコンソール表示が画像認識の邪魔になる場合があり、そういう場合に利用してください
    • 一般向けリリースで有効にならないように気を付けてください

注意事項

Windows や Mac 向けにビルドする場合

Windows もしくは Mac 向けにビルドする場合、Player Settings の Resolution and Presentation にある Run in Background にチェックを入れ、ウィンドウが非アクティブ状態でもゲームが停止しないようにしてください。

チェックを入れない場合、Python のツールを操作した際にゲームアプリケーションが非アクティブ状態になり、何も動作しなくなってしまいます。

iOS 向けにビルドする場合

Playable! Mobile Unity Plugin はツールとの以下の通信を行います。

  • UDP パケットのブロードキャスト送信
  • WebSocket

上記が利用できるように、アプリの権限を設定しておく必要があります。 具体的には以下のような対応が必要です。

  • iOS14.5 以後の iOS 実機で動かしたい場合は、Multicast Network の entitlement が必要となります。
  • Multicast Network の entitlement を付与するためには、Apple developer への申請と承認が必要となります。
    Apple Developer へのリンク