Game Frame X Network

All-in-One Solution for Indie Game Development · Empowering Indie Developers' Dreams

Documentation · Quick Start · QQ Group: 467608841 / 233840761

English | 简体中文 | 繁體中文 | 日本語 | 한국어

Project Overview

Network Component - A long-connection network component for Unity that provides network interfaces including TCP, WebSocket, and custom protocol support, making network functionality simpler and more efficient.

Features

• Long-connection network support (TCP / WebSocket)
• RPC call mechanism with timeout handling
• Heartbeat packet mechanism (configurable on focus lost/gained)
• Pluggable message serialization (IMessageSerializer interface) with two-level registration (global default + per-channel override)
• Network message serialization and deserialization
• Network channel management
• Network event system

Quick Start

Installation

Choose one of the following methods:

1. Edit your Unity project's Packages/manifest.json and add the scopedRegistries section:

   {
     "scopedRegistries": [
       {
         "name": "GameFrameX",
         "url": "https://gameframex.upm.alianblank.uk",
         "scopes": [
           "com.gameframex"
         ]
       }
     ],
     "dependencies": {
       "com.gameframex.unity.network": "2.6.6"
     }
   }

   scopes controls which packages are resolved through this registry. Only packages whose names start with com.gameframex will be fetched from it.

2. Add to manifest.json dependencies:

   {
      "com.gameframex.unity.network": "https://github.com/gameframex/com.gameframex.unity.network.git"
   }

3. Use Package Manager in Unity with Git URL: https://github.com/gameframex/com.gameframex.unity.network.git

4. Clone the repository into your Unity project's Packages directory. It will be loaded automatically.

Platform Support

Platform	Supported
Windows	Yes
macOS	Yes
Linux	Yes
Android	Yes
iOS	Yes
WebGL	Yes

Documentation & Resources

• Documentation
• GitHub Repository

Community & Support

• QQ Group: Join via QR Code

Changelog

See CHANGELOG.md for details.

Dependencies

Package	Description
com.gameframex.unity	1.1.1
com.gameframex.unity.event	1.0.0

License

See LICENSE.md for license information.