https://github.com/axioncloud/freemegb

A GameBoy simulator that has seen multiple program language iterations. Currently, the latest iteration is in Go. Previous iterations include, C++ (Qt, then GTK) and Node.js (Electron.js)
https://github.com/axioncloud/freemegb

go golang gtk3 simulator

Last synced: 22 days ago
JSON representation

A GameBoy simulator that has seen multiple program language iterations. Currently, the latest iteration is in Go. Previous iterations include, C++ (Qt, then GTK) and Node.js (Electron.js)

• Host: GitHub
• URL: https://github.com/axioncloud/freemegb
• Owner: axioncloud
• License: bsd-2-clause
• Created: 2019-05-08T13:24:53.000Z (over 5 years ago)
• Default Branch: lang/go
• Last Pushed: 2023-04-10T03:12:00.000Z (over 1 year ago)
• Last Synced: 2024-10-17T17:17:11.050Z (29 days ago)
• Topics: go, golang, gtk3, simulator
• Language: Go
• Homepage: https://freemegb.axioncloud.org
• Size: 270 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.com/ioncloud64/freemegb.svg?branch=lang%2Fgo)](https://travis-ci.com/ioncloud64/freemegb)

![GitHub issues](https://img.shields.io/github/issues-raw/ioncloud64/freemegb)

![License](https://img.shields.io/github/license/ioncloud64/freemegb)

![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/ioncloud64/freemegb)

![GitHub last commit](https://img.shields.io/github/last-commit/ioncloud64/freemegb)

[![GoDoc](https://godoc.org/github.com/ioncloud64/freemegb?status.svg)](https://godoc.org/github.com/ioncloud64/freemegb)

# FreeMe!GB

A GameBoy simulator written in Go. GUI bindings are written for GTK+. This program is designed to simulate the real hardware that was equipped in the system itself.

## Features

*Note: Features not yet implemented are italicized*

* Debugging Utility

  - CPU Registers

  - OPCODE descriptions

  - *Breakpoint debugging*

* Emulation Core

  - ROMs

    + ROM Name

    + ROM Type

    + ROM Size

    + *Compatibility Check*

  - CPU

    + Decode ROM file into OPCODE map

    + Registers per hardware specifications

    + Interrupts per specifications

    + *Throttle speed per hardware specifications*

  - *GPU*

* *Controller Support*

* *Shaders*

* Installers

  - Supported Platforms:

    + Linux RPM, DEB, and AppImage

    + Windows MSI

    + OSX dmg

## Build Requirements

* Windows

  - Install MSYS2 mingw64

  - [Install Windows dependencies](https://github.com/gotk3/gotk3/wiki)

  - Build by hand:

    - Add */mingw64/bin* to $PATH

  - Clone repository

  - Navigate to repository and run *go mod init*

  - run *make host* or *make windows_amd64*

    - *Note: if you wish to compile x86, add /bin/mingw32 to your $PATH instead*

* Linux

  - [Install Linux dependencies](https://github.com/gotk3/gotk3/wiki)

* Mac OS X

  - Not planned

# Project Inspiration

I have always interested in how emulators work, so I started to have this idea of creating my own emulator variant of the original GameBoy. This simulator is designed to be both educational and eventually complete. Please give me time as this is a personal project that may be dormant from time to time, depending on how life is at home. Feel free to give suggestions and tips at [email protected].

I look forward to completing FreeMe!GB and discovering Node.js's ability to perform.

Please check out the [wiki](https://github.com/ioncloud64/freemegb/wiki) for more information.