Main

.fix-style.sh

@@ -0,0 +1,4 @@
+cp extern/jaffarCommon/.clang-format .
+extern/jaffarCommon/.build-tools/check-style.sh fix source
+extern/jaffarCommon/.build-tools/check-style.sh fix games
+extern/jaffarCommon/.build-tools/check-style.sh fix emulators

.github/workflows/make.yml

@@ -0,0 +1,222 @@
+name: Build and Run Tests
+
+on:
+  pull_request:
+    branches: [ "main" ]
+  push:
+    branches: [ "main" ]
+
+jobs:
+
+  # Build documentation and checking proper style
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: recursive
+    - name: Installing apt packages
+      run: sudo apt install clang-format doxygen graphviz
+    - name: Checking proper code styling
+      run:  |
+            cp extern/jaffarCommon/.clang-format .
+            extern/jaffarCommon/.build-tools/check-style.sh check source
+            extern/jaffarCommon/.build-tools/check-style.sh check games
+            extern/jaffarCommon/.build-tools/check-style.sh check emulators
+
+  # Build and run tests (QuickerNES) + Coverage Tests
+  build-QuickerNES:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: recursive
+    - name: Create build directory
+      run: mkdir build
+    - name: Installing meson and ninja
+      run: python3 -m pip install meson ninja
+    - name: Installing apt packages
+      run: sudo apt install libgtest-dev gcovr libnuma-dev libtbb-dev libsdl2-dev libsdl2-image-dev
+    - name: Run meson configuration
+      run: meson setup build -Dbuildtype=release -Db_coverage=true -DuseNCurses=false -Demulators=QuickerNES
+    - name: Building project
+      run: ninja -C build
+    - name: Running tests
+      run: ninja test -C build
+    - name: Running coverage analysis
+      run: ninja coverage -C build
+    - name: Upload coverage reports to Codecov
+      uses: codecov/[email protected]
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        slug: SergioMartin86/jaffarPlusPlus
+        fail_ci_if_error: true
+        files: build/meson-logs/coverage.xml
+    - uses: actions/upload-artifact@v4
+      if: always()
+      with:
+        name: meson-logs
+        path: build/meson-logs/
+
+
+  # Build and run tests (QuickerSDLPoP)
+  build-QuickerSDLPoP:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: recursive
+    - name: Create build directory
+      run: mkdir build
+    - name: Installing meson and ninja
+      run: python3 -m pip install meson ninja
+    - name: Installing apt packages
+      run: sudo apt install libgtest-dev gcovr libnuma-dev libtbb-dev libsdl2-dev libsdl2-image-dev
+    - name: Run meson configuration
+      run: meson setup build -Dbuildtype=release -DuseNCurses=false -Demulators=QuickerSDLPoP
+    - name: Building project
+      run: ninja -C build
+    - name: Running tests
+      run: ninja test -C build
+
+  # Build and run tests (QuickerSnes9x)
+  build-QuickerSnes9x:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: recursive
+    - name: Create build directory
+      run: mkdir build
+    - name: Installing meson and ninja
+      run: python3 -m pip install meson ninja
+    - name: Installing apt packages
+      run: sudo apt install libgtest-dev gcovr libnuma-dev libtbb-dev libsdl2-dev libsdl2-image-dev
+    - name: Run meson configuration
+      run: meson setup build -Dbuildtype=release -DuseNCurses=false -Demulators=QuickerSnes9x
+    - name: Building project
+      run: ninja -C build
+    - name: Running tests
+      run: ninja test -C build
+
+  # Build and run tests (QuickerGPGX)
+  build-QuickerGPGX:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: recursive
+    - name: Create build directory
+      run: mkdir build
+    - name: Installing meson and ninja
+      run: python3 -m pip install meson ninja
+    - name: Installing apt packages
+      run: sudo apt install libgtest-dev gcovr libnuma-dev libtbb-dev libsdl2-dev libsdl2-image-dev
+    - name: Run meson configuration
+      run: meson setup build -Dbuildtype=release -DuseNCurses=false -Demulators=QuickerGPGX
+    - name: Building project
+      run: ninja -C build
+    - name: Running tests
+      run: ninja test -C build
+
+  # Build and run tests (QuickerStella)
+  build-QuickerStella:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: recursive
+    - name: Create build directory
+      run: mkdir build
+    - name: Installing meson and ninja
+      run: python3 -m pip install meson ninja
+    - name: Installing apt packages
+      run: sudo apt install libgtest-dev gcovr libnuma-dev libtbb-dev libsdl2-dev libsdl2-image-dev
+    - name: Run meson configuration
+      run: meson setup build -Dbuildtype=release -DuseNCurses=false -Demulators=QuickerStella
+    - name: Building project
+      run: ninja -C build
+    # Disabling tests for stella because it does not run correctly in the CI  
+    #- name: Running tests
+    #  run: ninja test -C build
+
+  # Build and run tests (Atari2600Hawk)
+  build-Atari2600Hawk:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: recursive
+    - name: Create build directory
+      run: mkdir build
+    - name: Installing meson and ninja
+      run: python3 -m pip install meson ninja
+    - name: Installing apt packages
+      run: sudo apt install libgtest-dev gcovr libnuma-dev libtbb-dev libsdl2-dev libsdl2-image-dev
+    - name: Run meson configuration
+      run: meson setup build -Dbuildtype=release -DuseNCurses=false -Demulators=Atari2600Hawk
+    - name: Building project
+      run: ninja -C build
+    - name: Running tests
+      run: ninja test -C build      
+
+  # Build and run tests (Atari2600Hawk)
+  build-QuickerSMBC:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: recursive
+    - name: Create build directory
+      run: mkdir build
+    - name: Installing meson and ninja
+      run: python3 -m pip install meson ninja
+    - name: Installing apt packages
+      run: sudo apt install libgtest-dev gcovr libnuma-dev libtbb-dev libsdl2-dev libsdl2-image-dev
+    - name: Run meson configuration
+      run: meson setup build -Dbuildtype=release -DuseNCurses=false -Demulators=QuickerSMBC
+    - name: Building project
+      run: ninja -C build
+    - name: Running tests
+      run: ninja test -C build
+
+  # Build and run tests (QuickerRAW)
+  build-QuickerRAW:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: recursive
+    - name: Create build directory
+      run: mkdir build
+    - name: Installing meson and ninja
+      run: python3 -m pip install meson ninja
+    - name: Installing apt packages
+      run: sudo apt install libgtest-dev gcovr libnuma-dev libtbb-dev libsdl2-dev libsdl2-image-dev
+    - name: Run meson configuration
+      run: meson setup build -Dbuildtype=release -DuseNCurses=false -Demulators=QuickerRAW
+    - name: Building project
+      run: ninja -C build
+    # Disabling tests for RAW because I cannot upload the game data files
+    #- name: Running tests
+    #  run: ninja test -C build
+
+  # Build and run tests (QuickerArkBot)
+  build-QuickerArkBot:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: recursive
+    - name: Create build directory
+      run: mkdir build
+    - name: Installing meson and ninja
+      run: python3 -m pip install meson ninja
+    - name: Installing apt packages
+      run: sudo apt install libgtest-dev gcovr libnuma-dev libtbb-dev libsdl2-dev libsdl2-image-dev
+    - name: Run meson configuration
+      run: meson setup build -Dbuildtype=release -DuseNCurses=false -Demulators=QuickerArkBot
+    - name: Building project
+      run: ninja -C build
+    - name: Running tests
+      run: ninja test -C build

