2016-11-02 16:36:19 -04:00
# scratch-audio
2016-10-13 15:07:18 -04:00
#### Scratch audio engine is for playing sounds, instruments and audio effects in Scratch 3.0 projects
2017-02-02 12:25:41 -05:00
[](https://greenkeeper.io/)
2016-10-14 17:29:51 -04:00
#### Please note this project is at an early stage and we are not ready for pull requests
2022-11-16 12:59:18 -05:00
[](https://circleci.com/gh/LLK/scratch-audio?branch=develop)
2016-10-13 15:07:18 -04:00
## Installation
This requires you to have Git and Node.js installed.
In your own node environment/application:
```bash
2024-02-23 16:26:15 -05:00
npm install https://github.com/scratchfoundation/scratch-audio.git
2016-10-13 15:07:18 -04:00
```
If you want to edit/play yourself:
```bash
2016-11-02 16:36:19 -04:00
git clone git@github.com:LLK/scratch-audio.git
cd scratch-audio
2016-10-13 15:07:18 -04:00
npm install
```
## Testing
```bash
npm test
```
## Donate
We provide [Scratch ](https://scratch.mit.edu ) free of charge, and want to keep it that way! Please consider making a [donation ](https://secure.donationpay.org/scratchfoundation/ ) to support our continued engineering, design, community, and resource development efforts. Donations of any size are appreciated. Thank you!
2023-12-20 21:20:04 -05:00
## Committing
This project uses [semantic release ](https://github.com/semantic-release/semantic-release ) to ensure version bumps
follow semver so that projects depending on it don't break unexpectedly.
In order to automatically determine version updates, semantic release expects commit messages to follow the
[conventional-changelog ](https://github.com/bcoe/conventional-changelog-standard/blob/master/convention.md )
specification.
You can use the [commitizen CLI ](https://github.com/commitizen/cz-cli ) to make commits formatted in this way:
```bash
npm install -g commitizen@latest cz-conventional-changelog@latest
```
Now you're ready to make commits using `git cz` .
