Skip to content

tacio/joyboard

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

joyboard

PyPI - Version PyPI - Python Version


Table of Contents

Purpose

joyboard is a python program that sends keyboard signals from a joypad (like a xbox controller) so that you write from the joypad.

Currently, lower case letters and some punctuaction is all you can write. Also, you can delete characters (backspace), insert newline (enter), insert tab, and move the cursor. But, there many buttons and combos yet to create.

Conceptually, it should act kind of like a stenographic keyboard, writing full words with simultaneous key presses.

Installation

pip install joyboard

This will also install the necessary dependencies: pygame for controller input and keyboard for sending keystrokes.

Usage

To run joyboard, execute the main script:

python -m joyboard.main

Note

On Linux, you might need to run it with sudo for it to work.

Controls

The controller is used as follows:

  • Left Stick: Selects a character set.
  • Face Buttons (A, B, X, Y): Selects a character from the set.
  • Right Stick: Moves the cursor (up, down, left, right).

Character Mapping

The table below shows the character mapped to each combination of the left stick direction and face button.

Direction A B X Y
N (Up) a b c h
NE ã g f v
E (Right) e d s m
SE y q j w
S (Down) i p z n
SW õ . , !
W (Left) o t r l
NW u k x ?

Special Characters

Special actions are mapped to face buttons when the left stick is in the neutral position.

Button Action
A space
B backspace
X enter
Y tab

Roadmap

joyboard is still early (lowercase letters and some punctuation today), with much more planned — a fuller character set, configurable layouts, CI, and an ecosystem around it. See ROADMAP.md for where the project is headed.

License

joyboard is distributed under the terms of the MIT license.

About

Python prototype for chord-inspired text entry using a game controller.

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages