styly-dev / styly-spatial-layer-plugin Goto Github PK

View Code? Open in Web Editor NEW

9.0 5.0 1.0 21.69 MB

Unity plugin to upload your contents to Vision Pro via STYLY

Home Page: https://apps.apple.com/us/app/styly-for-vision-pro/id6475184828

License: MIT License

C# 100.00%

unity unity3d vision-pro visionos styly

styly-spatial-layer-plugin's Introduction

STYLY Spatial Layer Plugin for Vision Pro

What is this plugin?

You can upload your Unity contents to STYLY for Vision Pro.

Notes

Contents of STYLY for Vision Pro is not compatible with STYLY for other platforms. Its code base is different from STYLY VR or STYLY mobile.
STYLY for Vision Pro doesn't have 3D contents creation tools for now.
Please give us your feedback on Github Issues.
Your contents will be published to the PUBLIC. Don't upload your contents which you want make private.
Contents gallery on STYLY app is white list based now. STYLY team may pick up your contents display in the app.

Requirements

Unity
- Unity 2022.3.27 or later (Use 2022.3.XX)
- Modules:
  - visionOS Build Support
- Render pipelines: URP
- Color Space: Linear
Xcode (if you want to test with visionOS simulator)
- Xcode 15.2 or later
- Apple Silicon Mac (M1/M2/M3)

Supported features for STYLY visionOS Plugin

Mixed Reality mode: Bounded Volumes, Unbounded Volumes
Standard URP shaders: Lit, Simple Lit, Unlit and some shaders in supported Unity packages
Visual Scripting
Timeline, animator, animation, audioclip and other basic features. See Supported Unity Features and Components page for the detail.

NOT Supported features for STYLY visionOS Plugin

Fully Immersive VR, Windowed Apps
Your C# scripts
Custom shaders
Visual Effect Graph
Postprocessing Stack

Supported Visual Scripting Unity packages

VRM Visual Scripting Nodes
glTFast Visual Scripting Nodes
Spectrum Visual Scripting Nodes
WebRequest Visual Scripting Nodes
STYLY-XR-Rig

You are moe than welcome to recommend new custom Visual Scripting nodes to support.

How to setup

Unity

Install Unity via Unity Hub
- Install Unity 2022.3.27 or later (Use 2022.3.XX) with modules:
  - visionOS Build Support

Setup Unity project

Option A (Easiest & recommended): Download Unity Template Project including STYLY visionOS Plugin and supported packages
Option B (for existing project): Use OpenUPM .
- Prerequisites : Node.js 14.18 or above

    # Install openupm-cli
    npm install -g openupm-cli

    # Go to your unity project directory
    cd YOUR_UNITY_PROJECT_DIR

    # Install STYLY plugin for Unity
    openupm add -f com.styly.styly-spatial-layer-plugin
    # Install supported packages for STYLY
    openupm add -f com.styly.package-collection-spatial-layer

Xcode

Install Xcode 15.2 or later with visionOS simulator. Xcodes is the easiest way to install and manage multiple versions of Xcode.
Open Simulator from Xcode menu. ClickXcode -Open Developer Tool -Simulator
Open Vision Pro simulator from menu. ClickFile -Open Simulator -visionOS 1.0 -Apple Vision Pro

Install STYLY for Vision Pro into the visionOS simulator

Install STYLY for visionOS into the simulator
- Download STYLY-Vision-OS-App.app and drag the app file to the simulator window from Finder.

How to build and upload contents

Unity prefab can be built and uploaded to STYLY. Right click a prefab in a project window and select STYLY - Build Content FIle

Built file will be created as yyyyMMddHHmmss.styly in _Output directory in your project.

STYLY for visionOS webpage will be opened in a browser. Login with your STYLY account.

Upload your built contents (.styly file) with its title, description and display type.

Bounded: Your contents will be displayed in 1m x 1m x 1m size. Contents can be displayed with other apps.
Unbounded: Your contents will be displayed exclusively in a space.

How to play the contents on STYLY

Open content page on visionOS simulator. You can copy and paste your URL of the content from your Mac to the simulator.
Click Play on device on the page.
Your content will be displayed.

