diff --git a/.gitignore b/.gitignore index 29dff36..5643868 100644 --- a/.gitignore +++ b/.gitignore @@ -11,6 +11,8 @@ UserSettings/ *.asmdef *.pdb *.mdb +!Samples/**/*.cs +!Samples/**/*.asmdef !Samples~/**/*.cs !Samples~/**/*.asmdef diff --git a/Documentation~/README_UI.md b/Documentation~/README_UI.md index a34d1f0..dd29f2c 100644 --- a/Documentation~/README_UI.md +++ b/Documentation~/README_UI.md @@ -4,9 +4,11 @@ ## Scenes +Import samples from Unity Package Manager before opening demo scenes. + ```text -Packages/xin.aisu.si-m1.face/Samples/SI-M1 Face Demo/Scenes/FaceModuleDemo.unity -Packages/xin.aisu.si-m1.face/Samples/Face Detection Demo/Scenes/FaceDetectionDemo.unity +Assets/Samples/AISU SI-M1 Face SDK/0.1.6/SI-M1 Face Demo/Scenes/FaceModuleDemo.unity +Assets/Samples/AISU SI-M1 Face SDK/0.1.6/Face Detection Demo/Scenes/FaceDetectionDemo.unity ``` ## SI-M1 Face Demo diff --git a/Documentation~/README_UI.zh-CN.md b/Documentation~/README_UI.zh-CN.md index ffa0c95..a7db7f9 100644 --- a/Documentation~/README_UI.zh-CN.md +++ b/Documentation~/README_UI.zh-CN.md @@ -4,9 +4,11 @@ English documentation: [README_UI.md](README_UI.md). ## 场景 +打开 Demo 场景前,先在 Unity Package Manager 中导入 Samples。 + ```text -Packages/xin.aisu.si-m1.face/Samples/SI-M1 Face Demo/Scenes/FaceModuleDemo.unity -Packages/xin.aisu.si-m1.face/Samples/Face Detection Demo/Scenes/FaceDetectionDemo.unity +Assets/Samples/AISU SI-M1 Face SDK/0.1.6/SI-M1 Face Demo/Scenes/FaceModuleDemo.unity +Assets/Samples/AISU SI-M1 Face SDK/0.1.6/Face Detection Demo/Scenes/FaceDetectionDemo.unity ``` ## SI-M1 Face Demo diff --git a/Documentation~/SDK_QuickStart.md b/Documentation~/SDK_QuickStart.md index 1425a39..7bb68d7 100644 --- a/Documentation~/SDK_QuickStart.md +++ b/Documentation~/SDK_QuickStart.md @@ -104,9 +104,11 @@ await manager.StopFaceOperationAsync(); ## 5. Samples -Sample scenes: +Import samples from Unity Package Manager, then open: ```text -Packages/xin.aisu.si-m1.face/Samples/SI-M1 Face Demo/Scenes/FaceModuleDemo.unity -Packages/xin.aisu.si-m1.face/Samples/Face Detection Demo/Scenes/FaceDetectionDemo.unity +Assets/Samples/AISU SI-M1 Face SDK/0.1.6/SI-M1 Face Demo/Scenes/FaceModuleDemo.unity +Assets/Samples/AISU SI-M1 Face SDK/0.1.6/Face Detection Demo/Scenes/FaceDetectionDemo.unity ``` + +Package scenes under `Packages/xin.aisu.si-m1.face/Samples` are read-only and should not be opened directly. diff --git a/Documentation~/SDK_QuickStart.zh-CN.md b/Documentation~/SDK_QuickStart.zh-CN.md index 87a7be2..1baf601 100644 --- a/Documentation~/SDK_QuickStart.zh-CN.md +++ b/Documentation~/SDK_QuickStart.zh-CN.md @@ -104,9 +104,11 @@ await manager.StopFaceOperationAsync(); ## 5. Samples -示例场景: +在 Unity Package Manager 中导入 Samples,然后打开: ```text -Packages/xin.aisu.si-m1.face/Samples/SI-M1 Face Demo/Scenes/FaceModuleDemo.unity -Packages/xin.aisu.si-m1.face/Samples/Face Detection Demo/Scenes/FaceDetectionDemo.unity +Assets/Samples/AISU SI-M1 Face SDK/0.1.6/SI-M1 Face Demo/Scenes/FaceModuleDemo.unity +Assets/Samples/AISU SI-M1 Face SDK/0.1.6/Face Detection Demo/Scenes/FaceDetectionDemo.unity ``` + +`Packages/xin.aisu.si-m1.face/Samples` 下的场景是只读包内容,不要直接打开。 diff --git a/README.md b/README.md index d1935fa..736dbb2 100644 --- a/README.md +++ b/README.md @@ -48,13 +48,15 @@ public sealed class FaceExample : MonoBehaviour ## Samples -Sample scenes are under: +Import samples from Unity Package Manager, then open the imported scenes under `Assets/Samples`. ```text -Packages/xin.aisu.si-m1.face/Samples/SI-M1 Face Demo/Scenes/FaceModuleDemo.unity -Packages/xin.aisu.si-m1.face/Samples/Face Detection Demo/Scenes/FaceDetectionDemo.unity +Assets/Samples/AISU SI-M1 Face SDK/0.1.6/SI-M1 Face Demo/Scenes/FaceModuleDemo.unity +Assets/Samples/AISU SI-M1 Face SDK/0.1.6/Face Detection Demo/Scenes/FaceDetectionDemo.unity ``` +Do not open sample scenes directly from `Packages/xin.aisu.si-m1.face/Samples`, because Git UPM package contents are read-only in Unity. + Use `SI-M1 Face Demo` for full SDK command testing. Use `Face Detection Demo` for a compact camera, serial, enrollment, verification, and user-list workflow. ## Documentation diff --git a/README.zh-CN.md b/README.zh-CN.md index d8434fb..82528cb 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -48,13 +48,15 @@ public sealed class FaceExample : MonoBehaviour ## Samples -示例场景路径: +在 Unity Package Manager 中导入 Samples,然后打开 `Assets/Samples` 下的场景。 ```text -Packages/xin.aisu.si-m1.face/Samples/SI-M1 Face Demo/Scenes/FaceModuleDemo.unity -Packages/xin.aisu.si-m1.face/Samples/Face Detection Demo/Scenes/FaceDetectionDemo.unity +Assets/Samples/AISU SI-M1 Face SDK/0.1.6/SI-M1 Face Demo/Scenes/FaceModuleDemo.unity +Assets/Samples/AISU SI-M1 Face SDK/0.1.6/Face Detection Demo/Scenes/FaceDetectionDemo.unity ``` +不要直接打开 `Packages/xin.aisu.si-m1.face/Samples` 下的示例场景,Git UPM 包内容在 Unity 中是只读的。 + `SI-M1 Face Demo` 用于完整 SDK 命令测试。`Face Detection Demo` 用于摄像头、串口、录入、识别和用户列表的最小流程测试。 ## 文档 diff --git a/package.json b/package.json index b7ea93a..2521aa7 100644 --- a/package.json +++ b/package.json @@ -14,5 +14,17 @@ "recognition", "serial", "unity" + ], + "samples": [ + { + "displayName": "SI-M1 Face Demo", + "description": "Full demo scene and UI for connecting, registering, recognizing, querying, deleting, and releasing the SI-M1 face module.", + "path": "Samples/SI-M1 Face Demo" + }, + { + "displayName": "Face Detection Demo", + "description": "Minimal camera preview, serial connection, enrollment, recognition, and user data test scene.", + "path": "Samples/Face Detection Demo" + } ] }