Unity WebGL component for VueJs application
Last updated a year ago by votetake .
ISC · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install vue-unity-webgl 
SYNC missed versions from official npm registry.


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.


npm install --save


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.

  <unity src="static/Build/game.json" width="1000" height="600" unityLoader="static/Build/UnityLoader.js"></unity>  

  import Unity from 'vue-unity-webgl'
  new Vue({
    components: { Unity }


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


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 <unity> tag, and call the message(object, method, param) method through this.$refs.

  <unity src="static/Build/game.json" width="1000" height="600" unityLoader="static/Build/UnityLoader.js" ref="myInstance"></unity>  

import Unity from 'vue-unity-webgl'

new Vue({
  methods: {
    onClick () {
      this.$refs.myInstance.message("object", "method", "param")


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.

.unity {
    .unity-container {
        canvas {
    .unity-loader {
        .bar {
            .fill {
                /* the width will be set by the component */

html example

<!DOCTYPE html>
        <title>My Unity Game</title>
        <div id="app"></div>
    <script src="Build/UnityLoader.js"></script>
    <script src="static/compiled/bundle.js"></script>

Current Tags

  • 1.2.0                                ...           latest (a year ago)

3 Versions

  • 1.2.0                                ...           a year ago
  • 1.1.0                                ...           3 years ago
  • 1.0.0                                ...           3 years ago
Maintainers (1)
Today 0
This Week 1
This Month 1
Last Day 1
Last Week 6
Last Month 45
Dependencies (8)
Dev Dependencies (0)
Dependents (0)

Copyright 2014 - 2017 © |