Server Portals

This mod enables the creation of server-side portals that activate using configured blocks and items. When passing through a portal, a specified command is executed. Compatible with vanilla clients. If the mod is also installed on the client, the portal frame can be displayed in various colors configured on the server.

Installation

To use this mod, Fabric, Fabric API, and owo-lib are required. The project source code is available on GitHub.

Usage Instructions

Important: After making changes to portal settings, the server must be restarted!

View the list of configured portals:

/serverportals list

Register a new portal:

/serverportals register NAME FRAME_BLOCK LIGHT_UP_ITEM COLOR COMMAND

Example: /serverportals register test minecraft:bone_block minecraft:ender_eye black "say hello" creates a portal with a frame made of bone blocks, activated by an ender eye, which will display a greeting when passed through.

Delete a portal:

/serverportals unregister NAME

Example Configuration

Settings are stored in the file /config/server-portals.json5. Changes to the configuration while the server is running will be overwritten by portal configuration commands.

{
  "logLevel": 0,
  "portals": [
    {
      "index": "say_hello_portal",
      "frameBlockId": "minecraft:bone_block",
      "lightWithItemId": "minecraft:ender_eye",
      "color": 0,
      "command": "say \"hello world\""
    },
    {
      "index": "tp_portal",
      "frameBlockId": "minecraft:gold_block",
      "lightWithItemId": "minecraft:ender_eye",
      "color": 5592575,
      "command": "tp @p 0 100 0"
    }
  ]
}

Integration with ProxyCommands

To create a portal to another server, use the command:

/serverportals register NAME BLOCK ITEM COLOR "proxycommand \"server SERVERNAME\""

Example:

/serverportals register server_creative minecraft:bone_block minecraft:ender_eye black "proxycommand \"server creative\""

Known Issues

An error message may appear in the server logs when registering a portal without a dimension, but the command will execute correctly.