You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit f3cfa4b
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: README.md
+30-1Lines changed: 30 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,6 +13,33 @@ A complete GameBoy emulator written in C++ with SDL2, OpenGL, and ImGui.
13
13
- ImGui user interface, allowing drag-and-drop of ROM files directly into the window to play immediately
14
14
- Slow-motion support
15
15
16
+
## Build & Run Instructions
17
+
This emulator is built specifically for **Windows 11**.
18
+
19
+
### Requirements
20
+
-**OS**: Windows 11
21
+
-**CMake**: Version 3.20 or higher
22
+
-**Compiler**: MSVC (Visual Studio 2019/2022) or any compatible C++20 compiler on Windows.
23
+
24
+
### Build from source
25
+
Open your terminal (Command Prompt / PowerShell) and run the following commands:
26
+
```bat
27
+
# 1. Generate the build files
28
+
cmake -B build
29
+
30
+
# 2. Compile the executable
31
+
cmake --build build --config Release
32
+
```
33
+
The compiled executable will be located at `build/Release/gb_emulator.exe`.
34
+
35
+
### Running the Emulator
36
+
You can launch the emulator in two ways:
37
+
1.**Direct Launch**: Simply double-click `gb_emulator.exe`. Once the window opens, you can drag and drop any `.gb` ROM file into the emulator window to start playing.
38
+
2.**Command Line**: Run the executable and pass the ROM file path as an argument.
39
+
```bat
40
+
gb_emulator.exe "path/to/your/game.gb"
41
+
```
42
+
16
43
## ROMs
17
44
You can download test ROMs and game ROMs to play from the links below:
0 commit comments