godc

command module
v0.2.24 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 29, 2025 License: MIT Imports: 17 Imported by: 0

README

GODC - Go Dreamcast Command Line Tool

godc logo

Lint Test codecov Go Report Card Go Reference License

CLI for building Go programs for Sega Dreamcast. It uses libgodc, a minimal Go runtime for the Dreamcast, along with pre-built KOS ready for coding.

Requirements

  • Go (1.25.3+)
  • make
  • git

Install

go install github.com/drpaneas/godc@latest

Note: Make sure $GOBIN (or $GOPATH/bin) is in your PATH so that godc is available after installation.

Setup

Download and install the Dreamcast toolchain:

godc setup  # Download and install the libraries
godc doctor # Check installation (optional)
godc env    # Show environment info (optional)

This installs to ~/dreamcast and updates your shell config.

KallistiOS environment loaded:
  KOS_BASE:    $HOME/dreamcast/kos
  KOS_CC_BASE: $HOME/dreamcast/sh-elf
  KOS_PORTS:   $HOME/dreamcast/kos-ports
  GCC version: 15.1.0

Usage

mkdir my_game; cd my_game # Create a directory to work
godc init     # Initialize it
vim main.go   # Write your code
godc build    # Build
godc run      # Run in emulator
godc run --ip # Run on hardware via dc-tool-ip
godc clean    # Remove generated build files

Update libgodc

To update the libgodc runtime library to the latest version:

godc update

This pulls the latest libgodc from GitHub and rebuilds it. Use this when new features or fixes are added to libgodc.

Custom Configuration (optional)

godc config # Configure emulators, IP Addresses etc

Config file: ~/.config/godc/config.toml

Path = "/home/user/dreamcast"
Emu = "flycast"
IP = "192.168.2.203"

Documentation

Overview

godc - Dependency interfaces for testability

godc - Dreamcast Go CLI

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL