Difference between revisions of "PyPRP:Installing"

(Installing PyPRP: changed Blender link to 2.49 (latest Python 2.5 compatible version))
(Added more detailed explanation of where to find the Blender scripts folder and PyPRP 1.6 installation instructions.)
Line 2: Line 2:
 
#Make sure you have [http://download.blender.org/release/Blender2.49/blender-2.49-windows-py25.exe Blender 2.49] or '''some version which was compiled with Python 2.5.4'''.
 
#Make sure you have [http://download.blender.org/release/Blender2.49/blender-2.49-windows-py25.exe Blender 2.49] or '''some version which was compiled with Python 2.5.4'''.
 
#Download and install everything listed under "Required Software" section.
 
#Download and install everything listed under "Required Software" section.
 +
#[[#Finding your Blender Scripts Folder|Find the Blender scripts folder]] to install PyPRP into.
 
#See the [[Installing PyPRP#Getting PyPRP | Getting PyPRP]] section.
 
#See the [[Installing PyPRP#Getting PyPRP | Getting PyPRP]] section.
  
Line 21: Line 22:
 
*[http://kent.dl.sourceforge.net/sourceforge/psyco/psyco-1.6.win32-py25.exe Psyco (Windows version)]
 
*[http://kent.dl.sourceforge.net/sourceforge/psyco/psyco-1.6.win32-py25.exe Psyco (Windows version)]
 
*[http://sourceforge.net/project/showfiles.php?group_id=41036 Psyco (Other versions)]
 
*[http://sourceforge.net/project/showfiles.php?group_id=41036 Psyco (Other versions)]
 +
 +
==Finding your Blender Scripts Folder==
 +
 +
===All Platforms===
 +
If you have an item ''System'' > ''System Information…'' in the Help menu in Blender and it works without causing a Python script error, look for ''Default dir for scripts'' or ''User defined dir for scripts'' in its output.
 +
 +
===Windows===
 +
Usually ''C:\Program Files\Blender Foundation\Blender\.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===
 +
Usually ''/home/<'''YOUR_USER_NAME'''>/.blender/scripts''
  
 
==Getting PyPRP==
 
==Getting PyPRP==
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.  
+
===PyPRP 1.6 Beta===
 +
Once you have the required software installed, get GoW PyPRP 1.6.0b1 (link to be added shortly). If you have a previous version of PyPRP installed, uninstall it by removing all files starting with ''prp_'' (or ''alc'' and ''uruprp_'' for even older versions) from your Blender ''scripts'' folder. Unzip the file and move the ''PyPRP'' folder (the whole folder, ''not'' the files in it – this has changed from previous versions) into the Blender ''scripts'' folder.
 +
 
 +
===PyPRP 1.5 (latest stable version)===
 +
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).  
  
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''.  
+
Unzip the file and move everything inside* the 'src' folder to your "''.../.blender/scripts''" folder.
  
 
  *NOTE: Do NOT put the actual 'src' FOLDER inside your "/scripts" folder, only the files from inside the 'src' 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, [http://svn.guildofwriters.com/pyprp_nightly.zip get the 'bleeding edge' PyPRP]. This file is updated every night at midnight Eastern Time.
 
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.
  

Revision as of 15:51, 12 August 2009

Installing PyPRP

  1. Make sure you have Blender 2.49 or some version which was compiled with Python 2.5.4.
  2. Download and install everything listed under "Required Software" section.
  3. Find the Blender scripts folder to install PyPRP into.
  4. See the Getting PyPRP section.

Required Software - Windows version

Required Software - Linux and other versions

Additional Stuff

Psyco is also recommended for speeding up code running times.

Finding your Blender Scripts Folder

All Platforms

If you have an item System > System Information… in the Help menu in Blender and it works without causing a Python script error, look for Default dir for scripts or User defined dir for scripts in its output.

Windows

Usually C:\Program Files\Blender Foundation\Blender\.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

Usually /home/<YOUR_USER_NAME>/.blender/scripts

Getting PyPRP

PyPRP 1.6 Beta

Once you have the required software installed, get GoW PyPRP 1.6.0b1 (link to be added shortly). If you have a previous version of PyPRP installed, uninstall it by removing all files starting with prp_ (or alc and uruprp_ for even older versions) from your Blender scripts folder. Unzip the file and move the PyPRP folder (the whole folder, not the files in it – this has changed from previous versions) into the Blender scripts folder.

PyPRP 1.5 (latest stable version)

Once you have the required software installed, get the latest PyPRP (GoW PyPRP 1.5.0).

Unzip the file and move everything inside* the 'src' folder to your ".../.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, get the 'bleeding edge' PyPRP. This file is updated every night at midnight Eastern Time.

Advanced users can select which version of PyPRP they would like to download.

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.