Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marinerer/unity-webgl
An easy solution for embedding Unity WebGL builds in webApp or Vue.js project, with two-way communication between your webApp and Unity. 🏣 在webApp 或 Vue.js 项目中嵌入 Unity WebGL，并支持通过API在 webApp 和 Unity 之间进行双向通信。
https://github.com/marinerer/unity-webgl
unity-player unity-web unity-web-player unity-webgl unity-webgl-build vue-unity vue-unity-webgl
Last synced: 3 days ago
JSON representation
An easy solution for embedding Unity WebGL builds in webApp or Vue.js project, with two-way communication between your webApp and Unity. 🏣 在webApp 或 Vue.js 项目中嵌入 Unity WebGL，并支持通过API在 webApp 和 Unity 之间进行双向通信。
- Host: GitHub
- URL: https://github.com/marinerer/unity-webgl
- Owner: Marinerer
- License: apache-2.0
- Created: 2021-11-23T11:43:32.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-25T11:38:31.000Z (24 days ago)
- Last Synced: 2025-01-08T19:08:29.096Z (10 days ago)
- Topics: unity-player, unity-web, unity-web-player, unity-webgl, unity-webgl-build, vue-unity, vue-unity-webgl
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/unity-webgl
- Size: 9.35 MB
- Stars: 146
- Watchers: 6
- Forks: 22
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# unity-webgl
[](https://www.npmjs.com/package/unity-webgl)
[](https://codecov.io/gh/Marinerer/unity-webgl)
[](https://github.com/Marinerer/unity-webgl/releases)
[](https://www.npmjs.com/package/unity-webgl)
[](https://bundlephobia.com/package/unity-webgl)
[](https://github.com/Marinerer/unity-webgl)
[ English | [中文](./README.zh_CN.md) ]
`unity-webgl` provides an easy solution for embedding `Unity WebGL` builds in your web applications, with two-way communication and interaction between your webApp and Unity application with advanced API's.
> 🚨 Reminder
>
> `v4.x` has been updated significantly and the API is not compatible with `v3.x` and earlier versions. For upgrades, please refer to [Changelogs](https://github.com/Marinerer/unity-webgl/wiki/Major-changes-in-v4)
Based on [react-unity-webgl](https://github.com/jeffreylanters/react-unity-webgl)
## Features
- 📦 Easy integration, framework-agnostic
- 📩 Bidirectional communication between WebApp and Unity
- ⏰ Comprehensive event handling mechanism
- 🧲 Built-in Vue components (vue2/3)
## Installation
**npm**
```bash
npm install unity-webgl
```
**Browser**
```html
```
## Quick Start
- [Live Demo](https://stackblitz.com/edit/unity-webgl-v4-demo)
- [vue3 Demo](https://stackblitz.com/edit/unity-webgl-v4-vue3-demo)
> 🚨 **Important:**
> Communication and interaction with the web application are only possible after the Unity instance is successfully created (when the `mounted` event is triggered).
> Recommended to include a loading progress bar when opening the page.
```javascript
import UnityWebgl from 'unity-webgl'
const unityContext = new UnityWebgl('#canvas', {
loaderUrl: 'path/to/unity.loader.js',
dataUrl: 'path/to/unity.data',
frameworkUrl: 'path/to/unity.framework.js',
codeUrl: 'path/to/unity.code',
})
unityContext
.on('progress', (progress) => console.log('Loaded: ', progress))
.on('mounted', () => {
// ⚠️ Unity instance created, ready for communication
unityContext.sendMessage('GameObject', 'ReceiveRole', 'Tanya')
})
// For Unity to call
unityContext.addUnityListener('gameStart', (msg) => {
console.log('from Unity : ', msg)
})
// window.dispatchUnityEvent('gameStart', '{score: 0}')
```
Vue Demo
```html
import UnityWebgl from 'unity-webgl'
import VueUnity from 'unity-webgl/vue'
const unityContext = new UnityWebgl({
loaderUrl: 'path/to/unity.loader.js',
dataUrl: 'path/to/unity.data',
frameworkUrl: 'path/to/unity.framework.js',
codeUrl: 'path/to/unity.code',
})
unityContext.addUnityListener('gameStart', (msg) => {
console.log('from Unity : ', msg)
})
```
## API
### Constructor
```typescript
new UnityWebgl(canvas: HTMLCanvasElement | string, config?:UnityConfig)
// or
const unityContext = new UnityWebgl(config: UnityConfig)
unityContext.create(canvas: HTMLCanvasElement | string)
```
- `canvas` : Render Unity canvas elements or selectors.
- `config` : Initializes the Unity application's configuration items.
#### config
Initializes the Unity application's configuration items.
| Property | Type | Description | Required |
| ------------------------ | ------- | -------------------------------------------------------------------------------------------------- | -------- |
| `loaderUrl` | string | Unity resource loader file | ✅ |
| `dataUrl` | string | File containing resource data and scenes | ✅ |
| `frameworkUrl` | string | File with runtime and plugin code | ✅ |
| `codeUrl` | string | WebAssembly binary file with native code | ✅ |
| `streamingAssetsUrl` | string | URL for streaming resources | Optional |
| `memoryUrl` | string | URL for generated framework files | Optional |
| `symbolsUrl` | string | URL for generated Unity code files | Optional |
| `companyName` | string | Metadata: Company name | Optional |
| `productName` | string | Metadata: Product name | Optional |
| `productVersion` | string | Metadata: Product version | Optional |
| `devicePixelRatio` | number | Canvas device pixel ratio. @see[devicePixelRatio][devicePixelRatio-url] | Optional |
| `matchWebGLToCanvasSize` | boolean | Disable automatic WebGL canvas size sync. @see[matchWebGLToCanvasSize][matchWebGLToCanvasSize-url] | Optional |
| `webglContextAttributes` | object | WebGL rendering context options. @see[WebGLRenderingContext][webglContextAttributes-url] | Optional |
[devicePixelRatio-url]: https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
[matchWebGLToCanvasSize-url]: https://issuetracker.unity3d.com/issues/webgl-builds-dont-allow-separate-control-on-canvas-render-buffer-size
[webglContextAttributes-url]: https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getContextAttributes
### Methods
**Instance methods :**
#### ⭐️ `create(canvas: HTMLCanvasElement | string): void;`
Create a Unity WebGL instance on the specified canvas.
- `canvas` : canvas element
```javascript
await unityContext.create('#canvas')
```
#### ⭐️ `unload(): Promise;`
Unload the Unity WebGL instance.
```javascript
await unityContext.unload()
```
#### ⭐️ `sendMessage(objectName: string, methodName: string, value?: any): this;`
Send a message to invoke a public method in the Unity scene.
- `objectName`: Object Name in Unity Scene
- `methodName`: Unity script method name
- `value`: Passed value
```javascript
unityContext.sendMessage('GameObject', 'gameStart', { role: 'Tanya' })
```
#### `requestPointerLock(): void;`
Request pointer lock on the Unity canvas.
#### `takeScreenshot(dataType?: string, quality?: any): string | undefined;`
Capture a screenshot of the Unity canvas.
- `dataType`: Type of image data
- `quality`: Image quality
```javascript
const screenshot = unityContext.takeScreenshot('image/jpeg', 0.92)
```
#### `setFullscreen(enabled: boolean): void;`
Toggle fullscreen mode.
```javascript
unityContext.setFullscreen(true)
```
**Event methods :**
#### `on(name: string, listener: EventListener, options?: { once?: boolean }): this;`
Register for listening events.
```javascript
unityContext.on('progress', (progress) => {
console.log('Progress:', progress)
})
```
#### `off(name: string, listener?: EventListener): this;`
Remove event listener.
```javascript
unityContext.off('progress', listener)
```
**Unity Communication methods :**
#### `addUnityListener(name: string, listener: EventListener, options?: { once?: boolean }): this;`
Register a specific listener for Unity to call.
```javascript
unityContext.addUnityListener('GameStarted', (level) => {
console.log('Game started at level:', level)
})
// then call it in Unity
window.dispatchUnityEvent('GameStarted', 3)
```
#### `removeUnityListener(name: string, listener?: EventListener): this;`
Remove registered listeners.
```javascript
unityContext.removeUnityListener('GameStarted', listener)
```
### `window.dispatchUnityEvent(name: string, ...args: any[])`
The way to dispatch a registered listener on the Unity side. (Calling JS methods in unity)
```javascript
window.dispatchUnityEvent('GameStarted', 3)
```
### Events
| Event Name | Description |
| --------------- | ---------------------------------------- |
| `beforeMount` | Triggered before Unity instance creation |
| `mounted` | Triggered after Unity instance creation |
| `beforeUnmount` | Triggered before Unity instance unload |
| `unmounted` | Triggered after Unity instance unload |
| `progress` | Unity resource loading progress |
| `error` | Error events |
| `debug` | Debug messages from Unity |
## Unity-JavaScript Communication
- [Unity Docs: Interaction with browser scripting](https://docs.unity3d.com/Manual/webgl-interactingwithbrowserscripting.html)
### 1. Call Unity script functions from JavaScript
```javascript
const unityContext = new UnityWebgl()
/**
* @param {string} objectName Name of an object in your scene.
* @param {string} methodName Public method name.
* @param {any} value Passed value.
*/
unityContext.sendMessage('GameObject', 'StartGame', { role: 'Tanya' })
```
### 2. Call JavaScript functions from Unity scripts
1. First register the listener for Unity to call via `addUnityListener` on the web side.
```javascript
unityContext.addUnityListener('gameStart', (level) => {
console.log('Game started at level:', level)
})
```
2. Add the registered `gameStart` method to your Unity project.
```javascript
// javascript_extend.jslib
mergeInto(LibraryManager.library, {
Hello: function () {
window.alert('Hello, world!')
},
GameStart: function (level) {
//window.alert(UTF8ToString(str));
window.dispatchUnityEvent('gameStart', UTF8ToString(level))
},
})
```
3. Call these functions in unity's `C#` scripts:
```csharp
using UnityEngine;
using System.Runtime.InteropServices;
public class WebGLPluginJS : MonoBehaviour
{
[DllImport("__Internal")]
public static extern void Hello();
[DllImport("__Internal")]
public static extern void GameStart(string level);
void Start()
{
Hello();
GameStart("2");
}
}
```
## Issues
- [Keyboard Input and Focus Handling](https://docs.unity3d.com/Manual/webgl-input.html)
- [Debug and troubleshoot Web builds](https://docs.unity3d.com/Manual/webgl-debugging.html)
- [Web performance considerations](https://docs.unity3d.com/Manual/webgl-performance.html)
## Contributing
Contributions are welcome! Please submit a [Pull Request](https://github.com/Marinerer/unity-webgl/pulls).
## License
Apache-2.0 License
## Support
For issues or questions, please file an issue on the [GitHub repository](https://github.com/Marinerer/unity-webgl).