功能：记录用户的鼠标键盘操作，通过触发按钮自动执行之前记录的操作，可设定执行的次数，可以理解为 精简绿色版 的 按键精灵。

用途：在进行某些操作简单、单调重复的工作时，使用本软件就可以很省力了。自己只要做一遍，然后接下来就让电脑来做。

该软件通过 Python 语言编写，已编译为 windows 平台可执行文件，未安装 Python 的用户可直接下载 release 版本 https://github.com/taojy123/KeymouseGo/releases ，直接点击 KeymouseGo.exe 运行

我是陶佳元，热爱代码，怀旧，在互联网上常用的 ID 有 taojy123 、tao.py。

我的个人站点 tslow.cn 整理并罗列了一些 个人项目 和 小工具 合集。

你可以在 简书 浏览我最新发布的文章，还可以在 B站 观看我的技术分享和生活纪实。

我的邮箱: [email protected]

如果您是开发爱好者，并对本项目感兴趣，欢迎参与项目的共同建设，您可以向本项目提交 Pull request 来贡献代码。

在此，特别感谢积极贡献者：

Monomux

1、点击 录制 按钮，开始录制。

2、在计算机上进行任意操作，如点击鼠标、键盘输入，这部分的动作会被记录下来。

3、点击 结束 按钮，结束录制。

4、点击 启动 按钮，计算机会重复执行一遍第2步中所录制的动作。

1、可设置脚本重复执行的次数，如果为 0 即为无限循环。

2、默认启动热键为 F6，功能等同于 启动 按钮；默认终止热键为 F9，按下后将会停止正在运行的脚本。

3、录制时只记录鼠标点击动作和键盘动作，不记录鼠标移动轨迹。

4、每次录制结束后都会在 scripts 目前下生成一个新的脚本文件。

5、运行前可以在列表中选择一个需要执行的脚本。

6、scripts 下的脚本文件内容可以修改，修改时可参考如下所述 脚本格式说明。

7、热键设置中的Middle指代鼠标中键，XButton指代鼠标侧键

8、由于程序速度受限，当输入的鼠标速度大于一定值时脚本将无法以预期的输入速度执行

部分系统环境中，可能出现无法录制完整的鼠标事件的情况，请以管理员身份运行此工具即可正常使用。

演示屏幕分辨率为1920 * 1080

[
 [3000, "EM", "mouse right down", [0.05208%, 0.1852%]],    // 开始运行 `3000ms` 后，在屏幕相对坐标 `(0.05208, 0.1852)`即 `(100,200)` 处 `按下鼠标右键`；
 [50,   "EM", "mouse right up",   [0.05208%, 0.1852%]],    // 等待 `50ms` 后在相同位置 `抬起鼠标右键`；
 [1000, "EK", "key down",         (70, 'F', 0)],                                   // 等待 `1000ms` 后 `按下f键`；
 [50,   "EK", "key up",           (70, 'F', 0)],                                   // 等待 `50ms` 后 `抬起f键`；
 [100,  "EM", "mouse left down",  [0.2604%, 0.4630%]],      // 等待 `100ms` 后，在屏幕相对坐标 `(0.2604, 0.4630)`即 `(500, 500)` 处 `按下鼠标左键`；
 [100,  "EM", "mouse move",       [0.2604%, 0.5556%]],       // 等待 `100ms` 后，鼠标移动至相对坐标 `(0.2604, 0.5556)`即 `(500, 600)` 位置；
 [100,  "EM", "mouse left down",  [0.3125%, 0.5556%]],                   // 等待 `100ms` 后，在屏幕相对坐标 `(0.3125, 0.5556)`即 `(600, 600)` 处 `抬起鼠标左键`；
 [100,  "EX", "input",            "你好 world"],                                   // 等待 `100ms` 后，在当前位置输入 `你好 world` 文字。
]

脚本为 json 格式，每一行代表一次动作：

