Forgot to locally switch from the SDL branch and delete it...

.github/workflows/build.yml

@@ -10,6 +10,7 @@ on:
       - '.github/workflows/**'
     branches:
       - master
+      - sdl
   workflow_dispatch:
 
 jobs:
@@ -100,7 +101,7 @@ jobs:
         run: |
           mkdir -p build
           cd build
-          cmake .. -DCMAKE_BUILD_TYPE=Release
+          cmake .. -DCMAKE_BUILD_TYPE=Release -D CMAKE_SYSTEM_VERSION=10.0.26100.0
 
       - name: Build CMake
         run: |

.gitmodules

@@ -1,9 +1,12 @@
-[submodule "dependencies/sfml"]
-	path = dependencies/sfml
-	url =  https://github.com/SFML/SFML.git
-[submodule "dependencies/libconfig"]
-	path = dependencies/libconfig
-	url =  https://github.com/hyperrealm/libconfig.git
+[submodule "dependencies/sdl"]
+	path = dependencies/sdl
+	url = git@github.com:libsdl-org/SDL.git
 [submodule "dependencies/nativefiledialog"]
 	path = dependencies/nativefiledialog
 	url = git@github.com:btzy/nativefiledialog-extended.git
+[submodule "dependencies/libconfig"]
+	path = dependencies/libconfig
+	url = https://github.com/hyperrealm/libconfig.git
+[submodule "dependencies/sdl_ttf"]
+	path = dependencies/sdl_ttf
+	url = git@github.com:libsdl-org/SDL_ttf.git

CMakeLists.txt

@@ -5,19 +5,11 @@ VERSION 0.1)
 
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
-
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
+option(SDL_VENDORED "Use vendored libraries" ON)
 
 add_executable(8ChocChip)
 
-#option(BUILD_SHARED_LIBS "Build shared libraries" OFF)
-
-#file(GLOB ASSETS "${CMAKE_SOURCE_DIR}/assets/*")
-#
-#foreach(ASSET ${ASSETS})
-#    configure_file(${ASSET} ${CMAKE_BINARY_DIR}/assets COPYONLY)
-#endforeach()
-
 add_subdirectory(dependencies)
 add_subdirectory(src)
 
@@ -27,33 +19,13 @@ else()
     set(libname "config")
 endif()
 
-target_link_libraries(8ChocChip PRIVATE sfml-graphics sfml-audio sfml-window sfml-system nfd ${libname}++)
+target_link_libraries(8ChocChip PRIVATE SDL3::SDL3 SDL3_ttf::SDL3_ttf nfd ${libname}++)
 
-# Set the RPATH of the executable to include the directory where SFML libraries are located
 set_target_properties(8ChocChip PROPERTIES
         INSTALL_RPATH "$ORIGIN"
         BUILD_RPATH "$ORIGIN"
 )
 
