Font for pTAdvance (#24)

* add ubuntu font, update docs, add licenses
* detect pTAdvance & use matching font
needed to update to newer webserial pkg for this in order to be able to
detect ptAdvance by it vendor&product usb ids
* better customise font for advance

Author: maks

LICENSE

@@ -0,0 +1,49 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, 2025 xiphonics, inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+-------------------------------------------------------------------------------
+Third-Party Software and Licenses
+-------------------------------------------------------------------------------
+
+This project includes third-party software components. Each component is
+subject to its own license. Below is a summary of included external code:
+
+1. Ubuntu Mono font
+   Path: assets/fonts/UbuntuMono-Regular.ttf
+   SPDX-License-Identifier: Ubuntu-font-1.0
+   License file: docs/Ubuntu-Font-Licence-1.0.txt
+
+2. ZX-Origins fonts
+   Path: sources/Adapters/picoTracker/display/font.h
+   SPDX-License-Identifier: custom
+   License file: docs/FONT-LICENSE.md
+
+The license texts for the above components are available in their respective
+folders. This project does not relicense or modify the terms of those licenses.

README.md

@@ -8,8 +8,14 @@ The webapp [is available here](https://xiphonics.github.io/picotracker_client/).
 
 ## Getting Started
 
-Connect picotracker to usb port. On linux this will probably be `/dev/ttyACM0`
-You will need to switch between any 2 screens on the picotracker to "initialise" the display on the app.
+Connect picotracker to a usb port.
+
+Run the Flutter web app using: 
+`flutter run -d web lib/main.dart`
+
+In VSCode, with Flutter extension installed just press `F5` to run udner a debugger.
+
+The production application is deployed to: https://ui.xiphonics.com/ via GitHub Actions.
 
 ## Supported Platforms
 
@@ -21,10 +27,10 @@ You will need to switch between any 2 screens on the picotracker to "initialise"
 
 - [X] display fg/bg colours
 - [X] webapp version
-- [ ] use palette (custom colours) send from picotracker ([once supported by remoteui protocol](https://github.com/xiphonics/picoTracker/issues/263))
+- [X] use palette (custom colours) send from picotracker ([once supported by remoteui protocol](https://github.com/xiphonics/picoTracker/issues/263))
 - [X] implement notes blank *background* display of Song screen
 - [ ] reconnect port on picotracker reset (on load new project)
 - [ ] set initial window size
 - [ ] show usb port connection status
 - [X] app setting for USB port device name
-- [ ] request refresh on connect ([once supported by remoteui protocol](https://github.com/xiphonics/picoTracker/issues/263))
+- [X] request refresh on connect ([once supported by remoteui protocol](https://github.com/xiphonics/picoTracker/issues/263))

assets/fonts/UbuntuMono-Regular.ttf

@@ -0,0 +1,128 @@
+# A ZX-Origins Typeface
+
+Thank you for downloading one of the fonts in my ZX Origins collection. You will see a number of files in this download for the various formats this font is supplied in. They are as follows:
+
+## Formats
+
+### Sinclair ZX Spectrum
+
+Inside the **Spectrum** folder you will find each font has a `.ch8` file that is a RAW 768-byte file that can be loaded directly into BASIN, AGD or other Spectrum environments. Alternatively you can load it into any available RAM address and then `POKE 23606` and `23607` with the appropriate RAM address minus 256 bytes.
+
+Each font also has a `.fzx` file containing a proportional conversion of the font for use with the [FZX Proportional Font Renderer](https://github.com/z88dk/z88dk/tree/master/libsrc/_DEVELOPMENT/font/fzx) available for the ZX Spectrum. Z80 assembler-compatible files containing `defb` statements can be found in the `source` folder with the suffix `.z80.asm`.
+
+A `.tap` tape image is provided which can be either written to a physical tape, loaded in via a DivMMC or mounted in an emulator. It contains all the fonts for the given typeface complete with a built-in demonstration program that will allow all the fonts to be previewed in any color combination.
+
+### Acorn BBC Micro/Electron
+
+Inside the **BBC** folder you will find each font has a `.bbc` file that can be copied to your own discs and `*EXEC`'ed once you have set `*FX 20,7` and carved out space for them with `PAGE=&1F00`. It is recommended you `*EXEC` them from your `!BOOT` file. If you need to execute them from your own BASIC then instead you should use the [BFont](http://mdfs.net/Apps/Font/) load routine by J.G.Harston in 0/VDU mode.
+
+Additionally a DFS-formatted `.ssd` disk image is provided for use with emulators contains a demonstration program showing the fonts available for this typeface in any color combination in low, medium or high-resolution modes.
+
+### Commodore 64
+
+The **C64** folder contains two `.64c` files (raw in PETSCI order with a 2 byte extra header) - one with upper-case only and more line drawing characters (`.upper`) - and the other containing both upper and lower case (`.both`).
+
+Additionally there is a combined `.bin` file containing both the fonts in a raw format that can be used as a character ROM in an emulator or otherwise imported into your dev system.
+
+### Amstrad CPC
+
+The **CPC** folder contains a `.bas` file representing ASCII BASIC versions of the font definition for Amstrad BASIC starting at line 9000. You can use a tool such as WinAPE's "Auto Type" feature to paste this into your BASIC program. When run this code will redefine the current character set to match. Note that ZX Origins is a subset of the Amstrad CPC character set and so will not include various symbols and non-Latin characters.
+
+Alternatively a `.dsk` file is also included which contains a CPC 664/6128 DATA disk image that is ready to use. Either run them directly or `MERGE` them with your BASIC program. Ensure lines 9000-9980 are free in your program as they will be overwritten by the MERGE.
+
+### Game Boy
+
+The **GameBoy** folder contains multiple `.png` files that can be loaded into a Game Boy Studio for developing games for the Nintendo Game Boy. Each font has a regular (light), a `-dark` (inverse), and a `-var` proportional/variable-width versions. Right now only the standard Spectrum character set is represented so ASCII plus pound and copyright symbols.
+
+### Atari 8-bit
+
+The **Atari8** folder contains a `.fnt` file for each font which is the RAW font data with ATASCII ordering with line-drawing characters from the original machine set.
+
+### CoCo (Tandy Color Computer/TRS-80)
+
+Files are included ready for use with the [CoCoVGA board](http://www.cocovga.com/) which allows redefined characters. Each `.CHR` file contains a single font in RS-DOS binary format complete with standard 5-byte header and trailer configured to load at `$E00`.
+
+A `.dsk` disk image is also included containing copies of each of the fonts in the family within a 35-track Disk Basic image file produced by [CMOC](http://perso.b2b2c.ca/~sarrazip/dev/cmoc-manual.html).
+
+### PC
+
+### BDF (Glyph Bitmap Distribution Format)
+
+Standard bitmap font format used by many Windows and Mac tools. If you need to extend the character set out I would start here as it allows for large character sets etc and is still purely bitmap.
+
+### PSF (PC Screen Font)
+
+Font file capable of being used by Linux as console fonts.
+
+### TTF (TrueType font)
+
+A Windows, Mac and Linux friendly scalable version of the font. It is very hard to preserve the original bitmap sharply across platforms in a TrueType container but I've done what I can. This looks best at multiples of 8px on Windows. Experiment with other sizes or metrics as you need depending on your OS.
+
+### WOFF (Web font)
+
+A web font for older browsers and the Godot game engine.
+
+### WOFF2 (Web font)
+
+A web font for modern browsers containing a fully Brotli compressed web-friendly version of the TrueType font for use within web pages.
+
+## Other systems
+
+In the `Source` folder you will find:
+
+- C-style headers containing `static const` arrays with the suffix `.h`
+- Motorola 68000 assembler files containing `DC.B` statements with the suffix `.68000.asm`
+- Intel x86 assembler files containing `db` statements with the suffix `.x86.asm`
+- Zilog Z80 assembler files containing `defb` statements with the suffix `.z80.asm`
+- MOS 6502 assembler files containing `.byte` statements with the suffix `.6502.asm`
+
+Please note that all these files contain the raw glyphs in ASCII order with Sinclair-specific modifications:
+
+- ↑ (up-arrow) at 0x5E instead of ^ (caret) except where I've drawn them as a caret
+- £ (UK pound sign) at 0x60 instead of ` (grave accent)
+- © (copyright sign) at 0x7F instead of the DEL control code
+
+## Further conversion
+
+If you wish to convert this font to other formats the BDF file is a good starting point.
+
+Alternatively check out John Elliot's PSFTOOLS which can turn the .psf file included into BBC, Wyse, C code, FNT and others formats. I would recommend however sticking with the TTF and WOFF2 for scalable versions as they have been carefully optimized to reduce smoothing at specific sizes.
+
+Many of the conversions are achieved using my open-source [PixelWorld tool](https://github.com/damieng/pixelworld).
+
+I may include additional formats in future updates of ZX Origins if there is demand.
+
+## Thanks
+
+My sincere thanks to:
+
+- [John Elliot](https://www.seasip.info/) for his amazing [psftools](https://www.seasip.info/Unix/PSF/) which helped streamline the process.
+- [Paul van der Laan](http://type-invaders.com) for lending his expertise and research into how to make 8x8 bitmap fonts perfect in [FontLab Studio 5](https://www.fontlab.com/font-editor/fontlab-studio-5/).
+- [Paul Dunn](https://github.com/ZXDunny) for the BASIN editor that is my 8x8 bitmap font designer of choice
+- [Arda Erdikmen](https://github.com/ref-xx) for improvements to [BASIN](https://github.com/ref-xx/basinc)
+- [Santiago Crespo](https://gameboys.es/) for all his help in getting the GameBoy Studio versions right
+- [J.G.Harston](https://mdfs.net/) for the BBC font-loading routines [BFont](https://mdfs.net/Apps/Font/) and the [mkimg tool](https://mdfs.net/Apps/DiskTools/) used to automate .ssd creation
+- The team behind [iDSK](https://github.com/cpcsdk/idsk) used to prepare the Amstrad CPC disk images
+- To Brendan Donahe for the [CoCoVGA](http://cocovga.com/about/) scripts and conversion tool
+
+## Licence
+
+This font is part of the ZX Origins font collection Copyright (c) 1988-2023 Damien Guard.
+
+Formal licenses are complicated and burdensome so here's the deal. These are some acceptable use examples:
+
+1. Use it in your game (commercial or non-commercial)
+2. Print something on a t-shirt
+3. Use the embedded font file on your site
+4. Set your favorite terminal or OS to use it
+
+Ideally with a credit like "<fontname> font by DamienG https://damieng.com/zx-origins" _if_ you have a credits section. If you don't that's fine. Either way dropping me an email at damieng@gmail.com to let me know what you used it for **is appreciated**.
+
+The only prohibited use is redistributing this font as a font. i.e. re-hosting the files on your own site or bundling it with other art assets or using it to create assets. I have put a lot of time into these and my only reward is seeing download counts on my site which is ad-free so it seems unfair other people would re-host these files on their site and make $ from Google AdWords etc.
+
+If you need to modify the font for your usage - either to add characters (this collection is pure ASCII + copyright + UK pound sign right now) or if a few are bothering you just change the credit to "Font based on <fontname> by DamienG" or something.
+
+Thanks and enjoy!
+
+[)amien
+https://damieng.com/zx-origins/

docs/FONT-LICENSE.md

@@ -0,0 +1,96 @@
+-------------------------------
+UBUNTU FONT LICENCE Version 1.0
+-------------------------------
+
+PREAMBLE
+This licence allows the licensed fonts to be used, studied, modified and
+redistributed freely. The fonts, including any derivative works, can be
+bundled, embedded, and redistributed provided the terms of this licence
+are met. The fonts and derivatives, however, cannot be released under
+any other licence. The requirement for fonts to remain under this
+licence does not require any document created using the fonts or their
+derivatives to be published under this licence, as long as the primary
+purpose of the document is not to be a vehicle for the distribution of
+the fonts.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this licence and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Original Version" refers to the collection of Font Software components
+as received under this licence.
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to
+a new environment.
+
+"Copyright Holder(s)" refers to all individuals and companies who have a
+copyright ownership of the Font Software.
+
+"Substantially Changed" refers to Modified Versions which can be easily
+identified as dissimilar to the Font Software by users of the Font
+Software comparing the Original Version with the Modified Version.
+
+To "Propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification and with or without charging
+a redistribution fee), making available to the public, and in some
+countries other activities as well.
+
+PERMISSION & CONDITIONS
+This licence does not grant any rights under trademark law and all such
+rights are reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of the Font Software, to propagate the Font Software, subject to
+the below conditions:
+
+1) Each copy of the Font Software must contain the above copyright
+notice and this licence. These can be included either as stand-alone
+text files, human-readable headers or in the appropriate machine-
+readable metadata fields within text or binary files as long as those
+fields can be easily viewed by the user.
+
+2) The font name complies with the following:
+(a) The Original Version must retain its name, unmodified.
+(b) Modified Versions which are Substantially Changed must be renamed to
+avoid use of the name of the Original Version or similar names entirely.
+(c) Modified Versions which are not Substantially Changed must be
+renamed to both (i) retain the name of the Original Version and (ii) add
+additional naming elements to distinguish the Modified Version from the
+Original Version. The name of such Modified Versions must be the name of
+the Original Version, with "derivative X" where X represents the name of
+the new work, appended to that name.
+
+3) The name(s) of the Copyright Holder(s) and any contributor to the
+Font Software shall not be used to promote, endorse or advertise any
+Modified Version, except (i) as required by this licence, (ii) to
+acknowledge the contribution(s) of the Copyright Holder(s) or (iii) with
+their explicit written permission.
+
+4) The Font Software, modified or unmodified, in part or in whole, must
+be distributed entirely under this licence, and must not be distributed
+under any other licence. The requirement for fonts to remain under this
+licence does not affect any document created using the Font Software,
+except any version of the Font Software extracted from a document
+created using the Font Software may only be distributed under this
+licence.
+
+TERMINATION
+This licence becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF
+COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM OTHER
+DEALINGS IN THE FONT SOFTWARE.

docs/UFL.txt

@@ -11,6 +11,9 @@ import 'commands.dart';
 import 'pico_app.dart';
 import 'widgets/pico_screen.dart';
 
+// just simple global for now
+late final SerialPortHandler serialHandler;
+
 class MainScreen extends StatefulWidget {
   const MainScreen({super.key});
 
@@ -25,7 +28,6 @@ class _MainScreenState extends State<MainScreen> {
   StreamSubscription? cmdStreamSubscription;
   final _grid = ScreenCharGrid();
   final cmdBuilder = CmdBuilder();
-  late final SerialPortHandler serialHandler;
 
   StreamSubscription? usbUdevStream;
 
@@ -49,7 +51,8 @@ class _MainScreenState extends State<MainScreen> {
             _grid.setColor(cmd.r, cmd.g, cmd.b);
             break;
           case FontCmd():
-            fontNotifier.value = PtFont.values[cmd.index];
+            final offset = serialHandler.isAdvance() ? AdvFontOffSet : 0;
+            fontNotifier.value = PtFont.values[cmd.index + offset];
             break;
         }
       });

lib/main_screen.dart

@@ -3,9 +3,12 @@
 import 'package:flutter/material.dart';
 import 'package:picotracker_client/main_screen.dart';
 
+const AdvFontOffSet = 2;
+
 enum PtFont {
   Hourglass,
   YouSquared,
+  Ubuntu_Mono,
 }
 
 final fontNotifier = ValueNotifier<PtFont>(PtFont.Hourglass);
@@ -23,7 +26,7 @@ class PicoApp extends StatelessWidget {
           theme: ThemeData(
             colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
             useMaterial3: true,
-            fontFamily: fontNotifier.value.name,
+            fontFamily: fontNotifier.value.name.replaceAll("_", " "),
           ),
           home: const MainScreen(),
         );

lib/pico_app.dart

@@ -37,6 +37,9 @@ class SerialPortHandler {
     }
   }
 
+  // TODO:
+  bool isAdvance() => false;
+
   void _initPort() {
     debugPrint("Init Port");
     try {

lib/serialport_native.dart

@@ -6,4 +6,6 @@ class SerialPortHandler {
   void chooseSerialDevice() async {}
 
   bool isConnected() => false;
+
+  bool isAdvance() => false;
 }