sean1832/Portal.blender

Blender Portal adaptor plugin for IPC data exchange

Portal.blender

Portal.blender is a Blender add-on that allows you to communicate data between Blender and other applications using IPC. It is the Blender adaptor of the Portal project.

⭐️ Like this repo? please consider a star!

Compatibility

Portal.blender	Portal.Gh
0.1.2	0.4.0
0.1.1	0.4.0
0.1.0	0.4.0
0.0.3	0.3.1, 0.3.0 pre-release
0.0.2	0.2.0, 0.1.2, 0.1.1
0.0.1	0.2.0, 0.1.2, 0.1.1

Installation

• Download the latest release from the releases page.
• Drag and drop the zip file into Blender to install.

Dependencies

If this is your first time installing the Portal add-on, you will need to install the dependencies. To do this, follow these steps:

Important

You must start blender as an administrator to install the dependencies. After the dependencies are installed, you can run Blender as a regular user. See issue.

1. Open the preferences (Edit > Preferences > Add-ons).
2. Search for the 'Portal' add-on.
3. Open the details section of the add-on.
4. Click on the 'Install dependencies' button.
5. Restart Blender.

Usage

• Locate the Portal Server panel in the 3D View sidebar. (Shortcut: N)
• Select Connection Type from the dropdown menu.
• Click Start Server to start the server.

Custom Handlers

You can create custom handlers to manipulate the data that is received. To do this, follow these steps:

1. Copy and paste the template code into blender's text editor.
2. Modify the CustomHandler.handle method with your custom logic.
3. Select Custom from the Connection Type dropdown menu.
4. Select the custom script from the Handler field.
5. Click Start Server to start the server.

Documentation

For more information, visit the Portal.