Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gabe565/gones

🕹️ An NES emulator written in Go.
https://github.com/gabe565/gones

6502-processor emulation emulator nes nintendo nintendo-nes

Last synced: about 1 month ago
JSON representation

🕹️ An NES emulator written in Go.

Host: GitHub
URL: https://github.com/gabe565/gones
Owner: gabe565
Created: 2022-11-07T17:03:06.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2024-04-12T16:08:51.000Z (9 months ago)
Last Synced: 2024-04-13T20:50:29.464Z (8 months ago)
Topics: 6502-processor, emulation, emulator, nes, nintendo, nintendo-nes
Language: Go
Homepage: https://gones.gabe565.com
Size: 3.66 MB
Stars: 15
Watchers: 2
Forks: 1
Open Issues: 19
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        




  

  GoNES



[![GitHub release (latest by date)](https://img.shields.io/github/v/release/gabe565/gones)](https://github.com/gabe565/gones/releases)

[![Build](https://github.com/gabe565/gones/actions/workflows/build.yml/badge.svg)](https://github.com/gabe565/gones/actions/workflows/build.yml)

[![Go Report Card](https://goreportcard.com/badge/github.com/gabe565/gones)](https://goreportcard.com/report/github.com/gabe565/gones)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=gabe565_gones&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=gabe565_gones)

_An NES emulator written in Go._



## Install

### Homebrew (macOS)

```shell

brew install gabe565/tap/gones --no-quarantine

```

### Binary

Automated builds are uploaded during the release process. See the [latest release](https://github.com/gabe565/gones/releases/latest) for download links.

### Web

GoNES supports emulation in a web browser by compiling to WASM.  

A hosted instance is available at [gones.gabe565.com](https://gones.gabe565.com).

### From Source

  Click to expand

#### Requirements

Rendering uses [hajimehoshi/ebiten](https://github.com/hajimehoshi/ebiten) which requires

OpenGL development libraries to compile.

See [ebiten install steps](https://ebitengine.org/en/documents/install.html).

#### Installation

Make sure you have [Go](https://go.dev/doc/install) and the [requirements](#requirements) installed, then run:

```shell

go install gabe565.com/gones@latest

```

## Usage

### Application

When started, GoNES will open a file picker. Choose the `.nes` file to start emulation.

### Terminal

  Click to expand

GoNES also supports being launched from a terminal.

```shell

gones ROM_FILE

```

See [docs](./docs/gones.md) for the full command line usage documentation.

## Configuration

A configuration file will be generated the first time GoNES is run. Depending on your operating system, the file will be available at:

- **Windows:** `%AppData%\gones\config.toml`

- **macOS:** `~/Library/Application Support/gones/config.toml`

- **Linux:** `~/.config/gones/config.toml`

An example configuration is also available at [`config_example.toml`](config_example.toml).

## Keybinds

Keys are configurable, but the default values are listed below.

### Player 1

| Nintendo   | Emulator    |

|------------|-------------|

| A          | M           |

| B          | N           |

| Directions | WASD        |

| Start      | Enter       |

| Select     | Right Shift |

| A (Turbo)  | K           |

| B (Turbo)  | J           |

### Player 2

  Click to expand

| Nintendo   | Emulator          |

|------------|-------------------|

| A          | Num Pad 3         |

| B          | Num Pad 2         |

| Directions | Home/Del/End/PgDn |

| Start      | Num Pad Enter     |

| Select     | Num Pad Plus      |

| A (Turbo)  | Num Pad 6         |

| B (Turbo)  | Num Pad 5         |

### Other

| Action            | Key      |

|-------------------|----------|

| Save State        | F1       |

| Load State        | F5       |

| Undo Save State   | Shift+F1 |

| Undo Load State   | Shift+F5 |

| Fast Forward      | F (Hold) |

| Reset             | R (Hold) |

| Toggle Fullscreen | F11      |

| Screenshot        | \        |

#### Debugging

  Click to expand

| Action                                            | Key |

|---------------------------------------------------|-----|

| Toggle step debugging                             | `   |

| Toggle stdout trace log (when step debug enabled) | Tab |

| Step to next frame                                | 1   |

| Run to next render                                | 2   |

## Milestones

- [x] CPU implementation

  - CPU is stable, and `nestest.nes` passes.

- [x] Cartridge implementation

  - [x] Support for mappers

  - [x] Common mappers implemented

    - Supported mappers: 0, 1, 2, 3, 4, 7, 69, 71 (84.34% of official NES games)

- [x] PPU implementation (graphics)

  - [x] Background rendering

  - [x] Sprite rendering

- [x] GUI

  - Rendering works, but menu options need to be added.

- [x] Basic controller support

  - [x] Player 1

  - [x] Player 2

  - [ ] External controllers

- [x] APU implementation (audio)

- [x] Save file for games with batteries

- [x] Save states

- [x] Configuration (remap controllers, video config, sound config, etc)

  - [x] Config file

  - [ ] Config UI

- [ ] Cheats

## References

- [NESDev wiki](https://www.nesdev.org/wiki/Nesdev_Wiki)

- [NESDev 6502 Reference](https://www.nesdev.org/obelisk-6502-guide/)

- [NESDev Undocumented Opcodes](https://www.nesdev.org/undocumented_opcodes.txt)

- [Writing an NES Emulator in Rust](https://bugzmanov.github.io/nes_ebook/)

- [fogleman/nes](https://github.com/fogleman/nes)

- [ltriant/nes](https://github.com/ltriant/nes)

- [i82orbom/nesgo](https://github.com/i82orbom/nesgo)

- [No-Intro](https://no-intro.org)

- [NES Composite Palette Project](https://www.firebrandx.com/nespalette.html)