Перейти к содержимому
Mineforgian

Custom Portal API Reforged

Forge port of Fabrics Custom Portal API, updated for newer versions of MC.

Загрузки
133K
Подписчики
12
Обновлён
28 ноября 2025 г.
Лицензия
MIT

Опубликован 14 августа 2023 г.

Исходный кодСообщить об ошибке

Custom Portal API Reforged

Library mod allowing developers to create portals to their custom dimensions easily. These custom portals will function exactly like nether portals, except being fully customizable. You can control the frame block, portal block, tinting, ignition source, destination, and more!

Some example of portals

Usage

Add the repository/mod to your build.gradle. 

repositories {
        maven {url 'https://maven.azuredoom.com/mods'}
}
dependencies {
//1.20.1
        implementation fg.deobf('net.kyrptonaught.customportalapi:customportalapi-reforged:MODVERSION')
//1.20.2+
implementation fg.deobf("net.kyrptonaught.customportalapi:cpapireforged-neo-1.20.2:MODVERSION")
}

Now onto creating and registering the portal itself, this is simple thanks to the CustomPortalBuilder class. We will make use of this in FMLCommonSetupEvent.

The following is a very simple portal that will take us to The End, and is lit by right-clicking the frame with an Eye of Ender:

CustomPortalBuilder.beginPortal()  
        .frameBlock(Blocks.DIAMOND_BLOCK)  
        .lightWithItem(Items.ENDER_EYE)  
        .destDimID(new ResourceLocation("the_end"))  
        .tintColor(45,65,101)  
        .registerPortal();

A Nether portal would be registered as follows: 

CustomPortalBuilder.beginPortal()  
        .frameBlock(Blocks.OBSIDIAN)  
        .destDimID(new ResourceLocation("the_nether"))  
        .tintColor(131, 66, 184)  
        .registerPortal();
CustomPortalBuilder is filled with plenty of methods to customize the functionality of your portal, all of which are documented in the class.



Some noteworthy methods to mention:

  • lightWithWater/Item/Fluid - These allow you to control how the portal is lit.
  • onlyLightInOverworld - Only allow the portal to be used in the overworld to your destination of choice
  • flatPortal - Flat Portal similar to the End or the Twilight Forest portal.



Credits

Based off the main Fabric mod HERE and an older ported mod HERE

Ченджлог

1.7.0Релиз1.21.10 · 28 ноября 2025 г.

v1.4.0

  • Ported to 1.21.10 (Thanks to AnonymousHacker1279)
1.6.0Релиз1.21.9 · 1 октября 2025 г.

v1.4.0

  • Ported to 1.21.9
1.2.2Релиз1.21.1 · 8 июля 2025 г.

v1.2.2

✨ New Features

  • Added Ignite Events

    • Implemented PortalIgniteEvent and PortalPreIgniteEvent interfaces.
    • Included corresponding handlers and invokers.
    • 🔧 These events allow:
      • Executing custom logic before and after portal ignition.
      • Cancelling the ignition entirely, if desired.

  • Player Entity in Ignite Context

    • The player is now included as part of the ignition source in item-use events.
    • ✅ Matches upstream behavior.
    • 🔍 Enables event consumers to identify which player attempted to light the portal.

⚠️ Breaking Change

  • Fixed Item Usage Behavior on Failed Portal Lighting
    • customportalapi-reforged previously cancelled item usage when ignition failed, which is opposite of upstream behavior.
    • This has been reversed: item usage is now only cancelled if the portal is successfully lit.
    • Example: Using an Eye of Ender to light a portal will no longer cause it to fly off and possibly break—it will be consumed only when ignition succeeds.

Credit murderspagurder for this PR!

1.5.0Релиз1.21.6 · 25 июня 2025 г.

v1.4.0

  • Ported to 1.21.6 - Credit to AnonymousHacker1279
1.4.0Релиз1.21.5 · 21 мая 2025 г.

v1.4.0

1.2.1Релиз1.21.1 · 8 марта 2025 г.

v1.2.0

  • Change registering portals to an event on the mod bus - Wolfieboy09
  • Update the wiki for these changes - Wolfieboy09
  • Move to RuntimeException over logging an error to get the user's attention on why it won't work - Wolfieboy09
  • Code cleanup - Wolfieboy09
  • Fixes portal colors.
1.0.11Релиз1.21.1 · 22 ноября 2024 г.

v1.0.11

  • Fix ResourceLocationException errors - AnonymousHacker1279
1.0.10Релиз1.21.1 · 25 сентября 2024 г.

v1.0.10

  • Ported to 1.21.1
  • Fire post teleport event again - AnonymousHacker1279

Комментарии

Загружаем…