Custom Portal API Reforged
by AzureDoom
Custom Portal API Reforged is a Forge and NeoForge library that lets developers build nether-style portals leading to custom dimensions.
What it does
A developer registers a portal through the CustomPortalBuilder class, usually inside the common setup event. The builder sets the frame block, the portal block, the tint, the ignition source and the destination, so a portal can behave like a nether portal while leading anywhere.
The library is built for mod authors rather than players, though a player only sees its effect once another mod registers a portal with it. Client and server are both listed as the environment, so the server and every player need the library. It is published for Forge and NeoForge across nine release versions, 1.20.1 – 1.21.10, and is released under the MIT License as open source. It updates a earlier library of the same design, adapted for newer Minecraft versions.
Six catalog mods already depend on it, including MCDoom, Lost River, Custom Portal Builder, Ocean World Dimension and EmeraldCraft. Its public links cover the source code, the issue tracker and a wiki.
Key features
Custom portal blocks
The frame block, portal block and tinting can each be set, so a portal can look different from the nether portal.
Ignition sources
Portals can be lit with a light item, a fluid or water, which controls how a player activates them.
Dimension restriction
The onlyLightInOverworld option lets a portal work only from the overworld, toward the destination the author picks.
Flat portals
The flatPortal option creates a flat portal similar to the End portal or the Twilight Forest portal.
Gallery
Compatibility
Latest build for each game version and loader.
1.21.x5 of 5 versions with builds
1.20.x4 of 4 versions with builds
Only full game releases are shown. This mod publishes no snapshot builds.
Required by 6 mods
Use cases
Who it’s for: Mod developers who add dimensions or portal-based travel. Players rarely install it directly; it is most useful when another mod that depends on it is present.
How it compares
Custom Portal API is the Forge option from 1.19.2 and shares the client and server environment with this library, under the MIT License and as open source. Reforged Fabric API is a Forge library for 1.20 – 1.20.1 under the Apache License 2.0, also open source. OpenPortals is a NeoForge library for 1.21.11 – 26.3, released under the MIT License as open source.
| Mod | Loaders | Game versions | Environment | Updated |
|---|---|---|---|---|
| Custom Portal API Reforged | Forge and NeoForge | 1.20.1 – 1.21.10 | Client and server | 2025-11-28 |
| Custom Portal API [Forge] | Forge | 1.19.2 | Client and server | 2022-09-03 |
| Reforged Fabric API | Forge | 1.20 – 1.20.1 | Client and server | 2023-08-25 |
| OpenPortals | NeoForge | 1.21.11 – 26.3 | Client and server | 2026-10-03 |
Questions
Does Custom Portal API Reforged need to be installed on both sides?
Which loaders does Custom Portal API Reforged support?
Which game versions have files?
In the catalog
Custom Portal API Reforged is one of 3,514 Library mods on ModsFinder, and one of 1,576 Library mods for Forge. 15,569 mods support Minecraft 1.21.10.
More from AzureDoom
Similar mods
What the author says
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! Add the repository/mod to your…
Official listing
- Modrinth page
- modrinth.com/mod/custom-portal-api-reforged
- Owner
- AzureDoom
- Published
- 2023-08-14
- Updated on Modrinth
- 2025-11-28
- Facts verified
- 2026-10-15