Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/creativeikep/unicamex
UniCamEx is a virtual camera for MacOS that can display textures output from Unity.
https://github.com/creativeikep/unicamex
core-media-io macos system-extension unity virtual-camera
Last synced: 3 months ago
JSON representation
UniCamEx is a virtual camera for MacOS that can display textures output from Unity.
- Host: GitHub
- URL: https://github.com/creativeikep/unicamex
- Owner: creativeIKEP
- License: mit
- Created: 2023-05-31T12:07:48.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-21T11:59:24.000Z (9 months ago)
- Last Synced: 2024-10-08T18:07:04.094Z (3 months ago)
- Topics: core-media-io, macos, system-extension, unity, virtual-camera
- Language: Swift
- Homepage:
- Size: 988 KB
- Stars: 38
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# UniCamEx
UniCamEx is a virtual camera for MacOS that can display textures output from Unity.
You can use in macOS 12.3 and later because UniCamEx use Apple's [Camera Extension with Core Media I/O](https://developer.apple.com/documentation/coremediaio/creating_a_camera_extension_with_core_media_i_o).
## Usage
### Usage for Develop send textures from Unity Editor
This repository has the demo that send textures from Unity Editor.
Check a Unity [scene](https://github.com/creativeIKEP/UniCamEx/blob/v1.1.0/UniCamEx_Unity/Assets/Scenes/SampleScene.unity).
#### 1. Install
UniCamEx can be installed with Unity Package Manager.
UniCamEx can be installed from npm or GitHub URL.
##### Install from npm (Recommend)
UniCamEx can be installed by adding following sections to your manifest file (`Packages/manifest.json`).
To the `scopedRegistries` section:
```
{
"name": "creativeikep",
"url": "https://registry.npmjs.com",
"scopes": [ "jp.ikep" ]
}
```
To the `dependencies` section:
```
"jp.ikep.unicamex": "1.2.0"
```
Finally, the manifest file looks like below:
```
{
"scopedRegistries": [
{
"name": "creativeikep",
"url": "https://registry.npmjs.com",
"scopes": [ "jp.ikep" ]
}
],
"dependencies": {
"jp.ikep.unicamex": "1.2.0",
...
}
}
```
##### Install from GitHub URL
UniCamEx can be installed by adding below URL on the Unity Package Manager's window
```
https://github.com/creativeIKEP/UniCamEx.git?path=UniCamEx_Unity/Packages/UniCamEx#v1.2.0
```
or, adding below sentence to your manifest file(`Packages/manifest.json`) `dependencies` block. Example is below.
```
{
"dependencies": {
"jp.ikep.unicamex": "https://github.com/creativeIKEP/UniCamEx.git?path=UniCamEx_Unity/Packages/UniCamEx#v1.2.0",
...
}
}
```
#### 2. Send textures from Unity Editor
You can send camera rendered images with adding a `UniCamExSender` component to camera in your scenes.
If you want to send any video, you can do so by directly using the `UniCamExPlugin` class.
Please refer to `UniCamExSender` class for usage instructions.
#### 3. Install an Auxiliary app for UniCamEx
Download `UniCamExExtensionInstaller.zip` for auxiliary app of UniCamEx from [release page](https://github.com/creativeIKEP/UniCamEx/releases/latest) and Open the zip file.
**Move `UniCamExExtensionInstaller.app` to `~/Applications` directory** and run `UniCamExExtensionInstaller.app`.
#### 4. Install UniCamEx Virtual Camera
Push `Install` button.
Allow using System Extension from the Mac setting if the dialog that blocked System Extension is displayed.
Then, you can select the camera named "UniCamEx" with any camera appication and can see textures output from Unity Editor！
### Usage for Build the Standalone App
You must enroll the [Apple Developer Program membership](https://developer.apple.com/programs/) for building the app used System Extension.
#### 1. Clone this repository
You must build UniCamEx project for embeding to your the Standalone App.
So, you need to clone this repository.
#### 2. Copy UniCamEx's Unity Package to Your Unity Project
Copy `UniCamEx/UniCamEx_Unity/Packages/UniCamEx` directory to `/Packages` directory.
#### 3. Build UniCamEx Xcode Project with Your Custom Configuration.
1. Open `UniCamEx/UniCamEx/UniCamEx.xcodeproj`.
2. Change to your custom Bundle Identifier in `Extension` target and the name of the App Groups in the `Extension` target.
The name of the App Groups in the `Extension` target must start with the Bundle Identifier in the `Extension` target.
Also, sign in with your Apple developer account.
3. Change to your custom configuration in `UniCamEx/UniCamEx/UniCamExConfig.swift`.
4. Set `Build Configuration` to `Release`, and build `Extension` and `UniCamExBundle` in targets.
#### 4. Integrate Your Custom Built Items to Unity.
1. Replace from `/Packages/UniCamEx/PostProcessData~/jp.ikep.UniCamEx.Extension.systemextension` to your built `.systemextension`.
2. Replace from `/Packages/UniCamEx/Plugins/macOS/UniCamExBundle.bundle` to your built `UniCamExBundle.bundle`.
3. Rewrite from `jp.ikep.UniCamEx.Extension.systemextension` to your built `.systemextension` file name in [`/Packages/UniCamEx/Scripts/Editor/MacXcodeProjPostProcess.cs`](https://github.com/creativeIKEP/UniCamEx/blob/v1.1.0/UniCamEx_Unity/Packages/UniCamEx/Scripts/Editor/MacXcodeProjPostProcess.cs#L11-L12) and [`/Packages/UniCamEx/PostProcessData~/PostprocessBuild.py`](https://github.com/creativeIKEP/UniCamEx/blob/v1.1.0/UniCamEx_Unity/Packages/UniCamEx/PostProcessData~/PostprocessBuild.py#L8-L9).
#### 5. Coding for Send textures from Unity
You can send camera rendered images with adding a `UniCamExSender` component to camera in your scenes.
Also, you can send textures using the `UniCamExPlugin.Send` method.
#### 6. Export Xcode Project with Unity
**Turn on "Create Xcode Project"** on the Build Settings window.
Also, **build from the "Clean Build..." button**.
Exporting Xcode Project can does the necessary settings for [Camera Extension with Core Media I/O](https://developer.apple.com/documentation/coremediaio/creating_a_camera_extension_with_core_media_i_o).
Necessary settings for [Camera Extension with Core Media I/O](https://developer.apple.com/documentation/coremediaio/creating_a_camera_extension_with_core_media_i_o) is set with post process build of UniCamEx.
Post process build of UniCamEx may not work if you did not build from the "Clean Build..." button.
#### 7. Build .app with Xcode
Open exported `.xcodeproj` file with Xcode and sign in with your Apple developer account.
You must enroll the [Apple Developer Program membership](https://developer.apple.com/programs/) for building the app used System Extension.
You can build an app after sign in with Apple developer account that enrolled Apple Developer Program membership.
#### 8. Run the Built App
**Move built app from build directory to `~/Applications` directory** and run your app.
Allow using System Extension from the Mac setting if the dialog that blocked System Extension is displayed.
Then, you can select virtual camera with any camera appication and can see textures output from your app made with Unity！
## Author
[IKEP](https://ikep.jp)
## LICENSE
Copyright (c) 2023 IKEP
[MIT](/LICENSE.md)
## Others
- UniCamEx implementation is inspired by article below and I referenced it. Thanks!
- https://qiita.com/fuziki/items/405c681a0cae702ad092