Skip to content

Commit

Permalink
Update credit & add install instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
ButterscotchV committed Jan 31, 2024
1 parent c2db756 commit d9f02cb
Showing 1 changed file with 16 additions and 4 deletions.
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,25 @@
# ButterSTT

A simple real-time speech to text application for the VRChat chatbox
A simple real-time speech to text application for the VRChat chatbox.

Using:
## Installation
- Download the zip and extract it into a folder.
- Download a model file from https://abb128.github.io/april-asr/models.html.
- Recommended: [april-english-dev-01110_en.april](https://april.sapples.net/april-english-dev-01110_en.april)
- Place the model file in the `Models` folder next to `ButterSTT.exe`.

## Usage
- Run `ButterSTT.exe`, it will connect to VRChat OSC at `127.0.0.1:9000` by default.
- Optionally, configure the program by editing the values in `config.json`.

## Credit

### Using

- <https://github.com/naudio/NAudio>
- <https://github.com/abb128/april-asr>
- <https://github.com/VRCWizard/CoreOSC-VRC-UTF8>
- <https://github.com/LucHeart/CoreOSC-UTF8-ASYNC>

Loosely based on:
### Loosely based on

- <https://github.com/VRCWizard/TTS-Voice-Wizard>

0 comments on commit d9f02cb

Please sign in to comment.