Skip to content

Quick start does not work as advertised #3

Description

@jhuston

Following the instructions in the README and https://github.com/danielraffel/pulp/blob/main/docs/guides/getting-started.md

Claim:

That's it — three commands from zero to a working plugin.

Actual

~/workspace/PULP_WORKSPACE
% curl -fsSL https://www.generouscorp.com/pulp/install.sh | sh
Installing Pulp CLI for darwin-arm64...
Fetching latest release...
Downloading https://github.com/danielraffel/pulp/releases/download/v0.1.1/pulp-darwin-arm64.tar.gz...
Extracting to ~/.pulp/bin...
Installed: pulp unknown

Pulp CLI installed successfully!

Get started:
  pulp create MyPlugin     # create your first plugin
  pulp doctor              # check your environment

Or clone the framework:
  git clone https://github.com/danielraffel/pulp.git
  cd pulp && ./setup.sh

Restart your shell or run: source

~/workspace/PULP_WORKSPACE
% pulp create "TestPlugin" --type effect --manufacturer "Manufacturer" --output "TestPlugin"
Checking environment...
  ✓ Environment OK

Standalone mode — fetching SDK...
Downloading Pulp SDK v0.1.1 (darwin-arm64)...
  ✓ Downloading SDK (0s)
  ✓ Extracting SDK (0s)
  ✓ SDK v0.1.1 cached at ~/.pulp/sdk/0.1.1
Mode: standalone product project (default)
Creating TestPlugin (effect) at ~/workspace/PULP_WORKSPACE/TestPlugin

  Created testplugin.hpp
  Created CMakeLists.txt
  Created clap_entry.cpp
  Created vst3_entry.cpp
  Created au_v2_entry.cpp
  Created test_testplugin.cpp
  Created main.cpp
  Created pulp.toml

Building...
  ✓ Configuring (2s)
  ✓ Building (38s)

Running tests...
Test project ~/workspace/PULP_WORKSPACE/TestPlugin/build
    Start 1: TestPlugin processes audio
1/3 Test #1: TestPlugin processes audio ..........   Passed    0.01 sec
    Start 2: TestPlugin has correct descriptor
2/3 Test #2: TestPlugin has correct descriptor ...   Passed    0.01 sec
    Start 3: TestPlugin state round-trip
3/3 Test #3: TestPlugin state round-trip .........   Passed    0.01 sec

100% tests passed, 0 tests failed out of 3

Total Test time (real) =   0.02 sec

  ✓ TestPlugin is ready!

  Source:     ~/workspace/PULP_WORKSPACE/TestPlugin
  SDK:        ~/.pulp/sdk/0.1.1
  VST3:       ~/workspace/PULP_WORKSPACE/TestPlugin/build/VST3/TestPlugin.vst3
  CLAP:       ~/workspace/PULP_WORKSPACE/TestPlugin/build/CLAP/TestPlugin.clap
  AU:       ~/workspace/PULP_WORKSPACE/TestPlugin/build/AU/TestPlugin.component
  Standalone: ~/workspace/PULP_WORKSPACE/TestPlugin/build/TestPlugin.app

  Next steps:
    cd ~/workspace/PULP_WORKSPACE/TestPlugin
    pulp build              # rebuild after changes
    pulp test -R testplugin  # run tests
    pulp validate           # validate plugin formats

~/workspace/PULP_WORKSPACE took 42s
% ls
TestPlugin

~/workspace/PULP_WORKSPACE
% cd TestPlugin

~/workspace/PULP_WORKSPACE/TestPlugin
% pulp run
Error: no standalone binary found in ~/workspace/PULP_WORKSPACE/TestPlugin/build/bin
  Create one with: pulp create MyApp --type app
  Or build an existing project: pulp build

Opening the binary at build/TestPlugin.app immediately crashes.

Opening the plugin as a VST3 in Max/MSP and opening the UI shows a horizontally mirrored

Image

Metadata

Metadata

Assignees

No one assigned

    Labels

    clipulp CLI tooldocsDocumentation, README, guidessdkSDK install, packaging, distribution

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions