Merge branch 'develop'

Author: nnarain

.travis.yml

@@ -27,7 +27,7 @@ install:
 
 script:
 - mkdir build && cd build
-- cmake .. -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTS=ON -DWITH_COVERAGE=ON -DBUILD_DOCS=ON
+- cmake .. -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTS=ON -DWITH_COVERAGE=ON -DBUILD_EXAMPLES=ON
 - cd .. && cppcheck -q --enable=all --inconclusive --force --suppressions-list=./config/cppcheck-suppress.txt src/gameboycore/ && cd -
 - make
 - make check && make run_test_roms

CMakeLists.txt

@@ -8,8 +8,6 @@ cmake_minimum_required(VERSION 3.0)
 
 project(gameboycore)
 
-option(BUILD_DOCS "Build documentation" OFF)
-
 set(CMAKE_MODULE_PATH ${CMAKE_PREFIX_PATH} "${CMAKE_CURRENT_SOURCE_DIR}/cmake/")
 set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_CURRENT_SOURCE_DIR}/cmake/Modules/")
 

README.md

@@ -4,6 +4,7 @@
 [![Build status](https://ci.appveyor.com/api/projects/status/jkrjhds3i67o5k76/branch/develop?svg=true)](https://ci.appveyor.com/project/nnarain/gameboycore/branch/develop)
 [![codecov](https://codecov.io/gh/nnarain/gameboycore/branch/master/graph/badge.svg)](https://codecov.io/gh/nnarain/gameboycore)
 [![GitHub release](https://img.shields.io/github/release/nnarain/gameboycore.svg)](https://github.com/nnarain/gameboycore/releases)
+[![Docs](https://img.shields.io/badge/docs-latest-brightgreen.svg)](https://nnarain.github.io/gameboycore)
 
 GameboyCore is a Gameboy/Gameboy Color emulator library written in C++.
 

appveyor.yml

@@ -21,7 +21,7 @@ install:
 before_build:
   - cd c:\projects\gameboycore
   - mkdir build && cd build
-  - cmake .. -DBUILD_TESTS="ON" -DBUILD_EXAMPLE="OFF" -DBUILD_DOCS="OFF" -DCMAKE_TOOLCHAIN_FILE=%VCPKG_TOOLCHAIN%
+  - cmake .. -DBUILD_TESTS=ON -DBUILD_EXAMPLES=ON -DCMAKE_TOOLCHAIN_FILE=%VCPKG_TOOLCHAIN%
 
 build:
   project: c:\projects\gameboycore\build\gameboycore.sln

src/CMakeLists.txt

@@ -1,7 +1,12 @@
 option(BUILD_TOOLS "Build debug tooling" OFF)
+option(BUILD_EXAMPLES "Build example programs" OFF)
 
 add_subdirectory(gameboycore)
 
 if (BUILD_TOOLS)
     add_subdirectory(tools)
 endif(BUILD_TOOLS)
+
+if (BUILD_EXAMPLES)
+    add_subdirectory(examples)
+endif(BUILD_EXAMPLES)

src/examples/01_minimal/CMakeLists.txt

@@ -0,0 +1,9 @@
+add_executable(minimal_example
+    src/main.cpp
+)
+
+target_link_libraries(minimal_example
+    gameboycore
+)
+
+target_compile_definitions(minimal_example PRIVATE GAMEBOYCORE_STATIC=1)

src/examples/01_minimal/src/main.cpp

@@ -0,0 +1,45 @@
+#include <gameboycore/gameboycore.h>
+
+#include <iostream>
+#include <string>
+#include <functional>
+
+using namespace gb;
+
+int main(int argc, char * argv[])
+{
+    if (argc < 2)
+    {
+        std::cerr << "Must provide path to a ROM file\n";
+        return 1;
+    }
+
+    std::string filepath{argv[1]};
+
+    // Create an instance of the gameboy emulator core
+    GameboyCore core;
+
+    // Set callbacks for video and audio
+    core.setScanlineCallback([](const GPU::Scanline& scanline, int line){
+        std::cout << "Line " << line << "\n";
+    });
+    core.setAudioSampleCallback([](int16_t l, int16_t r){
+        std::cout << "L: " << l << " " << "R: " << r << "\n";
+    });
+
+    // Open the ROM specified ROM file
+    try
+    {
+        core.open(filepath);
+    }
+    catch(const std::runtime_error& e)
+    {
+        std::cerr << "Error loading ROM file: " << e.what() << "\n";
+        return 1;
+    }
+
+    // Run the emulator
+    core.emulateFrame();
+
+    return 0;
+}

src/examples/02_batteryram/CMakeLists.txt

@@ -0,0 +1,9 @@
+add_executable(batteryram_example
+    src/main.cpp
+)
+
+target_link_libraries(batteryram_example
+    gameboycore
+)
+
+target_compile_definitions(batteryram_example PRIVATE GAMEBOYCORE_STATIC=1)

src/examples/02_batteryram/src/main.cpp

@@ -0,0 +1,42 @@
+#include <gameboycore/gameboycore.h>
+
+#include <iostream>
+#include <string>
+
+using namespace gb;
+
+int main(int argc, char * argv[])
+{
+    if (argc < 2)
+    {
+        std::cerr << "Must provide path to a ROM file\n";
+        return 1;
+    }
+
+    std::string filepath{argv[1]};
+
+    // Create an instance of the gameboy emulator core
+    GameboyCore core;
+
+    // Open the ROM specified ROM file
+    try
+    {
+        core.open(filepath);
+    }
+    catch(const std::runtime_error& e)
+    {
+        std::cerr << "Error loading ROM file: " << e.what() << "\n";
+        return 1;
+    }
+
+    // Get battery RAM from the emulator
+    // Battery RAM is persistent storage for the Gameboy (RAM at this location is always on because of a battery in the cartridge)
+    // Battery RAM starts at address $A000
+    auto batteryram = core.getBatteryRam();
+    batteryram[0] = 0xFF;
+    core.setBatteryRam(batteryram);
+
+    std::cout << "$A000: " << std::hex << (int)core.readMemory(0xA000) << "\n";
+
+    return 0;
+}

src/examples/03_linkport/CMakeLists.txt

@@ -0,0 +1,9 @@
+add_executable(linkport_example
+    src/main.cpp
+)
+
+target_link_libraries(linkport_example
+    gameboycore
+)
+
+target_compile_definitions(linkport_example PRIVATE GAMEBOYCORE_STATIC=1)