Awesome

UnityChoseKun

English Ver. README

概要

Unityで開発したアプリを実機上で実行している時に、GameObjectの内容をほんの少しだけ変更したいだけなのに、ビルド完了迄長時間待たされることで、貴重な開発時間を無駄にして悔しい思いをした事は無いでしょうか。 UnityChoseKunは再ビルドを行うこと無く、UnityEditor上で開発機で実行中のアプリの調整を行う為のEditor拡張です。

Demo

https://user-images.githubusercontent.com/29646672/220570479-85ea8eff-75cf-401b-92bb-4cb5ae4cd205.mp4

このプロジェクトで出来ること

• 実機で再生されているSceneをHierarchy形式で表示(Player Hierarchy)
• GameObjectに含まれるComponentの内容等、アプリケーションの内容を編集し実機側へ反映させる。(Player Inspector)

動作環境

下記の内容で動作の確認済を行っています。

• Unityのバージョン
  • Unity2018.4.26f1 (一部、機能制限あり)
  • Unity2019.4.40f1
  • Unity2020.2.2f1
  • Unity2020.3.27f1
  • Unity2021.2.15f1
  • Unity2021.3.1f1
  • Unity2022.3.43f1
• プラットフォーム
  • Android
    • Pixel3XL
    • Pixel4XL
  • iOS
    • iPhone 6S

Universal RPに関しては下記の組み合わせで動作確認を行っています。

対応しているClassについて

• Application
• OnDemandRendering
• QualitySettings
• Screen
• Shader
• Sprite
• SystemInfo
• ScalableBufferManager
• SortingLayer
• Texture
• Time
• Component
  • Animator
  • AnimationCurve
  • Behaviour
  • Bounds
  • Camera
  • Collider
  • Keyframe
  • Light
  • LayerMask
  • Material
  • Matrix4x4
  • MeshRenderer
  • MonoBehavior
  • Object
  • ParticleSystem
  • PhysicMaterial
  • Quartanion
  • Rect
  • Renderer
  • Resolution
  • Rigidbody
  • SkinnedMeshRenderer
  • SpriteRenderer
  • TextureCurve
  • Transform
  • Vector2
  • Vector3
  • Vector4
  • UI
    • Canvas
• Render Core Library
  • Volume
  • VolumeProfile
  • VolumeComponent
  • VolumeParameter
    • BoolParameter
    • LayerMaskParameter
    • IntParameter
    • NoInterpIntParameter
    • MinIntParameter
    • NoInterpMinIntParameter
    • MaxIntParameter
    • NoInterpMaxIntParameter
    • ClampedIntParameter
    • NoInterpClampedIntParameter
    • FloatParameter
    • NoInterpFloatParameter
    • MinFloatParameter
    • NoInterpMinFloatParameter
    • MaxFloatParameter
    • NoInterpMaxFloatParameter
    • ClampedFloatParameter
    • NoInterpClampedFloatParameter
    • FloatRangeParameter
    • NoInterpFloatRangeParameter
    • ColorParameter
    • NoInterpColorParameter
    • Vector2Parameter
    • NoInterpVector2Parameter
    • Vector3Parameter
    • NoInterpVector3Parameter
    • Vector4Parameter
    • NoInterpVector4Parameter
    • TextureParameter
    • NoInterpTextureParameter
    • Texture2DParameter
    • Texture3DParameter
    • RenderTextureParameter
    • NoInterpRenderTextureParameter
    • CubemapParameter
    • NoInterpCubemapParameter
    • AnimationCurveParameter
    • TextureCurveParameter
• Universal Render Pipeline
  • ScriptableRenderData
  • UniversalAdditionalCameraData
  • UniversalAdditionalLightData
  • UniversalRenderPipelineAsset
  • UniversalRenderPipelineGlobal

Classの追加方法に関してはこちらをご覧ください： Howto_add_class.md

注意事項・免責事項

• 万が一不測の事態が起きても一切保証は出来ませんのでご注意下さい。
• Script Debuggingと併用できません。必ずScript DebuggingをOFFにした上でビルドを行ってください。
• Texture,Shaderに関しては内容の確認のみで、変更を行うことは出来ません。
• Materialが参照しているShader/Textureを変更する為にはTexture/ShaderのPullを先に実行する必要があります。
• Unity2018では以下の機能に対応していません。
  • Materialが参照しているTextureの差し替え

セットアップ

