Difference between revisions of "PyPRP:Installing"

m (added clarity regarding 'src' folder instructions)
m (Nightly Build and Older Releases)
 
(45 intermediate revisions by 13 users not shown)
Line 1: Line 1:
=Installing PyPRP=
+
{{Tutorial|Installation}}
#Make sure you have the latest version of [http://www.blender.org/download/get-blender/ Blender] (currently version 2.48)
+
==Video Tutorial==
#Download and install everything listed under "Required Software" section.
+
bnewton81 has provided a [http://www.youtube.com/watch?v=2TQRiJ0iYck video tutorial] for the installation process.
#See the [[Installing PyPRP#Getting PyPRP | Getting PyPRP]] section.
+
  
==Required Software - Windows version ==
+
==Required Software==
* [http://www.python.org/ftp/python/2.5.1/python-2.5.1.msi Python 2.5.1] or [http://www.python.org/ftp/python/2.5.2/python-2.5.2.msi 2.5.2]
+
* [http://effbot.org/downloads/PIL-1.1.6.win32-py2.5.exe Python Imaging Library]
+
*[http://www.voidspace.org.uk/cgi-bin/voidspace/downman.py?file=pycrypto-2.0.1.win32-py2.5.zip Python Cryptography Toolkit]
+
*[http://pyyaml.org/download/pyyaml/PyYAML-3.05.win32-py2.5.exe PyYAML]
+
  
==Required Software - Linux and other versions ==
+
===Windows===
* [http://www.python.org/download/ Python 2.5.1 or 2.5.2]
+
* [http://mirror.cs.umn.edu/blender.org/release/Blender2.49b/blender-2.49b-windows.exe Blender 2.49b]
 +
* [http://www.python.org/ftp/python/2.6.6/python-2.6.6.msi Python 2.6.6]
 +
* [http://effbot.org/downloads/PIL-1.1.6.win32-py2.6.exe Python Imaging Library 1.1.6]
 +
* [https://pypi.python.org/packages/2.6/P/PyYAML/PyYAML-3.10.win32-py2.6.exe#md5=4c1a374cb89fa0ff43f3b94b5692edd9 PyYAML 3.10]
 +
 
 +
''NOTE: Python 2.6.6 is the newest 2x version of Python that will work with Blender 2.49b. Blender 2.49b is the newest version of Blender that will work with PyPRP 1.6.1.  Only versions up to PIL 1.1.6 and PyYAML 3.10 will work without PyPRP causing a C Runtime error R6034 to pop up! This error appears to have no affect on building an age, but to be safe, go only as high as these versions of Blender, Python, PIL, PyYAML, and PyPRP.''
 +
 
 +
===Mac/Linux===
 +
* [http://www.blender.org/download/get-blender/ Blender 2.49b]
 +
* [http://www.python.org/ftp/python/2.6.6/Python-2.6.6.tgz Python 2.6.6]
 
* [http://www.pythonware.com/products/pil/ Python Imaging Library]
 
* [http://www.pythonware.com/products/pil/ Python Imaging Library]
*[http://www.amk.ca/files/python/crypto/pycrypto-2.0.1.tar.gz Python Cryptography Toolkit (source?)]
+
* [http://pyyaml.org/download/pyyaml/PyYAML-3.09.tar.gz PyYAML 3.09]
*[http://pyyaml.org/download/pyyaml/ PyYAML]
+
  
==Additional Stuff==
+
==Finding your Blender Scripts Folder==
Psyco is also recommended for speeding up code running times.
+
Before we get PyPRP and install it, you will need to locate your Blender scripts folder, which is where PyPRP needs to be placed.
  
*[http://kent.dl.sourceforge.net/sourceforge/psyco/psyco-1.5.2.win32-py2.5.exe Psyco (Windows version)]
+
===All Platforms (Advanced)===
*[http://sourceforge.net/project/showfiles.php?group_id=41036 Psyco (Other versions)]
+
''Note: This method is for users who are already comfortable with using Blender''
  
==Getting PyPRP==
+
Click on the ''Help'' > ''System'' > ''System Information''. This will create a text file called ''system-info.txt'' inside Blender. Open this text file and look for a line that says ''Default dir for scripts''. Your scripts folder is written out in the line below.
Once you have the required software installed, [http://www.guildofwriters.com/pyprp/gow-pyprp-1.5.0.zip get the latest PyPRP] (GoW PyPRP 1.5.0).  
+
  
Unzip the file and move everything inside* the 'src' folder to your "''.../.blender/scripts''" folder.  
+
===Windows===
 +
Blender allows you to choose where your scripts folder is installed. By default, Blender obscures the script folder in your Application Data folder, which makes finding it somewhat troublesome. Unfortunately, the Application Data folder is in different places depending on which version of Windows you are using. Please refer to the following sample locations to see if your scripts folder is in the Application Data folder.
 +
* '''Windows 2000/XP''': ''C:\Documents and Settings\<'''Your User Name'''>\Application Data\Blender Foundation''
 +
* '''Windows Vista/7''': ''C:\Users\<'''Your User Name'''>\AppData\Roaming\Blender Foundation''
 +
If the ''Blender Foundation'' folder is present, then your scripts folder can be found by going to the ''Blender'' > ''.blender'' > ''scripts'' folder. Otherwise, the scripts folder can be found within your Blender installation itself. This is usually ''C:\Program Files\Blender Foundation\Blender\.blender\scripts''. If you are running a 64-bit operating system, substitute ''Program Files'' for ''Program Files (x86)''.
  
On Windows, this is usually ''C:\Program Files\Blender Foundation\Blender\.blender\scripts'' while on Linux, you will probably find it in ''/home/<'''YOUR_USER_NAME'''>/.blender/scripts''.  
+
===Mac OS X===
 +
You have two options: Either use the built-in scripts folder of the Blender application. This is simple and makes PyPRP available to all users of the computer, but you will have to move over PyPRP if you install a newer version of Blender. Or make your personal scripts folder to keep PyPRP and other third-party scripts neatly separated from Blender's built-in scripts.
 +
 
 +
'''To use the built-in scripts folder:''' Right-click or ctrl-click on the ''blender'' application and choose ''Show Package Contents''. Go to ''Contents/MacOS''. The ''.blender'' folder is in there, but it is invisible because its name starts with a period. To open it, press cmd-shift-G (or choose ''Go to Folder…'' from the ''Go'' menu) and enter ''.blender'' into the box. The '''''scripts''''' folder is in the ''.blender'' folder and already contains a number of scripts.
 +
 
 +
'''To make your own scripts folder:''' Open ''/Applications/Utilities/Terminal'', enter
 +
mkdir -p ~/.blender/scripts
 +
and press return. You can quit Terminal after that. (You can't make the ''.blender'' folder in the Finder because it doesn't allow you to rename it to a name starting with a period.) Now open your home folder (''/Users/<your user name>'') and press cmd-shift-G (or choose ''Go to Folder…'' from the ''Go'' menu). Enter ''.blender'' into the box to open the invisible folder you just created and find the '''''scripts''''' folder in there.
 +
 
 +
At this stage, Blender will exclusively use the newly created scripts folder and thus lose its built-in scripts. To bring them back: Open Blender and drag the menu bar down to reveal the Preferences window. Select ''File Paths'' in the bottom button row. Click the folder button in the ''Python Scripts'' box, navigate to where you installed the Blender application (''blender.app'') in the file dialog, drill down to ''blender.app/Contents/MacOS/.blender/scripts'', and click ''SELECT SCRIPT PATH''. After closing the Preferences window again, choose ''File'' > ''Save Default Settings'' to make the new setting permanent.
 +
 
 +
===Linux===
 +
''/home/<'''Your User Name'''>/.blender/scripts''
 +
 
 +
 
 +
'''Important :''' Whatever the OS, make sure the PyPRP files are copied inside /scripts/'''PyPRP/''' or Blender will return a 'No module named PyPRP' error.
 +
 
 +
==Getting PyPRP==
 +
===PyPRP 1.6 (latest stable version)===
 +
Once you have the required software installed and have located your Blender scripts folder, download [http://guildofwriters.org/pyprp/gow-pyprp-1.6.1.zip PyPRP 1.6.1]. If you have a previous version of PyPRP installed you will need to uninstall it by removing all files starting with ''prp_'', ''alc'', and ''uruprp_'' from your Blender ''scripts'' folder because the ''files from older versions of PyPRP will conflict with PyPRP 1.6 and cause it to crash''. Unzip the file and move the ''PyPRP'' folder (the whole folder, ''not'' just the files in it – this has changed from previous versions) into the Blender ''scripts'' folder.
  
*NOTE: Do NOT put the actual 'src' FOLDER inside your "/scripts" folder, only the files from inside the 'src' folder
+
===Nightly Build and Older Releases===
 +
Alternatively, if you are interested in getting the very latest development version with the newest features and most bugs, you may grab the bleeding edge [https://github.com/H-uru/PyPRP/zipball/master git master branch] of PyPRP, which represents current in-development version of PyPRP
  
Alternatively, if you are interested in getting the very latest development version with the newest features, [http://svn.guildofwriters.com/pyprp_nightly.zip get the 'bleeding edge' PyPRP]. This file is updated every night at midnight Eastern Time.
+
''Advanced users can select any [[PyPRP:Downloads|older versions of PyPRP]] they would like to download.''
  
''Advanced users can select [[Download_PyPRP|which version of PyPRP]] they would like to download.''
+
==Reaching your age==
 +
In order to be able to reach the age you created in-game, you need the same set of tools as required for [[Playing Fan Ages|playing fan ages]].
  
 
==Congrats==
 
==Congrats==
 
Congratulations! You should now have PyPRP installed and are ready to get started building Ages. If you'd like to test that PyPRP is installed and working properly you can try to [[Getting_Started_With_Writing|get started on your own]].
 
Congratulations! You should now have PyPRP installed and are ready to get started building Ages. If you'd like to test that PyPRP is installed and working properly you can try to [[Getting_Started_With_Writing|get started on your own]].
  
[[Category:PyPRP]][[Category:Tools Tutorials]]
+
[[Category:PyPRP]]

Latest revision as of 12:55, 28 June 2016

Disambig gray.png

This is a tutorial page.Versions available: PyPRP; 3ds Max; Korman.
 

Video Tutorial

bnewton81 has provided a video tutorial for the installation process.

Required Software

Windows

NOTE: Python 2.6.6 is the newest 2x version of Python that will work with Blender 2.49b. Blender 2.49b is the newest version of Blender that will work with PyPRP 1.6.1. Only versions up to PIL 1.1.6 and PyYAML 3.10 will work without PyPRP causing a C Runtime error R6034 to pop up! This error appears to have no affect on building an age, but to be safe, go only as high as these versions of Blender, Python, PIL, PyYAML, and PyPRP.

Mac/Linux

Finding your Blender Scripts Folder

Before we get PyPRP and install it, you will need to locate your Blender scripts folder, which is where PyPRP needs to be placed.

All Platforms (Advanced)

Note: This method is for users who are already comfortable with using Blender

Click on the Help > System > System Information. This will create a text file called system-info.txt inside Blender. Open this text file and look for a line that says Default dir for scripts. Your scripts folder is written out in the line below.

Windows

Blender allows you to choose where your scripts folder is installed. By default, Blender obscures the script folder in your Application Data folder, which makes finding it somewhat troublesome. Unfortunately, the Application Data folder is in different places depending on which version of Windows you are using. Please refer to the following sample locations to see if your scripts folder is in the Application Data folder.

  • Windows 2000/XP: C:\Documents and Settings\<Your User Name>\Application Data\Blender Foundation
  • Windows Vista/7: C:\Users\<Your User Name>\AppData\Roaming\Blender Foundation

If the Blender Foundation folder is present, then your scripts folder can be found by going to the Blender > .blender > scripts folder. Otherwise, the scripts folder can be found within your Blender installation itself. This is usually C:\Program Files\Blender Foundation\Blender\.blender\scripts. If you are running a 64-bit operating system, substitute Program Files for Program Files (x86).

Mac OS X

You have two options: Either use the built-in scripts folder of the Blender application. This is simple and makes PyPRP available to all users of the computer, but you will have to move over PyPRP if you install a newer version of Blender. Or make your personal scripts folder to keep PyPRP and other third-party scripts neatly separated from Blender's built-in scripts.

To use the built-in scripts folder: Right-click or ctrl-click on the blender application and choose Show Package Contents. Go to Contents/MacOS. The .blender folder is in there, but it is invisible because its name starts with a period. To open it, press cmd-shift-G (or choose Go to Folder… from the Go menu) and enter .blender into the box. The scripts folder is in the .blender folder and already contains a number of scripts.

To make your own scripts folder: Open /Applications/Utilities/Terminal, enter

mkdir -p ~/.blender/scripts

and press return. You can quit Terminal after that. (You can't make the .blender folder in the Finder because it doesn't allow you to rename it to a name starting with a period.) Now open your home folder (/Users/<your user name>) and press cmd-shift-G (or choose Go to Folder… from the Go menu). Enter .blender into the box to open the invisible folder you just created and find the scripts folder in there.

At this stage, Blender will exclusively use the newly created scripts folder and thus lose its built-in scripts. To bring them back: Open Blender and drag the menu bar down to reveal the Preferences window. Select File Paths in the bottom button row. Click the folder button in the Python Scripts box, navigate to where you installed the Blender application (blender.app) in the file dialog, drill down to blender.app/Contents/MacOS/.blender/scripts, and click SELECT SCRIPT PATH. After closing the Preferences window again, choose File > Save Default Settings to make the new setting permanent.

Linux

/home/<Your User Name>/.blender/scripts


Important : Whatever the OS, make sure the PyPRP files are copied inside /scripts/PyPRP/ or Blender will return a 'No module named PyPRP' error.

Getting PyPRP

PyPRP 1.6 (latest stable version)

Once you have the required software installed and have located your Blender scripts folder, download PyPRP 1.6.1. If you have a previous version of PyPRP installed you will need to uninstall it by removing all files starting with prp_, alc, and uruprp_ from your Blender scripts folder because the files from older versions of PyPRP will conflict with PyPRP 1.6 and cause it to crash. Unzip the file and move the PyPRP folder (the whole folder, not just the files in it – this has changed from previous versions) into the Blender scripts folder.

Nightly Build and Older Releases

Alternatively, if you are interested in getting the very latest development version with the newest features and most bugs, you may grab the bleeding edge git master branch of PyPRP, which represents current in-development version of PyPRP

Advanced users can select any older versions of PyPRP they would like to download.

Reaching your age

In order to be able to reach the age you created in-game, you need the same set of tools as required for playing fan ages.

Congrats

Congratulations! You should now have PyPRP installed and are ready to get started building Ages. If you'd like to test that PyPRP is installed and working properly you can try to get started on your own.