Skip to content

Commit 8936bfc

Browse files
AlianBlankAlianBlank
committed
docs: 重构README文档结构并优化迷你游戏平台分类
- 将迷你游戏平台从平铺列表重组为分类结构（国内、国际、设备OEM、游戏平台） - 修复HTML标签闭合位置错误 - 优化Markdown表格格式对齐 - 更新目录结构以反映新的分类组织
1 parent 2d42aaf commit 8936bfc

1 file changed

Lines changed: 129 additions & 98 deletions

File tree

‎README.md‎

Lines changed: 129 additions & 98 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919

2020
---
2121

22+
</div>
23+
2224
## 📑 Table of Contents
2325

2426
- [🏗️ Project Overview](#🏗️-project-overview)
@@ -35,8 +37,6 @@
3537
- [🤝 Community & Support](#🤝-community--support)
3638
- [📄 License](#📄-license)
3739

38-
</div>
39-
4040
---
4141

4242
## 🏗️ Project Overview
@@ -224,15 +224,15 @@ Runtime/
224224

225225
#### Runtime Sub-Modules
226226

227-
| Sub-Module | Description | Main Features |
228-
|------------|-------------|---------------|
229-
| **Base** | Framework Core | Component management, event pool, logging, reference pool, task pool, variable system, lifecycle management, singleton pattern |
230-
| **Extension** | Extension Library | Common extensions (string, collection, datetime), Unity type extensions (Transform, Vector), sequence reader, GameObject extensions |
231-
| **Helper** | Helper Classes | Application, camera, file, path, math, random, timer, network, JSON, rendering, position and more |
232-
| **ObjectPool** | Object Pool System | Object reuse, memory optimization, performance improvement |
233-
| **Property** | Property System | Bindable properties, data binding, MVVM support |
234-
| **ReferencePool** | Reference Pool System | Reference type management, GC optimization |
235-
| **Utility** | Utility Classes | Encryption (AES/RSA/DSA), compression, hash (MD5/SHA1/HMAC), CRC, JSON, file operations, ID generation, type conversion, text processing, logging |
227+
| Sub-Module | Description | Main Features |
228+
| ----------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
229+
| **Base** | Framework Core | Component management, event pool, logging, reference pool, task pool, variable system, lifecycle management, singleton pattern |
230+
| **Extension** | Extension Library | Common extensions (string, collection, datetime), Unity type extensions (Transform, Vector), sequence reader, GameObject extensions |
231+
| **Helper** | Helper Classes | Application, camera, file, path, math, random, timer, network, JSON, rendering, position and more |
232+
| **ObjectPool** | Object Pool System | Object reuse, memory optimization, performance improvement |
233+
| **Property** | Property System | Bindable properties, data binding, MVVM support |
234+
| **ReferencePool** | Reference Pool System | Reference type management, GC optimization |
235+
| **Utility** | Utility Classes | Encryption (AES/RSA/DSA), compression, hash (MD5/SHA1/HMAC), CRC, JSON, file operations, ID generation, type conversion, text processing, logging |
236236

237237
### 🔌 Plugins Module
238238

@@ -254,12 +254,12 @@ Plugins/
254254

255255
#### Plugins Sub-Modules
256256

257-
| Sub-Module | Description | Dependencies |
258-
|------------|-------------|--------------|
259-
| **iOS Plugin** | iOS native functionality | GameFrameX.mm |
260-
| **Compression Library** | ZIP file compression/decompression | SharpZipLib |
261-
| **Memory Management** | Efficient memory operations | StringTools, Memory, Buffers |
262-
| **Runtime Support** | .NET runtime extensions | CompilerServices.Unsafe |
257+
| Sub-Module | Description | Dependencies |
258+
| ----------------------- | ---------------------------------- | ---------------------------- |
259+
| **iOS Plugin** | iOS native functionality | GameFrameX.mm |
260+
| **Compression Library** | ZIP file compression/decompression | SharpZipLib |
261+
| **Memory Management** | Efficient memory operations | StringTools, Memory, Buffers |
262+
| **Runtime Support** | .NET runtime extensions | CompilerServices.Unsafe |
263263

264264
### 🛠️ Editor Module
265265

@@ -288,27 +288,31 @@ Editor/
288288
│ └── InspectorLockShortcut.cs # Keyboard Shortcut Lock
289289
├── MiniGame/ # Mini Game Platform Adaptation (21 Platforms) ⭐
290290
│ ├── MiniGameDefineSymbolHelper.cs # Base Define Symbol Manager
291-
│ ├── MiniGameDefineSymbolHelper.WeChat.cs # WeChat
292-
│ ├── MiniGameDefineSymbolHelper.Alipay.cs # Alipay
293-
│ ├── MiniGameDefineSymbolHelper.DouYin.cs # DouYin
294-
│ ├── MiniGameDefineSymbolHelper.KuaiShou.cs # KuaiShou
295-
│ ├── MiniGameDefineSymbolHelper.Baidu.cs # Baidu
296-
│ ├── MiniGameDefineSymbolHelper.TapTap.cs # TapTap
297-
│ ├── MiniGameDefineSymbolHelper.Meituan.cs # Meituan
298-
│ ├── MiniGameDefineSymbolHelper.Bilibili.cs # Bilibili
299-
│ ├── MiniGameDefineSymbolHelper.JingDong.cs # JingDong (JD.com)
300-
│ ├── MiniGameDefineSymbolHelper.Taobao.cs # Taobao
301-
│ ├── MiniGameDefineSymbolHelper.Vivo.cs # vivo
302-
│ ├── MiniGameDefineSymbolHelper.OPPO.cs # OPPO
303-
│ ├── MiniGameDefineSymbolHelper.Xiaomi.cs # Xiaomi
304-
│ ├── MiniGameDefineSymbolHelper.Huawei.cs # Huawei
305-
│ ├── MiniGameDefineSymbolHelper.Discord.cs # Discord
306-
│ ├── MiniGameDefineSymbolHelper.YouTube.cs # YouTube
307-
│ ├── MiniGameDefineSymbolHelper.Facebook.cs # Facebook
308-
│ ├── MiniGameDefineSymbolHelper.GooglePlay.cs # Google Play
309-
│ ├── MiniGameDefineSymbolHelper.TikTok.cs # TikTok
310-
│ ├── MiniGameDefineSymbolHelper.CrazyGames.cs # CrazyGames
311-
│ └── MiniGameDefineSymbolHelper.Poki.cs # Poki
291+
│ ├── DomesticMiniGames/ # Domestic (China) Mini Games
292+
│ │ ├── MiniGameDefineSymbolHelper.WeChat.cs # WeChat
293+
│ │ ├── MiniGameDefineSymbolHelper.Alipay.cs # Alipay
294+
│ │ ├── MiniGameDefineSymbolHelper.DouYin.cs # DouYin
295+
│ │ ├── MiniGameDefineSymbolHelper.KuaiShou.cs # KuaiShou
296+
│ │ ├── MiniGameDefineSymbolHelper.Baidu.cs # Baidu
297+
│ │ ├── MiniGameDefineSymbolHelper.JingDong.cs # JingDong
298+
│ │ ├── MiniGameDefineSymbolHelper.Meituan.cs # Meituan
299+
│ │ ├── MiniGameDefineSymbolHelper.Taobao.cs # Taobao
300+
│ │ └── MiniGameDefineSymbolHelper.Bilibili.cs # Bilibili
301+
│ ├── InternationalMiniGames/ # International Mini Games
302+
│ │ ├── MiniGameDefineSymbolHelper.CrazyGames.cs # CrazyGames
303+
│ │ ├── MiniGameDefineSymbolHelper.Discord.cs # Discord
304+
│ │ ├── MiniGameDefineSymbolHelper.Facebook.cs # Facebook
305+
│ │ ├── MiniGameDefineSymbolHelper.GooglePlay.cs # Google Play
306+
│ │ ├── MiniGameDefineSymbolHelper.Poki.cs # Poki
307+
│ │ ├── MiniGameDefineSymbolHelper.TikTok.cs # TikTok
308+
│ │ └── MiniGameDefineSymbolHelper.YouTube.cs # YouTube
309+
│ ├── DeviceOEMs/ # Device OEM Mini Games
310+
│ │ ├── MiniGameDefineSymbolHelper.Huawei.cs # Huawei
311+
│ │ ├── MiniGameDefineSymbolHelper.OPPO.cs # OPPO
312+
│ │ ├── MiniGameDefineSymbolHelper.Vivo.cs # vivo
313+
│ │ └── MiniGameDefineSymbolHelper.Xiaomi.cs # Xiaomi
314+
│ └── GamePlatforms/ # Game Platform
315+
│ └── MiniGameDefineSymbolHelper.TapTap.cs # TapTap
312316
├── PackageManager/ # Package Manager Window
313317
│ ├── PackageManagerWindow.cs # Package Manager Window
314318
│ └── PackagesManifest.cs # Package Manifest
@@ -326,19 +330,19 @@ Editor/
326330

327331
#### Editor Sub-Modules
328332

329-
| Sub-Module | Description | Main Features |
330-
|------------|-------------|---------------|
331-
| **BuildHotfix** | Hotfix Build | HybridCLR hotfix assembly build and management |
332-
| **BuildProduct** | Product Build | Build process automation, pre/post hooks |
333-
| **BuildWebGLTools** | WebGL Build | WebGL platform specific build tools |
334-
| **Cropping** | Image Cropping | Visual image cropping tool |
335-
| **Inspector** | Custom Inspectors | Object pool, reference pool visual monitoring |
336-
| **InspectorLockShortcut** | Inspector Lock | Keyboard shortcut for locking Inspector panel |
337-
| **MiniGame** | Mini Game Adaptation | One-click switch between 8 mini game platforms |
338-
| **PackageManager** | Package Management | Visual package management interface |
339-
| **UpdatePackages** | Package Update | Batch update project dependencies |
340-
| **Welcome** | Welcome Interface | New user guide and quick access |
341-
| **Misc** | Miscellaneous | Logging, define symbols, types and more |
333+
| Sub-Module | Description | Main Features |
334+
| ------------------------- | -------------------- | ----------------------------------------------------------------------------------------------------------------------- |
335+
| **BuildHotfix** | Hotfix Build | HybridCLR hotfix assembly build and management |
336+
| **BuildProduct** | Product Build | Build process automation, pre/post hooks |
337+
| **BuildWebGLTools** | WebGL Build | WebGL platform specific build tools |
338+
| **Cropping** | Image Cropping | Visual image cropping tool |
339+
| **Inspector** | Custom Inspectors | Object pool, reference pool visual monitoring |
340+
| **InspectorLockShortcut** | Inspector Lock | Keyboard shortcut for locking Inspector panel |
341+
| **MiniGame** | Mini Game Adaptation | One-click switch between 21 mini game platforms (categorized into domestic, international, device OEMs, game platforms) |
342+
| **PackageManager** | Package Management | Visual package management interface |
343+
| **UpdatePackages** | Package Update | Batch update project dependencies |
344+
| **Welcome** | Welcome Interface | New user guide and quick access |
345+
| **Misc** | Miscellaneous | Logging, define symbols, types and more |
342346

343347
---
344348

@@ -472,14 +476,31 @@ Quickly switch between mini game platforms in Unity menu:
472476
```
473477
GameFrameX/
474478
├── Scripting Define Symbols/
475-
│ ├── Enable WeChat Mini Game
476-
│ ├── Enable Alipay Mini Game
477-
│ ├── Enable DouYin Mini Game
478-
│ ├── Enable KuaiShou Mini Game
479-
│ ├── Enable Baidu Mini Game
480-
│ ├── Enable TapTap Mini Game
481-
│ ├── Enable Meituan Mini Game
482-
│ └── Enable Bilibili Mini Game
479+
│ ├── Domestic Mini Games/
480+
│ │ ├── Enable WeChat Mini Game
481+
│ │ ├── Enable Alipay Mini Game
482+
│ │ ├── Enable DouYin Mini Game
483+
│ │ ├── Enable KuaiShou Mini Game
484+
│ │ ├── Enable Baidu Mini Game
485+
│ │ ├── Enable JingDong Mini Game
486+
│ │ ├── Enable Meituan Mini Game
487+
│ │ ├── Enable Taobao Mini Game
488+
│ │ └── Enable Bilibili Mini Game
489+
│ ├── International Mini Games/
490+
│ │ ├── Enable Discord Mini Game
491+
│ │ ├── Enable YouTube Mini Game
492+
│ │ ├── Enable Facebook Mini Game
493+
│ │ ├── Enable Google Play Mini Game
494+
│ │ ├── Enable TikTok Mini Game
495+
│ │ ├── Enable CrazyGames Mini Game
496+
│ │ └── Enable Poki Mini Game
497+
│ ├── Device OEMs/
498+
│ │ ├── Enable Huawei Mini Game
499+
│ │ ├── Enable OPPO Mini Game
500+
│ │ ├── Enable Vivo Mini Game
501+
│ │ └── Enable Xiaomi Mini Game
502+
│ └── Game Platforms/
503+
│ └── Enable TapTap Mini Game
483504
```
484505

485506
#### 🏗️ Build Tools
@@ -505,56 +526,66 @@ GameFrameX/
505526

506527
### Operating Systems
507528

508-
| Platform | Status | Supported Version |
509-
|----------|--------|-------------------|
510-
| Windows | ✅ Supported | Unity 2019.4+ |
511-
| macOS | ✅ Supported | Unity 2019.4+ |
512-
| Linux | ✅ Supported | Unity 2019.4+ |
513-
| iOS | ✅ Supported | Unity 2019.4+ |
514-
| Android | ✅ Supported | Unity 2019.4+ |
515-
| WebGL | ✅ Supported | Unity 2019.4+ |
529+
| Platform | Status | Supported Version |
530+
| -------- | ----------- | ----------------- |
531+
| Windows | ✅ Supported | Unity 2019.4+ |
532+
| macOS | ✅ Supported | Unity 2019.4+ |
533+
| Linux | ✅ Supported | Unity 2019.4+ |
534+
| iOS | ✅ Supported | Unity 2019.4+ |
535+
| Android | ✅ Supported | Unity 2019.4+ |
536+
| WebGL | ✅ Supported | Unity 2019.4+ |
516537

517538
### Mini Game Platform Adaptation
518539

519540
GameFrameX provides one-click mini game platform adaptation, supporting **21 mainstream mini game platforms** worldwide:
520541

521-
#### 🇨🇳 China Mainland Platforms (14)
522-
523-
| Platform | Define Symbol | Region | Menu Priority |
524-
|----------|---------------|--------|---------------|
525-
| WeChat Mini Game | `ENABLE_WECHAT_MINI_GAME` / `WEIXINMINIGAME` | 🇨🇳 China | 2000 |
526-
| DouYin Mini Game | `ENABLE_DOUYIN_MINI_GAME` / `DOUYINMINIGAME` | 🇨🇳 China | 2100 |
527-
| KuaiShou Mini Game | `ENABLE_KUAISHOU_MINI_GAME` / `KUAISHOUMINIGAME` | 🇨🇳 China | 2200 |
528-
| Baidu Mini Game | `ENABLE_BAIDU_MINI_GAME` / `BAIDUMINIGAME` | 🇨🇳 China | 2300 |
529-
| Alipay Mini Game | `ENABLE_ALIPAY_MINI_GAME` / `ALIPAYMINIGAME` | 🇨🇳 China | 2400 |
530-
| JD Mini Game | `ENABLE_JINGDONG_MINI_GAME` / `JINGDONGMINIGAME` | 🇨🇳 China | 2500 |
531-
| Taobao Mini Program | `ENABLE_TAOBAO_MINI_GAME` / `TAOBAOMINIGAME` | 🇨🇳 China | 2600 |
532-
| TapTap Mini Game | `ENABLE_TAPTAP_MINI_GAME` / `TAPTAPMINIGAME` | 🇨🇳 China | 2700 |
533-
| Meituan Mini Game | `ENABLE_MEITUAN_MINI_GAME` / `MEITUANMINIGAME` | 🇨🇳 China | 2800 |
534-
| Bilibili Mini Game | `ENABLE_BILIBILI_MINI_GAME` / `BILIBILIMINIGAME` | 🇨🇳 China | 2900 |
535-
| vivo Mini Game | `ENABLE_VIVO_MINI_GAME` / `VIVOMINIGAME` | 🇨🇳 China | 3100 |
536-
| OPPO Mini Game | `ENABLE_OPPO_MINI_GAME` / `OPPOSMINIGAME` | 🇨🇳 China | 3200 |
537-
| Xiaomi Mini Game | `ENABLE_XIAOMI_MINI_GAME` / `XIAOMIMINIGAME` | 🇨🇳 China | 3300 |
538-
| Huawei Mini Game | `ENABLE_HUAWEI_MINI_GAME` / `HUAWEIMINIGAME` | 🇨🇳 China | 3400 |
539-
540-
#### 🌍 Global Platforms (7)
541-
542-
| Platform | Define Symbol | Region | Menu Priority |
543-
|----------|---------------|--------|---------------|
544-
| Discord | `ENABLE_DISCORD_MINI_GAME` / `DISCORDMINIGAME` | 🌍 Global | 2700 |
545-
| YouTube | `ENABLE_YOUTUBE_MINI_GAME` / `YOUTUBEMINIGAME` | 🌍 Global | 2800 |
546-
| Facebook | `ENABLE_FACEBOOK_MINI_GAME` / `FACEBOOKMINIGAME` | 🌍 Global | 2900 |
547-
| Google Play | `ENABLE_GOOGLEPLAY_MINI_GAME` / `GOOGLEPLAYMINIGAME` | 🌍 Global | 3000 |
548-
| TikTok | `ENABLE_TIKTOK_MINI_GAME` / `TIKTOKMINIGAME` | 🌍 Global | 3500 |
549-
| CrazyGames | `ENABLE_CRAZYGAMES_MINI_GAME` / `CRAZYGAMESMINIGAME` | 🌍 Global | 3600 |
550-
| Poki | `ENABLE_POKI_MINI_GAME` / `POKIMINIGAME` | 🌍 Global | 3700 |
542+
#### 🇨🇳 Domestic Mini Games (9)
543+
544+
| Platform | Define Symbol | Region | Menu Priority |
545+
| ------------------- | ------------------------------------------------ | ------- | ------------- |
546+
| WeChat Mini Game | `ENABLE_WECHAT_MINI_GAME` / `WEIXINMINIGAME` | 🇨🇳 China | 2000 |
547+
| Alipay Mini Game | `ENABLE_ALIPAY_MINI_GAME` / `ALIPAYMINIGAME` | 🇨🇳 China | 2400 |
548+
| DouYin Mini Game | `ENABLE_DOUYIN_MINI_GAME` / `DOUYINMINIGAME` | 🇨🇳 China | 2100 |
549+
| KuaiShou Mini Game | `ENABLE_KUAISHOU_MINI_GAME` / `KUAISHOUMINIGAME` | 🇨🇳 China | 2200 |
550+
| Baidu Mini Game | `ENABLE_BAIDU_MINI_GAME` / `BAIDUMINIGAME` | 🇨🇳 China | 2300 |
551+
| JD Mini Game | `ENABLE_JINGDONG_MINI_GAME` / `JINGDONGMINIGAME` | 🇨🇳 China | 2500 |
552+
| Taobao Mini Program | `ENABLE_TAOBAO_MINI_GAME` / `TAOBAOMINIGAME` | 🇨🇳 China | 2600 |
553+
| Meituan Mini Game | `ENABLE_MEITUAN_MINI_GAME` / `MEITUANMINIGAME` | 🇨🇳 China | 2800 |
554+
| Bilibili Mini Game | `ENABLE_BILIBILI_MINI_GAME` / `BILIBILIMINIGAME` | 🇨🇳 China | 2900 |
555+
556+
#### 🌍 International Mini Games (7)
557+
558+
| Platform | Define Symbol | Region | Menu Priority |
559+
| ----------- | ---------------------------------------------------- | -------- | ------------- |
560+
| Discord | `ENABLE_DISCORD_MINI_GAME` / `DISCORDMINIGAME` | 🌍 Global | 2700 |
561+
| YouTube | `ENABLE_YOUTUBE_MINI_GAME` / `YOUTUBEMINIGAME` | 🌍 Global | 2800 |
562+
| Facebook | `ENABLE_FACEBOOK_MINI_GAME` / `FACEBOOKMINIGAME` | 🌍 Global | 2900 |
563+
| Google Play | `ENABLE_GOOGLEPLAY_MINI_GAME` / `GOOGLEPLAYMINIGAME` | 🌍 Global | 3000 |
564+
| TikTok | `ENABLE_TIKTOK_MINI_GAME` / `TIKTOKMINIGAME` | 🌍 Global | 3500 |
565+
| CrazyGames | `ENABLE_CRAZYGAMES_MINI_GAME` / `CRAZYGAMESMINIGAME` | 🌍 Global | 3600 |
566+
| Poki | `ENABLE_POKI_MINI_GAME` / `POKIMINIGAME` | 🌍 Global | 3700 |
567+
568+
#### 📱 Device OEMs (4)
569+
570+
| Platform | Define Symbol | Region | Menu Priority |
571+
| ---------------- | -------------------------------------------- | ------- | ------------- |
572+
| Huawei Mini Game | `ENABLE_HUAWEI_MINI_GAME` / `HUAWEIMINIGAME` | 🇨🇳 China | 3400 |
573+
| OPPO Mini Game | `ENABLE_OPPO_MINI_GAME` / `OPPOSMINIGAME` | 🇨🇳 China | 3200 |
574+
| Vivo Mini Game | `ENABLE_VIVO_MINI_GAME` / `VIVOMINIGAME` | 🇨🇳 China | 3100 |
575+
| Xiaomi Mini Game | `ENABLE_XIAOMI_MINI_GAME` / `XIAOMIMINIGAME` | 🇨🇳 China | 3300 |
576+
577+
#### 🎮 Game Platforms (1)
578+
579+
| Platform | Define Symbol | Region | Menu Priority |
580+
| ---------------- | -------------------------------------------- | ------- | ------------- |
581+
| TapTap Mini Game | `ENABLE_TAPTAP_MINI_GAME` / `TAPTAPMINIGAME` | 🇨🇳 China | 2700 |
551582

552583
#### Define Symbol Details
553584

554585
- **Unified Define**: `ENABLE_WEBGL_MINI_GAME` - Shared by all mini game platforms
555586
- **Platform Defines**: Independent defines for conditional compilation per platform
556587
- **Mutex Mechanism**: Enabling one mini game platform automatically disables others
557-
- **Menu Path**: `GameFrameX/Scripting Define Symbols/Enable [Platform] Mini Game`
588+
- **Menu Path**: `GameFrameX/Scripting Define Symbols/[Category]/Enable [Platform] Mini Game`
558589

559590
---
560591

0 commit comments

Comments
 (0)