Getting Started

Using the Render Pipeline only requires a few steps to setup:

1. Getting an up-to-date Panda3D build

For the pipeline you need a recent Panda3D build. You can either use a precompiled build from here: Panda3D Devel SDK Downloads or compile it yourself, using the sources from here (use the master branch).

When you successfully installed/compiled it, head over to the next step. In case you have trouble compiling it, you can always ask or help on the forums or the panda3d irc!

2. Getting the Pipeline

You should download the latest version from github, by cloning the repository, for example with:

git clone https://github.com/tobspr/RenderPipeline --depth=1 --branch master --single-branch RenderPipeline
git submodule init
git submodule update

Alternatively you can use the Download ZIP button. Place the pipeline in a subfolder of your project, e.g. RenderPipeline/.

3. Setting up the Pipeline

Before use, you must run setup.py. This will configure various stuff including unpacking the pipeline assets.

You will also be asked if you want to use the C++ modules. If you want to use the C++ modules, see the instruction on how to compile them here.

4. Initializing the Pipeline

You can find a code-snippet showing how to initialize the pipeline here: Roaming-Ralph Sample.

The sample shows the basic code required to run the pipeline. The setup.py script also offers to install this sample amonst others.

Troubleshooting

In the most cases, you want to store the pipeline in a subfolder.

If your example fails to run with:

ImportError: cannot import name RenderPipeline

then make sure the RenderPipeline main folder is on your system path. You can configure this in python with sys.path.insert(0, "path/to/render/pipeline/). As a convenience function, you can also do from render_pipeline_importer import RenderPipeline to import the render pipeline, assuming the pipeline is on your path.

5. Accessing the Pipeline Tools

To configure the various plugins that control the pipeline, see the Plugin Configurator. (Note, you need the Python Qt4 libraries.)

There is also a DayTime editor, see Time of Day.

In a running program, you can use these hotkeys to inspect the pipeline:

6. Adding Lights & Models

When you start adding the render pipeline to your own program, then in order to make your objects shaded, you have to add some lights. You can find a list of supported lights at the Lights page, also more detailed information how to create a light.