styly-spatial-layer-plugin's People

Contributors

Stargazers

Watchers

Forkers

scs-yasu

styly-spatial-layer-plugin's Issues

Package and Configuration management system

I'll make a Configuration management system which handles

Constant string such as Package name of this plugin
Scripting Define Symbols to add when this package is installed

Image tracking sample creation

Change version info of STYLY Plugin player settings

Hand gesture sample

Node using Hand pose asset file or shape asset file and recognize hand gestures.

Implement on another repository.

Cannot create a prefab in Object Interaction sample

STYLY-Vision-OS-App Crashes on Launch Due to DYLD_ROOT_PATH Not Set

I am encountering an issue when trying to launch the STYLY-Vision-OS-App after downloading it. The app crashes immediately with the following error:

Termination Reason: DYLD 9 
DYLD_ROOT_PATH not set for simulator program

Crash Report:

Incident Identifier: 92FD2D73-1EE2-49E7-9929-D48B33419591
CrashReporter Key:   768FC28F-811B-033A-E55A-29FAD6C46EE9
Hardware Model:      Mac14,9
Process:             STYLY-Vision-OS-App [73570]
Path:                /Volumes/VOLUME/*/STYLY-Vision-OS-App.app/STYLY-Vision-OS-App
Identifier:          com.styly.STYLY-Vision-OS-App
Version:             1.0.12 (0)
Code Type:           ARM-64 (Native)
Role:                Default
Parent Process:      launchd [1]
Coalition:           com.styly.STYLY-Vision-OS-App [78480]

Date/Time:           2024-05-17 22:44:56.6344 +0900
Launch Time:         2024-05-17 22:44:56.5693 +0900
OS Version:          macOS 14.4.1 (23E224)
Release Type:        User
Report Version:      104

Exception Type:  EXC_CRASH (SIGABRT)
Exception Codes: 0x0000000000000000, 0x0000000000000000
Termination Reason: DYLD 9 
DYLD_ROOT_PATH not set for simulator program

Triggered by Thread:  0

Thread 0 Crashed:
0   dyld                          	       0x1008e5a50 __abort_with_payload + 8
1   dyld                          	       0x1008f0628 abort_with_payload_wrapper_internal + 104
2   dyld                          	       0x1008f065c abort_with_payload + 16
3   dyld                          	       0x1008826b0 dyld4::halt(char const*, dyld4::StructuredError const*) + 304
4   dyld                          	       0x10087f31c dyld4::prepare(dyld4::APIs&, dyld3::MachOAnalyzer const*) + 4084
5   dyld                          	       0x10087dedc start + 1844

Steps to Reproduce:

Download the STYLY-Vision-OS-App.
Attempt to open the app from the Downloads folder.
System Information:

Model: MacBook Pro (Mac14,9)
Processor: Apple M2 Pro
macOS Version: 14.4.1 (23E224)
App Version: 1.0.12 (0)
Additional Notes:

It appears the app is failing to launch because the DYLD_ROOT_PATH environment variable is not set, which is required for the simulator program. Any guidance on how to resolve this issue would be appreciated.

Add OpenXR to Plugin Template

Hand tracking sample for creators

Conflicts between UniVRM and glTFast

Refer to this information to fix.
https://qiita.com/liveasnotes/items/e09226c7af7a8008dd91

Project Settings > Player > Other Settings > Script Compilation > Scripting Define Symbols
UNIGLTF_DISABLE_DEFAULT_GLTF_IMPORTER
UNIGLTF_DISABLE_DEFAULT_GLB_IMPORTER

@afjk I think we need to add this Define Symbols into this plugin project and also the app project.

Image tracking VisualScripting graph sample

[Plugin] Stop creating .styly in case of error

Pre-check

OS ( Mac only )
Unity Version (2023.3.x)
Unity Module installed (Vision OS and iOS)

Execution Error

Build AssetBundle Failed.

Ideal implementation

show error
do not create .styly fie

Plugin: Show build error message

Slack thread
https://psychicvrlab.slack.com/archives/C06DEGRAVNF/p1709996972261519

こちらの.stylyファイルをアップロードすると500エラーが出るようです。バリデーションエラーだと思いますが、一応共有。エラーメッセージ表示の対応が必要ですね。

こちらアップロードすると同事象発生します
https://drive.google.com/file/d/1HHAnltuRS2KDKk3EuBy_L7Fw0j5MB5_4/view?usp=sharing
こちらが使っていたUnityEditor拡張スクリプトです
https://drive.google.com/file/d/1E6c7hw3aq9G0K8p4XadttlLnj1mM2Vo2/view?usp=sharing
一応アップロードした元のPrefabも
https://drive.google.com/file/d/13EgzZ345CVzhfssVhPeun_JATILFSD4q/view?usp=sharing

Video sample for creators

Add sample of video player

Update README

I'll add the following to the README.md

Installation with

OpenUPM
GUI using git URL

Create STYLY-XR-Rig compatible with XR Interaction Toolkit

Delete "Test Variable Utility" item from menu.

Change Repository and Package name

We'll change the names

https://github.com/styly-dev/STYLY-visionOS-Plugin
=>
https://github.com/styly-dev/STYLY-Spatial-Layer-Plugin

com.styly.styly-vision-os-plugin
=>
com.styly.styly-spatial-layer-plugin

Script graph file, Embedded script graph Subgraph in samples

Add bounded sample

Evinronment mesh VisualScripting graph creation

Environment mesh sample for creators

check if Intel mac can be used for content creation

Templete project management

We better provide the template project including the STYLY-visionOS-Plugin and the supported plugins.
The benefit of the template is that creator doesn't need to use OpenUPM to install those plugins.

In order to manage the template, using this repository as the template would be a good option.

I'll add a script to

Detect the downloaded project is from a zip at release page or from git clone.
If the project is from the zip, delete the files in the packages directory and add package name to the manifest.json
Check .git directory existence to determine the files are downloaded via the zip or the git clone method.
The script should be executed only at the first time of the project load.

Hand tracking VisualScripting graph creation

Package name should be used via a constant

@afjk
string value com.psychicvrlab.styly-vision-os-plugin is directly used in source codes, but it should be defined once and should be used as the constant.

Preload Audio Data needs to be checked on AudioClip

Preload Audio Data needs to be checked on AudioClip.

Unity: 2023.3.26f1
STYLY Vision OS Plugin: 0.1.7
PolySpatial: 1.1.6

We need to consider implementing preprocessing code to check Preload Audio Data on each AudioClip automatically.

Check ExportPackageOptions.Recurse is needed?

ExportPackageOptions.Recurse

Code
https://github.com/styly-dev/STYLY-visionOS-Plugin/blob/f5453d1490518805ef0e0488893eb020bfed7828/Packages/com.styly.styly-vision-os-plugin/Editor/Utility/ExportBackupFileUtility.cs#L22

https://docs.unity3d.com/2022.3/Documentation/ScriptReference/ExportPackageOptions.html

https://docs.unity3d.com/2022.3/Documentation/ScriptReference/AssetDatabase.ExportPackage.html

Install STYLY-XR-Rig from right click menu

GitHub Action to add supported package list to README

Instead of managing them manually, it's better to implement a GitHub action to show supported package list on README.

Read manifest.json to get a version number of com.styly.package-collection-spatial-layer
Read list of package.json of com.styly.package-collection-spatial-layer
Add the list to README
Also add PolySpatial version

Dependency package list of the package can be retrieved from
https://package.openupm.com/com.styly.package-collection-spatial-layer

Videoplayer support for visionOS

I will implement a Videoplayer helper script to

make Videoplayer component available on visionOS.
check Videoplayer component uses RenderTexture on visionOS. Alert if not using RenderTexture.
call Unity.PolySpatial.PolySpatialObjectUtils.MarkDirty() for the RenderTexture if PolySpatial is installed.
cache a video file if the source is URL and WebRequest_VisualScriptingNodes package is installed.
~~Display the description of the script on the inspector, such as the feature of the visionOS support, caching feature etc.~~
~~Display fix button on the inspector to solve the requirement issues. ~~
~~Add RequireComponent to the script~~

The VideoPlayerHelper script is intended to be attached to the same Gameobject which has a VideoPlayer component.