UnityChoseKunは別途RemoteConnectパッケージを使用します。UnityChoseKunと合わせて取得して下さい。 取得したパッケージを任意のUnityプロジェクトへ追加することでセットアップは完了です。

パッケージの取得方法

UnityChoseKunはGitHubのリポジトリで管理されています。 セットアップ方法にはいくつかありますが、PackageManagerから取得する方法がもっとも簡単でお勧めです。

コンソールからリポジトリを取得する

コンソールからリポジトリを取得する場合、下記のコマンドを実行します。

git clone https://github.com/katsumasa/RemoteConnect.git
git clone https://github.com/katsumasa/UnityChoseKun.git

GitHubから直接取得する

1. WebブラウザーでUnityChoseKunとRemotoConnectのWebページを開く
2. 画面右上緑色のCodeと記述されているプルダウンメニューからDownload ZIPを選択しZIPファイルをダウンロード
3. ZIPファイルを解凍しUnityProjectのAssetフォルダ以下へ配置する。

[お勧め]PackageManagerから取得する

1. Window > Package ManagerでPackage Managerを開く
2. Package Manager左上の+のプルダウンメニューからAdd package form git URL...を選択する
3. ダイアログへhttps://github.com/katsumasa/RemoteConnect.git を設定し、Addボタンを押す
4. Package Manager左上の+のプルダウンメニューからAdd package form git URL...を選択する
5. ダイアログへhttps://github.com/katsumasa/UnityChoseKun.git を設定し、Addボタンを押す

アプリケーションビルド時の設定

• 調整を行うSceneにUnityChoseKun.prefabを配置する。
• Development BuildとAutoconnect Profilerにチェックを入れる。
• URPなどPackageManagerで管理されているClassの調整を行う場合、Scripting BackEndにはMonoを指定する必要があります。

機能紹介

Player Hierarchy

EditorのHierarchy同様にGameObjectの親子関係を変更したり、右クリックからのモーダルダイヤログでGameObjectを生成したり、基本的なComponentを追加することが出来ます。 Window > UTJ > UnityChoseKun > Player Hierarchyより起動します。

Reload

実機で実行されているアプリケーションのScene情報を分析し、Hierarchy Treeとして展開します。 まず初めにReloadを実行し、Sceneの情報を取得することからスタートします。

NOTE

• GameObjectが数万個存在するような複雑なSceneの場合、Reloadには時間がかかることに注意して下さい。
• アプリケーションに含まれていないComponentを追加するとエラーとなります。

Player Inspector

実機で実行しているアプリケーションに対する情報の表示や内容の編集を行う為のWindowです。 プルダウンメニューから表示する内容を切り替えて使用します。
Window > UTJ > UnityChoseKun > Player Inspectorより起動します。

Inspector

Player Hierarchyで選択したGameObjectが持つComponentの内容を編集します。 すべてのComponetの内容を編集出来る訳ではなく、現時点では一部のComponentに限定されています。 非対応のComponentに関しては、Componentのenableのみ編集可能となっています。

• [Connect To] : 接続先のデバイスを選択します。 Profilerと共有しています。
• [Add Component] : GameObjectにComponentを追加します。(未実装)

UnityEngine.Application

Application Classのstaticメンバーに関する内容を確認することが出来ます。（編集は出来ません) また、Application.Quit()を実行することが可能です。

• [Pull] : Application Classのstaticメンバーを取得します。
• [Quit] : Application.Quite()を実行します。

UnityEngine.Android.Permisson

プラットフォームがAndroidの場合、パーミッションの内容を確認することが出来ます。（編集は出来ません)

• [Pull] : Android.Permissonのメンバーを取得します。

UnityEngine.Component

Scene上に存在するComponentの種類と数をカウントします。 本Editor拡張で未対応なComponentは規定Classにカウントします。

• [Analayze] : Player Hierarchyの情報からScene内のGameObjectに含まれているComponentを種類別にカウントします

UnityEngine.QualitySettings

QualitySettingの内容を確認することができます。（編集は出来ません)

• [Pull] : QualitySettingsのメンバーを取得します。

UnityEngine.Rendering.GraphicsSettings

GraphicsSettingsの内容を確認することができます。（編集は出来ません）

• [Pull] : GraphicsSettingsのメンバーを取得します。

UnityEngine.Rendering.OnDemandRendering

OnDemandRenderingのパラメーターの内容の表示と編集を行うことが可能です。

• [renderFrameInterval] : 現在のフレームレートの間隔を取得または設定します。Application.targetFrameRateまたはQualitySettings.vSyncCountの値にレンダリングを戻すには、これを0または1に設定します。

