[RAHasher] CLI improvements

LeXofLeviafan · LeXofLeviafan · commit 1465e60221e3 · 2025-06-14T22:30:02.000+02:00
diff --git a/.github/workflows/c-cpp.yml b/.github/workflows/c-cpp.yml
@@ -13,8 +13,17 @@ on:
       - develop
 
 jobs:
-  RALibretro-Win32:
-    runs-on: windows-2019
+  Prepare-release:  # preventing concurrent releases creation
+    runs-on: ubuntu-latest
+    steps:
+    - name: Create release
+      uses: softprops/action-gh-release@v1
+      if: startsWith(github.ref, 'refs/tags/')
+      with:
+        draft: true
+
+  RAHasher-Win32:
+    runs-on: windows-2025
     steps:
     - name: Checkout
       uses: actions/checkout@v2
@@ -25,10 +34,19 @@ jobs:
     - name: Install Windows SDK 8.1
       run: choco install windows-sdk-8.1
     - name: Build
-      run: msbuild.exe RALibretro.sln -p:Configuration=Release -p:Platform=x86
+      run: msbuild.exe RALibretro.sln -t:RAHasher -p:Configuration=Release -p:Platform=x86
+    - name: Zip
+      if: startsWith(github.ref, 'refs/tags/')
+      run: 7z a -mx=9 RAHasher-x86-Windows-${{ github.ref_name }}.zip .\obj\Release\Win32\RAHasher.exe
+    - name: Release
+      uses: softprops/action-gh-release@v1
+      if: startsWith(github.ref, 'refs/tags/')
+      with:
+        draft: true
+        files: RAHasher*.zip
 
-  RALibretro-Win64:
-    runs-on: windows-2019
+  RAHasher-Win64:
+    runs-on: windows-2025
     steps:
     - name: Checkout
       uses: actions/checkout@v2
@@ -39,39 +57,16 @@ jobs:
     - name: Install Windows SDK 8.1
       run: choco install windows-sdk-8.1
     - name: Build
-      run: msbuild.exe RALibretro.sln -p:Configuration=Release -p:Platform=x64
-
-  RALibretro-Win32-cross-compile:
-    runs-on: ubuntu-latest
-    steps:
-    - name: Checkout
-      uses: actions/checkout@v2
-      with:
-        submodules: recursive
-    - name: Install dependencies
-      run: |
-        sudo apt-get update
-        sudo apt-get install gcc-multilib # bits/libc-header-start.h
-    - name: Install MinGW
-      uses: egor-tensin/setup-mingw@v2
-    - name: Build
-      run: make ARCH=x86
-
-  RALibretro-Win64-cross-compile:
-    runs-on: ubuntu-latest
-    steps:
-    - name: Checkout
-      uses: actions/checkout@v2
+      run: msbuild.exe RALibretro.sln -t:RAHasher -p:Configuration=Release -p:Platform=x64
+    - name: Zip
+      if: startsWith(github.ref, 'refs/tags/')
+      run: 7z a -mx=9 RAHasher-x64-Windows-${{ github.ref_name }}.zip .\obj\Release\x64\RAHasher.exe
+    - name: Release
+      uses: softprops/action-gh-release@v1
+      if: startsWith(github.ref, 'refs/tags/')
       with:
-        submodules: recursive
-    - name: Install dependencies
-      run: |
-        sudo apt-get update
-        sudo apt-get install gcc-multilib # bits/libc-header-start.h
-    - name: Install MinGW
-      uses: egor-tensin/setup-mingw@v2
-    - name: Build
-      run: make ARCH=x64
+        draft: true
+        files: RAHasher*.zip
 
   RAHasher-linux-x86:
     runs-on: ubuntu-latest
diff --git a/Makefile.RAHasher b/Makefile.RAHasher
@@ -60,7 +60,7 @@ src/Git.cpp: etc/Git.cpp.template FORCE
 
 zip: $(OUTDIR)/RAHasher$(EXE)
 	rm -f $(OUTDIR)/RAHasher-*.zip RAHasher-*.zip
