Skip to content
This repository

Virtual World Framework

branch: master
Octocat-spinner-32 documents Add functionality to save and load from separate directory structure. August 07, 2013
Octocat-spinner-32 lib Merge pull request #130 from virtual-world-framework/branch/view-inte… February 13, 2014
Octocat-spinner-32 public Removes the blockly app for the pull request April 15, 2014
Octocat-spinner-32 support Merge remote-tracking branch 'remotes/origin/development' into integr… February 27, 2014
Octocat-spinner-32 test Node.js Server parse driver-specifying url parameters. Add casperjs t… January 27, 2014
Octocat-spinner-32 .gitattributes Automatically normalize line endings on checkout and commit. December 16, 2012
Octocat-spinner-32 .gitignore Ignoring node_modules September 19, 2013
Octocat-spinner-32 .gitmodules Switch to JSDoc 3. February 05, 2013
Octocat-spinner-32 CHANGELOG.md Updated CHANGELOG.md and version.js February 27, 2014
Octocat-spinner-32 Gemfile Remove phantomjs gem because not needed October 02, 2013
Octocat-spinner-32 Gemfile.lock Update Gemfile.lock after pulling out the phantomjs gem October 07, 2013
Octocat-spinner-32 LICENSE Normalize files still containing CRLF line endings. December 16, 2012
Octocat-spinner-32 README.md Improve README. March 13, 2014
Octocat-spinner-32 Rakefile Add rake test runner for new casperjs server tests. December 06, 2013
Octocat-spinner-32 config.ru Moved 404 routing to vwf.rb and implemented function call to return 4… August 15, 2013
Octocat-spinner-32 init.rb Add ability to save vwf state to file in current directory, either by… January 09, 2013
Octocat-spinner-32 node-server.js Update documentation link for 'vwf create' command that points to Get… February 19, 2014
Octocat-spinner-32 node_vwf.js Updated spacing February 11, 2014
Octocat-spinner-32 npm-shrinkwrap.json Update shrinkwrap with the new modules. December 16, 2013
Octocat-spinner-32 package.json Implement `vwf create` and add mocha tests. December 16, 2013
Octocat-spinner-32 vwf.bat Revert "Remove unnecessary calls to cmd.exe in vwf.bat" March 13, 2014
README.md

Virtual World Framework

The Virtual World Framework (VWF) allows you to build collaborative, immersive applications in the browser. VWF provides:

  • Realtime state synchronization.
  • Support for immersive applications - a set of drivers for 3D, audio, video and modern graphics.

VWF applications are written in JavaScript and leverage emerging web technologies such as WebGL, WebRTC, and WebSockets to provide a full 3D environment that is automatically synchronized across clients.

Installation

Install on Mac/Linux

NOTE: On Mac OS X, please make sure you have Xcode Command Line Tools installed prior to executing the script below (https://developer.apple.com/xcode/).

$ curl -kL http://get.virtual.wf  | sh

This command may be re-run to upgrade the installation to the latest version of VWF.

Install on Windows

  • The Windows Installer has temporarily been taken down for maintenance. In the mean time, follow our Installation Instructions.

For more complex installations, such as working on VWF core, please see our Installation Instructions.

Quick Start

Create a new VWF application from the command line.

$ vwf create my-app

Change directory into that app and run the application.

$ cd my-app
$ vwf

Your application is now up and running at http://localhost:3000.

To get started with VWF, check out Getting Started.

Examples

For examples, check out our demos.

Also, browse through other example applications in the public directory.

Contributing

Our development process utilizes several branches:

  • Build Status master - Stable release of VWF. Running on http://demo.virtual.wf.
  • Build Status integration - Integration testing features from development before merging into master. Running on http://integration.virtual.wf.
  • Build Status development - The latest development and new features of the framework. Running on http://development.virtual.wf.
  • branch/feature-name - Feature development is done on a feature branch before being merged back to development.

When submitting a pull request, please use the development branch.

Also, please be sure that your pull request conforms to our Coding Standard.

Community

Keep track of developments and get help with VWF.

  • Discover an issue? Head over to Issues and report it.

License

Copyright 2014 United States Government, as represented by the Secretary of Defense, Under Secretary of Defense (Personnel & Readiness) licensed under the Apache 2.0 License.

Something went wrong with that request. Please try again.