Leahnaya/sprites
1
0
Fork 0
mirror of https://github.com/smogon/sprites.git synced 2026-09-26 11:17:11 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Document compression settings

Browse Source
This commit is contained in:
Christopher Monsanto
2020-05-01 03:06:49 -04:00
parent f8bc65549d
commit a7183cbc47
1 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -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.