https://github.com/mirrornetworking/kcp2k

https://github.com/mirrornetworking/kcp2k

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/mirrornetworking/kcp2k
• Owner: MirrorNetworking
• License: mit
• Created: 2020-10-14T08:05:01.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-05-04T12:54:57.000Z (almost 2 years ago)
• Last Synced: 2024-05-21T14:03:55.916Z (almost 2 years ago)
• Language: C#
• Size: 784 KB
• Stars: 249
• Watchers: 5
• Forks: 45
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# kcp2k

C# KCP based on the original C [kcp](https://github.com/skywind3000/kcp).

Works with **netcore** and **Unity**. 

Developed for [Mirror Networking](https://github.com/MirrorNetworking/Mirror).

Questions & support on [Mirror Networking Discord](https://discord.gg/xVW4nU4C34).

# Features

* Kcp.cs based on kcp.c v1.7, line-by-line translation to C#

* Heavy test coverage

* Fixed [WND_RCV bug](https://github.com/skywind3000/kcp/pull/291) from original kcp

* Optional high level C# code for client/server connection handling

* Optional high level Unreliable channel added

Pull requests for bug fixes & tests welcome.

# Unity

kcp2k works perfectly with Unity, see the Mirror repository's KcpTransport.

# Allocations

The client is allocation free.

The server's SendTo/ReceiveFrom still allocate.

Microsoft is considering to [remove the remaining allocation](https://github.com/dotnet/runtime/issues/30797#issuecomment-1308599410).

# Remarks

- **Congestion Control** should be left disabled. It seems to be broken in KCP.