Skip to content

Latest commit

 

History

History
157 lines (105 loc) · 5.14 KB

使用方法.md

File metadata and controls

157 lines (105 loc) · 5.14 KB

使用方法

太长不看版

  1. 安装雷电模拟器，在其中安装交我办并登录Jaccount.
  2. 安装Python3.11.
  3. 使用以下命令安装本项目：pip install -U sjtuautorun
  4. 编写配置文件，跑步计划.（可选）
  5. 编写启动代码.
  6. 运行启动代码.

安装

前期准备

安装 雷电模拟器, 并在其中安装 交我办，登录Jaccount.

雷电模拟器请安装雷电模拟器9

在安装交我办后，请打开并登录后，再使用本脚本

安装 Python , 推荐安装 Python3.11.

特别提醒：如果你的电脑中已经安装了其他版本的python，请确保你理解了python的安装机制，或是直接使用 anaconda 来管理不同python版本

安装本项目(sjtuautorun)

本项目已支持通过 PyPI 进行部署, 在安装好 Python 后, 打开命令提示符(cmd), 输入以下命令后回车.

pip install -U sjtuautorun

后续更新时使用同一命令.

检查是否安装成功

在python执行以下代码:

import sjtuautorun
print(sjtuautorun.__version__)

能正常显示版本即为成功

使用本项目

配置用户文件

修改配置文件的内容, 默认文件在sjtuautorun/data/default_settings.yaml，也可以单独写一个配置文件，并在start_script()的时候指定.

使用自己的计划时，请在

配置文件模板如下:

emulator:
  emulator_dir: "" #雷电模拟器安装路径，默认从注册表中获取
  emulator_index: 1 #雷电模拟器使用多开器请修改该项为对应的模拟器id

DELAY: 1.5 
PLAN_ROOT: #如果你的计划文件不在默认路径下，请在这里指定
plan: "default" # 你的计划文件名，不包括后缀

# ========== Logger设置 ==========
LOG_PATH: "log"
DEBUG: True
SHOW_ANDROID_INPUT: True
log_level: DEBUG #调试模式 log_level 应该设置为 DEBUG

在上例中，计划位于

C:
├─ path
   ├─ to
      ├─ your
         ├─ plans
            ├─ 宣怀大道.yaml
            ├─ 其他计划.yaml

编写跑步计划

本项目支持用户自定义跑步计划，本项目也提供一些预设的跑步计划，放在sjtuautorun/data/plans目录下.

跑步计划文件模板如下:

# 宣怀大道.yaml
speed: [3.4, 3.5] # 配速区间（min/km）
mode: single_trip # 单程，目前支持：circular（循环，到达终点后前往起点）、back-and-forth（往返跑）
locating_error: 10 # 定位随机化误差
distance: 4000 # 跑步距离
points: # 途径点，第一个是起点，最后一个是终点
  - [121.431588, 31.026867]
  - [121.443628, 31.030699]

开始使用

这一份简单的启动代码:

# start.py
from sjtuautorun.mygo import RunPlan
from sjtuautorun.scripts.main import start_script

timer = start_script()
run_plan = RunPlan(timer)
run_plan.start_run()

这份代码启动了整个程序并获取了一个控制器 timer, start_script() 可以有参数, 代表用户设置的路径, 例如:

import os
from sjtuautorun.scripts.main import start_script
timer = start_script(os.path.join(os.path.dirname(__file__), "settings.yaml"))

如果不指定这个参数, 程序将会使用默认的用户配置文件运行.

接下来，run_plan = RunPlan(timer)实例了一个跑步计划来接管控制器，run_plan.start_run()启动了跑步. 目前上不支持自动结束跑步，请在脚本运行结束后手动退出.

创建虚拟环境（可选）

鉴于 Python 的依赖会随着电脑上项目的增加而变得复杂而难以维护，我们推荐你使用conda，venv等工具来为每个项目创建不同的虚拟环境.

anaconda（推荐）

对于电脑上安装了多个python版本的用户，系统环境变量中的python会被最后安装的版本所覆盖. 对于这种情况，最为简便的方法是使用 anaconda .

在下载并安装anaconda（推荐在全英文路径下安装）后，你需要打开conda prompt，并使用conda来管理你的Python环境.

此时你会见到在命令行的开始，会有写有(base)，这代表目前的conda环境是base.

conda create -n your_env_name python=x.x

使用上面的命令可以创建一个名称为your_env_name的环境，其python版本为x.x.

conda activate your_env_name

在创建完环境后，你可以使用上述命令来进入其中，此时你行首的括号应当会变为(your_env_name).

现在你可以继续上面的安装本项目操作了，更多的conda使用方法请自行google，在这不做更多介绍.

venv

venv 在 Python3.6 及以上的版本中都默认安装，在这里附上 venv 的使用方式.