Skip to content

Commit

Permalink
updated windows installation
Browse files Browse the repository at this point in the history
  • Loading branch information
PyrApple committed Mar 10, 2015
1 parent 8903852 commit 133e07a
Show file tree
Hide file tree
Showing 2 changed files with 80 additions and 49 deletions.
11 changes: 7 additions & 4 deletions manual/installation/development.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
====================================
Development Environment Installation
====================================
=======================================
Install for Future BlenderVR Developers
=======================================

This guide walks you over the basic steps of setting up a development environment for Blender-VR.
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.
Most of the time you won't need to modify and rebuild Blender, so those instructions are specified separately.

Expand Down
118 changes: 73 additions & 45 deletions manual/installation/installation.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
==================
Installation Guide
==================
=================
Install BlenderVR
=================

In order to install Blender-VR you need this guide.

Expand All @@ -12,17 +12,17 @@ In order to install Blender-VR you need this guide.
Document Sections
-----------------
* `Folder Structure`_
* `Requirements`_
* `Quick Setup`_
* `Acquiring Blender`_
* `Getting Samples`_
* `Acquiring BlenderVR and Basic sample scenes`_
* `Install dependecies`_
* `Quick Setup`_
* `Running`_


Folder Structure
-----------------
----------------

After all the downloads and installations you should end up with the following folder structure. This is a recommendation, and it will be used as reference along this manual.e
After all the downloads and installations you should end up with the following folder structure. This is a recommendation, and it will be used as reference along this manual.

``//blender-vr/``
*Blender-VR Source Code*
Expand All @@ -36,28 +36,64 @@ After all the downloads and installations you should end up with the following f
``//venv/``
*Python Virtual Environment*

Acquiring Blender
-----------------

Blender-VR requires `Blender 2.74 <http://www.blender.org/download>`_ or newer.
Optionally you can use a patched version of Blender 2.73a available here for all the supported platforms.

* `Mac OSX 64 bit: Blender 2.73a Patched <http://www.dalaifelinto.com/blendervr/ftp/blender-2.73-5c6ef95-OSX-10.6-x86_64.zip>`_. [1]_
* `Windows 32 bit: Blender 2.73a Patched <http://www.dalaifelinto.com/blendervr/ftp/https://builder.blender.org/download/blender-2.73-5c6ef95-win32.zip>`_. [2]_
* `Windows 64 bit: Blender 2.73a Patched <http://www.dalaifelinto.com/blendervr/ftp/blender-2.73-5c6ef95-win64.zip>`_. [2]_
* `Linux 32 bit: Blender 2.73a Patched <http://www.dalaifelinto.com/blendervr/ftp/blender-2.73-5c6ef95-linux-glibc211-i686.tar.bz2>`_. [3]_
* `Linux 64 bit: Blender 2.73a Patched <http://www.dalaifelinto.com/blendervr/ftp/blender-2.73-5c6ef95-linux-glibc211-x86_64.tar.bz2>`_. [3]_

.. [1] Requires Mac OSX 10.6+
.. [2] Compatible with Windows 8, 7, Vista. If Blender reports an error on startup, please install the `Visual C++ 2013 Redistributable Package <http://www.microsoft.com/en-us/download/details.aspx?id=40784>`_.
.. [3] Requires glibc 2.11. Suits most recent GNU/Linux distributions
Acquiring BlenderVR and Basic sample scenes
-------------------------------------------

Requirements
------------
.. _requirements:
* `Blender-VR Sources <https://github.com/BlenderVR/blender-vr/archive/v1.0.zip>`_ (download and unzip in the top folder, rename it to **blender-vr**)

Before getting started is recommended to look at the available samples.
The basic sample should help testing if everything was installed correctly, as well as testing the configuration file of your VR lab.
The other samples are to be used as reference to develop other VR projects.

* Download `All Samples <https://github.com/BlenderVR/samples/archive/master.zip>`_

You can also download an individual sample folder. For that you will need `SVN <http://subversion.apache.org/>`_ or `SVN Tortoise <http://tortoisesvn.net/>`_ (Windows only).
To check which samples are available visit the `Samples Repository <https://github.com/BlenderVR/samples.git>`_.


.. code-block:: bash
$ cd $INSTALL_DIR
$ mkdir -p samples
$ svn checkout https://github.com/BlenderVR/samples/trunk/simple samples/
(Or simply `svn checkout` the required sample with SVN Tortoise).


Install dependecies
-------------------

Install those packages or make sure you have them in your system.

All Time Mandatory
******************

* `Python <http://www.python.org/>`_
* `Blender-VR Sources <https://github.com/BlenderVR/blender-vr/archive/v1.0.zip>`_ (download and unzip in the top folder, rename it to **blender-vr**)
* `Blender Binary <#acquiring-blender>`_ (download and uncompress in the top folder, rename it to **blender**)


