├── steam_appid.txt ├── .gitattributes ├── requirements.txt ├── GadgetDeck ├── requirements.txt ├── keyboard.json ├── joystick_ui.py ├── onscreen_keyboard.py └── __main__.py ├── util ├── gadget-deck-base.service ├── gadget-deck@.service ├── gadget-deck@shell.service ├── 99-gadget-deck.rules ├── gadget-deck@mtp.service ├── gadget-deck-autocomplete └── game_actions_480.vdf ├── setup ├── Makefile ├── HID Descriptors ├── mouse.txt ├── keyboard.txt └── joystick.txt ├── README.md ├── .gitignore ├── gadget-deck-manager.py └── LICENSE /steam_appid.txt: -------------------------------------------------------------------------------- 1 | 480 -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | git+https://github.com/Frederic98/python-hid-parser.git 2 | usb-gadget 3 | -------------------------------------------------------------------------------- /GadgetDeck/requirements.txt: -------------------------------------------------------------------------------- 1 | PyQt5 2 | usb-gadget 3 | git+https://github.com/Frederic98/SteamworksPy.git 4 | -------------------------------------------------------------------------------- /util/gadget-deck-base.service: -------------------------------------------------------------------------------- 1 | # /etc/systemd/system/gadget-deck-base.service 2 | [Unit] 3 | Description=Steam Deck Gadget base 4 | 5 | [Service] 6 | Type=oneshot 7 | RemainAfterExit=yes 8 | WorkingDirectory=/usr/share/gadget-deck 9 | ExecStartPre=modprobe libcomposite 10 | ExecStart=/usr/share/gadget-deck/gadget-deck-manager.py setup 11 | ExecStop=/usr/share/gadget-deck/gadget-deck-manager.py destroy 12 | 13 | [Install] 14 | WantedBy=multi-user.target 15 | -------------------------------------------------------------------------------- /util/gadget-deck@.service: -------------------------------------------------------------------------------- 1 | # /etc/systemd/system/gadget-deck@.service 2 | [Unit] 3 | Description=Steam Deck Gadget function 4 | BindsTo=gadget-deck-base.service 5 | After=gadget-deck-base.service 6 | 7 | [Service] 8 | Type=oneshot 9 | RemainAfterExit=yes 10 | WorkingDirectory=/usr/share/gadget-deck 11 | ExecStart=/usr/share/gadget-deck/gadget-deck-manager.py enable %i 12 | ExecStop=/usr/share/gadget-deck/gadget-deck-manager.py disable %i 13 | 14 | 15 | [Install] 16 | WantedBy=multi-user.target 17 | -------------------------------------------------------------------------------- /util/gadget-deck@shell.service: -------------------------------------------------------------------------------- 1 | # /etc/systemd/system/gadget-deck@shell.service 2 | [Unit] 3 | Description=Steam Deck Gadget MTP function 4 | BindsTo=gadget-deck-base.service 5 | After=gadget-deck-base.service 6 | 7 | [Service] 8 | Type=oneshot 9 | RemainAfterExit=yes 10 | WorkingDirectory=/usr/share/gadget-deck 11 | ExecStart=/usr/share/gadget-deck/gadget-deck-manager.py enable shell 12 | ExecStop=/usr/share/gadget-deck/gadget-deck-manager.py disable shell 13 | 14 | [Install] 15 | WantedBy=multi-user.target 16 | -------------------------------------------------------------------------------- /setup: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | if [ ! "$EUID" -eq 0 ]; then 4 | echo "Run as root!" 5 | exit 1 6 | fi 7 | 8 | wget -P GadgetDeck https://github.com/Frederic98/GadgetDeck/releases/download/V0.1/GadgetDeck.zip 9 | cd GadgetDeck 10 | unzip GadgetDeck.zip 11 | 12 | su $SUDO_USER -c make 13 | make install 14 | 15 | cp -r GadgetDeck /usr/share/gadget-deck/ 16 | chmod +x /usr/share/gadget-deck/GadgetDeck/GadgetDeck 17 | sudo -u $SUDO_USER bash -c "steamos-add-to-steam /usr/share/gadget-deck/GadgetDeck/GadgetDeck" 18 | 19 | cd .. 20 | rm -r GadgetDeck 21 | -------------------------------------------------------------------------------- /util/99-gadget-deck.rules: -------------------------------------------------------------------------------- 1 | // /etc/polkit-1/rules.d/99-gadget-deck.rules 2 | // Allow non-root user to manage GadgetDeck service 3 | polkit.addRule(function(action, subject) { 4 | if (action.id == "org.freedesktop.systemd1.manage-units" && subject.user == "deck") { 5 | if(action.lookup("unit") == "gadget-deck-base.service"){ 6 | return polkit.Result.YES; 7 | } 8 | if(RegExp('gadget-deck@[A-Za-z0-9_-]+.service').test(action.lookup("unit"))){ 9 | return polkit.Result.YES; 10 | } 11 | } 12 | }); 13 | -------------------------------------------------------------------------------- /util/gadget-deck@mtp.service: -------------------------------------------------------------------------------- 1 | # /etc/systemd/system/gadget-deck@mtp.service 2 | [Unit] 3 | Description=Steam Deck Gadget MTP function 4 | BindsTo=gadget-deck-base.service 5 | After=gadget-deck-base.service 6 | 7 | [Service] 8 | Type=exec 9 | WorkingDirectory=/usr/share/gadget-deck 10 | ExecStartPre=/usr/share/gadget-deck/gadget-deck-manager.py enable mtp --no-activate 11 | ExecStart=/usr/share/gadget-deck/umtprd 12 | ExecStartPost=/usr/share/gadget-deck/gadget-deck-manager.py activate 13 | ExecStopPost=/usr/share/gadget-deck/gadget-deck-manager.py disable mtp 14 | 15 | [Install] 16 | WantedBy=multi-user.target 17 | -------------------------------------------------------------------------------- /util/gadget-deck-autocomplete: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | _gadget_completer() { 4 | # Firstly, check if binary is found, don't autocomplete when not in GadgetDeck directory 5 | if type "${COMP_WORDS[0]}" > /dev/null 2>&1; then 6 | if [ "${#COMP_WORDS[@]}" == "2" ]; then 7 | # autocomplete the action 8 | COMPREPLY=($(compgen -W "setup destroy enable disable" "${COMP_WORDS[1]}")) 9 | elif [ "${#COMP_WORDS[@]}" == "3" ]; then 10 | # Check the value of the action argument 11 | if [ "${COMP_WORDS[1]}" == "destroy" ]; then 12 | # Autocomplete by listing what's in the usb gadget folder 13 | COMPREPLY=($(compgen -W "`ls /sys/kernel/config/usb_gadget`" "${COMP_WORDS[2]}")) 14 | fi 15 | fi 16 | fi 17 | } 18 | 19 | # Register the autocomplete function 20 | complete -F _gadget_completer gadget-deck-manager.py 21 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | .DEFAULT_GOAL := setup 2 | 3 | build-ui: 4 | pyinstaller \ 5 | --add-data "GadgetDeck/keyboard.json":"." \ 6 | --add-data "GadgetDeck/*.so":"." \ 7 | --add-data "steam_appid.txt":"." \ 8 | --name "GadgetDeck" \ 9 | GadgetDeck/__main__.py 10 | 11 | RELEASE_DIR = dist/release 12 | release: build-ui 13 | rm -r -f $(RELEASE_DIR) $(RELEASE_DIR).zip 14 | mkdir -p $(RELEASE_DIR) 15 | cp -r dist/GadgetDeck $(RELEASE_DIR) 16 | cp -r "HID Descriptors" $(RELEASE_DIR) 17 | cp -r util $(RELEASE_DIR) 18 | cp `find -maxdepth 1 -type f -not \( -name '.*' -or -name '*.spec' \)` $(RELEASE_DIR) 19 | cd $(RELEASE_DIR); zip -r GadgetDeck.zip *; cd -; 20 | 21 | setup: 22 | mkdir -p /home/deck/.steam/steam/controller_config 23 | cp util/game_actions_480.vdf /home/deck/.steam/steam/controller_config/ 24 | 25 | INSTALL_DIR = /usr/share/gadget-deck 26 | install: 27 | mkdir -p $(INSTALL_DIR) 28 | cp gadget-deck-manager.py $(INSTALL_DIR)/ 29 | chmod +x $(INSTALL_DIR)/gadget-deck-manager.py 30 | cp -r "HID Descriptors" $(INSTALL_DIR) 31 | pip install -r requirements.txt 32 | cp util/gadget-deck*.service /etc/systemd/system/ 33 | cp util/99-gadget-deck.rules /etc/polkit-1/rules.d/ 34 | -------------------------------------------------------------------------------- /HID Descriptors/mouse.txt: -------------------------------------------------------------------------------- 1 | 0x05, 0x01, // Usage Page (Generic Desktop Ctrls) 2 | 0x09, 0x02, // Usage (Mouse) 3 | 0xA1, 0x01, // Collection (Application) 4 | 0x05, 0x09, // Usage Page (Button) 5 | 0x19, 0x01, // Usage Minimum (0x01) 6 | 0x29, 0x08, // Usage Maximum (0x08) 7 | 0x15, 0x00, // Logical Minimum (0) 8 | 0x25, 0x01, // Logical Maximum (1) 9 | 0x95, 0x08, // Report Count (8) 10 | 0x75, 0x01, // Report Size (1) 11 | 0x81, 0x02, // Input (Data,Var,Abs,No Wrap,Linear,Preferred State,No Null Position) 12 | 0x05, 0x01, // Usage Page (Generic Desktop Ctrls) 13 | 0x09, 0x30, // Usage (X) 14 | 0x09, 0x31, // Usage (Y) 15 | 0x16, 0x00, 0x80, // Logical Minimum (-32768) 16 | 0x26, 0xFF, 0x7F, // Logical Maximum (32767) 17 | 0x75, 0x10, // Report Size (16) 18 | 0x95, 0x02, // Report Count (2) 19 | 0x81, 0x06, // Input (Data,Var,Rel,No Wrap,Linear,Preferred State,No Null Position) 20 | 0x09, 0x38, // Usage (Wheel) 21 | 0x15, 0x81, // Logical Minimum (-127) 22 | 0x25, 0x7F, // Logical Maximum (127) 23 | 0x75, 0x08, // Report Size (8) 24 | 0x95, 0x01, // Report Count (1) 25 | 0x81, 0x06, // Input (Data,Var,Rel,No Wrap,Linear,Preferred State,No Null Position) 26 | 0x05, 0x0C, // Usage Page (Consumer) 27 | 0x0A, 0x38, 0x02, // Usage (AC Pan) 28 | 0x15, 0x81, // Logical Minimum (-127) 29 | 0x25, 0x7F, // Logical Maximum (127) 30 | 0x75, 0x08, // Report Size (8) 31 | 0x95, 0x01, // Report Count (1) 32 | 0x81, 0x06, // Input (Data,Var,Rel,No Wrap,Linear,Preferred State,No Null Position) 33 | 0xC0, // End Collection 34 | 35 | // 68 bytes 36 | -------------------------------------------------------------------------------- /HID Descriptors/keyboard.txt: -------------------------------------------------------------------------------- 1 | 0x05, 0x01, // Usage Page (Generic Desktop Ctrls) 2 | 0x09, 0x06, // Usage (Keyboard) 3 | 0xA1, 0x01, // Collection (Application) 4 | 0x05, 0x08, // Usage Page (LEDs) 5 | 0x19, 0x01, // Usage Minimum (Num Lock) 6 | 0x29, 0x03, // Usage Maximum (Scroll Lock) 7 | 0x15, 0x00, // Logical Minimum (0) 8 | 0x25, 0x01, // Logical Maximum (1) 9 | 0x75, 0x01, // Report Size (1) 10 | 0x95, 0x03, // Report Count (3) 11 | 0x91, 0x02, // Output (Data,Var,Abs,No Wrap,Linear,Preferred State,No Null Position,Non-volatile) 12 | 0x09, 0x4B, // Usage (Generic Indicator) 13 | 0x95, 0x01, // Report Count (1) 14 | 0x91, 0x02, // Output (Data,Var,Abs,No Wrap,Linear,Preferred State,No Null Position,Non-volatile) 15 | 0x95, 0x04, // Report Count (4) 16 | 0x91, 0x01, // Output (Const,Array,Abs,No Wrap,Linear,Preferred State,No Null Position,Non-volatile) 17 | 0x05, 0x07, // Usage Page (Kbrd/Keypad) 18 | 0x19, 0xE0, // Usage Minimum (0xE0) 19 | 0x29, 0xE7, // Usage Maximum (0xE7) 20 | 0x95, 0x08, // Report Count (8) 21 | 0x81, 0x02, // Input (Data,Var,Abs,No Wrap,Linear,Preferred State,No Null Position) 22 | 0x75, 0x08, // Report Size (8) 23 | 0x95, 0x01, // Report Count (1) 24 | 0x81, 0x01, // Input (Const,Array,Abs,No Wrap,Linear,Preferred State,No Null Position) 25 | 0x19, 0x00, // Usage Minimum (0x00) 26 | 0x29, 0x91, // Usage Maximum (0x91) 27 | 0x26, 0xFF, 0x00, // Logical Maximum (255) 28 | 0x95, 0x06, // Report Count (6) 29 | 0x81, 0x00, // Input (Data,Array,Abs,No Wrap,Linear,Preferred State,No Null Position) 30 | 0xC0, // End Collection 31 | 32 | // 60 bytes 33 | -------------------------------------------------------------------------------- /HID Descriptors/joystick.txt: -------------------------------------------------------------------------------- 1 | 0x05, 0x01, // Usage Page (Generic Desktop Ctrls) 2 | 0x09, 0x04, // Usage (Joystick) 3 | 0xA1, 0x01, // Collection (Application) 4 | 0x15, 0x81, // Logical Minimum (-127) 5 | 0x25, 0x7F, // Logical Maximum (127) 6 | 0x09, 0x01, // Usage (Pointer) 7 | 0xA1, 0x00, // Collection (Physical) 8 | 0x09, 0x30, // Usage (X) 9 | 0x09, 0x31, // Usage (Y) 10 | 0x09, 0x33, // Usage (Rx) 11 | 0x09, 0x34, // Usage (Ry) 12 | 0x75, 0x08, // Report Size (8) 13 | 0x95, 0x04, // Report Count (4) 14 | 0x81, 0x02, // Input (Data,Var,Abs,No Wrap,Linear,Preferred State,No Null Position) 15 | 0xC0, // End Collection 16 | 0x15, 0x00, // Logical Minimum (0) 17 | 0x25, 0x7F, // Logical Maximum (127) 18 | 0x09, 0x01, // Usage (Pointer) 19 | 0xA1, 0x00, // Collection (Physical) 20 | 0x09, 0x32, // Usage (Z) 21 | 0x09, 0x35, // Usage (Rz) 22 | 0x75, 0x08, // Report Size (8) 23 | 0x95, 0x02, // Report Count (2) 24 | 0x81, 0x02, // Input (Data,Var,Abs,No Wrap,Linear,Preferred State,No Null Position) 25 | 0xC0, // End Collection 26 | 0xA1, 0x00, // Collection (Physical) 27 | 0x05, 0x09, // Usage Page (Button) 28 | 0x19, 0x01, // Usage Minimum (0x01) 29 | 0x29, 0x18, // Usage Maximum (0x18) 30 | 0x15, 0x00, // Logical Minimum (0) 31 | 0x25, 0x01, // Logical Maximum (1) 32 | 0x75, 0x01, // Report Size (1) 33 | 0x95, 0x18, // Report Count (24) 34 | 0x81, 0x02, // Input (Data,Var,Abs,No Wrap,Linear,Preferred State,No Null Position) 35 | 0xC0, // End Collection 36 | 0xC0, // End Collection 37 | 38 | // 68 bytes 39 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # GadgetDeck 2 | This is a program to emulate a game controller on the Steam Deck when connected over USB to another computer. 3 | 4 | ## How it works 5 | The USB port on the Steam Deck is a USB Dual Role Port. This means that, like most phones, it can act as a USB host or device. 6 | This is possible with the DWC3 (DesignWare Core SuperSpeed 3.0) controller in the AMD CPU. 7 | Using LibComposite, we can emulate a wide variety of USB devices. In this case, an HID device is emulated that has some game controller inputs. 8 | 9 | ## Prerequisites 10 | - A password set for the `deck` user 11 | - SSH enabled 12 | 13 | ## How to use 14 | ### 1. Enable USB Dual Role Device 15 | On the Steam Deck, boot into the BIOS by holding the `VOLUME UP` button and pressing the power button and go to `setup utility`. 16 | Navigate to `Advanced`>`USB Configuration`>`USB Dual Role Device` and change from `XHCI` to `DRD`. 17 | Then `Exit`>`Exit Saving Changes`. 18 | 19 | ### 2. Install GadgetDeck 20 | In a terminal, run 21 | ```shell 22 | curl -s https://raw.githubusercontent.com/Frederic98/GadgetDeck/main/setup | sudo bash 23 | ``` 24 | This should download and install GadgetDeck and everything it needs to work. When this is done, you should have a new item in your Steam library under `non-steam`. 25 | :exclamation:It is possible that it shows up as a blank tile without a name. This should be fixed after a reboot. 26 | 27 | Start GadgetDeck, and assign actions to all inputs appropriately. When this is done, connect your Deck to a PC and test if the keyboard and mouse work. 28 | 29 | On your computer, search `game controllers` and open `Set up USB game controllers`. Move the Steam Deck joysticks, and this should be reflected on your computer. 30 | 31 | In Steam on your computer, go to `settings`->`Controller`->`General controller settings` and enable `Generic gamepad configuration support`. 32 | Then, click the steam deck and map all the buttons to a controller layout. 33 | 34 | ### 3. Disable GadgetDeck 35 | Not really necessary. But, to stop the USB gadgets, either reboot the Deck, or, in a terminal, type `systemctl stop gadget-deck-base`. 36 | 37 | ## Planned improvements 38 | - Ethernet gadget for local multiplayer by connecting two Steam Decks to each other (Might need to disable charging on both to prevent one from draining the other) 39 | - MTP gadget to browse Steam Deck files from computer 40 | - UVC gadget for streaming game to computer without the use of an HDMI capture card 41 | -------------------------------------------------------------------------------- /GadgetDeck/keyboard.json: -------------------------------------------------------------------------------- 1 | [ 2 | [ 3 | {"name": "ESCAPE", "label": "ESC", "width": 1.5}, 4 | {"name": "F1", "type": "FUNCTION"}, 5 | {"name": "F2", "type": "FUNCTION"}, 6 | {"name": "F3", "type": "FUNCTION"}, 7 | {"name": "F4", "type": "FUNCTION"}, 8 | {"name": "F5", "type": "FUNCTION"}, 9 | {"name": "F6", "type": "FUNCTION"}, 10 | {"name": "F7", "type": "FUNCTION"}, 11 | {"name": "F8", "type": "FUNCTION"}, 12 | {"name": "F9", "type": "FUNCTION"}, 13 | {"name": "F10", "type": "FUNCTION"}, 14 | {"name": "F11", "type": "FUNCTION"}, 15 | {"name": "F12", "type": "FUNCTION"}, 16 | {"name": "DELETE", "label": "DEL", "width": 1.5} 17 | ], 18 | [ 19 | {"name": "`", "shift": "~"}, 20 | {"name": "1", "shift": "!"}, 21 | {"name": "2", "shift": "@"}, 22 | {"name": "3", "shift": "#"}, 23 | {"name": "4", "shift": "$"}, 24 | {"name": "5", "shift": "%"}, 25 | {"name": "6", "shift": "^"}, 26 | {"name": "7", "shift": "&"}, 27 | {"name": "8", "shift": "*"}, 28 | {"name": "9", "shift": "("}, 29 | {"name": "0", "shift": ")"}, 30 | {"name": "-", "shift": "_"}, 31 | {"name": "=", "shift": "+"}, 32 | {"name": "BACKSPACE", "width": 2, "label": "BACK"} 33 | ], 34 | [ 35 | {"name": "TAB", "width": 1.5, "label": "TAB"}, 36 | "Q", 37 | "W", 38 | "E", 39 | "R", 40 | "T", 41 | "Y", 42 | "U", 43 | "I", 44 | "O", 45 | "P", 46 | {"name": "[", "shift": "{"}, 47 | {"name": "]", "shift": "}"}, 48 | {"name": "\\", "width": 1.5, "shift": "|"} 49 | ], 50 | [ 51 | {"name": "CAPSLOCK", "width": 1.75, "label": "CAPS"}, 52 | "A", 53 | "S", 54 | "D", 55 | "F", 56 | "G", 57 | "H", 58 | "J", 59 | "K", 60 | "L", 61 | {"name": ";", "shift": ":"}, 62 | {"name": "'", "shift": "\""}, 63 | {"name": "ENTER", "width": 2.25, "label": "ENTER"} 64 | ], 65 | [ 66 | {"name": "SHIFT_LEFT", "width": 2.25, "label": "SHIFT", "type": "SHIFT"}, 67 | "Z", 68 | "X", 69 | "C", 70 | "V", 71 | "B", 72 | "N", 73 | "M", 74 | {"name": ",", "shift": "<"}, 75 | {"name": ".", "shift": ">"}, 76 | {"name": "/", "shift": "?"}, 77 | {"name": "SHIFT_RIGHT", "width": 2.75, "label": "SHIFT", "type": "SHIFT"} 78 | ], 79 | [ 80 | {"name": "CONTROL_LEFT", "width": 1.25, "label": "CTRL", "type": "CONTROL"}, 81 | {"name": "GUI_LEFT", "width": 1.25, "label": "#", "type": "GUI"}, 82 | {"name": "ALT_LEFT", "width": 1.25, "label": "ALT", "type": "ALT"}, 83 | {"name": "SPACE", "width": 8.75, "label": ""}, 84 | {"name": "ALT_RIGHT", "width": 1.25, "label": "ALT", "type": "ALT"}, 85 | {"name": "GUI_RIGHT", "width": 1.25, "label": "#", "type": "GUI"}, 86 | {"name": "APPLICATION", "width": 1.25, "label": "..."}, 87 | {"name": "CONTROL_RIGHT", "width": 1.25, "label": "CTRL", "type": "CONTROL"} 88 | ] 89 | ] -------------------------------------------------------------------------------- /util/game_actions_480.vdf: -------------------------------------------------------------------------------- 1 | "In Game Actions" 2 | { 3 | "actions" 4 | { 5 | "InGameControls" 6 | { 7 | "title" "#Set_Ingame" 8 | "StickPadGyro" 9 | { 10 | "JoyLeft" 11 | { 12 | "title" "#Action_JoyLeft" 13 | "input_mode" "joystick_move" 14 | } 15 | "JoyRight" 16 | { 17 | "title" "#Action_JoyRight" 18 | "input_mode" "joystick_move" 19 | } 20 | "Mouse" 21 | { 22 | "title" "#Action_Mouse" 23 | "input_mode" "absolute_mouse" 24 | } 25 | } 26 | "AnalogTrigger" 27 | { 28 | "TrigLeft" "#Action_TrigLeft" 29 | "TrigRight" "#Action_TrigRight" 30 | } 31 | "Button" 32 | { 33 | "X" "#Action_X" 34 | "Y" "#Action_Y" 35 | "A" "#Action_A" 36 | "B" "#Action_B" 37 | "UP" "#Action_UP" 38 | "DOWN" "#Action_DOWN" 39 | "LEFT" "#Action_LEFT" 40 | "RIGHT" "#Action_RIGHT" 41 | "BumpLeft" "#Action_BumpLeft" 42 | "BumpRight" "#Action_BumpRight" 43 | "Menu" "#Action_Menu" 44 | "Start" "#Action_Start" 45 | "JoyPressLeft" "#Action_JoyPressLeft" 46 | "JoyPressRight" "#Action_JoyPressRight" 47 | "MouseClickLeft" "#Action_MouseClickLeft" 48 | "MouseClickRight" "#Action_MouseClickRight" 49 | "BackLeftTop" "#Action_BackLeftTop" 50 | "BackLeftBottom" "#Action_BackLeftBottom" 51 | "BackRightTop" "#Action_BackRightTop" 52 | "BackRightBottom" "#Action_BackRightBottom" 53 | } 54 | } 55 | } 56 | "localization" 57 | { 58 | "english" 59 | { 60 | "Set_Ingame" "In-Game Controls" 61 | "Set_Menu" "Menu Controls" 62 | "Action_JoyLeft" "Joystick Left" 63 | "Action_JoyRight" "Joystick Right" 64 | "Action_Mouse" "Mouse" 65 | "Action_MouseClickLeft" "Mouse Click Left" 66 | "Action_MouseClickRight" "Mouse Click Right" 67 | "Action_TrigLeft" "Trigger Left" 68 | "Action_TrigRight" "Trigger Right" 69 | "Action_BumpLeft" "Bumper Left" 70 | "Action_BumpRight" "Bumper Right" 71 | "Action_JoyPressLeft" "Joystick Press Left" 72 | "Action_JoyPressRight" "Joystick Press Right" 73 | "Action_X" "Button X" 74 | "Action_Y" "Button Y" 75 | "Action_A" "Button A" 76 | "Action_B" "Button B" 77 | "Action_UP" "DPAD Up" 78 | "Action_DOWN" "DPAD Down" 79 | "Action_LEFT" "DPAD Left" 80 | "Action_RIGHT" "DPAD Right" 81 | "Action_Menu" "Button Menu" 82 | "Action_Start" "Button Start" 83 | "Action_BackLeftTop" "Back Paddle Top Left" 84 | "Action_BackLeftBottom" "Back Paddle Bottom Left" 85 | "Action_BackRightTop" "Back Paddle Top Right" 86 | "Action_BackRightBottom" "Back Paddle Bottom Right" 87 | } 88 | } 89 | } 90 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | share/python-wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | MANIFEST 28 | 29 | # PyInstaller 30 | # Usually these files are written by a python script from a template 31 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 32 | *.manifest 33 | *.spec 34 | 35 | # Installer logs 36 | pip-log.txt 37 | pip-delete-this-directory.txt 38 | 39 | # Unit test / coverage reports 40 | htmlcov/ 41 | .tox/ 42 | .nox/ 43 | .coverage 44 | .coverage.* 45 | .cache 46 | nosetests.xml 47 | coverage.xml 48 | *.cover 49 | *.py,cover 50 | .hypothesis/ 51 | .pytest_cache/ 52 | cover/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | .pybuilder/ 76 | target/ 77 | 78 | # Jupyter Notebook 79 | .ipynb_checkpoints 80 | 81 | # IPython 82 | profile_default/ 83 | ipython_config.py 84 | 85 | # pyenv 86 | # For a library or package, you might want to ignore these files since the code is 87 | # intended to run in multiple environments; otherwise, check them in: 88 | # .python-version 89 | 90 | # pipenv 91 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 92 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 93 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 94 | # install all needed dependencies. 95 | #Pipfile.lock 96 | 97 | # poetry 98 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 99 | # This is especially recommended for binary packages to ensure reproducibility, and is more 100 | # commonly ignored for libraries. 101 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 102 | #poetry.lock 103 | 104 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 105 | __pypackages__/ 106 | 107 | # Celery stuff 108 | celerybeat-schedule 109 | celerybeat.pid 110 | 111 | # SageMath parsed files 112 | *.sage.py 113 | 114 | # Environments 115 | .env 116 | .venv 117 | env/ 118 | venv/ 119 | ENV/ 120 | env.bak/ 121 | venv.bak/ 122 | 123 | # Spyder project settings 124 | .spyderproject 125 | .spyproject 126 | 127 | # Rope project settings 128 | .ropeproject 129 | 130 | # mkdocs documentation 131 | /site 132 | 133 | # mypy 134 | .mypy_cache/ 135 | .dmypy.json 136 | dmypy.json 137 | 138 | # Pyre type checker 139 | .pyre/ 140 | 141 | # pytype static type analyzer 142 | .pytype/ 143 | 144 | # Cython debug symbols 145 | cython_debug/ 146 | 147 | # PyCharm 148 | # JetBrains specific template is maintainted in a separate JetBrains.gitignore that can 149 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 150 | # and can be added to the global gitignore or merged into this file. For a more nuclear 151 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 152 | #.idea/ 153 | 154 | .testing 155 | -------------------------------------------------------------------------------- /GadgetDeck/joystick_ui.py: -------------------------------------------------------------------------------- 1 | import os 2 | import json 3 | 4 | from PyQt5.QtCore import pyqtSignal, QPoint, Qt, QRect 5 | from PyQt5.QtGui import QPainter, QPen, QBrush 6 | from PyQt5.QtWidgets import QApplication, QWidget, QVBoxLayout, QHBoxLayout, QPushButton, qApp 7 | 8 | import onscreen_keyboard 9 | 10 | 11 | def constrain(value, lo, hi): 12 | return max(lo, min(value, hi)) 13 | 14 | 15 | class JoystickUI(QWidget): 16 | _update_info_signal = pyqtSignal(object) 17 | keypress = pyqtSignal(str) 18 | keyrelease = pyqtSignal(str) 19 | keystate = pyqtSignal(object) 20 | 21 | def __init__(self): 22 | QWidget.__init__(self) 23 | self.main_layout = QVBoxLayout() 24 | self.js = AnalogWidget() 25 | self.main_layout.addWidget(self.js) 26 | self.exit_button = QPushButton('Exit') 27 | self.exit_button.clicked.connect(self.exit) 28 | self.main_layout.addWidget(self.exit_button) 29 | with open(os.path.join(os.path.dirname(__file__), 'keyboard.json')) as f: 30 | keyboard_keys = json.load(f) 31 | self.keyboard = onscreen_keyboard.Keyboard(keyboard_keys) 32 | self.keyboard.keypress.connect(self.onscreen_keypress_event) 33 | self.keyboard.keyrelease.connect(self.onscreen_keyrelease_event) 34 | self.keystate.connect(self.keyboard.set_key_state) 35 | self.main_layout.addWidget(self.keyboard) 36 | self.setLayout(self.main_layout) 37 | self.setWindowState(Qt.WindowMaximized) 38 | screen = QApplication.desktop().screenGeometry() 39 | self.setFixedSize(screen.width(), screen.height()) 40 | self.keyboard.setMaximumHeight(screen.height()//2) 41 | 42 | self.data = {} 43 | self._update_info_signal.connect(self._update_information_listener) 44 | 45 | def update_information(self, data): 46 | self.data.update(data) 47 | self._update_info_signal.emit(self.data) 48 | 49 | def _update_information_listener(self, data): 50 | if 'analog_data' in data: 51 | self.js.set_value(data['analog_data']) 52 | 53 | def onscreen_keypress_event(self, key): 54 | self.keypress.emit(key) 55 | 56 | def onscreen_keyrelease_event(self, key): 57 | self.keyrelease.emit(key) 58 | 59 | def onscreen_keystate_set(self, **kwargs): 60 | self.keystate.emit(kwargs) 61 | 62 | def exit(self): 63 | self.close() 64 | qApp.quit() 65 | 66 | @property 67 | def qApp(self): 68 | return qApp 69 | 70 | 71 | class AnalogWidget(QWidget): 72 | def __init__(self): 73 | QWidget.__init__(self) 74 | self.main_layout = QHBoxLayout() 75 | 76 | self.trigger_left = TriggerWidget() 77 | self.main_layout.addWidget(self.trigger_left) 78 | self.joystick_left = JoystickWidget() 79 | self.main_layout.addWidget(self.joystick_left) 80 | self.joystick_right = JoystickWidget() 81 | self.main_layout.addWidget(self.joystick_right) 82 | self.trigger_right = TriggerWidget() 83 | self.main_layout.addWidget(self.trigger_right) 84 | 85 | self.setLayout(self.main_layout) 86 | 87 | def set_value(self, data): 88 | self.joystick_left.set_value(data['JoyLeft'].x, data['JoyLeft'].y) 89 | self.joystick_right.set_value(data['JoyRight'].x, data['JoyRight'].y) 90 | self.trigger_left.set_value(data['TrigLeft'].x) 91 | self.trigger_right.set_value(data['TrigRight'].x) 92 | 93 | 94 | class JoystickWidget(QWidget): 95 | def __init__(self, *args, **kwargs): 96 | QWidget.__init__(self, *args, **kwargs) 97 | self.setMinimumSize(100, 100) 98 | self.js_position = [0,0] 99 | 100 | def set_value(self, x, y): 101 | self.js_position[0] = constrain(x, -1, 1) 102 | self.js_position[1] = constrain(y, -1, 1) * -1 103 | self.update() 104 | 105 | def paintEvent(self, a0) -> None: 106 | painter = QPainter(self) 107 | painter.setRenderHint(QPainter.Antialiasing) 108 | painter.setRenderHint(QPainter.HighQualityAntialiasing) 109 | center = QPoint(int(self.width() / 2), int(self.height() / 2)) 110 | radius = int((min(self.width(), self.height()) - 1) / 2) 111 | 112 | painter.setPen(QPen(Qt.black)) 113 | painter.setBrush(QBrush(Qt.lightGray)) 114 | painter.drawEllipse(center, radius, radius) 115 | 116 | painter.setPen(QPen(Qt.black)) 117 | painter.setBrush(QBrush(Qt.black)) 118 | dot_radius = radius / 1.5 119 | dot_x = int(self.js_position[0] * (radius - dot_radius)) + center.x() 120 | dot_y = int(self.js_position[1] * (radius - dot_radius)) + center.y() 121 | painter.drawEllipse(QPoint(dot_x, dot_y), dot_radius, dot_radius) 122 | 123 | 124 | class TriggerWidget(QWidget): 125 | def __init__(self): 126 | QWidget.__init__(self) 127 | self.value = 0.0 128 | self.setMinimumSize(25, 50) 129 | 130 | def set_value(self, value): 131 | self.value = value 132 | self.update() 133 | 134 | def paintEvent(self, a0) -> None: 135 | painter = QPainter(self) 136 | padding = 5 137 | 138 | painter.setPen(QPen(Qt.black)) 139 | painter.setBrush(QBrush(Qt.white)) 140 | painter.drawRect(self.rect()) 141 | 142 | painter.setBrush(QBrush(Qt.black)) 143 | bottom_right = QPoint(self.width() - padding, self.height() - padding) 144 | top_left = bottom_right - QPoint(int(self.width() - 2*padding), int((self.height() - 2*padding) * self.value)) 145 | painter.drawRect(QRect(top_left, bottom_right)) 146 | 147 | 148 | if __name__ == '__main__': 149 | app = QApplication([]) 150 | ui = JoystickUI() 151 | ui.show() 152 | app.exec() 153 | -------------------------------------------------------------------------------- /gadget-deck-manager.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | import argparse 3 | import glob 4 | import subprocess 5 | import os 6 | from typing import Union 7 | 8 | import hid_parser 9 | import usb_gadget 10 | 11 | gadget = usb_gadget.USBGadget('gadget-deck') 12 | 13 | 14 | def gadget_setup(): 15 | gadget.idVendor = '0x1d6b' 16 | gadget.idProduct = '0x0104' 17 | gadget.bcdDevice = '0x0100' 18 | gadget.bcdUSB = '0x0200' 19 | # gadget.bDeviceClass = '0x02' 20 | # gadget.bDeviceSubClass = '0x00' 21 | # gadget.bDeviceProtocol = '0x00' 22 | 23 | strings = gadget['strings']['0x409'] 24 | strings.serialnumber = '0123456789' 25 | strings.manufacturer = 'Valve' 26 | strings.product = 'Steam Deck' 27 | 28 | config = gadget['configs']['c.1'] 29 | config.bmAttributes = '0x80' 30 | config.MaxPower = '250' 31 | config['strings']['0x409'].configuration = 'Steam Deck Configuration' 32 | return config 33 | 34 | 35 | def gadget_activate(): 36 | gadget.activate() 37 | 38 | 39 | def gadget_destroy(): 40 | for config in os.scandir(gadget['configs'].path): 41 | config = usb_gadget.ConfigFS(config.path) 42 | for function in os.scandir(config.path): 43 | if function.is_symlink(): 44 | os.remove(function.path) 45 | for language in os.scandir(config['strings'].path): 46 | os.rmdir(language.path) 47 | os.rmdir(config.path) 48 | for function in os.scandir(gadget['functions'].path): 49 | os.rmdir(function.path) 50 | for language in os.scandir(gadget['strings'].path): 51 | os.rmdir(language.path) 52 | os.rmdir(gadget.path) 53 | 54 | 55 | def create_function_hid(name: str, report: Union[str, list[int]], protocol=0, subclass=0): 56 | if isinstance(report, str): 57 | with open(report, 'rt') as f: 58 | descriptor = hid_parser.ReportDescriptor.from_str(f.read()) 59 | else: 60 | descriptor = hid_parser.ReportDescriptor(report) 61 | hid = usb_gadget.HIDFunction(gadget, name) 62 | hid.protocol = str(protocol) 63 | hid.subclass = str(subclass) 64 | hid.report_length = str(descriptor.get_input_report_size().byte) 65 | hid.report_desc = bytes(descriptor.data) 66 | gadget.link(hid, gadget['configs']['c.1']) 67 | return hid 68 | 69 | def remove_function(name): 70 | os.unlink(gadget['configs']['c.1'][name].path) 71 | os.rmdir(gadget['functions'][name].path) 72 | 73 | def function_enable(function: str, activate=True): 74 | gadget.deactivate() 75 | if function in ('joystick', 'mouse', 'keyboard'): 76 | function = create_function_hid(function, f'HID Descriptors/{function}.txt') 77 | if activate: 78 | gadget.activate() 79 | chmod_hidg() 80 | if function == 'mtp': 81 | function = usb_gadget.USBFunction(gadget, 'ffs.mtp') 82 | gadget.link(function, gadget['configs']['c.1']) 83 | os.mkdir('/dev/ffs-mtp') 84 | subprocess.call(['mount', '-t', 'functionfs', 'mtp', '/dev/ffs-mtp']) 85 | if activate: 86 | gadget.activate() 87 | if function == 'shell': 88 | function = usb_gadget.USBFunction(gadget, 'acm.shell') 89 | gadget.link(function, gadget['configs']['c.1']) 90 | if activate: 91 | gadget.activate() 92 | subprocess.call(['systemctl', 'start', f'getty@ttyGS{function.port_num}.service']) 93 | 94 | 95 | def function_disable(function: str, activate=True): 96 | gadget.deactivate() 97 | if function in ('joystick', 'mouse', 'keyboard'): 98 | remove_function(f'hid.{function}') 99 | if function == 'mtp': 100 | subprocess.call(['umount', '/dev/ffs-mtp']) 101 | os.rmdir('/dev/ffs-mtp') 102 | remove_function('ffs.mtp') 103 | if function == 'shell': 104 | function = usb_gadget.USBFunction(gadget, 'acm.shell') 105 | subprocess.call(['systemctl', 'start', f'getty@ttyGS{function.port_num}.service']) 106 | remove_function('acm.shell') 107 | linked_functions = [f for f in os.scandir(gadget['configs']['c.1'].path) if f.is_symlink()] 108 | if activate and linked_functions: 109 | gadget.activate() 110 | chmod_hidg() 111 | 112 | def chmod_hidg(): 113 | for dev in glob.glob('/dev/hidg*'): 114 | subprocess.call(['chmod', '0666', dev]) 115 | 116 | 117 | if __name__ == '__main__': 118 | parser = argparse.ArgumentParser('steam-gadget') 119 | action_parser = parser.add_subparsers(title='action', required=True) 120 | 121 | action_setup = action_parser.add_parser('setup') 122 | action_setup.set_defaults(action=gadget_setup) 123 | 124 | action_destroy = action_parser.add_parser('destroy') 125 | action_destroy.set_defaults(action=gadget_destroy) 126 | 127 | action_activate = action_parser.add_parser('activate') 128 | action_activate.set_defaults(action=gadget_activate) 129 | 130 | action_enable = action_parser.add_parser('enable') 131 | action_enable.add_argument('function') 132 | action_enable.add_argument('--no-activate', action='store_false', dest='activate') 133 | action_enable.set_defaults(action=function_enable) 134 | 135 | action_disable = action_parser.add_parser('disable') 136 | action_disable.add_argument('function') 137 | action_disable.add_argument('--no-activate', action='store_false', dest='activate') 138 | action_disable.set_defaults(action=function_disable) 139 | 140 | args = vars(parser.parse_args()) 141 | action = args.pop('action') 142 | action(**args) 143 | 144 | # steam_gadget = usb_gadget.USBGadget('steam_gadget') 145 | # config = gadget_setup(steam_gadget) 146 | # joystick = function_hid(steam_gadget, 'joystick0', 'HID Descriptors/joystick.txt') 147 | # keyboard = function_hid(steam_gadget, 'keyboard0', 'HID Descriptors/keyboard.txt') 148 | # mouse = function_hid(steam_gadget, 'mouse0', 'HID Descriptors/mouse.txt') 149 | # steam_gadget.link(joystick, config) 150 | # steam_gadget.link(keyboard, config) 151 | # steam_gadget.link(mouse, config) 152 | # steam_gadget.activate() 153 | -------------------------------------------------------------------------------- /GadgetDeck/onscreen_keyboard.py: -------------------------------------------------------------------------------- 1 | from PyQt5.QtCore import Qt, pyqtSignal, QRect 2 | from PyQt5.QtGui import QPainter, QBrush, QPen, QFont 3 | from PyQt5.QtWidgets import QWidget, QApplication, QHBoxLayout, QVBoxLayout, QSpacerItem 4 | 5 | 6 | class Keyboard(QWidget): 7 | keypress = pyqtSignal(str) 8 | keyrelease = pyqtSignal(str) 9 | 10 | def __init__(self, keys): 11 | QWidget.__init__(self) 12 | self.setLayout(QVBoxLayout()) 13 | self.rows = [] 14 | for i,row in enumerate(keys): 15 | widget = KeyboardRow(row) 16 | widget.keypress.connect(self.onscreen_keypress_event) 17 | widget.keyrelease.connect(self.onscreen_keyrelease_event) 18 | self.rows.append(widget) 19 | self.layout().addWidget(widget) 20 | self.layout().setStretch(i, 1) 21 | self.layout().setContentsMargins(0,0,0,0) 22 | self.layout().setSpacing(0) 23 | 24 | def onscreen_keypress_event(self, key): 25 | self.keypress.emit(key) 26 | 27 | def onscreen_keyrelease_event(self, key): 28 | self.keyrelease.emit(key) 29 | 30 | def set_key_state(self, kwargs): 31 | for widget in self.rows: 32 | widget.set_key_state(**kwargs) 33 | 34 | 35 | class KeyboardRow(QWidget): 36 | keypress = pyqtSignal(str) 37 | keyrelease = pyqtSignal(str) 38 | 39 | def __init__(self, keys): 40 | QWidget.__init__(self) 41 | self.setLayout(QHBoxLayout()) 42 | self.keys = [] 43 | for i,key in enumerate(keys): 44 | if isinstance(key, str): 45 | key = {'name': key} 46 | if 'width' not in key: 47 | key['width'] = 1.0 48 | if key.get('type', None) == 'spacer': 49 | btn = QWidget() 50 | else: 51 | btn = KeyboardKey(**key) 52 | btn.keypress.connect(self.onscreen_keypress_event) 53 | btn.keyrelease.connect(self.onscreen_keyrelease_event) 54 | self.keys.append(btn) 55 | self.layout().addWidget(btn) 56 | self.layout().setStretch(i, int(key['width']*10)) 57 | 58 | self.layout().setContentsMargins(0, 0, 0, 0) 59 | self.layout().setSpacing(0) 60 | 61 | def onscreen_keypress_event(self, key): 62 | self.keypress.emit(key) 63 | 64 | def onscreen_keyrelease_event(self, key): 65 | self.keyrelease.emit(key) 66 | 67 | def set_key_state(self, **kwargs): 68 | for widget in self.keys: 69 | widget.set_key_state(**kwargs) 70 | 71 | 72 | class KeyboardKey(QWidget): 73 | keypress = pyqtSignal(str) 74 | keyrelease = pyqtSignal(str) 75 | 76 | key_type = '' 77 | _subclasses = {} 78 | def __new__(cls, name, *args, **kwargs): 79 | if cls is KeyboardKey: 80 | keytype = kwargs.get('type', name) 81 | if keytype in KeyboardKey._subclasses: 82 | cls = KeyboardKey._subclasses[keytype] 83 | return super().__new__(cls) 84 | 85 | def __init_subclass__(cls, key=None): 86 | if key is not None: 87 | KeyboardKey._subclasses[key] = cls 88 | cls.key_type = key 89 | 90 | def __init__(self, name: str, **kwargs): 91 | QWidget.__init__(self) 92 | self.key = name 93 | self.kwargs = kwargs 94 | self.font = QFont('Arial', 15) 95 | self.key_states = {'capslock': False, 'shift': False, 'numlock': False, 'scrolllock': False} 96 | self.pressed = False 97 | 98 | @property 99 | def label(self): 100 | if self.key_states['shift'] and self.kwargs.get('shift') is not None: 101 | return self.kwargs['shift'] 102 | if self.kwargs.get('label') is not None: 103 | return self.kwargs['label'] 104 | label = self.key 105 | # Capslock and Shift work like XOR - if one of them is active, capitalize the letter 106 | capitalized = self.key_states['shift'] != self.key_states['capslock'] 107 | return label.upper() if capitalized else label.lower() 108 | 109 | def mousePressEvent(self, a0) -> None: 110 | self.keypress.emit(self.key) 111 | self.pressed = True 112 | self.update() 113 | 114 | def mouseReleaseEvent(self, a0) -> None: 115 | self.keyrelease.emit(self.key) 116 | self.pressed = False 117 | self.update() 118 | 119 | def paintEvent(self, a0) -> None: 120 | painter = QPainter(self) 121 | if self.pressed: 122 | painter.setBrush(QBrush(Qt.gray)) 123 | else: 124 | painter.setBrush(QBrush(Qt.black)) 125 | rect = QRect(3, 3, self.width()-6, self.height()-6) 126 | painter.drawRect(rect) 127 | painter.setPen(QPen(Qt.white)) 128 | painter.setFont(self.font) 129 | painter.drawText(rect, Qt.AlignCenter, self.label) 130 | 131 | def resizeEvent(self, a0) -> None: 132 | self.font = QFont('Arial', self.height() // 2) 133 | 134 | def set_key_state(self, **kwargs): 135 | self.key_states.update(kwargs) 136 | self.update() 137 | 138 | 139 | class CapslockKey(KeyboardKey, key='CAPSLOCK'): 140 | def mousePressEvent(self, a0) -> None: 141 | self.keypress.emit(self.key) 142 | 143 | def mouseReleaseEvent(self, a0) -> None: 144 | self.keyrelease.emit(self.key) 145 | 146 | def set_key_state(self, capslock=None, **kwargs): 147 | if capslock is not None: 148 | self.pressed = capslock 149 | self.update() 150 | 151 | 152 | class LatchingKey(KeyboardKey, key='LATCHING'): 153 | def mousePressEvent(self, a0) -> None: 154 | if self.pressed: 155 | self.keyrelease.emit(self.key) 156 | else: 157 | self.keypress.emit(self.key) 158 | 159 | def mouseReleaseEvent(self, a0) -> None: 160 | pass 161 | 162 | def set_key_state(self, **kwargs): 163 | if self.key_type.lower() in kwargs: 164 | self.pressed = kwargs[self.key_type.lower()] 165 | self.update() 166 | 167 | 168 | class ShiftKey(LatchingKey, key='SHIFT'): 169 | ... 170 | 171 | 172 | class ControlKey(LatchingKey, key='CONTROL'): 173 | ... 174 | 175 | 176 | class AltKey(LatchingKey, key='ALT'): 177 | ... 178 | 179 | 180 | class GuiKey(LatchingKey, key='GUI'): 181 | ... 182 | 183 | 184 | class FunctionKey(KeyboardKey, key='FUNCTION'): 185 | @property 186 | def label(self): 187 | return self.key.upper() 188 | 189 | if __name__ == '__main__': 190 | import json 191 | app = QApplication([]) 192 | with open('keyboard.json') as f: 193 | keys = json.load(f) 194 | key = Keyboard(keys) 195 | key.keypress.connect(print) 196 | key.show() 197 | app.exec() 198 | -------------------------------------------------------------------------------- /GadgetDeck/__main__.py: -------------------------------------------------------------------------------- 1 | import select 2 | import threading 3 | import subprocess 4 | 5 | from PyQt5.QtWidgets import QApplication 6 | from steamworks import STEAMWORKS 7 | import usb_gadget 8 | 9 | try: 10 | import joystick_ui 11 | except ImportError: 12 | import os, sys 13 | sys.path.append(os.path.dirname(__file__)) 14 | import joystick_ui 15 | 16 | 17 | class JoystickEmulator: 18 | ACTION_SETS = ('InGameControls',) 19 | ANALOG_ACTIONS = ('JoyLeft', 'JoyRight', 'TrigLeft', 'TrigRight', 'Mouse') 20 | DIGITAL_ACTIONS = ('A', 'B', 'X', 'Y', 'UP', 'DOWN', 'LEFT', 'RIGHT', 'BumpLeft', 'BumpRight', 'Menu', 'Start', 'JoyPressLeft', 'JoyPressRight', 21 | 'BackLeftTop', 'BackLeftBottom', 'BackRightTop', 'BackRightBottom') 22 | DIGITAL_MOUSE_ACTIONS = ('MouseClickLeft', 'MouseClickRight') 23 | KEYBOARD_MODIFIERS = {'shift': ('SHIFT_LEFT', 'SHIFT_RIGHT'), 24 | 'control': ('CONTROL_LEFT', 'CONTROL_RIGHT'), 25 | 'alt': ('ALT_LEFT', 'ALT_RIGHT'), 26 | 'gui': ('GUI_LEFT', 'GUI_RIGHT')} 27 | 28 | def __init__(self): 29 | self.window = joystick_ui.JoystickUI() 30 | 31 | gadget = usb_gadget.USBGadget('gadget-deck') 32 | self.js_gadget = self.mouse_gadget = self.keyboard_gadget = None 33 | if gadget['functions'].exists('hid.joystick'): 34 | print('Joystick gadget found') 35 | hid_joystick = usb_gadget.HIDFunction(gadget, 'joystick') 36 | self.js_gadget = usb_gadget.JoystickGadget(hid_joystick.device, 2, 2, 24) 37 | if gadget['functions'].exists('hid.mouse'): 38 | print('Mouse gadget found') 39 | hid_mouse = usb_gadget.HIDFunction(gadget, 'mouse') 40 | self.mouse_gadget = usb_gadget.MouseGadget(hid_mouse.device, 2, 8, 2) 41 | if gadget['functions'].exists('hid.keyboard'): 42 | print('Keyboard gadget found') 43 | hid_keyboard = usb_gadget.HIDFunction(gadget, 'keyboard') 44 | self.keyboard_gadget = usb_gadget.KeyboardGadget(hid_keyboard.device, 6) 45 | self.keyboard_gadget.set_output_report_callback(self.keyboard_state_callback) 46 | 47 | self.window.keypress.connect(self.onscreen_keypress_event) 48 | self.window.keyrelease.connect(self.onscreen_keyrelease_event) 49 | self.steam = STEAMWORKS() 50 | self.steam.initialize() 51 | self.steam.Input.Init() 52 | self.controllers = self.steam.Input.GetConnectedControllers() 53 | self.action_set = self.steam.Input.GetActionSetHandle(self.ACTION_SETS[0]) 54 | self.analog_actions = {name: self.steam.Input.GetAnalogActionHandle(name) for name in self.ANALOG_ACTIONS} 55 | self.digital_actions = {name: self.steam.Input.GetDigitalActionHandle(name) for name in self.DIGITAL_ACTIONS} 56 | self.digital_actions.update({name: self.steam.Input.GetDigitalActionHandle(name) for name in self.DIGITAL_MOUSE_ACTIONS}) 57 | 58 | self.js_thread = threading.Thread(target=self.steam_worker, daemon=True) 59 | self.js_thread.start() 60 | 61 | def steam_worker(self): 62 | while True: 63 | self.steam.Input.RunFrame() 64 | if self.controllers: 65 | controller = self.controllers[0] 66 | analog_data = {action: self.steam.Input.GetAnalogActionData(controller, handle) for action, handle in self.analog_actions.items()} 67 | digital_data = {action: self.steam.Input.GetDigitalActionData(controller, handle).bState for action, handle in self.digital_actions.items()} 68 | data = {'analog_data': analog_data, 'digital_action': digital_data} 69 | self.window.update_information(data) 70 | 71 | if self.js_gadget is not None: 72 | self.js_gadget.set_joystick(0, analog_data['JoyLeft'].x, -1 * analog_data['JoyLeft'].y) 73 | self.js_gadget.set_joystick(1, analog_data['JoyRight'].x, -1 * analog_data['JoyRight'].y) 74 | self.js_gadget.set_trigger(0, analog_data['TrigLeft'].x) 75 | self.js_gadget.set_trigger(1, analog_data['TrigRight'].x) 76 | for i, btn in enumerate(self.DIGITAL_ACTIONS): 77 | self.js_gadget.set_button(i, digital_data[btn]) 78 | self.js_gadget.update() 79 | if self.mouse_gadget is not None: 80 | self.mouse_gadget.move(analog_data['Mouse'].x, analog_data['Mouse'].y) 81 | self.mouse_gadget.set_button(0, digital_data['MouseClickLeft']) 82 | self.mouse_gadget.set_button(1, digital_data['MouseClickRight']) 83 | self.mouse_gadget.update() 84 | else: 85 | self.controllers = self.steam.Input.GetConnectedControllers() 86 | for controller in self.controllers: 87 | self.steam.Input.ActivateActionSet(controller, self.action_set) 88 | self.window.update_information({'controller': self.controllers}) 89 | 90 | def keyboard_state_callback(self, data): 91 | report = int.from_bytes(data, 'little') 92 | states = {name: bool(report >> i) for i,name in enumerate(['numlock', 'capslock', 'scrolllock'])} 93 | self.window.onscreen_keystate_set(**states) 94 | 95 | def onscreen_keypress_event(self, key): 96 | if self.keyboard_gadget is not None: 97 | self.keyboard_gadget.press(key) 98 | self.keyboard_gadget.update() 99 | for modifier, modkeys in self.KEYBOARD_MODIFIERS.items(): 100 | if key in modkeys: 101 | self.window.onscreen_keystate_set(**{modifier: True}) 102 | 103 | def onscreen_keyrelease_event(self, key): 104 | if self.keyboard_gadget is not None: 105 | for modifier, modkeys in self.KEYBOARD_MODIFIERS.items(): 106 | # Modifier keys when pressed, stay pressed until another key is pressed. 107 | # So, if a modifier was pressed before, unpress it 108 | if any(self.keyboard_gadget.is_pressed(modkey) for modkey in modkeys): 109 | self.window.onscreen_keystate_set(**{modifier: False}) 110 | for modkey in modkeys: 111 | self.keyboard_gadget.release(modkey) 112 | self.keyboard_gadget.release(key) 113 | self.keyboard_gadget.update() 114 | 115 | 116 | if __name__ == '__main__': 117 | for gadget in ('joystick', 'mouse', 'keyboard'): 118 | if subprocess.call(['systemctl', 'is-active', '--quiet', f'gadget-deck@{gadget}.service']) != 0: 119 | print(f'Gadget {gadget} not active, starting...') 120 | subprocess.call(['systemctl', 'start', f'gadget-deck@{gadget}.service']) 121 | app = QApplication([]) 122 | emulator = JoystickEmulator() 123 | emulator.window.show() 124 | app.exec() 125 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------