autodigipick

Name	autodigipick JSON
Version	1.1.1 JSON
	download
home_page
Summary	Automatically solve Starfield Digipick puzzles with the press of a button.
upload_time	2023-09-13 22:28:37
maintainer
docs_url	None
author
requires_python	>=3.8
license	MIT License Copyright (c) 2023 dev@reggx.eu Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords	starfield solver opencv
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # AutoDigipick

Digipick puzzles in Bethesda's Starfield are fun to solve, but they can be tedious to solve manually. This script automates the process of solving them.

Using OpenCV and Tesseract, the script takes a screenshot of the puzzle, identifies the symbols, and solves the puzzle. It then displays the solution in an extra window which you can display on a second monitor for quick reference.


![Example image showing the game on top screen and the solution on secondary monitor](example.jpg)

# Installation

You will need to install [Tesseract](https://tesseract-ocr.github.io/tessdoc/Installation.html) and add the path to the tesseract executable to your PATH environment variable.

If you use the packed executable release of AutoDigipick, then you can start it by double-clicking the executable. 

Otherwise, you will need to install [Python](https://www.python.org/downloads/) and install the dependencies listed in requirements.txt. Then you can run the script with `python autodigipick.py`.

Alternatively, you can install the package with pip (Recommended in a virtual environment or using tools like pipx):

```cmd
pip install autodigipick
```

and use `autodigipick.exe` to run the script. The configuration file will be created in the active directory and you can modify it to your needs.



## Usage

Open autodigipick.toml in a text editor and change the configuration to fit your personal setup.

In particular, you will need to change the following values:

```toml
[capture]
monitor_id = 3  # Change to your monitor's ID
```

```toml
[hotkey]
solve = "F13"  # I use macro keys on my keyboard, but you can use any key you want
exit = "F14"  # it also supports combinations with + like "ctrl+shift+alt+q"
```

```toml
[display]
resolution = [1920, 1080]  # Depending on the size of your secondary monitor, you may need to change this
position = [1000, 2300]  # Change this to a position on your secondary monitor
```

Then just run the script and press the solve hotkey while the puzzle is on screen.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "autodigipick",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "Starfield,solver,OpenCV",
    "author": "",
    "author_email": "ReggX <dev@reggx.eu>",
    "download_url": "https://files.pythonhosted.org/packages/08/5e/eba27f665dd806581e0b8db1ebcac4565da40c8296c40f6944717a8e8d23/autodigipick-1.1.1.tar.gz",
    "platform": null,
    "description": "# AutoDigipick\r\n\r\nDigipick puzzles in Bethesda's Starfield are fun to solve, but they can be tedious to solve manually. This script automates the process of solving them.\r\n\r\nUsing OpenCV and Tesseract, the script takes a screenshot of the puzzle, identifies the symbols, and solves the puzzle. It then displays the solution in an extra window which you can display on a second monitor for quick reference.\r\n\r\n\r\n![Example image showing the game on top screen and the solution on secondary monitor](example.jpg)\r\n\r\n# Installation\r\n\r\nYou will need to install [Tesseract](https://tesseract-ocr.github.io/tessdoc/Installation.html) and add the path to the tesseract executable to your PATH environment variable.\r\n\r\nIf you use the packed executable release of AutoDigipick, then you can start it by double-clicking the executable. \r\n\r\nOtherwise, you will need to install [Python](https://www.python.org/downloads/) and install the dependencies listed in requirements.txt. Then you can run the script with `python autodigipick.py`.\r\n\r\nAlternatively, you can install the package with pip (Recommended in a virtual environment or using tools like pipx):\r\n\r\n```cmd\r\npip install autodigipick\r\n```\r\n\r\nand use `autodigipick.exe` to run the script. The configuration file will be created in the active directory and you can modify it to your needs.\r\n\r\n\r\n\r\n## Usage\r\n\r\nOpen autodigipick.toml in a text editor and change the configuration to fit your personal setup.\r\n\r\nIn particular, you will need to change the following values:\r\n\r\n```toml\r\n[capture]\r\nmonitor_id = 3  # Change to your monitor's ID\r\n```\r\n\r\n```toml\r\n[hotkey]\r\nsolve = \"F13\"  # I use macro keys on my keyboard, but you can use any key you want\r\nexit = \"F14\"  # it also supports combinations with + like \"ctrl+shift+alt+q\"\r\n```\r\n\r\n```toml\r\n[display]\r\nresolution = [1920, 1080]  # Depending on the size of your secondary monitor, you may need to change this\r\nposition = [1000, 2300]  # Change this to a position on your secondary monitor\r\n```\r\n\r\nThen just run the script and press the solve hotkey while the puzzle is on screen.\r\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2023 dev@reggx.eu  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "Automatically solve Starfield Digipick puzzles with the press of a button.",
    "version": "1.1.1",
    "project_urls": {
        "Homepage": "https://github.com/reggx/autodigipick"
    },
    "split_keywords": [
        "starfield",
        "solver",
        "opencv"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e926f8543b7501d07031be8e4ba0557cd0054c332943728b949619dcb17b207b",
                "md5": "534c4c493cd163ad582b7b6c13d925fd",
                "sha256": "83347f5a571f4317a1e911bb798e44131a0f1b374b42b4047f7d08651c727397"
            },
            "downloads": -1,
            "filename": "autodigipick-1.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "534c4c493cd163ad582b7b6c13d925fd",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 9851,
            "upload_time": "2023-09-13T22:28:36",
            "upload_time_iso_8601": "2023-09-13T22:28:36.205902Z",
            "url": "https://files.pythonhosted.org/packages/e9/26/f8543b7501d07031be8e4ba0557cd0054c332943728b949619dcb17b207b/autodigipick-1.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "085eeba27f665dd806581e0b8db1ebcac4565da40c8296c40f6944717a8e8d23",
                "md5": "2b632cb4798813a94268261b26477d99",
                "sha256": "8bb03ada1f5b945bce52ced3e08c5fb217da4ba1fad71588e38b7b2c41295edf"
            },
            "downloads": -1,
            "filename": "autodigipick-1.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "2b632cb4798813a94268261b26477d99",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 11795,
            "upload_time": "2023-09-13T22:28:37",
            "upload_time_iso_8601": "2023-09-13T22:28:37.769922Z",
            "url": "https://files.pythonhosted.org/packages/08/5e/eba27f665dd806581e0b8db1ebcac4565da40c8296c40f6944717a8e8d23/autodigipick-1.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-13 22:28:37",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "reggx",
    "github_project": "autodigipick",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "autodigipick"
}