Revision as of 01:14, 12 November 2009

Installing PyPRP

1. Make sure you have Blender 2.49a. Note: this requires Python 2.6.2.
   (To be precise, PyPRP 1.6 also works with some older versions of Blender (before 2.49a) and Python (before 2.6), but make sure that your Blender, Python, PyYAML, and PIL match! That is, if your Blender was built with Python 2.5.x, you also need Python 2.5.y (the minor versions x and y shouldn't matter), PyYAML for Python 2.5, and PIL for Python 2.5.)
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

• Python 2.6.4
• Python Imaging Library 1.1.6
• PyYAML 3.09

Required Software - Linux and other versions

• Python 2.6.2
• Python Imaging Library
• PyYAML

Additional Stuff

Psyco is also recommended for speeding up code running times.

• Psyco (Windows version)
• Psyco (Other versions)

Python Cryptography Toolkit (PyCrypto) is optional and only required for (non-functional) Myst V file support and to generate manifests for Alcugs data servers.

• Python Cryptography Toolkit (Windows)
• Python Cryptography Toolkit (source?)

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 (latest stable version)

Once you have the required software installed, get GoW PyPRP 1.6.0. 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.

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.