diff --git a/kotonebot/backend/README.md b/kotonebot/backend/README.md new file mode 100644 index 0000000..a8e0b56 --- /dev/null +++ b/kotonebot/backend/README.md @@ -0,0 +1,5 @@ +# kotonebot.backend +此文件夹下存放的是核心代码,例如 OCR、模板匹配、任务和动作的上下文实现等。 + +## .debug +此模块负责可视化调试工具的实现。 diff --git a/kotonebot/client/README.md b/kotonebot/client/README.md index f9d2adc..e7ae391 100644 --- a/kotonebot/client/README.md +++ b/kotonebot/client/README.md @@ -1 +1,2 @@ -此文件夹下为客户端操作代码,包括对模拟器的启停,设备的控制等 \ No newline at end of file +# kotonebot.client +此文件夹下为客户端操作代码,包括对模拟器的启停,设备的控制等 diff --git a/kotonebot/run/README.md b/kotonebot/run/README.md new file mode 100644 index 0000000..d6ebfbe --- /dev/null +++ b/kotonebot/run/README.md @@ -0,0 +1,2 @@ +# kotonebot.run +此文件夹下存放调度脚本,负责执行所有的任务。 \ No newline at end of file diff --git a/kotonebot/tasks/README.md b/kotonebot/tasks/README.md new file mode 100644 index 0000000..89c16ef --- /dev/null +++ b/kotonebot/tasks/README.md @@ -0,0 +1,21 @@ +# kotonebot.tasks +此文件夹下存放的是与具体游戏逻辑相关的脚本。基本上一个任务对应一个脚本。 +每个任务的入口函数都应当用 `@task` 装饰器装饰,每个动作函数都应当用 `@action` 装饰器装饰。 + +一些名词: +* 任务 Task:程序调度的基本单位,是用户可以在软件进行相应配置。例如领取邮箱、完成培育、清空商店等 +* 动作 Action:比任务更小的单元。例如在培育中进行一次练习、在竞赛中进行一次挑战等。 +> [!NOTE] +> 与游戏逻辑无关的函数不应当标记为任务或者动作。 + +所有对设备的操作都应该通过 `kotonebot.backend.context` 模块中的 `device` 对象进行。 + +## .actions +此文件夹下存放一些任务之间共同的动作。 + +## R.py +此脚本由软件自动生成,存放了所有的图片资源名称及对应的路径。 +在脚本里对图片资源的引用都应该通过 R 获得,避免硬编码字符串。 + +此脚本不会被提交到 Git 仓库中。因此首次 Clone 后,应当运行 `python ./tools/make_resources.py` 来生成此脚本。 +如果你用的是 VSCode,可以通过 Terminal -> Run Task... -> Make R.py 来运行此脚本。 \ No newline at end of file diff --git a/kotonebot/ui/README.md b/kotonebot/ui/README.md new file mode 100644 index 0000000..ee326cf --- /dev/null +++ b/kotonebot/ui/README.md @@ -0,0 +1,3 @@ +# kotonebot.ui +此文件夹下存放的是与用户交互相关的代码,包括前后端交互、配置文件的读写等。 +但是不包括前端项目。前端项目在 `/kotonebot-ui` 文件夹下。