⚡ EasyPortal

EasyPortal revolutionizes Minecraft travel by enabling custom-shaped, PIN-secured portals with seamless 1:1 linking through an intuitive in-game GUI.

Built for Minecraft 1.21.1 on Fabric — by SoloDev

---

✨ Features

🎨 Portal Shape Designer

• 16×16 Grid Editor — Draw any portal frame shape you want, block by block.
• Left-Click to draw, Right-Click to erase — supports click-and-drag painting.
• Inventory-Aware — The block palette is sourced directly from your inventory. Choose any block you have as the frame material.
• Reset Canvas button to start fresh at any time.

🔗 Portal Linking

• OneWay — Teleport to a saved coordinate destination (one-directional exit).
• Bidirectional Link — Create a two-way connection between two portals.
• 1:1 Exclusive Linking — Each portal can only be linked to one other portal at a time. No multi-linking allowed.
• Automatic Destination Resolution — Link portals by name; the mod resolves coordinates automatically.

🔒 Security System

• Private Portals — Mark any portal as private to restrict access.
• PIN Code Protection — Set a numeric PIN that guests must enter via a pop-up GUI.
• Session-Based Auth — Enter the PIN once per session; no re-entry until you disconnect.
• Owner Bypass — Portal owners always pass through without being prompted.
• Admin Bypass — Server operators (OP Level 2+) or players with easyportal.admin can bypass all PIN gates.
• Shared PIN for Links — When linking two portals, a PIN set on one side is automatically shared with the linked portal.
• Auth Cooldown — After cancelling the PIN prompt, it won't re-appear instantly. A cooldown triggers before the prompt shows again.

🌈 Portal Colors

• 9 Built-In Colors: Cyan, Purple, Red, Green, Blue, Magenta, Yellow, Orange, Pink.
• Hex Color Picker — Use the advanced color picker in the GUI to set any custom RGB hex color for portal particles and gateway blocks.
• Animated Portal Gateway — Each portal has a custom-rendered, translucent animated block with your chosen color.

👻 Preview & Placement

• Ghost Preview — After designing your portal, a translucent holographic outline follows your crosshair showing exactly where it will be built.
• Rotation — Press [R] to rotate the portal (North → East → South → West).
• Orientation Toggle — Press [Middle Mouse] to switch between Vertical (wall) and Horizontal (floor/ceiling) alignment.
• Right-Click to Confirm — Place the portal with a right-click.
• Left-Click to Cancel — Abort placement at any time.
• Block Requirements HUD — While placing, a live checklist on the left of the screen shows required blocks vs. what you have (e.g., Dirt 4/5). Missing blocks are highlighted.
• Key Hints HUD — On-screen hints on the right side remind you of all placement controls.

⚙️ Behavior Settings

• Teleport Cooldown — Set a 0–60 second cooldown between consecutive teleports per portal (slider in the GUI).
• Entity Teleportation — Toggle "Allow Mobs / Items / Entities" to let non-player entities (mobs, dropped items, etc.) pass through portals.
• Resistance Buff — Players receive 3 seconds of Resistance V after teleporting, preventing fall damage.
• Teleport Effects — Particles and ender teleport sound play at both origin and destination.
• Dimension Overlay — When teleporting across dimensions, a colored screen overlay effect (matching portal color) fades in and out.

📋 Portal Network Dashboard

• Open with [Right Shift] or /easyportal gui.
• Portal List — View all your portals in a sleek, searchable table.
• Search — Filter portals by name, owner, or destination.
• Delete — Remove portals with a confirmation popup.
• "+ NEW PORTAL" button to jump directly into the Portal Designer.
• Admin View — Admins can see and manage all players' portals.

🌍 Cross-Dimension Support

• Portals work across all dimensions — Overworld, Nether, End, and modded dimensions.
• Destinations store dimension identifiers and resolve them at teleport time.

🏗️ Survival Friendly

• Portal frames consume blocks from your inventory in Survival mode.
• Creative mode bypasses block requirement checks.

🛡️ Frame Integrity

