You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/quickstart.md
+16-21Lines changed: 16 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,37 +27,32 @@
27
27
28
28
## ⚙️ Base Setup
29
29
30
-
1. Go to the [UnityNeuroSpeech GitHub repository](https://github.com/HardCodeDev777/UnityNeuroSpeech) and download the following **three `.rar` files** from the latest Release:
31
-
-`UnityNeuroSpeech.X.X.X.rar` – main framework files
32
-
-`default.venv.rar` – Python environment for the TTS server
33
-
-`TTSModel.rar` – pretrained XTTS model
34
-
35
-
2. Extract all archives to the same directory. After extraction:
36
-
- Inside `UnityNeuroSpeech/` you’ll find:
37
-
- a `.unitypackage`
38
-
- a `Server/` folder
39
-
- a `run_server.bat` file
40
-
⚠️ **Do not import the `Server` folder or `.bat` file into Unity. Keep them outside the project directory.**
41
-
42
-
3. Place your `.wav` voice files into `Server/Voices`.
43
-
Each file must follow the naming pattern: `en_voice.wav`, `ru_voice.wav`, etc.
30
+
1. Go to the [UnityNeuroSpeech GitHub repository](https://github.com/HardCodeDev777/UnityNeuroSpeech) and download the following **four files** from the latest Release:
31
+
32
+
-`UnityNeuroSpeech.X.X.X.rar` – main framework files
33
+
-`default.venv.rar` – Python environment for the TTS server
34
+
-`TTSModel.rar` – pretrained XTTS model
35
+
-`Setup/` - folder with files for quick automatic setup
44
36
45
-
4. Move the extracted `.venv` folder (from `default.venv.rar`) into the `Server/` folder.
37
+
2. Create a new empty folder anywhere on your computer (name it however you like).
38
+
3. Drag all the following into that folder:
46
39
47
-
5. Move the extracted `TTSModel/` folder (from `TTSModel.rar`) into the `Server/` folder as well.
40
+
- The entire `Setup/` folder (contents only)
41
+
- The three `.rar` archives mentioned above
48
42
49
-
6. Import the `.unitypackage` into your Unity project.
43
+
4. Run `RunPowershell.bat`
44
+
45
+
5. After setup finishes, you'll see a new folder `UnityNeuroSpeech X.X.X`. Open it and drag the `.unitypackage` into your Unity project. **Do not move or import the other files. Keep them outside the Unity project folder.**
46
+
6. Place your `.wav` voice files into `Server/Voices`.
47
+
Each file must follow the naming pattern: `en_voice.wav`, `ru_voice.wav`, etc.
50
48
51
49
7. In the `UnityNeuroSpeech` folder, you’ll see an empty `Whisper/` folder. Drop your Whisper `.bin` model file into it.
52
50
51
+
53
52
> Some folders (like `Whisper/`) may contain `.txt` placeholder files.
54
53
> These are only used to ensure Unity exports the folder. You can safely delete them after setup.
55
54
56
55
---
57
56
58
-
> You can also manually install your own Python environment and download the XTTS model separately.
59
-
> But if you want everything to "just work" **without fighting with pip, PATH, or broken dependencies** — use the provided `.venv` and `TTSModel`.
60
-
61
-
---
62
57
63
58
✅ **Done! You’re ready to build your first talking AI agent.**
0 commit comments