• 每行的第 1 个元素表示时间间隔，指的是本次动作与上一次动作之间相隔的时间，单位为毫秒。
• 每行的第 2 个元素表示鼠标动作或是键盘动作：EM 为鼠标，EK 为键盘，EX 为其他拓展动作。
• 每行的第 3 个元素表示动作的类型：
  • mouse left down 为鼠标左键按下，mouse left up 为鼠标左键抬起，
  • mouse right down 为鼠标右键按下，mouse right up 为鼠标右键抬起，
  • mouse middle down 为鼠标中键按下， mouse middle up 为鼠标中键抬起，
  • mouse wheel up 为鼠标滚轮上滑， mouse wheel down 为鼠标滚轮下滑，
  • key down 为键盘按键按下，key up 为键盘按键抬起，
  • mouse move 为鼠标滑过，input 输入文字。
• 每行的第 4 个元素表示具体的动作参数
  • 当为鼠标动作时，由两个子元素构成，分别为鼠标所在的屏幕位置的横纵坐标，
  • 当为键盘动作时，由三个子元素构成，分别是（按键编号, 按键名, 拓展标记)，
  • 当为输入文字动作时，为要输入的文字内容。
• 每行 // 后的部分为注释内容。
• 修改时请严格遵守格式，否则可能导致脚本无法运行，建议修改前先备份一下。

程序提供了插件扩展接口，默认扩展类位于assets/plugins/Extension.py，可以通过派生Extension类实现自定义功能。

Extension类初始化函数包含以下参数:

• runtimes脚本执行次数
• speed脚本执行速度(%)
• thd执行脚本的线程对象
• swap默认为None，捕捉到PushProcess异常时会将swap的内容传递给新扩展对象，在子流程结束后接收新扩展对象swap的内容

在执行过程中，修改runtimes的值会影响脚本的实际执行次数。

Extension类提供以下接口:

• onbeginp()，在脚本执行前，扩展模块实例化后执行，默认包含提示音播放
• onbeforeeachloop(currentloop)，在每次执行脚本前执行，返回False时跳过本次执行
• onrunbefore(event, currentindex)，在每行脚本执行前执行，返回False时跳过本行执行
• onrunafter(event, currentindex)，在每行脚本后执行，无论onrunbefore返回值如何，无返回值
• onaftereachloop(currentloop)，在每次执行完脚本后执行，无论onbeforeeachloop返回值如何，无返回值
• onrecord(event, currentindex)，在每次录制到一个操作后执行，返回True记录本次操作
• onendp()，在全部循环执行完成后执行，默认包含提示音播放

currentindex和currentloop分别指代当前脚本的行索引与循环索引(从0开始)

event为当前脚本执行的操作，其内容包含

• delay操作延时(ms)
• event_type事件类型
• message操作类型
• action操作参数
• addon用户自定义内容，可以是任意数据类型，在自定义扩展中可使用

定义Extension子类<name>时，确保模块名<name>.py与子类名<name>相同。

为脚本指定扩展，可以在GUI或是命令行下指定，也可以在脚本内指定(优先级最高)，在脚本内指定时，需要在脚本第一行加上扩展模块名。

[
    "模块名",
    // 以下为脚本内容
]

程序启动时默认添加plugins文件夹到库搜索路径，如果需要添加其它库搜索路径，可以通过在扩展开头添加以下内容：

示例：添加程序目录下的plugins文件夹到搜索路径

import os
from KeymouseGo import add_lib_path
add_lib_path([
    os.path.join(os.getcwd(), "plugins")
])

在相应文件夹添加入搜索路径后，该文件夹下模块的引入可以直接通过import或from ... import ...实现：

例如，假设plugins文件夹下存在Util.py，可直接通过以下指令引入模块

import Util

流程控制

程序对脚本执行流程提供了以下方法，均以异常形式定义，使用时通过raise异常实现流程控制:

• JumpProcess(index)跳转到索引为index的脚本行
• BreakProcess结束本次执行
• EndProcess结束全部执行

各接口接受的流程控制异常:

日志调试

本程序使用loguru作为日志模块，在自定义扩展中可直接引入模块进行日志调试

from loguru import logger

日志内容默认保存在主程序日志中，如果有其它的需求可以参阅loguru的文档进行改动

示例:

在Script目录下存在录制的脚本1.txt，2.txt，其内容均多于3行，程序先执行1.txt中内容。

扩展操作：

1. 在第一次脚本执行中，执行完第一条(索引0)脚本内容后跳转到第3条脚本(索引2)
2. 在第一次脚本执行中，执行完第3条脚本后转而加载新的扩展，以相同的速度执行2.txt内容2次，新的扩展操作包括:
   1. 在第一次执行中，执行完第1条脚本后跳过本次循环
   2. 在第一次执行中，执行完第2条脚本后结束执行
   3. 结束执行后，显示从原扩展中转递过来的数据
3. 在第二次脚本执行中，跳过第1条(索引0)脚本内容
4. 在第二次脚本执行中，执行完第2条脚本后重复执行一次第二条脚本
5. 限制脚本执行次数为3次

在plugins/目录下新建MyExtension.py，其内容为:

from assets.plugins.Extension import *
from assets.plugins.ProcessException import *
from UIFunc import RunScriptClass
from loguru import logger

logger.info('Import MyExtension')


class MyExtension(Extension):
    def __init__(self, runtimes, speed, thd=None, swap=None):
        # 默认的构造函数将参数分别赋给self.runtimes,self.speed,self.swap
        super().__init__(runtimes, speed, thd, swap)
        # 保存当前执行次数
        self.currentloop = 0
        
        # 传递给子扩展的数据，传递时采用=赋值而不是浅/深复制
        # self.swap = 'Helloworld'
        
        """
        完成功能5
        GUI界面或命令行设置的执行次数通过runtimes参数传入，并保存到self.runtimes
        修改此值可以改变实际执行次数
        """ 
        # self.runtimes = 3

    def onbeforeeachloop(self, currentloop):
        # 更新当前执行次数
        self.currentloop = currentloop
        return True

    def onrunbefore(self, event, currentindex):
        return True
        # 完成功能3
        # if self.currentloop == 1 and currentindex == 0:
        #     return False
        # else:
        #     return True

    def onrunafter(self, event, currentindex):
        pass
        # 完成功能1
        # if self.currentloop == 0 and currentindex == 0:
        #     raise JumpProcess(2)
        # 完成功能2
        # elif self.currentloop == 0 and currentindex == 2:
        #     """
        #     run_sub_script包含5个参数，
        #     extension: 父流程的扩展对象，在这里输入self即可
        #     scriptpath: 子流程执行的脚本路径，采用相对路径或是绝对路径均可
        #     speed: 子流程执行的速度，默认为100(%)
        #     runtimes: 子流程执行次数，默认为1
        #     subextension_name: 子流程加载的扩展模块，默认为Extension
        #     """
        #     RunScriptClass.run_sub_script(self, 'scripts/0603_1013.txt', 
        #                                    speed=self.speed, 
        #                                    runtimes=2, 
        #                                    subextension_name='MyExtension2',
        #                                    thd=self.thd
        #                                    )
        # 完成功能4
        # elif self.currentloop == 1 and currentindex == 1:
        #     """
        #     在程序中，每个操作被封装为一个ScriptEvent对象，其内容包含
        #     event.delay: int类型，为操作延时(ms)
        #     event.event_type: str类型，为事件类型
        #     event.message: str类型，为操作类型
        #     event.action: str类型，为操作参数
        #     event.addon: 任意类型，添加的类型需要实现__str__方法以便保存
        #     """
        #     event.execute()

在plugins/目录下新建MyExtension2.py，其内容为:

from assets.plugins.Extension import *
from assets.plugins.ProcessException import *
from loguru import logger

logger.info('Import MyExtension2')


class MyExtension2(Extension):
    def __init__(self, runtimes, speed, thd=None, swap=None):
        super().__init__(runtimes, speed, thd, swap)
        self.currentloop = 0

    def onbeforeeachloop(self, currentloop):
        self.currentloop = currentloop
        return True

    def onrunafter(self, event, currentindex):
        pass
        # 完成功能2.i
        # if self.currentloop == 0:
        #     raise BreakProcess()
        # 完成功能2.ii
        # elif self.currentloop == 1 and currentindex == 1:
        #     raise EndProcess()

    def onendp(self):
        pass
        # 完成功能2.iii
        # logger.info(self.swap)

