Vision Pro/Unity/Poly Spatial开发笔记整理【四】（打包工具）_xcode打包app到vision os

作者：从前慢现在也慢 | 2024-08-03 22:10:47

踩

xcode打包app到vision os

打包工具

在多次打包尝试中，不断的切换打包名称和打包类型成了一件很麻烦的事情，而且还要区分类型进行文件夹管理，于是就诞生了写一个打包工具的想法。
打包工具截图

具体步骤

获取Vision OS Settings配置
根据当前配置设置打包的场景
设置打包输出文件夹类型

关键步骤：获取打包平台配置

`VisionOSSettings`

成员类型	成员名称	描述	作用
字段	k_SettingsKey	用于存储和检索`VisionOSSettings`实例的键。	用于在Player设置中保存和加载配置数据。
字段	k_HandTrackingUsageTooltip	手部追踪用途描述的提示信息。	用于在请求手部追踪授权时向用户展示的描述信息。
字段	k_WorldSensingUsageTooltip	世界感知用途描述的提示信息。	用于在请求世界感知授权时向用户展示的描述信息。
枚举	AppMode	定义应用程序的模式：虚拟现实（`VR`）、混合现实（`MR`）或窗口化（`Windowed`）。	用于设置应用程序的初始模式。
字段	m_AppMode	应用程序的初始模式。	用于获取或设置应用程序的初始模式。
字段	m_HandsTrackingUsageDescription	手部追踪用途的描述。	用于提供手部追踪用途的描述，将添加到生成的visionOS Player Xcode项目的Info.plist文件中。
字段	m_WorldSensingUsageDescription	世界感知用途的描述。	用于提供世界感知用途的描述，将添加到生成的visionOS Player Xcode项目的Info.plist文件中。
属性	appMode	获取或设置应用程序的模式。	用于获取或设置`m_AppMode`字段的值。
属性	handsTrackingUsageDescription	获取或设置手部追踪用途的描述。	用于获取或设置`m_HandsTrackingUsageDescription`字段的值。
属性	worldSensingUsageDescription	获取或设置世界感知用途的描述。	用于获取或设置`m_WorldSensingUsageDescription`字段的值。
方法	GetOrCreateSettings	获取当前选中的设置，或者如果没有设置则创建默认设置。	用于获取或创建`VisionOSSettings`实例。
属性	currentSettings	获取或设置用于Player构建的`VisionOSSettings`。	用于获取或设置当前的`VisionOSSettings`实例。
方法	TrySelect	尝试选择当前的`VisionOSSettings`实例。	用于将当前的`VisionOSSettings`实例设置为活动对象。
方法	GetSerializedSettings	获取`VisionOSSettings`的序列化对象。	用于创建`VisionOSSettings`实例的`SerializedObject`。

这个文件是通过Package Manager的Add Package By Name导入com.unity.polyspatial才会出现，文件位置是："Assets/XR/Settings/VisionOSSettings.asset"，。

读取`VisionOSSettings`方法

以下是读取配置文件的代码：

/// <summary>
/// 加载关于VisionOS的配置参数
/// </summary>
private void LoadSettings()
{
	var configPath = "Assets/XR/Settings/VisionOSSettings.asset";
	_visionOSSettings = AssetDatabase.LoadAssetAtPath<VisionOSSettings>(configPath);
}
1
2
3
4
5
6
7
8

获取当前打包的版本

这段代码提供了一个下拉菜单，让开发者在Unity编辑器中选择VisionOS项目的构建类型：实机（Device）或模拟器（Simulator）。选择结果会更新项目的构建设置，确保生成的应用适配目标平台。

PlayerSettings.VisionOS.sdkVersion =
            (VisionOSSdkVersion)EditorGUILayout.EnumPopup(PlayerSettings.VisionOS.sdkVersion);
1
2

以及选择的版本的枚举类型：

