guac

README

guac-rf (Guac Rodrigo’s Fork): NDS, GBA, GBC, DMG, Pokémon Mini Emulator

Guac is an Emulator written in golang for Gameboy, Pokémon Mini, Gameboy Color, Gameboy Advance, and Nintendo DS handheld consoles.

Original Breakdown NDS Update

Building

Building from source is possible with golang > 1.26.0, by following these simple steps:

1. Clone this repository through git:

git clone https://github.com/SplaatSites/guac.git

(Optional) Update the cloned repo

git pull

1. Build the project

go build .

Getting Started

In both command line and console mode, save files are placed in the same directory as the rom file (ex. "toki_tori.gbc", "toki_tori.gbc.save")

Command line

Run the executable with a rom path (gb, gbc, gba, nds, min are required extensions) to immediately enter the game.

.\guac -r="../rom/pokemon_emerald.gba"

Console Mode

Run the executable without flags to use console mode, which initalizes a Game Selection Screen.

.\guac

Setting up Console Mode

At root, create a "roms.json" file. This file will hold the game metadata in the following format. At this time Art must be 1:1 pngs or jpgs. Watch trailing commas in json, it got me many a times.

[
 {
  "RomPath": "./rom/gba/the_minish_cap.gba",
  "ArtPath": "./art/the_minish_cap.png"
 }
 ...]

Configuration

Emulator settings can be configured using the config.toml file at root. If you would like to return to the default config.toml file, delete any present config.toml file and run the emulator.

Configurable Options

General

1. Keyboard / Controller Input
2. Backdrop Color
3. Menu Game Density
4. FPS Control

GB / GBC

1. DMG Gameboy Palette

GBA

1. Optimizations (Idle looping, sound clock updated)

NDS

1. Jit Parameters
2. Bios and Firmware Options
3. Screen Layout, Sizing and Rotation
4. Real Time Clock offset
5. 3D Scene Export options

Pokémon Mini

1. WIP

Testing

Check the ./emu folder for individual consoles. These consoles will have "testing.md" files showing currently passing tests and tested games.