Direct Connect vs Invite Codes: How Players Join

Overview

Windrose supports two methods for players to join a dedicated server: invite codes and direct IP connection. The method you use is controlled by the USE_DIRECT_CONNECTION startup variable and network configuration. Each method has different network requirements.

Invite Code Mode

When USE_DIRECT_CONNECTION is set to false (the default), players join using an invite code. The invite code is set in ServerDescription.json:

"InviteCode": "CREW01"

Requirements:

• The invite code must be at least 6 alphanumeric characters.
• UPnP must be enabled on the host router or network. The server uses UPnP to establish a NAT punch-through so players can reach it without manual port forwarding.
• No manual port forwarding is required when UPnP is working correctly.

Invite codes are the simpler option for home networks and environments where you control the router. They are not recommended for datacenter or VPS hosting where UPnP is typically unavailable.

Direct IP Mode

When USE_DIRECT_CONNECTION is set to true, players connect by entering the server's IP address and port directly in the game client. The game port defaults to 7777 (TCP/UDP).

Requirements:

• The game port (7777 by default) must be exposed and reachable from the internet.
• The panel's port allocation must include the game port.
• Port forwarding or firewall rules must be configured to pass traffic on the game port to the container.

Direct IP mode is recommended for VPS and dedicated hardware hosting in datacenters where UPnP is not available.

Switching Between Modes

To switch modes, update the USE_DIRECT_CONNECTION variable in the panel and restart the server. No changes to ServerDescription.json are required — the startup variable controls the behavior.

Sharing Connection Details with Players

Invite code mode: Share the InviteCode value from ServerDescription.json. Players enter this code in the game's join screen.

Direct IP mode: Share the server's public IP and port in the format:

203.0.113.45:7777

Troubleshooting Connection Failures

If players cannot connect in invite code mode:

• Confirm UPnP is enabled on the host network/router.
• Check that the InviteCode in ServerDescription.json is at least 6 alphanumeric characters.
• Review R5.log for NAT or UPnP error messages.

If players cannot connect in direct IP mode:

• Confirm the game port is open in the panel's port allocations.
• Verify firewall rules allow inbound traffic on port 7777 TCP and UDP.
• Test connectivity using a port scanner from an external IP before asking players to try.

Related

• Port Forwarding and Network Configuration
• Configuring Your Server with ServerDescription.json
• Installing and Starting a Windrose Dedicated Server
• Troubleshooting Common Windrose Server Issues