🎛️ VJam Guide
Everything about using VJam, in depth 📖 The in-app Help (the ? button) is just a quick reference — here you get the "why", how to get good, the workflows, and what to do when things break 💪
Why this guide? Until now, VJam's how-to lived only in the in-app Help. Great software has great docs 📚 So VJam gets them too. How it's structured? Top-tier docs split into 4 kinds (tutorial / how-to / reference / concepts). VJam follows those 4 pillars + troubleshooting, mobile, and a glossary 🏛️
📑 Contents
👋 Intro
- What is VJam — what it does & the design idea
🎬 Tutorial (learn by doing)
- Getting Started — your first 5 minutes: get sound in, get visuals, switch them
🛠️ How-to (find it by what you need)
- 🔊 Audio input & when it's not reacting — mic / audio file / demo + fixing hiccups
- 🎨 Stack & switch presets — tap to stack / swipe to switch / Kill / layer cap
- 🎱 Deck A/B & crossfade — two independent decks / crossfader / browser controls the current deck
- 🌈 Blend & filters — how they stack × color grading
- 🖼️ Add images, video, text — 8 image styles / video / 10 text effects / track info
- ⭐ Save with Scenes & FAV — preset FAV / scene = full deck state / slots 1–9
- 🔴 Record to MP4 — format/length/audio settings / audio needs a file / MP4 export
- 📡 Use in streaming (OBS) — capture the PROJ window in OBS / audio / performance
- 📺 Projector / external monitor — PROJ = visuals-only window / 2-screen / PC only
- 🎹 MIDI controller — connect / MIDI learn / global & deck targets
- ✅ Pre-show checklist — audio / screen / prep / control / stability / recording
📱 Mobile
- 📱 On mobile — all gestures / PC-only features / mobile notes
- 📲 PWA / App install — what PWA means / install steps / iOS notes
🆘 Troubleshooting
- 🆘 When things break — look it up by symptom
📋 Reference
- 📋 Cheat sheet — all shortcuts / gestures / blends / filters / Cockpit / minibar
💡 Concepts (why it's built this way)
- 💡 Concepts — dual engine / deck independence / "feel" visuals / modulation
📖 Glossary
- 📖 Glossary — VJam terms at a glance
🧑💻 For developers
- p5 preset authoring guide — write your own presets (existing, in Japanese)
- p5 learning track — learning log for preset audio reactivity (existing, in Japanese)
The source of truth is always the code (src/). If the guide drifts, trust the code 🔧