Packetty

Packetty is a simple, packet-based and event-driven Netty wrapper that saves you a lot of work.

After implementing several projects with Netty, I noticed that I had to write the same boilerplate code over and over again. Since I didn't feel like doing this anymore and wanted to reduce maintenance effort as well as use my time more efficiently, I developed Packetty.

Table of Contents

• Including the wrapper in your project
  • No build or dependency management tool
  • Using build or dependency management tool
• Simple example project
• Used dependencies and tools
• License

Including the wrapper in your project

No build or dependency management tool

You can download the latest version from the releases page and add the .jar files to your project libraries. We recommend using a build and dependency management tool though.

Using build or dependency management tool

As Maven dependency

<!-- Add required repository -->
<repositories>
    <repository>
        <id>packetty</id>
        <url>https://mymavenrepo.com/repo/v3i97KuHAZF1V0yF9mn0/</url>
    </repository>
</repositories>

<!-- Add common as dependency -->
<dependencies>
    <dependency>
        <groupId>id.niklas</groupId>
        <artifactId>packetty-common</artifactId>
        <version>1.1.3</version>
    </dependency>
</dependencies>

<!-- Add client as dependency -->
<dependencies>
    <dependency>
        <groupId>id.niklas</groupId>
        <artifactId>packetty-client</artifactId>
        <version>1.1.3</version>
    </dependency>
</dependencies>

<!-- Add server as dependency -->
<dependencies>
    <dependency>
        <groupId>id.niklas</groupId>
        <artifactId>packetty-server</artifactId>
        <version>1.1.3</version>
    </dependency>
</dependencies>

As Gradle dependency

// Add required repository
allprojects {
    repositories {
        maven { url 'https://mymavenrepo.com/repo/v3i97KuHAZF1V0yF9mn0/' }
    }
}

// Add common as dependency
dependencies {
    implementation 'id.niklas:packetty-common:1.1.3'
}

// Add client as dependency
dependencies {
    implementation 'id.niklas:packetty-client:1.1.3'
}

// Add server as dependency
dependencies {
    implementation 'id.niklas:packetty-server:1.1.3'
}

As SBT dependency

// Add required repository
resolvers += "packetty" at "https://mymavenrepo.com/repo/v3i97KuHAZF1V0yF9mn0"

// Add common as dependency
libraryDependencies += "id.niklas" % "packetty-common" % "1.1.3"

// Add client as dependency
libraryDependencies += "id.niklas" % "packetty-client" % "1.1.3"

// Add server as dependency
libraryDependencies += "id.niklas" % "packetty-server" % "1.1.3"

Simple example project

Check out Packetty Ping Pong for a simple example project that demonstrates the use of Packetty.

Used dependencies and tools

Don't worry, I've already taken care of the dependencies, so you won't have to. Nevertheless, I would like to draw attention to the software libraries and frameworks used, without which the project couldn't have been realized this way:

• Netty
• Jackson
• Moonwlker
• Guava
• Log4j
• Project Lombok
• JUnit

License

This project is licensed under the MIT License. See the LICENSE.txt file for details.