Overview#
Restricted Portals is a progression-control mod that prevents players from entering specific dimensions until they have met certain requirements—typically crafting a unique "Dimensional Crystal." This mod is widely used in multiplayer environments and expert-style modpacks to prevent players from skipping early-game content or rushing to end-game dimensions for strategic advantages.
In modern versions (1.20.1 and 1.21.x), the mod utilizes the Minecraft advancement system to track player progress. Once a player crafts the required item, they are granted a hidden or visible advancement that serves as a permanent "key" for that dimension. Without this advancement, the player is physically repelled from portal blocks and notified of the missing requirement via a customizable chat message.
Mechanics#
The mod operates through a simple check-and-block system that triggers whenever a player interacts with a portal block.
Portal Blocking
When a player touches a portal block (such as a Nether Portal or End Portal), the mod checks the player's advancement data. If the player has not yet crafted the item associated with that dimension, the following occurs:
- Repulsion: The player is immediately pushed back from the portal, preventing them from teleporting.
- Notification: A message is displayed in the chat or action bar (configurable) informing the player which item is required to unlock access.
Advancement Integration
The mod automatically generates advancements based on the configuration file. Crafting the designated item triggers the advancement. This ensures that once a player has proven their progression by crafting the crystal, they have permanent access to the dimension, even if they lose the item later.
Blocking the Overworld
A unique feature of the mod is the ability to block access to the Overworld. This is particularly useful for modpacks where the player starts in a different dimension (e.g., The Lost Cities, Twilight Forest, or a Skyblock void) and must earn their way into the main world.
Items#
Restricted Portals adds two primary items by default, which serve as the standard keys for vanilla dimensions. These items have no function other than being crafted to unlock access.
| Item | Registry Name | Purpose |
|---|---|---|
| Nether Crystal | restrictedportals:nether_crystal |
Crafted to unlock access to the Nether dimension. |
| End Crystal | restrictedportals:end_crystal |
Crafted to unlock access to the End dimension. |
Recipes#
The default recipes for the Dimensional Crystals are designed to be challenging, requiring materials found in the current stage of gameplay.
Nether Crystal Recipe
To unlock the Nether, players must typically gather materials from the Overworld, including obsidian and diamonds.
| Result | Ingredients | Pattern |
|---|---|---|
| Nether Crystal | 4x Obsidian, 4x Gold Ingot, 1x Diamond | O G O, G D G, O G O |
End Crystal Recipe
To unlock the End, players must have already accessed the Nether to obtain high-tier materials like the Nether Star.
| Result | Ingredients | Pattern |
|---|---|---|
| End Crystal | 4x Ender Pearl, 4x Blaze Rod, 1x Nether Star | E B E, B N B, E B E |
(Note: These recipes can be modified by modpack creators using Datapacks or KubeJS.)
Configuration#
The mod is highly customizable via its configuration file. On Forge, this is located at config/restrictedportals-common.toml, and on Fabric, it is found at config/restrictedportals.json.
Config Options
| Option | Description | Default Value |
|---|---|---|
| Crafted Items | A list of item IDs that must be crafted to unlock dimensions. | ["restrictedportals:nether_crystal", "restrictedportals:end_crystal"] |
| Dimension Resource Names | The registry IDs of the dimensions to be locked. | ["minecraft:the_nether", "minecraft:the_end"] |
| Dimension Display Names | The names of the dimensions as they appear in-game. | ["Nether", "End"] |
| Advancement Title | The title of the advancement granted. Supports %dim%. |
"%dim% Traveler" |
| Advancement Description | The description of the advancement. Supports %item% and %dim%. |
"Craft a %item% to enter the %dim%" |
| Blocked Message | The message sent to players when they are denied entry. | "You must craft a %item% to enter the %dim%!" |
Placeholders
%dim%: Replaced by the Dimension Display Name.%item%: Replaced by the name of the required item.
Customization & Datapacks#
Restricted Portals is not limited to the Nether and the End. It can be used to lock any dimension from any mod (e.g., The Twilight Forest, Blue Skies, or Bumblezone).
Adding Modded Dimensions
To lock a modded dimension, add the dimension's ID and a corresponding item ID to the configuration file. For example, to lock the Twilight Forest behind a Naga Trophy:
- Add
twilightforest:twilight_forestto the Dimension Resource Names list. - Add
twilightforest:naga_trophyto the Crafted Items list. - Add
Twilight Forestto the Dimension Display Names list.
Custom Advancement Datapacks
Advanced users can create custom advancement datapacks to change the criteria for unlocking a dimension. Instead of crafting an item, you can set the requirement to killing a specific boss, reaching a certain coordinate, or completing a quest. The mod will respect these custom advancements as long as they follow the internal naming convention generated by the mod's config.