From a7183cbc478ecc85b7ff079c9a5b02c573acc9e6 Mon Sep 17 00:00:00 2001 From: Christopher Monsanto Date: Fri, 1 May 2020 03:06:49 -0400 Subject: [PATCH] Document compression settings --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 40759f1f..88173a82 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,21 @@ Install dependencies once with `pnpm install`. Then, to build: $ tup ``` +## Configuration + +Build settings are configurable in `tup.config`. + +- `CONFIG_DEFAULT_OPTIPNG`: Command line to pass to `optipng`. +- `CONFIG_DEFAULT_ADVPNG`: Command line to pass to `advpng`. +- `CONFIG_TRAINERS_{OPTIPNG,ADVPNG}`: Compression options for `trainers/` only. +- `CONFIG_DEX_{OPTIPNG,ADVPNG}`: Compression options for `dex/` only. + +For example, these settings reflect the compression settings for the files chaos uploaded in `src/`: +``` +CONFIG_DEFAULT_OPTIPNG=-o7 +CONFIG_DEFAULT_ADVPNG=-z4 -i5000 +``` + ## Filename Scheme Pokemon sprite filenames are in a 1-to-1 correspondence with the Pokemon's name, for ease of processing. Filenames may be directly substituted in shell commands without escaping. This naming scheme means that some of the filenames in `src/` are a little awkward looking to humans, but it means that no additional data beyond what is encoded in the filesystem is required to determine the correct name for any given Pokémon.