Phase 2: services/premiere-plugin/QUICK_START.md
This commit is contained in:
parent
6239795300
commit
ea157f7835
1 changed files with 188 additions and 0 deletions
188
services/premiere-plugin/QUICK_START.md
Normal file
188
services/premiere-plugin/QUICK_START.md
Normal file
|
|
@ -0,0 +1,188 @@
|
|||
# Wild Dragon MAM - Premiere Pro Panel Quick Start
|
||||
|
||||
## Installation (5 minutes)
|
||||
|
||||
### Windows
|
||||
```
|
||||
1. Copy folder to:
|
||||
C:\Users\<USERNAME>\AppData\Roaming\Adobe\CEP\extensions\com.wilddragon.mam.panel\
|
||||
|
||||
2. Open Registry Editor (regedit.exe)
|
||||
Navigate to: HKEY_CURRENT_USER\Software\Adobe\CSXS.11
|
||||
Create DWORD: PlayerDebugMode = 1
|
||||
|
||||
3. Restart Premiere Pro
|
||||
```
|
||||
|
||||
### macOS
|
||||
```
|
||||
1. Copy folder to:
|
||||
~/Library/Application Support/Adobe/CEP/extensions/com.wilddragon.mam.panel/
|
||||
|
||||
2. Open Terminal and run:
|
||||
defaults write /Library/Preferences/com.adobe.CSXS.11 PlayerDebugMode 1
|
||||
|
||||
3. Restart Premiere Pro
|
||||
```
|
||||
|
||||
## Access the Panel
|
||||
|
||||
Window > Extensions > Wild Dragon MAM
|
||||
|
||||
## First Time Setup
|
||||
|
||||
1. Enter server URL (default: http://localhost:7434)
|
||||
2. Click "Connect"
|
||||
3. Green indicator appears when connected
|
||||
4. Assets load automatically
|
||||
|
||||
## Basic Workflow
|
||||
|
||||
```
|
||||
Connect → Browse → Search → Select → Import
|
||||
```
|
||||
|
||||
### Connect
|
||||
- Enter MAM server URL
|
||||
- Click Connect button
|
||||
- Wait for green status indicator
|
||||
|
||||
### Browse
|
||||
- Scroll through asset thumbnails
|
||||
- Click any asset to see details
|
||||
|
||||
### Search
|
||||
- Type in search box
|
||||
- Results update automatically
|
||||
- Filter by project using dropdown
|
||||
|
||||
### Select
|
||||
- Click an asset thumbnail
|
||||
- Details panel shows metadata
|
||||
- Asset is highlighted with accent border
|
||||
|
||||
### Import
|
||||
- Click "Import" to download and import selected asset
|
||||
- Click "Import All" to import all visible assets
|
||||
- Progress bar shows download status
|
||||
- Success message appears when complete
|
||||
|
||||
## Features at a Glance
|
||||
|
||||
| Feature | Location | Action |
|
||||
|---------|----------|--------|
|
||||
| Server Connection | Top bar | Enter URL + Click Connect |
|
||||
| Search Assets | Search box | Type search term |
|
||||
| Filter by Project | Dropdown | Select from list |
|
||||
| View Details | Details panel | Click any asset |
|
||||
| Import Single | Import button | Select asset + Click Import |
|
||||
| Import Multiple | Import All button | Click Import All |
|
||||
| View Progress | Progress bar | Watch while importing |
|
||||
|
||||
## File Locations
|
||||
|
||||
```
|
||||
services/premiere-plugin/
|
||||
├── CSXS/manifest.xml Extension config
|
||||
├── index.html Main panel UI
|
||||
├── css/styles.css Dark theme styles
|
||||
├── js/
|
||||
│ ├── CSInterface.js Adobe interface
|
||||
│ └── main.js Panel logic
|
||||
├── jsx/
|
||||
│ └── premiere.jsx Premiere integration
|
||||
├── README.md Full docs
|
||||
└── QUICK_START.md This file
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**Panel doesn't show:**
|
||||
- Is PlayerDebugMode set to 1? Restart Premiere Pro.
|
||||
- Is the folder in the right location? Check the path above.
|
||||
- Is Premiere Pro version 22.0 or later? Check Help > About.
|
||||
|
||||
**Can't connect to server:**
|
||||
- Is the server running? Check http://localhost:7434 in a browser.
|
||||
- Is the URL correct? Try http://localhost:7434 first.
|
||||
- Is firewall blocking? Check network settings.
|
||||
|
||||
**Assets not loading:**
|
||||
- Click Connect again to refresh.
|
||||
- Check the search box is empty.
|
||||
- Try a different project filter.
|
||||
|
||||
**Import fails:**
|
||||
- Are proxy files available on the server?
|
||||
- Is there disk space for downloads?
|
||||
- Check Premiere Pro's Event Monitor for errors.
|
||||
|
||||
## Tips & Tricks
|
||||
|
||||
- Server URL is saved to local storage (persists across sessions)
|
||||
- Thumbnail previews load lazily for performance
|
||||
- Search updates with 300ms debounce (wait while typing)
|
||||
- Double-click a card does nothing (use single click instead)
|
||||
- Progress bar shows download + import progress
|
||||
- Click red X to dismiss error messages
|
||||
|
||||
## API Endpoints Expected
|
||||
|
||||
The MAM server should provide:
|
||||
|
||||
```
|
||||
GET /api/health ← Server health check
|
||||
GET /api/projects ← List of projects
|
||||
GET /api/assets ← List assets (paginated)
|
||||
POST /api/assets/{id}/download ← Signed S3 URL
|
||||
```
|
||||
|
||||
See README.md for full API specification.
|
||||
|
||||
## ExtendScript Functions Available
|
||||
|
||||
The panel can call these Premiere Pro functions:
|
||||
|
||||
```javascript
|
||||
// Import file into project
|
||||
importFileToProject(filePath)
|
||||
|
||||
// Get current sequence
|
||||
getActiveSequence()
|
||||
|
||||
// Insert into timeline
|
||||
insertClipToSequence(filePath, trackIndex)
|
||||
|
||||
// Get project info
|
||||
getProjectPath()
|
||||
getProjectInfo()
|
||||
getSequenceTracks()
|
||||
```
|
||||
|
||||
See jsx/premiere.jsx for details.
|
||||
|
||||
## Color Scheme (Dark Theme)
|
||||
|
||||
```
|
||||
Primary Background: #0f0f1e (very dark blue)
|
||||
Secondary Background: #1a1a2e (dark blue)
|
||||
Accent Color: #e94560 (bright red/pink)
|
||||
Text Primary: #ffffff (white)
|
||||
Text Secondary: #b0b0c0 (light gray)
|
||||
Success: #00d084 (green)
|
||||
Error: #ff4444 (red)
|
||||
```
|
||||
|
||||
## Support
|
||||
|
||||
See README.md for:
|
||||
- Complete installation guide
|
||||
- Full feature documentation
|
||||
- API reference
|
||||
- ExtendScript function reference
|
||||
- Performance optimization notes
|
||||
- Security considerations
|
||||
|
||||
---
|
||||
|
||||
Version 1.0.0 | April 2026
|
||||
Loading…
Reference in a new issue