Quilkin is a non-transparent UDP proxy specifically designed for use with large scale multiplayer dedicated game servers deployments, to ensure security, access control, telemetry data, metrics and more.
It is designed to be used behind game clients as well as in front of dedicated game servers.
Project State
Project is currently in alpha status, and is being actively developed. Expect things to break.
Not to be used in production systems.
Usage
- Start with our Project Overview.
- See how to use Quilkin.
- View example integration architectures.
- Quickstart: Quilkin with netcat.
- Quickstart: Quilkin Agones and Xonotic.
- See the examples folder for configuration and usage examples.
- See the proxy configuration reference for all the configuration options.
- See the Session documentation for an overview of quilkin sessions and metrics.
- See Filter documentation for a list of filters, and their configuration options.
- The Administration interface provides access to health and metrics endpoints.
- Finally, we also have a FAQ
Code of Conduct
Participation in this project comes under the Contributor Covenant Code of Conduct
Development and Contribution
Please read the contributing guide for directions on writing code and submitting Pull Requests.
Quilkin is in active development - we would love your help in shaping its future!
Community
There are lots of ways to engage with the Quilkin community:
- Here on Github via issues and pull requests.
- Join our mailing list, which also gives you access to our continuous integration builds.
- Join our Discord chat server.
- Follow up on Twitter.
Credits
Many concepts and architectural decisions where inspired by Envoy Proxy. Huge thanks to that team for the inspiration they provided with all their hard work.
Licence
Apache 2.0