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

https://github.com/blackchip-org/retro-cs

The retro-computing systems
https://github.com/blackchip-org/retro-cs

6502 commodore-128 commodore-64 emulator galaga go golang mspacman pacman z80

Last synced: 5 months ago
JSON representation

The retro-computing systems

Awesome Lists containing this project

README

          

# retro-cs

[![Build Status](https://travis-ci.com/blackchip-org/retro-cs.svg?branch=master)](https://travis-ci.com/blackchip-org/retro-cs) [![GoDoc](https://godoc.org/github.com/blackchip-org/retro-cs?status.svg)](https://godoc.org/github.com/blackchip-org/retro-cs)

The Retro-Computing Systems.

Inspired by the Vintage Computer Club. This project is no longer being actively
worked on but that could always change. Feel free to contact me for more
information.

See my [VCF West 2022](https://vcfed.org/) presentation here:

[![Adventures in Emulation](https://img.youtube.com/vi/VRFtXx4i8lo/0.jpg)](https://www.youtube.com/watch?v=VRFtXx4i8lo "Adventures In Emulation")

See my [VCF East 2022](https://vcfed.org/) class here:

[![Writing an Emulator](https://img.youtube.com/vi/kq0_PiOVN0E/0.jpg)](https://www.youtube.com/watch?v=kq0_PiOVN0E "Writing an Emulator")

See my [MAGFest 2020](https://www.magfest.org/) presentation on this emulator here:

[![Adventures in Writing an Emulator](https://img.youtube.com/vi/kO0rGXFjIA8/0.jpg)](https://www.youtube.com/watch?v=kO0rGXFjIA8 "Adventures in Writing an Emulator")

Notes on the systems in progress:

- [Commodore 64](doc/c64.md)
- [Commodore 128](doc/c128.md)
- [Pac-Man](doc/pacman.md)
- and Ms. Pac-Man
- [Galaga](doc/galaga.md)

Development notes:

- [Memory](doc/memory.md)
- [MOS Technology 6502 series processor](doc/m6502.md)
- [Pac-Man](https://github.com/blackchip-org/retro-cs/blob/master/doc/pacman.md#development-notes)
- [Zilog Z80 processor](doc/z80.md)

## Requirements

Go and SDL2 are needed to build the application.

### Linux

Install SDL with:

```bash
sudo apt-get install libsdl2{,-image,-mixer,-ttf,-gfx}-dev
```

Install go from here:

https://golang.org/dl

### macOS

Install go and SDL with:

```bash
brew install go sdl2{,_image,_mixer,_ttf,_gfx} pkg-config
```

### Windows

It's never easy on Windows. Go needs to use mingw to compile the SDL bindings. Follow the instructions on the go-sdl2 page:

https://github.com/veandco/go-sdl2#requirements

Install go from here:

https://golang.org/dl

### ROMs

ROMs are not included in this repository. Follow the directions for each system to obtain the proper ROMs or ask for the resource pack.

## Installation

```
go get github.com/blackchip-org/retro-cs/...
```

## Run

```
~/go/bin/retro-cs -s
```

where `` is one of the following:

- `c64`
- `c128`
- `galaga`
- `mspacman`
- `pacman`

Use the `-m` flag to enable the [monitor](doc/monitor.md).

Escape key to exit if in full screen mode.

## License

MIT