Skip to content

Commit

Permalink
modified install-plugins, VRPN install uncomplete yet
Browse files Browse the repository at this point in the history
  • Loading branch information
PyrApple committed Mar 18, 2015
1 parent 9f6e889 commit 3b1cbfd
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 25 deletions.
59 changes: 38 additions & 21 deletions manual/installation/install-plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,35 +24,48 @@ Add a ``plugins`` directory to your $INSTALL_DIR (see `Folder Structure <install
VRPN
----

This section guides you through `VRPN <http://www.cs.unc.edu/Research/vrpn/index.html>`_, install.
In a nutshell, you will have to build a VRPN server and blenderVR will act as a VRPN client.
once the VRPN server launched on your machine/network, any device defined in your vrpn.cfg (input of vrpn server) will be handled by the server and its related ``infos`` pulled by the blenderVR VRPn client.
This section briefly exposes the `VRPN <http://www.cs.unc.edu/Research/vrpn/index.html>`_, install.
In a nutshell, you will have to build VRPN, launch a VRPN server and blenderVR then will act as a VRPN client to fetch the data from your VRPN deives.
once the VRPN server launched on your machine/network, any device defined in your vrpn.cfg (input of vrpn server) will be handled by the server and its related ``infos`` pulled by the blenderVR VRPN client.
See `Getting started with VRPN <http://www.cs.unc.edu/Research/vrpn/vrpn_getting_started.html>`_ for more information.

Download `VRPN 07.33.zip <http://www.cs.unc.edu/Research/vrpn/downloads/vrpn_07_33.zip>`_ and unzip it into $INSTALL_DIR/plugins/vrpn/.
Create a ``build`` directory to finally have the following tree:
.. Create a ``build`` directory to finally have the following tree:
``//plugins/vrpn/vrpn``
``//plugins/vrpn/build``
.. ``//plugins/vrpn/vrpn``
.. ``//plugins/vrpn/build``
On OSX:
.. On OSX:
.. code-block:: bash
.. .. code-block bash
.. $ cd $INSTALL_DIR/plugins/vrpn/build
.. $ cmake -DCMAKE_OSX_ARCHITECTURES=x86_64 ../vrpn
.. $ make
then follow compilation instructions from `VRPN Compiling <http://www.cs.unc.edu/Research/vrpn/vrpn_standard_stuff.html>`_.

$ cd $INSTALL_DIR/plugins/vrpn/build
$ cmake -DCMAKE_OSX_ARCHITECTURES=x86_64 ../vrpn
$ make
Add the path of the vrpn python directory (e.g. `$INSTALL_DIR/plugins/vrpn/build/python`) to your `configuration file <components/configuration-file.html>`_ libraries.

Else, follow compilation instructions from `VRPN Compiling <http://www.cs.unc.edu/Research/vrpn/vrpn_standard_stuff.html>`_.
Once done, launch the ``basic-vrpn.blend`` scene in ``$INSTALL_DIR/samples/oculus_dk2/``.

Oculus Rift DK2
---------------

This section guides you through the installation of the dk2-blender-java-web-sockets.
This "java-websocket" is a local server (to be launch on the machine to which the oculus is plugged) that will received the oculus dk2 tracking infos.
In the meantime, blenderVR will pull these data to synchronize the user orientation in the virtual world.
This section guides you through the installation required to run the oculus rift dk2 with blenderVR.

The following install procedure involves:

* install java
* install dk2-blender-java-web-sockets
* install python dependencies
* install the oculus rift dk2 runtime
* modify blenderVR configuration file for dk2 support

The dk2 support in blenderVR relies on the `dk2-blender-java-web-sockets <https://github.com/tltmedia/dk2-blender-java-web-sockets>`_.
This java-websocket is a local server (to be launched on the machine to which the oculus is plugged) that will receive the data from the oculus dk2 and let blenderVR pull them to synchronize the user orientation in the virtual world.

Install `Java <https://www.java.com/fr/download/>`_ on your machine (try to type ``java``in a terminal window to see if it's not already installed).
Install `Java <https://www.java.com/fr/download/>`_ on your machine (try to type ``java`` in a terminal window to see if it's not already installed).

Download `dk2-blender-java-web-sockets-master.zip <https://github.com/tltmedia/dk2-blender-java-web-sockets/archive/master.zip>`_ rename it ``dk2-blender-java-web-sockets`` and move it to $INSTALL_DIR/plugins.

Expand All @@ -66,9 +79,6 @@ On OSX/Linux:
$ source venv/bin/activate
$ pip3 install -r blender-vr/requirements-dk2.txt
.. note::
MacOS: running these lines may popup window "download the command line developer tools", go for it.

On Windows:

.. code-block:: bash
Expand All @@ -77,6 +87,13 @@ On Windows:
$ .\venv\Scripts\activate
$ pip3 install -r blender-vr\requirements-dk2.txt
Modify your `configuration file <components/configuration-file.html>`_ to add the path to your newly installed libraries or modify the configuration file ``$INSTALL_DIR/blender-vr/configurations/main-dk2.xml`` to match your architecture.
Download and install the `Oculus Runtime <https://developer.oculus.com/downloads/>`_ for your architecture.

.. note ::
OSX: check on the web to setup your screen configuration for the rift (mirrored display, 90 rotation, etc.), e.g. `here <http://www.reddit.com/r/oculus/comments/2dbxve/041_with_dk2_on_a_mac_incompatible_resolution/>`_
Modify your `configuration file <components/configuration-file.html>`_ to add the path to your newly installed libraries. Check the configuration file ``$INSTALL_DIR/blender-vr/configurations/main-dk2.xml`` for guideline.

Once done, launch the basic .blend scene in $INSTALL_DIR/samples/oculus_dk2/
Once done, launch the ``basic-dk2.blend`` scene in ``$INSTALL_DIR/samples/oculus_dk2/``.
8 changes: 4 additions & 4 deletions manual/installation/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -115,10 +115,10 @@ On OSX/Linux:
.. note::
MacOS: running these lines may popup window "download the command line developer tools", go for it.
Linux: If the "pyvenv venv" command fails, you can try the command "pyvenv-3.4 venv"
Linux: If pyvenv command fails due to mising ensurepip module, try `this script <https://gist.github.com/uranusjr/d03a49767c7c307be5ed>`_

Linux: If the "pyvenv venv" command fails, you can try the command "pyvenv-3.4 venv".

Linux: If pyvenv command fails due to mising ensurepip module, try `this script <https://gist.github.com/uranusjr/d03a49767c7c307be5ed>`_ .

On Windows:

Expand Down

0 comments on commit 3b1cbfd

Please sign in to comment.