Better Portable Graphics module for After Dark https://after-dark.habd.as/module/fractal-forest
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 3.6KB

Fractal Forest

Better Portable Graphics module for After Dark. Fractal Forest adds support for Fabrice Bellard’s BPG Image format.

Latest NPM version NPM downloads per month Minimum After Dark version WTFPL licensed

Setup

None required.

Installation

  1. Copy the contents of this repository into a directory called themes/fractal-forest under the root of your After Dark site.
  2. Add fractal-forest as a theme component to your After Dark site config.toml, e.g.

    theme = [
      "fractal-forest",
      "after-dark"
    ]
    
  3. Add and specify settings for the module in your After Dark site config, e.g.

    [params.modules.fractal_forest]
      enabled = true # Optional, set false to disable module
      decoders = [
        "bpgdec8", # 8-bit only javascript decoder without animation
        "bpgdec", # > 8-bit javascript decoder without animation
        "bpgdec8a" # 8-bit javascript decoder with animation
      ]
      crossorigin = "anonymous" # Optional, sets CORS attribute
    
  4. Build and deploy your After Dark site.

For additional information please see BPG Image format.

Development

For development, install Docker on your machine:

Then build the codecs with docker build.

To adjust the version of bpg used simply modify LIBBPG_VERSION in the Dockerfile for desired version and rebuild. If you’re on a multicore system adjust CPU_CORES to decrease compilation time.

Docker build produces an intermediate container image with libbpg source and result of compilation. It also copyies the codecs into a busybox image.

To access the full libbpg source run:

$ docker run -it 30c982469f98

Where 30c982469f98 is the image id of the intermediate step.

To access just the codecs run:

$ docker run -it 712e9ce47e86

Where 712e9ce47e86 is the image id of the final build step.

To update the javascript decoders in static/js/bpg run:

$ docker run --rm --entrypoint tar 712e9ce47e86 cC /var/www/ . | tar xvC static/js

Where 712e9ce47e86 is the image id of the final build step.

Reference the libbpg mirror for additional compilation settings, README and Makefile. See the Docker Documentation for help with Docker.

License

Copyright © 2018 Josh Habdas jhabdas@protonmail.com

This work is free. You can redistribute it and/or modify it under the terms of the Do What The Fuck You Want To Public License, Version 2, as published by Sam Hocevar. See the COPYING file for more details.