Add support and docs for RS3 Lightguns

Author: SeongGino

CMakeLists.txt

@@ -1,6 +1,6 @@
 cmake_minimum_required(VERSION 3.14)
 
-project(QMamehook VERSION 2.1 LANGUAGES CXX)
+project(QMamehook VERSION 2.2 LANGUAGES CXX)
 
 set(CMAKE_AUTOUIC ON)
 set(CMAKE_AUTOMOC ON)

README.md

@@ -9,8 +9,9 @@ A bare-bones implementation of a MAME network output client, made primarily for
  - Cross-platform: i.e, works natively on Linux for native emulators, and the same code runs just as well on Windows.
  - Modern: Built on C++ & QT5/6, and made to interface with the MAME network output *standard*, meaning implicit support e.g. for RetroArch cores that use TCP localhost:8000 for feeding force feedback events.
  - Small & Simple: runs in the background with a single command, no admin privileges necessary.
- - Designed for light guns: Made for and exclusively compatible with the serial port interface used by PC light gun systems (which currently are [OpenFIRE](https://github.com/TeamOpenFIRE/OpenFIRE-Firmware), [GUN4IR](https://forum.arcadecontrols.com/index.php/topic,161189.0.html), and the [Blamcon](https://blamcon.com/) systems).
+ - Designed for light guns: Made for and exclusively compatible with the serial port interface used by PC light gun systems (which currently are [OpenFIRE](https://github.com/TeamOpenFIRE/OpenFIRE-Firmware), [GUN4IR](https://forum.arcadecontrols.com/index.php/topic,161189.0.html), [Blamcon](https://blamcon.com/) systems, and the RetroShooter RS3*).
  - Compatible with MAMEHOOKER configs: Uses the same *.ini* files verbatim, no changes needed!
+##### *requires manual whitelisting on Linux
 
 ### Why would you NOT use this over MAMEHOOKER?
  - It's barebones: Strictly only supports light gun peripherals over serial (COM devices).
@@ -49,6 +50,12 @@ Only programs with *network outputs support* (event packets sent over TCP @ loca
 Just run the `QMamehook` executable in a terminal; send an interrupt signal (or `pkill QMamehook`) to stop it.
 
 Game config files are searched in `~/.config/QMamehook/ini`, and the program output will indicate whether a correct file matching the `mame_start` message is found or not.
+
+> [!NOTE]
+> RS3 users will have to manually probe the usbserial driver to expose this device's serial port, which can be done as follows (as root/with sudo privileges):
+> ```
+> # modprobe usbserial vendor=0x0483 product=0x5750
+> ```
 ### For Windows:
 ##### Requirements: Windows 7 and up.
  - Download the latest release zip.

qhookermain.cpp

@@ -160,10 +160,11 @@ void qhookerMain::SerialInit()
         }
     } else {
         QList<QSerialPortInfo> newDevices;
-        // Filter devices based on Vendor IDs (JB = 9025, Props3D = 13939, OpenFIRE = 0xF143)
+        // Filter devices based on Vendor IDs:
         for (const QSerialPortInfo &info : std::as_const(serialFoundList)) {
-            if(info.vendorIdentifier() == 9025  ||  // JB
-               info.vendorIdentifier() == 13939 ||  // Props3D
+            if(info.vendorIdentifier() == 9025   || // JB
+               info.vendorIdentifier() == 13939  || // Props3D
+               info.vendorIdentifier() == 0x0483 || // RS3 Reaper (requires manual modprobe by user)
                info.vendorIdentifier() == 0xF143)   // OpenFIRE
                 newDevices.append(info);
             else if(!info.portName().startsWith("ttyS"))
@@ -266,16 +267,19 @@ void qhookerMain::AddNewDevices(QList<QSerialPortInfo> &newDevices)
         printf("Port Name: %s\n", info.portName().toLocal8Bit().constData());
         printf("Vendor Identifier:  ");
         if(info.hasVendorIdentifier()) {
-            printf("%04X", info.vendorIdentifier());
+            printf("%04X ", info.vendorIdentifier());
             switch(info.vendorIdentifier()) {
             case 9025:
-                printf(" (GUN4IR Lightgun)\n");
+                printf("(GUN4IR Lightgun)\n");
                 break;
             case 13939:
-                printf(" (Blamcon Lightgun)\n");
+                printf("(Blamcon Lightgun)\n");
+                break;
+            case 0x0483:
+                printf("(RetroShooter Lightgun)");
                 break;
             case 0xF143:
-                printf(" (OpenFIRE Lightgun)\n");
+                printf("(OpenFIRE Lightgun)\n");
                 break;
             default:
                 // unlikely to happen due to whitelisting, but just in case.