Nina

Thanks for using soundworks!

If you are developping an appliction using soundworks, let us know by filling a comment there collective-soundworks/soundworks#61

Links

• General Documentation / Tutorials
• API
• Examples
• Issue Tracker
• Working with Max/MSP

Soundworks wizard

The soundworks wizard is a interactive command line tool that gives you access to a bunch of high-level functionnalities, such as:

• configure and create new clients
• install / uninstall plugins and related libraries
• find some documentation
• create environment config files
• etc.

npx soundworks

Available npm scripts

npm run dev

Launch the application in development mode. Watch file system, transpile and bundle files on change (i.e. when a source file is saved), and restart the server when needed.

npm run build

Build the application. Transpile and bundle the source code without launching the server.

npm run build:prod

Build the application for production. Same as npm run build but additionally creates minified files for browser clients.

npm run start

Launch the server without rebuilding the application. Basically a shortcut for node ./.build/server/index.js.

npm run watch [name] (node clients only)

Launch the [name] client and restart when the sources are updated.

For example, if you are developping an application with a node client, you should run the dev script (to build the source and start the server) in one terminal:

npm run dev

And launch and watch the node client(s) (e.g. called thing) in another terminal:

npm run watch thing

Environment variables

ENV

Define which environment config file should be used to run the application. Environment config files are located in the /config/env directory.

For example, given the following config files:

├─ config
│  ├─ env
│  │  ├─ default.js
│  │  └─ prod.js   

To start the server the /config/env/prod.js configuration file, you should run:

ENV=prod npm run start

By default, the /config/env/default.json configuration file is used.

PORT

Override the port defined in the config file.

For example, to launch the server on port 3000 whatever the port value defined in the default configuration file, you should run:

PORT=3000 npm run start

EMULATE (node clients only)

Run several node client instances in parallel in the same terminal window.

For example, to launch 4 instances of the client thing in parallel (each client instance being run inside its own fork), you should run:

EMULATE=4 npm run watch:process thing

Credits

soundworks is a framework developped by the ISMM team at Ircam

License

BSD-3-Clause