Skip to content

Commit 3846147

Browse files
JasonXuDeveloperclaude
JasonXuDeveloper
and
claude
authored
docs: redesign README with modern layout (#629)
* docs: redesign README with feature card grid and modern layout Rewrite both README.md and README_zh_cn.md with a Fumadocs-inspired design: hero with social proof stats, 3x2 HTML table feature cards, before/after comparison, streamlined packages table, and merged related projects section. Removes legacy branches, showcase grid, and verbose sections in favor of scannable progressive disclosure. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net> * docs: fix grammar in hero subtitle Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net> * docs: add line breaks to hero subtitle Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net> * docs: simplify quick start and emphasize lightweight core Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net> * docs: add Ultralight Core feature card, simplify Quick Start Move lightweight emphasis from Quick Start into a dedicated feature card. Merge Zero Allocation into the 10x+ Performance card. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net> * docs: add table role=presentation, deduplicate nav links Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net> --------- Signed-off-by: JasonXuDeveloper - 傑 <jason@xgamedev.net> Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent c54b408 commit 3846147

File tree

2 files changed

+169
-139
lines changed

2 files changed

+169
-139
lines changed

‎README.md‎

Lines changed: 85 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -2,76 +2,101 @@
22

33
![JEngine](https://socialify.git.ci/JasonXuDeveloper/JEngine/image?font=JetBrains+Mono&forks=1&issues=1&logo=https%3A%2F%2Fjengine.xgamedev.net%2Flogo.png&name=1&owner=1&pulls=1&stargazers=1&theme=Auto)
44

5-
[![Version](https://img.shields.io/github/v/release/JasonXuDeveloper/JEngine)](https://github.com/JasonXuDeveloper/JEngine/releases) [![Tests](https://github.com/JasonXuDeveloper/JEngine/actions/workflows/pr-tests.yml/badge.svg)](https://github.com/JasonXuDeveloper/JEngine/actions/workflows/pr-tests.yml) [![License](https://img.shields.io/github/license/JasonXuDeveloper/JEngine)](https://github.com/JasonXuDeveloper/JEngine/blob/master/LICENSE) [![Last Commit](https://img.shields.io/github/last-commit/JasonXuDeveloper/JEngine)](https://github.com/JasonXuDeveloper/JEngine/commits) [![Top Language](https://img.shields.io/github/languages/top/JasonXuDeveloper/JEngine)](https://github.com/JasonXuDeveloper/JEngine) [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FJasonXuDeveloper%2FJEngine.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2FJasonXuDeveloper%2FJEngine) [![CodeFactor](https://www.codefactor.io/repository/github/jasonxudeveloper/jengine/badge)](https://www.codefactor.io/repository/github/jasonxudeveloper/jengine) [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/JasonXuDeveloper/JEngine/badge)](https://securityscorecards.dev/viewer/?uri=github.com/JasonXuDeveloper/JEngine) [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/11830/badge)](https://www.bestpractices.dev/projects/11830) [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/JasonXuDeveloper/JEngine)
5+
**Ship game updates without shipping a build.**
6+
7+
Runtime hot updates for all platforms — push code, assets, and logic without rebuilding.<br>
8+
Powered by HybridCLR with built-in encryption and obfuscation.<br>
9+
1,000+ games shipped · 100+ companies in production · built-in Claude Code AI integration.
610

7-
**An out-of-the-box Unity framework for hot updatable games**
11+
[![Version](https://img.shields.io/github/v/release/JasonXuDeveloper/JEngine)](https://github.com/JasonXuDeveloper/JEngine/releases) [![Tests](https://github.com/JasonXuDeveloper/JEngine/actions/workflows/pr-tests.yml/badge.svg)](https://github.com/JasonXuDeveloper/JEngine/actions/workflows/pr-tests.yml) [![License](https://img.shields.io/github/license/JasonXuDeveloper/JEngine)](https://github.com/JasonXuDeveloper/JEngine/blob/master/LICENSE) [![Last Commit](https://img.shields.io/github/last-commit/JasonXuDeveloper/JEngine)](https://github.com/JasonXuDeveloper/JEngine/commits) [![Top Language](https://img.shields.io/github/languages/top/JasonXuDeveloper/JEngine)](https://github.com/JasonXuDeveloper/JEngine) [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FJasonXuDeveloper%2FJEngine.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2FJasonXuDeveloper%2FJEngine) [![CodeFactor](https://www.codefactor.io/repository/github/jasonxudeveloper/jengine/badge)](https://www.codefactor.io/repository/github/jasonxudeveloper/jengine) [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/JasonXuDeveloper/JEngine/badge)](https://securityscorecards.dev/viewer/?uri=github.com/JasonXuDeveloper/JEngine) [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/11830/badge)](https://www.bestpractices.dev/projects/11830) [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/JasonXuDeveloper/JEngine)
812

913
[Documentation](https://jengine.xgamedev.net/) | [中文文档](https://github.com/JasonXuDeveloper/JEngine/blob/master/README_zh_cn.md)
1014

1115
</div>
1216

13-
## Why JEngine?
17+
&nbsp;
1418

15-
- **Lightweight** - Only core package (few files) required; add optional packages as needed
16-
- **One-Click Build** - JEngine Panel builds code + assets with obfuscation in one click
17-
- **10x+ Performance** - HybridCLR outperforms ILRuntime/Lua hot update solutions
18-
- **Zero/Minimal GC** - UniTask (GC-free async) + Nino (high-performance serialization)
19-
- **All Platforms** - iOS, Android, Windows, macOS, WebGL, WeChat, Douyin, Alipay, TapTap
20-
- **Secure Updates** - Obfuscate hot update DLL + encrypt resources (assets & DLL/PDB) with XOR/AES/ChaCha20
21-
- **AI-Accelerated** - Intelligent AI [seamlessly integrated](.claude-plugin/), deeply understands JEngine to boost productivity
22-
- **Commercial Ready** - Production-proven by individuals and enterprise teams
19+
## Why JEngine
2320

24-
## Overview
21+
<table role="presentation">
22+
<tr>
23+
<td width="33%" valign="top">
2524

26-
JEngine is a Unity framework that enables **runtime hot updates** for games. Designed for both beginners and professionals, it provides secure, high-performance features out of the box.
25+
### Ultralight Core
2726

28-
## Quick Start
27+
A handful of files — that's the entire core package. Drop it in and hot updates just work. No boilerplate code required.
2928

30-
### Requirements
31-
- **Unity 2022.3+**
29+
</td>
30+
<td width="33%" valign="top">
3231

33-
### Branch Information
32+
### 10x+ Performance
3433

35-
| Branch | Status | Description |
36-
|--------|---------|-------------|
37-
| `master` | **Recommended** | Latest stable version with the most powerful features |
38-
| `0.8.x` | Legacy | Most popular 2023 version (no longer maintained) |
39-
| `0.7.x` | Legacy | Most popular 2022 version (no longer maintained) |
40-
| `0.6.x` | Legacy | Complete with full documentation (no longer maintained) |
41-
| `0.5.x` | Legacy | Used by some commercial projects (no longer maintained) |
34+
HybridCLR runs standard C# natively — 10x+ faster than ILRuntime or Lua. UniTask for GC-free async, Nino for zero-allocation serialization.
4235

43-
## Packages
36+
</td>
37+
<td width="33%" valign="top">
38+
39+
### Built-in Security
40+
41+
Encrypt assets and DLLs with XOR, AES, or ChaCha20. Obfuscate hot update code with Obfuz. No other hot update framework ships this.
42+
43+
</td>
44+
</tr>
45+
<tr>
46+
<td width="33%" valign="top">
47+
48+
### One-Click Build
49+
50+
Compile code, generate AOT metadata, obfuscate, encrypt, and package resources — all from one button in the JEngine Panel.
51+
52+
</td>
53+
<td width="33%" valign="top">
54+
55+
### All Platforms
56+
57+
iOS, Android, Windows, macOS, WebGL — plus WeChat, Douyin, Alipay, and TapTap mini-game platforms. YooAsset powers games with 1M+ DAU.
58+
59+
</td>
60+
<td width="33%" valign="top">
4461

45-
### Official Packages
62+
### AI-Powered Development
4663

47-
| Package | Type | Coverage | Description |
48-
|---------|------|----------|-------------|
49-
| **JEngine.Core** | Required | N/A | Hot update support with secure, high-performance features |
50-
| **JEngine.Util** | Optional | [![Util Coverage](https://codecov.io/gh/JasonXuDeveloper/JEngine/branch/master/graph/badge.svg?flag=util)](https://codecov.io/gh/JasonXuDeveloper/JEngine) | Utility classes including JAction and JObjectPool |
51-
| **JEngine.UI** | Optional | [![UI Coverage](https://codecov.io/gh/JasonXuDeveloper/JEngine/branch/master/graph/badge.svg?flag=ui)](https://codecov.io/gh/JasonXuDeveloper/JEngine) | UI utilities for both runtime and editor |
64+
First hot update framework with a [Claude Code plugin](.claude-plugin/). AI that understands JEngine patterns and writes idiomatic code for your game.
5265

53-
**JEngine.Util Features:**
54-
- **JAction** - Zero-GC chainable async task framework with fluent API, object pooling, delays, conditions, and loops
55-
- **JObjectPool** - Thread-safe, lock-free generic object pooling using CAS operations
66+
</td>
67+
</tr>
68+
</table>
5669

57-
**JEngine.UI Features:**
58-
- **MessageBox** - Zero-allocation async prompt system with UniTask integration and object pooling for runtime UI
59-
- **Editor UI** - Shadcn-inspired modern UI Toolkit framework with theming support and Bootstrap/Panel UI integration
70+
&nbsp;
6071

61-
### Third-Party Packages
72+
## Before & After
6273

63-
| Package | Description | Link |
64-
|---------|-------------|------|
65-
| **MetaJUI** | Customized UI framework for JEngine | [Repository](https://github.com/Meta404Dev/MetaJUI) |
66-
| **MetaExcelDataTool** | Excel table guide tool | [Repository](https://github.com/Meta404Dev/MetaExcelDataTool) |
74+
| Traditional Approach | With JEngine |
75+
|---------------------|--------------|
76+
| Learn Lua or TypeScript for hot update code | Standard C# — same language, same IDE, same debugging |
77+
| Register cross-domain adapters (ILRuntime) | Zero adapters — HybridCLR runs C# natively |
78+
| No built-in asset protection | XOR / AES / ChaCha20 encryption + code obfuscation |
79+
| Manual multi-step build pipeline | One-click build from JEngine Panel |
6780

68-
## Dependencies
81+
&nbsp;
6982

70-
| Dependency | Description | Repository |
71-
|------------|-------------|------------|
72-
| **Obfuz** | Code obfuscation | [GitHub](https://github.com/focus-creative-games/obfuz) |
73-
| **HybridCLR** | Runtime code execution | [GitHub](https://github.com/focus-creative-games/hybridclr) |
74-
| **YooAssets** | Runtime resource updates | [GitHub](https://github.com/tuyoogame/YooAsset) |
83+
## Quick Start
84+
85+
**Unity 2022.3+** required. Follow the [Getting Started Guide](https://jengine.xgamedev.net/) to be up and running in minutes.
86+
87+
&nbsp;
88+
89+
## Packages
90+
91+
| Package | Type | Description |
92+
|---------|------|-------------|
93+
| **JEngine.Core** | Required | Hot update runtime — bootstrap, encryption, resource management |
94+
| **JEngine.Util** | Optional | JAction (zero-GC async tasks) · JObjectPool (lock-free object pooling) |
95+
| **JEngine.UI** | Optional | MessageBox (async dialog prompts) · Editor UI (modern UI Toolkit components with theming) |
96+
97+
Built on [HybridCLR](https://github.com/focus-creative-games/hybridclr) · [YooAsset](https://github.com/tuyoogame/YooAsset) · [UniTask](https://github.com/Cysharp/UniTask) · [Nino](https://github.com/JasonXuDeveloper/Nino) · [Obfuz](https://github.com/focus-creative-games/obfuz)
98+
99+
&nbsp;
75100

76101
## 🎉 Latest Features (v1.1.6)
77102

@@ -81,38 +106,29 @@ JEngine is a Unity framework that enables **runtime hot updates** for games. Des
81106

82107
[📋 View Complete Changelog](CHANGE.md)
83108

84-
## Project Statistics
85-
86-
[![Stargazers over time](https://starchart.cc/JasonXuDeveloper/JEngine.svg)](https://starchart.cc/JasonXuDeveloper/JEngine)
87-
88-
## Showcase
109+
&nbsp;
89110

90-
> If your project uses JEngine, feel free to contact the author - we'd be happy to showcase your work here!
111+
## Community
91112

92-
| <img src="https://img.tapimg.com/market/lcs/b2d125432dffa4741c929ddceb3bf95f_360.png?imageMogr2/auto-orient/strip" alt="Alice's Dream Space" width="128" height="128" /> | <img src="https://img.tapimg.com/market/lcs/378c87731ce06ab8338977c90761a187_360.png?imageMogr2/auto-orient/strip" alt="Grinding Panic" width="128" height="128" /> | <img src="https://img.tapimg.com/market/lcs/0ac05aa58706032db05c5dbf1df77cf4_360.png?imageMogr2/auto-orient/strip" alt="Harvest Leeks" width="128" height="128" /> | <img src="https://img.tapimg.com/market/lcs/5c13a62dfeec50334f16e2f31db151e2_360.png?imageMogr2/auto-orient/strip" alt="MingMing Match" width="128" height="128" /> |
93-
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
94-
| <p align="center">[Alice's Dream Space](https://www.taptap.com/app/224117)</p> | <p align="center">[Grinding Panic](https://www.taptap.com/app/225175)</p> | <p align="center">[Harvest Leeks](https://www.taptap.com/app/232558)</p> | <p align="center">[MingMing Match](https://www.taptap.com/app/233988)</p> |
95-
| <img src="https://img.tapimg.com/market/lcs/d561f17020081307ff08366233070d88_360.png?imageMogr2/auto-orient/strip" alt="Rabbit Restaurant" width="128" height="128" /> | <img src="https://media.9game.cn/gamebase/2022/6/29/a2fabeb2e1f4c048b58a7861d60affc3.png?x-oss-process=image/resize,w_256,m_lfit" alt="Cangyuan World" width="128" height="128" /> | <img src="https://img.tapimg.com/market/lcs/475635baa9a75856ea21a216a215f5b2_360.png?imageMogr2/auto-orient/strip" alt="Kz Spirit" width="128" height="128" /> | <img src="https://github.com/kkmjnh11110/MyResouse/blob/master/icon.PNG?raw=true" alt="Boundless Cinema" width="128" height="128" /> |
96-
| <p align="center">[Rabbit Restaurant](https://www.taptap.com/app/235127)</p> | <p align="center">[Cangyuan World](https://www.9game.cn/hongmengshijie/)</p> | <p align="center">[Kz Spirit](https://www.taptap.com/app/238569)</p> | <p align="center">[Boundless Cinema](https://apps.apple.com/us/app/id1506237271)</p> |
97-
98-
## Contributors
113+
[![Stargazers over time](https://starchart.cc/JasonXuDeveloper/JEngine.svg)](https://starchart.cc/JasonXuDeveloper/JEngine)
99114

100115
<img src="https://contrib.rocks/image?repo=JasonXuDeveloper/JEngine"/>
101116

102-
## Recommendations
117+
&nbsp;
118+
119+
## Related Projects
103120

104-
Check out these other excellent Unity frameworks:
121+
**JEngine Ecosystem:**
122+
- [MetaJUI](https://github.com/Meta404Dev/MetaJUI) — Customized UI framework for JEngine
123+
- [MetaExcelDataTool](https://github.com/Meta404Dev/MetaExcelDataTool) — Excel table guide tool
105124

106-
- [IFramework](https://github.com/OnClick9927/IFramework) - Simple Unity Tools
107-
- [QFramework](https://github.com/liangxiegame/QFramework) - Your first K.I.S.S Unity 3D Framework
108-
- [TEngine](https://github.com/ALEXTANGXIAO/TEngine) - Unity framework solution
109-
- [BundleMaster](https://github.com/mister91jiao/BundleMaster) - Unity resource loading master
110-
- [Nino](https://github.com/JasonXuDeveloper/Nino) - Ultimate high-performance binary serialization library for C#.
125+
**Other Great Unity Projects:**
126+
- [IFramework](https://github.com/OnClick9927/IFramework) · [QFramework](https://github.com/liangxiegame/QFramework) · [TEngine](https://github.com/ALEXTANGXIAO/TEngine) · [BundleMaster](https://github.com/mister91jiao/BundleMaster) · [Nino](https://github.com/JasonXuDeveloper/Nino)
111127

112128
---
113129

114130
<div align="center">
115131

116-
**If JEngine helps you, please give it a Star!**
132+
**If JEngine helps your project, give it a ⭐**
117133

118134
</div>

0 commit comments

Comments
 (0)