Overte open source virtual worlds platform.
Find a file
2013-08-21 15:03:12 -07:00
animation-server CR feedback 2013-08-21 13:09:51 -07:00
assignment-server repair header byte calculations in assignment server 2013-08-08 15:19:48 -07:00
audio-mixer implement --domain in audio-mixer 2013-08-07 19:30:49 -07:00
avatar-mixer CR feedback 2013-07-25 12:29:17 -07:00
cmake suppress warnings for glm headers that pop up in Xcode 5 2013-08-14 15:34:57 -07:00
domain-server removed debug 2013-08-19 11:16:22 -07:00
eve changes for stub pull request of assignee work 2013-08-05 10:06:50 -07:00
externals add the STK library for future audio magic 2013-05-30 12:25:29 -07:00
hardware/head_hand Revert "read from magnetometer on SDA, SLC" 2013-02-27 14:45:52 -08:00
injector changes for stub pull request of assignee work 2013-08-05 10:06:50 -07:00
interface Merge pull request #877 from Atlante45/separate_import_with_preview 2013-08-21 13:44:17 -07:00
jenkins rename missed variable in last commit 2013-08-19 13:19:02 -07:00
libraries CR feedback 2013-08-21 13:09:51 -07:00
pairing-server switch calls to printLog to QDebug 2013-07-16 11:07:22 -07:00
space-server switch calls to printLog to QDebug 2013-07-16 11:07:22 -07:00
tools move gen_stars to the tools folder 2013-05-22 12:39:27 -07:00
voxel-edit fix small build issue in voxel-edit 2013-08-10 11:31:48 -07:00
voxel-server CR feedback 2013-08-21 13:09:51 -07:00
.gitignore add Makefiles to the gitignore 2013-07-24 11:28:42 -07:00
CMakeLists.txt switch OS X base SDK to 10.7 2013-08-20 14:55:29 -07:00
Doxyfile initial rev of Doxyfile to generate HTML documentation for our classes 2013-08-14 14:20:47 -07:00
hifi.podspec add the voxels library to the hifi podspec 2013-08-05 17:38:47 -07:00
LICENSE add an all rights reserved license 2013-07-01 11:56:19 -07:00
README.md Significant updates to README to make it more useful 2013-08-21 15:03:12 -07:00

What is Hifi?

High Fidelity (hifi) is an early-stage technology lab experimenting with Virtual Worlds and VR.

In this repository you'll find the source to many of the components in our alpha-stage virtual world. The project embraces distributed development and if you'd like to help, we'll pay you -- find out more at Worklist.net. If you find a small bug and have a fix, pull requests are welcome. If you'd like to get paid for your work, make sure you report the bug via a job on Worklist.net.

We're hiring! We're looking for skilled developers; send your resume to hiring@highfidelity.io

Building Interface

Interface is our OS X and Linux build-able client for accessing our virtual world.

CMake

Hifi uses CMake to generate build files and project files for your platform. You can download CMake at cmake.org

Create a build directory in the root of your checkout and then run the CMake build from there. This will keep the rest of the directory clean, and makes the gitignore a little easier to handle (since we can just ignore build).

mkdir build
cd build
cmake .. -G Xcode

Those are the commands used on OS X to run CMake from the build folder and generate Xcode project files. If you are building on a *nix system, you'll run something like "cmake .." (this will depend on your exact needs)

Other dependencies & information

In addition to CMake, Qt 5.1 is required to build all components.

What can I build on? We have successfully built on OS X 10.8, Ubuntu and a few other modern Linux distributions. A Windows build is planned for the future, but not currently in development.

I'm in-world, what can I do?

If you don't see anything, make sure your preferences are pointing to root.highfidelity.io, if you still have no luck it's possible our servers are simply down; if you're experiencing a major bug, let us know by suggesting a Job on Worklist.net -- make sure to include details about your operating system and your computer system.

To move around in-world, use the arrow keys (and Shift + up/down to fly up or down) or W A S D, and E or C to fly up/down. All of the other possible options and features are available via menus in the Interface application.

Other components

voxel-server, animation-server, audio-mixer, avatar-mixer, domain-server, pairing-server and space-server are architectural components that will allow you to run the full stack of the virtual world should you choose to.

I'm ready, I want to run my own virtual world!

In the voxel-server/src directory you will find a README that explains how to setup and administer a voxel-server.

Keep in mind that, at a minimum, you must run a domain-server, voxel-server, audio-mixer, and avatar-mixer to have a working virtual world. Basic documentation for the other components is on its way.