MirageNet / IgnoranceNG

Ignorance is a plug and play Enet-powered reliable UDP transport for Mirror Networking. By utilizing the Enet backend, Ignorance is a solid replacement for the Unity LLAPI transport.

Mirage version of this transport. All rights and original credit is due to Coburn

If you feel so inclined, I'd appreciate a coffee to keep me caffeinated if you use this transport.

Welcome to Ignorance, a Enet-powered Transport system for the Mirror Networking project. By utilizing the tried and true Enet native C library, Ignorance provides reliable UDP communications for your game projects where the default Telepathy TCP transport would choke.

Ignorance scales up to 4096 theortical CCU with up to 255 channels per client (also known as a peer in Enet terms). Channels allow you to split up network communications so you can have channels for data that are mission critical as well as non-essential data. Mirror and by extension, Unity, choke before hitting that CCU mark in the real world unless one carefully optimizes their network code carefully.

Ignorance was used in a recent "Vinesauce is Hope" walking simulation demo which had multiple server instances running with over 300 CCU each. Video clips available here.

Ignorance was originally intended to replace Unity's LLAPI Transport that ships with Mirror, however since it uses native libraries it was deemed too risky to ship with Mirror itself. Enet has been proven to be superior when compared to Unity LLAPI. Please read the FAQ (towards the bottom of this wall of text) before using the

Compatiblity

Desktop

• x64 Windows editions, starting from Windows 7

  • As of Ignorance 1.3.8, 32bit Windows Enet native blobs are no longer included. There was not enough reasoning to iinclude 32bit native blobs since 32bit Windows is a platform that Unity is slowly phasing out. As such, if you really need 32bit native blobs then you can use my ENet-CSharp repositories' build system on your copy of 32bit Windows, or ask for a 32bit binary blob.

  In addition to the above dot point, the only real places that I know of where 32bit is still common is Russia, Brazil and some other countries.

• macOS 10.12 onwards

  El Captain and below ARE NOT supported.

  Compiled on a GitHub autobuilder Ubuntu instance.

  Tested and confirmed working on High Sierra, Mojave, Catalina.

  • Tested and confirmed working on High Sierra, Mojave, Catalina.

• Linux x64

  • x86_64 libraries are included, compiled on a GitHub autobuilder Ubuntu instance.

  • Should just work on various Linux distros, as long as they aren’t too exotic. Main testing has been done on Debian/Ubuntu/Fedora/CentOS.

  • If your distro uses a different C library instead of GNU C then you’ll need to recompile the blobs manually. See the ENet-CSharp repository for more information.

Console

• Nintendo Switch

• Manual compile of Enet native binaries required, see this document from the ENet-CSharp repository.

• Xbox One

  • UWP: Tested and confirmed working for LAN Client only. LAN Host doesn't work.

  • Native: Possibly, however I don’t have development kit or license to test.

• PlayStation

  • Vita: Dead platform.

  • PS4: Likely would require custom version of Enet due to the console using a BSD-based OS.

Mobile

• Android

• Android 4.4 "KitKat" onwards.

  • ARMv7, ARM64 and x86 blobs are included.

  • x86_64 Blobs are not included since Unity 2018.4 LTS does not support that platform yet.

• Apple iOS

  • System version 8.0 minimum

  • Supports iPhone 4S to the latest iPhone. Tested and working on iPhone 4S, iPhone 5s, iPad 2 WiFi + 3G and iPad (5th Gen)

  • Compiled as a FAT library.

Dependencies

• ENet-CSharp (custom fork, NOT compatible with upstream)

• Mirage Networking

Installation

The preferred installation method is Unity Package manager.

If you are using unity 2019.3 or later:

1. Open your project in unity
2. Install Mirage
3. Click on Windows -> Package Manager
4. Click on the plus sign on the left and click on "Add package from git URL..."
5. enter https://github.com/MirageNet/IgnoranceNG.git?path=/Assets/Mirage/Runtime/Transport/Ignorance
6. Unity will download and install Mirage Ignorance

How to use

As of Ignorance 1.3, I have included a pre-configured sample scene so you can get started easily. Otherwise add the script called Ignorance to your NetworkManager object,

removing any TCP-based or other UDP-based transport. Then set the script to be used in NetworkManagers' "Transport" field.

FAQ (aka Please Read This First)

Why should I use Ignorance over Unity LLAPI?

Unity LLAPI is old, obsolete and no longer mantained by Unity Technologies. It is currently on heavy life-support until they get their act together with the new Unity Multiplay system. Plus, it was held together by bandaids and bubble-gum. Depending on what you threw over the network, you'd get random latency spikes and packets would go missing even in Reliable delivery mode.

Ignorance aims to replace it with a stable and high performance transport system that allows you to forget about low-level networking stress and spend more time focusing on the gameplay.

Important note

Since Mirror and all transports use LateUpdate to process their network code, there might be a chance that at very low framerate (ie. you are really stressing the server or creating lots of GameObjects in which Unity has to load from disk) that the networking gets overwhelmed, regardless of classic or threaded versions of Ignorance. It is essential to keep your server's frame rate running as high as possible as this will reduce latency and in-game lag. You will be able to tell when the server is under heavy stress when networked objects get very choppy and/or the client starts hanging.

Until Mirror changes how they manage their transport code, we are stuck with having to deal with this design issue.

I have a bug!

Check the current open bug reports and/or report a new one here. I strongly also recommend you be present in the Mirage Discord so I can ask for further info and/or you can test fixes for your bug reports. Trolls are not welcome.

Bugs that do not have enough details will be closed with #wontfix. Details like your OS, Unity Editor version, any Ignorance errors, etc is essential for a good bug report.

It might be slightly out of date, but it covers the basics of Ignorance.

I am not satisfied with Ignorance.

Please let me know why as I can't improve my code if I don't get feedback. However, if you're just here to troll me and my code, then please move on.

See also: LiteNetLib4Mirror.

Credits

• Coffee Donators: Thank you so much.

• vis2k and Paul: Mirror lead developers.

• Katori: Helped kickstart the threaded version that evolved into Ignorance 2.

• BigBoxVR: Pull requests and found a race condition that threatened stability.

• c6burns: Words cannot describe how much help he's been. Bloody oath mate.

• Petris: Code refactoring and tidy up (you rock man!)

• BigBoxVR and Martin: Pull requests.

• The folks at the Mirror discord: Memes, Courage, laughs, drama and all-round awesome folks to chat with.

• To all the others who I have missed. Thanks a lot, you know who you are.

• You too can have your name here if you send in a PR. Don't delay, get your PR in today!

Previous hall of fame:

• FSE_Vincenzo: Providing insight into proper usage of ENET, rebuttal, improvements, etc.
• shiena: Pull requests for bug fixes and oversights.
• Draknith: Testing and mapping Reliable/Unreliable channels in Mirror to ENET Channels, testing.

And last but not least...

• nxrighthere: Helped debug some things in early versions of Ignorance, before blacklisting everyone on the Mirror team from his repos. His funeral.