Skip to content

Commit

Permalink
Added automatic installation guidelines for windows
Browse files Browse the repository at this point in the history
(in installation/installation-executable.rst), and
thus renamed installation to installation-manual.rst
(and updated dynamic ref).
  • Loading branch information
PyrApple committed Sep 9, 2015
1 parent a3494d2 commit dc45a15
Show file tree
Hide file tree
Showing 13 changed files with 65 additions and 28 deletions.
2 changes: 1 addition & 1 deletion manual/components/osc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,6 @@ Once you've opened the ``BlenderVR_Sound_Rendering_Engine_<version>.maxpat`` on

.. tip ::
If you downloaded BlenderVR `samples <../installation/installation.html#download-samples-scenes>`_, see the scenes in the ``samples/plugin/osc`` folder for a direct insight on how to use the OSC API.
If you downloaded BlenderVR `samples <../installation/installation-manual.html#download-samples-scenes>`_, see the scenes in the ``samples/plugin/osc`` folder for a direct insight on how to use the OSC API.
.. LIMSI members, see http://wikivenise.limsi.fr/index.php/Open_Sound_Control.
2 changes: 1 addition & 1 deletion manual/components/processor-file.rst
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Keyboard and Mouse

You can get access to keyboard and mouse information of the `master node <../architecture/master-slaves.html#master>`_ by defining the `keyboardAndMouse <http://blender-vr.readthedocs.org/modules/rst/blendervr.processor.base.html?highlight=keyboardandmouse#blendervr.processor.base.Processor.keyboardAndMouse>`_ method. The ``info`` provided has the same format than any provided through the `VRPN plugin <vrpn.html>`_.

You can use a `logger`_ to see what is contained inside the ``info`` argument. You can also have a look at the ``simple.processor.py`` file inside ``simple`` `sample <../installation/installation.html#getting-samples>`_ folder to get an example of how to use this method.
You can use a `logger`_ to see what is contained inside the ``info`` argument. You can also have a look at the ``simple.processor.py`` file inside ``simple`` `sample <../installation/installation-manual.html#getting-samples>`_ folder to get an example of how to use this method.

Choose Objects to Synchronize
-----------------------------
Expand Down
2 changes: 1 addition & 1 deletion manual/components/user-interface.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ You can choose any screen set (4) that is defined inside your ``XML`` configurat
Simulation File
===============

Here, you must select the ``.blend`` file you want to load (6). For the beginning, you should try the ``basic.blend``, that you can get from the `samples repository <../installation/installation.html#getting-samples>`_. You can manually select a processor file (7) or activate the ``NameLink`` (8) for BlenderVR to automatically look for a <name_of_blender_scene>.processor.py file in the directory of the .blend file. You will learn to create your own .blend scenes and processor files via the samples and going though the `BlenderVR API <http://blender-vr.readthedocs.org>`_.
Here, you must select the ``.blend`` file you want to load (6). For the beginning, you should try the ``basic.blend``, that you can get from the `samples repository <../installation/installation-manual.html#getting-samples>`_. You can manually select a processor file (7) or activate the ``NameLink`` (8) for BlenderVR to automatically look for a <name_of_blender_scene>.processor.py file in the directory of the .blend file. You will learn to create your own .blend scenes and processor files via the samples and going though the `BlenderVR API <http://blender-vr.readthedocs.org>`_.

Start/Stop
==========
Expand Down
5 changes: 2 additions & 3 deletions manual/components/vrpn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,11 @@ VRPN is a protocol used in Virtual Reality to exchange data with external device
BlenderVR behaves like a VRPN client. At the other end, a VRPN server will host
different tracker or sensors that would be as many haptic arms, tracked stereoscopic
glasses or Wiimote devices. The server will associate a name to these device, along
with a variable “info” that holds the useful information about
the considered device.
with a variable “info” that holds the useful information about the considered device.

In BlenderVR, the receiving of VRPN messages and definition of associated methods
is done in the ``<blender_scene_name>.processor.py`` script attached to a scene (see
examples in the `samples <../installation/installation.html#getting-samples>`_ folder).
examples in the `samples <../installation/installation-manual.html#getting-samples>`_ folder).

Document Sections
-----------------
Expand Down
4 changes: 2 additions & 2 deletions manual/development/build-win-exe.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Build Windows Executable
This section is intented for developers willing to create a BlenderVR.exe (Windows executable) based on BlenderVR source code.

