Custom Portals Foxified

Custom Portals lets you build portals out of any block. Matching frames link together and allow easy distant travel. You can create networks of portals all across your world and dimensions.

This mod is a NeoForge re-implementation of Custom Portals (Fabric).

Portals

Build a rectangular-ish frame using any solid block, then right-click the inside with a Portal Catalyst. Create a second frame out of the exact same block, light it with a matching catalyst color, and they link up instantly.

• Any block works as a frame; stone, leafs, diamond blocks, whatever you want
• Vertical or horizontal portals work, you can build frames on walls, floors, ceilings, even floating.
• 16 catalyst colors to organize your portal network
• Portals link by matching color + frame material
• Same-dimension and cross-dimension travel (with Gate Rune)
• Colored particles and portal effects just like vanilla portals
• Baaaahhh 🐑

Catalysts

Shaped recipe: 4 ender pearls + 4 eyes of ender + 1 dye -> 2 portal catalysts

Catalysts can also be recolored: any catalyst + a dye -> 1 catalyst of the new color (shapeless).

Runes

Place rune blocks on the portal's frame to enhance it. The rune must be mounted on a block that is directly adjacent to a portal block.

Without runes, portals link within 100 blocks in the same dimension. Haste on either end of a linked pair grants instant teleportation for both sides.

Recipe Images

Linking

Portals link automatically to the nearest compatible unlinked portal (same catalyst color + same frame block). If a portal is destroyed or disabled, its partner becomes unlinked and will search for a new valid match 🥀

This system is intentionally simple and deterministic. In multiplayer or dense same-color networks, relinking may choose a different frame than you expected. That is by design: placement/distance and layout matter, and it enables more creative portal topologies.

Redstone

Redstone behavior is enabled by default: a redstone signal turns off a portal. While powered, the portal unlinks; when power is removed, it automatically re-links using the normal linking rules above.

Because this works per-portal, you can disable one end of a pair and let the freed portal find a different compatible partner if one exists. This supports builds like ABC portal switching, redstone-controlled travel networks, and multiplayer routing setups.

You can disable redstone interaction entirely in config if you prefer.

Datapacks

You can define entirely new custom portals using datapacks. With datapacks, you can:

• Pick the frame block (single block or a block tag) and catalyst item for a portal
• Set the portal's color (any of the 16 dye colors)
• Choose how the catalyst is used (consumed, damaged, or untouched) and how much
• Use linked-pair linking like the built-in portals, or scaled dimension counterpart linking that auto-generates the other side in a target dimension (like vanilla nether portals, with a configurable coordinate scale)
• Restrict the built-in 16 colored portals with a frame allowlist/blocklist tag, or by claiming a frame block exclusively for a custom portal

See examples/ for the full datapack reference and ready-to-use example datapacks.

Configuration

All settings are in custom_portals_foxified-common.toml:

Differences from the Original

Why port?

The original mod works with Sinytra Connector, but connector can break mods and adds overhead. More importantly, the original mod uses mixins to rewrite Minecraft's teleportation sequence, which can cause crashes or data loss with mods that attach data to players. It's not the original dev's fault, it's just how modding goes.

This port uses NeoForge's native Portal interface instead. Vanilla handles all player data and dimension hopping. No mixins, no data loss, so hopefully better compatibility.

Beyond compatibility, this port also includes a number of improvements over the original:

<details> <summary>Improvements over the original</summary>

Performance

• Removed per-tick block entity polling - the original mod ticks every portal block every game tick to check state. This port is fully event-driven (neighborChanged, link/unlink, rune changes)
• No block entity at all - portal state lives in world saved data with spatial indexing

Compatibility

• No mixins - the original mod uses EntityMixin, ServerPlayerMixin, and LocalPlayerMixin to rewrite teleportation. This port uses NeoForge's native Portal interface so vanilla handles all entity data and dimension transitions cleanly

Gameplay

• Rune removal revalidates links - in the original, removing a gate rune from a cross-dimension pair leaves them linked. This port properly breaks incompatible links when runes are removed

</details>

No Private Portals

The original mod's private portals feature is not included. The implementation didn't make practical sense in multiplayer. If you want to travel with a friend, what happens then? If there's real demand for portal access control, I can implement it; but a proper integration would be with something like FTB Teams.

Redstone Modes

Compared to the original mod’s three redstone modes (off, on, no effect), this port uses one consistent behavior: powered portals are disabled (redstoneDisables = true by default).
This keeps portal state predictable and supports practical routing builds; see Redstone for full behavior details.

Compatibility

• Requires NeoForge 1.21.1 (21.1.219+)

Credits

Original Custom Portals mod by Palyon (MIT licensed). This is a NeoForge reimplementation of their legendary work.

License

GPL-3.0-or-later