5.8.1 Installing the io_scene_cs add-on script

This section describes the installation procedure of the io_scene_cs add-on script.

Getting the add-on

The io_scene_cs add-on script is available in the Crystal Space package,
within the ‘CS/scripts/blender’ directory. The script should be used with
the corresponding version of Crystal Space.

Installing the add-on

Since the script is composed of several files, you cannot simply use the ‘Install Add-On’
button of the Blender interface. Instead, you need to copy manually the folder
‘CS/scripts/blender/io_scene_cs’ into the Blender add-ons directory
(‘blender/$version/scripts/addons’). By default, this directory should be at:

Enabling the add-on

Blender add-ons are found in the ‘Add-Ons’ tab of the ‘Files > User Preferences’
window. Once an add-on has been installed, it has to be enabled before it can be used.
Simply place a check mark on the ‘Enable an addon’ box of the add-on called
‘Import-Export: Export Crystal Space 3D format’.

If the add-on doesn't appear in the list, then this probably means that the installation
was not made correctly. Please check the directory where you placed the io_scene_cs
add-on script, or check the Blender console for any problems.

The new export functionality is now integrated into Blender and can be used. If you want to
disable the functionality, uncheck the box. To get more information on the add-on you can
press the arrow at the left of the entry. Finally, this add-on can be enabled everytime
you start Blender simply by saving your user preferences (‘Save As Default’ at the
bottom of the window).

Testing the presence of the add-on

Close the Blender ‘User Preferences’ window, then go and check if the
‘Crystal Space Export’ panel appears in the ‘Render’ context of the
‘Properties’ (or ‘Buttons’) window (it can appear either at the top
or at the bottom of the context).

If you don't see the interface, then you may:

Scroll either to the top and to the bottom of the ‘Render’ context since
the Crystal Space panel may appear in both places.

Check that you have the exporter add-on correctly installed and enabled.

Configuring Crystal Space

Finally, if you want to test your exported meshes and models, you should have a valid
Crystal Space package installed on your computer, with the ‘CRYSTAL’ environment
variable pointing to the installation directory. Although this variable is not technically
needed to use the io_scene_cs script, you will need it in order to view your
exported files and to use the ‘Export and Run’ functionality of the script.
See section Setting the CRYSTAL environment variable for more information on the way to
do this.