From ab20125bfe23d5b9b09700c9be0fe2597061793c Mon Sep 17 00:00:00 2001 From: Brandon Liu Date: Thu, 9 May 2024 13:44:25 +0800 Subject: [PATCH] add sprites docs (#245) --- sprites/README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 sprites/README.md diff --git a/sprites/README.md b/sprites/README.md new file mode 100644 index 00000000..b6df27b9 --- /dev/null +++ b/sprites/README.md @@ -0,0 +1,13 @@ +# Sprites + +You will need a Rust compiler. + +`cargo build --release` will create the `spritegen` binary in `target/release` + +To generate spritesheets for the light theme: + +`./target/release/spritegen refill.svg themes/light.json dist/light` + +Creates `dist/light.json`, `dist/light.png`, `dist/light@2x.json`, `dist/light@2x.png` + +In the basemaps viewer (run `npm run dev` in `/app`), check the "local sprites" box to load sprites from `/sprites/dist`