SANDBOX — this is a test environment. No servers are actually deployed and no real payments are charged.
✓ VerifiedLibraries & compatibility

Custom Portal API Reforged

by AzureDoom · for Minecraft

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

152KDownloads
10 mo agoLast updated
MITLicense
Forge · NeoForgeLoaders

About Custom Portal API Reforged

From Modrinth

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

<font size=+4>Custom Portal API Reforged</font>

<font size=+1> 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! </br></br>

Some example of portals

<font size=+2>Usage</font>

Add the repository/mod to your build.gradle. </font>

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")
}

<font size=+1>

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.

</br></br> 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.

</br></br>

<font size=+2>Credits</font>

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

Highlights

From source data

Game versions

Supports 9 Minecraft versions, the newest being 1.21.10.

Loaders

Runs on Forge and NeoForge.

Footprint

Rated a light load on a server.

What kind of mod it is

From the catalog
Listed on Modrinth as “Mods”

Libraries & compatibility

Foundations and fixes other mods build on. Usually installed because something else needs it.

Runs on your server

From source side support

Modrinth lists Custom Portal API Reforged as required on the server. Check its Modrinth page to see whether players need it too.

Compatibility

Game
Minecraft
Loaders
ForgeNeoForge
Runs on
Serverrequired on the server
Game versions
1.21.10 and 8 earlier

Verified at the source

  • ✓ModrinthOfficial listing, checked 2026-10-01Open ↗
  • ✓AuthorAzureDoom, as published on Modrinth
  • ✓LicenseMITFree

Custom Portal API Reforged, answered

Generated from the mod’s own source data.

Do my players need to install Custom Portal API Reforged?

Modrinth lists Custom Portal API Reforged as required on the server. Check its Modrinth page to see whether players need it too.

Which loaders does it support?

Forge and NeoForge.

Is it free?

Yes. Custom Portal API Reforged is free to download from Modrinth. Its license is MIT.

How do I add it to my Nxeon server?

Use “Add to a server” on this page, or open NxLabs from your dashboard. We install it, restart your server and switch it on.

NxLabs

Run Custom Portal API Reforged on a Minecraft server.

Deploy in about a minute from $4.20 a month, then add Custom Portal API Reforged in one click.