Immersive Portals Mod Documentation

Immersive Portals is a Minecraft mod (Fabric version) that enables see-through portals and seamless teleportation. It allows for 'Non-Euclidean' space effects by changing underlying Minecraft mechanics to permit the client to load multiple dimensions simultaneously and synchronize remote world information (blocks/entities) to the client. Key features include:

• Portal-in-portals rendering: Visualizing nested portals.
• Scale and Gravity transformation: Portals can modify player scale and the direction of gravity.
• Compatibility: Portal rendering is roughly compatible with certain versions of Sodium and Iris.

Note: This repository contains the Fabric version. For the Forge/NeoForge version, refer to the iPortalTeam/ImmersivePortalsModForNeo repository.

Since this is a Fabric mod, you should follow the official Fabric development setup guide to prepare your environment for running or building the code.

Follow the instructions at: https://fabricmc.net/wiki/tutorial:setup

The mod provides an API that allows other mods to interact with its core systems. Developers can use the API to:

• Manage see-through portals
• Dynamically add dimensions
• Synchronize remote chunks to the client
• Render the world into a GUI
• Access other utilities

For detailed technical documentation on specific classes and methods, refer to the API description.

Targets the portal you are currently pointing at to change its orientation. This is a targeted command; you must be looking at the portal entity.

Arguments:

• rotation (Rotation): The new Euler angles for the portal's orientation.

/set_orientation <rotation: rotation>

Creates a specialized item (command stick) that can execute sub-commands. Requires permission level 2.

Arguments:

• command (SubCommand): The specific sub-command to bind to the stick.

/create_command_stick <command: subcommand>

The AxisArgumentType is a custom Brigadier argument type used in Immersive Portals commands to select a spatial axis. It accepts case-insensitive inputs for the X, Y, or Z axes.

Accepted Values:

• x or X maps to Direction.Axis.X
• y or Y maps to Direction.Axis.Y
• z or Z maps to Direction.Axis.Z

If an invalid string is provided, the command will throw an error: Invalid Axis <input>.

// Example of how this type is used within a command context to retrieve the axis
Direction.Axis axis = AxisArgumentType.getAxis(context, "argName");

Executes dimension stack management logic. This command requires permission level 2.

/dimension_stack

To use the SubCommandArgumentType in custom Minecraft commands within the Immersive Portals environment, you must call the init() method. This registers the argument type under the resource location imm_ptl:sub_command_argument_type using the Fabric ArgumentTypeRegistry.

SubCommandArgumentType.init();

The TimingFunctionArgumentType allows you to pass a TimingFunction enum value as an argument in Minecraft commands. When using a command that requires this argument, you must provide the exact name of one of the available TimingFunction constants.

If an invalid string is provided, the command will fail with the error: Invalid Timing Function <input>.

// Example of how a developer would retrieve the parsed TimingFunction from a command context
TimingFunction function = TimingFunctionArgumentType.get(context, "argName");