.gitignore

@@ -1,3 +1,6 @@
+run-clang-format
+.mono
+.clang-format
 *.bk
 .vscode
 *.a26
@@ -26,8 +29,8 @@ tools/llvm/
 tools/run-clang-format/
 *.p1r
 *.log
-*.sol
-
+jaffar.best.sol
+jaffar.worst.sol
 # Prerequisites
 *.d
 

.gitmodules

@@ -1,3 +1,30 @@
-[submodule "extern/json"]
-	path = extern/json
-	url = https://github.com/nlohmann/json.git
+[submodule "subprojects/quickerNES"]
+	path = extern/quickerNES
+	url = https://github.com/SergioMartin86/quickerNES.git
+[submodule "extern/jaffarCommon"]
+	path = extern/jaffarCommon
+	url = https://github.com/SergioMartin86/jaffarCommon.git
+[submodule "extern/quickerSDLPoP"]
+	path = extern/quickerSDLPoP
+	url = https://github.com/SergioMartin86/quickerSDLPoP.git
+[submodule "extern/quickerSnes9x"]
+	path = extern/quickerSnes9x
+	url = https://github.com/SergioMartin86/quickerSnes9x.git
+[submodule "extern/quickerGPGX"]
+	path = extern/quickerGPGX
+	url = https://github.com/SergioMartin86/quickerGPGX.git
+[submodule "extern/quickerStella"]
+	path = extern/quickerStella
+	url = https://github.com/SergioMartin86/quickerStella.git
+[submodule "extern/atari2600Hawk"]
+	path = extern/atari2600Hawk
+	url = https://github.com/SergioMartin86/libAtari2600HawkTester.git
+[submodule "extern/quickerSMBC"]
+	path = extern/quickerSMBC
+	url = https://github.com/SergioMartin86/quickerSMBC.git
+[submodule "extern/quickerRAW"]
+	path = extern/quickerRAW
+	url = https://github.com/SergioMartin86/QuickerRAW.git
+[submodule "extern/quickerArkBot"]
+	path = extern/quickerArkBot
+	url = https://github.com/SergioMartin86/QuickerArkBot.git

