voice-commander

一个使用语音命令和快捷键定义宏和触发器的应用程序。受流行的商业软件VoiceAttack的启发。

需要Python 3.12+

这是对现有项目的重大重写。如果您正在寻找此软件的旧版本，请查看pre-rewrite标签（或在PyPI上现在已撤回的0.0.1a版本）。

安装

通过pip

要安装，最好在virtualenv中，使用pip

pip install voice-commander

此软件还要求您安装AutoHotkey。您可以将AutoHotkey安装到默认位置，或者，作为替代方案，在virtualenv中安装ahk-binary软件包

pip install ahk-binary

Windows可执行文件

即将推出。

用法

基本原语包括<强>配置文件、<强>触发器、<强>动作和<强>条件。

• 一个<强>动作定义了触发时将执行的基本操作，例如按下键盘键、播放声音、打开程序等。
• 触发器用于触发一组相关的操作。例如，说出语音激活短语、按下一个热键组合（如win+n）或类似操作。触发器可以触发任意数量的操作。
• 条件用于有条件地控制触发器或触发器内的特定操作的执行。例如，你可能只想在打开/聚焦特定窗口（如游戏）时，才执行按键操作。触发器可以附加到触发器或操作上。
• 配置文件是一组触发器（及其相关的操作/条件），可以方便地一起激活/停用。

基本示例

您可以在Python代码中定义和运行配置文件。

from voice_commander.profile import Profile
from voice_commander.triggers import *
from voice_commander.actions import *

profile = Profile("myprofile")

# triggers when any of these phrases are spoken
# You can add as many phrases as you want
trigger = VoiceTrigger('lower landing gear', 'retract landing gear')
# When the above trigger activates from a voice command, presses the "l" button (bound in-game to landing gear toggle)
action = AHKPressAction("l")
trigger.add_action(action)  # you can add multiple actions if you want. Here, we're just adding one action.
profile.add_trigger(trigger)

profile.run()

您还可以将配置文件序列化/反序列化到/从JSON。

# save the profile to the present working directory
profile.save_json(dirname='.', filename='myprofile.vcp.json')  # "vcp" means "Voice Commander Profile"

from voice_commander.profile import load_profile
# easily load profiles from JSON
profile = load_profile('./myprofile.vcp.json')
profile.run()

您还可以直接编辑和运行表示完整配置文件的JSON文件。上述示例生成的JSON文件大致如下

{
    "configuration": {
        "profile_name": "myprofile",
        "schema_version": "0",
        "triggers": [
            {
                "trigger_type": "voice_commander.triggers.VoiceTrigger",
                "trigger_config": {
                    "*trigger_phrases": [
                        "lower landing gear",
                        "retract landing gear"
                    ]
                },
                "actions": [
                    {
                        "action_type": "voice_commander.actions.AHKPressAction",
                        "action_config": {
                            "key": "l"
                        }
                    }
                ]
            }
        ]
    }
}

还支持JSON5。未来可能会支持更多格式。

您可以直接从命令行运行这些文件中的配置文件

python -m voice_commander run-profile --profile-file ./myprofile.vcp.json

完整文档即将推出。

扩展语音指挥官

语音指挥官的开发考虑了扩展性。目前我们还没有太多可以分享的内容，但您可以查看voice-commander-elite项目，这是一个旨在为《危险边缘》游戏玩家提供特殊功能的扩展。它目前正在作为未来扩展的实验对象。《voice-commander-elite》也可能给您提供其他可能扩展的想法。

状态

该项目处于早期开发阶段，但已准备好使用。将努力保持现有配置文件架构与（或转换为）任何未来架构版本的兼容性，尽管Python API可能会进行一些破坏性更改，至少在我们起步时是这样的。

当前限制

该软件的一些显著限制如下

• 只能读取游戏手柄控制器的X、Y、Z、R、U和V轴。一些特殊的轴（如某些油门控制器的“旋钮”）不能用作触发器
• 虽然可以使用控制器/游戏手柄输入进行触发宏，但我们目前还不支持在宏中发送控制器或游戏手柄输入。因此，您可能需要确保有键盘绑定可用于游戏中的操作。
• 当前仅支持波形音频文件（.wav）播放声音（且仅在Windows上支持）
• 尚未支持XInput设备（例如，Xbox One控制器）用于触发或发送
• 大多数有意义的功能需要ahk（因此还需要AutoHotkey和Windows）。未来的版本将支持Linux友好的替代方案
• 不支持游戏手柄/控制器输入的输入拦截（阻止活动程序接收输入）。