Deecy

Deecy is an experimental Dreamcast emulator written in Zig.

Videos: Soul Calibur (May 2024), Grandia II (July 2024), DCA3 (January 2025)

Installation

• Download the latest version for your platform from the Release Page.
• Decompress the zip archive.
• Copy your bios and flash dumps as dc_boot.bin and dc_flash.bin to the data folder.
• Launch the Deecy executable and click Change Directory to select the folder where you store your DC games.

Usage

Keybindings

Deecy should detect, map and use controllers automatically. Host controllers can be manually assigned to guest controller ports in the Settings. Keyboard bindings can be customized in the settings. Defaults for controller 1:

Shortcuts

CLI options

Compatibility

See issue #33

Build

Install the correct zig version (see .zigversion). You can use zigup to manage your installed zig versions, or get it from https://ziglang.org/download/.

zigup 0.15.2

Clone and build. Zig will fetch all dependencies automatically.

git clone https://github.com/Senryoku/Deecy         # Clone the repo
cd Deecy
zig build run                                       # Build and run in debug mode without any argument
zig build run --release=fast -- -g "path/game.gdi"  # Build and run in release mode and loads a disc

You will also need to provide copies of dc_boot.bin and dc_flash.bin files in the data/ directory.

Linux

nfd-zig (native file dialog) needs this additional dependency on Linux:

sudo apt install libgtk-3-dev

Things I know I have to do

• Debug, debug, debug.
• SH4:
  • MMU:
    • Windows CE: Test and Debug more games.
    • Optimize.
• AICA:
  • Debug
• Renderer:
  • Framebuffer:
    • Improve detection of writes to framebuffer (false positives?)
    • Write back for games that need it.
  • Modifier Volumes.
    • Implemented: Inclusion volumes and shadow bit over opaque and transparent geometry.
    • Missing: Exclusion volumes.
    • Missing: Translucent MV in pre-sort mode.
  • Region Array Data Configuration are mostly ignored.
  • Fog LUT Mode 2.
  • User Tile Clip, only the simplest version is supported.
  • Secondary accumulate buffer (low priority, not many games use this feature).
  • Mipmaps for palette textures?
  • Follow ISP_FEED_CFG discard mode flag? (Find a game that turns it off)

Nice to have

• Some (rendering) performance metrics directly in the emulator?
• GDROM-DMA: Uses a superfluous memcpy (gdrom -> dma-queue -> ram). Not a huge deal on my main system, but I bet it's noticeable on lower end devices.

Some sources

• http://www.shared-ptr.com/sh_insns.html
• SH4 Hardware Manual / Programming Manual
• https://segaretro.org/Dreamcast_official_documentation
• Dreamcast Programming by Marcus Comstedt : https://mc.pp.se/dc/
• Boot ROM disassembly by Lars Olsson (https://lars-olsson.sizious.com/, originally https://www.ludd.ltu.se/~jlo/dc/)
• Neill Corlett's Yamaha AICA notes
• AICA ARM7 Core tester by snickerbockers: https://github.com/snickerbockers/dc-arm7wrestler/
• Reicast https://github.com/skmp/reicast-emulator

Dependencies

Dependencies are managed by the build.zig.zon file.

• Multiple libraries from https://github.com/zig-gamedev (MIT)
• ndf-zig: https://github.com/fabioarnold/nfd-zig (MIT)
• zig-lz4: https://github.com/SnorlaxAssist/zig-lz4 (MIT), bindings for LZ4 https://github.com/lz4/lz4 (BSD 2-Clause)

Thanks

• Huge thanks to drk||Raziel and MetalliC for their respective contributions to the scene, and for answering my questions!
• Thanks to originaldave_ for the sh4 tests (https://github.com/SingleStepTests/sh4)
• And overall thanks to everyone participating in the EmuDev Discord :)

Licence

Uses data from MAME under the BSD-3-Clause licence (see src/gdrom_secu.zig). CHD related features (src/disc/chd.zig) are also inspired by, or even direct ports of, their equivalent from the MAME project.

Rest is MIT.