README.md

@@ -1,14 +1,41 @@
+
+[![Build and Run Tests](https://github.com/SergioMartin86/jaffarPlusPlus/actions/workflows/make.yml/badge.svg)](https://github.com/SergioMartin86/jaffarPlusPlus/actions/workflows/make.yml) [![codecov](https://codecov.io/github/SergioMartin86/jaffarPlusPlus/graph/badge.svg?token=NF9W0XZ16h)](https://codecov.io/github/SergioMartin86/jaffarPlusPlus) 
+
 # JaffarPlus
 
 ![](jaffar.png)
 
-High-performance bot for tool-assisted speedrunning, based on [Jaffar](https://github.com/SergioMartin86/jaffar), a solver for the original Prince of Persia (DOS). JaffarPlus is:
+JaffarPlus is a high-performance general-purpose breath-first search optimizer. This project is specially tailored for the production tool-assisted speedruns (TAS). Its features are:
 
 * High-Performance: Tailored for multi-core CPUs, especially for high core counts.
-* Multi-Platform: Supports games from multiple consoles/plaftforms: NES, SNES, Genesis, SDLPoP.
+* Multi-Platform: Supports games from multiple consoles/game emulators
 * Extensible: Any new emulators or games that support load/save and advance step functions can be added to JaffarPlus via a common API
 
-A list of TAS movies produced by eien86 using JaffarPlus can be found [here](https://tasvideos.org/Subs-List?user=eien86&statusfilter=6)
+This work is based on [Jaffar](https://github.com/SergioMartin86/jaffar), a solver for the original Prince of Persia (DOS).
+
+# Built-in Emulator Support
+
+## Consoles
+
+| Console            | Core(s)                                                                      | Target        |  Notes        |
+| --------           | -------                                                                      | ------        | ------        |
+| Atari 2600         | [QuickerStella](https://github.com/SergioMartin86/quickerStella)             | Bizhawk (dev) | Faster than Atari2600Hawk  |
+| Atari 2600         | [Atari2600Hawk](https://github.com/CasualPokePlayer/libAtari2600Hawk)        | Bizhawk 2.9.2 |               |
+| NES                | [QuickerNES](https://github.com/SergioMartin86/quickerNES)                   | Bizhawk 2.9.2 |               |
+| SNES               | [QuickerSnes9x](https://github.com/SergioMartin86/quickerSnes9x)             | Bizhawk 2.9.2 |               |
+| Sega Genesis       | [QuickerGPGX](https://github.com/SergioMartin86/quickerGPGX)                 | Bizhawk 2.9.2 |               |
+| Sega CD            | [QuickerGPGX](https://github.com/SergioMartin86/quickerGPGX)                 | Bizhawk 2.9.2 |               |
+| Sega SG-1000       | [QuickerGPGX](https://github.com/SergioMartin86/quickerGPGX)                 | Bizhawk 2.9.2 |               |
+| Sega Master System | [QuickerGPGX](https://github.com/SergioMartin86/quickerGPGX)                 | Bizhawk 2.9.2 |               |
+
+## Game-Specific
+
+| Game                                | Core(s)                                                           |   Target      |  Notes   |
+| --------                            | -------                                                           | ------        | ------   |
+| Prince of Persia (DOS / Apple ][)   | [QuickerSDLPoP](https://github.com/SergioMartin86/quickerSDLPoP)  | LibTAS+PCem   |          |
+| Another World                       | [QuickerRaw](https://github.com/SergioMartin86/QuickerRAW)        | *many*        |  All ports of AW use the same engine |
+| Super Mario Bros (NES)              | [QuickerSMBC](https://github.com/SergioMartin86/quickerSMBC)      | Bizhawk 2.9.2 |  Inaccurate in transitions, but good for solving levels |
+| Arkanoid (NES)                      | [QuickerArkbot](https://github.com/SergioMartin86/quickerArkBot)  | Bizhawk 2.9.2 (NesHawk Core) |          |
 
 Author
 =============
@@ -17,6 +44,24 @@ Author
   + Github: https://github.com/SergioMartin86
   + Twitch: https://www.twitch.tv/eien86
   + Youtube: https://www.youtube.com/channel/UCSXpK3d6vUq58fjgF5jFoKA
-
-Contributions via pull requests are highly appreciated.
+  + TASVideos: https://tasvideos.org/Users/Profile/eien86
+
+- A list of TAS movies produced by eien86 using JaffarPlus can be found [here](https://tasvideos.org/Subs-List?user=eien86&statusfilter=6)
+
+- Contributions via pull requests are highly appreciated.
+
+- Thanks to:
+  + TASVideos' staff (judges, encoders, admins, etc)
+  + The Bizhawk development team (YoshiRulz, feos, Morilli, CasualPokePlayer, NattTheBear, Alyosha, feos, zeromus, and many others)
+  + Dávid Nagy and all SDLPoP developers
+  + Gregory Montoir and Fabien Sanglard (authors of Fabother World)
+  + Eke-Eke and all Genesis Plus GX developers
+  + Shay Green, Christopher Snowhill and all QuickNES developers
+  + sbroger (a.k.a Chef Stef), developer of Arkbot
+  + Mitchell Sternke, developer of SMB-C
+  + Alexander Lyashuk (mooskagh, crem) for kickstarting the idea of creating a TASing bot.
+  + The authors of the third party libraries used.
 
+- JaffarPlus is distributed freely under the GPL3 license for any purpose and use, as long as:
+  + The license and proper credits to its author are preserved
+  + If you publish a TAS or any public work using this software, I'd appreciate you mention it and linking this repository in your description

emulators/README.md

@@ -0,0 +1,10 @@
+For emulators to be included in JaffarPlus, the following conditions must be met:
+
+- They core needs to be developed in their own repository and included here as a submodule
+- They need to implement Meson as build system so that they can easily be loaded as a subproject dependency
+- They need to pass a CI pipeline with build and run tests.
+- The run tests must include the reproduction of movies (preferably published at tasvideos.org) with the following conditions
+  + The end state hash must be equal for a simple reproduction (only advance state) and a full re-record reproduction (save / advance / load / advance). This ensures to some extent that the solution that JaffarPlus produces through repeated re-recording can be reproduced later in a simple playback in the emulator.
+  + If the emulator is an improved version of an original one, the original must be preserved in the repository and the test above must produce the exact same results for both of them.
+- Must be fully thread-safe
+- Must have no memory leaks in load/save/advance state routines