v0.30.3 Bugfixes

Author: SweMonkey

changelog.txt

@@ -1,3 +1,25 @@
+v0.30.3:
+Terminal: 16 colour support for the 4x8 font. Achieved by sacrificing the inverted character set (only when using 16 colour 4x8!).
+Terminal: Added the "tty" command; it initializes the SMDTC TTY to a sane enviroment for a linux tty, although still somewhat iffy and some functionality is still missing.
+Terminal: Added support for DECCKM (Cursor Key Format). "Cursor", "Numpad cursor", "Home" and "End" keys should now switch reporting mode correctly.
+Terminal: Control characters can now be entered by pressing CTRL + <key>, for example: CTRL+C will send ^C.
+Terminal: History queue can now store 2 commands.
+UI: Added preliminary ColourPicker, Tab and ConfirmBox widget, these will be finalized later on. These widgets can be tested in the UI tester; Quick menu -> Debug -> UI Tester.
+Misc: Boot prompt now uses the terminal instead of the drawing on its own to the window plane. This allows for much better printing, colour and scrolling support if needed.
+
+Fixes:
+Terminal: Mode set/reset in parser got broken in an earlier commit. Escape sequences such as "ESC[?Ⓝh" should now work again, applications such as nano now renders properly again.
+Terminal: Added a few skeleton escape codes, ie doing the bare minimum to handle them for now so they don't mess with previous/following escape codes.
+DevMgr: Joypad was set to a weird state after the PS/2 keyboard detected scan iterated through all ports, which caused a few buttons to not work on joypads.
+Drivers: The PS/2 keyboard detection scan will now only scan ports with an unknown ID, this is to avoid disturbing devices which for certain is not a PS/2 keyboard.
+Drivers: Hopefully fixed the XPN driver for the last time; Pinging does not get stuck in monitor mode any more.
+Misc cursor fixes; due to earlier optimizations the cursor Y position did not always get updated.
+Misc fixes in 4x8 font tilesets; 1 stray pixel in one character and 1 missing pixel in another character. The characters in question are used for line drawing.
+
+Known bugs:
+IRC: Nick list is missing 1 nick, see command 353 in IRC.c
+IRC: Erroneous string comparison in command 353, in IRC.c
+
 v0.30.2:
 Telnet/Terminal: Erroneously cleared the entire next row of text every time a newline+carridge return was encountered, this should only be done when also scrolling down to a new line.
 IRC: The typing input box at the bottom now uses DMA VRAM copy. Previously a new single tile was uploaded to VRAM for every character you typed.
@@ -9,7 +31,7 @@ Misc: Slimmed UTF8 tables down from 256 bytes to 64 bytes for every table. Now o
 Misc: Added doxygen comments to the PS/2 keyboard functions.
 Misc: Date function added to terminal. Used to sync to a time server and to print the current date.
 FixMe: IRC: Nick list is missing 1 nick, see command 353 in IRC.c .
-FixMe: IRC: Erroneous string comparision in command 353, in IRC.c .
+FixMe: IRC: Erroneous string comparison in command 353, in IRC.c .
 
 v0.30.1:
 SMDTC: FAT12/16/32 support, file operations and other misc functions added for testing purposes. Disabled by default.

doc/CRAM.txt

@@ -0,0 +1,41 @@
+CRAM Setup
+Note: 0-based numbering, meaning row goes from 0 to 3 and column goes from 0 to 15
+
+
+Row     Column      Usage                                               Index
+0       0           Background colour                                   0
+0       1           Red icon colour                                     1
+0       2           Window title foreground                             2
+0       3           Window title background                             3
+0       4           Cursor colour                                       4
+0       5           Icon background                                     5
+0       6           Normal icon colour                                  6
+0       7           Green icon colour                                   7
+
+1       1           Window text BG Normal / Terminal text BG            17
+1       2           Window text FG Normal                               18
+1       3           Window inner BG                                     19
+1       4           Window title BG                                     20
+1       5           Window shadow                                       21
+1       6           Window border                                       22
+1       7           Colour picker (Reserved)                            23
+
+3       2           Window text FG Inverted                             50
+3       3           Window text BG Inverted                             51
+
+3       6           Screensaver colour 0                                54
+3       7           Screensaver colour 1                                55
+
+0       8-15        4+4 colours for 16 colour 4x8 fonts (Text+AA)        8 ... 15
+1       8-15        4+4 colours for 16 colour 4x8 fonts (Text+AA)       24 ... 31
+2       8-15        4+4 colours for 16 colour 4x8 fonts (Text+AA)       40 ... 47
+3       8-15        4+4 colours for 16 colour 4x8 fonts (Text+AA)       56 ... 63
+
+0       12-15       2+2 colours for 8 colour 4x8 fonts (Text+AA)        12 ... 15
+1       12-15       2+2 colours for 8 colour 4x8 fonts (Text+AA)        28 ... 31
+2       12-15       2+2 colours for 8 colour 4x8 fonts (Text+AA)        44 ... 47
+3       12-15       2+2 colours for 8 colour 4x8 fonts (Text+AA)        60 ... 63
+
+2       0-15        16 colours for 8x8 fonts                            32 ... 47
+Row     Column      Usage                                               Index
+

