https://github.com/votetake/vue-unity-webgl

Unity 3d Component for VueJS
https://github.com/votetake/vue-unity-webgl

Last synced: 2 months ago
JSON representation

Unity 3d Component for VueJS

• Host: GitHub
• URL: https://github.com/votetake/vue-unity-webgl
• Owner: votetake
• Created: 2017-08-24T17:18:57.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-07T05:25:00.000Z (over 1 year ago)
• Last Synced: 2024-03-26T12:05:35.527Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 492 KB
• Stars: 206
• Watchers: 11
• Forks: 51
• Open Issues: 20
• Metadata Files:
  • Readme: README.md

Lists

• awesome-stars - vue-unity-webgl

README

        
# vue-unity-webgl

Easy to use Unity 5.6 or newer (also Unity 2017 or newer)  WebGL player component for your VueJS application. Embed your Unity application in your application for writing interactive interfaces with two way Unity and VueJS communication.

 

## Install

```Bash

npm install vue-unity-webgl

```

## Usage

To get stated import the Unity component from `vue-unity-webgl`. Once imported you can use the Unity component to load in your Unity content. Place the Unity tag along with a src to the json file Unity exported.

```js

    

  import Unity from 'vue-unity-webgl'

  

  new Vue({

    components: { Unity }

  })

```

> ### Notice

> Don't forget to add a script tag to load the `UnityLoader.js` file if miss unityLoader attribute, exported by Unity in your base html file, index.html in example.

## Optional attributes

* `src` - Path to json build

* `width` - width div container

* `height` - height div container

* `unityLoader` - path to UnityLoader, with this

# Communication

Unity allows you to send Javascript messages to the Unity content. In order to do so using VueJs you have to add a ref to the `` tag, and call the `message(object, method, param)` method through `this.$refs`.

```js

    

import Unity from 'vue-unity-webgl'

new Vue({

  methods: {

    onClick () {

      this.$refs.myInstance.message("object", "method", "param")

    }

  }

})

```

# styling

The player will be injected in the a component with the class `unity-container`. To style to player use the following sass styling. To style the loader you can style the component with the class `unity-loader`. See the example below.

```scss

.unity {

    .unity-container {

        canvas {

            

        }

    }

    .unity-loader {

        .bar {

            .fill {

                /* the width will be set by the component */

            }

        }

    }

}

```

# html example

```html

    

        My Unity Game

    

    

        


    

    

    


```