.. note::
For casual users, please download the current BlenderVR Excecutable, see the `Installation Guide <../installation/installation.html>`_.
For casual users, please download the current BlenderVR Excecutable, see the `Installation Guide <../installation/installation-executable.html>`_.

This installer was build using `Inno Setup <http://www.jrsoftware.org/>`_ (v5.5.5).
Please download the `BlenderVR Installer source code <ftp://blendervrdownloads:blendervr@echange.limsi.fr/BlenderVR_W7_Installer/Installer_BlenderVR_W7_dev.zip>`_ before reading the next section.
Expand Down Expand Up @@ -37,7 +37,7 @@ Installer Folder Structure

+ BlenderVR base folders

(copy of the `Folder Structure <installation.html#folder-structure>`_ suggested during BlenderVR `Installation <installation.html>`_)
(copy of the `Folder Structure <installation-manual.html#folder-structure>`_ suggested during BlenderVR `Installation <installation-manual.html>`_)

``//source/``
*BlenderVR Source Code*
Expand Down
2 changes: 1 addition & 1 deletion manual/development/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Requirements
------------

Before working in the documentation you need to install all the requirements and the main repository
from the `installation <../installation/installation.html>`_ guide.
from the `installation <../installation/installation-manual.html>`_ guide.

Quick Setup
-----------
Expand Down
4 changes: 2 additions & 2 deletions manual/first-run.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ First Run


.. note::
After the `installation <installation/installation.html>`_ you should make sure everything is working before going on your own. For this first run you will need at least the basic sample from the `samples repository <installation/installation.html#download-samples-scenes>`_.
After the `installation <installation/installation-manual.html>`_ you should make sure everything is working before going on your own. For this first run you will need at least the basic sample from the `samples repository <installation/installation-manual.html#download-samples-scenes>`_.

Document Sections
-----------------
Expand All @@ -16,7 +16,7 @@ Document Sections
Launch BlenderVR
-----------------

Start by opening the BlenderVR GUI (see `Running BlenderVR <installation/installation.html#running>`_ in the Install section). Although in the future you can launch it via a shortcut, for the first run it's better to do it via command-line, to catch any unexpected error.
Start by opening the BlenderVR GUI (see `Running BlenderVR <installation/installation-manual.html#running>`_ in the Install section). Although in the future you can launch it via a shortcut, for the first run it's better to do it via command-line, to catch any unexpected error.
It is advised to understand how to manipulate the `User Interface <components/user-interface.html>`_ before going any further.

Open the Simulation File
Expand Down
Binary file added manual/images/install-windows-python.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 5 additions & 5 deletions manual/installation/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ Install for BlenderVR Development
This guide walks you over the basic steps of setting up a development environment for BlenderVR.

.. note ::
For casual BlenderVR users, please refer to the `Install BlenderVR <installation.html>`_ page.
For casual BlenderVR users, please refer to the `Install BlenderVR <installation-manual.html>`_ page.
The install is the same as described in `Install BlenderVR <installation.html>`_ but for:
The install is the same as described in `Install BlenderVR <installation-manual.html>`_ but for:

* git clone of the BlenderVR repository, to freely modify and eventually commit your modifications.
* svn/git clone of the BlenderVR samples, to eventually add your own demo scenes to the BlenderVR samples repository
Expand All @@ -31,7 +31,7 @@ BlenderVR requires a vanilla Blender 2.75 or newer.

If you ever need to modify and rebuild Blender for further customizations, please consult the `Blender's official documentation <http://wiki.blender.org/index.php/Dev:Doc/Building_Blender>`_.

Else, download the sources provided in `Acquiring Blender <installation.html#acquiring-blender>`_.
Else, download the sources provided in `Acquiring Blender <installation-manual.html#acquiring-blender>`_.


Acquiring BlenderVR
Expand All @@ -58,7 +58,7 @@ Regarding BlenderVR samples, Git is not a good system to work on binary files, s
$ cd $INSTALL_DIR
$ svn checkout https://github.com/BlenderVR/samples/trunk samples
where $INSTALL_DIR is the root BlenderVR folder (see the `Install BlenderVR <installation.html#folder-structure>`_ page for more details).
where $INSTALL_DIR is the root BlenderVR folder (see the `Install BlenderVR <installation-manual.html#folder-structure>`_ page for more details).

