README¶
探索 Odin Inspector 进阶功能、整合优质资源、优化游戏开发流程
⚠️ 重要声明¶
Odin Toolkits是开源的、第三方扩展工具集,主要面向Odin Inspector and Serializer的中文用户。Odin Toolkits提供了英文界面解决方案,欢迎贡献完善英文界面。- 本项目与 Sirenix 公司及官方产品
Odin Inspector and Serializer无任何隶属、合作关系,并非官方衍生产品。 - 本项目不包含
Odin Inspector and Serializer的发行版本。 - 本文中的
Odin Inspector为Odin Inspector and Serializer的简称。
项目愿景¶
- 成为使用
Odin Inspector and Serializer的开发者的必备扩展工具集。
主要模块¶
Script Doc Generator:脚本文档生成工具,一键生成API文档,也可以自定义文档格式。Attribute Overview Pro:Odin 特性总览窗口 Pro 版,在官方的Attribute Overview内容上进行扩展。Tool Packages:工具箱模块,提供一些简单的编辑器工具。Community:社区模块,收集、整理、分享使用Odin Inspector制作的工具以及其他优质资源。- 原生多语言特性,在构造函数层面直接添加多语言参数。
安装¶
前提条件¶
Tuanjie 1.6.7 LTS或Unity 2021.3.45f2c1 LTS或对应引擎的更高版本Odin Inspector And Serializer最新版本。本项目最初基于3.3.1.14开发。
具体步骤¶
Odin Toolkits依赖Odin Inspector插件,请先自行导入Odin Inspector插件到项目。从 Unity Global AssetStore 和 Sirenix 官网 上购买
Odin Inspector或其他方式获取。
- 确保项目中已安装
Odin Inspector - 下载最新发布包
- 将包导入到
Unity项目中 - 通过
Tools/Odin Toolkits菜单访问工具
开始使用¶
导入后,您可以通过 Unity 编辑器菜单访问 Odin Toolkits:
Tools/Odin Toolkits/Getting Started- 开始菜单Tools/Odin Toolkits/Editor Settings- 配置编辑器阶段设置Tools/Odin Toolkits/Runtime Config- 配置运行时设置Tools/Odin Toolkits/Attribute Overview Pro- Odin 特性总览窗口 Pro 版Tools/Odin Toolkits/Script Doc Generator- 脚本文档生成工具Tools/Odin Toolkits/Tool Packages- 工具箱Tools/Odin Toolkits/Community- 社区模块
项目结构¶
Plugins/
├─ Yuumix/
│ ├─ Community/
│ │ ├─ Editor/
│ │ ├─ Modules/
│ ├─ OdinToolkits/
│ │ ├─ AttributeOverviewPro/
│ │ ├─ Core/
│ │ │ ├─ Editor/
│ │ │ ├─ Resources/
│ │ │ ├─ Runtime/
│ │ ├─ Modules/
│ │ ├─ ScriptDocGenerator/
│ │ ├─ Tests/
相关链接¶
许可证¶
本项目基于 MIT 许可证授权。
Logo 许可证¶
查看 LOGO-LICENSE.md 文档。
更新日志¶
详细版本历史和变更请查看网站 Information/CHANGELOG 章节或项目中的 CHANGELOG.md。
贡献指南¶
暂不推荐,因为目前 API 可能随时改变。查看 CONTRIBUTING.md 文档。
支持与反馈¶
发送邮箱时,请添加 [Odin Toolkits - xxx] 前缀,例如 [Odin Toolkits - BUG],这样更便于接收反馈,避免遗漏。
感谢你看到这里,如果 Odin Toolkits 在你的 Unity 开发过程中切实提供了帮助,恳请为项目点亮一颗 ★ Star!
如果 Odin Toolkits 打包出现错误,请提 issue,或者联系我,我会尽快处理,业余时间开发,无法即时回复,请优先邮件联系。
