jeslyvarghese / remixVR

RemixVR is a tool for collaboratively building customizable VR experiences.

RemixVR

RemixVR is a tool to collaboratively build editable VR experiences.

The editable VR experiences are called VR templates. Anyone can create a VR template. Each VR template will have configurable options that can be selected by the user. These options allow the user to create custom VR experiences from a single VR template.

For example, let's look at the ObjectsVR template. It has three options. You can change the object, the 360 background and the sound it creates when hovering on the object.

In the initial version, these options are updated by editing the code. However, as we continue to develop RemixVR, we'll be including a visual way to update the options.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Documentation

You can read RemixVR docs to view all the documentation about the project.

Prerequisites

To make sure the projects runs on your machine, you need to have the following items installed on your machine.

Install node.js on your machine. We'll be using node.js for running our development server and building our project using webpack.

We'll use yarn as our dependency manager. If you don't have yarn on your machine, make sure to install yarn.

Installing

First, we need to clone this Github repo and open the folder.

git clone https://github.com/teliportme/remixVR.git
cd remixVR

Then we need to install the dependencies.

yarn install

Once the installation of is completed, you're ready to use the VR templates.

The repo is setup as a monorepo using yarn workspaces. This conserves disk space by sharing common dependencies across different packages.

Running a VR template

Once you have installed all the dependencies, to start a VR template, go to the template folder and in the terminal run yarn start.

For example, to start the ObjectsVR template, go to the template folder.

cd packages/objectsvr

Once you're inside the template folder, then start the development server.

yarn start

You can view the template by going to http://localhost:8080/ on your browser.

Running the tests

To run the test, navigate to the root folder of remixVR. Then run:

yarn run test

The test files are present inside the template folder. The test files ends with .test.js in their file name. You can look at ObjectsVR test file to see an example.

Built With

• a-frame
• webpack
• karma
• mocha
• chai
• sinon

Contributing

Please read CODE OF CONDUCT for details on our code of conduct. Please read CONTRIBUTING GUIDE before contributing.

Versioning

We use SemVer for versioning the VR templates.

Authors

• Rison Simon

See also the list of contributors who participated in this project.

License

This project is licensed under the GPL v3 License - see the LICENSE.md file for details.