Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
nand2mario committed Oct 15, 2022
1 parent 2c28bb1 commit 50dde9d
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
4 changes: 4 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@

## Version history for NESTang - an NES emulator for Tang Primer 20K

v0.3, 10/15/2022 - Supporting the dock
- Support the newly released Tang Primer 20K dock. The HDMI module is no longer needed!
- Press LB to use the in-game menu to load ROMs.

v0.2.0, 10/7/2022 - The DDR3 release
* Switch to on-board DDR3 for main memory.

Expand Down
13 changes: 5 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,18 @@ This is still a work in progress. Here's what works.
* 720p HDMI video and sound output.
* PC-side loader program for game loading and controller input.
* Cycle accurate emulation quality as we nearly recreated the NES circuits.
* ~~Needs a MiSTer SDRAM module. Similar to [MiSTer](https://misterfpga.org/), SDRAM is needed for its low access latency required by emulation.~~ (v0.2 no longer needs SDRAM! :smiley:)
* ~~Needs a MiSTer SDRAM module. Similar to [MiSTer](https://misterfpga.org/), SDRAM is needed for its low access latency required by emulation.~~ (since v0.2 the SDRAM is no longer needed! :smiley:)

## Setup

Interested? Here's what you need:

* Sipeed Tang Primer 20K with Lite Carrier Board. About $30.
* Muse-Lab HDMI PMod: [aliexpress](https://www.aliexpress.com/item/3256804122775243.html) or [taobao](https://item.taobao.com/item.htm?id=671021594308).

Now wire the HDMI module up following the [wiring instructions](doc/wiring.md).
* Sipeed Tang Primer 20K (starting at $30).
* Muse-Lab HDMI PMod if you got the lite version of Tang: [aliexpress](https://www.aliexpress.com/item/3256804122775243.html) or [taobao](https://item.taobao.com/item.htm?id=671021594308). The dock version already has HDMI so you are fine. [Wiring instructions](doc/wiring.md) for lite version.

Then it's time to enjoy some NES games,
* Download a [NESTang release](https://github.com/nand2mario/nestang/releases/).
* Start **Gowin Programmer**, and program `nestang.fs` to the board. If you see a colorful NES palette, then your setup is working.
* Download the latest [NESTang release](https://github.com/nand2mario/nestang/releases/).
* Start **Gowin Programmer**, and program `nestang-lite.fs` or `nestang-doc.fs` depending which board you have. If you see a colorful NES palette, then your setup is working.
* Connect your game controller/controllers to your PC. I use a pair of old Xbox 360 controllers.
* Run `loader.exe -c COM4 games\rom.nes` (replace COM4 with your port number) to load the game `rom.nes` and run it. If it complains about missing DLLs, install [Microsoft Visual C++ Redistributable package](https://aka.ms/vs/17/release/vc_redist.x64.exe).
* Press the left button (LB) to call out the in game OSD menu. There you can load other games in the `games` directory.
Expand All @@ -43,7 +41,6 @@ See NESTang [changes.md](CHANGES.md).

Here are what I may work on when I get time. No promise though. Suggestions and pull requests are welcome!
* A way to work without a PC.
* Support Tang Primer 20K dock when it comes out. The dock comes with HDMI on-board so we have an even cleaner setup.
* Support more games.
* An enclosure?
* Cheats support.
Expand Down

0 comments on commit 50dde9d

Please sign in to comment.