/// <summary>
///   <para>支持的VisionOS SDK版本</para>
/// </summary>
public enum VisionOSSdkVersion
{
    /// <summary>
    ///   <para>设备SDK</para>
    /// </summary>
    Device,
    /// <summary>
    ///   <para>模拟器SDK</para>
    /// </summary>
    Simulator,
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

根据当前配置设置打包的场景

InitBuildScenes用于初始化场景的默认列表，DrawSceneOptions在编辑器中提供界面让用户自定义每个场景的构建配置并保存。

/// <summary>
/// 初始化构建项目的参数
/// </summary>
private void InitBuildScenes()
{
	_sceneConfigs = new Dictionary<string, VisionOSSettings.AppMode>();
	foreach (var editorBuildSettingsScene in EditorBuildSettings.scenes)
		_sceneConfigs.Add(editorBuildSettingsScene.path, VisionOSSettings.AppMode.MR);
}

/// <summary>
/// 绘制所有场景的配置项
/// </summary>
private void DrawSceneOptions()
{
	GUILayout.Space(5f);
	GUILayout.Label("场景类型配置选择：");

	GUILayout.BeginVertical("HelpBox");

	for (int i = 0; i < EditorBuildSettings.scenes.Length; i++)
	{
		var editorBuildSetting = EditorBuildSettings.scenes[i];
		GUILayout.BeginHorizontal();
		GUILayout.Label(editorBuildSetting.path, GUILayout.Width(250f));
			_sceneConfigs[editorBuildSetting.path] =
                (VisionOSSettings.AppMode)EditorGUILayout.EnumPopup(_sceneConfigs[editorBuildSetting.path]);
		GUILayout.EndHorizontal();
	}

	GUILayout.EndVertical();
	if (GUILayout.Button("保存配置")) SaveLocalData();
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

开始打包Xcode工程输出到指定目录

这段代码用于构建VisionOS项目，通过选择匹配的场景并指定输出路径。OnClickBuildVisionOSProject触发构建流程，GetEnabledScenes获取要包含的场景。



/// <summary>
/// 点击构建VisionOS项目
/// </summary>
private void OnClickBuildVisionOSProject()
{
	_outputXcodeProject =
	$"{_outputPath}/{_visionOSAppMode}/{PlayerSettings.VisionOS.sdkVersion}/{DateTime.Now:yyMMddHHmm}";

	if (!Directory.Exists(_outputXcodeProject))
		Directory.CreateDirectory(_outputXcodeProject);

	var scenes = GetEnabledScenes();
	if (scenes.Length == 0) _exceptionMessage = "没有满足条件的场景";

	var buildXcodeProjectPath = Path.Combine(_outputXcodeProject, "");

	if (!string.IsNullOrEmpty(_exceptionMessage)) return;

	var result = BuildPipeline.BuildPlayer(new BuildPlayerOptions
	{
		scenes = scenes,
		locationPathName = buildXcodeProjectPath,
		target = BuildTarget.VisionOS,
		options = BuildOptions.None
	});
}


/// <summary>
/// 获取当前已激活场景
/// </summary>
/// <returns>符合当前打包模式的场景列表</returns>
private string[] GetEnabledScenes()
{
	var scenes = new List<string>();
	for (var i = 0; i < EditorBuildSettings.scenes.Length; i++)
	{
		var scenePath = EditorBuildSettings.scenes[i].path;
		if (_sceneConfigs[scenePath] == _visionOSAppMode)
			scenes.Add(scenePath);
	}

	return scenes.ToArray();
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

完整代码

using System;
using System.Collections.Generic;
using System.IO;
using Newtonsoft.Json;
using Unity.VisualScripting;
using UnityEditor;
using UnityEditor.XR.VisionOS;
using UnityEngine;
using UnityEngine.XR;

public class VisionProBuildingWindow : EditorWindow
{
    private VisionOSSettings _visionOSSettings;

    private VisionOSSettings.AppMode _visionOSAppMode;

    private string _outputPath, _outputXcodeProject;

    private Dictionary<string, VisionOSSettings.AppMode> _sceneConfigs;

    private string[] _editorBuildSettingsScenes;

    private string _exceptionMessage;

    [MenuItem("Window/Tools/VisionProBuildingWindow")]
    private static void ShowWindow()
    {
        var window = GetWindow(typeof(VisionProBuildingWindow));
        window.titleContent = new GUIContent("设置VisionOS导出选项");
    }

    private void Awake()
    {
        InitWindowData();
        LoadSettings();
    }

    private void InitWindowData()
    {
        InitLocalData();
        InitOutputParams();
    }

    private void InitOutputParams()
    {
        _outputPath = $"{Application.dataPath.Replace("/Assets", "")}/Out";
    }


    /// <summary>
    /// 初始化本地存储的配置数据
    /// </summary>
    private void InitLocalData()
    {
        var data = EditorPrefs.GetString($"{nameof(VisionProBuildingWindow)}.EnableScene");
        if (string.IsNullOrEmpty(data)) InitBuildScenes();
        else _sceneConfigs = JsonConvert.DeserializeObject<Dictionary<string, VisionOSSettings.AppMode>>(data);
    }


    /// <summary>
    /// 初始化构建项目的参数
    /// </summary>
    private void InitBuildScenes()
    {
        _sceneConfigs = new Dictionary<string, VisionOSSettings.AppMode>();
        foreach (var editorBuildSettingsScene in EditorBuildSettings.scenes)
            _sceneConfigs.Add(editorBuildSettingsScene.path, VisionOSSettings.AppMode.MR);
    }

    /// <summary>
    /// 保存本地存储的配置数据
    /// </summary>
    private void SaveLocalData()
    {
        EditorPrefs.SetString(
            $"{nameof(VisionProBuildingWindow)}.EnableScene",
            JsonConvert.SerializeObject(_sceneConfigs));
    }

    private void OnFocus()
    {
        InitWindowData();
    }

    /// <summary>
    /// 加载关于VisionOS的配置参数
    /// </summary>
    private void LoadSettings()
    {
        var configPath = "Assets/XR/Settings/VisionOSSettings.asset";
        _visionOSSettings = AssetDatabase.LoadAssetAtPath<VisionOSSettings>(configPath);
    }

    /// <summary>
    /// 切换当前VisionOS打包显示类型
    /// </summary>
    /// <param name="appMode">1=VR,2=MR,3=Windowed</param>
    private void SwitchVisionOSMode(VisionOSSettings.AppMode appMode)
    {
        if (_visionOSSettings == null) return;
        if (_visionOSSettings.appMode == appMode) return;
        _visionOSSettings.appMode = appMode;
        EditorUtility.SetDirty(_visionOSSettings);
        AssetDatabase.SaveAssetIfDirty(_visionOSSettings);
    }

    private void OnGUI()
    {
        DrawProjectOptions();
        DrawSceneOptions();
        DrawBuildOptions();
    }

    /// <summary>
    /// 绘制项目的
    /// </summary>
    private void DrawProjectOptions()
    {
        GUILayout.BeginHorizontal();
        GUILayout.Label("当前选择的打包类型", GUILayout.Width(150f));
        PlayerSettings.VisionOS.sdkVersion =
            (VisionOSSdkVersion)EditorGUILayout.EnumPopup(PlayerSettings.VisionOS.sdkVersion);
        GUILayout.EndHorizontal();

        GUILayout.BeginHorizontal();
        GUILayout.Label("当前输出的打包路径", GUILayout.Width(150f));
        GUILayout.Label(_outputXcodeProject);
        GUILayout.EndHorizontal();

        GUILayout.BeginHorizontal();
        GUILayout.Label("当前选中的打包模式", GUILayout.Width(150f));
        _visionOSAppMode = (VisionOSSettings.AppMode)EditorGUILayout.EnumPopup(_visionOSAppMode);
        SwitchVisionOSMode(_visionOSAppMode);
        GUILayout.EndHorizontal();
    }

    /// <summary>
    /// 绘制所有场景的配置项
    /// </summary>
    private void DrawSceneOptions()
    {
        GUILayout.Space(5f);
        GUILayout.Label("场景类型配置选择：");

        GUILayout.BeginVertical("HelpBox");

        for (int i = 0; i < EditorBuildSettings.scenes.Length; i++)
        {
            var editorBuildSetting = EditorBuildSettings.scenes[i];
            GUILayout.BeginHorizontal();
            GUILayout.Label(editorBuildSetting.path, GUILayout.Width(250f));
            _sceneConfigs[editorBuildSetting.path] =
                (VisionOSSettings.AppMode)EditorGUILayout.EnumPopup(_sceneConfigs[editorBuildSetting.path]);
            GUILayout.EndHorizontal();
        }

        GUILayout.EndVertical();

        if (GUILayout.Button("保存配置")) SaveLocalData();
    }

    /// <summary>
    /// 绘制Build参数选项和按钮
    /// </summary>
    private void DrawBuildOptions()
    {
        GUILayout.Space(5f);
        GUILayout.BeginHorizontal();
        GUILayout.FlexibleSpace();
        if (GUILayout.Button("开始创建工程", GUILayout.Width(200f), GUILayout.Height(60f)))
            OnClickBuildVisionOSProject();

        GUILayout.FlexibleSpace();
        GUILayout.EndHorizontal();

        if (string.IsNullOrEmpty(_exceptionMessage))
            return;
        GUILayout.BeginHorizontal("HelpBox");
        GUILayout.Label($"{_exceptionMessage}");
        GUILayout.EndHorizontal();
    }

    /// <summary>
    /// 点击构建VisionOS项目
    /// </summary>
    private void OnClickBuildVisionOSProject()
    {
        _outputXcodeProject =
            $"{_outputPath}/{_visionOSAppMode}/{PlayerSettings.VisionOS.sdkVersion}/{DateTime.Now:yyMMddHHmm}";

        if (!Directory.Exists(_outputXcodeProject))
            Directory.CreateDirectory(_outputXcodeProject);

        var scenes = GetEnabledScenes();
        if (scenes.Length == 0) _exceptionMessage = "没有满足条件的场景";

        var buildXcodeProjectPath = Path.Combine(_outputXcodeProject, "");

        if (!string.IsNullOrEmpty(_exceptionMessage)) return;

        var result = BuildPipeline.BuildPlayer(new BuildPlayerOptions
        {
            scenes = scenes,
            locationPathName = buildXcodeProjectPath,
            target = BuildTarget.VisionOS,
            options = BuildOptions.None
        });
    }


    /// <summary>
    /// 获取当前已激活场景
    /// </summary>
    /// <returns>符合当前打包模式的场景列表</returns>
    private string[] GetEnabledScenes()
    {
        var scenes = new List<string>();
        for (var i = 0; i < EditorBuildSettings.scenes.Length; i++)
        {
            var scenePath = EditorBuildSettings.scenes[i].path;
            if (_sceneConfigs[scenePath] == _visionOSAppMode)
                scenes.Add(scenePath);
        }

        return scenes.ToArray();
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/从前慢现在也慢/article/detail/925114