roj1

🏮 Roj1 (Roji)

Roj1 (pronounced as Roji, Japanese for "alleyway") is a lightweight tool that carves a private, 1-to-1 path between any two points on the internet. Share Minecraft servers, AI APIs, or local databases directly and securely—without port forwarding, static IPs, or middleman fees.

Why Roj1?

While the public internet becomes increasingly crowded and monetized, Roj1 offers a quiet, hidden passage.

• Zero Tolls: No subscriptions, no bandwidth caps, and no infrastructure costs.
• Pure P2P: Your data stays between you and your peer. No traffic ever touches a central relay server.
• Single Binary: A single Go binary. No drivers, no complex networking, just a direct link.
• NAT-Proof: Effortlessly traverses home routers and mobile hotspots using STUN/WebRTC.
• Lightweight: The core is built using only the gorilla/websocket and pion/webrtc libraries.

Common Use Cases

Getting Started

Prerequisites (Host Only)

The Host needs Visual Studio Code installed to handle the initial handshake via its native Port Forwarding feature (requires a GitHub login).

Setup

1. Download: Get the latest binary for your OS from the Releases page.
2. Launch: Run the executable in your terminal.

For the Host:

1. Launch roj1 and select Host.
2. Enter your local service port (e.g., 25565).
3. In VS Code's Ports panel, forward the port provided by the CLI and set visibility to Public.
4. Share the generated Forwarded URL with your peer.
5. Once connected, you can stop the VS Code forward; the P2P tunnel is now independent.

For the Peer:

1. Launch roj1 and select Client.
2. Paste the URL provided by the Host.
3. Choose a local port to map the service to.
4. Access the service at 127.0.0.1:<your_port>.

CLI Arguments

For automation or LAN setups, Roj1 can be launched entirely from the command line, bypassing the interactive prompts. If -role is omitted, the tool falls back to the default interactive mode.

Host example:

roj1 -role host -port 25565 -wsPort 9000 -wsListen

Client example:

roj1 -role client -port 25565 -wsUrl ws://192.168.1.10:9000/ws

TIP: When both machines are on the same local network, use -wsListen on the Host to make the WebSocket signaling server directly reachable via LAN IP. This eliminates the need for VS Code Port Forwarding entirely — the Client simply connects using ws://<host-lan-ip>:<wsPort>/ws.

Network Compatibility

• Optimal: Fiber, Home Wi-Fi, 4G/5G mobile hotspots.
• Limited: Strict corporate firewalls (Symmetric NAT) or public Wi-Fi with P2P blocking.

Support

Report bugs or suggest features via GitHub Issues. Please include your OS version and any error logs.