Home

Welcome to the Kyanite Portals wiki!

This wiki explains the basics of Kyanite Portals so you can easily make your own custom portals in Minecraft! These portals can do all sorts of behavior.

Why use Kyanite Portals?

Kyanite Portals was made as an alternative to Custom Portal API specifically for Deeper and Darker. The reason why is that Custom Portal API didn't have everything Deeper and Darker needed (e.g., multiple ignition sources, correctly checking inner portal contents, executing custom code on travel rather than just setting the travel sound, generating the portal inside the dimension's bounds, correctly showing the client-side nausea effect), so I developed Kyanite Portals to suit our needs.

However, even though this library was made for Deeper and Darker, it functions in a modular system where you can register and set each part that makes a portal:

1. Portal generator: the algorithm which generates a portal when a trigger is used. The default square portal algorithm is configurable for most cases, but if you need a very distinct portal (like the Betweenlands portal, for example), you can make your own generator.
2. Portal tester: the algorithm which tests the portal frame to see if it is a valid portal. This is normally used to check if the portal is still valid after generation and with triggers.
3. Actions: code executed in various situations: entering a portal, traveling through a portal, tick, random tick, and animation tick.
4. Portal travel time: the time it takes to execute all travel actions upon entering the portal.
5. Triggers: actions which open a portal. Similar to Custom Portal API's ignition sources, but they can be anything. The default options are enough for most cases, but you can register your own triggers.