npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

peacemaker-unity-react-sei-sdk

v1.0.3-beta

Published

A React component for integrating Unity WebGL with Sei blockchain

Downloads

114

Readme

Peacemaker Unity React SEI SDK

Peacemaker SDK integrates Unity WebGL with Sei blockchain. Enables initiating transactions from within Unity and receiving responses as callbacks.

Installation

Install the package using npm:

npm install peacemaker-unity-react-sei-sdk

Also make sure you have all the required peer dependencies installed:

npm install @sei-js/core @sei-js/react react react-dom react-unity-webgl

To effectively use the integration you also have to have a crypto wallet such as Compass installed as an extension in your browser.

Usage

React bindings

Import the Peacemaker component from the package and wrap your Unity scene in it. Pass paths to the Unity WebGL files as props (loaderUrl, frameworkUrl, codeUrl, dataUrl).

import { Peacemaker } from 'peacemaker-unity-react-sei-sdk';

export default function App() {
    return (
        <Peacemaker
            loaderUrl="unity/Build/Build.loader.js"
            dataUrl="unity/Build/Build.data"
            frameworkUrl="unity/Build/Build.framework.js"
            codeUrl="unity/Build/Build.wasm"
            timeoutMs={30_000}
            width="100%"
            height="100%"
        />
    );
}

Optionally, you can pass a timeoutMs prop to set the maximum time in milliseconds to wait for user's response to authentication request. Default is 30 seconds.

You can also set a custom size of your Unity scene by passing width and height string props as in the example above (either as percentages or pixels, e.g. "100%" or "600px").

Unity C# bindings

The instructions for configuring your Unity project and using C# API can be found in the following repository.

React Project Example

Example of creating a React project with Vite and using the Peacemaker component:

1. Create Vite project

npm create vite@latest my-unity-react-app

Then chose React and then Typescipt in the CLI prompt.

2. Install dependencies

cd my-unity-react-app
npm install

3. Install Peacemaker

npm install peacemaker-unity-react-sei-sdk
npm install @sei-js/core @sei-js/react react react-dom react-unity-webgl

4. Move your Unity WebGL files into the Vite project

Create a unity folder in the src/public directory of your project and move your Unity WebGL files (Build.loader.js, Build.data, Build.framework.js, Build.wasm) into it.

5. Add Peacemaker component to your app

Open src/App.tsx file, remove all the content and add the following code instead:

import './App.css';
import { Peacemaker } from 'peacemaker-unity-react-sei-sdk';

function App() {
    return (
        <Peacemaker
            loaderUrl="unity/Build/Build.loader.js"
            dataUrl="unity/Build/Build.data"
            frameworkUrl="unity/Build/Build.framework.js"
            codeUrl="unity/Build/Build.wasm"
            timeoutMs={30_000}
            width="800px"
            height="600px"
        />
    );
}

export default App;

Ensure that paths and casing are correct and match Unity WebGL files mentioned in the previous step.

6. Run the app

Start Vite in development mode:

npm run dev

then go to http://localhost:5173 in your browser.

If you are using an example Unity project found in the C# SDK repository, you will see an example Unity scene with a Login button in it. Once you click it, you will be redirected to the Compass Sei Wallet to authenticate your account. After you login, you will see a message in Unity console with your account address.

Demo

Limitations

Note that this package is still in development, there is still a lot to do to fully support an effective integration. Reach out on github in case of any issues.