• Automatic Destruction — If a player breaks a block that is part of a portal's frame, the portal is destroyed and the player is notified.
• Periodic Validation — When validateFrame is enabled in the config, the server periodically checks portal integrity and removes broken portals.

🗂️ Configuration

The mod generates easyportal.json in the config directory with the following options:

Option	Default	Description
defaultPortalLimit	5	Maximum number of portals per player.
enableClaimProtection	true	Prevents building portals in claimed areas.
validateFrame	false	Enables periodic server-side frame integrity checks.

---

🚀 Installation

1. Install Minecraft 1.21.1 with Fabric Loader (≥ 0.18.4).
2. Install Fabric API.
3. Download easyportal-1.21.1.jar and place it in your .minecraft/mods folder.
4. Launch the game!

---

📖 How to Use

1. Open the Portal Dashboard

• Press the default keybind: [Right Shift]
• Or run the command: /easyportal gui

This opens the Portal Network Dashboard where you can view all your portals, search, delete, or create new ones.

2. Create a New Portal

Click "+ NEW PORTAL" in the dashboard to open the Portal Designer. The designer has two panels:

Left Panel — Shape Editor

• Draw your portal frame on the 16×16 grid.
• Left-Click (or drag) to paint blocks. Right-Click (or drag) to erase.
• Select your frame block from the Frame Material section (sourced from your inventory).

Right Panel — Configuration

The configuration sidebar has 5 collapsible sections:

1. Identity & Network

• Portal Name — Give your portal a unique name.
• Network Mode — Choose Oneway (Exit Only) or Bidirectional Link.
• Target Destination — Select from available destinations/portals.

2. Gateway Aura

• Atmosphere Tint — Pick a color for portal particles and blocks using the color picker.

3. Frame Material

• Browse and select any block from your inventory as the portal frame.

4. Security

• Private Portal checkbox — Restricts access.
• Portal PIN — Required when private is enabled. Guests must enter this PIN.
• When linking to a portal that already has a PIN, the existing PIN is automatically shared.

5. Behavior

• Teleport Cooldown — Slider from 0 to 60 seconds.
• Allow Mobs / Items / Entities — Enable entity pass-through.

3. Preview & Place

1. Click "PREVIEW & PLACE" to close the designer and enter placement mode.
2. A ghost outline of your portal appears at your crosshair.
3. Rotate: Press [R].
4. Toggle Orientation: Press [Middle Mouse Button] to switch between wall and floor/ceiling.
5. Confirm: Right-Click to build the portal.
6. Cancel: Left-Click to abort.

Note: In Survival, you must have the required blocks in your inventory. The block requirement HUD on screen shows what you have vs. what's needed.

4. Using Portals

Simply walk into the portal gateway blocks to teleport. The mod detects your position and triggers teleportation automatically.

• Public portals — Anyone can use them.
• Private portals — A PIN entry GUI appears. Enter the correct PIN to unlock.
• Once authenticated, you won't be prompted again until you log out (session-based).

5. Managing Destinations

Create standalone coordinate destinations for OneWay portals using commands:

Command	Description
/easyportal setDest <name>	Saves your current position as a destination.
/easyportal delDest <name>	Deletes a saved destination (with tab-completion).

These destinations appear in the Portal Designer's Target Destination dropdown when using OneWay mode.

6. Managing Portals

• View: Open the dashboard with [Right Shift].
• Search: Use the search bar to filter by portal name, owner, or destination.
• Delete: Click the DEL button next to any portal, then confirm.
• Auto-Destruction: Breaking a frame block in-world destroys the portal automatically.

---

🤝 Permissions

Permission	Level	Description
easyportal.admin	OP 2+	Bypass PIN protection, view & manage all players' portals.

---

🛠️ Dependencies

Dependency	Version
Minecraft	1.21.1
Fabric Loader	≥ 0.18.4
Fabric API	Any
Java	≥ 21

---

⌨️ Default Keybinds

Key	Action
Right Shift	Toggle Portal Dashboard
R	Rotate portal during placement
Middle Mouse	Toggle vertical/horizontal orientation during placement
Right-Click	Confirm portal placement
Left-Click	Cancel portal placement
ESC	Close any GUI

---

Created by SoloDev ⚡