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.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
You can read RemixVR docs to view all the documentation about the project.
To make sure the projects runs on your machine, you need to have the following items installed on your machine.
First, we need to clone this Github repo and open the folder.
git clone https://github.com/teliportme/remixVR.gitcd remixVR
Then we need to install the dependencies.
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.
Once you have installed all the dependencies, to start a VR template, go to the template folder and in the terminal run
For example, to start the ObjectsVR template, go to the template folder.
Once you're inside the template folder, then start the development server.
You can view the template by going to
http://localhost:8080/ on your browser.
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.
We use SemVer for versioning the VR templates.
See also the list of contributors who participated in this project.
This project is licensed under the GPL v3 License - see the LICENSE.md file for details.