
Security News
Open Source Maintainers Feeling the Weight of the EU’s Cyber Resilience Act
The EU Cyber Resilience Act is prompting compliance requests that open source maintainers may not be obligated or equipped to handle.
@web-unity-bridge/core
Advanced tools
@web-unity-bridge/core is a JavaScript library designed to integrate Unity games and experiences seamlessly into web environments. This library provides a structured way to load and interact with Unity instances within a web page, handling script loading,
@web-unity-bridge/core is a JavaScript library designed to integrate Unity games and experiences seamlessly into web environments. This library provides a structured way to load and interact with Unity instances within a web page, handling script loading, canvas rendering, and event management.
This project was inspired by the react-unity-webgl library, which facilitates the integration of Unity with React applications. We have adapted and extended its principles to create a more tailored solution for our specific use cases in web environments.
npm install @web-unity-bridge/core
To use @web-unity-bridge/core, follow these steps:
Create a configuration object for your Unity instance specifying necessary parameters like the path to the Unity build.
const unityConfig = {
loaderUrl: "Build/unity.loader.js",
dataUrl: "Build/unity.data",
frameworkUrl: "Build/unity.framework.js",
codeUrl: "Build/unity.wasm",
};
Instantiate UnityMethod with a target HTML element and the Unity configuration.
import BridgeCore from '@web-unity-bridge/core';
const unityContainer = document.getElementById("unity-div");
const bridgeCore = new BridgeCore(unityContainer, unityConfig);
Add event listeners to handle custom events or loading progress.
bridgeCore.statusAddEventListener("loaded", () => {
console.log("Unity loaded successfully!");
});
bridgeCore.statusAddEventListener("progress", (progress) => {
console.log(`Loading progress: ${progress}%`);
});
Use the provided methods to interact with the Unity instance as needed.
// Example method to start a game
function startGame() {
bridgeCore.unityInstance.SendMessage('GameManager', 'Start');
}
To dispatch events, the module provides a global function called dispatchUnityWebGLEvent
. This function accepts the event name and parameters as arguments, and it will dispatch the event to the appropriate Unity context.
bridge.addEventListener({
eventName: 'SetScore',
callback: (score) => {
console.log('SetScore>>', score);
},
});
Example: Dispatching an event from a JSLib
mergeInto(LibraryManager.library, {
SetScore: function (score) {
try {
window.dispatchUnityWebGLEvent("SetScore", score);
} catch (e) {
console.warn("Failed to dispatch event");
}
},
});
Contributions are welcome! Feel free to open issues or submit pull requests on our GitHub repository.
This project is licensed under the MIT License - see the LICENSE file for details.
FAQs
@web-unity-bridge/core is a JavaScript library designed to integrate Unity games and experiences seamlessly into web environments. This library provides a structured way to load and interact with Unity instances within a web page, handling script loading,
The npm package @web-unity-bridge/core receives a total of 11 weekly downloads. As such, @web-unity-bridge/core popularity was classified as not popular.
We found that @web-unity-bridge/core demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The EU Cyber Resilience Act is prompting compliance requests that open source maintainers may not be obligated or equipped to handle.
Security News
Crates.io adds Trusted Publishing support, enabling secure GitHub Actions-based crate releases without long-lived API tokens.
Research
/Security News
Undocumented protestware found in 28 npm packages disrupts UI for Russian-language users visiting Russian and Belarusian domains.