Mineuniverse
Mods
Custom Portal API Reforged

Custom Portal API Reforged

MOD
Forge port of Fabrics Custom Portal API, updated for newer versions of MC.
by AzureDoomC
Download Claim this project
Add a badge to your pageLink to Custom Portal API Reforged from a README, website or forum post.
Preview: Badge

Badges update automatically and link to the mod page on MineUniverse.

3,743,886 downloads
0 likes
0 followers
Updated Oct 14, 2026
0 hypes
Follow0
API and Library
Advertisement Remove ads with Premium →

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!

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 "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.

customportalapi-reforged 1.7.0
MC NeoForge, 1.21.10
Release 2025-11-28 Get
customportalapi-reforged 1.6.0
MC 1.21.9, NeoForge
Release 2025-10-01 Get
customportalapi-reforged 1.2.2
MC NeoForge, 1.21.1
Release 2025-07-08 Get
customportalapi-reforged 1.5.0
MC NeoForge, 1.21.6
Release 2025-06-25 Get
customportalapi-reforged 1.4.0
MC 1.21.5, NeoForge
Release 2025-05-21 Get
customportalapi-reforged 1.2.1
MC NeoForge, 1.21.1
Release 2025-03-08 Get
customportalapi-reforged 1.0.11
MC NeoForge, 1.21.1
Release 2024-11-22 Get
customportalapi-reforged 1.0.10
MC NeoForge, 1.21.1
Release 2024-09-25 Get
customportalapi-reforged 1.0.10
MC NeoForge, 1.21.1
Release 2024-09-25 Get
customportalapi-reforged 1.0.6
MC NeoForge, 1.20.4
Release 2024-06-30 Get
customportalapi-reforged1.20.6 1.0.8
MC NeoForge, 1.20.6
Release 2024-06-30 Get
customportalapi-reforged1201 1.0.4
MC NeoForge, 1.20.1, Forge
Release 2024-06-30 Get
customportalapi-reforged1201 1.0.3
MC NeoForge, 1.20.1
Release 2024-05-15 Get
customportalapi-reforged 1.0.6
MC NeoForge, 1.20.4
Release 2024-05-15 Get
customportalapi-reforged1.20.6 1.0.7
MC NeoForge, 1.20.6
Release 2024-05-15 Get
customportalapi-reforged 1.0.5
MC NeoForge, 1.20.4
Release 2024-01-08 Get
customportalapi-reforged 1.0.4
MC NeoForge, 1.20.4
Release 2023-12-23 Get
cpapireforged-neo-1.20.2-1.0.3.jar
MC 1.20.2, NeoForge
Release 2023-11-23 Get
cpapireforged-1.0.1.jar
MC NeoForge, 1.20.1, Forge
Release 2023-09-21 Get
cpapireforged-1.0.2.jar
MC NeoForge, 1.20.1, Forge
Release 2023-09-21 Get
cpapireforged-1.0.0.jar
MC NeoForge, 1.20.1, Forge
Release 2023-08-14 Get

More from AzureDoomC

Advertisement Remove ads with Premium →

You Might Also Like