Learn How to Use Tunnely
Everything you need to know to host and share your Minecraft servers
Features
Visibility Modes (Public, Friends Only, Invite Only)
Granular control over who can discover and join your server.
- Public: listed for any authenticated user
- Friends Only: visible and joinable by accepted friends
- Invite Only: not listed; requires invite or known endpoint
- + 1 more...
Direct Messaging
One-to-one chat with polling delivery, unread counts, and read receipts.
- 3s polling; loads last 50 messages per conversation
- RLS ensures only friends can message
- Unread badges, timestamps, read receipts (✓/✓✓)
- + 1 more...
Offline Mode & Gamemode Selector
Toggle authentication mode and set default gamemode (Survival/Creative/Adventure/Spectator).
- Offline mode surfaces a clear anti‑piracy warning
- Gamemode cycles with emoji labels; persists to config
- Server init applies authentication + gamemode settings
No Modpack Warning
Warns vanilla users when browsing public modpack servers.
- Modal popup on first visit to Public Lobbies
- Explains compatibility risks and options
- One‑per‑session UX; does not block browsing
Getting Started
Quick Start
Install mod + create account + host your first session in minutes.
- 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
- + 1 more...
Dedicated Server Support
Use Tunnely on headless server installs.
- Install loader + Architectury + Tunnely
- Configure relay and Supabase in config JSON
- CLI commands: /tunnel login | start | status | endpoint
Networking
Multi-Hop Relay Routing
Optimized routes across relays lower cross-region latency by 30-50%.
- Dijkstra-based route optimizer with hop penalty
- Mesh monitoring + adaptive re-routing on degradation
- HMAC-auth + TLS/WSS between relays
- + 1 more...
Regions and Relay Selection
Automatic region/relay selection based on measured latency.
- NA/EU/APAC relays with fast fallback
- Browser shows server region; filter by region
- Mesh pathing for cross-region parties
Multi‑Port Forwarding
Forward additional UDP/TCP ports for voice chat and services.
- Auto-detect Simple Voice Chat / Plasmo Voice
- Full UDP support with per-port rate limiting
- Packet size validation and auto‑retry logic
- + 1 more...
Bandwidth Compression
Automatic GZIP compression cuts bandwidth by 50‑80%.
- Application‑layer compression for Minecraft packets
- Minimal CPU overhead, mesh‑aware
- Improves chunk and gameplay packet throughput
- + 1 more...
Relay Mesh Monitoring
Continuous topology measurements and health status.
- Latency probing and connection state tracking
- Optimal route cache with re‑routing triggers
- Metrics endpoints for production monitoring
Security
Encryption V2 (Key Sync Reliability)
Fixes key sync race conditions with proactive init, validation, and caching.
- Keys generated on login; sync before chat
- Validate RSA keys; self-test roundtrip
- Local public key cache with force refresh on chat open
- + 1 more...
Authorization Layers
Defense‑in‑depth across UI, DB RLS, and relay checks.
- Client UI shows only accessible servers
- Database Row‑Level Security enforces visibility
- Relay validates join attempts against DB
- + 1 more...
Systems
Compatibility System
Prevents version/loader/modpack mismatches and surfaces compatibility in the browser.
- Detects Minecraft version, loader, modpack ID/version
- Stores in DB and displays badges in server browser
- Match rules: version and loader must match; modpack (if both present) must match
- + 1 more...
Player Capacity Tracking
Live player counts with capacity enforcement across UI, DB, and relay.
- Tracks current/max players via heartbeats
- Disables Join UI when at capacity
- Relay rejects over-capacity joins (policy violation)
- + 1 more...