https://github.com/dgapitts/ebabel-audio
https://github.com/dgapitts/ebabel-audio
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dgapitts/ebabel-audio
- Owner: dgapitts
- License: gpl-3.0
- Created: 2018-10-14T12:41:19.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-10-15T20:37:57.000Z (over 7 years ago)
- Last Synced: 2025-02-09T05:47:16.517Z (over 1 year ago)
- Language: JavaScript
- Size: 169 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# ebabel-audio
[](https://travis-ci.org/dgapitts/ebabel-audio)
Play music or positional sound.
## Module install and usage in your game
### Install
```
npm install --save ebabel-audio
```
### Usage
```
const ebabelAudio = require('ebabel-audio');
const result = ebabelAudio();
```
## Development of this module
Fork this repository on Github, `git clone` your repository, checkout the develop branch, and when you are done, submit a pull request from your repository develop branch to this repository develop branch.
* fork this repository on github.com
* git clone your forked repository.
* git checkout develop
### First step when developing
```
npm install
```
### Run linting and unit tests
```
npm test
```
An html coverage report is to be found in the `coverage` folder.
### Generate documentation
```
npm run jsdoc
```
The generated documentation is to be found in the `docs` folder.