readme.md

@@ -1,20 +1,30 @@
 
 # SMD Terminal emulator, Telnet and IRC client v0.30+
-A terminal emulator, telnet and IRC client for the Sega Mega Drive/Genesis with support for PS/2 keyboards and RS-232 communication.<br>
+A terminal emulator, telnet and IRC client for the Sega Mega Drive/Genesis with support for keyboards and RS-232 communication.<br>
 ![Screenshot of the telnet client](https://deceptsoft.com/smdtc_extra_git/v30/telnet_small.png)
 ![Screenshot of the IRC client](https://deceptsoft.com/smdtc_extra_git/v30/irc_small.png)
 ![Screenshot of the terminal emulator showing nano](https://deceptsoft.com/smdtc_extra_git/v30/blastem_20240401_104314.png)
 ![Screenshot of a debugging utility to inspect streams](https://deceptsoft.com/smdtc_extra_git/v30/hexview_small.png)
 ![Screenshot of the telnet client in 80 column + 8 colour mode](https://deceptsoft.com/smdtc_extra_git/v30/blastem_20240401_203819.png)
 ![Screenshot of the terminal emulator](https://deceptsoft.com/smdtc_extra_git/v30/blastem_20240505_222454.png)
 
-Extra hardware:<br>
-A PS/2 keyboard or a Sega Saturn keyboard (not required but preferred).<br>
-A "voltage translator" to translate between the MD +5v and remote RS232 device logic levels,<br>
-I personally recommend the max3232 (https://www.ti.com/lit/ds/symlink/max3232.pdf)<br>
-<br>
-xPico/RetroLink support as an alternative to the above is being worked on.<br>
-<br>
+##### Table of Contents
+* [Disclaimer](#disclaimer)
+* [Thanks](#thanks-to)
+* [Building from source](#building-smdtc-from-source)
+* [Running SMDTC](#running-smdtc)
+* [Required hardware](#required-hardware)
+* [Devices](#devices)
+  * [Autodetected devices](#list-of-autodetected-devices)
+  * [How to wire up a PS/2 keyboard](#how-to-wire-up-a-ps2-keyboard)
+  * [Pin configuration of the MD controller ports](#pin-configuration-of-the-md-controller-ports)
+  * [PS/2 pin reference](#ps2-pin-reference)
+  * [MD UART pin reference](#md-uart-pin-reference)
+* [Shortcuts](#shortcuts)
+  * [Quick menu](#quick-menu)
+  * [IRC client](#irc-client)
+  * [Telnet client](#telnet-client)
+  * [Terminal emulator](#terminal-emulator)
 
 ## Disclaimer
 > [!WARNING]
@@ -28,6 +38,7 @@ xPico/RetroLink support as an alternative to the above is being worked on.<br>
 b1tsh1ft3r - Testing, improvement ideas and RetroLink/xPico support<br>
 RKT - For creating a 4x8 extended ASCII font tileset<br>
 Stef - For creating [SGDK](https://github.com/Stephane-D/SGDK)<br>
+Sik - For creating the website [Plutiedev](https://plutiedev.com/) with valuable information regarding the MD<br>
 <br>
 
 ## Building SMDTC from source
@@ -36,6 +47,23 @@ Stef - For creating [SGDK](https://github.com/Stephane-D/SGDK)<br>
 The SGDK library must be rebuilt with the flags `HALT_Z80_ON_IO` and `HALT_Z80_ON_DMA` set to 0 in config.h to make sure the z80 CPU is never getting its bus back.<br>
 <br>
 
+## Running SMDTC
+SMDTC is made to run on the original Mega Drive / Genesis hardware;<br>
+Easiest way to run SMDTC on your system is by transferring the binary file `smdt_vX.YY.Z.bin` to a flashcart.<br>
+<br>
+You can also run SMDTC in a Mega Drive / Genesis emulator and easily check it out; Do mind that most emulators do not provide any way to actually connect any external serial devices, so no network support is possible while running in an emulator.<br><br>
+I highly recommend the emulator [BlastEm](https://www.retrodev.com/blastem/nightlies/) since it supports the Sega Saturn keyboard.<br>
+Other emulators may have issues running SMDTC and it is unlikely they will have any keyboard support.
+<br>
+
+## Required hardware
+1. A PS/2 keyboard or a Sega Saturn keyboard (not strictly required but preferred).
+2. A **5 volt** RS-232 serial connection or an xPico/xPort module.
+3. A Mega Drive or Genesis and a way to run roms on it.
+<br>
+
+RetroLink network cartridge as an alternative network adapter is being worked on.<br>
+
 ## Devices
 SMDTC has a device manager which can autodetect if a device is present and where it is plugged in.<br>
 Device detection is only done on bootup, no plug & play support (yet).<br>
@@ -48,18 +76,18 @@ A fallback joypad device will be activated if SMDTC fails to find a keyboard or
 All detected devices can be viewed in the "Connected devices" list (Quick menu -> Mega Drive settings -> Connected devices)<br>
 <br>
 > [!NOTE]
-> SMDTC is limited when it comes to detecting the presence of a serial connection on the built in UART (Only an xPico module can be autodetected)<br>
-> By default SMDTC will listen for incoming connections on PORT 2 UART.<br>
+> SMDTC is limited when it comes to detecting the presence of a serial connection on the built in UART.<br>
+> By default SMDTC will listen for incoming connections and attempt to find serial devices on PORT 2 UART.<br>
 > This setting can be changed in the "Select serial port" menu (Quick menu -> Mega Drive settings -> Select serial port)<br>
 > Do not forget to save your changes! (Quick menu -> Reset -> Save config to sram)<br>
 <br>
 
-### List of autodetected devices that require no configuration
+### List of autodetected devices
 PS/2 Keyboard.<br>
 Sega Saturn keyboard.<br>
 Sega 3/6 button joypad.<br>
-xPico module connected to built in UART (Currently being worked on, support may be iffy)<br>
-RetroLink network adapter cartridge  (Currently being worked on, support may be iffy)<br>
+xPico module connected to built in UART (May require you to set the correct serial port as described above)<br>
+RetroLink network adapter cartridge (Currently being worked on, support may be iffy)<br>
 <br>
 
 ### How to wire up a PS/2 keyboard
@@ -80,7 +108,7 @@ MD port pin 8 = PS/2 GND pin 3<br>
 See the pin configuration lists below for pinouts of the MD controller ports and PS/2 keyboard.<br>
 <br>
 
-### Pin configuration of the MD controller ports: 
+### Pin configuration of the MD controller ports
 MD port pin 1 = PS/2 device 1 clock  (CLK1)<br>
 MD port pin 2 = PS/2 device 1 data   (DATA1)<br>
 MD port pin 3 = PS/2 device 2 clock  (CLK2)<br>
@@ -91,19 +119,19 @@ MD port pin 7 = Reserved             (CP3)<br>
 MD port pin 8 = GND<br>
 MD port pin 9 = Serial RX<br>
 
-### PS/2 pin reference:
+### PS/2 pin reference
 PS/2 pin 1 = Data<br>
 PS/2 pin 3 = GND<br>
 PS/2 pin 4 = VCC<br>
 PS/2 pin 5 = Clock<br>
 
-### MD UART pin reference:
+### MD UART pin reference
 MD port pin 5 = VCC<br>
 MD port pin 6 = TX<br>
 MD port pin 8 = GND<br>
 MD port pin 9 = RX<br>
 
-### Connected device list:
+### Connected device list
 P1:0 = Port 1 @ pin 1+2<br>
 P1:1 = Port 1 @ pin 3+4<br>
 P1:S = Port 1 UART<br>
@@ -117,14 +145,16 @@ P3:1 = Port 3 @ pin 3+4<br>
 P3:S = Port 3 UART<br>
 P3:D = Port 3 Parallel+UART Mode<br>
 
-## Quick menu shortcuts
+## Shortcuts
+
+### Quick menu
 Right windows key OR F8 = Open the Quick menu<br>
 Enter = Enter submenu and activate a choice<br>
 Escape = Back out of current menu<br>
 Up cursor = Move selector up<br>
 Down cursor = Move selector down<br>
 
-## IRC client shortcuts
+### IRC client
 F1  = Channel 1 tab<br>
 F2  = Channel 2 tab<br>
 F3  = Channel 3 tab<br>
@@ -137,13 +167,12 @@ Tab = Toggle channel user list<br>
 Numpad 4 = Scroll left<br>
 Numpad 6 = Scroll right<br>
 
-## Telnet client shortcuts
-F11 = Send ^C to remote server<br>
-F12 = Send ^X to remote server<br>
-Numpad 1 = Scroll left<br>
-Numpad 3 = Scroll right<br>
+### Telnet client
+F1  = Scroll left<br>
+F2  = Scroll right<br>
 
-## Terminal emulator
+### Terminal emulator
 Type `help` for a list of all available built in commands.<br>
-Up arrow   = Retype last entered string<br>
-Down arrow = Clear current typed string<br>
+<br>History queue:<br>
+Up arrow   = Go back in history of entered command strings.<br>
+Down arrow = Go forward in history or clear command string if at the last entered command string.<br>