Skip to content

Latest commit

 

History

History
39 lines (24 loc) · 1.26 KB

README.md

File metadata and controls

39 lines (24 loc) · 1.26 KB
Raw

Komodo

BlueDragon's Velocity plugin. It currently serves a few purposes:

  • Routing players to servers based on received gRPC messages
  • Dynamically create and remove servers based on other gRPC calls
  • Requesting a player count from an external service and generating a server list ping response with it
  • Sending players to a lobby when they first join

Usage

Build with ./gradlew build and place the JAR from build/libs/Komodo-x.x.x.jar in your Velocity proxy's plugins folder.

Configuration

Environment variables:

  • KOMODO_PUFFIN_URI: The URI used to connect to Puffin. Should comply with this document.

    Default value: puffin:50051

  • KOMODO_GRPC_PORT: The port used for Komodo's gRPC server.

    Default value: 50051

Development

This can be built as a docker container with the following command:

$ docker build -t bluedragonmc/komodo:dev .

This uses the Dockerfile in the current directory to make an image with Velocity, Komodo, and a few other plugins.

Note: When running inside Docker, a PUFFIN_VELOCITY_SECRET environment variable must be passed to the container, which is used to create the forwarding.secret file in the container.