Ultraleap Unity插件

GitHub

Ultraleap Unity插件使开发者能够使用Ultraleap的手部追踪技术构建Unity应用。它包含各种资产、示例和实用工具，使在XR项目中使用手部追踪设计和构建应用变得容易。

<div align="center"><br/>下载插件</div>	<div align="center"><br/>功能指南</div>	<div align="center"><br/>贡献</div>
安装Ultraleap Unity插件。	探索Ultraleap Unity插件的可用功能。	为开源仓库做出贡献，留下您的印记并帮助他人。

入门指南

要使用此插件，您需要以下内容：

最新的Ultraleap手势追踪软件。您可以在此处获取。
Ultraleap手势追踪摄像头 - 按照此处的步骤进行设置。
Unity 2021.3 LTS或更新版本。UnityPlugin包已经在2021.3 LTS和2022.3 LTS版本上测试通过。
按照下面列出的安装流程之一进行操作。

更详细的入门文档可在我们的网站上获取。

请注意：

由于Unity的包依赖关系不断变化，我们无法保证与每个插件或Unity变体的兼容性，但我们的目标是为Unity持续支持的任何LTS版本提供支持。
如果您直接从此仓库获取Unity插件，可能会发现它与早期版本的Unity不能很好地兼容。

安装

您可以通过多种方式使用此插件。我们为不同用户列出了几种推荐的工作流程。这个列表绝不是详尽无遗的。

OpenUPM（推荐）

这种工作流程是最简单的入门方式，并且使更新包变得简单。

如果您熟悉OpenUPM，请按照OpenUPM说明进行操作。

OpenUPM设置

每个Unity项目只需执行一次设置。在编辑 -> 项目设置 -> 包管理器中，添加一个新的作用域注册表，详细信息如下：

名称：Ultraleap
URL：https://package.openupm.com
作用域：com.ultraleap

作用域注册表.png

OpenUPM添加、升级或删除包

打开包管理器（窗口 -> 包管理器），在窗口左上角的下拉菜单中导航到"我的注册表"。

我的注册表.png

Ultraleap UPM包应该在列表中可见。点击您想要安装/修改的包。

注意：Ultraleap Tracking包含Core、Hands和Interaction Engine模块。有一些由第三方独立创建的旧包包含这些模块，但它们不再更新。

包列表.png

（可选）点击包时，它会自动选择最新版本。如果您想选择或更改为不同的版本，请点击包名称左侧的箭头，然后点击"查看所有版本"。

包版本.png

可以使用右下角的按钮安装或删除包。（如果包当前已安装，安装按钮将替换为"升级到<版本>"）

OpenUPM CLI

如果您更喜欢使用命令行界面来修改包或需要能够从终端执行操作（例如CI），那么您可能会发现OpenUPM CLI很有帮助。请参阅OpenUPM-CLI入门指南。

Unity包（传统方式）

您可以在这里找到Ultraleap Unity插件的.unitypackage发布版本，它们附加在每个发布版本中。

请注意，.unitypackage不处理包依赖关系或更新，因此只建议在您希望修改包时使用。

详细说明可在下面的折叠部分中找到。

<details> <summary> 传统.unitypackage </summary>

.unitypackage概述

.unitypackage文件是可用的传统消费方法，如果您更喜欢它或在以下情况下仍然有用：

需要修改包内容且
不打算升级到更新的版本

如果您不需要修改包内容，建议使用OpenUPM消费者工作流程。如果您需要修改并期望升级到更新版本，建议使用本地UPM包贡献者工作流程，因为它可以让您使用git对更改进行版本控制，并在升级时解决任何潜在的冲突。

添加.unitypackage

导入包（Assets -> Import Package -> Custom Package），可以从我们的Unity开发者网站或本仓库的发布部分下载。

升级.unitypackage

（可选）如果您对包进行了任何更改，您可能希望将这些更改保存到其他地方。
从Assets/ThirdParty/Ultraleap中删除您想要升级的包内容。
导入您希望更改的.unitypackage。

移除.unitypackage

从Assets/ThirdParty/Ultraleap中删除您想要移除的包。

</details>

贡献者工作流程

贡献者工作流程由UnityPlugin开发人员使用，并推荐给希望为源代码仓库做出贡献的社区成员。

<details> <summary> 本地UPM包 </summary>

本地UPM包概述

这个工作流程需要几个步骤来设置，使您能够：

在一个（或多个）Unity项目中修改UPM包内容。
使用git管理更改。
将更改贡献回远程仓库。

（注意）通过这种方法导入时需要Git LFS。

本地UPM包设置

克隆或子模块化仓库。
1. 仓库不应该被克隆/子模块化到Unity保留的项目文件夹中，即Assets、Library、ProjectSettings或Packages。建议创建另一个文件夹，如"LocalPackages"。
2. （注意）如果您不打算共享您的项目，并希望在多个Unity项目中使用相同的UPM包，那么克隆到您机器上的一个公共位置可能是理想的选择。

添加本地UPM包

您可以通过以下两种方式之一将仓库中的包添加到您的项目中：

（可共享）编辑您的项目manifest.json（Project/Packages/manifest.json），添加从Unity项目的Packages文件夹到仓库Packages文件夹中包的相对路径。有关更多信息，请参阅Unity手册。如果您已将仓库克隆到Unity项目内的LocalPackages中，以下是一个示例。
```
"com.ultraleap.tracking": "file:../LocalPackages/unityplugin/Packages/Tracking",
"com.ultraleap.tracking.preview": "file:../LocalPackages/unityplugin/Packages/Tracking Preview",
```
（不可共享）打开包管理器（Window -> Package Manager）并点击"从磁盘添加包…"。将其指向仓库Packages文件夹内所需的包。重复此操作以添加您想要本地引用的所有包。 这将使用您机器上的绝对文件路径，因此如果不修改路径以在新机器上工作，将不是可共享的解决方案。