Skip to content

Commit 37185ce

Browse files
committed
Update README
1 parent 55ad85b commit 37185ce

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ A Python package to render note block songs to a variety of audio formats.
44

55
## Overview
66

7-
nbswave is a Python package aimed at rendering note block songs from [Open Note Block Studio](https://opennbs.org/) to audio tracks.
7+
nbswave is a Python package aimed at rendering note block songs from [Open Note Block Studio](https://opennbs.org/) to audio tracks. Supports many common audio formats, both for loading custom sounds as well as exporting tracks.
88

99
## Setup
1010

@@ -27,7 +27,15 @@ from nbswave import *
2727
render_audio("song.nbs", "output.mp3")
2828
```
2929

30-
The output format will be detected automatically based on the file extension.
30+
The output format will be detected automatically based on the file extension. You can still specify it explicitly if you'd like:
31+
32+
```python
33+
from nbswave import *
34+
35+
render_audio("song.nbs", "output", format='wav')
36+
```
37+
38+
> Compatibility with audio formats depends on your FFmpeg configuration.
3139
3240
### Custom instruments
3341

0 commit comments

Comments
 (0)