Add nix flake
This commit is contained in:
@@ -35,9 +35,8 @@ speaker mappings, generated audio, and TTS endpoint stay on your computer.
|
||||
|
||||
## Requirements
|
||||
|
||||
- A reachable [Kokoro-FastAPI](docs/kokoro-fastapi.json) instance. Install and
|
||||
run it using the upstream [Kokoro-FastAPI instructions](https://github.com/remsky/Kokoro-FastAPI);
|
||||
Mudmouth uses `http://127.0.0.1:8880` by default.
|
||||
- A reachable [Kokoro-FastAPI](https://github.com/remsky/Kokoro-FastAPI) instance. Install and
|
||||
run it using the upstream instructions; Mudmouth uses `http://127.0.0.1:8880` by default.
|
||||
- An EverQuest log with `/log on`.
|
||||
|
||||
No `ffplay`, `mpv`, PipeWire command, or other external audio player is
|
||||
@@ -48,6 +47,24 @@ required; Mudmouth plays returned WAV audio itself.
|
||||
See [development and build notes](docs/development.md) for local setup,
|
||||
running Mudmouth, validation, and multi-platform release packaging.
|
||||
|
||||
### NixOS
|
||||
|
||||
Install the packaged application from this repository:
|
||||
|
||||
```bash
|
||||
nix profile install github:pleb/mudmouth
|
||||
mudmouth --log "$HOME/Games/EverQuestLegends/Logs/eqlog_Character_server.txt"
|
||||
```
|
||||
|
||||
Or run it without installing:
|
||||
|
||||
```bash
|
||||
nix run github:pleb/mudmouth -- --log "$HOME/Games/EverQuestLegends/Logs/eqlog_Character_server.txt"
|
||||
```
|
||||
|
||||
The flake includes the ALSA runtime dependency. Start Kokoro-FastAPI separately;
|
||||
Mudmouth connects to `http://127.0.0.1:8880` by default.
|
||||
|
||||
## TUI controls
|
||||
|
||||
| Key | Action |
|
||||
|
||||
Reference in New Issue
Block a user