plugdata-team.github.io/documentation.html at main · plugdata-team/plugdata-team.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
<!doctype html>
<html lang="en">
<head>
  <meta charset="UTF-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1" />
  <title>Documentation — plugdata</title>
  <meta name="description" content="Guides, references and tutorials for plugdata — from your first oscillator to shipping a finished plugin." />
  <link rel="icon" href="assets/plugdata-logo.png" type="image/png" />
  <link rel="preconnect" href="https://fonts.googleapis.com" />
  <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
  <link href="https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet" />
  <link rel="stylesheet" href="styles.css" />
</head>
<body>

<header class="site-header">
  <div class="container">
    <div class="bar">
      <a href="index.html" class="brand"><img src="assets/plugdata-logo.png" alt=""/><span>plugdata</span></a>
      <nav class="nav" aria-label="Primary">
        <a href="index.html" data-nav-link>Home</a>
        <a href="about.html" data-nav-link>About</a>
        <a href="download.html" data-nav-link>Download</a>
        <a href="documentation.html" data-nav-link>Documentation</a>
        <a href="support.html" data-nav-link>Support</a>
        <a href="store.html" data-nav-link>Store</a>
      </nav>
      <div class="icon-links">
        <a class="icon-btn" href="https://github.com/plugdata-team/plugdata" target="_blank" rel="noreferrer" aria-label="GitHub"><svg width="16" height="16" viewBox="0 0 1024 1024" fill="none" xmlns="http://www.w3.org/2000/svg">
        <path fill-rule="evenodd" clip-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8C0 11.54 2.29 14.53 5.47 15.59C5.87 15.66 6.02 15.42 6.02 15.21C6.02 15.02 6.01 14.39 6.01 13.72C4 14.09 3.48 13.23 3.32 12.78C3.23 12.55 2.84 11.84 2.5 11.65C2.22 11.5 1.82 11.13 2.49 11.12C3.12 11.11 3.57 11.7 3.72 11.94C4.44 13.15 5.59 12.81 6.05 12.6C6.12 12.08 6.33 11.73 6.56 11.53C4.78 11.33 2.92 10.64 2.92 7.58C2.92 6.71 3.23 5.99 3.74 5.43C3.66 5.23 3.38 4.41 3.82 3.31C3.82 3.31 4.49 3.1 6.02 4.13C6.66 3.95 7.34 3.86 8.02 3.86C8.7 3.86 9.38 3.95 10.02 4.13C11.55 3.09 12.22 3.31 12.22 3.31C12.66 4.41 12.38 5.23 12.3 5.43C12.81 5.99 13.12 6.7 13.12 7.58C13.12 10.65 11.25 11.33 9.47 11.53C9.76 11.78 10.01 12.26 10.01 13.01C10.01 14.08 10 14.94 10 15.21C10 15.42 10.15 15.67 10.55 15.59C13.71 14.53 16 11.53 16 8C16 3.58 12.42 0 8 0Z" transform="scale(64)" fill="#1B1F23"/>
        </svg></a>
        <a class="icon-btn" href="https://discord.gg/eT2RxdF9Nq" target="_blank" rel="noreferrer" aria-label="Discord"><svg width="20" height="20" viewBox="0 0 24 24" fill="currentColor"><path d="M19.27 5.33A18 18 0 0 0 14.9 4l-.2.42a16.6 16.6 0 0 0-4.9 0L9.6 4a18 18 0 0 0-4.37 1.33C2.5 9.32 1.76 13.2 2.13 17a18.5 18.5 0 0 0 5.6 2.83l.45-.62a13 13 0 0 1-2.13-1.03l.52-.41a13 13 0 0 0 11.16 0l.52.41c-.66.4-1.38.74-2.13 1.03l.45.62A18.5 18.5 0 0 0 21.87 17c.46-4.55-.74-8.4-2.6-11.67zM9.34 14.6a1.78 1.78 0 0 1-1.66-1.86 1.7 1.7 0 1 1 3.32 0c0 1.03-.74 1.86-1.66 1.86zm5.32 0a1.78 1.78 0 0 1-1.66-1.86 1.7 1.7 0 1 1 3.32 0c0 1.03-.74 1.86-1.66 1.86z"/></svg></a>
      </div>
      <button class="icon-btn menu-toggle" data-menu-toggle aria-label="Menu"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.8"><path d="M4 7h16M4 12h16M4 17h16"/></svg></button>
    </div>
    <nav class="mobile-nav" data-mobile-nav>
      <a href="index.html" data-nav-link>Home</a>
      <a href="about.html" data-nav-link>About</a>
      <a href="download.html" data-nav-link>Download</a>
      <a href="documentation.html" data-nav-link>Documentation</a>
      <a href="support.html" data-nav-link>Support</a>
      <a href="store.html" data-nav-link>Store</a>
    </nav>
  </div>
</header>

<main>

<section class="page-hero">
  <div class="dot-grid-fade"></div>
  <div class="container">
    <div class="inner">
      <p class="eyebrow">Documentation</p>
      <h1 class="text-balance">Learn plugdata at your own pace.</h1>
      <p class="sub">Guides, references and tutorials, from your first oscillator to a finished plugin.</p>
    </div>
  </div>