-# Copy DLLs needed for runtime on Windows
-if(WIN32)
-    add_custom_command(
-            TARGET 8ChocChip
-            COMMENT "Copy OpenAL DLL"
-            PRE_BUILD COMMAND ${CMAKE_COMMAND} -E copy ${SFML_SOURCE_DIR}/extlibs/bin/$<IF:$<EQUAL:${CMAKE_SIZEOF_VOID_P},8>,x64,x86>/openal32.dll $<TARGET_FILE_DIR:${PROJECT_NAME}>
-            VERBATIM)
-
-    if (BUILD_SHARED_LIBS)
-        add_custom_command(TARGET 8ChocChip POST_BUILD
-                COMMAND ${CMAKE_COMMAND} -E copy_if_different
-                $<TARGET_FILE:sfml-graphics>
-                $<TARGET_FILE:sfml-window>
-                $<TARGET_FILE:sfml-system>
-                $<TARGET_FILE:sfml-audio>
-                $<TARGET_FILE_DIR:8ChocChip>)
-    endif()
-endif()
-
 # Copy nfd and config++ libraries to the executable directory
 if (UNIX AND NOT APPLE)
     add_custom_command(TARGET ${PROJECT_NAME} POST_BUILD

README.md

@@ -1,19 +1,18 @@
 # 8ChocChip
 
-8ChocChip is an emulator for the [Chip8](https://en.wikipedia.org/wiki/CHIP-8) software that I am working on to learn the basics around emulation. 
-I decided to program this in C++ because I wanted to do more in it and improve my skills.
+8ChocChip is an emulator for the Chip8 software that I am working on to learn the basics around emulation.
 
-The graphics and only library used in this is SFML which handles the window, inputs and sounds. 
+This uses SDL to handle graphics, input, audio and some other small things.
 libconfig is used to manage config and save data files, and NativeFileDialog-extended is used for basic popup windows like the file/directory selector.
 
 ## TODO
 
 There are a couple of things left to do until I would say it works well enough
-- [x] ~~Fix some of the instructions that result in most programs failing except for `BLINKY`~~ Should be done but the test suite has issues I can not figure out how to fix. But is better than before and should work with most stuff
+- [x] Proper flag compatibility unlike many out there
 - [ ] Cleaner/more optimised code
 - [x] Windows Support
 - [ ] MacOS Support (Builds, but unable to test)
-- [ ] Switch to SDL from SFML
+- [x] Switch to SDL from SFML
 
 ## Usage
 
@@ -37,17 +36,17 @@ Some parts are just setting up ssh or installing dependencies which you may have
 
 ### Requirements
 
-To build this it requires C++, CMake and whatever SFML and SFML Audio requires on your platform. Check build file above.
+To build this it requires C++, CMake and whatever SDL/dependencies need. Check build file above.
 
 # Credits
 
-Thanks to these two blogs that helped me through creating this emulator
-[How to Create Your Very Own Chip-8 Emulator](https://www.freecodecamp.org/news/creating-your-very-own-chip-8-emulator/)
-[Guide to making a CHIP-8 emulator ](https://tobiasvl.github.io/blog/write-a-chip-8-emulator/)
+Thanks to these two blogs that helped me through creating this emulator. These are actually based on a "broken" emulator guide so not everything will work. But it is good as a base and learning how to do your own research into the functionality of the emulator.
+- [How to Create Your Very Own Chip-8 Emulator](https://www.freecodecamp.org/news/creating-your-very-own-chip-8-emulator/)
+- [Guide to making a CHIP-8 emulator ](https://tobiasvl.github.io/blog/write-a-chip-8-emulator/)
 
 ## Libraries
 
 Currently, three libraries are being used
-- [SFML](https://github.com/SFML/SFML) - UI, graphics, input and sounds
+- [SDL](https://github.com/libsdl-org/SDL) - UI, graphics, input and sounds
 - [NativeFileDialog-extended](https://github.com/btzy/nativefiledialog-extended) - Handles file dialogs for selecting files/directories. Fork of [nativefiledialog](https://github.com/mlabbe/nativefiledialog) which I used a fork of that added only CMake support, this new one adds that plus new fixes/features
 - [libconfig](https://github.com/hyperrealm/libconfig) - Library to manage save data (like directories that hold ROMs) and possible future config files

dependencies/CMakeLists.txt

@@ -1,8 +1,13 @@
-if(NOT EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/sfml/CMakeLists.txt")
-    message("${CMAKE_CURRENT_SOURCE_DIR}/sfml/CMakeLists.txt")
-    message(FATAL_ERROR "Please initialize submodules using:\n  git submodule update --init --recursive")
+add_subdirectory(nativefiledialog)
+
+set(BUILD_EXAMPLES OFF CACHE BOOL "Disable examples for libconfig" FORCE)
+set(BUILD_TESTS ON CACHE BOOL "Disable tests for libconfig" FORCE)
+add_subdirectory(libconfig EXCLUDE_FROM_ALL)
+
+if(SDL_VENDORED)
+    add_subdirectory(sdl EXCLUDE_FROM_ALL)
+else()
+    find_package(SDL3 REQUIRED CONFIG REQUIRED COMPONENTS SDL3-shared)
 endif()
 
-add_subdirectory(sfml)
-add_subdirectory(nativefiledialog)
-add_subdirectory(libconfig)
+add_subdirectory(sdl_ttf)

src/CMakeLists.txt

@@ -1,6 +1,5 @@
-add_subdirectory(sfml)
+add_subdirectory(sdl)
 add_subdirectory(util)
 add_subdirectory(emulator)
 
-target_sources(8ChocChip PUBLIC main.cpp)
-
+target_sources(8ChocChip PUBLIC main.cpp Timer.cpp Timer.h)

src/Timer.cpp

@@ -0,0 +1,67 @@
+#include "Timer.h"
+
+#include <SDL3/SDL.h>
+
+Timer::Timer() {
+    this->startTicks = 0;
+    this->pausedTicks = 0;
+
+    this->paused = false;
+    this->started = false;
+}
+
+void Timer::start() {
+    this->started = true;
+    this->paused = false;
+
+    this->startTicks = SDL_GetTicks();
+    this->pausedTicks = 0;
+}
+
+void Timer::stop() {
+    this->started = false;
+    this->paused = false;
+    this->startTicks = 0;
+    this->pausedTicks = 0;
+}
+
+void Timer::pause() {
+    if(this->started && !this->paused) {
+        this->paused = true;
+
+        this->pausedTicks = SDL_GetTicks() - this->startTicks;
+        this->startTicks = 0;
+    }
+}
+
+void Timer::unpause() {
+    if(this->started && this->paused) {
+        this->paused = false;
+
+        this->startTicks = SDL_GetTicks() - this->pausedTicks;
+
+        this->pausedTicks = 0;
+    }
+}
+
+uint64_t Timer::getTicks() const {
+    uint64_t time = 0;
+
+    if(this->started) {
+        if(this->paused) {
+            time = this->pausedTicks;
+        } else {
+            time = SDL_GetTicks() - this->startTicks;
+        }
+    }
+
+    return time;
+}
+
+bool Timer::isStarted() const {
+    return this->started;
+}
+
+bool Timer::isPaused() const {
+    return this->paused && this->started;
+}

src/Timer.h

@@ -0,0 +1,28 @@
+#ifndef TIMER_H
+#define TIMER_H
+
+#include <stdint.h>
+
+class Timer {
+public:
+    Timer();
+
+    void start();
+    void stop();
+    void pause();
+    void unpause();
+
+    uint64_t getTicks() const;
+
+    bool isStarted() const;
+    bool isPaused() const;
+
+private:
+    uint64_t startTicks;
+    uint64_t pausedTicks;
+
+    bool paused;
+    bool started;
+};
+
+#endif

src/emulator/Cpu.cpp

@@ -205,19 +205,21 @@ void Cpu::runInstruction(const uint16_t opcode) {
             break;
         }
         case 0xD000: {
-            const uint16_t width = 8;
             const uint16_t height = (opcode & 0xF);
 
+            const uint8_t uX = this->registers[x];
+            const uint8_t uY = this->registers[y];
             this->registers[0xF] = 0;
 
             for (uint16_t row = 0; row < height; row++) {
+                constexpr uint16_t width = 8;
                 uint8_t sprite = this->memory[this->address + row];
 
                 for (uint16_t col = 0; col < width; col++) {
                     // If the bit (sprite) is not 0, render/erase the pixel
                     if ((sprite & 0x80) > 0) {
                         // If setPixel returns 1, which means a pixel was erased, set VF to 1
-                        if (this->renderer->setPixel(this->registers[x] + col, this->registers[y] + row)) {
+                        if (this->renderer->setPixel(uX + col, uY + row)) {
                             this->registers[0xF] = 1;
                         }
                     }
@@ -232,12 +234,12 @@ void Cpu::runInstruction(const uint16_t opcode) {
         case 0xE000:
             switch (opcode & 0xFF) {
                 case 0x9E:
-                    if (this->keyboard->isKeyPressed(this->registers[x])) {
+                    if (this->keyboard->isKeyPressed(this->registers[x] & 0xF)) {
                         this->pc += 2;
                     }
                     break;
                 case 0xA1:
-                    if (!this->keyboard->isKeyPressed(this->registers[x])) {
+                    if (!this->keyboard->isKeyPressed(this->registers[x] & 0xF)) {
                         this->pc += 2;
                     }
                     break;
@@ -269,7 +271,7 @@ void Cpu::runInstruction(const uint16_t opcode) {
                     this->address += this->registers[x];
                     break;
                 case 0x29:
-                    this->address = 0x50 + this->registers[x] * 5;
+                    this->address = 0x50 + (this->registers[x] & 0xF) * 5;
                     break;
                 case 0x33: {
                     uint8_t value = this->registers[x];

src/emulator/Cpu.h

@@ -40,4 +40,4 @@ class Cpu {
     Speaker* speaker;
 };
 
-#endif //CPU_H
+#endif

src/emulator/Keyboard.h

@@ -10,22 +10,22 @@ class Keyboard {
     std::unordered_map<uint8_t, bool> keysPressed;
     std::function<void(unsigned char)> onNextKeyPress;
     std::unordered_map<uint8_t, unsigned char> KEYMAP = {
-        {27, 0x1}, // 1
-        {28, 0x2}, // 2
-        {29, 0x3}, // 3
-        {30, 0xc}, // 4
-        {16, 0x4}, // Q
-        {22, 0x5}, // W
-        {4, 0x6}, // E
-        {17, 0xD}, // R
-        {0, 0x7}, // A
-        {18, 0x8}, // S
-        {3, 0x9}, // D
-        {5, 0xE}, // F
-        {25, 0xA}, // Z
-        {23, 0x0}, // X
-        {2, 0xB}, // C
-        {21, 0xF}  // V
+        {30, 0x1}, // 1
+        {31, 0x2}, // 2
+        {32, 0x3}, // 3
+        {33, 0xc}, // 4
+        {20, 0x4}, // Q
+        {26, 0x5}, // W
+        {8, 0x6}, // E
+        {21, 0xD}, // R
+        {4, 0x7}, // A
+        {22, 0x8}, // S
+        {7, 0x9}, // D
+        {9, 0xE}, // F
+        {29, 0xA}, // Z
+        {27, 0x0}, // X
+        {6, 0xB}, // C
+        {25, 0xF}  // V
     };
 
     void setOnNextKeyPress(std::function<void(unsigned char)> callback);
@@ -34,6 +34,4 @@ class Keyboard {
     bool isKeyPressed(int keyCode);
 };
 
-
-
-#endif //KEYBOARD_H
+#endif