From a1e0cce3b251c81b8d18f9cd339dbe21750887fc Mon Sep 17 00:00:00 2001 From: toivoh Date: Wed, 18 Sep 2024 07:58:39 +0200 Subject: [PATCH] docs(tt_um_toivoh_demo_deluxe): Update docs --- .../tt_um_toivoh_demo_deluxe/docs/info.md | 29 ++++++++++++------- 1 file changed, 19 insertions(+), 10 deletions(-) diff --git a/projects/tt_um_toivoh_demo_deluxe/docs/info.md b/projects/tt_um_toivoh_demo_deluxe/docs/info.md index dde03f2..6565a6c 100644 --- a/projects/tt_um_toivoh_demo_deluxe/docs/info.md +++ b/projects/tt_um_toivoh_demo_deluxe/docs/info.md @@ -11,17 +11,24 @@ You can also include images in this folder and reference them in the markdown. E Curly / Medieval presents -![Sequential Shadows logo](sequential-shadows.png) +![](sequential-shadows.png) my contribution to the Tiny Tapeout 8 demo competition. Code, graphics, and music by Curly (Toivo Henningsson) of Medieval. This is the deluxe version, with Pmod VGA RGB444 output support and a few changes from the original, in 2x2 tiles compared to the original's 1x2. +The demo can be seen at https://youtu.be/pkiTu3iLA_U (captured from a Verilator simulation). + +## How it works + +See the documentation for the original version: https://github.com/toivoh/tt08-demo/blob/main/docs/info.md / Tiny Tapeout 8 project [770]. +The deluxe version adds some tweaks such as a shadow beneath the logo, and credits. + ## How to test -Plug in a [TinVGA](https://github.com/mole99/tiny-vga) compatible Pmod on the TT08 demo board's out Pmod. -Plug in a Pmod compatbile with [Mike's audio Pmod](https://github.com/MichaelBell/tt-audio-pmod) compatible Pmod on the TT08 demo board's bidir Pmod. +Plug in a [TinyVGA](https://github.com/mole99/tiny-vga) compatible Pmod on the TT08 demo board's out Pmod. +Plug in a Pmod compatible with [Mike's audio Pmod](https://github.com/MichaelBell/tt-audio-pmod) on the TT08 demo board's bidir Pmod. Set all inputs to zero to get the default behavior. **Warning: The default behavior includes some flashing ligts.** Set `v_bass_off` and `v_drums_off` (keep `ui_in` at 3 instead of 0) to remove flashing. The demo starts directly after reset. @@ -32,10 +39,10 @@ This demo is best viewed with the monitor rotated 90 degrees, with the left side There is no guarantee that changing the inputs after reset is released works as intended, but it probably does. Some of the inputs provide options on how the demo is run: -- `v_bass_off`: Setting this high reduces flashing, but also turns off the bass in some parts. -- `v_drums_off`: Setting this high reduces flashing, but also turns off the drums in some parts. -- `v_bass_low`: Setting this high keeps the bass at its default octave during the entire demo, and increases flashing. -- `pause`: While this is high, the demo is paused and the sound is turned off. +- `v_bass_off`: Setting this high reduces flashing when the audio visualizer is on by turning off the bass. +- `v_drums_off`: Setting this high reduces flashing when the audio visualizer is on by turning off the drums. +- `v_bass_low`: Setting this high keeps the bass at its default octave even when the audio visualizer is on, which increases flashing. +- `pause`: While this is high, the demo is paused and the sound is turned off. Can probably be used to start the demo paused. - `step_frame`: While this is high, the the demo advances one frame per cycle. Used for testing. - `rgb444_mode`: Setting this high sets the output to RGB444 mode instead of the default RGB222 - `pmod_vga_pinout`: Setting this high enables the alternative Pmod VGA pinout. @@ -43,15 +50,17 @@ Some of the inputs provide options on how the demo is run: - The `p_` outputs are used when `pmod_vga_pinout` is high. This fits the Pmod VGA pinout. - `logo_shadow_off`: When high, removes the logo's shadow (like in the non-deluxe version). -If using A Pmod VGA as output, set `rgb444_mode` unless you want the original RGB222 experience. +If using A Pmod VGA as output, you can set `rgb444_mode` to increase the color depth, or leave it unset to get the original RGB222 experience. Please try both: which to prefer is a matter of taste. -For the demo competition, set `pmod_vga_pinout` and `rgb444_mode` if you have a Pmod VGA, and please consider if you can still hook up the sound. Don't set any of the other inputs. +For the demo competition, only use a Pmod VGA if you have one and can get sound output while using it. +If using Pmod VGA, set `pmod_vga_pinout`, and you can set `rgb444_mode` as well. Don't set any other inputs. +If using TinyVGA for output, set all inputs to zero. ## External hardware This project needs - either - - a [TinVGA](https://github.com/mole99/tiny-vga) VGA Pmod. + - a [TinyVGA](https://github.com/mole99/tiny-vga) VGA Pmod. - [Mike's audio Pmod](https://github.com/MichaelBell/tt-audio-pmod). - or a [Pmod VGA](https://digilent.com/reference/pmod/pmodvga/start) - There is no ready option to output the audio in this case, but it's still present on the same pins, so you may be able to get it out with some creative wiring, and e g feed it to [Mike's audio Pmod](https://github.com/MichaelBell/tt-audio-pmod).