https://github.com/krymonota/packetty
Packetty is a simple, packet-based and event-driven Netty wrapper that saves you a lot of work.
https://github.com/krymonota/packetty
jackson json listener netty packet
Last synced: 3 months ago
JSON representation
Packetty is a simple, packet-based and event-driven Netty wrapper that saves you a lot of work.
- Host: GitHub
- URL: https://github.com/krymonota/packetty
- Owner: Krymonota
- License: mit
- Created: 2020-08-16T21:22:39.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-08-20T18:53:15.000Z (over 5 years ago)
- Last Synced: 2024-04-29T23:50:03.031Z (over 1 year ago)
- Topics: jackson, json, listener, netty, packet
- Language: Java
- Homepage:
- Size: 17.6 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Packetty [](https://github.com/Krymonota/packetty/LICENSE.txt)
Packetty is a simple, packet-based and event-driven [Netty](https://github.com/netty/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](#including-the-wrapper-in-your-project)
* [No build or dependency management tool](#no-build-or-dependency-management-tool)
* [Using build or dependency management tool](#using-build-or-dependency-management-tool)
* [Simple example project](#simple-example-project)
* [Used dependencies and tools](#used-dependencies-and-tools)
* [License](#license)
## Including the wrapper in your project
#### No build or dependency management tool
You can [download the latest version from the releases page](https://github.com/Krymonota/packetty/releases/latest) 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
```xml
packetty
https://mymavenrepo.com/repo/v3i97KuHAZF1V0yF9mn0/
id.niklas
packetty-common
1.1.3
id.niklas
packetty-client
1.1.3
id.niklas
packetty-server
1.1.3
```
As Gradle dependency
```gradle
// 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
```scala
// 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](https://github.com/Krymonota/packetty-pingpong) 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](https://netty.io/)
- [Jackson](https://github.com/FasterXML/jackson)
- [Moonwlker](https://github.com/bertilmuth/moonwlker)
- [Guava](https://github.com/google/guava)
- [Log4j](https://logging.apache.org/log4j/)
- [Project Lombok](https://projectlombok.org/)
- [JUnit](https://junit.org/junit5/)
## License
This project is licensed under the MIT License. See the [LICENSE.txt](https://github.com/Krymonota/packetty/blob/master/LICENSE.txt) file for details.