Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/JohannesDeml/Unity-Net-Core-Networking-Sockets

NetCoreServer Client implementation for Unity
https://github.com/JohannesDeml/Unity-Net-Core-Networking-Sockets

client-side multiplayer network realtime sockets tcp udp unity unity3d

Last synced: about 2 months ago
JSON representation

NetCoreServer Client implementation for Unity

Lists

README

        

# Unity .Net Core Networking Client

![Unity Editor Screenshot](./Docs/preview.png)

*Lightweight Unity client for [NetCoreServer](https://github.com/chronoxor/NetCoreServer)*
[![openupm](https://img.shields.io/npm/v/com.deml.netcore-networking?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.deml.netcore-networking/) [![](https://img.shields.io/github/release-date/JohannesDeml/Unity-Net-Core-Networking-Sockets.svg)](https://github.com/supyrb/JohannesDeml/Unity-Net-Core-Networking-Sockets) [![Unity 2018.1 or later](https://img.shields.io/badge/unity-2018.1%20or%20later-green.svg?logo=unity&cacheSeconds=2592000)](https://unity3d.com/get-unity/download/archive)

This is an example for a unity client that works with a [NetCoreServer](https://github.com/chronoxor/NetCoreServer) server application. The latest version is built with Unity 2020.3.1f1 and NetCoreServer 5.0.15.

## Features

* Supports SSL, TCP & UDP
* Client code from NetCoreServer with wrappers for unity usage
* Precompiled server executables for windows for easy testing
* Small GC overhead - Usage of MemoryStream
* Async send and receive - Does not block the Main Thread
* Low level - just plain UPD/TCP/SSL
* Tested with local, network and remote server

| Platform | SSL | TCP | UDP |
| -------- | :--: | :--: | :--: |
| Editor | ✔️ | ✔️ | ✔️ |
| Android | ✔️ | ✔️ | ✔️ |
| iOS | ✔️ | ✔️ | ✔️ |
| Windows | ✔️ | ✔️ | ✔️ |

## Installation

You can either install the package through the package manager with [OpenUPM](https://openupm.com/) (Recommended) or download the scripts as a unity package

### OpenUPM

```sh
# Install openupm-cli
$ npm install -g openupm-cli

# Enter your unity project folder
$ cd YOUR_UNITY_PROJECT_FOLDER

# Add package to your project
$ openupm openupm add com.deml.netcore-networking
```

### Download

[Latest Unity Package](../../releases/latest)

## Setup

* Unity 2020.3.1f1 (Works with older versions as well)
* Precompiled servers an in [ServerWindows](./ServerWindows), run the bat you want to test
* Open `Samples/EchoClient/Scenes/NetworkExampleClient.unity` and hit play.
* Default port is `3333` when running the bat files.

## Troubleshooting

* I can't find the samples
* The samples are stored in `Assets/NetCoreNetworking/Samples~`. A symlink at `Assets/Samples` points to the folder. That symlink might break when pulling for the first time on Windows. There are two solutions for it:
* Just run **`Assets/.RelinkSamples.bat`** to regenerate the symlink.
* [Configure your git to support symlinks](https://stackoverflow.com/a/59761201/3319358)
* The precompiled server scripts don't work
* Install Dotnet from https://dotnet.microsoft.com/download

## TODO

* Split messages back into the sent chunks
* Fix bug: Repeated asnyc sending results in some packages not being sent for UDP
* Support Websockets

## Libraries

* [NetCoreServer](https://github.com/chronoxor/NetCoreServer) by [Chronoxor](https://github.com/chronoxor/)

## License

* MIT - see [LICENSE](./LICENSE)