-	zip -9 RAHasher-$(ARCH)-$(KERNEL)-`git describe --tags | sed s/\-.*//g | tr -d "\n"`.zip $(OUTDIR)/RAHasher$(EXE)
+	zip -9 --junk-paths RAHasher-$(ARCH)-$(KERNEL)-`git describe --tags | sed s/\-.*//g | tr -d "\n"`.zip $(OUTDIR)/RAHasher$(EXE)
 
 clean:
 	rm -f $(OUTDIR)/RAHasher$(EXE) $(OBJS) $(OUTDIR)/RAHasher*.zip RAHasher*.zip
diff --git a/README.md b/README.md
@@ -1,13 +1,10 @@
-# RALibretro
+# RAHasher
 
-RALibretro is a multi-emulator that can be used to develop RetroAchievements and, of course, earn them.
+RAHasher is a CLI utility for verifying ROM checksums [with hashing methods used by RetroAchievements](https://docs.retroachievements.org/developer-docs/game-identification.html).
 
-The "multi-emulation" feature is only possible because it uses [libretro](https://github.com/libretro/) cores to do the actual emulation. What RALibretro does is to connect the emulation to the tools used to create RetroAchievements.
+_(It's a copy of the same utility provided by [RALibretro](https://github.com/RetroAchievements/RALibretro), but with a bit more convenient CLI.)_
 
-The integration with RetroAchievements.org site is done by the [RAIntegration](https://github.com/RetroAchievements/RAIntegration).
-
-
-## Building RALibretro with MSYS2/Makefile
+## Building RAHasher with MSYS2/Makefile
 
 ### Install MSYS2
 
@@ -25,14 +22,14 @@ $ pacman -S make git zip mingw-w64-i686-gcc mingw-w64-i686-SDL2 mingw-w64-i686-g
 ### Clone the repo
 
 ```
-$ git clone --recursive --depth 1 https://github.com/RetroAchievements/RALibretro.git
+$ git clone --recursive --depth 1 https://github.com/LeXofLeviafan/RAHasher.git
 ```
 
 ### Build
 
 ```
-$ cd RALibretro
-$ make
+$ cd RAHasher
+$ make -f Makefile.RAHasher HAVE_CHD=1
 ```
 
 **NOTE**: use `make` for a release build or `make DEBUG=1` for a debug build. Don't forget to run `make clean` first if switching between a release build and a debug build.
@@ -42,21 +39,32 @@ $ make
 ### Clone the repo
 
 ```
-> git clone --recursive --depth 1 https://github.com/RetroAchievements/RALibretro.git
+> git clone --recursive --depth 1 https://github.com/LeXofLeviafan/RAHasher.git
 ```
 
 ### Build
 
-Load `RALibretro.sln` in Visual Studio and build it.
+Load `RALibretro.sln` in Visual Studio and build it (specifically the `RAHasher` target).
 
 ## Command Line Arguments
 
 Argument|Description
 -|-
--c [--core]|the core's name, e.g. `--core picodrive_libretro`
--s [--system]|the system id, see ConsoleID in [RAInterface/RA_Consoles.h](https://github.com/RetroAchievements/RAInterface/blob/master/RA_Consoles.h), e.g. `--system 1`
--g [--game]|full path to the game's file, e.g. `--game "C:\ROMS\GEN\Demons Of Asteborg Demo.gen"`
+-v|(optional) enables verbose messages for debugging
+-s systempath|(optional) specifies where supplementary files are stored (typically a path to RetroArch/system)
+system|specifies the system key or id associated to the game (which hash algorithm to use)
+filepath|specifies the path to the game file (file may include wildcards, path may not)
+
+I.e., in order to find out what checksum RA would assign to a NES game file, you can invoke the program like this:
+```bat
+RAHasher.exe NES "C:\ROMS\NES\Alwa's Awakening 8-bit edition.nes"
+```
+You can also pass `?` as the system key; in which case RAHasher will attempt to detect the system based on ROM file extension. (Note: equivalent "system ID" number is `91`.)
 
-In order to run a game on startup, provide the core, system and game, e.g.:
+Additionally, you can pass multiple filenames and/or specify it a glob template (with `*`/`?` wildcards). Note that wildcards are only allowed in _filename itself_ (not in the path), and that system detection is not allowed in multiple files mode.
 
-`RALibretro.exe --core picodrive_libretro --system 1 --game "C:\ROMS\GEN\Demons Of Asteborg Demo.gen"`
+Finally, the full list of valid console keys/IDs will be printed along with usage info if you run RAHasher without arguments:
+```bat
+RAHasher.exe
+```
+The list ordering matches RetroAchievements website menu. (Also, system keys match short names from [RetroAchievents game lists](https://retroachievements.org/games), sans whitespace.)
diff --git a/src/RAHasher.cpp b/src/RAHasher.cpp
@@ -13,6 +13,9 @@
 #ifdef _WIN32
  #define WIN32_LEAN_AND_MEAN
  #include <Windows.h>
+ #ifndef strcasecmp
+   #define strcasecmp _stricmp
+ #endif
 #elif defined(__unix__)
  #include <glob.h>
  #include <sys/stat.h>
@@ -28,16 +31,150 @@ void rc_hash_init_chd_cdreader(); /* in HashCHD.cpp */
 
 void   initHash3DS(const std::string& systemDir); /* in Hash3DS.cpp */
 
+static const char* _NINTENDO = "Nintendo";
+static const char* _SONY     = "Sony";
+static const char* _ATARI    = "Atari";
+static const char* _SEGA     = "Sega";
+static const char* _NEC      = "NEC";
+static const char* _SNK      = "SNK";
+static const char* _OTHERS   = "Others";
+
+typedef struct console_t {
+  const uint32_t id;
+  const char* key;
+  const char* group;
+  const char* name;
+} console_t;
+
+static const console_t CONSOLES[] = {
+  {RC_CONSOLE_GAMEBOY,                   "GB",      _NINTENDO, "Game Boy"},
+  {RC_CONSOLE_GAMEBOY_ADVANCE,           "GBA",     _NINTENDO, "Game Boy Advance"},
+  {RC_CONSOLE_GAMEBOY_COLOR,             "GBC",     _NINTENDO, "Game Boy Color"},
+  {RC_CONSOLE_NINTENDO,                  "NES",     _NINTENDO, "NES/Famicom"},
+  {RC_CONSOLE_SUPER_NINTENDO,            "SNES",    _NINTENDO, "SNES/Super Famicom"},
+  {RC_CONSOLE_NINTENDO_64,               "N64",     _NINTENDO, "Nintendo 64"},
+  {RC_CONSOLE_GAMECUBE,                  "GC",      _NINTENDO, "GameCube"},
+  {RC_CONSOLE_NINTENDO_DS,               "DS",      _NINTENDO, "Nintendo DS"},
+  {RC_CONSOLE_NINTENDO_DSI,              "DSi",     _NINTENDO, "Nintendo DSi"},
+  {RC_CONSOLE_POKEMON_MINI,              "MINI",    _NINTENDO, "Pokemon Mini"},
+  {RC_CONSOLE_VIRTUAL_BOY,               "VB",      _NINTENDO, "Virtual Boy"},
+  {RC_CONSOLE_GAME_AND_WATCH,            "G&W",     NULL,       "Game & Watch"},
+  {RC_CONSOLE_NINTENDO_3DS,              "3DS",     NULL,       "Nintendo 3DS"},
+  {RC_CONSOLE_WII,                       "Wii",     NULL,       "Nintendo Wii"},
+  {RC_CONSOLE_WII_U,                     "WiiU",    NULL,       "Nintendo Wii U"},
+
+  {RC_CONSOLE_PLAYSTATION,               "PS1",     _SONY, "PlayStation"},
+  {RC_CONSOLE_PLAYSTATION_2,             "PS2",     _SONY, "PlayStation 2"},
+  {RC_CONSOLE_PSP,                       "PSP",     _SONY, "PlayStation Portable"},
+
+  {RC_CONSOLE_ATARI_2600,                "2600",    _ATARI, "Atari 2600"},
+  {RC_CONSOLE_ATARI_7800,                "7800",    _ATARI, "Atari 7800"},
+  {RC_CONSOLE_ATARI_JAGUAR,              "JAG",     _ATARI, "Atari Jaguar"},
+  {RC_CONSOLE_ATARI_JAGUAR_CD,           "JCD",     _ATARI, "Atari Jaguar CD"},
+  {RC_CONSOLE_ATARI_LYNX,                "Lynx",    _ATARI, "Atari Lynx"},
+  {RC_CONSOLE_ATARI_5200,                "5200",    NULL,    "Atari 5200"},
+  {RC_CONSOLE_ATARI_ST,                  "AST",     NULL,    "Atari ST"},
+
+  {RC_CONSOLE_SG1000,                    "SG1K",    _SEGA, "SG-1000"},
+  {RC_CONSOLE_MASTER_SYSTEM,             "SMS",     _SEGA, "Master System"},
+  {RC_CONSOLE_GAME_GEAR,                 "GG",      _SEGA, "Game Gear"},
+  {RC_CONSOLE_MEGA_DRIVE,                "MD",      _SEGA, "Genesis/Mega Drive"},
+  {RC_CONSOLE_SEGA_CD,                   "SCD",     _SEGA, "Sega CD"},
+  {RC_CONSOLE_SEGA_32X,                  "32X",     _SEGA, "32X"},
+  {RC_CONSOLE_SATURN,                    "SAT",     _SEGA, "Saturn"},
+  {RC_CONSOLE_DREAMCAST,                 "DC",      _SEGA, "Dreamcast"},
+  {RC_CONSOLE_PICO,                      "Pico",    NULL,   "Sega Pico"},
+
+  {RC_CONSOLE_PC_ENGINE,                 "PCE",     _NEC, "PC Engine/TurboGrafx-16"},
+  {RC_CONSOLE_PC_ENGINE_CD,              "PCCD",    _NEC, "PC Engine CD/TurboGrafx-CD"},
+  {RC_CONSOLE_PC8800,                    "80/88",   _NEC, "PC-8000/8800"},
+  {RC_CONSOLE_PCFX,                      "PC-FX",   _NEC, "PC-FX"},
+  {RC_CONSOLE_PC6000,                    "PC-6000", NULL,  "PC-6000"},
+  {RC_CONSOLE_PC9800,                    "9800",    NULL,  "PC-9800"},
+
+  {RC_CONSOLE_NEO_GEO_CD,                "NGCD",    _SNK, "Neo Geo CD"},
+  {RC_CONSOLE_NEOGEO_POCKET,             "NGP",     _SNK, "Neo Geo Pocket"},
+
+  {RC_CONSOLE_3DO,                       "3DO",     _OTHERS, "3DO Interactive Multiplayer"},
+  {RC_CONSOLE_AMSTRAD_PC,                "CPC",     _OTHERS, "Amstrad CPC"},
+  {RC_CONSOLE_APPLE_II,                  "A2",      _OTHERS, "Apple II"},
+  {RC_CONSOLE_ARCADE,                    "ARC",     _OTHERS, "Arcade"},
+  {RC_CONSOLE_ARCADIA_2001,              "A2001",   _OTHERS, "Arcadia 2001"},
+  {RC_CONSOLE_ARDUBOY,                   "ARD",     _OTHERS, "Arduboy"},
+  {RC_CONSOLE_COLECOVISION,              "CV",      _OTHERS, "ColecoVision"},
+  {RC_CONSOLE_ELEKTOR_TV_GAMES_COMPUTER, "ELEK",    _OTHERS, "Elektor TV Games Computer"},
+  {RC_CONSOLE_FAIRCHILD_CHANNEL_F,       "CHF",     _OTHERS, "Fairchild Channel F"},
+  {RC_CONSOLE_INTELLIVISION,             "INTV",    _OTHERS, "Intellivision"},
+  {RC_CONSOLE_INTERTON_VC_4000,          "VC4000",  _OTHERS, "Interton VC 4000"},
+  {RC_CONSOLE_MAGNAVOX_ODYSSEY2,         "MO2",     _OTHERS, "Magnavox Odyssey 2"},
+  {RC_CONSOLE_MEGADUCK,                  "DUCK",    _OTHERS, "Mega Duck"},
+  {RC_CONSOLE_MSX,                       "MSX",     _OTHERS, "MSX"},
+  //{RC_CONSOLE_STANDALONE,                "EXE",     _OTHERS, "Standalone"},  /* >90, not usable */
+  {RC_CONSOLE_UZEBOX,                    "UZE",     _OTHERS, "Uzebox"},
+  {RC_CONSOLE_VECTREX,                   "VECT",    _OTHERS, "Vectrex"},
+  {RC_CONSOLE_SUPERVISION,               "WSV",     _OTHERS, "Watara Supervision"},
+  {RC_CONSOLE_WASM4,                     "WASM4",   _OTHERS, "WASM-4"},
+  {RC_CONSOLE_WONDERSWAN,                "WS",      _OTHERS, "WonderSwan"},
+  {RC_CONSOLE_AMIGA,                     "Amiga",   NULL,     "Amiga"},
+  {RC_CONSOLE_CASSETTEVISION,            "ECV",     NULL,     "Cassette Vision"},
+  {RC_CONSOLE_SUPER_CASSETTEVISION,      "ESCV",    NULL,     "Super Cassette Vision"},
+  {RC_CONSOLE_COMMODORE_64,              "C64",     NULL,     "Commodore 64"},
+  {RC_CONSOLE_FM_TOWNS,                  "FMTowns", NULL,     "FM Towns"},
+  {RC_CONSOLE_NOKIA_NGAGE,               "N-Gage",  NULL,     "Nokia N-Gage"},
+  {RC_CONSOLE_ORIC,                      "Oric",    NULL,     "Oric"},
+  {RC_CONSOLE_CDI,                       "CD-i",    NULL,     "Philips CD-i"},
+  {RC_CONSOLE_SHARPX1,                   "X1",      NULL,     "Sharp X1"},
+  {RC_CONSOLE_X68K,                      "X68K",    NULL,     "Sharp X68000"},
+  {RC_CONSOLE_THOMSONTO8,                "TO8",     NULL,     "Thomson TO8"},
+  {RC_CONSOLE_TI83,                      "TI83",    NULL,     "TI-83"},
+  {RC_CONSOLE_TIC80,                     "TIC-80",  NULL,     "TIC-80"},
+  {RC_CONSOLE_VIC20,                     "VIC-20",  NULL,     "VIC-20"},
+  {RC_CONSOLE_ZEEBO,                     "Zeebo",   NULL,     "Zeebo"},
+  {RC_CONSOLE_ZX81,                      "ZX81",    NULL,     "ZX81"},
+  {RC_CONSOLE_ZX_SPECTRUM,               "ZXS",     NULL,     "ZX Spectrum"},
+  {RC_CONSOLE_MS_DOS,                    "DOS",     NULL,     "DOS"},
+  {RC_CONSOLE_XBOX,                      "Xbox",    NULL,     "Xbox"},
+};
+static const long CONSOLES_NUM = sizeof(CONSOLES) / sizeof(console_t);
+
+static int32_t find_console_id (const char* key) {
+  for (int i = 0;  i < CONSOLES_NUM;  i++)
+    if ((CONSOLES[i].group != NULL) && (strcasecmp(key, CONSOLES[i].key) == 0))
+      return CONSOLES[i].id;
+  return atoi(key);  // if no matching key found, falling back to original behaviour
+}
+
 static void usage(const char* appname)
 {
   printf("RAHasher %s\n====================\n", git::getReleaseVersion());
 
-  printf("Usage: %s [-v] [-s systempath] systemid filepath\n", util::fileName(appname).c_str());
+  printf("Usage: %s [-v] [-s systempath] system filepath...\n", util::fileName(appname).c_str());
   printf("\n");
   printf("  -v             (optional) enables verbose messages for debugging\n");
   printf("  -s systempath  (optional) specifies where supplementary files are stored (typically a path to RetroArch/system)\n");
-  printf("  systemid       specifies the system id associated to the game (which hash algorithm to use)\n");
+  printf("  system         specifies the system key or id associated to the game (which hash algorithm to use)\n");
   printf("  filepath       specifies the path to the game file (file may include wildcards, path may not)\n");
+
+  printf("\n");
+  printf(" ID Key     Group    Name\n");
+  printf(" -- ------- -------- ---------------------------\n");
+  const char* last_group = NULL;
+  for (int i = 0;  i < CONSOLES_NUM;  i++) {
+#ifdef HIDE_UNSUPPORTED_CONSOLES
+    if (CONSOLES[i].group == NULL)
+      continue;
+#endif
+    if ((CONSOLES[i].group != NULL) && (last_group != NULL) && (last_group != CONSOLES[i].group))
+      printf("\n");
+    printf(" %2d %-7s %-8s %s\n", CONSOLES[i].id, CONSOLES[i].key,
+           (CONSOLES[i].group == NULL ? "" : CONSOLES[i].group), CONSOLES[i].name);
+    if (CONSOLES[i].group != NULL)
+      last_group = CONSOLES[i].group;
+  }
+  printf("\nFor a single file, console ID can be specified as '?' (to attempt guessing by extension)\n");
+#ifndef HIDE_UNSUPPORTED_CONSOLES
+  printf("Warning: consoles with a 'blank' group are currently not supported by RA!\n");
+#endif
 }
 
 class StdErrLogger : public Logger
@@ -267,7 +404,8 @@ int main(int argc, char* argv[])
     return 1;
   }
 
-  consoleId = atoi(argv[argi++]);
+  const char* consoleKey = argv[argi++];
+  consoleId = (strcmp(consoleKey, "?") == 0 ? 1+RC_CONSOLE_MAX : find_console_id(consoleKey));
   if (consoleId == 0)
   {
     usage(argv[0]);
diff --git a/src/RAHasher.vcxproj b/src/RAHasher.vcxproj
@@ -63,6 +63,9 @@
       <SubSystem>Console</SubSystem>
       <GenerateDebugInformation>true</GenerateDebugInformation>
     </Link>
+    <PreBuildEvent>
+      <Command>$(ProjectDir)..\etc\MakeGitCpp.bat</Command>
+    </PreBuildEvent>
     <CustomBuildStep>
       <Command>copy /b/y $(TargetPath) $(SolutionDir)\bin</Command>
     </CustomBuildStep>
@@ -88,6 +91,9 @@
       <SubSystem>Console</SubSystem>
       <GenerateDebugInformation>true</GenerateDebugInformation>
     </Link>
+    <PreBuildEvent>
+      <Command>$(ProjectDir)..\etc\MakeGitCpp.bat</Command>
+    </PreBuildEvent>
     <CustomBuildStep>
       <Command>copy /b/y  $(TargetPath) $(SolutionDir)\bin64</Command>
     </CustomBuildStep>
@@ -118,6 +124,9 @@
       <OptimizeReferences>true</OptimizeReferences>
       <GenerateDebugInformation>true</GenerateDebugInformation>
     </Link>
+    <PreBuildEvent>
+      <Command>$(ProjectDir)..\etc\MakeGitCpp.bat</Command>
+    </PreBuildEvent>
     <CustomBuildStep>
       <Command>copy /b/y $(TargetPath) $(SolutionDir)\bin</Command>
     </CustomBuildStep>
@@ -147,6 +156,9 @@
       <OptimizeReferences>true</OptimizeReferences>
       <GenerateDebugInformation>true</GenerateDebugInformation>
     </Link>
+    <PreBuildEvent>
+      <Command>$(ProjectDir)..\etc\MakeGitCpp.bat</Command>
+    </PreBuildEvent>
     <CustomBuildStep>
       <Command>copy /b/y  $(TargetPath) $(SolutionDir)\bin64</Command>
     </CustomBuildStep>
