SameBoy | Accurate GB/GBC emulator |
| download: https://git.y1.nz/archives/sameboy.tar.gz | |
| README | Files | Log | Refs | LICENSE |
build-faq.md
1 # macOS Specific Issues
2 ## Attempting to build the Cocoa frontend fails with NSInternalInconsistencyException
3
4 When building on macOS, the build system will make a native Cocoa app by default. In this case, the build system uses the Xcode `ibtool` command to build user interface files. If this command fails, you can fix this issue by starting Xcode and letting it install components. After this is done, you should be able to close Xcode and build successfully.
5
6 ## Attempting to build the SDL frontend on macOS fails on linking
7
8 SameBoy on macOS expects you to have SDL2 installed via Brew, and not as a framework. Older versions expected it to be installed as a framework, but this is no longer the case.
9
10 # Windows Build Process
11
12 ## Tools and Libraries Installation
13
14 For the various tools and libraries, follow the below guide to ensure easy, proper configuration for the build environment:
15
16 ### SDL2
17
18 For [libSDL2](https://libsdl.org/download-2.0.php), download the Visual C++ Development Library pack. Place the extracted files within a known folder for later. Both the `\x64\` and `\include\` paths will be needed.
19
20 The following examples will be referenced later:
21
22 - `C:\SDL2\lib\x64\*`
23 - `C:\SDL2\include\*`
24
25 ### rgbds
26
27 After downloading [rgbds](https://github.com/gbdev/rgbds/releases/), ensure that it is added to the `%PATH%`. This may be done by adding it to the user's or SYSTEM's Environment Variables, or may be added to the command line at compilation time via `set path=%path%;C:\path\to\rgbds`.
28
29 ### Git Bash & Make
30
31 Ensure that the `Git\usr\bin` directory is included in `%PATH%`. Like rgbds above, this may instead be manually included on the command line before installation: `set path=%path%;C:\path\to\Git\usr\bin`. Similarly, make sure that the directory containing `make.exe` is also included.
32
33 ## Building
34
35 Within a command prompt in the project directory:
36
37 ```
38 vcvars64
39 set lib=%lib%;C:\SDL2\lib\x64
40 set include=%include%;C:\SDL2\include
41 make
42 ```
43 On some versions of Visual Studio, you might need to use `vcvarsx86_amd64` instead of `vcvars64`. Please note that these directories (`C:\SDL2\*`) are the examples given within the "SDL Port" section above. Ensure that your `%PATH%` properly includes `rgbds` and `Git\usr\bin`, and that the `lib` and `include` paths include the appropriate SDL2 directories.
44
This webpage is intended to be an accessible preview of this repository. To get a fuller picture, clone it and use the git CLI.