Skip to content
This repository has been archived by the owner on Aug 2, 2023. It is now read-only.
/ endpoint-netty Public archive

Efficient and lightweight packet-protocol framework on top of netty

License

Notifications You must be signed in to change notification settings

Koboo/endpoint-netty

Repository files navigation

Binflux-Netty

Endpoint-Netty offers a fast and secure way to define your own lightweight protocol with netty. The main functions are the definition of the protocol, the encoding of the packets and the provision of a consumer-based event system.

Further information can be found in the project wiki.

Overview

Java Version

The current versions of Endpoint-Netty are built with the OpenJDK 16 and targets Java 8 to ensure backward compatibility. If you want to build Endpoint-Netty on a newer version, go to Build and follow the steps.

Add as dependency

Here you can see how to add Endpoint-Netty to your project. This example only includes Gradle and Maven, but can also support other build systems.

Gradle:

repositories {
    maven { 
        url 'https://repo.koboo.eu/releases' 
    }
}

dependencies {
    // !Always needed! 
    compile 'eu.koboo:endpoint-core:2.7'
        
    // client-related     
    compile 'eu.koboo:endpoint-client:2.7'
        
    // server-related     
    compile 'eu.koboo:endpoint-server:2.7'
}

Maven:

<repositories>
   <repository>
      <id>repo.koboo.eu</id>
      <url>https://repo.koboo.eu/releases</url>
   </repository>
</repositories>

<dependencies>
    <!-- !Always needed! --> 
   <dependency>
      <groupId>eu.koboo</groupId>
      <artifactId>endpoint-core</artifactId>
      <version>2.7</version>
   </dependency>
   
    <!-- client-related -->     
   <dependency>
      <groupId>eu.koboo</groupId>
      <artifactId>endpoint-client</artifactId>
      <version>2.7</version>
   </dependency>
   
    <!-- server-related -->    
   <dependency>
      <groupId>eu.koboo</groupId>
      <artifactId>endpoint-server</artifactId>
      <version>2.7</version>
   </dependency>
<dependencies>

You can also add this repository to your project via jitpack, but this can cause problems unless you know how jitpack behaves.

Build from source

Endpoint-Netty uses Gradle (6.7) to build the jar files.

  • Clone repository

    • git clone https://github.com/Koboo/endpoint-netty
  • Checkout the branch you want to build (default: master)

    • git checkout master
  • Execute the gradle build-routine

    • gradle build (depends on your os / ide)

About

Efficient and lightweight packet-protocol framework on top of netty

Topics

Resources

License

Stars

Watchers

Forks

Languages