README.md

portum

Modern and flexible implementation of the minecraft votifier protocol. Thought as embedded service or middleware.

Portum uses theresa for dependency injection and constrictor for networking.

Build status

	Build Status
Master

Installation

Maven Repositories

<repositories>
    <!-- Klauke Enterprises Releases -->
    <repository>
        <id>klauke-enterprises-maven-releases</id>
        <name>Klauke Enterprises Maven Releases</name>
        <url>https://repository.klauke-enterprises.com/repository/maven-releases/</url>
    </repository>
</repositories>

Maven dependency

<dependencies>
  <dependency>
    <groupId>com.felixklauke.portum</groupId>
    <artifactId>portum-server</artifactId>
    <version>1.0.0</version>
  </dependency>
</dependencies>

Gradle Repositories

repositories {
  maven {
    url = 'https://repository.klauke-enterprises.com/repository/maven-releases/'
  }
}

Gradle dependency

dependencies {
  implementation group: 'com.felixklauke.portum', name: 'portum-server', version: '1.0.0';
}

Usage

As soon as you have imported the server dependency the usage will be pretty much straight forward.
Just create a portum server config with the needed vote listeners and create and start a server with this config. Have fun!

public final class ServerExample {
  private final PortumServer server = PortumServerFactory.createServer(PortumServerConfig
      .newBuilder()
      .withHost("localhost")
      .withPort(80808)
      .withListeners(Arrays.asList())
      .build());
  
  public ServerExample() {
    server.start();
  }
}