Metadata-Version: 2.4
Name: shadepix
Version: 0.6.1
Summary: Faceless pixel avatars from your terminal. Zero dependencies.
Author: Bastien Cochet
License-Expression: MIT
Project-URL: Homepage, https://github.com/bstcoc/shade
Keywords: pixel-art,avatar,cli,terminal,generator
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

<p align="center">
  <img src="assets/wordmark.png" width="420" alt="shade">
</p>

<p align="center">
  <b>Faceless pixel avatars from your terminal.</b><br>
  One Python file. Zero dependencies. Every face stays blank.<br><br>
  <a href="https://bstcoc.github.io/shade/"><b>Try it in your browser →</b></a>
</p>

<p align="center">
  <img src="assets/examples.png" alt="Avatars made with shade">
</p>

## Why

Most avatar makers draw a face. shade draws everything else: hair, beard, hat, clothes, background.
Eyes are always covered (shades, visor, goggles, a band), and there is no nose and no mouth.
You get an avatar that feels like you without showing a face.

## Install

```sh
brew install bstcoc/tap/shade
# or: uv tool install shadepix
# or: pipx install shadepix
```

Needs Python 3.10+ and nothing else. Works on macOS, Linux and Windows. The command is `shade`.

## Use it

Run `shade` to open the studio:

<p align="center"><img src="assets/demo.gif" width="760" alt="The shade studio"></p>

- `↑` `↓` pick a setting, `←` `→` change it, and the preview updates live
- `space` shuffles the look and keeps your size, shape and detail level
- `⏎` saves a PNG and `g` saves an animated GIF, then you can keep going

You can also make an avatar without the studio:

```sh
shade curly visor hoodie            # words in any order
shade topcolor=navy bg=night stars  # colors take group=value
shade random beanie                 # random look, with a beanie
shade curly visor gif               # animated GIF: a light streak sweeps the lenses
shade @5nd9ajtmz9                   # rebuild an avatar from its code
shade seed bastien                  # the same avatar for the same name, forever
shade curly -o me.gif               # choose the file; -o - writes to stdout
shade help                          # every group and value
```

Every avatar has a short code like `@5nd9ajtmz9`. Share it and anyone can rebuild the same avatar.

### What you can change

17 settings, each with plenty of choices:

- **Face and hair:** 5 head shapes, 8 skin tones, 11 hairstyles (afro and ponytail included), 16 hair colors, 6 beards.
- **Hats:** cap, beanie, bandana, headphones, beret, bucket hat, plus party hat and graduation cap for big days.
- **Eyewear:** shades, round glasses, visor, band, goggles, VR headset, aviators, cat-eye, in 11 lens colors.
- **Outfits:** hoodie (hood down or up with `hoodup`), tee, jacket, turtleneck, sweater, suit, polo, thobe, puffer, overalls, in 21 fabric colors. Add an earring, chain, scarf, bow tie or pin. The accent color (`hatcolor=`) paints the hat, scarf, bow tie and pin.
- **Backgrounds:** 18 colors and 13 patterns, from plain and gradient to rain, snow, confetti, hearts and a crescent moon. Patterns move in GIFs.
- **Output:** detail level (`rich`, `shaded`, `flat`), shape (`rounded`, `circle`, `square`) and size (200, 400 or 1200 px), for PNG and GIF.

## Use it from an agent

shade ships a skill for Claude Code. Install it once and ask for a pixel avatar in plain words:

```sh
mkdir -p ~/.claude/skills/shade
curl -fsSL -o ~/.claude/skills/shade/SKILL.md https://raw.githubusercontent.com/bstcoc/shade/main/skills/shade/SKILL.md
```

## Let any AI design one

```sh
shade agent
```

This copies a ready-made prompt to your clipboard. Paste it to any AI and it replies with a `shade` command, or with a pixel grid you render using `shade draw`.

## Draw your own

A grid is a text file. A line like `K #0d0d14` sets a color, every other line is a row of pixels, and `.` is transparent.

```
K #0d0d14
r #ff0000
.K.
KrK
.K.
```

```sh
shade draw art.txt
```

## Releases

Every merged release PR publishes a new version to PyPI and GitHub, and the [web demo](https://bstcoc.github.io/shade/) picks it up with its notes. See [CHANGELOG.md](CHANGELOG.md).

## License

[MIT](LICENSE)
