Skip to contents

bittermelon: Bitmap Tools

Source: R/bittermelon-package.R
bittermelon.Rd

Provides functions for creating, modifying, and displaying bitmaps including printing them in the terminal. There is a special emphasis on monochrome bitmap fonts and their glyphs as well as colored pixel art/sprites. Provides native read/write support for the 'hex' and 'yaff' bitmap font formats and if 'monobit' https://github.com/robhagemans/monobit is installed can also read/write several additional bitmap font formats.

Package options

The following bittermelon options may be set globally via base::options():

bittermelon.bg

Set new default bg argument value for format.bm_bitmap(), format.bm_pixmap(), print.bm_bitmap(), and print.bm_pixmap().

bittermelon.col

Set new default col argument value for as.raster.bm_bitmap() and plot.bm_bitmap().

bittermelon.compress

Set new default compress argument value for format.bm_bitmap(), format.bm_pixmap(), print.bm_bitmap(), and print.bm_pixmap().

bittermelon.downscale

Set new default downscale argument value for format.bm_bitmap(), format.bm_pixmap(), print.bm_bitmap(), and print.bm_pixmap().

bittermelon.fg

Set new default fg argument value for format.bm_bitmap() and print.bm_bitmap().

bittermelon.monobit_path

Set new default monobit_path argument value for read_monobit() and write_monobit().

bittermelon.px

Set new default px argument value for format.bm_bitmap() and print.bm_bitmap(). If unset both functions default to px_auto().

The following cli options may also be of interest:

cli.num_colors

See cli::num_ansi_colors(). If set to 1L then the cli package won't add any ANSI sequences.

cli.unicode

Whether UTF-8 character support should be assumed. Used by px_auto() which is the default of the bittermelon.px option.

See also

Useful links:

Author

Maintainer: Trevor L. Davis trevor.l.davis@gmail.com (ORCID)

Other contributors:

  • Frederic Cambus (Developer of included 'Spleen' font) [typographer]

  • Markus Kuhn (Maintainer of included 'Fixed' font) [typographer]

  • josehzz (Artist of included 'Farming Crops 16x16' sprites) [artist]