{"id":19179586,"url":"https://github.com/animenosekai/umaru","last_synced_at":"2026-06-11T21:32:55.703Z","repository":{"id":185343821,"uuid":"603573518","full_name":"Animenosekai/umaru","owner":"Animenosekai","description":"A small Switch Pro Controller driver which lets you use your computer with it !","archived":false,"fork":false,"pushed_at":"2025-05-19T19:25:28.000Z","size":1043,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-26T04:30:36.613Z","etag":null,"topics":["controller","driver","pro-controller","switch"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Animenosekai.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-02-18T23:12:20.000Z","updated_at":"2023-08-01T15:09:21.000Z","dependencies_parsed_at":null,"dependency_job_id":"4bc62591-a192-4a5a-835c-3319e04d93cc","html_url":"https://github.com/Animenosekai/umaru","commit_stats":null,"previous_names":["animenosekai/umaru"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/Animenosekai/umaru","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Animenosekai%2Fumaru","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Animenosekai%2Fumaru/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Animenosekai%2Fumaru/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Animenosekai%2Fumaru/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Animenosekai","download_url":"https://codeload.github.com/Animenosekai/umaru/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Animenosekai%2Fumaru/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34219510,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-11T02:00:06.485Z","response_time":57,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["controller","driver","pro-controller","switch"],"created_at":"2024-11-09T10:43:34.141Z","updated_at":"2026-06-11T21:32:55.682Z","avatar_url":"https://github.com/Animenosekai.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Umaru\n\n\u003cimg align=\"right\" src=\"./assets/umaru.png\" height=\"220px\"\u003e\n\n***A small Switch Pro Controller driver which lets you use your computer with it !***\n\n\u003cbr\u003e\n\u003cbr\u003e\n\n[![PyPI version](https://badge.fury.io/py/umaru.svg)](https://pypi.org/project/umaru/)\n[![Downloads](https://static.pepy.tech/personalized-badge/umaru?period=total\u0026units=international_system\u0026left_color=grey\u0026right_color=blue\u0026left_text=Total%20Downloads)](https://pepy.tech/project/umaru)\n[![PyPI - Downloads](https://img.shields.io/pypi/dm/umaru)](https://pypistats.org/packages/umaru)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/umaru)](https://pypi.org/project/umaru/)\n[![PyPI - Status](https://img.shields.io/pypi/status/umaru)](https://pypi.org/project/umaru/)\n[![GitHub - License](https://img.shields.io/github/license/Animenosekai/umaru)](https://github.com/Animenosekai/umaru/blob/master/LICENSE)\n[![GitHub top language](https://img.shields.io/github/languages/top/Animenosekai/umaru)](https://github.com/Animenosekai/umaru)\n[![CodeQL Checks Badge](https://github.com/Animenosekai/umaru/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/Animenosekai/umaru/actions/workflows/codeql-analysis.yml)\n![Code Size](https://img.shields.io/github/languages/code-size/Animenosekai/umaru)\n![Repo Size](https://img.shields.io/github/repo-size/Animenosekai/umaru)\n![Issues](https://img.shields.io/github/issues/Animenosekai/umaru)\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\u003e 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\u003e 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┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━┓                                                                                            \n┃ Device                             ┃ Manufacturer ┃ Serial Number         ┃                                                                                            \n┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━┩                                                                                            \n│                                    │ Apple        │                       │                                                                                            \n│                                    │ Apple        │                       │                                                                                            \n│ Apple Internal Keyboard / Trackpad │ Apple Inc.   │ FM70*************+F** │                                                                                            \n│ Apple Internal Keyboard / Trackpad │ Apple Inc.   │ FM70*************+F** │                                                                                            \n│ Apple Internal Keyboard / Trackpad │ Apple Inc.   │ FM70*************+F** │                                                                                            \n│ Apple Internal Keyboard / Trackpad │ Apple Inc.   │ FM70*************+F** │                                                                                            \n│ Apple Internal Keyboard / Trackpad │ Apple Inc.   │ FM70*************+F** │                                                                                            \n│ Apple Internal Keyboard / Trackpad │ Apple Inc.   │ FM70*************+F** │                                                                                            \n│ Apple Internal Keyboard / Trackpad │ Apple Inc.   │ FM70*************+F** │                                                                                            \n│ Apple Internal Keyboard / Trackpad │ Apple Inc.   │ FM70*************+F** │                                                                                            \n│ Apple Internal Keyboard / Trackpad │ Apple Inc.   │ FM70*************+F** │                                                                                            \n│ Apple Internal Keyboard / Trackpad │ Apple Inc.   │ FM70*************+F** │                                                                                            \n│ BTM                                │ APPL         │                       │                                                                                            \n│ Headset                            │ Apple        │                       │                                                                                            \n│ Keyboard Backlight                 │              │                       │                                                                                            \n└────────────────────────────────────┴──────────────┴───────────────────────┘                                                                                            \n                                                                                                                                                                         \n                                                                                                                                                                         \n                                                                                                                                                                         \n⠴ Searching for a controller — 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┏━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┓                                                                                                                    \n┃ Device         ┃ Manufacturer ┃ Serial Number     ┃                                                                                                                    \n┡━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━┩                                                                                                                    \n│ Pro Controller │              │ 58:**:**:**:**:D9 │                                                                                                                    \n└────────────────┴──────────────┴───────────────────┘                                                                                                                    \n                                                                                                                                                                                                                                                                                                                                       \n⠸ Filter: pro — 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![Keyboard Screenshot](assets/screenshot_keyboard.png)\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`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanimenosekai%2Fumaru","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fanimenosekai%2Fumaru","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanimenosekai%2Fumaru/lists"}