{"id":15752784,"url":"https://github.com/yamakaky/gyromouse","last_synced_at":"2025-06-13T22:39:35.559Z","repository":{"id":145832012,"uuid":"393499213","full_name":"Yamakaky/gyromouse","owner":"Yamakaky","description":"A crossplatform mapper from gamepad inputs to keyboard and mouse actions, with special care for good gyro controls.","archived":false,"fork":false,"pushed_at":"2024-05-10T13:02:48.000Z","size":472,"stargazers_count":23,"open_issues_count":28,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-28T01:48:36.226Z","etag":null,"topics":["gamepad","gyro","linux","macos","windows"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Yamakaky.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"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":"2021-08-06T20:47:17.000Z","updated_at":"2025-02-05T14:06:03.000Z","dependencies_parsed_at":"2024-10-25T09:55:01.642Z","dependency_job_id":null,"html_url":"https://github.com/Yamakaky/gyromouse","commit_stats":{"total_commits":133,"total_committers":3,"mean_commits":"44.333333333333336","dds":0.06015037593984962,"last_synced_commit":"7aca933ac9eca5a046ebb0aaa5d53d1d52b2dc74"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yamakaky%2Fgyromouse","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yamakaky%2Fgyromouse/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yamakaky%2Fgyromouse/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yamakaky%2Fgyromouse/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Yamakaky","download_url":"https://codeload.github.com/Yamakaky/gyromouse/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248881475,"owners_count":21176858,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["gamepad","gyro","linux","macos","windows"],"created_at":"2024-10-04T07:05:44.102Z","updated_at":"2025-04-14T12:31:37.753Z","avatar_url":"https://github.com/Yamakaky.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Gyromouse\n\nA crossplatform mapper from gamepad inputs to keyboard and mouse actions, with special care for good gyro controls. Useful to play games and control a computer from the couch.\n\n## Main features\n\n- [X] Translation of gamepad buttons, sticks, 3D movement and more into keyboard and mouse actions\n  - [X] Control the mouse in 3D and 2D apps by physically moving the controller ([The gyro is a mouse](http://gyrowiki.jibbsmart.com/blog:the-gyro-revolution)). Only on compatible hardware including PS4/5, Switch and Steam controllers.\n  - [X] Advanced input mapping including tap, hold, double click, layers and more\n  - [X] Multiple stick modes including Flick Stick, mouse ring, scroll wheel and more\n- [X] Crossplatform support of Windows, Linux and macOS.\n- [ ] Planned: configuration in a GUI in addition of the text files\n- [ ] Planned: 3D render of the controller with its orientation in a window\n\n## Quickstart\n\n1. Download the latest release at https://github.com/Yamakaky/gyromouse/releases ;\n2. Create a `default.txt` file in the same directory as `gyromouse`. Possible content is described below. You can start with one of the examples at https://github.com/Yamakaky/gyromouse/tree/master/mappings ;\n3. Run `gyromouse`, either by double click (Windows) or in a terminal (Linux, macOS). This will run the input mapper using the configuration in `default.txt`.\n\n### Windows\n\nNo special setup are needed. When launching, you may need to [allow the app in Defender Smartscreen](https://www.addictivetips.com/windows-tips/whitelist-apps-in-the-smartscreen-on-windows-10) or in your antivirus.\n\n### Linux\n\n`gyromouse` needs access rights to the controller device in `/dev` to access every features, the gyroscope in particular. If you don't see `Starting calibration, don't move the controller...` in the console when pluging in the controller, try doing one of the following:\n\n1. Install udev rules from steam, for example `usr/lib/udev/rules.d/70-steam-input.rules` from the [Steam package in Archlinux](https://archlinux.org/packages/multilib/x86_64/steam/download), if a similar file is not installed by your distro;\n2. Put your user in the `input` group and reboot (`usermod -a -G input \u003cmyuser\u003e`);\n3. Give yourself access to the raw hid devices `chmod 666 /dev/hidraw*` (temporary, lasts until next reboot));\n4. Run `gyromouse` as root using `sudo` (last resort, not recommended).\n\n### macOS\n\nTODO\n\n## Configuration\n\n`gyromouse` uses the same configuration format as [JoyShockMapper](https://github.com/Electronicks/JoyShockMapper#commands). See [here](https://github.com/Yamakaky/gyromouse/blob/master/src/config/all-settings-example) for every command parsed by `gyromouse`, and \u003chttps://github.com/Yamakaky/gyromouse/issues\u003e for missing or partial features. Some of them are unimplemented and show a warning when used. Implemented features:\n- [X] Digital inputs\n    - [X] Most controller inputs\n    - [X] Most simple keys (letters, enter, space...)\n    - [X] Tap, hold, simultaneous, double and chorded press\n    - [X] Modifiers\n- [ ] Advanced triggers\n- [X] Sticks\n    - [X] AIM, FLICK, FLICK_ONLY, ROTATE_ONLY, NO_MOUSE\n    - [X] MOUSE_RING, MOUSE_AREA, SCROLL_WHEEL\n    - [ ] Ring only for NO_MOUSE\n- [X] Gyro\n    - [X] Most settings\n    - [X] Local, world and player space\n    - [ ] Basic sensor fusion only\n    - [ ] Calibration on connection only\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyamakaky%2Fgyromouse","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyamakaky%2Fgyromouse","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyamakaky%2Fgyromouse/lists"}