Need help with Ignorance?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

SoftwareGuy
193 Stars 28 Forks Other 398 Commits 3 Opened issues

Description

Ignorance utilizes the power of ENet to provide a reliable UDP networking transport for Mirror Networking.

Services available

!
?

Need anything else?

Contributors list

Ignorance 1.4 Logo

Ignorance 1.4 Beta

Ko-Fi PayPal GitHub issues GitHub last commit MIT Licensed

I'd appreciate a coffee if you use this transport.

"Probably the fastest transport out there for Mirror..." - FSEVincenzo, 2021 (Mirror Discord)_

Ignorance is a high-performance UDP based transport that plugs into Mirror Networking. By harnessing the power of the tried and true ENet native library, it provides reliable and unreliable UDP communications with up to 4096 connected peers (clients) and 255 channels. Reliable UDP has a lot of benefits over TCP which was the default in Mirror until KCP was implemented.

The benefit of Ignorance is that you can utilize channels which allow you to split up network communications. This allows you to have channels for data that are mission critical and must be sent out the door as quickly as possible as well as channels that can send slower non-essential data.

Mirror LTS v46.x or Mirror Mainline v46.x onwards required. Ignorance 1.4.0 (Non-Beta) will not work with older Mirror versions.

Ignorance Standalone

See STANDALONE.md.

Licensing Warning

Ignorance is licensed under MIT license. However, there has been recent cases where other developers have been using the full Ignorance source or parts thereof, stripping the MIT licensing and slapping their own license on it instead. This falls in violation of the MIT license as it clearly states that copyright notices must remain intact.

In short, don't be a code thief and respect the MIT license.

Ignorance with Mirror/Mirage/et al.

Ignorance itself was not designed to be used outside of Mirror. However, you can utilize Ignorance Standalone to get the same performance but without the Mirror Transport bindings.

Mirage has it's own Ignorance NG port which is mantained by the Mirage team themselves.

🐟-Net uses/used a mashed up version of Ignorance called Fluidity. For reasons that won't be disclosed here, do not report any Fludity bugs here.

If you are using your own network stack or you are trying to plumb Ignorance to another networking solution that already exists, you are much better off using the ENet-CSharp wrapper to talk to ENet directly. You could also try Ignorance Standalone which is mentioned above.

In short: Ignorance is not designed out of the box to work with anything other than Mirror (and by extension, Mirage if you count the port). Ignorance Standalone should work fine.

Ignorance in Action

  • If you own a copy of Population One, congrats. That game uses Ignorance as its primary network transport layer. It also earns its spot into the first major game that is using Ignorance.

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

What devices are supported?

IMPORTANT: 32Bit Desktop Targets are NOT supported. Target 64Bit for Desktop or bust.

The native library, ENet, does not support 32bit targets on desktop. To work around this, build your Unity project and target x86_64 in the Unity Build Settings window. There are a lot of other benefits to be using a 64bit runtime as well. If you cannot build for 64bit, open a support ticket.

Supported platforms, out of the box:

  • 64Bit Desktop Platforms (Windows, Mac, Linux), Android (ARMv7/ARM64) including VR devices and iOS (ARMv7/ARM64).

  • If ENet native can run on it and it's supported by Unity, you're good to go with Ignorance.

Other platforms that require some extra work:

  • Consoles, like the Nintendo Switch, PlayStation 4 and PlayStation 5. I do not have development clearance to build the native library for these platforms, so they require additional work to get functioning.

For more info, see the FAQ.

Dependencies

Please note that the repository doesn't include Mirror, instead it only provides you the Ignorance code.

Make sure you have Mirror installed and up to date before installing Ignorance.

  • ENet-CSharp: Slightly modified version included

  • Mirror Networking: use the latest Asset Store release. Git Master also supported but not recommended.

Installation

Download the Unity Package from Releases that is the latest one. Simply import the Unity Package and Unity will do the rest. Follow the instructions below.

Alternatively you can use the code from the master branch, which is often up to date compared to the releases.

How to use

I have included two pre-configured sample scenes so you can get started easily. One is Pong, one is a copy paste with some modifications of Mirror's Basic scene. Otherwise add the script called Ignorance to your NetworkManager object, removing any TCP-based or other UDP-based transport (ie. kcp2k). Then set the script to be used in NetworkManagers' "Transport" field.

FAQ (aka Please Read This First)

See FAQ.md.

I found a bug, where do I report it?

Check the current open bug reports and/or report a new one here.

Failing that you can always ping me in the Mirror Discord and I'll reply as soon as I can. Don't excessively ping me or you'll suffer my wrath.

Bugs that do not have enough details will be either closed or put as low priority. Details like your OS, Unity Editor version, any Ignorance errors, etc is essential for a good bug report.

I have other questions, I want answers.

Here's a quick primer.. It might be slightly out of date, but it covers the basics of Ignorance.

Credits

  • Donators: Thanks for helping keep the lights on.

  • FSE_Vincenzo: Resident master of the ENet way. They are part of Flying Squirrel Entertainment - go check their games out.

  • JesusLuvsYooh : CCU endurance testing project, ideas, fixes and other awesome stuff

  • Katori: Helped kickstart the threaded version that evolved into short-lived Ignorance 2.x version, which later became Ignorance Threaded.

  • PhantomGamers: Got Mirror + Ignorance working as a BepInEx client-side side-load modification for a game. Holy shit, that's cool.

  • BigBoxVR: Pull requests and found a race condition that threatened stability. Also uses Ignorance in Population One, a VR title.

  • Martin: Pull requests, testing with Dissonance. Great VoIP asset for Unity.

  • c6burns, Petris, shiena, Draknith, nxrighthere, vis2k, Paul

  • The Mirror Discord and 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!

To be continued...?

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.