Skip to content

Commit

Permalink
update minecraft docs (#708)
Browse files Browse the repository at this point in the history
Co-authored-by: Niji <[email protected]>
  • Loading branch information
masonj5n and nijikokun authored May 8, 2024
1 parent cbe3589 commit ebe5fe2
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 2 deletions.
25 changes: 23 additions & 2 deletions docs/using-ngrok-with/minecraft.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,27 @@ title: Minecraft

Minecraft requires the use of an ngrok TCP tunnel to share your server with others. Use `ngrok tcp 25565` to open a TCP tunnel on the default Minecraft port. You can then use the address provided to connect to your Minecraft server.

The free version of ngrok does not allow you to get a permanent TCP address, which means when you restart the agent, you will need to send a new TCP address to your players. Our paid accounts allow you to reserve a TCP Address for reuse. In this case, you would start the TCP tunnel using `ngrok tcp --remote-addr TCP_ADDRESS 25565`.
The free version of ngrok has the following restrictions:

CAUTION: The TCP tunnel you open is available to anyone by default. Our paid accounts allow you to restrict access to specific IP Addresses using IP Restrictions.
- **No permanent TCP address**
- When you restart the agent, you will need to send a new TCP address to your players. Our paid accounts allow you to reserve a TCP Address for reuse. In this case, you would start the TCP tunnel using `ngrok tcp --remote-addr TCP_ADDRESS 25565`.
- **Bandwidth Limits**
- The free plan includes a limited amount of bandwidth per month which will prevent players from connecting to your server when exceeded.
- **No IP Restrictions**
- Your Minecraft server will be available to anyone by default.

Static/unchanging addresses, increased bandwidth limits, and IP Restrictions are all available with our [paid accounts](https://ngrok.com/pricing).

## Troubleshooting

### Bandwidth Limit Exceeded

If you exceed the bandwidth limit on your account players will no longer be able to connect to your server.

Players attempting to connect to your server may see a "Disconnected" message in the Minecraft client.
![Minecraft Client Disconnected](/img/howto/minecraft/client_disconnected.png)

Your server logs may indicate the client connecting and immediately disconnecting.
![Minecraft Server Logs](/img/howto/minecraft/server_disconnected.png)

Check your [usage](https://dashboard.ngrok.com/usage) page to ensure you haven't exceeded your "Bandwidth Limit Out" limit.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ebe5fe2

Please sign in to comment.