Skip to content

Installation

To compile you must install pd4web as a PureData patch or a Python package.

Pd Patch (Graphical Interface)

On PureData, pd4webprovides a simple GUI.

  • How to Install?

    To use the pd4web object in PureData, follow these steps:

    • Open PureData.
    • Navigate to Tools Find Externals.
    • Search for pd4web.
    • Click the Install button.
    • Wait for download and create a new pd4web object.

  • Gui Interface

    pd4web

Python Package (Command Line)

If you're comfortable with the command line, you can use the pd4web package to compile your patches.

  • Set up in 10 seconds

    Use pip to install the pd4web package:

    pip install pd4web

  • Command Line Use

    You will get a executable script called pd4web.

    usage: pd4web <PureData Patch Path>

The options of the CLI are:

Flag Description Default
--help Print usage information -
--pd4web-folder <PATH> Pd4Web folder (with libraries, sources, etc.) -
-m, --initial-memory <MB> Initial memory size in megabytes 32
-z, --patch-zoom <ZOOM> Set patch zoom level 1
-o, --output-folder <PATH> Output folder Same as the patch being compiled
-c, --clear-before-compile Clear WebPatch and Pd4Web folders before compilation false
-t, --template-id <ID> Set template ID. See templates 0
-s, --server Start server for the given patch or current folder -
--evnk <LIST> Register extra PdLua objects for a virtual number keyboard on touch devices "nbx,floatatom"
--evtk <LIST> Register extra PdLua objects for a virtual text keyboard on touch devices "listatom,symbolatom"
--export-es6-module Export Pd4WebModule as an ES6 module for native import/export and TypeScript support false
--nogui Disable GUI interface false
--debug Activate debug compilation (faster compilation, slower execution, more error info) false
--devdebug Activate development debug compilation false
--failfast Fail on first error message true