Add BLUEDRAGON_PUFFIN_PORT and BLUEDRAGON_GRPC_SERVER_PORT environment variables

Author: FluxCapacitor2

README.md

@@ -1,56 +1,79 @@
 # Server
-![GitHub Workflow Status (with branch)](https://img.shields.io/github/actions/workflow/status/BlueDragonMC/Server/gradle.yml?branch=main&label=Java%20CI%20with%20Gradle&logo=github)
+
+![GitHub Workflow Status (with branch)](https://img.shields.io/github/actions/workflow/status/BlueDragonMC/Server/docker-publish.yml?branch=main&label=Docker%20Build&logo=github)
 ![GitHub last commit](https://img.shields.io/github/last-commit/BlueDragonMC/Server)
 ![Jitpack CI Status](https://img.shields.io/badge/dynamic/json?color=blue&label=jitpack&query=%24.status&url=https%3A%2F%2Fjitpack.io%2Fapi%2Fbuilds%2Fcom.github.BlueDragonMC%2FServer%2Flatest&logo=gradle)
 
 [![BlueDragon Logo](./favicon_64.png)](https://bluedragonmc.com)
 
 BlueDragon's [Minestom](https://minestom.net/) implementation. It currently includes:
+
 - Creating isolated instances for different game types and modes
 - A modular system for adding functionality to games
-  - This allows for a very high degree of code reusability and simplicity, and makes rapid prototyping of games very quick and easy.
+    - This allows for a very high degree of code reusability and simplicity, and makes rapid prototyping of games very
+      quick and easy.
 - System for handling player punishments
 - Database support linked to every `Player` using a player provider
 - Synchronization with other servers using gRPC messaging and a Mongo database
 - Routing players to the correct instance when they join
 - Separated, per-instance chat and tablist functionality
 - Basic commands
 
-Minestom is a Minecraft server library targeted at developers. Their wiki is available [here](https://wiki.minestom.net).
+Minestom is a Minecraft server library targeted at developers. Their wiki is
+available [here](https://wiki.minestom.net).
 
 ## Usage
+
 Build with `./gradlew build` and run the JAR created at `build/libs/Server-x.x.x-all.jar`.
 Requires Java 17 or higher.
 
 ## Development
+
 This can be built as a docker container with the following command:
+
 ```shell
 $ DOCKER_BUILDKIT=1 docker build -t bluedragonmc/server:testing .
 ```
+
 This uses the `Dockerfile` in the current directory to build an image with the version string `"testing"`.
 *Note: A game named `Lobby` must be present for the server to run!*
 
 Environment variables:
-* `PUFFIN_VELOCITY_SECRET` - Your Velocity proxy forwarding secret (optional). If not specified, Mojang authentication will be enabled.
+
+* `PUFFIN_VELOCITY_SECRET` - Your Velocity proxy forwarding secret (optional). If not specified, Mojang authentication
+  will be enabled.
 * `BLUEDRAGON_AGONES_HEALTHCHECK_INTERVAL_MS` - The amount of time in between Agones healthcheck pings, in milliseconds.
 * `BLUEDRAGON_AGONES_RESERVATION_TIME_MS` - The amount of time in between Agones server reservations, in milliseconds.
 * `BLUEDRAGON_AGONES_DISABLED` - Disables Agones integration if set to any value.
 * `BLUEDRAGON_ENV_TYPE` - Set to "DEV" to enable development mode.
-* `BLUEDRAGON_QUEUE_TYPE` - Set to "IPC" to use Puffin or "TEST" for the `TestQueue`. If not present, a default value is inferred.
+* `BLUEDRAGON_QUEUE_TYPE` - Set to "IPC" to use Puffin or "TEST" for the `TestQueue`. If not present, a default value is
+  inferred.
 * `BLUEDRAGON_MONGO_CONNECTION_STRING` - The connection string used to connect to MongoDB.
 * `BLUEDRAGON_PUFFIN_HOSTNAME` - The hostname used to connect to Puffin.
 * `BLUEDRAGON_LUCKPERMS_HOSTNAME` - The hostname used to connect to LuckPerms.
 * `HOSTNAME` - Used to determine the server name. Provided by default in Docker or Kubernetes environments.
 * `SERVER_INSTANCE_MIN_INACTIVE_TIME` - The amount of time that an instance must be inactive before it is cleaned up.
 * `SERVER_INSTANCE_CLEANUP_PERIOD` - The amount of time in between instance cleanup tasks.
+* `BLUEDRAGON_PUFFIN_PORT` - The port used to connect to Puffin. Defaults to `50051`.
+* `BLUEDRAGON_GRPC_SERVER_PORT` - The port used to create a gRPC server. Defaults to `50051`.
+
+> [!TIP]
+> If you are running Puffin, Komodo, or multiple game server instances on the same machine without some kind of
+> networking isolation, you must change the `BLUEDRAGON_GRPC_SERVER_PORT` environment variable for each server to
+> prevent port conflicts.
 
 ## Implementation
+
 To learn how to integrate other server software with BlueDragon's systems, see the [Integration Guide](./INTEGRATION.md)
 
 ## Creating a Game
-To learn how to create a game using this library, see our [ExampleGame](https://github.com/BlueDragonMC/ExampleGame/blob/main/README.md) repository. It has guides and documentation for creating a simple game.
+
+To learn how to create a game using this library, see
+our [ExampleGame](https://github.com/BlueDragonMC/ExampleGame/blob/main/README.md) repository. It has guides and
+documentation for creating a simple game.
 
 ## Project Structure
+
 The project contains a `common` subproject, which is used by all games as an API to compile against.
 This subproject also contains many useful game modules that most games use.
 

common/src/main/kotlin/com/bluedragonmc/server/api/Environment.kt

@@ -12,6 +12,8 @@ abstract class Environment {
         val mongoConnectionString get() = current.mongoConnectionString
         val dbName get() = current.dbName
         val puffinHostname get() = current.puffinHostname
+        val puffinPort get() = current.puffinPort
+        val grpcServerPort get() = current.grpcServerPort
         val defaultGameName get() = current.defaultGameName
         val gameClasses get() = current.gameClasses
         val versionInfo get() = current.versionInfo
@@ -28,6 +30,8 @@ abstract class Environment {
     abstract val queue: Queue
     abstract val mongoConnectionString: String
     abstract val puffinHostname: String
+    abstract val puffinPort: Int
+    abstract val grpcServerPort: Int
     abstract val luckPermsHostname: String
     abstract val gameClasses: Collection<String>
     abstract val versionInfo: VersionInfo

src/main/kotlin/com/bluedragonmc/server/bootstrap/IntegrationsInit.kt

@@ -26,8 +26,8 @@ object IntegrationsInit : Bootstrap() {
             Messaging.initializeOutgoing(OutgoingRPCHandlerStub())
         } else {
             logger.info("Attempting to connect to messaging at address ${InetAddress.getByName(Environment.puffinHostname).hostAddress}")
-            Messaging.initializeIncoming(IncomingRPCHandlerImpl())
-            Messaging.initializeOutgoing(OutgoingRPCHandlerImpl(Environment.puffinHostname))
+            Messaging.initializeIncoming(IncomingRPCHandlerImpl(Environment.grpcServerPort))
+            Messaging.initializeOutgoing(OutgoingRPCHandlerImpl(Environment.puffinHostname, Environment.puffinPort))
             runBlocking {
                 Messaging.outgoing.initGameServer(Environment.getServerName())
             }

src/main/kotlin/com/bluedragonmc/server/impl/IncomingRPCHandlerImpl.kt

@@ -12,9 +12,9 @@ import org.slf4j.LoggerFactory
 import java.util.*
 import java.util.concurrent.TimeUnit
 
-class IncomingRPCHandlerImpl : IncomingRPCHandler {
+class IncomingRPCHandlerImpl(serverPort: Int) : IncomingRPCHandler {
 
-    private val server = ServerBuilder.forPort(50051)
+    private val server = ServerBuilder.forPort(serverPort)
         .addService(GameClientService())
         .addService(PlayerHolderService())
         .build()
@@ -23,7 +23,7 @@ class IncomingRPCHandlerImpl : IncomingRPCHandler {
 
     init {
         server.start()
-        logger.info("gRPC server started on port 50051")
+        logger.info("gRPC server started on port $serverPort")
     }
 
     override fun isConnected() = !server.isShutdown && !server.isTerminated

src/main/kotlin/com/bluedragonmc/server/impl/OutgoingRPCHandlerImpl.kt

@@ -28,12 +28,12 @@ import net.minestom.server.instance.Instance
 import java.util.*
 import java.util.concurrent.TimeUnit
 
-class OutgoingRPCHandlerImpl(serverAddress: String) : OutgoingRPCHandler {
+class OutgoingRPCHandlerImpl(serverAddress: String, serverPort: Int) : OutgoingRPCHandler {
 
     private lateinit var serverName: String
 
     private val channel =
-        ManagedChannelBuilder.forAddress(serverAddress, 50051)
+        ManagedChannelBuilder.forAddress(serverAddress, serverPort)
             .defaultLoadBalancingPolicy("round_robin")
             .usePlaintext()
             .enableRetry()

src/main/kotlin/com/bluedragonmc/server/queue/environments.kt

@@ -30,6 +30,8 @@ class ConfiguredEnvironment : Environment() {
 
     override val mongoConnectionString: String = System.getenv("BLUEDRAGON_MONGO_CONNECTION_STRING") ?: defaultMongoConnectionString()
     override val puffinHostname: String = System.getenv("BLUEDRAGON_PUFFIN_HOSTNAME") ?: defaultPuffinHostname()
+    override val puffinPort: Int = System.getenv("BLUEDRAGON_PUFFIN_PORT")?.toIntOrNull() ?: 50051
+    override val grpcServerPort: Int = System.getenv("BLUEDRAGON_GRPC_SERVER_PORT")?.toIntOrNull() ?: 50051
     override val luckPermsHostname: String = System.getenv("BLUEDRAGON_LUCKPERMS_HOSTNAME") ?: defaultLuckPermsHostname()
 
     override val gameClasses: Collection<String> = GameLoader.gameNames