Create README.md
Browse files
README.md
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: mit
|
| 3 |
+
language:
|
| 4 |
+
- en
|
| 5 |
+
- de
|
| 6 |
+
tags:
|
| 7 |
+
- game-engine
|
| 8 |
+
- local-ai
|
| 9 |
+
- tts
|
| 10 |
+
- rust
|
| 11 |
+
- roleplay
|
| 12 |
+
---
|
| 13 |
+
|
| 14 |
+
# Trinity (Offline Demo Build)
|
| 15 |
+
|
| 16 |
+
Trinity is a 100% offline-capable narrative game engine and cognitive framework built natively in Rust (`egui`).
|
| 17 |
+
|
| 18 |
+
This standalone distribution is a playable technical demo showcasing the integration of local language models, deterministic game-state tracking, and low-latency neural TTS.
|
| 19 |
+
|
| 20 |
+
## Architecture & Tech Stack
|
| 21 |
+
|
| 22 |
+
- **Inference:** Local abliterated Gemma 2 9B running via bundled `llama-server`. Completely offline, zero telemetry.
|
| 23 |
+
- **State Bridge:** Deterministic game mechanics (vital signs, inventory management, D20 skill checks) integrated via local IPC and logged in SQLite.
|
| 24 |
+
- **Voice Pipeline:** Piper neural TTS (ONNX runtime) with sentence-level audio buffer streaming for near-zero response latency.
|
| 25 |
+
- **Client:** Native Rust desktop client (`egui`).
|
| 26 |
+
|
| 27 |
+
## Getting Started (Windows x64)
|
| 28 |
+
|
| 29 |
+
1. Download `Trinity_Demo_Win64.zip` (approx. 6.4 GB, bundled with quantized model weights and Piper runtime).
|
| 30 |
+
2. Extract the archive to a local directory (e.g. `C:\Trinity`).
|
| 31 |
+
3. Run `Trinity.exe`.
|
| 32 |
+
|
| 33 |
+
### Hardware Requirements
|
| 34 |
+
- **OS:** Windows 10 / 11 (64-bit)
|
| 35 |
+
- **GPU:** NVIDIA GPU with at least 6–8 GB VRAM recommended for smooth inference and audio streaming.
|
| 36 |
+
- **Storage:** ~8 GB free disk space after extraction.
|