Server Sided Portals

📝 Description

This is a mod API that provides easily customizable and server-sided portals to any custom dimension. This mod is required server side only, and is thus compatible with any client, Vanilla included. This mod can be used as a dependency for another mod/datapack, or bundled in a modpack with a custom datapack or with mods that require it.

Check out the usage details below or on the Wiki!

✨ Features

• 🔮 Custom Portals: Create portals with fully customizable frames linked to any dimension.
• 🧱 Flexible Frame Design: Define valid frame blocks using block tags — supports multiple block types!
• 🔥 Custom Igniters: Choose which items can light the portal using item tags — supports multiple items!
• 🖥️ Server-Side Only: No need to install the mod on clients — works entirely server-side.
• 🌍 Cross-Dimension Support: Add portals to any dimension, even ones added by other mods.
• ✅ Fully Compatible: Works seamlessly with both Vanilla and modded clients.
• 🧩 Mod & Datapack Friendly: Simple integration whether you're using a datapack or developing a mod.
• 📚 Comprehensive Wiki: Check out the Wiki for guides, examples, and more features!

🚀 Usage

For detailed examples, check out the Wiki. There, you'll find step-by-step guides for creating custom dimensions, portal frames, igniters, and additional tweaks!

📦 Datapack

Making use of this mod with a datapack is easy! Just follow these simple steps:

1. Set up a datapack: Start by creating a datapack following this Minecraft tutorial.
2. Define a dimension Type: Generate a custom dimension type with this generator.
3. Create your dimension: Use this generator to set up your custom dimension.
4. Specify portal frame blocks: Create a block tag called dimension_portal_frame, replacing dimension with your dimension name. You can include multiple blocks or even other tags!
5. (Optional) Choose portal igniters: Optionally create an item tag named dimension_portal_igniter, replacing dimension with your dimension name, for items that can ignite the portal. You can also use multiple items or tags.
6. Organize your files: Make sure all JSON files from the above steps are under the same namespace.