illuscape/README.md
pyr0ball 788b5c1688
Some checks are pending
CI / test (22.04) (push) Waiting to run
CI / test (24.04) (push) Waiting to run
docs: add final README and CONTRIBUTING
2026-05-25 21:14:46 -07:00

101 lines
2.7 KiB
Markdown

# Illuscape
> Inkscape configured for Adobe Illustrator migrants.
Illuscape patches Inkscape's config to match Illustrator's keyboard shortcuts,
workspace layout, scroll/zoom behavior, color palettes, and document templates —
without modifying Inkscape itself.
## What it does
| Feature | Detail |
|---------|--------|
| Keyboard shortcuts | Adobe Illustrator CC or CS6 presets — your choice at install |
| Scroll/zoom | Mouse wheel pans (not zooms); Ctrl+wheel zooms — matching Illustrator |
| Canvas | White background, cyan guides, rubber-band selection (touching, not enclosed) |
| Node handles | Square handles, rotation handles hidden until needed |
| Palettes | Illustrator Defaults, Grays, and Earth Tones swatches |
| Templates | Letter, A4, Web 1920x1080, Web 1280x720, Print CMYK Letter, Print CMYK A4 |
| Symbols | Common symbol library (arrows, checkmark, star, cross) |
| Recent files | 20 (matching Illustrator; Inkscape default is 4) |
| Single-window mode | On by default |
## Requirements
- Inkscape 1.2 or later
- Python 3.8+
- Bash 4+
## Install
```bash
git clone https://github.com/your-org/illuscape
cd illuscape
./install.sh
```
Follow the prompt to choose your Illustrator era (CC or CS6), then open Inkscape.
### Non-interactive (for scripts / MenagerieOS)
```bash
./install.sh --preset=cc --yes
# or
./install.sh --preset=cs6 --yes
```
### Supported Inkscape installs
- Native (apt, pacman, etc.)
- Flatpak (`org.inkscape.Inkscape`)
- Snap
## Uninstall
```bash
./uninstall.sh
```
Your original Inkscape config is restored from the backup created at install time.
## Tool mapping from Illustrator to Inkscape
| Illustrator tool | Key | Inkscape equivalent |
|-----------------|-----|---------------------|
| Selection | V | Selection tool |
| Direct Selection | A | Node tool |
| Pen | P | Pen tool |
| Pencil | N | Pencil tool |
| Paintbrush | B | Calligraphy tool |
| Type | T | Text tool |
| Rectangle | M | Rectangle tool |
| Ellipse | L | Ellipse tool |
| Rotate | R | Transform > Rotate |
| Scale | S | Transform > Scale |
| Reflect | O | Transform > Flip |
| Gradient | G | Gradient tool |
| **Mesh** | **U** | **Mesh Gradient tool (direct equivalent)** |
| Eyedropper | I | Dropper tool |
| Zoom | Z | Zoom tool |
| Hand | H / Space | Pan (Space held) |
| Scissors | C | Scissors tool |
| Eraser | Shift+E | Eraser tool |
| Blob Brush | Shift+B | Spray tool (paint mode) |
| Symbol Sprayer | Shift+S | Spray tool (clone mode) |
| Live Paint | K | Paint Bucket tool |
## Planned extensions (post-v1)
- Artboards panel
- Character Styles
- Recolor Artwork
- Object Styles
- Export for Screens (1x/2x/3x batch)
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md).
## License
MIT — see [LICENSE](LICENSE).