Skip to content

Commit 6eec963

Browse files
Update website
Add code highlighting. Update Base Setup in quickstart.md
1 parent acc83d8 commit 6eec963

File tree

2 files changed

+34
-10
lines changed

2 files changed

+34
-10
lines changed

docs/quickstart.md

Lines changed: 29 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,36 @@
2727

2828
## ⚙️ Base Setup
2929

30-
1. Go to the [UnityNeuroSpeech GitHub repository](https://github.com/HardCodeDev777/UnityNeuroSpeech) and download the latest Release.
31-
2. Extract the `.zip`. You'll see:
32-
- a `.unitypackage`
33-
- a `Server/` folder
34-
- a `run_server.bat` file
35-
⚠️ **Do not import the Server folder or `.bat` file into Unity. Keep them outside the project directory.**
36-
3. Place your voice `.wav` files into `Server/Voices`.
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`.
3743
Each file must follow the naming pattern: `en_voice.wav`, `ru_voice.wav`, etc.
38-
4. Import the `.unitypackage` into Unity.
39-
5. In the `UnityNeuroSpeech` folder, find the empty `Whisper` folder and drop your `.bin` Whisper model file into it.
44+
45+
4. Move the extracted `.venv` folder (from `default.venv.rar`) into the `Server/` folder.
46+
47+
5. Move the extracted `TTSModel/` folder (from `TTSModel.rar`) into the `Server/` folder as well.
48+
49+
6. Import the `.unitypackage` into your Unity project.
50+
51+
7. In the `UnityNeuroSpeech` folder, you’ll see an empty `Whisper/` folder. Drop your Whisper `.bin` model file into it.
52+
53+
> Some folders (like `Whisper/`) may contain `.txt` placeholder files.
54+
> These are only used to ensure Unity exports the folder. You can safely delete them after setup.
55+
56+
---
57+
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`.
4060
4161
---
4262

mkdocs.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,8 @@ extra:
3333
link: https://github.com/HardCodeDev777/UnityNeuroSpeech
3434
analytics:
3535
provider: google
36-
tracking_id: G-X9H2RHNQ7G
36+
tracking_id: G-X9H2RHNQ7G
37+
markdown_extensions:
38+
- pymdownx.highlight
39+
- pymdownx.superfences
40+
- pymdownx.inlinehilite

0 commit comments

Comments
 (0)