Click to Go Home

Installation

This page goes over the steps to install ChipEight.

Note that only debian linux, specifically Ubuntu, and Windows 11 have been tested. Other operating systems will be added later.

Linux

This section will show you how to install these tools to get ChipEight built and running:

Git
SDL2
Mingw32

  1. Open your terminal and install Git by typing

    sudo apt install git-all

  2. Pick a location to clone the ChipEight repository and type

    git clone https://github.com/JeremyS22/ChipEight.git

    If for some reason the link doesn't work, go to ChipEight's repository on Github and copy the page's url (whether it's the address bar or from clicking on the green "code" button)

  3. Type

    cd ChipEight

  4. ChipEight uses SDL2 and lmingw32, you'll have to install these libraries (If prompted for either of these type 'y'):
    • SDL2:

      sudo apt-get install libsdl2-dev

    • lmingw32

      sudo apt-get install gcc-mingw-w64

  5. Build and compile the code by typing

    g++ -g -I src/include -I src/include/SDL2 -L src/lib -o ChipEight main.cpp Cpu.cpp Screen.cpp Memory.cpp Keypad.cpp Debugger.cpp DebuggingTextbox.cpp -lmingw32 -lSDL2main -lSDL2 -lSDL2_ttf

  6. Finally run the builded linux executable by typing

    ./ChipEight

Note: The ChipEight emulator is still in early development, so it's very likely some roms won't be fully or playable at all.