Skip to content

Joystick support #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions docs/docs/joystick.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
layout: default
title: Joystick support
parent: Porting guide
nav_order: 8
---

# Joystick

Joystick can be used to send Joystick events thru USB Joystick interface.

![](../img/vial-joystick.png)

In order to enable Joystick support in your firmware, follow these steps:

## 1. Add QMK Joystick support to `config.h`

Follow [QMK documentation](https://docs.qmk.fm/#/feature_joystick) in order to configure Joystick.

## 2. Enable Joystick in `rules.mk`

Add `JOYSTICK_ENABLE = yes` to your `rules.mk` file.

## 3. Add Vial Joystick as part of KLE keymap

To enable **Joystick** on **VIAL** it is necessary to add this lines to the `vial.json` file

```
{ "vial": {
"Joystick": true
...
}
}

```

## Done!
Binary file added docs/img/vial-joystick.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.