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: 3 months ago
JSON representation
NetCoreServer Client implementation for Unity
- Host: GitHub
- URL: https://github.com/JohannesDeml/Unity-Net-Core-Networking-Sockets
- Owner: JohannesDeml
- License: mit
- Created: 2020-05-13T16:20:42.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-04-08T07:59:15.000Z (over 3 years ago)
- Last Synced: 2024-05-02T01:24:12.528Z (7 months ago)
- Topics: client-side, multiplayer, network, realtime, sockets, tcp, udp, unity, unity3d
- Language: C#
- Size: 1.18 MB
- Stars: 86
- Watchers: 8
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Unity .Net Core Networking Client
*Lightweight Unity client for [NetCoreServer](https://github.com/chronoxor/NetCoreServer)*
[](https://openupm.com/packages/com.deml.netcore-networking/) [](https://github.com/supyrb/JohannesDeml/Unity-Net-Core-Networking-Sockets) [](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)