Getting Started
install
setup
account

Quick Start

Install mod + create account + host your first session in minutes.

Overview

Get up and running with Tunnely in under 5 minutes. No port forwarding, no complicated network configuration - just install the mod, create an account, and start hosting.

Quick Summary

  • Install Architectury API dependency and Tunnely mod for your loader
  • Press U → Login/Register → Create account
  • Open a world → Host Game → choose visibility → Start Hosting
  • Share endpoint or invite friends to join

How It Works

1

Download Architectury API (required dependency) for your mod loader from Modrinth or CurseForge.

2

Download the Tunnely mod for your specific loader (Fabric/Forge/Quilt) and Minecraft version.

3

Place both .jar files in your mods folder, typically located at .minecraft/mods/

4

Launch Minecraft and press U (default keybind) to open the Tunnely interface.

5

Click Login/Register, create your account with email and password, and you're ready to host!

Use Cases

Real-World Examples

First Time Setup

Download both mods, drop in mods folder, launch game, press U, register account, open world, click 'Host Game', select Friends Only, click Start - done in 3 minutes!

Quick Friend Session

Already set up? Just open your world, press U, click Host Game, choose visibility, start hosting, and share the endpoint with your friend.

Modpack Hosting

The same process works with modpacks - just ensure everyone has the same pack installed for compatibility.

Technical Details

  • Tunnely is a client-side mod that works on any world, including singleplayer worlds.
  • Architectury API is required as it provides cross-loader compatibility.
  • Your account is stored securely in Supabase with encrypted credentials.
  • The mod creates a virtual server using your existing world without requiring dedicated server software.

Best Practices

  • Make sure both Architectury API and Tunnely are for the same Minecraft version and loader.
  • Use a strong password for your account - it protects your hosting privileges.
  • Test hosting in a test world first before inviting friends to your main world.
  • Start with Friends Only visibility for your first session to get comfortable with the interface.

Common Issues & Solutions

  • If the U key doesn't work, check for keybind conflicts in Minecraft settings.
  • Architectury API must be installed first - Tunnely won't load without it.
  • Make sure you download the correct loader variant (Fabric vs Forge vs Quilt).
  • If login fails, check your internet connection and verify your email/password.

TAGS

install
setup
account
host