Custom Type

The overall process of setting up 'Custom Type' with ButterflyNetRender is very straight forward:

Install:

(Windows):

• 1. Install the custom command line application locally on all the Windows Rendernode machines (in the same location on all machines)

ie: c:\cool_raytracer\ray.exe

• 2. Set the custom type in the BNR Controller (see the next step)

Configure:

Configure paths and settings in BNR Controller:

In the BNR Controller:

• 1. Add the new custom type (Custom RayTracer) (Options->Configure->Configure Custom scene types)

• 2. Select a 'empty' option

• 3. In the 'Settings' tab

o Set the 'Name' and Icon for this type
o Set the extension type used by the scene (*.scn)
o Set 'Run Once' if this would only be a script that run on a single rendernode -
o Set Scene Reader - if this type has a supported scene reader
o Set 'Enable Post Command' - if you want a post command to run after this is complete
o Set the Default Frame range, Group and Priority settings

• 4. In the 'Output' tab

o Enable the Frame Size - if the command line supports that ability
o Enable the output format - if the command line supports that ability 
this will then add frame verify to the custom type

• 5. In the 'Files' tab

Set the location of the 'ray.exe' (the local path on each Rendernode)  
(Options->Configure Platforms - Custom RayTracer)

• 6. In the 'Command' tab

o Confirm you have the correct command line settings to run the Custom command line 
(this should include the frame start and frame end if it will be used on all the 
rendernodes for rendering.)

Check the 'Quick Help Keys' to show a list of all the varables that can be used.

Make sure you use the 'Test' button to check to see if the command looks correct

Restart:

Restart the BNR Controller.

Add:

Now add scene file for rendering: (make sure you select the 'Custom Type'

After you add the scene - you may need to:

• 1. Select the Frame range (Output Tab)
• 2. Select the Output format (Output Tab)

to set the settings

Make sure you add the scene from the Shared Network folder (that all the rendernodes have access to - otherwise the rendernodes will not be able to load the scene)

Test:

The best way to test a to confirm the setup is working:

• 1. Make sure 'Custom Type' is installed on the controller (in the same location as the RenderNodes)
• 2. Add a 'Custom Type' scene into BNR
• 3. Select the 'Render' Tab
• 4. Press the 'Test Render Command" and then press 'Launch Locally'

This will run the same command the Rendernodes will get - but you will get to see more information directly. You will need to check the 'Task Manager' to see if the command is running in the back ground

• Right click on the Scene and a select "Open Scene Trace Log folder" and you should find the output text "Render_*.txt" - Please open with notepad to view the text.

(note if you see *.csv files - these are BNR Controller state flows)