Vojta/antichamber-at-home
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update plugin

Browse Source
This commit is contained in:
Vojtěch Struhár 2025-05-20 21:22:18 +02:00
parent d5b4f22a9d
commit d52d760b18
2 changed files with 24 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
addons/portals/README.md
View File

@ -4,28 +4,26 @@ This plugin enables you to easily create seamless plugins.
## Documentation ## Documentation
For documentation about `Portal3D`, see the portal script itself. For documentation about `Portal3D`, see the portal script itself. Everything is properly documented
Everything is properly documented and viewable in the default and viewable in the default documentation window. Go to the script editor, click _Search Help_ in
documentation window. Click _Script > Search Help_ and type the top bar and search for "Portal3D".
"Portal3D" in there.
For everything else, there is this README. For everything else, there is this README.
## Materials ## Guides
### Portals ### Customize portals in the editor
The portal mesh has a custom shader material assigned to it at runtime, The portal mesh has a custom shader material assigned to it at runtime (defined in
(defined in `materials/portal_shader.gdshader`), but in editor, it uses `materials/portal_shader.gdshader`), but in editor, it uses a regular material -- find it at
a regular material -- find it at `materials/editor-preview-portal-material.tres`. `materials/editor-preview-portal-material.tres`. You can edit this material to customize how
You can edit this material to customize how portals look in the editor portals look in the editor (in case the default gray color blends in too much).
(in case the default gray color blends in too much).
### Smooth teleportation ### Smooth teleportation
The Portal3D script provides a mechanism for smooth teleportation. In order to be The Portal3D script provides a mechanism for smooth teleportation. In order to be able to create
able to create smooth portal transitions, you need to implement a clipping shader smooth portal transitions, you need to put a clipping shader onto all meshes that are supposed to
on all meshes that are supposed to participate in the teleportation. participate in the smooth teleportation.
**How to convert a regular mesh to a clippable one?** Like this: **How to convert a regular mesh to a clippable one?** Like this:
@ -53,12 +51,11 @@ void fragment() {
} }
``` ```
And that's it! Now look for `DUPLICATE_MESHES_CALLBACK` in the Portal3D script, you And that's it! Now look for `DUPLICATE_MESHES_CALLBACK` in the Portal3D script, you are ready to
are ready to get going with smooth teleportation! get going with smooth teleportation!
## Gizmos ## Gizmos
This plugin includes couple of custom gizmos. One gives a This plugin includes couple of custom gizmos. One gives a connected portal an outline and the
connected portal an outline and the second one visualizes portal's second one visualizes portal's front direction. You can configure the color of both gizmos in
front direction. You can configure the color of both gizmos in _Project Settings / Addons / Portals_ or turn them off altogether.
_Project Settings > Addons > Portals_ or turn them off altogether.

6
addons/portals/plugin.cfg
View File

@ -1,7 +1,7 @@
[plugin] [plugin]
name="3D Portals" name="Portals 3D"
description="Implements seamless portals in 3D" description="Seamless portals plugin in 3D"
author="Vojtech Struhar" author="Vojtech Struhar"
version="0.1" version="1.0"
script="plugin.gd" script="plugin.gd"