https://github.com/dbradleyfl/Mixed-Reality-JS

A simple framework for building Hololens applications with Javascript and ThreeJS. Based on HoloJS.
https://github.com/dbradleyfl/Mixed-Reality-JS

hololens hololens-applications javascript javascript-framework threejs webpack

Last synced: about 2 months ago
JSON representation

A simple framework for building Hololens applications with Javascript and ThreeJS. Based on HoloJS.

• Host: GitHub
• URL: https://github.com/dbradleyfl/Mixed-Reality-JS
• Owner: dbradleyfl
• License: other
• Created: 2017-02-19T00:11:43.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-04-13T19:11:08.000Z (over 7 years ago)
• Last Synced: 2024-05-15T20:12:33.638Z (4 months ago)
• Topics: hololens, hololens-applications, javascript, javascript-framework, threejs, webpack
• Language: JavaScript
• Homepage:
• Size: 2.84 MB
• Stars: 53
• Watchers: 5
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Mixed Reality JS

![MRJS Demo](https://github.com/dbradleyfl/Mixed-Reality-JS/blob/master/demo-mrjs.gif?raw=true)

A simple framework for building Hololens applications with Javascript and [ThreeJS](https://github.com/mrdoob/three.js/). Derived from [HoloJS](https://github.com/Microsoft/HoloJS).

## Requirements

* Windows 10

* Hololens (Or emulator)

* Visual Studio 2015

## Getting Started

1. Run *npm install -g mrjs*, then *mrjs new your_app_name*, then *cd your_app_name*.

2. Run *mrjs start*. Write your three js app in the src/ folder.

3. Make sure your Hololens development environment is all setup [using Microsoft's guides](https://developer.microsoft.com/en-us/windows/holographic/getting_started).

4. To deploy and debug, on emulator or device, run  *mrjs package*, open the HoloJS solution located in the release/ folder in Visual Studio. Change the deployment app from HoloHost to ThreeJSApp (right click ThreeJSApp in Solution Exporer and click "set as StartUp project"). Build > Clean Solution. Build > Rebuild Solution. Select your deployment target (Device, or emulator) in the menu then deploy the ThreeJSApp. You can also utilize the deployment instructions on the [HoloJS repo](https://github.com/Microsoft/HoloJS#system-requirements).

## Contributions

Hoping to keep this project moving along and toward being a framework for building VR/AR/MR applications for any device with Javascript. Below are a couple things that need to be impolmented into this version.

## Missing Features

* The name of the Universal Windows Application and description / author information should be pulled from the package.json

* Path issues within the UWP need to be addressed. For example, putting a "./" infront of the example app's texture.png url will break the UWP and fail silently. Need to find a solution for that.

* Piping images and other assets into the UWP isn't fully implemented yet.

* I'd like to have a --template option for mrjs new the allows you to select ThreeJS or AFrame as your perfered framework.

* I'd like to have an option for packaging for GearVR, mrjs package --gearvr, that injects the ThreeJS app into a GearVRF application. Need to figure out how difficult running WebGL/ThreeJS will be with GearVRF.