</section>

<section class="section">
  <div class="container">
    <div class="section-head">
      <p class="eyebrow" style="margin-bottom: 0.75rem;">Documentation</p>
      <h2>Browse by topic.</h2>
    </div>
    <div class="doc-grid">
        <a class="doc-card" href="docs.html"><div class="icon-box"><svg width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.8"><path d="M2 3h6a4 4 0 0 1 4 4v13a3 3 0 0 0-3-3H2zM22 3h-6a4 4 0 0 0-4 4v13a3 3 0 0 1 3-3h7z"/></svg></div><h3>Official Documentation</h3><p>Browse the official plugdata documentation</p></a>
        <a class="doc-card" href="reference.html"><div class="icon-box"><svg width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.8"><path d="M2 3h6a4 4 0 0 1 4 4v13a3 3 0 0 0-3-3H2zM22 3h-6a4 4 0 0 0-4 4v13a3 3 0 0 1 3-3h7z"/></svg></div><h3>Object reference</h3><p>Browse the plugdata object reference</p></a>
        <a class="doc-card" href="https://puredata.info/docs"><div class="icon-box"><svg width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.8"><path d="M2 3h6a4 4 0 0 1 4 4v13a3 3 0 0 0-3-3H2zM22 3h-6a4 4 0 0 0-4 4v13a3 3 0 0 1 3-3h7z"/></svg></div><h3>Pure Data Documentation</h3><p>Most Pure Data documentation applies to plugdata too</p></a>
        <a class="doc-card" href="https://msp.ucsd.edu/techniques/latest/book.pdf"><div class="icon-box"><svg width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.8"><path d="M2 3h6a4 4 0 0 1 4 4v13a3 3 0 0 0-3-3H2zM22 3h-6a4 4 0 0 0-4 4v13a3 3 0 0 1 3-3h7z"/></svg></div><h3>Theory and Techniques of Electronic Music</h3><p>An exellent source of information by Miller Puckette, the original creator of pure-data</p></a>
        <a class="doc-card" href="https://wasted-audio.github.io/hvcc/"><div class="icon-box"><svg width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.8"><rect x="4" y="4" width="16" height="16" rx="2"/><rect x="9" y="9" width="6" height="6"/><path d="M9 1v3M15 1v3M9 20v3M15 20v3M20 9h3M20 15h3M1 9h3M1 15h3"/></svg></div><h3>Heavy Documentation</h3><p>Compile patches to portable C++ for embedded targets, exported plugins and game engines.</p></a>
        <a class="doc-card" href="https://agraef.github.io/pd-lua/tutorial/pd-lua-intro.html"><div class="icon-box"><svg width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.8"><path d="M4 17l6-6-6-6"/><path d="M12 19h8"/></svg></div><h3>Lua / pdlua</h3><p>Extend plugdata with scripted objects in Lua.</p></a>
        <a class="doc-card" href="https://youtube.com/playlist?list=PLZYD2Edyty0BfJ1RAH2heamjJGVj0TEau&si=153PTY-doNhh_NtX"><div class="icon-box"><svg width="18" height="18" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.8"><polygon points="23 7 16 12 23 17 23 7"/><rect x="1" y="5" width="15" height="14" rx="2"/></svg></div><h3>Video Tutorials</h3><p>We recommend Sound Codex' YouTube series on plugdata as a starting point. It covers everything from core concepts to making sound and music, to DAW integration.</p></a>
    </div>
  </div>
</section>
</main>
<footer class="site-footer">
  <div class="container">
    <div class="top">
      <div><a href="index.html" class="brand"><img src="assets/plugdata-logo.png" alt="" width="28" height="28" /><span>plugdata</span></a><p class="blurb">A free, open-source visual programming environment for audio.</p></div>
      <div><h4>Project</h4><ul><li><a href="about.html">About</a></li><li><a href="documentation.html">Documentation</a></li><li><a href="reference.html">Reference</a></li><li><a href="support.html">Support</a></li></ul></div>
      <div><h4>Get plugdata</h4><ul><li><a href="download.html">Download</a></li><li><a href="store.html">Store</a></li><li><a href="https://github.com/plugdata-team/plugdata/releases" target="_blank" rel="noreferrer">Releases</a></li></ul></div>
      <div><h4>Community</h4><ul><li><a href="https://github.com/plugdata-team/plugdata" target="_blank" rel="noreferrer">GitHub</a></li><li><a href="https://discord.gg/eT2RxdF9Nq" target="_blank" rel="noreferrer">Discord</a></li><li><a href="https://github.com/sponsors/timothyschoen" target="_blank" rel="noreferrer">Sponsor</a></li></ul></div>
    </div>
    <div class="bottom"><p class="copy">© <span data-year>2025</span> plugdata. Released under the GPL-3.0 license. Based on Pure Data by Miller Puckette.</p></div>
  </div>
</footer>

<script src="main.js"></script>
</body>
</html>