ScalableBufferManager

ScalableBufferManagerを編集することが出来ます。

• [Pull] : ScalableBufferManagerのパラメーターを取得します。

NOTE:この機能を使用する場合、下記の条件を満たしている必要があります。

• Project Settings -> Enable Frame Timing Statsにチェックを入れた状態でアプリケーションをビルドしている。
• CameraもしくはRenderTextureのAllow Dynamic Resolutionが有効になっている。
• プラットフォーム(及びGraphicドライバ)が下記のいずれかである
  • Xbox One
  • PS4
  • Nintendo Switch
  • iOS/tvOS (Metal のみ)
  • Android (Vulkan のみ)

UnityEngine.Screen

Screen Classのstaticメンバーに関する内容を編集することが出来ます。

• [Pull] : Screen Classのstaticメンバーを取得します。
• [Push] : 編集した内容を実機上に書き戻します。

UnityEngine.Shader

アプリケーションから参照されているShader及びResourcesに含まれるShaderの一覧を表示します。

• [Pull] : Scene上のGameObjectから参照及びResourcesに含まれるShaderの一覧を取得します。

※Materialが参照しているShaderを変更する場合は、事前にPullを実行しておく必要があります。

UnityEngine.SortingLayer

実機上のSortingLayer.layersを取得します。

• [Pull] : アプリケーションで使用されているSorting Layerの値を取得します。

※SpriteRendererのSortingLayerを変更する場合、事前にPULLを実行する必要があります。

UnityEngine.Sprite

実機で実行されているアプリのScene上から参照されているSprite及びResourcesに含まれるSpriteの一覧を表示します。

• [Pull] : アプリケーションで使用されているSpriteの一覧を取得します。

※SpriteRendererのSpriteを変更する場合事前にPullを実行する必要があります。

UnityEngine.SystemInfo

SystemInfoのメンバーの値を取得します。

• [Pull] : 実行中のアプリケーションからSystemInfoのメンバーの値を取得します。

UnityEngine.Texture

Scene内から参照されているTextureとResourcesに含まれているTextureの一覧表示します。

• [Pull] : Scene上のGameObjectから参照及びResourcesに含まれるTextureの一覧を取得します。

※Materialが参照しているTextureを変更する場合は、事前にPullを実行しておく必要があります。

UnityEngine.Time

Time Classのstaticメンバーに関する内容を編集することが出来ます。

• [Pull] : Time Classのstaticメンバーを取得します。
• [Push] : 編集した内容を実機上に書き戻します。

※編集可能なメンバーはRead Only以外のメンバーに限定されます。詳しくはスクリプトリファレンスをご確認下さい。

UnityEngine.Profiling.Profiler

UnityEngine.Profiling.ProfilerクラスのAPIを使用してMemory関連の情報を取得します。

• [Pull] : 実行中にのアプリケーションからMemory関連の情報を取得します。
• [Export Objects RuntimeMemory] : Resources.FindObjectsOfTypeAll(typeof(UnityEngine.Object)) で取得した全てのUnityEngine.Objectに対するProfiler.GetRuntimeMemorySizeLongの結果をCSV形式で出力します。

FAQ

UnityPlayerSyncとUnityChoseKunの違いを教えて下さい。

UnityChoseKunはアプリケーション上のHierarchyの情報及び必要最低限のComponentの情報を取得し、その情報をアプリケーションへダイレクトに反映し、UnityPlayerSyncはアプリケーションのHierarchyをUnityEditor上にそのまま再現し、変更された内容をアプリケーションに反映します。 その為、UnityPlayerSyncはUnityChoseKunよりも得られる情報量が多い一方、アプリケーションとUnityEditorの同期にかかる時間はUnityChoseKunの方が短くなっています。

例えば、アプリケーションのパラメーターを調整してパフォーマンスチューニングや見た目の調整を行うような用途であればUnityChoseKunが適しています。 一方、UnityPlayerSyncは通常のUnityEditorのワークフローと殆ど変わらないGUIで操作することが出来る為、エンジニア以外のクリエーターでも直観的に操作が出来るというメリットがあります。

その他

• 要望・ご意見・不具合に関してはIssueから報告をお願いします。約束は出来ませんが可能な限り対応します。
• 不具合報告に関してはそれを再現する為のプロジェクトの添付及び再現手順などの記述をお願いします。こちらで再現が取れない場合、対応出来ない場合があります。