<h1 align="center">GuiPad</h1>
<p align="center">
<picture>
<source width="500" height="500" srcset="Icons/GuiPad_Logo.svg">
<img width="500" height="500" src="Icons/GuiPad_Logo.svg">
</picture>
</p>
<h3 align="center">Use your gamepad as a mouse with pygame and PyAutoGUI.</h3>
## Installation
**Make sure that pygame is at least version 2.0**
*Download GuiPad.py and run it with python.*
**OR**
Use ```pip install GuiPad``` in your Operating System terminal, then in a python terminal or script:
```python
import GuiPad
GuiPad.GuiPad()
```
https://pypi.org/project/GuiPad/
## Configuration
A settings.ini file can be used in Guipad.Guipad("PathToSettings.ini") for additional customisation.
Generate a standard settings file using:
```python
import os
import GuiPad
Make_In_Directory = os.path.join("C:\\Users","JackLawrenceCRISPR","Desktop","Folder") #put your own deployment directory!
GuiPad.MakeGuiPadini(Make_In_Directory, "GuiPad.ini") #you can also choose a custom name
```
Edit the .ini file to your preference then provide
_Path = os.path.join("C:\\Users","JackLawrenceCRISPR","Desktop","Folder","GuiPad.ini")_ in your _GuiPad.GuiPad(Path)_
## Controls
| Input | Output | Effect |
| :--- | :---: | --- |
| Left joystick | Mouse | Move cursor |
| Right trigger | Slow Mouse | Slow movment |
| Right joystick | Arrow Keys | Page Scrolling / Time & Sound (videos)|
| A Button | Left click | Normal click |
| B Button | Right click | Right click|
| X Button | Double click | Open file / select a word in text |
| Y Button | Middle click | Open link in new tab|
| D-Pad up | Ctrl + + | Zoom in |
| D-Pad down | Ctrl + - | Zoom out |
| D-Pad right | Ctrl + T | New tab |
| D-Pad left | Ctrl + W | Close window |
| Left shoulder | Ctrl + Shift + Tab | Next tab |
| Right shoulder | Ctrl + Tab | Previous tab |
| Left stick | Alt + Left | Go back |
| Right stick | Alt + Right | Go forward |
| Select button | Ctrl + C | Copy |
| Start button | Ctrl + V | Paste |
| Middle button | Enter | Apply |
## Button Mapping
Different gamepad types combined with different operating systems/drivers can cause button mapping inconsistencies.
Manually set your map if the shoulder and stick buttons on your gamepad are misaligned with the table above.
For example, a gamepad called "Controller (HORIPAD S)" could use the "xbox_windows" map which would be applied as:
```GuiPad.MapGamepad("Controller (HORIPAD S)","xbox_windows")```
The following command will provide further guidance for button mapping:
```python
import GuiPad
GuiPad.MapGamepad()
```
Raw data
{
"_id": null,
"home_page": "https://github.com/JackLawrenceCRISPR/GuiPad",
"name": "GuiPad",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.0",
"maintainer_email": "",
"keywords": "python,pygame,pyautogui,gamepad",
"author": "Jack Lawrence",
"author_email": "<JackLawrenceCRISPR@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/e7/bf/665a9bbef4367482dcedf3caa633ea8da0aab2dd172e9df4eedd65ad8ab6/GuiPad-1.2.2.tar.gz",
"platform": null,
"description": "\r\n<h1 align=\"center\">GuiPad</h1>\r\n<p align=\"center\">\r\n <picture>\r\n <source width=\"500\" height=\"500\" srcset=\"Icons/GuiPad_Logo.svg\"> \r\n <img width=\"500\" height=\"500\" src=\"Icons/GuiPad_Logo.svg\">\r\n </picture>\r\n</p>\r\n<h3 align=\"center\">Use your gamepad as a mouse with pygame and PyAutoGUI.</h3>\r\n\r\n\r\n## Installation\r\n**Make sure that pygame is at least version 2.0** \r\n*Download GuiPad.py and run it with python.* \r\n**OR** \r\nUse ```pip install GuiPad``` in your Operating System terminal, then in a python terminal or script: \r\n```python\r\nimport GuiPad\r\nGuiPad.GuiPad()\r\n```\r\nhttps://pypi.org/project/GuiPad/\r\n\r\n## Configuration\r\nA settings.ini file can be used in Guipad.Guipad(\"PathToSettings.ini\") for additional customisation. \r\nGenerate a standard settings file using:\r\n```python\r\nimport os\r\nimport GuiPad\r\nMake_In_Directory = os.path.join(\"C:\\\\Users\",\"JackLawrenceCRISPR\",\"Desktop\",\"Folder\") #put your own deployment directory!\r\nGuiPad.MakeGuiPadini(Make_In_Directory, \"GuiPad.ini\") #you can also choose a custom name\r\n```\r\nEdit the .ini file to your preference then provide \r\n_Path = os.path.join(\"C:\\\\Users\",\"JackLawrenceCRISPR\",\"Desktop\",\"Folder\",\"GuiPad.ini\")_ in your _GuiPad.GuiPad(Path)_\r\n\r\n## Controls\r\n| Input | Output | Effect |\r\n| :--- | :---: | --- |\r\n| Left joystick | Mouse | Move cursor |\r\n| Right trigger | Slow Mouse | Slow movment |\r\n| Right joystick | Arrow Keys | Page Scrolling / Time & Sound (videos)|\r\n| A Button | Left click | Normal click |\r\n| B Button | Right click | Right click|\r\n| X Button | Double click | Open file / select a word in text |\r\n| Y Button | Middle click | Open link in new tab|\r\n| D-Pad up | Ctrl + + | Zoom in |\r\n| D-Pad down | Ctrl + - | Zoom out |\r\n| D-Pad right | Ctrl + T | New tab |\r\n| D-Pad left | Ctrl + W | Close window |\r\n| Left shoulder | Ctrl + Shift + Tab | Next tab |\r\n| Right shoulder | Ctrl + Tab | Previous tab |\r\n| Left stick | Alt + Left | Go back |\r\n| Right stick | Alt + Right | Go forward |\r\n| Select button | Ctrl + C | Copy |\r\n| Start button | Ctrl + V | Paste |\r\n| Middle button | Enter | Apply |\r\n\r\n## Button Mapping\r\nDifferent gamepad types combined with different operating systems/drivers can cause button mapping inconsistencies. \r\nManually set your map if the shoulder and stick buttons on your gamepad are misaligned with the table above. \r\nFor example, a gamepad called \"Controller (HORIPAD S)\" could use the \"xbox_windows\" map which would be applied as: \r\n```GuiPad.MapGamepad(\"Controller (HORIPAD S)\",\"xbox_windows\")``` \r\n\r\nThe following command will provide further guidance for button mapping:\r\n```python\r\nimport GuiPad\r\nGuiPad.MapGamepad()\r\n```\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Use your gamepad as a mouse with pygame and PyAutoGUI.",
"version": "1.2.2",
"project_urls": {
"Homepage": "https://github.com/JackLawrenceCRISPR/GuiPad"
},
"split_keywords": [
"python",
"pygame",
"pyautogui",
"gamepad"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "03544f2f36047b70f2a84f9d59f4e39f4d9116bf7c258c99653e386a919bd5af",
"md5": "733174f3ceaff813048861590920503b",
"sha256": "bcd6f78fdc8eb7087cb2f5ac6c2b2832d8ff3a256cec7871349e906f7631e9a5"
},
"downloads": -1,
"filename": "GuiPad-1.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "733174f3ceaff813048861590920503b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.0",
"size": 9210,
"upload_time": "2023-10-25T12:46:21",
"upload_time_iso_8601": "2023-10-25T12:46:21.102568Z",
"url": "https://files.pythonhosted.org/packages/03/54/4f2f36047b70f2a84f9d59f4e39f4d9116bf7c258c99653e386a919bd5af/GuiPad-1.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e7bf665a9bbef4367482dcedf3caa633ea8da0aab2dd172e9df4eedd65ad8ab6",
"md5": "29be14a7256a36ee9abe7397fce86808",
"sha256": "40a19fed5522e22ab598eb8e62b6047e5c22c0c126415e8bfb586c3aef0fcd9a"
},
"downloads": -1,
"filename": "GuiPad-1.2.2.tar.gz",
"has_sig": false,
"md5_digest": "29be14a7256a36ee9abe7397fce86808",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.0",
"size": 9146,
"upload_time": "2023-10-25T12:46:22",
"upload_time_iso_8601": "2023-10-25T12:46:22.623599Z",
"url": "https://files.pythonhosted.org/packages/e7/bf/665a9bbef4367482dcedf3caa633ea8da0aab2dd172e9df4eedd65ad8ab6/GuiPad-1.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-25 12:46:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "JackLawrenceCRISPR",
"github_project": "GuiPad",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "guipad"
}
JSON