直接运行指定脚本:

> KeymouseGo.exe scripts/0314_1452.txt

运行指定脚本3次:

> KeymouseGo.exe scripts/0314_1452.txt -rt 3
> KeymouseGo.exe scripts/0314_1452.txt --runtimes 3

以200%的速度运行指定脚本:

> KeymouseGo.exe scripts/0314_1452.txt -sp 200
> KeymouseGo.exe scripts/0314_1452.txt --speed 200

加载自定义扩展MyExtension运行指定脚本:

> KeymouseGo.exe scripts/0314_1452.txt -m MyExtension
> KeymouseGo.exe scripts/0314_1452.txt --module MyExtension

1. 安装 Python3.10
2. pip install -r requirements.txt
3. pip install pyinstaller
4. pyinstaller -F --add-data ./assets;assets KeymouseGo.py

如果您觉得这个项目对您有所帮助，并乐意支持开源工作，可通过 支付宝 或 微信支付 为我赞赏支持

捐赠时可备注留下您的 Github 主页地址，我会将您加入 感谢列表 中（如果您愿意）

您的热情，我的动力！开源是一种精神，也是一种生活态度

感谢以下支持者:

感谢 JetBrains 免费提供开发工具

暂时没法打包 x86 版本，32 位系统的同学请自行源码编译，或 下载v1.5老版本 使用

• 添加 命令行运行能力

• 使用 PySide2 重写 UI
• 快捷键支持鼠标中键与侧键
• 相关 issue 提出的功能需求实现
• 4.0 代码基本由 Monomux 贡献，KeymouseGo 的整体品质有了较大提升。感谢付出！

• 修复了 input 事件无法输入内容的 bug

• 修复了中文注释无法解析的 bug

• 脚本文件中可使用 // 进行内容注释
• 可录制鼠标轨迹（mouse move 事件），并可在软件中设置轨迹精度，填 0 即不录制轨迹。

针对这个 issue(taojy123#39) 增加了两个功能点

• 命令行启动模式中可以随时按下 F9 热键，来终止脚本运行
• 模拟鼠标点击的脚本语句中可以设定坐标点为 [-1, -1], 用以表示在鼠标当前位置直接点击

因为兼容 macOS 遇到的很大的阻碍，最终放弃跨平台，血泪史可参看这两个 issue: taojy123#24 moses-palmer/pynput#55

• 改回使用 win32api 来模拟事件，只支持 windows 系统
• 解决了 shift + 上下左右 的回放问题，见 taojy123#27
• 增加了录制鼠标路径功能，需求来源 taojy123#33
• 增加了文字输入功能，需求来源 taojy123#34
• 因为使用了 win32api，不需要再手动设置屏幕缩放比例了
• 录制脚本语法有部分改动，不向前兼容

• 优化了脚本格式，将动作时间间隔，放到每行脚本的首位，逻辑更加合理
• 默认录制的第一个动作不加时间间隔，即按下启动按钮后立即执行第一个动作
• 如果重复多次执行，可修改脚本中第一个动作的时间（单位毫秒）来决定每轮动作之间的相隔时间

• 增加了屏幕缩放配置，兼容了修改过屏幕缩放比例的 win10 系统
• 优化代码，兼容 Python3

• 代码优化重构
• 使用 pynput 实现动作捕捉和执行，不再需要安装 pywin32 和 pyhook
• 兼容 macOS (需要在隐私设置中允许程序控制电脑)
• pynput 似乎不兼容 WinXP，暂时没法打包 x86 版本

• 修复自定义缩放后录制定位偏移 Bug

• 增加命令行运行方式

• Bug 修复

• UI 更新
• 移除了 后台模式
• 简化了录制脚本，增强了可读性
• 脚本文件名优化，可录制多个脚本，避免误操作覆盖了辛辛苦苦录制的脚本
• 可自定义 启动热键 和 终止热键