# Umaru
<img align="right" src="./assets/umaru.png" height="220px">
***A small Switch Pro Controller driver which lets you use your computer with it !***
<br>
<br>
[](https://pypi.org/project/umaru/)
[](https://pepy.tech/project/umaru)
[](https://pypistats.org/packages/umaru)
[](https://pypi.org/project/umaru/)
[](https://pypi.org/project/umaru/)
[](https://github.com/Animenosekai/umaru/blob/master/LICENSE)
[](https://github.com/Animenosekai/umaru)
[](https://github.com/Animenosekai/umaru/actions/workflows/codeql-analysis.yml)
## Index
- [Index](#index)
- [Features](#features)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installing](#installing)
- [Option 1: From PyPI](#option-1-from-pypi)
- [Option 2: From Git](#option-2-from-git)
- [Usage](#usage)
- [Select your device](#select-your-device)
- [Use your controller](#use-your-controller)
- [Quitting Umaru](#quitting-umaru)
## Features
- A cool looking Bluetooth device selection screen
- Control your mouse using your controller
- Use a virtual keyboard with your controller
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
### Prerequisites
You will need Python 3 to use this module
```bash
# vermin output
Minimum required versions: 3.7
Incompatible versions: 2
```
## Installing
### Option 1: From PyPI
```bash
pip install --upgrade umaru
```
> This will install the latest stable version from PyPI
### Option 2: From Git
```bash
pip install --upgrade git+https://github.com/Animenosekai/umaru.git
```
> This will install the latest development version from the git repository
You can check if you successfully installed it by printing out its version:
```bash
$ umaru --version
1.0
```
## Usage
```bash
usage: umaru [-h] [--filter FILTER]
options:
-h, --help show this help message and exit
--filter FILTER, -f FILTER
The default filter. Can be used to skip the controller discovery step.
```
You can use the `--filter` parameter to give a default filter for the discovery step, which automatically selects the controller if it is the only result which comes up.
If you are using `umaru` for the first time, I would recommend using the interactive discovery window first:
Start by running *umaru*
```bash
umaru
```
### Select your device
You should see the device discovery scene appear :
```bash
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Device ┃ Manufacturer ┃ Serial Number ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━┩
│ │ Apple │ │
│ │ Apple │ │
│ Apple Internal Keyboard / Trackpad │ Apple Inc. │ FM70*************+F** │
│ Apple Internal Keyboard / Trackpad │ Apple Inc. │ FM70*************+F** │
│ Apple Internal Keyboard / Trackpad │ Apple Inc. │ FM70*************+F** │
│ Apple Internal Keyboard / Trackpad │ Apple Inc. │ FM70*************+F** │
│ Apple Internal Keyboard / Trackpad │ Apple Inc. │ FM70*************+F** │
│ Apple Internal Keyboard / Trackpad │ Apple Inc. │ FM70*************+F** │
│ Apple Internal Keyboard / Trackpad │ Apple Inc. │ FM70*************+F** │
│ Apple Internal Keyboard / Trackpad │ Apple Inc. │ FM70*************+F** │
│ Apple Internal Keyboard / Trackpad │ Apple Inc. │ FM70*************+F** │
│ Apple Internal Keyboard / Trackpad │ Apple Inc. │ FM70*************+F** │
│ BTM │ APPL │ │
│ Headset │ Apple │ │
│ Keyboard Backlight │ │ │
└────────────────────────────────────┴──────────────┴───────────────────────┘
⠴ Searching for a controller — 0:00:07
```
Here, you can search your Switch Pro Controller using the arrows on your keyboard. You can also filter the results by typing a keyword.
```bash
┏━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┓
┃ Device ┃ Manufacturer ┃ Serial Number ┃
┡━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━┩
│ Pro Controller │ │ 58:**:**:**:**:D9 │
└────────────────┴──────────────┴───────────────────┘
⠸ Filter: pro — 0:00:13
```
Press **ENTER** to select the device.
### Use your controller
It should now connect to your controller.
- You can use the directional pad (the arrows) to move your cursor
- You can use the `A` button to left-click
- You can use the `B` button to right-click
- You can use the left stick to move the cursor up and down
- You can use the right stick to scroll
- You can use the share button (the square with a square in it) to bring up the virtual keyboard
- With the keyboard opened you can use the `ZR` button to capture or remove the controller capturing : this switches if the controller controls the mouse or the keyboard.
- When captured, you can use the directional pad (the arrows) to move around the keys
- When captured, you can use the `A` button to press a key, `B` to delete
- The capture also releases the scroll, which is might act weird if the controller is not captured by the keyboard
- You can press the share button again to remove the capture and close the virtual keyboard
### Quitting Umaru
Go back to your terminal and press `CTRL+C` or just press the left and right stick at the same time to quit `umaru`
Raw data
{
"_id": null,
"home_page": "https://github.com/Animenosekai/umaru",
"name": "umaru",
"maintainer": "Animenosekai",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "animenosekai.mail@gmail.com",
"keywords": "animenosekai,umaru,console,switch,controller,pro controller,game controller,game",
"author": "Animenosekai",
"author_email": "animenosekai.mail@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/99/d1/0feba19f86fe7cdaf184f0f4cbe6c2e17e6a82e88a73ee276d5076ed20d4/umaru-1.0.tar.gz",
"platform": null,
"description": "# Umaru\n\n<img align=\"right\" src=\"./assets/umaru.png\" height=\"220px\">\n\n***A small Switch Pro Controller driver which lets you use your computer with it !***\n\n<br>\n<br>\n\n[](https://pypi.org/project/umaru/)\n[](https://pepy.tech/project/umaru)\n[](https://pypistats.org/packages/umaru)\n[](https://pypi.org/project/umaru/)\n[](https://pypi.org/project/umaru/)\n[](https://github.com/Animenosekai/umaru/blob/master/LICENSE)\n[](https://github.com/Animenosekai/umaru)\n[](https://github.com/Animenosekai/umaru/actions/workflows/codeql-analysis.yml)\n\n\n\n\n## Index\n\n- [Index](#index)\n- [Features](#features)\n- [Getting Started](#getting-started)\n - [Prerequisites](#prerequisites)\n- [Installing](#installing)\n - [Option 1: From PyPI](#option-1-from-pypi)\n - [Option 2: From Git](#option-2-from-git)\n- [Usage](#usage)\n - [Select your device](#select-your-device)\n - [Use your controller](#use-your-controller)\n - [Quitting Umaru](#quitting-umaru)\n\n## Features\n\n- A cool looking Bluetooth device selection screen\n- Control your mouse using your controller\n- Use a virtual keyboard with your controller\n\n## Getting Started\n\nThese instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.\n\n### Prerequisites\n\nYou will need Python 3 to use this module\n\n```bash\n# vermin output\nMinimum required versions: 3.7\nIncompatible versions: 2\n```\n\n## Installing\n\n### Option 1: From PyPI\n\n```bash\npip install --upgrade umaru\n```\n\n> This will install the latest stable version from PyPI\n\n### Option 2: From Git\n\n```bash\npip install --upgrade git+https://github.com/Animenosekai/umaru.git\n```\n\n> This will install the latest development version from the git repository\n\nYou can check if you successfully installed it by printing out its version:\n\n```bash\n$ umaru --version\n1.0\n```\n\n## Usage\n\n```bash\nusage: umaru [-h] [--filter FILTER]\n\noptions:\n -h, --help show this help message and exit\n --filter FILTER, -f FILTER\n The default filter. Can be used to skip the controller discovery step.\n```\n\nYou can use the `--filter` parameter to give a default filter for the discovery step, which automatically selects the controller if it is the only result which comes up.\n\nIf you are using `umaru` for the first time, I would recommend using the interactive discovery window first:\n\nStart by running *umaru*\n\n```bash\numaru\n```\n\n### Select your device\n\nYou should see the device discovery scene appear :\n\n```bash\n\u250f\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2513 \n\u2503 Device \u2503 Manufacturer \u2503 Serial Number \u2503 \n\u2521\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2529 \n\u2502 \u2502 Apple \u2502 \u2502 \n\u2502 \u2502 Apple \u2502 \u2502 \n\u2502 Apple Internal Keyboard / Trackpad \u2502 Apple Inc. \u2502 FM70*************+F** \u2502 \n\u2502 Apple Internal Keyboard / Trackpad \u2502 Apple Inc. \u2502 FM70*************+F** \u2502 \n\u2502 Apple Internal Keyboard / Trackpad \u2502 Apple Inc. \u2502 FM70*************+F** \u2502 \n\u2502 Apple Internal Keyboard / Trackpad \u2502 Apple Inc. \u2502 FM70*************+F** \u2502 \n\u2502 Apple Internal Keyboard / Trackpad \u2502 Apple Inc. \u2502 FM70*************+F** \u2502 \n\u2502 Apple Internal Keyboard / Trackpad \u2502 Apple Inc. \u2502 FM70*************+F** \u2502 \n\u2502 Apple Internal Keyboard / Trackpad \u2502 Apple Inc. \u2502 FM70*************+F** \u2502 \n\u2502 Apple Internal Keyboard / Trackpad \u2502 Apple Inc. \u2502 FM70*************+F** \u2502 \n\u2502 Apple Internal Keyboard / Trackpad \u2502 Apple Inc. \u2502 FM70*************+F** \u2502 \n\u2502 Apple Internal Keyboard / Trackpad \u2502 Apple Inc. \u2502 FM70*************+F** \u2502 \n\u2502 BTM \u2502 APPL \u2502 \u2502 \n\u2502 Headset \u2502 Apple \u2502 \u2502 \n\u2502 Keyboard Backlight \u2502 \u2502 \u2502 \n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518 \n \n \n \n\u2834 Searching for a controller \u2014 0:00:07 \n```\n\nHere, you can search your Switch Pro Controller using the arrows on your keyboard. You can also filter the results by typing a keyword.\n\n```bash\n\u250f\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2513 \n\u2503 Device \u2503 Manufacturer \u2503 Serial Number \u2503 \n\u2521\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2529 \n\u2502 Pro Controller \u2502 \u2502 58:**:**:**:**:D9 \u2502 \n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518 \n \n\u2838 Filter: pro \u2014 0:00:13 \n```\n\nPress **ENTER** to select the device.\n\n### Use your controller\n\nIt should now connect to your controller.\n\n- You can use the directional pad (the arrows) to move your cursor\n- You can use the `A` button to left-click\n- You can use the `B` button to right-click\n- You can use the left stick to move the cursor up and down\n- You can use the right stick to scroll\n- You can use the share button (the square with a square in it) to bring up the virtual keyboard\n - With the keyboard opened you can use the `ZR` button to capture or remove the controller capturing : this switches if the controller controls the mouse or the keyboard.\n - When captured, you can use the directional pad (the arrows) to move around the keys\n - When captured, you can use the `A` button to press a key, `B` to delete\n - The capture also releases the scroll, which is might act weird if the controller is not captured by the keyboard\n - You can press the share button again to remove the capture and close the virtual keyboard\n\n### Quitting Umaru\n\nGo back to your terminal and press `CTRL+C` or just press the left and right stick at the same time to quit `umaru`",
"bugtrack_url": null,
"license": "MIT",
"summary": "A small Switch Pro Controller driver which lets you use your computer with it !",
"version": "1.0",
"project_urls": {
"Documentation": "https://github.com/Animenosekai/umaru/blob/main/README.md",
"Homepage": "https://github.com/Animenosekai/umaru",
"Issue Tracker": "https://github.com/Animenosekai/umaru/issues",
"Repository": "https://github.com/Animenosekai/umaru"
},
"split_keywords": [
"animenosekai",
"umaru",
"console",
"switch",
"controller",
"pro controller",
"game controller",
"game"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5434e9aeda36a8d4bf30c10844b24d597f4f58b66fb6df9b22165f859dafbbd4",
"md5": "934f0b70f1735f108f4e642b85829461",
"sha256": "b54692c346b356c11d7899a5c7f3a6cf742fd383e4e204e10a3b16a6acfe697e"
},
"downloads": -1,
"filename": "umaru-1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "934f0b70f1735f108f4e642b85829461",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 12590,
"upload_time": "2023-08-01T15:07:46",
"upload_time_iso_8601": "2023-08-01T15:07:46.048094Z",
"url": "https://files.pythonhosted.org/packages/54/34/e9aeda36a8d4bf30c10844b24d597f4f58b66fb6df9b22165f859dafbbd4/umaru-1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "99d10feba19f86fe7cdaf184f0f4cbe6c2e17e6a82e88a73ee276d5076ed20d4",
"md5": "d6b18faa07c5491adc7f70b5541ff94d",
"sha256": "ce3eea7a1ff9d5594f6f72b29649e356bad29a247304d5595033b3ac43582fe9"
},
"downloads": -1,
"filename": "umaru-1.0.tar.gz",
"has_sig": false,
"md5_digest": "d6b18faa07c5491adc7f70b5541ff94d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 13257,
"upload_time": "2023-08-01T15:07:47",
"upload_time_iso_8601": "2023-08-01T15:07:47.812715Z",
"url": "https://files.pythonhosted.org/packages/99/d1/0feba19f86fe7cdaf184f0f4cbe6c2e17e6a82e88a73ee276d5076ed20d4/umaru-1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-01 15:07:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Animenosekai",
"github_project": "umaru",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "umaru"
}
JSON
