Configuration file (and plugins): Library Path Sub-Section

manual/components/configuration-file.rst

@@ -40,7 +40,11 @@ Some elements can be specific to one node, other shared. For instance, the ``ble
       </system>
     </computer>
     <computer name='left computer' hostname='left.fqdn' />
-    <computer name='right computer' hostname='right.fqdn' />
+    <computer name='right computer' hostname='right.fqdn'>
+      <system>
+        <library path='/usr/local/lib/vrpn/' />
+      </system>
+    </computer>
   </computers>
 
 In this example, ``left computer`` and ``right computer`` nodes will use ``/usr/local/blender/2.74/bin/blenderplayer`` whereas ``front computer`` node will use ``/usr/bin/blenderplayer``.
@@ -191,6 +195,31 @@ owever, due to `not homogenous paths between nodes <#anchor>`_, you may have to
 
 See `Anchor <#anchor>`_ to know the purpose of anchor parameter.
 
+Library Path Sub-Section
+========================
+
+Plugins often relies on external libraries. If the library is not bundled in the ``blenderplayer`` python folder, the library folder can be specified with the ``library`` element.
+If any library is defined in a system section, they all must be defined.
+
+In the example below both OSC and VRPN library folders are specified for the OSX system, while the Linux stations shared the same system as defined in the top of the ``computers`` section.
+
+.. code:: xml
+
+  <computers>
+    <system>
+      <library path="/usr/local/lib/vrpn/" />
+      <library path="/usr/local/lib/osc/" />
+    </system>
+    <computer name='OSX station' hostname='mac'>
+      <system>
+        <library path="/User/dev/vrpn/build/python/" />
+        <library path="/User/dev/osc/lib/" />
+      </system>
+    </computer>
+    <computer name='Linux station A' hostname='linux_a' />
+    <computer name='Linux station B' hostname='linux_b' />
+  </computers>
+
 Login Sub-Section
 =================
 

manual/components/osc.rst

@@ -24,19 +24,28 @@ Interaction Setup
 
 While the OSC API allows to easily send OSC (UDP) flags, the MaxMSP associated
 Sound Rendering Engine has been design to receive an process these flags.
-Once you’ve opened the Blender-VR_Sound_Rendering_Engine_vX.maxpat on the
-OSC server as defined in the ``.xml`` configuration file
+Once you’ve opened the ``Blender-VR_Sound_Rendering_Engine_vX.maxpat`` on the
+OSC server as defined in the ``.xml`` configuration file:
 
 .. code:: xml
 
   <processor>
-    <osc host='serverName' port='3819'/>
+    (...)
+    <plugins>
+      <osc host='serverName' port='3819'/>
+        <user listener='Binaural 1' viewer='user A' />
+        <user listener='Ambisonic' />
+      </osc>
+    </plugins>
   </processor>
 
-and modified it to fit to your needs (spatializer, speakers mapping, microphone inputs,
+And modified it to fit to your needs (spatializer, speakers mapping, microphone inputs,
 etc.), the rest of the sound adding process takes place in Blender-VR.
 
-See ``samples/BlenderCave_OSC.blend`` and ``samples/BlenderCave_OSC_API.blend``
+.. note::
+  You also need to specify the folder containing your osc library in the `configuration file <configuration-file.html#library-path-sub-section>`__.
+
+See ``samples/BlenderCave_OSC.blend`` and ``samples/BlenderCave_OSC_API.blend``.
 LIMSI members, see http://wikivenise.limsi.fr/index.php/Open_Sound_Control .
 
 Downloads

manual/components/vrpn.rst

@@ -55,6 +55,9 @@ Example with a Nintendo Wii Controller
 
 *Analog will receive accelerometer data from the WiiMote, button only the pressed button states.*
 
+.. note::
+  You also need to specify the folder containing your vrpn library in the `configuration file <configuration-file.html#library-path-sub-section>`__.
+
 3. In the ``<blend_file_name>.processor.py`` script (e.g. Blender-VR_API.processor.py), add:
 
 .. code:: python