Required for Interface Development
**********************************

*At this moment those packages are always required, but the plans are to make them optional.*

* `PIP <https://pip.pypa.io/en/latest/installing.html>`_
* `QT 4.8 <http://download.qt.io/archive/qt/4.8/4.8.6/>`_
* `PIP <https://pip.pypa.io/en/latest/installing.html>`_ (the Python install should have installed pip, we advise you to try to use it in the `Quick Setup <#quick-setup>`_ section and install it if it's indeed uninstalled)

.. note::
MacOS: open Qt.mpkg with mouse right click -> Open, to avoid popup window "can't install, non identified developer".
Expand All @@ -67,6 +103,8 @@ Quick Setup

Type the following commands in your terminal. If you are in Windows we recommend you to use Power Shell or similar.

On OSX/Linux:

.. code-block:: bash
$ cd $INSTALL_DIR
Expand All @@ -79,55 +117,45 @@ Type the following commands in your terminal. If you are in Windows we recommend
.. note::
MacOS: running these lines may popup window "download the command line developer tools", go for it.

Acquiring Blender
-----------------

Blender-VR requires `Blender 2.74 <http://www.blender.org/download>`_ or newer. Optionally you can use a patched version of Blender 2.73a available here for all the supported platforms.

* `Mac OSX 64 bit: Blender 2.73a Patched <http://www.dalaifelinto.com/blendervr/ftp/blender-2.73-5c6ef95-OSX-10.6-x86_64.zip>`_. [1]_
* `Windows 32 bit: Blender 2.73a Patched <http://www.dalaifelinto.com/blendervr/ftp/https://builder.blender.org/download/blender-2.73-5c6ef95-win32.zip>`_. [2]_
* `Windows 64 bit: Blender 2.73a Patched <http://www.dalaifelinto.com/blendervr/ftp/blender-2.73-5c6ef95-win64.zip>`_. [2]_
* `Linux 32 bit: Blender 2.73a Patched <http://www.dalaifelinto.com/blendervr/ftp/blender-2.73-5c6ef95-linux-glibc211-i686.tar.bz2>`_. [3]_
* `Linux 64 bit: Blender 2.73a Patched <http://www.dalaifelinto.com/blendervr/ftp/blender-2.73-5c6ef95-linux-glibc211-x86_64.tar.bz2>`_. [3]_

.. [1] Requires Mac OSX 10.6+
.. [2] Compatible with Windows 8, 7, Vista. If Blender reports an error on startup, please install the `Visual C++ 2013 Redistributable Package <http://www.microsoft.com/en-us/download/details.aspx?id=40784>`_.
.. [3] Requires glibc 2.11. Suits most recent GNU/Linux distributions
Getting Samples
---------------

Before getting started is recommended to look at the available samples.
The basic sample should help testing if everything was installed correctly, as well as testing the configuration file of your VR lab.
The other samples are to be used as reference to develop other VR projects.

* Download `All Samples <https://github.com/BlenderVR/samples/archive/master.zip>`_

You can also download an individual sample folder. For that you will need `SVN <http://subversion.apache.org/>`_ or `SVN Tortoise <http://tortoisesvn.net/>`_ (Windows only).
To check which samples are available visit the `Samples Repository <https://github.com/BlenderVR/samples.git>`_.

On Windows:

.. code-block:: bash
$ cd $INSTALL_DIR
$ mkdir -p samples
$ svn checkout https://github.com/BlenderVR/samples/trunk/simple samples/
$ pip3 install virtualenv
$ virtualenv venv
$ .\\venv\\Scripts\\activate
$ pip3 install -r blender-vr/requirements.txt
$ python3 .\\venv\\Scripts\\pyside_postinstall.py -install
$ python3 .\\blender-vr\\blenderVR
(Or simply `svn checkout` the required sample with SVN Tortoise).
You may have to add the path to the python binary, e.g.

.. code-block:: bash
$ [Environment]::SetEnvironmentVariable("Path", "$env:Path;C:\\Python34\\;C:\\Python34\\Scripts\\")
Running
-------

Type the following commands in your terminal. If you are in Windows we recommend you to use Power Shell or similar.

On OSX/Linux:

.. code-block:: bash
$ cd $INSTALL_DIR
$ source venv/bin/activate
$ ./blender-vr/blenderVR
On Windows:

.. code-block:: bash
$ cd $INSTALL_DIR
$ .\\venv\\Scripts\\activate
$ python3 .\\blender-vr\\blenderVR
You should now see a window popping up. Congratulations your installation was a success. Once you are done running Blender-VR you can end the virtual environment:

.. code-block:: bash
Expand Down

0 comments on commit 133e07a

Please sign in to comment.