Add support for multiple joysticks

Author: bruj0

README.md

@@ -9,14 +9,15 @@ This utility can be considered a breach of TOS for some games, please make sure
 ## Features
 
 - Maps joystick buttons and hat directions to keyboard sequences
+- Supports multiple joysticks and controllers simultaneously
 - Supports modifier buttons (combinations)
 - Configurable delays between key presses
 - Supports special wait commands in sequences
 - Can execute pre-run and post-run functions
 - Includes a helper to identify joystick buttons and keyboard keys
 - Configuration via INI file or Python dictionary
 - Runs in the system tray with options to reload configuration and exit
-- 
+
 ### Power Configuration Presets (PIPS)
 
 The default configuration is set up for Elite Dangerous
@@ -76,7 +77,7 @@ You can see how it was created in the [Action tab](https://github.com/bruj0/ed-j
 
 - Python 3.6+
 - Windows operating system
-- A joystick or controller
+- One or more joysticks or controllers
 - Elite Dangerous game (optional, but that's what it's designed for)
 
 ### Setup
@@ -116,13 +117,13 @@ This will create a `config.ini` file with the default PIPS (Power Distribution)
 
 ### Identifying Joystick Buttons
 
-To see which buttons on your controller correspond to which button IDs:
+To see which buttons on your controller correspond to which button IDs (including support for multiple joysticks):
 
 ```bash
 python main.py --joystick-events
 ```
 
-Press buttons on your joystick or move the hat to see the output. Use these names in your configuration.
+Press buttons on your joystick(s) or move the hat to see the output. The output will indicate both the button/hat and the joystick index (e.g., `BUTTON_0_JOY0`, `HAT_0_JOY1_up`). Use these names in your configuration to assign actions to specific devices.
 
 ### Identifying Keyboard Keys
 
@@ -136,22 +137,24 @@ Press keys on your keyboard to see their names. Use these names in your configur
 
 ## Configuration
 
-You can configure the application using an INI file. Here's an example of the default configuration for Elite Dangerous power management:
+You can configure the application using an INI file. Here's an example of the default configuration for Elite Dangerous power management (for the first joystick):
 
 ```ini
-[HAT_0_up]
+[HAT_0_JOY0_up]
 sequence = [{"key": "v", "presses": 1}, {"key": "x", "presses": 2}]
 
-[HAT_0_down]
+[HAT_0_JOY0_down]
 sequence = [{"key": "v", "presses": 1}, {"key": "c", "presses": 2}]
 
-[HAT_0_left]
+[HAT_0_JOY0_left]
 sequence = [{"key": "v", "presses": 1}, {"key": "z", "presses": 1}, {"key": "x", "presses": 1}]
 
-[HAT_0_right]
+[HAT_0_JOY0_right]
 sequence = [{"key": "v", "presses": 1}, {"key": "c", "presses": 1}, {"key": "x", "presses": 1}]
 ```
 
+To configure actions for additional joysticks, use the appropriate joystick index in the section name (e.g., `[BUTTON_5_JOY1]`).
+
 ### Power Configuration Presets (PIPS)
 
 The default configuration is set up for Elite Dangerous power distribution using the hat switch:

config.ini

@@ -1,13 +1,13 @@
-[HAT_0_up]
+[HAT_0_JOY0_up]
 sequence = [{'key': 'v', 'presses': 1}, {'key': 'x', 'presses': 2}]
 
-[HAT_0_down]
+[HAT_0_JOY0_down]
 sequence = [{'key': 'v', 'presses': 1}, {'key': 'c', 'presses': 2}]
 
-[HAT_0_left]
+[HAT_0_JOY0_left]
 sequence = [{'key': 'v', 'presses': 1}, {'key': 'z', 'presses': 1}, {'key': 'x', 'presses': 1}]
 
-[HAT_0_right]
+[HAT_0_JOY0_right]
 sequence = [{'key': 'v', 'presses': 1}, {'key': 'c', 'presses': 1}, {'key': 'x', 'presses': 1}]
 
 [BUTTON_27]

ed_joystick_helper.py

@@ -24,16 +24,18 @@ def __init__(self, config):
         self.pressed_buttons = set()
         self.current_hat_positions = {}  # Track current hat positions
         self.config_file_path = None  # Store config file path for reloading
-        
+
         # Set up logging
         self.logger = logging.getLogger("ED_Joystick_Helper")
         if not self.logger.handlers:
             # Only configure if not already configured
             handler = logging.FileHandler("ed_joystick_helper.log")
-            formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
+            formatter = logging.Formatter(
+                "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
+            )
             handler.setFormatter(formatter)
             self.logger.addHandler(handler)
-            self.logger.setLevel(logging.INFO)
+            self.logger.setLevel(logging.DEBUG)
 
         # Initialize pygame for joystick support
         pygame.init()
@@ -73,7 +75,7 @@ def _execute_sequence(self, button_name, button_config):
         for item in sequence:
             key = item["key"]
             presses = item["presses"]
-            
+
             if key == "WAIT":
                 # Special case for wait command
                 time.sleep(presses)
@@ -105,11 +107,15 @@ def _map_key(self, key_name):
         # Otherwise, assume it's a character
         return key_name
 
-    def _process_button_press(self, button_name):
-        """Process a button press, checking modifiers and executing sequences"""
-        self.logger.info(f"Button pressed: {button_name}")
-        if button_name in self.config:
-            button_config = self.config[button_name]
+    def _process_button_press(self, button_name, joy_id=None):
+        """Process a button press, checking modifiers and executing sequences. Supports multiple joysticks with same button name."""
+        # If joy_id is provided, use extended button name
+        config_key = button_name
+        if joy_id is not None:
+            config_key = f"{button_name}_JOY{joy_id}"
+        self.logger.debug(f"Button pressed: {config_key}")
+        if config_key in self.config:
+            button_config = self.config[config_key]
 
             # Check if this button requires a modifier
             if "modifier" in button_config:
@@ -119,11 +125,11 @@ def _process_button_press(self, button_name):
 
             # Execute the sequence in a separate thread to not block the event loop
             threading.Thread(
-                target=self._execute_sequence, args=(button_name, button_config)
+                target=self._execute_sequence, args=(config_key, button_config)
             ).start()
 
-    def _process_hat_event(self, hat_id, x_value, y_value):
-        """Process a HAT event, converting it to a direction and triggering actions"""
+    def _process_hat_event(self, hat_id, x_value, y_value, joy_id=None):
+        """Process a HAT event, converting it to a direction and triggering actions. Supports multiple joysticks."""
         # Map hat position to direction
         direction = "centered"
         if x_value == 0 and y_value == 1:
@@ -144,9 +150,11 @@ def _process_hat_event(self, hat_id, x_value, y_value):
             direction = "up-left"
 
         hat_name = f"HAT_{hat_id}"
+        if joy_id is not None:
+            hat_name = f"{hat_name}_JOY{joy_id}"
 
         # Only process if the direction has changed
-        if self.current_hat_positions[hat_name] != direction:
+        if self.current_hat_positions.get(hat_name, None) != direction:
             self.current_hat_positions[hat_name] = direction
 
             # Create a hat event identifier that includes the direction
@@ -168,6 +176,7 @@ def reload_config(self):
         try:
             # Import here to avoid circular imports
             from main import load_config_from_ini
+
             new_config = load_config_from_ini(self.config_file_path)
             self.config = new_config
             self.logger.info(f"Configuration reloaded from {self.config_file_path}")
@@ -188,16 +197,20 @@ def start(self):
                     # self.logger.debug(f"Event: {event}")
                     if event.type == pygame.JOYBUTTONDOWN:
                         button_name = f"BUTTON_{event.button}"
-                        self.pressed_buttons.add(button_name)
-                        self._process_button_press(button_name)
+                        joy_id = event.joy if hasattr(event, 'joy') else 0
+                        self.pressed_buttons.add(f"{button_name}_JOY{joy_id}")
+                        self._process_button_press(button_name, joy_id)
                     elif event.type == pygame.JOYBUTTONUP:
                         button_name = f"BUTTON_{event.button}"
-                        if button_name in self.pressed_buttons:
-                            self.pressed_buttons.remove(button_name)
+                        joy_id = event.joy if hasattr(event, 'joy') else 0
+                        pressed_name = f"{button_name}_JOY{joy_id}"
+                        if pressed_name in self.pressed_buttons:
+                            self.pressed_buttons.remove(pressed_name)
                     elif event.type == pygame.JOYHATMOTION:
                         hat_id = event.hat
                         x_value, y_value = event.value
-                        self._process_hat_event(hat_id, x_value, y_value)
+                        joy_id = event.joy if hasattr(event, 'joy') else 0
+                        self._process_hat_event(hat_id, x_value, y_value, joy_id)
                     elif event.type == pygame.KEYDOWN:
                         key_name = pygame.key.name(event.key)
                         key_id = (
@@ -233,14 +246,16 @@ def print_joystick_events():
         logging.basicConfig(
             filename="ed_joystick_helper.log",
             level=logging.INFO,
-            format='%(asctime)s - %(name)s - %(levelname)s - %(message)s'
+            format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
         )
-    
+
     pygame.init()
     pygame.joystick.init()
 
     # Enable joystick events
-    pygame.event.set_allowed([pygame.JOYBUTTONDOWN, pygame.JOYBUTTONUP, pygame.JOYHATMOTION])
+    pygame.event.set_allowed(
+        [pygame.JOYBUTTONDOWN, pygame.JOYBUTTONUP, pygame.JOYHATMOTION]
+    )
 
     # Get the number of joysticks
     joystick_count = pygame.joystick.get_count()
@@ -268,10 +283,12 @@ def print_joystick_events():
                 # logger.debug(f"Event: {event}")  # Uncomment to see all events for debugging
                 if event.type == pygame.JOYBUTTONDOWN:
                     button_name = f"BUTTON_{event.button}"
-                    logger.info(f"Button pressed: {button_name}")
+                    joy_id = event.joy if hasattr(event, 'joy') else 0
+                    logger.info(f"Button pressed: {button_name}_JOY{joy_id}")
                 elif event.type == pygame.JOYHATMOTION:
                     hat_id = event.hat
                     x_value, y_value = event.value
+                    joy_id = event.joy if hasattr(event, 'joy') else 0
                     direction = "centered"
 
                     # Map hat position to direction
@@ -292,7 +309,7 @@ def print_joystick_events():
                     elif x_value == -1 and y_value == 1:
                         direction = "up-left"
 
-                    hat_name = f"HAT_{hat_id}"
+                    hat_name = f"HAT_{hat_id}_JOY{joy_id}"
                     logger.info(
                         f"Hat moved: {hat_name}, "
                         f"Position: {direction} ({x_value}, {y_value})"
@@ -313,9 +330,9 @@ def print_keyboard_events():
         logging.basicConfig(
             filename="ed_joystick_helper.log",
             level=logging.INFO,
-            format='%(asctime)s - %(name)s - %(levelname)s - %(message)s'
+            format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
         )
-    
+
     pygame.init()
     pygame.joystick.init()
 
@@ -340,7 +357,9 @@ def print_keyboard_events():
                     if key_name == " ":
                         logger.info("Key pressed: 'SPACE' - Config as: KEY_SPACE")
                     elif len(key_name) == 1:
-                        logger.info(f"Key pressed: '{key_name}' - Config as: {key_name}")
+                        logger.info(
+                            f"Key pressed: '{key_name}' - Config as: {key_name}"
+                        )
                     else:
                         key_upper = key_name.upper()
                         logger.info(

ed_joystick_tray.py

@@ -17,7 +17,7 @@ def setup_logging():
     log_file = "ed_joystick_helper.log"
     logging.basicConfig(
         filename=log_file,
-        level=logging.INFO,
+        level=logging.DEBUG,
         format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
         datefmt="%Y-%m-%d %H:%M:%S",
     )

main.py

@@ -21,29 +21,29 @@
 def setup_normal_logging():
     """Set up logging to file"""
     logging.basicConfig(
-        level=logging.INFO,
+        level=logging.DEBUG,
         format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
         datefmt="%Y-%m-%d %H:%M:%S",
     )
-    logger = logging.getLogger("ED_Joystick_Helper")
+    logger = logging.getLogger("main")
     return logger
 
 
 def print_starting(caller):
     """Example pre-run function"""
-    logger = logging.getLogger("ED_Joystick_Helper")
+    logger = logging.getLogger("main")
     logger.info(f"Sequence for {caller} started")
 
 
 def print_end(caller):
     """Example after-run function"""
-    logger = logging.getLogger("ED_Joystick_Helper")
+    logger = logging.getLogger("main")
     logger.info(f"Sequence for {caller} ended")
 
 
 def load_config_from_ini(file_path):
     """Load configuration from an INI file"""
-    logger = logging.getLogger("ED_Joystick_Helper")
+    logger = logging.getLogger("main")
     config = configparser.ConfigParser()
     if not os.path.exists(file_path):
         logger.error(f"Configuration file {file_path} not found.")
@@ -88,7 +88,7 @@ def load_config_from_ini(file_path):
 
 def create_default_config_file(file_path, config_dict):
     """Create a default INI configuration file"""
-    logger = logging.getLogger("ED_Joystick_Helper")
+    logger = logging.getLogger("main")
     config = configparser.ConfigParser()
 
     for button, settings in config_dict.items():
@@ -116,21 +116,21 @@ def create_default_config_file(file_path, config_dict):
 
 
 default_config = {
-    "HAT_0_up": {
+    "HAT_0_JOY0_up": {
         # Combat 1SYS/1ENG/4WEP
         "sequence": [
             {"key": "v", "presses": 1},  # Reset PIPS
             {"key": "x", "presses": 2},  # 4WEP
         ]
     },
-    "HAT_0_down": {
+    "HAT_0_JOY0_down": {
         # Shields 4SYS/2ENG
         "sequence": [
             {"key": "v", "presses": 1}, 
             {"key": "c", "presses": 2}  # 4SYS
         ]
     },
-    "HAT_0_left": {
+    "HAT_0_JOY0_left": {
         # Persuit 2ENG/4WEP
         "sequence": [
             {"key": "v", "presses": 1}, 
@@ -139,7 +139,7 @@ def create_default_config_file(file_path, config_dict):
         ]
     },
     # Offense 3SYS/1ENG/3WEP
-    "HAT_0_right": {
+    "HAT_0_JOY0_right": {
         "sequence": [
             {"key": "v", "presses": 1},
             {"key": "c", "presses": 1},  # 3SYS