Skip to content

Commit e23b463

Browse files
AlianBlankclaude
andcommitted
chore: 统一 README 多语言 i18n 规范及 package.json unity 版本
- 标准化 README 多语言支持 (en, zh-CN, zh-TW, ja, ko) - 修复版本徽章为动态 shields.io URL - 统一 unity 版本为 2019.4 - 创建对应的 Unity .meta 文件 Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
1 parent 6dab0fa commit e23b463

10 files changed

Lines changed: 197 additions & 117 deletions

README.ja.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<div align="center">
2+
3+
<img src="https://download.alianblank.com/gameframex/gameframex_logo_320.png" alt="GameFrameX Logo" width="160" height="160" />
4+
5+
# Game Frame X Web ProtoBuff
6+
7+
[![License](https://img.shields.io/github/license/gameframex/com.gameframex.unity.web.protobuff)](https://github.com/gameframex/com.gameframex.unity.web.protobuff/blob/main/LICENSE.md)
8+
[![Version](https://img.shields.io/github/v/release/gameframex/com.gameframex.unity.web.protobuff)](https://github.com/gameframex/com.gameframex.unity.web.protobuff/releases)
9+
10+
インディゲーム開発者向けオールインワンソリューション · インディ開発者の夢を支援
11+
12+
[ドキュメント](https://gameframex.doc.alianblank.com) | [クイックスタート](https://gameframex.doc.alianblank.com) | [QQグループ](https://qm.qq.com/q/urKenB9AU)
13+
14+
[English](README.md) | [简体中文](README.zh-CN.md) | [繁體中文](README.zh-TW.md) | **日本語** | [한국어](README.ko.md)
15+
16+
</div>
17+
18+
## プロジェクト概要
19+
20+
GameFrameX の Web ProtoBuff リクエストコンポーネント - Protocol Buffer ベースの HTTP ネットワークリクエスト機能を提供します。
21+
22+
## インストール方法(いずれかを選択)
23+
24+
1. `manifest.json``dependencies` に追加
25+
```json
26+
{"com.gameframex.unity.web.protobuff": "https://github.com/gameframex/com.gameframex.unity.web.protobuff.git"}
27+
```
28+
2. Unity の Package Manager で Git URL を使用して追加
29+
3. リポジトリをダウンロードして Unity プロジェクトの `Packages` ディレクトリに配置

README.ja.md.meta

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.ko.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<div align="center">
2+
3+
<img src="https://download.alianblank.com/gameframex/gameframex_logo_320.png" alt="GameFrameX Logo" width="160" height="160" />
4+
5+
# Game Frame X Web ProtoBuff
6+
7+
[![License](https://img.shields.io/github/license/gameframex/com.gameframex.unity.web.protobuff)](https://github.com/gameframex/com.gameframex.unity.web.protobuff/blob/main/LICENSE.md)
8+
[![Version](https://img.shields.io/github/v/release/gameframex/com.gameframex.unity.web.protobuff)](https://github.com/gameframex/com.gameframex.unity.web.protobuff/releases)
9+
10+
인디 게임 개발자를 위한 올인원 솔루션 · 인디 개발자의 꿈을 실현
11+
12+
[문서](https://gameframex.doc.alianblank.com) | [빠른 시작](https://gameframex.doc.alianblank.com) | [QQ 그룹](https://qm.qq.com/q/urKenB9AU)
13+
14+
[English](README.md) | [简体中文](README.zh-CN.md) | [繁體中文](README.zh-TW.md) | [日本語](README.ja.md) | **한국어**
15+
16+
</div>
17+
18+
## 프로젝트 개요
19+
20+
GameFrameX의 Web ProtoBuff 요청 컴포넌트 - Protocol Buffer 기반의 HTTP 네트워크 요청 기능을 제공합니다.
21+
22+
## 설치 방법 (택 1)
23+
24+
1. `manifest.json``dependencies`에 추가
25+
```json
26+
{"com.gameframex.unity.web.protobuff": "https://github.com/gameframex/com.gameframex.unity.web.protobuff.git"}
27+
```
28+
2. Unity Package Manager에서 Git URL을 사용하여 추가
29+
3. 저장소를 다운로드하여 Unity 프로젝트의 `Packages` 디렉토리에 배치

README.ko.md.meta

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 30 additions & 116 deletions
Original file line numberDiff line numberDiff line change
@@ -1,138 +1,52 @@
1-
## HOMEPAGE
1+
<div align="center">
22

3-
GameFrameX 的 Web ProtoBuff 请求组件
3+
<img src="https://download.alianblank.com/gameframex/gameframex_logo_320.png" alt="GameFrameX Logo" width="160" height="160" />
44

5-
**Web ProtoBuff 组件 (Web ProtoBuff Component)** - 提供基于 Protocol Buffer 的 HTTP 网络请求功能,支持异步发送和接收 ProtoBuff 消息。
5+
# Game Frame X Web ProtoBuff
66

7-
# 使用文档
7+
[![License](https://img.shields.io/github/license/gameframex/com.gameframex.unity.web.protobuff)](https://github.com/gameframex/com.gameframex.unity.web.protobuff/blob/main/LICENSE.md)
8+
[![Version](https://img.shields.io/github/v/release/gameframex/com.gameframex.unity.web.protobuff)](https://github.com/gameframex/com.gameframex.unity.web.protobuff/releases)
89

9-
`WebProtoBuffComponent` 类是一个游戏框架组件,专门用于处理基于 Protocol Buffer 的网络请求。它提供了一系列方法来发送 POST 请求,并自动处理 ProtoBuf 消息的序列化与反序列化。
10+
All-in-One Solution for Indie Game Development · Empowering Indie Developers' Dreams
1011

11-
## 功能概述
12+
[Documentation](https://gameframex.doc.alianblank.com) | [Quick Start](https://gameframex.doc.alianblank.com) | [QQ Group](https://qm.qq.com/q/urKenB9AU)
1213

13-
- **ProtoBuf 支持**: 原生支持 Protocol Buffer 消息格式。
14-
- **异步操作**: 基于 `Task<T>` 的异步 API,方便使用 `async/await`
15-
- **超时控制**: 支持自定义请求超时时间。
16-
- **跨平台**: 兼容 Unity WebGL 及其他原生平台。
14+
**English** | [简体中文](README.zh-CN.md) | [繁體中文](README.zh-TW.md) | [日本語](README.ja.md) | [한국어](README.ko.md)
1715

18-
## 环境要求
16+
</div>
1917

20-
使用本组件需要在 Unity 的 **Player Settings** -> **Scripting Define Symbols** 中添加以下宏定义:
18+
## Project Overview
2119

22-
`ENABLE_GAME_FRAME_X_WEB_PROTOBUF_NETWORK`
23-
24-
## 方法说明
25-
26-
### Awake
27-
28-
初始化游戏框架组件。获取 `IWebProtoBuffManager` 模块并配置超时时间。
29-
30-
```csharp
31-
protected override void Awake() { /* ... */ }
32-
```
33-
34-
### Post<T>
35-
36-
发送 ProtoBuf 消息并等待响应。
37-
38-
```csharp
39-
public Task<T> Post<T>(string url, GameFrameX.Network.Runtime.MessageObject message)
40-
where T : GameFrameX.Network.Runtime.MessageObject, GameFrameX.Network.Runtime.IResponseMessage
41-
```
20+
GameFrameX Web ProtoBuff request component - provides HTTP network request functionality based on Protocol Buffer, supporting asynchronous sending and receiving of ProtoBuff messages.
4221

43-
- **参数**:
44-
- `url`: 目标服务器的 URL 地址。
45-
- `message`: 要发送的消息对象(必须继承自 `MessageObject`)。
46-
- **返回值**:
47-
- 返回一个 `Task<T>`,任务完成后包含服务器响应的消息对象。
48-
- **类型参数**:
49-
- `T`: 响应消息的类型(必须继承自 `MessageObject` 并实现 `IResponseMessage`)。
22+
## Features
5023

51-
### Timeout
24+
- **ProtoBuf Support**: Native support for Protocol Buffer message format
25+
- **Async Operations**: `Task<T>` based async API for easy use with `async/await`
26+
- **Timeout Control**: Customizable request timeout
27+
- **Cross-Platform**: Compatible with Unity WebGL and other native platforms
5228

53-
获取或设置请求超时时间(单位:秒)。
29+
## Requirements
5430

55-
```csharp
56-
public float Timeout { get; set; }
57-
```
58-
59-
## 使用示例
31+
Add the following scripting define symbol in Unity's **Player Settings** -> **Scripting Define Symbols**:
6032

61-
### 1. 定义消息
62-
63-
首先定义请求和响应的 ProtoBuf 消息类。
33+
`ENABLE_GAME_FRAME_X_WEB_PROTOBUF_NETWORK`
6434

65-
```csharp
66-
using ProtoBuf;
67-
using GameFrameX.Network.Runtime;
68-
69-
[ProtoContract]
70-
public class LoginRequest : MessageObject
71-
{
72-
[ProtoMember(1)]
73-
public string Username { get; set; }
74-
75-
[ProtoMember(2)]
76-
public string Password { get; set; }
77-
}
78-
79-
[ProtoContract]
80-
public class LoginResponse : MessageObject, IResponseMessage
81-
{
82-
[ProtoMember(1)]
83-
public bool Success { get; set; }
84-
85-
[ProtoMember(2)]
86-
public string Token { get; set; }
87-
}
88-
```
35+
## Installation (choose one)
8936

90-
### 2. 发送请求
37+
1. Add to `manifest.json` dependencies:
38+
```json
39+
{"com.gameframex.unity.web.protobuff": "https://github.com/gameframex/com.gameframex.unity.web.protobuff.git"}
40+
```
41+
2. Add via Unity Package Manager using Git URL:
42+
`https://github.com/gameframex/com.gameframex.unity.web.protobuff.git`
43+
3. Download the repository and place it in your Unity project's `Packages` directory
9144

92-
在组件中使用 `WebProtoBuffComponent` 发送请求。
45+
## Usage Example
9346

9447
```csharp
95-
using UnityEngine;
9648
using GameFrameX.Web.ProtoBuff.Runtime;
9749

98-
public class LoginController : MonoBehaviour
99-
{
100-
public WebProtoBuffComponent WebComponent;
101-
102-
private async void Start()
103-
{
104-
var request = new LoginRequest
105-
{
106-
Username = "user",
107-
Password = "password"
108-
};
109-
110-
string url = "http://api.example.com/login";
111-
112-
try
113-
{
114-
// 发送请求并等待结果
115-
LoginResponse response = await WebComponent.Post<LoginResponse>(url, request);
116-
117-
if (response != null)
118-
{
119-
Debug.Log($"Login Result: {response.Success}, Token: {response.Token}");
120-
}
121-
}
122-
catch (System.Exception e)
123-
{
124-
Debug.LogError($"Request Failed: {e.Message}");
125-
}
126-
}
127-
}
50+
// Send request and wait for result
51+
LoginResponse response = await WebComponent.Post<LoginResponse>(url, request);
12852
```
129-
130-
## 安装方式(任选其一)
131-
132-
1. 直接在 `manifest.json` 的文件中的 `dependencies` 节点下添加以下内容
133-
```json
134-
{"com.gameframex.unity.web.protobuff": "https://github.com/gameframex/com.gameframex.unity.web.protobuff.git"}
135-
```
136-
2. 在 Unity 的 `Packages Manager` 中使用 `Git URL` 的方式添加库,地址为:`https://github.com/gameframex/com.gameframex.unity.web.protobuff.git`
137-
138-
3. 直接下载仓库放置到 Unity 项目的 `Packages` 目录下。会自动加载识别

README.md.meta

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.zh-CN.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
<div align="center">
2+
3+
<img src="https://download.alianblank.com/gameframex/gameframex_logo_320.png" alt="GameFrameX Logo" width="160" height="160" />
4+
5+
# Game Frame X Web ProtoBuff
6+
7+
[![License](https://img.shields.io/github/license/gameframex/com.gameframex.unity.web.protobuff)](https://github.com/gameframex/com.gameframex.unity.web.protobuff/blob/main/LICENSE.md)
8+
[![Version](https://img.shields.io/github/v/release/gameframex/com.gameframex.unity.web.protobuff)](https://github.com/gameframex/com.gameframex.unity.web.protobuff/releases)
9+
10+
独立游戏前后端一体化解决方案 · 独立游戏开发者的圆梦大使
11+
12+
[文档](https://gameframex.doc.alianblank.com) | [快速开始](https://gameframex.doc.alianblank.com) | [QQ群](https://qm.qq.com/q/urKenB9AU)
13+
14+
[English](README.md) | **简体中文** | [繁體中文](README.zh-TW.md) | [日本語](README.ja.md) | [한국어](README.ko.md)
15+
16+
</div>
17+
18+
## 项目简介
19+
20+
GameFrameX 的 Web ProtoBuff 请求组件 - 提供基于 Protocol Buffer 的 HTTP 网络请求功能,支持异步发送和接收 ProtoBuff 消息。
21+
22+
## 功能概述
23+
24+
- **ProtoBuf 支持**: 原生支持 Protocol Buffer 消息格式
25+
- **异步操作**: 基于 `Task<T>` 的异步 API,方便使用 `async/await`
26+
- **超时控制**: 支持自定义请求超时时间
27+
- **跨平台**: 兼容 Unity WebGL 及其他原生平台
28+
29+
## 环境要求
30+
31+
使用本组件需要在 Unity 的 **Player Settings** -> **Scripting Define Symbols** 中添加以下宏定义:
32+
33+
`ENABLE_GAME_FRAME_X_WEB_PROTOBUF_NETWORK`
34+
35+
## 安装方式(任选其一)
36+
37+
1. 直接在 `manifest.json` 的文件中的 `dependencies` 节点下添加以下内容
38+
```json
39+
{"com.gameframex.unity.web.protobuff": "https://github.com/gameframex/com.gameframex.unity.web.protobuff.git"}
40+
```
41+
2. 在 Unity 的 `Packages Manager` 中使用 `Git URL` 的方式添加库,地址为:`https://github.com/gameframex/com.gameframex.unity.web.protobuff.git`
42+
3. 直接下载仓库放置到 Unity 项目的 `Packages` 目录下。会自动加载识别
43+
44+
## 使用示例
45+
46+
```csharp
47+
using GameFrameX.Web.ProtoBuff.Runtime;
48+
49+
// 发送请求并等待结果
50+
LoginResponse response = await WebComponent.Post<LoginResponse>(url, request);
51+
```

README.zh-CN.md.meta

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.zh-TW.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<div align="center">
2+
3+
<img src="https://download.alianblank.com/gameframex/gameframex_logo_320.png" alt="GameFrameX Logo" width="160" height="160" />
4+
5+
# Game Frame X Web ProtoBuff
6+
7+
[![License](https://img.shields.io/github/license/gameframex/com.gameframex.unity.web.protobuff)](https://github.com/gameframex/com.gameframex.unity.web.protobuff/blob/main/LICENSE.md)
8+
[![Version](https://img.shields.io/github/v/release/gameframex/com.gameframex.unity.web.protobuff)](https://github.com/gameframex/com.gameframex.unity.web.protobuff/releases)
9+
10+
獨立遊戲前後端一體化解決方案 · 獨立遊戲開發者的圓夢大使
11+
12+
[文檔](https://gameframex.doc.alianblank.com) | [快速開始](https://gameframex.doc.alianblank.com) | [QQ群](https://qm.qq.com/q/urKenB9AU)
13+
14+
[English](README.md) | [简体中文](README.zh-CN.md) | **繁體中文** | [日本語](README.ja.md) | [한국어](README.ko.md)
15+
16+
</div>
17+
18+
## 項目簡介
19+
20+
GameFrameX 的 Web ProtoBuff 請求組件 - 提供基於 Protocol Buffer 的 HTTP 網絡請求功能,支持異步發送和接收 ProtoBuff 消息。
21+
22+
## 安裝方式(任選其一)
23+
24+
1. 直接在 `manifest.json` 文件中的 `dependencies` 節點下添加
25+
```json
26+
{"com.gameframex.unity.web.protobuff": "https://github.com/gameframex/com.gameframex.unity.web.protobuff.git"}
27+
```
28+
2. 在 Unity 的 `Packages Manager` 中使用 `Git URL` 添加
29+
3. 直接下載倉庫放置到 Unity 項目的 `Packages` 目錄下

README.zh-TW.md.meta

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)