Restricted Portals Mod — Guide

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.

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: 1. Add twilightforest:twilight_forest to the Dimension Resource Names list. 2. Add twilightforest:naga_trophy to the Crafted Items list. 3. Add Twilight Forest to 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.

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.

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.

End Crystal Recipe

To unlock the End, players must have already accessed the Nether to obtain high-tier materials like the Nether Star.

(Note: These recipes can be modified by modpack creators using Datapacks or KubeJS.)