Difference between revisions of "PyPRP Age Importer"

(Download Link)
(The Future of the Importer: Removed note about defunct PyPRP2)
 
(32 intermediate revisions by 8 users not shown)
Line 1: Line 1:
 
== Introduction ==
 
== Introduction ==
  
Useful to new Writers, is to import Cyan ages, as well as other user ages, into Blender. This allows a new Writer to get familiar with how an age is constructed before it is exported into Uru. It is also useful to 'old' Writers, who may, on occasion, delete a blend file for their age. Without importation, the loss of data from this, can often set a writer back months, as they would again have to start from scratch on that age.
+
On occasion, it may be useful to import ages (made by Cyan or others) into Blender from PRP or AGE files. Importing an age allows a new Writer to become familiar with how an age is constructed before it is exported into Uru. It may also be useful to retired Writers who have deleted (a) BLEND file(s) for their age and wish to continue development of that age. PyPRP's import feature prevents such a writer from having to rebuild that age from scratch.
  
Starting with the release of GoW-PyPRP 1.5.0, importing of ages by PyPRP was no longer a functionality of the plugin.
+
Age import has not supported since before the release of GoW-PyPRP 1.5.0.
  
== Information ==
+
==Required Software==
  
The PyPRP Age Importer is the most up to date stable version of PyPRP that allows importing functionality. It is a consistently updated version of PyPRP for the express purpose of importing ages into blender. It is a modified version of GoW-PyPRP 1.3.0 and thus should only be used for importing ages into Blender, rather than creating them.
+
===Windows===
 +
* [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]
 +
* [http://pyyaml.org/download/pyyaml/PyYAML-3.09.win32-py2.6.exe PyYAML 3.09]
  
== Before Getting Started ==
+
===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://pyyaml.org/download/pyyaml/PyYAML-3.09.tar.gz PyYAML 3.09
  
Before getting started importing your ages, it is recommended that you install a separate installation of Blender. Following the release of 1.4.0 of GoW-PyPRP, PyPRP was drastically re-engineered. This involved the creation of new scripts, and as such the PyPRP Age Importer will not replace the new scripts in your existing Blender installation. This will cause interference between the importer, and the current version of GoW-PyPRP.
+
== Installation ==
  
An alternative is to create two folders, one for the importer, and one for GoW-PyPRP. You would then copy the existing python scripts from the importer, into the folder associated with the importer. Then repeat the process for the GoW-PyPRP scripts, into the folder associated with it. When you want to import an age into blender, simply delete the GoW-PyPRP scripts from the scripts folder of blender, and place the importer's scripts into that folder. Then import your age and save in a blend file. Then delete the importer's scripts from Blender's script folder and replace with the GoW-PYPRP scripts.
+
Before we get PyPRP Importer and install it, you will need to locate your Blender scripts folder, which is where PyPRP Importer needs to be placed.
  
== The Future of the Importer ==
+
'''Important :''' Whatever the OS, make sure the PyPRP Importer files are copied inside /scripts/'''PyPRPImport/''' or Blender will return a 'No module named PyPRPImport' error.
  
Developers are hard at work on the release of PyPRP 2.x, that will make this version obsolete, until then this importer can serve the community as a decent importer of ages.
+
===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 Importer available to all users of the computer, but you will have to move over PyPRP Importer if you install a newer version of Blender. Or make your personal scripts folder to keep PyPRP Importer 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''
 +
 
 +
== The Future of the Importer ==
 +
The importer is offered "as-is". There are no plans for continued work.
  
 
== Download Link ==
 
== Download Link ==
  
[http://www.angelfire.com/mi2/milano/ImportScripts.zip'''PyPRP Importer''']
+
[https://dl.dropboxusercontent.com/s/lnfmyjvmoo87msu/PyPRPImporter.zip?dl=1&token_hash=AAGbL4W8kb2Glgsa0JgTgGonxonZVfA3L3bWjNAapL7Txg Latest Stable Version]
 +
 
 +
Additionally stuff (for Python 2.5):
 +
*[http://pyyaml.org/download/pyyaml/PyYAML-3.09.win32-py2.5.exe PyYAML]
 +
*[http://effbot.org/downloads/PIL-1.1.6.win32-py2.5.exe Image library]
 +
 
 +
Optional additional stuff:
 +
*[http://sourceforge.net/projects/psyco/files/psyco/1.6/psyco-1.6.win32-py25.exe/download Psyco (Windows version)]
 +
*[http://www.voidspace.org.uk/downloads/pycrypto-2.3.win32-py2.5.zip Python Cryptography Toolkit (Windows)]

Latest revision as of 22:35, 6 January 2016

Introduction

On occasion, it may be useful to import ages (made by Cyan or others) into Blender from PRP or AGE files. Importing an age allows a new Writer to become familiar with how an age is constructed before it is exported into Uru. It may also be useful to retired Writers who have deleted (a) BLEND file(s) for their age and wish to continue development of that age. PyPRP's import feature prevents such a writer from having to rebuild that age from scratch.

Age import has not supported since before the release of GoW-PyPRP 1.5.0.

Required Software

Windows

Mac/Linux

Installation

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

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

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 Importer available to all users of the computer, but you will have to move over PyPRP Importer if you install a newer version of Blender. Or make your personal scripts folder to keep PyPRP Importer 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

The Future of the Importer

The importer is offered "as-is". There are no plans for continued work.

Download Link

Latest Stable Version

Additionally stuff (for Python 2.5):

Optional additional stuff: