docs: 添加对每个模块的说明 README
This commit is contained in:
parent
1326d492a5
commit
1330ee23c0
|
@ -0,0 +1,5 @@
|
|||
# kotonebot.backend
|
||||
此文件夹下存放的是核心代码,例如 OCR、模板匹配、任务和动作的上下文实现等。
|
||||
|
||||
## .debug
|
||||
此模块负责可视化调试工具的实现。
|
|
@ -1 +1,2 @@
|
|||
此文件夹下为客户端操作代码,包括对模拟器的启停,设备的控制等
|
||||
# kotonebot.client
|
||||
此文件夹下为客户端操作代码,包括对模拟器的启停,设备的控制等
|
||||
|
|
|
@ -0,0 +1,2 @@
|
|||
# kotonebot.run
|
||||
此文件夹下存放调度脚本,负责执行所有的任务。
|
|
@ -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 来运行此脚本。
|
|
@ -0,0 +1,3 @@
|
|||
# kotonebot.ui
|
||||
此文件夹下存放的是与用户交互相关的代码,包括前后端交互、配置文件的读写等。
|
||||
但是不包括前端项目。前端项目在 `/kotonebot-ui` 文件夹下。
|
Loading…
Reference in New Issue