Repository navigation
HYC Framework 是什么 · 当前开发状态 · 想用的人看这篇(含避坑) #1
HYClub
announced in
Announcements
Replies: 1 comment
|
补充一句 👋 关于上面说的"先联系作者"——联系之后我们能给更多实际支持:
框架定位是通用基建,但我们更希望陪早期使用者把方案真正落地,而不是丢个文档就完事。有需要直接在本帖留言或私信都行 🙌 |
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
大家好,我们是 HYC Framework 的作者团队。开这个讨论帖,是想给所有"想用但不知道从哪下手"的朋友一个统一说明:这框架是干嘛的、现在开发到哪了、以及用的时候有哪些坑。
Warning
开发状态:框架目前仍在开发中(WIP),尚未发布稳定版。 接入前请先读完下面的「状态」和「风险」两节。
Note
使用前强烈建议先留言联系作者。 框架仍在快速迭代,接入前请在本帖(或仓库 Issue / Discussions)留个言告诉我们你的使用场景。我们能给你当前最稳的接入姿势、帮你避开正在改动的区域,也能在破坏性变更前提前通知你——避免你踩到我们刚改了一半的接口。
一、它是干嘛的
HYC Framework 是一个面向 Unity(DOTS / ECS 优先) 的项目基础设施框架,走 UPM 分发。我们把做项目时反复要写的几套系统收拢成了一套:
设计目标:调用方一套代码跨 WebGL / Android / PC / iOS,平台差异全在框架内部消化,上层不写
#if UNITY_WEBGL之类的分支。二、当前开发状态(WIP)
✅ 已完成 / 可跑:
Samples~/HYCSimple最小样例ConfigManagerConfigManager门面做了稳定承诺;底层(如ConfigRegistry)不在兼容范围内,可能随版本演进三、想用的人:怎么安装 & 上手
安装方式:UPM(推荐)
方式一 · Package Manager 图形界面:
方式二 · 直接改
Packages/manifest.json,在dependencies里加一行:{ "dependencies": { "com.hyc.framework": "https://github.com/HYClub/hyc-framework.git" } }Warning
UPM 走 git URL 拉的是 默认分支最新版。框架仍是 WIP,建议锁到某个 commit / tag(URL 后加
#v0.x.x或#<commit>)再接入,避免上游更新把你工程带崩。Samples~/HYCSimple(覆盖 Config / BT / Scene / Loc / Attr 五大系统),先跑通最小闭环await new FrameworkBootstrap().InitializeAsync("World Name"),别自己写平台分支Documentation~/,建议从「配置管线总览」「引导与世界」两篇看起四、用的时候有哪些坑(重点)
ConfigAssetFactory:禁止CreateInstance+ 手填 ID / GUID,否则跨机 / 跨工程 ID 撞车、子树引用选错树string → BlobString、Vector3 → float3,托管对象不能进 Blob,否则烘焙失败System.IO读 StreamingAssets:WebGL 无文件系统、Android 在 APK 内;用StreamingAssets.Exists / ReadBytesref var row = ref ConfigManager.{Type}.GetByID(id)(EA0001:值拷贝会读垃圾),且 ref 局部禁止跨方法 / 跨帧delayCall+ 伪 null 判空五、接入风险与建议
六、AI 协作友好(给用 AI 助手开发的人)
框架在仓库根自带
AGENTS.md(全局 AI 协作契约)和Documentation~/全套模块文档。如果你用 AI 助手(Copilot / WorkBuddy / Codex 等)来基于本框架开发,建议直接让 AI 读这两处的 md——里面写清了工厂发号、生成代码禁手改、Blob blittable、ref 取行 (EA0001)、IMGUI 约定等硬规则,且关键断言都要求"源码级实证",AI 读后能准确遵循、少踩我们踩过的坑。一句话:把
AGENTS.md+Documentation~/交给你的 AI,比让它凭训练记忆猜 API 靠谱得多。也欢迎把 AI 读文档后跑出来的结论 / 问题贴到本帖,我们一起来校准。我们也在持续开发,欢迎在帖子里提问 / 提需求 / 报 bug。落地过程中踩到的新坑,我们会同步更新到这篇。谢谢支持!🙏
All reactions