@soundworks/core
Advanced tools
Readme
Open-source creative coding framework for distributed applications based on Web technologies.
Primarily focused on music, soundworks aims at supporting rapid development of real-time distributed applications using JavaScript. It provides abstractions to hide the complexity of the network and to foster very rapid-prototyping and trial-and-error workflows that are typical in artistic practices.
WARNING: The version 4 of @soundworks/core is under heavy development.
The best and most simple way to start using soundworks is to use the @soundworks/create wizard.
npx @soundworks/create@latest
See https://soundworks.dev/tutorials/getting-started.html for more informations on the wizard and how to start with soundworks.
The API is not publicly published for now. To access the API documentation locally, just clone this repository, go to the v4 branch and launch some http server in the docs directory. For example, using the serve package:
git clone https://github.com/collective-soundworks/soundworks.git
cd soundworks
git checkout v4
serve docs
Feel welcome to open an issue or a PR if you find any inconsistency, error or missing information in the documentation.
If you made an application using soundworks please let us know here: https://github.com/collective-soundworks/soundworks/discussions/61
Basic TypeScript support will be proposed in a (hopefully) near future.
However, for maintenance reasons, we aim at following the TC39 and W3C specifications as close as possible. Therefore, we will wait for the https://github.com/tc39/proposal-type-annotations proposal to reach stage 3 to update the source code in a more integrated manner.
Note that the @soundworks/core package is automatically installed when creating an application using the @soundworks/create wizard, so most of the time you should not have to install this package manually. See https://soundworks.dev/guides/getting-started.html for more informations on the soundworks wizard.
npm install @soundworks/core
https://soundworks.dev/credits.html
FAQs
Open-source creative coding framework for distributed applications based on Web technologies
We found that @soundworks/core demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
Application Security
New SEC disclosure rules aim to enforce timely cyber incident reporting, but fear of job loss and inadequate resources lead to significant underreporting.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).