chore: add assets/README.md for v1.2.1
This commit is contained in:
@@ -0,0 +1,106 @@
|
||||
# MPM Brand Assets (Baked In)
|
||||
|
||||
All MPM logos and fonts ship **inside this plugin**. Nothing here needs the Google
|
||||
Drive connector, the Google MCP, or any network access at runtime. Use these files
|
||||
directly when producing documents, presentations, proposals, emails, and any
|
||||
visual content.
|
||||
|
||||
> **Why these are baked in:** Fetching logo PNGs from Google Drive through the
|
||||
> Google MCP is slow enough to disrupt normal content generation. These files are
|
||||
> the exact, authoritative assets pulled from the MPM `01 New Logos` Drive folder
|
||||
> (`drive.google.com/drive/folders/1xpO_sh0dQvWiMQbdmbhRZARuev4RpZiL`) and the
|
||||
> Montserrat / Open Sans families from Google Fonts. The Drive folder remains the
|
||||
> upstream source of truth; this copy is the fast local mirror.
|
||||
|
||||
## Resolving asset paths
|
||||
|
||||
Reference assets relative to the plugin root. The plugin root is available as the
|
||||
environment variable `${CLAUDE_PLUGIN_ROOT}`:
|
||||
|
||||
```bash
|
||||
# List available logos
|
||||
ls "${CLAUDE_PLUGIN_ROOT}/assets/logos/png/"
|
||||
|
||||
# The default light-background logo, as an absolute path for an image-insert tool
|
||||
echo "${CLAUDE_PLUGIN_ROOT}/assets/logos/png/Logo-Standard-Dark.png"
|
||||
```
|
||||
|
||||
If `${CLAUDE_PLUGIN_ROOT}` is not set in the current shell, translate the plugin
|
||||
directory to its bash mount path, e.g.
|
||||
`/sessions/<session-id>/mnt/.remote-plugins/plugin_<id>/assets/logos/png/<file>`.
|
||||
Confirm a path resolves with `ls` before handing it to a document tool. Never
|
||||
silently fall back to a non-MPM logo or a generic font — surface a clear error if a
|
||||
file cannot be found.
|
||||
|
||||
## Filename normalization
|
||||
|
||||
Plugin packaging rejects paths containing spaces, `@`, or `[ ]`. The baked-in files were
|
||||
renamed from their canonical Drive names to installer-safe equivalents (space/`@`/`[` → `-`,
|
||||
`]` removed). All references in this plugin already use the safe names — use them as the
|
||||
"exact filename." The mapping back to the Drive originals:
|
||||
|
||||
| Drive original | Baked-in (use this) |
|
||||
|----------------|---------------------|
|
||||
| `Logo Standard-Dark.png` / `.svg` | `Logo-Standard-Dark.png` / `.svg` |
|
||||
| `LOGO-Gradient-BG@4x.png` | `LOGO-Gradient-BG-4x.png` |
|
||||
| `LOGO-GradientRC-BG@4x.png` | `LOGO-GradientRC-BG-4x.png` |
|
||||
| `Silk Screen.png` / `.svg` | `Silk-Screen.png` / `.svg` |
|
||||
| `Standard Logo-Dark.svg` / `Standard Logo-Light.svg` | `Standard-Logo-Dark.svg` / `Standard-Logo-Light.svg` |
|
||||
| `Logo Transit-Dark.svg` / `Logo Transit-Light.svg` | `Logo-Transit-Dark.svg` / `Logo-Transit-Light.svg` |
|
||||
| `Logo-Transit-Smart Intermodal-{Dark,Light}.svg` | `Logo-Transit-Smart-Intermodal-{Dark,Light}.svg` |
|
||||
| `Logo-Transit-Smart Stop-{Dark,Light}.svg` | `Logo-Transit-Smart-Stop-{Dark,Light}.svg` |
|
||||
| `Asset 3.svg` / `Asset 4.svg` | `Asset-3.svg` / `Asset-4.svg` |
|
||||
| `Montserrat[wght].ttf` (+ Italic) | `Montserrat-wght.ttf` (+ `Montserrat-Italic-wght.ttf`) |
|
||||
| `OpenSans[wght].ttf` (+ Italic) | `OpenSans-wght.ttf` (+ `OpenSans-Italic-wght.ttf`) |
|
||||
|
||||
## Directory layout
|
||||
|
||||
```
|
||||
assets/
|
||||
├── logos/
|
||||
│ ├── png/ # 24 raster logos (PNG/JPG) — documents, web, presentations, email
|
||||
│ └── svg/ # 40 vector logos (SVG) — print, large-format, scalable digital
|
||||
└── fonts/
|
||||
├── Montserrat-wght.ttf # headings/titles — full weight axis (Thin→Black)
|
||||
├── Montserrat-Italic-wght.ttf
|
||||
├── OpenSans-wght.ttf # body text — full weight+width axes
|
||||
├── OpenSans-Italic-wght.ttf
|
||||
├── Montserrat-OFL.txt # SIL Open Font License
|
||||
└── OpenSans-OFL.txt # SIL Open Font License
|
||||
```
|
||||
|
||||
## Logo quick-pick (raster / `png/`)
|
||||
|
||||
| Situation | File |
|
||||
|-----------|------|
|
||||
| Light background (DEFAULT) | `Logo-Standard-Dark.png` |
|
||||
| White / off-white background | `Logo-Gold-Black.png` |
|
||||
| Dark / navy / charcoal background | `Logo-Gold-White.png` |
|
||||
| Single-color black printing | `Logo-Black-Text.png` |
|
||||
| Icon only on dark background | `Logo-White-Cutout.png` |
|
||||
| Pre-composed dark banner (no transparency) | `Logo-White-Cutout-Reversed-Text-BG.jpg` |
|
||||
| App icon / social avatar (square) | `LOGO-Gradient-BG-4x.png` |
|
||||
| App icon (rounded corners) | `LOGO-GradientRC-BG-4x.png` |
|
||||
| Transit Point collateral, light bg | `MPM-Transitpoint-Dark.png` |
|
||||
| Transit Point collateral, dark bg | `MPM-Transitpoint-Light.png` |
|
||||
| Partner / OEM "powered by" | `Logo-Powered.png` |
|
||||
| Merchandise / apparel | `SilkScreen.png` / `SilkScreen-LogoOnly.png` |
|
||||
| MPMedia.TV media property | `MPM-Logo-Fill-Text.png` |
|
||||
|
||||
For print and large-format, use the matching file under `svg/` (infinitely
|
||||
scalable). Transit product sub-brand marks (Mobile, Smart Intermodal, Smart Stop,
|
||||
Solar, MPLocal, MPMetro, MPRail, MPTram, MPXpress) are SVG-only under `svg/`.
|
||||
|
||||
## Fonts
|
||||
|
||||
Both families are the canonical Google Fonts variable fonts, redistributed under
|
||||
the SIL Open Font License (see the `*-OFL.txt` files). The single variable file per
|
||||
family covers every weight via the `wght` axis, so no separate per-weight files are
|
||||
needed.
|
||||
|
||||
- **Montserrat** — headings, titles, subheadings. Use weight as the primary
|
||||
hierarchy tool (Bold/Black for H1, SemiBold/Medium for H2/H3).
|
||||
- **Open Sans** — body copy (Regular, ~11pt). Pairs cleanly with Montserrat.
|
||||
|
||||
To embed in a document, point the tool at the absolute `.ttf` path. Never
|
||||
substitute Arial, Calibri, or any system default.
|
||||
Reference in New Issue
Block a user