Skip to content

Omni requires Unity version 2021.3 or higher, as it leverages the latest .NET Standard 2.1+ APIs to compatibility and performance.

Compatibility Table:

Unity 2021.3 LTS Unity 2022.3 LTS Unity 2023.2 Unity 6000.0 LTS

Warning

Using versions not listed in the compatibility table may result in unexpected behavior or functionality issues. For the most reliable experience, please check the Releases page for up-to-date version compatibility information.

Installation⚓️

Requirements⚓️

System Requirements

  • Unity 2021.3 or higher
  • .NET Standard 2.1+ API Compatibility
  • Git installed on your system(Optional)

Quick Install⚓️

  1. Open Unity Package Manager (Window > Package Manager)
  2. Click the + dropdown in the top-left corner
  3. Select Add package from git URL
  4. Paste:
    Text Only
    1
    https://github.com/RuanCardoso/Omni-Networking-for-Unity.git
  5. Click Add

  1. First, install required dependencies via Package Manager:

    1. Open Unity Package Manager (Window > Package Manager)
    2. Click the + dropdown in the top-left corner
    3. Select Add package by name
    4. Add these packages one at a time:
      Text Only
      1
2
      com.unity.localization@1.0.0
com.unity.nuget.newtonsoft-json@3.2.1

  2. Then install Omni:

    1. Download the latest source from our GitHub repository
    2. Extract the ZIP file
    3. Copy the contents to your Unity project's Assets folder

Dependencies

Make sure to install the required dependencies first, otherwise you may encounter compilation errors.

Installation Verification

After installation, verify that:

  • No console errors are present
  • The Omni menu appears in Unity's top menu bar
  • All dependencies are properly resolved

Dependencies⚓️

📦 Included Dependencies

Core Libraries

  • ✨ Newtonsoft Json - Industry-standard JSON framework for .NET, providing robust serialization and deserialization capabilities
  • 🚀 MemoryPack - High-performance zero-allocation binary serializer optimized for gaming and real-time applications
  • ⚡ UniTask - Zero allocation async/await solution for Unity, delivering superior performance over standard coroutines
  • 🎯 DOTween - Fast and efficient animation engine for Unity with a fluent API and extensive feature set

Database Connectors

  • 📁 SQLite - Self-contained, serverless, zero-configuration database engine perfect for local data storage
  • 🔋 MySqlConnector - High-performance, asynchronous MySQL database connector with connection pooling
  • 🐘 Npgsql - Open-source PostgreSQL database connector with full async support and advanced features
  • 📊 SQLKata - Elegant SQL query builder with support for multiple databases and complex queries
  • and others depending on the database you choose.

Networking

  • 🌐 LiteNetLib - Lightweight and fast UDP networking library with reliability, ordering, and connection management
  • 🔄 kcp2k - Reliable UDP communication protocol implementation offering low latency and congestion control
  • 🔒 BCrypt.Net - Modern cryptographic hashing for passwords with salt generation and verification
  • 🚪 Open.NAT - Port forwarding library supporting both UPnP and NAT-PMP for seamless multiplayer connectivity

Development Tools

  • 🛠️ Humanizer - Developer utility for manipulating and formatting strings, enums, dates, times, and more
  • 🎨 TriiInspector - Advanced Unity inspector extension providing enhanced editor customization
  • 🔄 ParrelSync - Unity editor extension for testing multiplayer gameplay with multiple game instances locally
  • ⚡ Dapper - High-performance micro-ORM supporting SQL queries with strong typing and object mapping
  • and others...

All dependencies are included in the Omni package and are automatically imported when you install it in your project using the Package Manager.