Contribute to the wiki

From High Fidelity Documentation
Jump to: navigation, search

High Fidelity is open source software enabling shared virtual reality.

Using High Fidelity, you can deploy a virtual reality server on a computer running Linux, OSX, or Windows, which can be then accessed by anyone from anywhere using our open source client. You can use the client with a regular 2D screen or with a head-mounted display (HMD) like the Oculus Rift or HTC Vive in conjunction with a mouse and keyboard and/or hand controllers to interact with your virtual environment. You can upload and manipulate your own content in many standard formats. You can also hyperlink your virtual spaces to other spaces, or browse a directory of publicly available servers run by other users.

In addition to providing open source software, High Fidelity also offers services helping you to uniquely name virtual spaces, manage your identity in different virtual worlds, and exchange digital assets. We are also building a system for sharing excess server resources with other operators, allowing huge, high-capacity spaces to be created. Our mission is to create a viable set of open software and standards to make virtual reality happen on a global scale.

For developers: Complex interactive content is created using JavaScript running on the client and/or server. Scripts can leverage the Bullet physics engine for fast accurate physics modeling. Content can be imported from FBX and OBJ formats. Both server and client currently run on OSX, Windows, and Linux. We use open standards and formats wherever possible. Our open source license is Apache 2.0. Contributions to development of the core systems can be made through our GitHub repository.

Please dive in and enjoy and/or contribute to this forever in-progress reference, suggest edits, and let us know what we're missing.

Contributing to the High Fidelity Documentation

Would you like to share your hints, tips, and techniques for exploring and scripting in High Fidelity? We welcome your contributions.

Have you found a mistake in the documentation, or do you have a small addition that would be so easy to add yourself rather than asking us to do it? The "Edit" tab on the upper right is your friend. Click it and see what happens (if you don't have one, you'll have to create a wiki account before you can edit — this should be simple and painless).

Do you have an idea for a new tutorial, article, or walkthrough? Make sure the topic is not already covered in another article. Then you can create an article by typing your desired title into a search; if it doesn't already exist you'll see a red link for creating an article with that name. All documentation should be formatted in wiki markup and follow the High Fidelity Documentation Style Guide.

Don't be afraid to ask for help or a basic review early in the process. Often things that may seem obvious to the designer of a tutorial are completely obscure to the novices for whom the tutorial is written.

Reviewing Contributions to the High Fidelity Documentation

There are two sides (or perhaps more) to reviewing documentation: ensuring the documentation is easy to read, and ensuring a novice reader would be able to easily follow the instructions in the documentation.

When reviewing (and writing) your documentation, turn on your spellchecker and imagine you have only the vaguest idea where anything is in the High Fidelity interface. Actually follow the instructions in the tutorial or article you are reviewing and point out places where, for example, a small hint as to the location of a menu item would make the document easier to follow.