https://github.com/harbaum/pacman-tangnano9k

A Pac-Man Arcade implementation for the TangNano9K using HDMI
https://github.com/harbaum/pacman-tangnano9k

arcade fpga gowin hdmi pacman tangnano9k verilog

Last synced: 8 months ago
JSON representation

A Pac-Man Arcade implementation for the TangNano9K using HDMI

• Host: GitHub
• URL: https://github.com/harbaum/pacman-tangnano9k
• Owner: harbaum
• License: gpl-3.0
• Created: 2023-08-02T17:49:14.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2025-01-25T20:25:53.000Z (9 months ago)
• Last Synced: 2025-01-25T21:21:09.658Z (9 months ago)
• Topics: arcade, fpga, gowin, hdmi, pacman, tangnano9k, verilog
• Language: VHDL
• Homepage:
• Size: 1.27 MB
• Stars: 32
• Watchers: 5
• Forks: 7
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Pac-Man on TangNano

This is the main README for original implementation on TangNano9k. For TangNano20k port, check also [README_20k](README_20k.md).

# Pac-Man on TangNano9k

A Pac-Man Arcade implementation for the [TangNano9K](https://wiki.sipeed.com/hardware/en/tang/Tang-Nano-9K/Nano-9K.html) using HDMI for video and audio output. See it in action in the

[Youtube Video](https://www.youtube.com/shorts/erQIn8R661M). The latest version supports the [use of a USB Joystick](m0sdock_usb_joystick/) as demonstrated in [this video](https://www.youtube.com/shorts/Z1DRsI0xd8o).

![Pac-Man](images/pacman_hdmi_wide.jpeg)

## Why another Pac-Man in HDL?

There are many Pac-Man implementations in HDL, especially the [great

version by MikeJ](https://www.fpgaarcade.com/kb/pacman/).  I wanted to

gain some experiences with the GoWin FPGAs and wanted to make use of

the HDMI output of the TangNano9K. So I wrote another Pac-Man using

[HDMI](https://github.com/hdl-util/hdmi).

Most existing versions recreate the original video and in a way that

outputs an upright 60hz signal with NTSC timing expecting the screen

to be mounted in portrait mode as it was in the original Arcade

machine. Such a signal can be converted to HDMI in landscape

format. But that needs a seperate frame buffer.

I wanted to implement the video to directly output a signal compatible

with modern screens. So the video logic implemented here does not work

like the original arcade machine. Instead it replaces the video logic

by something that outputs a double scanned signal with 576 lines

(576p@60hz).

By default the video is 1024x576p to nicely fit a 16:9 screen. The

game area is displayed centered with a dark blue border left and right.

The video can be configured to output a 4:3 video with a resolution

of 768x576p instead by commenting ``define WIDE` in line 4 of src/top.sv.

## ROMs

Since this project implements the hardware of the Pac-Man Arcade

machine it needs the original ROM files to run. These can

be obtained from the [Pac-Man (Midway)](https://www.bing.com/search?q=pacman+midway+arcade+rom) romset.

The ROMs need to be converted into HDL source files compatible with

the GoWin toolchain. This can either be done manually using the GoWin

IDE or via the [Python conversion tool](src/roms/bin2v.py) and [a shell script](src/roms/conv.sh).

|     ROM file    |     Contents    |   Verilog file    |     Module     | Depth | Width |

|-----------------|-----------------|-------------------|----------------|------:|------:|

| ```pacman.6e``` |   CPU ROM #1    | ```pacman_6e.v``` | pacman_6e      | 4096  |     8 |

| ```pacman.6f``` |   CPU ROM #2    | ```pacman_6f.v``` | pacman_6f      | 4096  |     8 |

| ```pacman.6h``` |   CPU ROM #3    | ```pacman_6h.v``` | pacman_6h      | 4096  |     8 |

| ```pacman.6j``` |   CPU ROM #4    | ```pacman_6j.v``` | pacman_6j      | 4096  |     8 |

| ```pacman.5e``` |   tile graphics | ```pacman_5e.v``` | pacman_5e      | 4096  |     8 |

| ```pacman.5f``` | sprite graphics | ```pacman_5f.v``` | pacman_5f      | 4096  |     8 |

| ```82s123.7f``` |   color palette | ```82s123_7f.v``` | prom_82s123_7f |    32 |     8 |

| ```82s126.4a``` |        colormap | ```82s126_4a.v``` | prom_82s126_4a |   256 |     4 |

| ```82s126.1m``` | audio wavetable | ```82s126_1m.v``` | prom_82s126_1m |   256 |     4 |

| ```82s126.3m``` | audio wavetable | ```82s126_3m.v``` | prom_82s126_3m |   256 |     4 |

The easiest way to convert these files is to place the ten ROM files

in the [src/roms](src/roms) directory and then run the

[shell script](src/roms/conv.sh).

## Usage

Convert the ROMs as described above.

Open the project file pacman.gprj from the corresponding board folder in the GoWin IDE run the synthesis, place & route and download the resulting bitstream onto the TangNano.

## Buttons

Once the game runs it can be controlled with six buttons connected to the TangNano9K

as depicted below:

![Button mapping](images/buttons.jpg)

The [pins used](tangnano9k/src/pacman.cst) are:

| Function | Pin Name | Pin No |

|----------|---------:|-------:|

| Up       |   IOB8A  |    25  |

| Down     |   IOB8B  |    26  |

| Left     |  IOB11A  |    27  |

| Right    |  IOB11B  |    28  |

| Coin     |  IOB13A  |    29  |

| Start    |  IOB13B  |    30  |

## USB joystick

You can also use a [USB joystick](m0sdock_usb_joystick/).