Detour

A Unity + .NET Core framework for asynchronous multiplayer games over WebSockets.

NOTE: Detour is still in active development and has not reached a stable version yet. These are aspirational features, although many work today. Use at your own risk and file lots of issues.

Features

• A fast WebSockets server designed directly for gaming in .NET Core, with or without ASP.NET
• A killer Unity client library designed to work with the Detour server, on any build target (even WebGL!)
• Share code (like message types and gameplay logic) between the server and the client

Getting Started

The best way to get started with Detour is the following:

• Clone this repository and use the provided DetourServerExample .NET Core project and Detour-Unity Unity project as a basis for your project.

In the future, we will provide more ways to get started with Detour including a NuGet package for the server framework and a .UNITYPACKAGE for the Unity portion.

FAQs

• Is Detour suitable for realtime games?

  • Realtime multiplayer games are more suited to binary streams than passing JSON back and forth for various reasons, and the founder of this project contributes to Mirror, a Unity framework designed for this task that is much better suited to it.

  That being said, I'd be psyched if someone would try!

• Can it be used (with/without) ASP.NET Core?

  • Note: While the ASP.NET Core integration is coming, currently only the Standalone server works. When ASP.NET Core integration is available your gameplay code should work the same on it. Yes! Detour can be used standalone in a .NET Core console app or with ASP.NET Core. Our goal with the ASP.NET Core middleware version of the library is to eventually provide a killer front-end for checking server status, managing load, etc, but the standalone library will be provided and supported for as long as it makes sense.

• Does Detour work on (insert Unity build target)?

  • Yes! While I do not currently have access to console SDKs, so far the only build target that provides any resistance is WebGL, which cannot use System.Net.Sockets. Detour provides its own JavaScript library (JSLIB in Unity parlance) to "bridge the gap" and connect to a Detour server using a WebGL client.

• Does Detour work on (insert Unity version here)?

  • I don't know! Detour is designed to work on Unity 2018.2.20 and higher. I would very much like it to work on earlier Unity version as well, so I welcome issues and PRs specific to those versions so that we can improve it. And of course, if there are issues with higher Unity versions, those should be addressd as well.

• Does Detour scale?

  • We'll find out together, but there's no reason it shouldn't.

• How should I report and document Detour issues?

  • Fill out an Issue on GitHub with your OS version, Unity version, Detour version and .NET Core version. If you can provide one or more reproduction projects to view the bug, that is all the better.