hd2-macros


Namehd2-macros JSON
Version 1.2.4 PyPI version JSON
download
home_pagehttps://github.com/spyoungtech/helldivers2-macros
SummaryHelldivers 2 macros
upload_time2024-05-22 10:53:26
maintainerNone
docs_urlNone
authorSpencer Young
requires_pythonNone
licenseNone
keywords ahk autohotkey helldivers macros
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Helldivers2 Stratagem Macro

This is software for macroing stratagem inputs in Helldivers2.

Windows only.

Please note: This project makes no efforts to hide itself, evade detection, or circumvent any anti-cheat measures.
If you use this software in Helldivers 2, there is no guarantee of any kind that you will not be banned. **Use at your own risk.**

# Installation

Prerequisite: this requires that you have [autohotkey](https://www.autohotkey.com/) installed in a default location. Python users may use `pip install ahk[binary]` to satisfy this requirement.

## Binary downloads

Check the [releases page](https://github.com/spyoungtech/helldivers2-macros/releases) for traditional
windows setup install or zip download. This is the preferred method for end-users who are not Python developers.


## With pip

For Python developers, you can also install using `pip`

```
pip install hd2_macros
```

In this method, you will need to launch using `python -m hd2_macros` and the `config.toml` is expected to be in the
present working directory.

# Usage

The short version is:

1. Configure your hotkeys using the `config.toml` file
2. Run the program with helldivers2
3. When you trigger one of your configured hotkeys, a short delay (`hotkey_start_delay`) will occur -- enough time for you to make sure you have your stratagem menu up -- and the program will enter the WASD inputs for the associated stratagem.


## Configuration
In the installation directory (or the current working directory for `pip` install users) use the `config.toml` file
to configure your hotkey loadouts.

```toml
# General settings apply for all loadouts
[general]
# How long to wait for the helldivers window before exiting
win_wait = 120

# Delay in seconds between when the hotkey pressed and beginning of WASD inputs
# Intended to allow you enough time to ensure the strategem menu is up and ready for input
hotkey_start_delay = 1.0
# Change logging verbosity (valid values are "DEBUG", "INFO", "WARNING", "ERROR")
log_level = "DEBUG"

# Hide the system tray icon for the application
no_tray_icon = false

# Define a hotkey that can be used to stop the program
# By default, bound to Windows key + Q
exit_hotkey = "#q"

# The time in between key UP/DOWN events when inputting macros.
# Lowering this value will make inputs faster, but may cause inputs to be dropped.
key_delay = 0.1

# If you have AutoHotkey in a non-default location, you may specify it by uncommenting this line:
# autohotkey_executable_path = "C:\Path\To\AutoHotkey64.exe"

# You can explicitly specify the version of AutoHotkey (v1 or v2). Usually, this is not necessary.
# When omitted, the version of Autohotkey is determined automatically
# autohotkey_version = ""

# The default input type is 'WASD' - you can change this to arrow keys by uncommenting this setting:
# input_type = "Arrows"



# A Loadout provides a mapping of Strategems to hotkeys. Each loadout specifies a hotkey used to switch to that loadout.
# For hotkey/modifiers syntax, see https://www.autohotkey.com/docs/v2/Hotkeys.htm and https://www.autohotkey.com/docs/v2/KeyList.htm

# The default loadout is the loadout used at program starts
[ default_loadout ]
switch_hotkey = "#1"  # press Win+1 to load this loadout
[ default_loadout.hotkeys ]
# Maps the orbital precision strike strategem to "Windows key + n"
# All stratagem names are lowercase
"orbital precision strike" = "#n"

# Add separate sets of loadouts using `[ loadouts.<NAME> ]`
[ loadouts.secondary ]
switch_hotkey = "#2" # press Win+2 to load this loadout
[ loadouts.secondary.hotkeys ]
"orbital precision strike" = "#b"
"mortar sentry" = "#s"
"eagle cluster bomb" = "#c"

# You can add as many loadouts as you want.
# ...
```

# Stratagem list

- `heavy machine gun`
- `quasar cannon`
- `resupply`
- `orbital illumination flare`
- `hellbomb`
- `reinforce`
- `machine gun`
- `anti-material rifle`
- `stalwart`
- `expendable anti-tank`
- `recoilless rifle`
- `flamethrower`
- `autocannon`
- `railgun`
- `spear`
- `eagle strafing run`
- `eagle airstrike`
- `eagle cluster bomb`
- `eagle napalm airstrike`
- `jump pack`
- `eagle smoke strike`
- `eagle 110mm rocket pods`
- `eagle 500kg bomb`
- `orbital gatling barrage`
- `orbital airburst strike`
- `orbital 120mm he barrage`
- `orbital walking barrage`
- `orbital 380mm he barrage`
- `orbital lasers`
- `orbital railcannon strike`
- `orbital precision strike`
- `orbital gas strike`
- `orbital ems strike`
- `orbital smoke strike`
- `hmg emplacement`
- `shield generation relay`
- `tesla tower`
- `machine gun sentry`
- `gatling sentry`
- `mortar sentry`
- `guard dog`
- `autocannon sentry`
- `rocket sentry`
- `ems mortar sentry`
- `anti-personnel minefield`
- `supply pack`
- `grenade launcher`
- `laser cannon`
- `incendiary mines`
- `guard dog rover`
- `ballistic shield backpack`
- `arc thrower`
- `shield generator pack`
- `patriot exosuit`

See also: [constants.py](https://github.com/spyoungtech/helldivers2-macros/blob/main/hd2_macros/constants.py) for input mappings.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/spyoungtech/helldivers2-macros",
    "name": "hd2-macros",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "ahk, autohotkey, helldivers, macros",
    "author": "Spencer Young",
    "author_email": "spencer.young@spyoung.com",
    "download_url": "https://files.pythonhosted.org/packages/56/d5/540d4f64a8bed72f7b637c8dfa990578e0044c1c50b1a6736a2a09c5295a/hd2_macros-1.2.4.tar.gz",
    "platform": null,
    "description": "# Helldivers2 Stratagem Macro\r\n\r\nThis is software for macroing stratagem inputs in Helldivers2.\r\n\r\nWindows only.\r\n\r\nPlease note: This project makes no efforts to hide itself, evade detection, or circumvent any anti-cheat measures.\r\nIf you use this software in Helldivers 2, there is no guarantee of any kind that you will not be banned. **Use at your own risk.**\r\n\r\n# Installation\r\n\r\nPrerequisite: this requires that you have [autohotkey](https://www.autohotkey.com/) installed in a default location. Python users may use `pip install ahk[binary]` to satisfy this requirement.\r\n\r\n## Binary downloads\r\n\r\nCheck the [releases page](https://github.com/spyoungtech/helldivers2-macros/releases) for traditional\r\nwindows setup install or zip download. This is the preferred method for end-users who are not Python developers.\r\n\r\n\r\n## With pip\r\n\r\nFor Python developers, you can also install using `pip`\r\n\r\n```\r\npip install hd2_macros\r\n```\r\n\r\nIn this method, you will need to launch using `python -m hd2_macros` and the `config.toml` is expected to be in the\r\npresent working directory.\r\n\r\n# Usage\r\n\r\nThe short version is:\r\n\r\n1. Configure your hotkeys using the `config.toml` file\r\n2. Run the program with helldivers2\r\n3. When you trigger one of your configured hotkeys, a short delay (`hotkey_start_delay`) will occur -- enough time for you to make sure you have your stratagem menu up -- and the program will enter the WASD inputs for the associated stratagem.\r\n\r\n\r\n## Configuration\r\nIn the installation directory (or the current working directory for `pip` install users) use the `config.toml` file\r\nto configure your hotkey loadouts.\r\n\r\n```toml\r\n# General settings apply for all loadouts\r\n[general]\r\n# How long to wait for the helldivers window before exiting\r\nwin_wait = 120\r\n\r\n# Delay in seconds between when the hotkey pressed and beginning of WASD inputs\r\n# Intended to allow you enough time to ensure the strategem menu is up and ready for input\r\nhotkey_start_delay = 1.0\r\n# Change logging verbosity (valid values are \"DEBUG\", \"INFO\", \"WARNING\", \"ERROR\")\r\nlog_level = \"DEBUG\"\r\n\r\n# Hide the system tray icon for the application\r\nno_tray_icon = false\r\n\r\n# Define a hotkey that can be used to stop the program\r\n# By default, bound to Windows key + Q\r\nexit_hotkey = \"#q\"\r\n\r\n# The time in between key UP/DOWN events when inputting macros.\r\n# Lowering this value will make inputs faster, but may cause inputs to be dropped.\r\nkey_delay = 0.1\r\n\r\n# If you have AutoHotkey in a non-default location, you may specify it by uncommenting this line:\r\n# autohotkey_executable_path = \"C:\\Path\\To\\AutoHotkey64.exe\"\r\n\r\n# You can explicitly specify the version of AutoHotkey (v1 or v2). Usually, this is not necessary.\r\n# When omitted, the version of Autohotkey is determined automatically\r\n# autohotkey_version = \"\"\r\n\r\n# The default input type is 'WASD' - you can change this to arrow keys by uncommenting this setting:\r\n# input_type = \"Arrows\"\r\n\r\n\r\n\r\n# A Loadout provides a mapping of Strategems to hotkeys. Each loadout specifies a hotkey used to switch to that loadout.\r\n# For hotkey/modifiers syntax, see https://www.autohotkey.com/docs/v2/Hotkeys.htm and https://www.autohotkey.com/docs/v2/KeyList.htm\r\n\r\n# The default loadout is the loadout used at program starts\r\n[ default_loadout ]\r\nswitch_hotkey = \"#1\"  # press Win+1 to load this loadout\r\n[ default_loadout.hotkeys ]\r\n# Maps the orbital precision strike strategem to \"Windows key + n\"\r\n# All stratagem names are lowercase\r\n\"orbital precision strike\" = \"#n\"\r\n\r\n# Add separate sets of loadouts using `[ loadouts.<NAME> ]`\r\n[ loadouts.secondary ]\r\nswitch_hotkey = \"#2\" # press Win+2 to load this loadout\r\n[ loadouts.secondary.hotkeys ]\r\n\"orbital precision strike\" = \"#b\"\r\n\"mortar sentry\" = \"#s\"\r\n\"eagle cluster bomb\" = \"#c\"\r\n\r\n# You can add as many loadouts as you want.\r\n# ...\r\n```\r\n\r\n# Stratagem list\r\n\r\n- `heavy machine gun`\r\n- `quasar cannon`\r\n- `resupply`\r\n- `orbital illumination flare`\r\n- `hellbomb`\r\n- `reinforce`\r\n- `machine gun`\r\n- `anti-material rifle`\r\n- `stalwart`\r\n- `expendable anti-tank`\r\n- `recoilless rifle`\r\n- `flamethrower`\r\n- `autocannon`\r\n- `railgun`\r\n- `spear`\r\n- `eagle strafing run`\r\n- `eagle airstrike`\r\n- `eagle cluster bomb`\r\n- `eagle napalm airstrike`\r\n- `jump pack`\r\n- `eagle smoke strike`\r\n- `eagle 110mm rocket pods`\r\n- `eagle 500kg bomb`\r\n- `orbital gatling barrage`\r\n- `orbital airburst strike`\r\n- `orbital 120mm he barrage`\r\n- `orbital walking barrage`\r\n- `orbital 380mm he barrage`\r\n- `orbital lasers`\r\n- `orbital railcannon strike`\r\n- `orbital precision strike`\r\n- `orbital gas strike`\r\n- `orbital ems strike`\r\n- `orbital smoke strike`\r\n- `hmg emplacement`\r\n- `shield generation relay`\r\n- `tesla tower`\r\n- `machine gun sentry`\r\n- `gatling sentry`\r\n- `mortar sentry`\r\n- `guard dog`\r\n- `autocannon sentry`\r\n- `rocket sentry`\r\n- `ems mortar sentry`\r\n- `anti-personnel minefield`\r\n- `supply pack`\r\n- `grenade launcher`\r\n- `laser cannon`\r\n- `incendiary mines`\r\n- `guard dog rover`\r\n- `ballistic shield backpack`\r\n- `arc thrower`\r\n- `shield generator pack`\r\n- `patriot exosuit`\r\n\r\nSee also: [constants.py](https://github.com/spyoungtech/helldivers2-macros/blob/main/hd2_macros/constants.py) for input mappings.\r\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Helldivers 2 macros",
    "version": "1.2.4",
    "project_urls": {
        "Documentation": "https://github.com/spyoungtech/helldivers2-macros",
        "Homepage": "https://github.com/spyoungtech/helldivers2-macros",
        "Source": "https://github.com/spyoungtech/helldivers2-macros",
        "Tracker": "https://github.com/spyoungtech/helldivers2-macros/issues"
    },
    "split_keywords": [
        "ahk",
        " autohotkey",
        " helldivers",
        " macros"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "de672180cba0b67187bf93eb2325476c5dd38d95aa52fe114fcaf49b47aeb363",
                "md5": "9819c5c50f7f7867a8fe8aaac09567cf",
                "sha256": "b04daa72c24d4c40ab734f3ef2d4a6ef8143af578c27372fd1143f9f9834920a"
            },
            "downloads": -1,
            "filename": "hd2_macros-1.2.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9819c5c50f7f7867a8fe8aaac09567cf",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 10664,
            "upload_time": "2024-05-22T10:53:25",
            "upload_time_iso_8601": "2024-05-22T10:53:25.110519Z",
            "url": "https://files.pythonhosted.org/packages/de/67/2180cba0b67187bf93eb2325476c5dd38d95aa52fe114fcaf49b47aeb363/hd2_macros-1.2.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "56d5540d4f64a8bed72f7b637c8dfa990578e0044c1c50b1a6736a2a09c5295a",
                "md5": "6be9e40da1f441e7dddac3b6d81c2d00",
                "sha256": "b3c7c76f7da2677d385f646f45fb31b4c2e5c09a1bebad006c70fa107a16f6a4"
            },
            "downloads": -1,
            "filename": "hd2_macros-1.2.4.tar.gz",
            "has_sig": false,
            "md5_digest": "6be9e40da1f441e7dddac3b6d81c2d00",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 9660,
            "upload_time": "2024-05-22T10:53:26",
            "upload_time_iso_8601": "2024-05-22T10:53:26.663128Z",
            "url": "https://files.pythonhosted.org/packages/56/d5/540d4f64a8bed72f7b637c8dfa990578e0044c1c50b1a6736a2a09c5295a/hd2_macros-1.2.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-22 10:53:26",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "spyoungtech",
    "github_project": "helldivers2-macros",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "hd2-macros"
}
        
Elapsed time: 0.34683s