IMPORTANT DISCLAIMER: Recursive portal rendering is NOT supported! (due to missing Godot features)

Getting started

1. Download the addon
2. Enable Portals3D in Project Settings > Plugins
3. When adding a new node, search for Portal3D
4. Add another Portal3D into your scene and move it aside
5. Set each other into the exit_portal property - this creates a portal pair and you can walk through!

For more advanced usages, explore the example scenes. Also the inspector properties are heavily commented :)

Showcase scenes

The project contains multiple demo levels showcasing its various features. It's best you try them yourself!

Features

• Seamless portal rendering for 1st person camera
• Teleportation of players
• Teleportation of objects thrown in
• Mesh clipping shaders for seamless transitions
• Extensive configuration options with editor inspector
• Customizable project settings
• Editor gizmos making it easier to work with portal pairs
• Public API for gameplay integration

This addon was developed as a part of my Master's thesis, so the thesis itself is its best documentation.

Contributions on GitHub are very welcome!