diff --git a/docs/using-ngrok-with/minecraft.md b/docs/using-ngrok-with/minecraft.md index 140e9bd9d..acd8fc116 100644 --- a/docs/using-ngrok-with/minecraft.md +++ b/docs/using-ngrok-with/minecraft.md @@ -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. diff --git a/static/img/howto/minecraft/client_disconnected.png b/static/img/howto/minecraft/client_disconnected.png new file mode 100644 index 000000000..219c6928d Binary files /dev/null and b/static/img/howto/minecraft/client_disconnected.png differ diff --git a/static/img/howto/minecraft/server_disconnected.png b/static/img/howto/minecraft/server_disconnected.png new file mode 100644 index 000000000..203922038 Binary files /dev/null and b/static/img/howto/minecraft/server_disconnected.png differ