Alternatively, to fetch an individual sample folder, you can use:

Expand Down Expand Up @@ -98,4 +98,4 @@ Required for Interface Development
Quick Setup and Running
-----------------------

see `Quick Setup and Running <installation.html#quick-setup>`_ in the Install BlenderVR Section.
see `Quick Setup and Running <installation-manual.html#quick-setup>`_ in the Install BlenderVR Section.
3 changes: 2 additions & 1 deletion manual/installation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Installation
.. toctree::
:maxdepth: 1

installation.rst
installation-manual.rst
installation-executable.rst
development.rst
plugins.rst
43 changes: 43 additions & 0 deletions manual/installation/installation-executable.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
==============================
Install BlenderVR (automatic)
==============================

This section details the install of BlenderVR based on an executable file, automation of the procedure described in the `Install BlenderVR <installation-manual.html>`_ page.

Once BlenderVR installed, verify the installation by opening the newly created BlenderVR application (you should see the `BlenderVR interface <../_images/user-interface-1.png>`_ pop-up)
and move on to the `First Run <../first-run.html>`_ page.

Document Sections
-----------------
* `Windows 7 (64bits)`_

.. note ::
If none of the provided executable is compliant / work on your machine, fallback to the `Install BlenderVR <installation-manual.html>`_ page.
.. figure:: /images/windows-logo.png
:width: 40px
:figwidth: 40px
:align: right

Windows 7 (64bits)
------------------

Download executable:

* `BlenderVR Win7 64bits WebInstall <ftp://blendervrdownloads:blendervr@echange.limsi.fr/BlenderVR_W7_Installer/BlenderVR_setup_Win64_Webinstall.exe>`_
* `BlenderVR Win7 64bits Standalone <ftp://blendervrdownloads:blendervr@echange.limsi.fr/BlenderVR_W7_Installer/BlenderVR_setup_Win64.exe>`_


.. warning ::
Even the ``Standalone`` install requires an internet connection (to install non-bundled python libs).
First, launch the executable, that will require administrator's rights. Move on the installation procedure and, when asked, select Python ``Install for all users``:

.. figure:: /images/install-windows-python.png
:width: 400px
:figwidth: 400px
:align: center

Near the end of the installation, accept the run of ``BlenderVR-install.bat`` to complete the installation.
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
:figwidth: 100px
:align: right

=================
Install BlenderVR
=================
==========================
Install BlenderVR (manual)
==========================

In order to install BlenderVR you need this guide.

Expand All @@ -16,18 +16,12 @@ In order to install BlenderVR you need this guide.

.. tip::

Windows "standard" (non-developpers) users are invited to download the BlenderVR WebInstall Excecutable (Windows 7):

* `BlenderVR Win7 WebInstall download <ftp://blendervrdownloads:blendervr@echange.limsi.fr/BlenderVR_W7_Installer/BlenderVR_setup_Win64_Webinstall.exe>`_
* `BlenderVR Win7 Standalone download <ftp://blendervrdownloads:blendervr@echange.limsi.fr/BlenderVR_W7_Installer/BlenderVR_setup_Win64.exe>`_

*(though you are still advised to read through the following installation and how to use guides)*
Windows "standard" (non-developpers) users are invited to download the BlenderVR Install Excecutable for Windows 7 *(though you are still advised to read through the following installation and how to use guides)*. See the `Install BlenderVR (automatic) <installation-executable.html>`_ page.

.. note ::
If you need the full development setup make sure to follow the `Development Environment <development.html>`_ guide.
Document Sections
-----------------
* `Folder Structure`_
Expand Down
2 changes: 1 addition & 1 deletion manual/installation/plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Document Sections
Folder Structure
----------------

Add a ``plugins`` directory to your $INSTALL_DIR (see `Folder Structure <installation.html#folder-structure>`_, this is once more a recommendation as it will be used as reference along this manual).
Add a ``plugins`` directory to your $INSTALL_DIR (see `Folder Structure <installation-manual.html#folder-structure>`_, this is once more a recommendation as it will be used as reference along this manual).

.. ``//plugins/``
.. *BlenderVR Plugins*
Expand Down

0 comments on commit dc45a15

Please sign in to comment.