mycopunk-swag/README.md

110 lines
3.5 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 🍄 Mycopunk Swag
**Decentralized merchandise for the mycelial revolution.**
A CLI-driven workflow for designing, managing, and distributing mycopunk merchandise (stickers, shirts, patches, zines) with automated print-on-demand fulfillment.
## Philosophy
Like mycelium networks that share resources without central control, this project embodies:
- **Open source designs** - Fork, remix, distribute
- **Decentralized production** - POD means no inventory, no warehouses
- **Anarchist tech** - Self-hosted, privacy-respecting, no platform lock-in
- **Community-driven** - Contribute designs, suggest products, share the spores
## Quick Start
```bash
# Install CLI
cd cli && pip install -e .
# Create a new design
mycopunk design new stickers/my-design --template=sticker-3x3
# Export to print-ready files
mycopunk design export stickers/my-design
# Validate against POD requirements
mycopunk design validate stickers/my-design
# Create product on POD service
mycopunk product create stickers/my-design --provider=prodigi
```
## Project Structure
```
mycopunk-swag/
├── designs/ # Source design files (SVG, XCF)
│ ├── stickers/ # Sticker designs
│ ├── shirts/ # Apparel designs
│ └── misc/ # Patches, pins, zines
├── templates/ # POD service templates
├── cli/ # Python CLI tool
├── config/ # Product & pricing configuration
├── scripts/ # Helper scripts
└── docs/ # Documentation
```
## Design Workflow
1. **Create** - Design in Inkscape/GIMP, save as SVG
2. **Configure** - Add `metadata.yaml` with product mappings
3. **Export** - Generate print-ready PNGs at required DPIs
4. **Validate** - Check against POD service requirements
5. **Push** - Upload to Printful/Prodigi
6. **Mockup** - Generate product mockups for shop
## Print-on-Demand Providers
| Provider | Products | Best For |
|----------|----------|----------|
| **Printful** | Apparel, accessories | T-shirts, hoodies, quality |
| **Prodigi** | Stickers, prints | Vinyl stickers, art prints, global shipping |
## CLI Reference
See [docs/cli-reference.md](docs/cli-reference.md) for full command documentation.
### Core Commands
```bash
mycopunk design new <path> # Create new design scaffold
mycopunk design list # List all designs
mycopunk design export <path> # Export to print formats
mycopunk design validate <path> # Validate requirements
mycopunk product create <path> # Create POD product
mycopunk product push <path> # Push design to POD
mycopunk product list # List all products
mycopunk mockup generate <path> # Generate mockups
mycopunk catalog sync # Sync POD catalogs
```
## Contributing Designs
1. Fork the repo
2. Create your design in `designs/` following the structure
3. Add `metadata.yaml` with required fields
4. Run `mycopunk design validate` to check requirements
5. Submit a PR with mockups in the description
### Design Requirements
- **Format**: SVG (vectors) or high-res PNG (4800×4800 minimum)
- **Resolution**: 300 DPI for all exports
- **Color Profile**: sRGB
- **Transparency**: PNG with transparent background preferred
See [docs/design-guidelines.md](docs/design-guidelines.md) for detailed specs.
## License
Designs are released under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) unless otherwise noted.
Code is released under [MIT License](LICENSE).
---
*Spread the spores. Decentralize everything.* 🍄