make_font.py (4049B)
1 """This script automates the conversion of font files into a format QMK firmware understands. 2 """ 3 4 from io import BytesIO 5 from qmk.path import normpath 6 from qmk.painter_qff import _generate_font_glyphs_list, QFFFont 7 from qmk.painter import generate_subs, render_header, render_source, valid_formats 8 from milc import cli 9 10 11 @cli.argument('-f', '--font', required=True, help='Specify input font file.') 12 @cli.argument('-o', '--output', required=True, help='Specify output image path.') 13 @cli.argument('-s', '--size', default=12, help='Specify font size. Default 12.') 14 @cli.argument('-n', '--no-ascii', arg_only=True, action='store_true', help='Disables output of the full ASCII character set (0x20..0x7E), exporting only the glyphs specified.') 15 @cli.argument('-u', '--unicode-glyphs', default='', help='Also generate the specified unicode glyphs.') 16 @cli.argument('-a', '--no-aa', arg_only=True, action='store_true', help='Disable anti-aliasing on fonts.') 17 @cli.subcommand('Converts an input font to something QMK understands') 18 def painter_make_font_image(cli): 19 # Create the font object 20 font = QFFFont(cli) 21 # Read from the input file 22 cli.args.font = normpath(cli.args.font) 23 font.generate_image(cli.args.font, cli.args.size, include_ascii_glyphs=(not cli.args.no_ascii), unicode_glyphs=cli.args.unicode_glyphs, use_aa=(False if cli.args.no_aa else True)) 24 # Render out the data 25 font.save_to_image(normpath(cli.args.output)) 26 27 28 @cli.argument('-i', '--input', help='Specify input graphic file.') 29 @cli.argument('-o', '--output', default='', help='Specify output directory. Defaults to same directory as input.') 30 @cli.argument('-n', '--no-ascii', arg_only=True, action='store_true', help='Disables output of the full ASCII character set (0x20..0x7E), exporting only the glyphs specified.') 31 @cli.argument('-u', '--unicode-glyphs', default='', help='Also generate the specified unicode glyphs.') 32 @cli.argument('-f', '--format', required=True, help=f'Output format, valid types: {", ".join(valid_formats.keys())}') 33 @cli.argument('-r', '--no-rle', arg_only=True, action='store_true', help='Disable the use of RLE to minimise converted image size.') 34 @cli.argument('-w', '--raw', arg_only=True, action='store_true', help='Writes out the QFF file as raw data instead of c/h combo.') 35 @cli.subcommand('Converts an input font image to something QMK firmware understands') 36 def painter_convert_font_image(cli): 37 # Work out the format 38 format = valid_formats[cli.args.format] 39 40 # Create the font object 41 font = QFFFont(cli.log) 42 43 # Read from the input file 44 cli.args.input = normpath(cli.args.input) 45 font.read_from_image(cli.args.input, include_ascii_glyphs=(not cli.args.no_ascii), unicode_glyphs=cli.args.unicode_glyphs) 46 47 # Work out the output directory 48 if len(cli.args.output) == 0: 49 cli.args.output = cli.args.input.parent 50 cli.args.output = normpath(cli.args.output) 51 52 # Render out the data 53 out_data = BytesIO() 54 font.save_to_qff(format, not cli.args.no_rle, out_data) 55 out_bytes = out_data.getvalue() 56 57 if cli.args.raw: 58 raw_file = cli.args.output / f"{cli.args.input.stem}.qff" 59 with open(raw_file, 'wb') as raw: 60 raw.write(out_bytes) 61 return 62 63 # Work out the text substitutions for rendering the output data 64 metadata = {"glyphs": _generate_font_glyphs_list(not cli.args.no_ascii, cli.args.unicode_glyphs)} 65 subs = generate_subs(cli, out_bytes, font_metadata=metadata, command_name="painter_convert_font_image") 66 67 # Render and write the header file 68 header_text = render_header(subs) 69 header_file = cli.args.output / f"{cli.args.input.stem}.qff.h" 70 with open(header_file, 'w') as header: 71 print(f"Writing {header_file}...") 72 header.write(header_text) 73 74 # Render and write the source file 75 source_text = render_source(subs) 76 source_file = cli.args.output / f"{cli.args.input.stem}.qff.c" 77 with open(source_file, 'w') as source: 78 print(f"Writing {source_file}...") 79 source.write(source_text)