https://github.com/felixklauke/portum

Modern and flexible implementation of the minecraft votifier protocol. Thought as embedded service or middleware.
https://github.com/felixklauke/portum

mcseu minecraft minecraft-server minecraft-server-list vote votifier

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/felixklauke/portum
• Owner: felixklauke
• License: mit
• Created: 2019-05-31T11:37:41.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-02-28T05:08:00.000Z (over 1 year ago)
• Last Synced: 2024-05-01T14:41:06.016Z (7 months ago)
• Topics: mcseu, minecraft, minecraft-server, minecraft-server-list, vote, votifier
• Language: Java
• Homepage: https://www.felix-klauke.com
• Size: 104 KB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# portum

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

Portum uses [theresa](https://github.com/FelixKlauke/theresa) for dependency injection and 

[constrictor](https://github.com/d3adspace/constrictor) for networking.

# Build status

|             	| Build Status                                                                                                                                              	| 

|-------------	|-----------------------------------------------------------------------------------------------------------------------------------------------------------	|

| Master      	| [![Build Status](https://travis-ci.org/felixklauke/portum.svg?branch=master)](https://travis-ci.org/felixklauke/portum) 	| 

# Installation

**Maven Repositories**

```xml

    

    

        klauke-enterprises-maven-releases

        Klauke Enterprises Maven Releases

        https://repository.klauke-enterprises.com/repository/maven-releases/

    

```

**Maven dependency**

```xml

  

    com.felixklauke.portum

    portum-server

    1.0.0

  

```

**Gradle Repositories**

```groovy

repositories {

  maven {

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

  }

}

```

**Gradle dependency**

```groovy

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!

```java

public final class ServerExample {

  private final PortumServer server = PortumServerFactory.createServer(PortumServerConfig

      .newBuilder()

      .withHost("localhost")

      .withPort(80808)

      .withListeners(Arrays.asList())

      .build());

  

  public ServerExample() {

    server.start();

  }

}

```