Palette Mapper

Make any image fit your color scheme

What is this?

Palette Mapper is split into 3 different things:

• The core library (located at lib/). This holds the implementation for taking a color palette and mapping it onto an image.

• An accompanying CLI (located at cli/). This allows you to interact with the library from your terminal.

• The website (located at web/). This enables you to use the library from the comfort of your browser.

🚧 TODO 🚧

0.1 release

• web

  • Notifications (see ./web/src/lib/ui_notification.ts)

  • Make it look better

    • Change color scheme (dependent on selected palette?)

    • Add grid to background

    • Show image output location

      • Before and after?

    • Allow toggling light and dark mode

  • Cleanup (remove stray console.logs, etc.)

• Finish other todos

---

Other (lower priority)

• web

  • allow clicking on image to bring up preview pop-up

• Implement more distance algorithms

  • CIEDE2000

  • CIE Hybrid

  • CIE76 LAB

  • Manhattan Distance

• Add caching to the ci

• (Possibly) Expand options for cli

  • Blurs

  • Batch processing

  • Lightening

---

Done

• Add examples

• Add pre-defined palettes

• Add checks for misspelling of palette

• Create web

• Add testing

  • Benchmarking with hyperfine for cli

  • e2e testing for web

  • CI

  • Benchmarking with criterion for lib

  • Snapshot testing for lib

• cli

  • completions (via clap-complete)

🖼️ Examples 🖼️

Tokyo Rail

Images

Chicago

Images

NYC Subway

Images

CLI completions

We use clap-complete's unstable-dynamic feature to generate completions.

To generate completions run (see clap-complete's docs for more info):

echo "source <(COMPLETE=bash your_program)" >> ~/.bashrc

💝 Acknowledgments 💝

• Thanks to the creators of image for their amazing library, without which this project would not have been possible.

• Thanks to Tinted Theming for their great collection of schemes used to create the built-in palettes found under ./palettes/

📜 License 📜

Examples

• ./assets/examples/tokyo_rail.jpg by Nicholas Cole is licensed under CC BY 2.0. Source: https://www.flickr.com/photos/ncole458/4869138986/in/photostream/

• ./assets/examples/chicago.jpg by Sarthak Banga is in the Public Domain. Source: https://www.pexels.com/photo/snowy-chicago-twilight-skyline-with-lake-michigan-35613845/

• ./assets/examples/nyc_subway.jpg by Sarthak Banga is in the Public Domain. Source: https://www.pexels.com/photo/night-train-passing-through-snowy-chicago-streets-35449810/

The palettes found in ./palettes/base16/ and ./palettes/base24/ are derived (using ./fetch-palettes.sh) from Tinted Theming and are licensed under MIT.

This project is dual licensed under MIT and Apache-2.0