Game Frame X Web ProtoBuff

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

Documentation · Quick Start · QQ Group: 467608841 / 233840761

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

Project Overview

GameFrameX Web ProtoBuff request component - provides HTTP network request functionality based on Protocol Buffer, supporting asynchronous sending and receiving of ProtoBuff messages.

Features

• ProtoBuf Support: Native support for Protocol Buffer message format
• Async Operations: Task<T> based async API for easy use with async/await
• Timeout Control: Customizable request timeout
• Cross-Platform: Compatible with Unity WebGL and other native platforms

Requirements

Add the following scripting define symbol in Unity's Player Settings -> Scripting Define Symbols:

ENABLE_GAME_FRAME_X_WEB_PROTOBUF_NETWORK

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.web.protobuff": "1.1.3"
     }
   }

   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.web.protobuff": "https://github.com/gameframex/com.gameframex.unity.web.protobuff.git"
   }

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

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

Installation

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"
      ]
    }
  ]
}

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

Then add the package to dependencies:

{
  "dependencies": {
    "com.gameframex.unity.web.protobuff": "1.1.3"
  }
}

Usage Example

using GameFrameX.Web.ProtoBuff.Runtime;

// Send request and wait for result
LoginResponse response = await WebComponent.Post<LoginResponse>(url, request);