diff --git a/example/README.md b/example/README.md new file mode 100644 index 00000000..a086ef99 --- /dev/null +++ b/example/README.md @@ -0,0 +1,36 @@ +# BetterGI 脚本示例 + +本目录提供了BetterGI各类脚本的基本示例,帮助用户快速理解和学习如何使用BetterGI的脚本功能。 + +## 目录结构 + +- `js/` - JavaScript脚本示例,展示如何使用JS实现各种自动化功能 +- `pathing/` - 地图路径追踪脚本示例,演示如何创建高效的材料采集路线 + +## 用途 + +这些示例旨在: +1. 演示脚本的基本结构和格式 +2. 提供常见使用场景的模板 +3. 帮助新用户学习脚本编写的最佳实践 +4. 展示BetterGI脚本系统的功能和可能性 + +## 如何使用 + +1. 浏览示例文件夹,找到与您需求相似的示例 +2. 查看示例脚本的结构和注释 +3. 复制相关示例作为您自己脚本的起点 +4. 根据需要修改和调整参数 + +## 脚本开发参考 + +如需编写更多自定义脚本,请参考: +- [脚本编写指南](https://bgi.huiyadan.com/dev/) +- [主仓库脚本](https://github.com/babalae/bettergi-scripts-list/tree/main/repo) + +## 贡献 + +欢迎提交新的示例或改进现有示例。提交前请确保您的示例: +- 包含详细的注释说明 +- 遵循 BetterGI 的脚本命名规范 +- 提供实用的功能演示