Skip to content

Commit c1ff8ef

Browse files
HardCodeDev777HardCodeDev777
committed
Update docs
1 parent 558a326 commit c1ff8ef

File tree

7 files changed

+90
-65
lines changed

7 files changed

+90
-65
lines changed

‎docs/other/server.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
---
44

5-
65
The Text-to-Speech model used in `UnityNeuroSpeech` is **Coqui XTTS**.
76
To balance performance and usability, the framework runs it through a small Python script that launches a local server.
87

‎docs/unity/agent-api.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -218,8 +218,8 @@ public static class AgentManager
218218

219219
---
220220

221-
#### 😎 You now have full control over your agents!
221+
**😎 You now have full control over your agents!**
222222

223223
Design smart behaviours, react to emotions, and go full sentient AI 🤖
224224

225-
UnityNeuroSpeech puts the power in your hands.
225+
**UnityNeuroSpeech puts the power in your hands.**

‎docs/unity/building-game.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ But don’t worry — **it takes less than a minute to set it up properly.**
99

1010
After building your game, go to the `Managed` folder.
1111

12-
There, create folders that match the `Model Path` value you set in the `SetupWhisperPath` script.
12+
There, create folders that match value you set in the `SceneManagerCreation` window in `Model path` field.
1313

1414
### 🗒️ Example 1
1515

@@ -34,7 +34,7 @@ You’ll need to run this `.bat` file **every time you launch the game**.
3434

3535
---
3636

37-
### 💡 Tip: Make a Startup Script
37+
## 💡 Tip: Make a Startup Script
3838

3939
You can make a simple `.bat` file that launches both the TTS server and the game:
4040

‎docs/unity/configure-settings.md‎

Lines changed: 28 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
---
44

5-
To use UnityNeuroSpeech, you will need to configure some initial settings. Don’t worry — it only takes a minute.
5+
To use UnityNeuroSpeech, you will need to configure some initial settings. Don’t worry — it only takes a few minutes.
66

77
---
88

@@ -12,17 +12,35 @@ Go to **UnityNeuroSpeech → Create Settings** in the Unity toolbar.
1212
You’ll see the window with these settings:
1313

1414

15-
#### 🧩 General Settings
15+
### 🔥 General
1616

17-
| Setting | Description |
18-
|------------------------------|------------------------------------------------------------------------------------------------|
19-
| **Logging type** | Controls how much info you want to see in the Unity console. |
20-
| **Emotions** | Add at least one emotion. These are passed to the LLM. |
21-
| **Not in Assets folder** | Check this if you moved the framework folder outside the default location. |
22-
| **Directory name** *(if above is checked)* | For example: if your folder path is `Assets/MyImports/Frameworks`, enter `MyImports/Frameworks`. |
17+
| Setting | Description |
18+
|--------------------------|----------------------------------------------------------------------------------------------|
19+
| **Logging type** | Controls how much info you want to see in the Unity console |
20+
| **Not in Assets folder** | Check this if you moved the framework folder outside the default location |
21+
| **Directory name** | For example: if your folder path is `Assets/MyImports/Frameworks`, enter `MyImports/Frameworks` |
22+
23+
### 🤖 Agents
24+
25+
| Setting | Description |
26+
|---------------------------|-------------------------------------------------------------------------------------------------|
27+
| **Emotions** | Add at least one emotion. These are passed to the LLM |
28+
| **Request timeout(secs)** | Timeout for requests to local TTS Python server |
29+
30+
### 🐍 Python
31+
32+
| Setting | Description |
33+
|------------------------------|--------------------------------------------|
34+
| **Enable Python debug** | Enables debug for local TTS Python server |
35+
| **Absolute path to main.py** | Full path to `main.py` in `Server/` folder |
36+
37+
### 😎 Advanced
38+
39+
| Setting | Description |
40+
|-----------------------|--------------------------------------------------------|
2341
| **Custom Ollama URI** | If empty, Ollama URI will be default "localhost:11434" |
42+
| **Custom TTS URI** | If empty, TTS URI will be default "localhost:7777" |
2443

25-
---
2644

2745
📝 When you're done, click **Save**.
28-
You can now create your first talkable agent!
46+
Now you can work with UnityNeuroSpeech and start setting up your scene!

‎docs/unity/creating-agent.md‎

Lines changed: 27 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,52 @@
1-
# 🧠 Creating an Agent
1+
# 🧠 Creating Agent
22

33
---
44

5-
An agent in UnityNeuroSpeech is a Unity object that can listen, talk, and respond using LLMs.
5+
Agent in UnityNeuroSpeech is a GameObject that can listen, talk, and respond using LLMs.
66
**Once you create your first agent, you’ll be able to speak with your AI!**
77

88
---
99

10-
## 🛠 How to Create an Agent
11-
12-
Go to **UnityNeuroSpeech → Create Agent**.
13-
You will see the window with these settings:
10+
> Before creating agent make sure you have any two sprites. They're used for Microphone state(enabled/disabled).
1411
12+
---
1513

16-
#### 👤 Agent Parameters
14+
## ✅ Scene Setup
1715

18-
| Setting | Description |
19-
|-----------------|-----------------------------------------------------------------------------|
20-
| **Model name** | Name of the LLM you downloaded via Ollama. |
21-
| **Agent name** | Internal name for your agent. Avoid spaces or dashes. |
22-
| **System prompt** | Base prompt used to control the AI’s behavior and tone. |
16+
1. Add a `Button` to your scene.
17+
2. Add an `AudioSource` to your scene.
2318

2419
---
2520

26-
### ✅ Final Setup in Scene
21+
## ️⚙️ Opening Agent settings
2722

28-
1. Create a `Canvas` in your scene.
29-
2. Add a `Dropdown` with at least three options and a `Button`.
30-
3. Add an `AudioSource` to your scene.
31-
4. Create an empty `GameObject` and attach the following scripts:
23+
Go to **UnityNeuroSpeech → Create Agent**.
24+
You will see the window with these settings:
3225

33-
- `WhisperManager`
34-
- `MicrophoneRecord`
35-
- `YourAgentNameController`
36-
- `SetupWhisperPath`
37-
38-
5. Configure the scripts:
26+
### 👤 Agent Parameters
3927

40-
#### 🔧 `WhisperManager`
41-
- Leave `Model Path` empty.
42-
- Turn off:
28+
| Setting | Description |
29+
|-----------------|--------------------------------------------------------------------------|
30+
| **Model name** | Name of the LLM you downloaded via Ollama |
31+
| **Agent name** | Internal name for your agent. Avoid spaces or dashes |
32+
| **System prompt** | Base prompt used to control the AI’s behavior and tone |
4333

44-
- `Is Model Path In StreamingAssets`
45-
- `Init On Awake`
46-
- `Use VAD`
47-
- Set `Language` to `auto`.
34+
### 👤 Agent Component Values
4835

49-
#### 🎙 `MicrophoneRecord`
50-
- Turn off `Use VAD`
51-
- Assign the `Dropdown` to `Microphone Dropdown`.
36+
| Setting | Description |
37+
|--------------------------------|--------------------------------|
38+
| **Microphone enable button** | Button you created before |
39+
| **Enabled microphone sprite** | Sprite for enabled microphone |
40+
| **Disabled microphone sprite** | Sprite for disabled microphone |
41+
| **Response audiosource** | AudioSource you created before |
5242

53-
#### 🤖 `YourAgentNameController`
54-
- `Agent Settings`: assign the `Agent_YourAgentName` ScriptableObject.
55-
- `WhisperManager`, `MicrophoneRecord`: assign the same GameObject.
56-
- Assign your `Button`, `Enable Mic Sprite`, `Disable Mic Sprite`, and `AudioSource`.
5743

58-
#### 📁 `SetupWhisperPath`
59-
- Drag the GameObject into `Whisper`.
60-
- For `Model Path`, use:
61-
`UnityNeuroSpeech/Whisper/ggml-medium.bin`
62-
(replace with your actual file name and folder if moved).
44+
📝 When you're done, click **Generate agent**.
45+
After scripts compilation click **Create agent in scene**.
6346

6447
---
6548

66-
### 🔄 Start the TTS Server
49+
## 🔄 Start the TTS Server
6750

6851
Run the `run_server.bat` file.
6952
⚠️ It **must be in the same directory** as the `Server` folder (i.e., not inside it).
@@ -79,13 +62,7 @@ Run the `run_server.bat` file.
7962

8063
---
8164

82-
### ❕ Note
83-
84-
If you want to add **more than one agent** in one scene, after creating new empty `GameObject`, add only `YourAgentNameController` script.
85-
86-
---
87-
88-
### 🎧 Tip
65+
## 🎧 Tip
8966

9067
The response delay depends on:
9168

‎docs/unity/creating-uns-manager.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# ⚙️ Creating UNS Manager
2+
3+
---
4+
5+
**UnityNeuroSpeech Manager** controls non-agent scripts. Without it, agent won't work.
6+
7+
---
8+
9+
## ✅ Scene Setup
10+
11+
1. Add a `Dropdown` with at least three options to your scene.
12+
13+
---
14+
15+
## ️⚙️ Opening UNS Manager settings
16+
17+
Go to **UnityNeuroSpeech → Scene Manager Creation**.
18+
You will see the window with these settings:
19+
20+
### 🗒️ UnityNeuroSpeech manager settings
21+
22+
| Setting | Description |
23+
|-------------------------|-------------------------------------------------------------------------------------|
24+
| **Microphone Dropdown** | Dropdown created before |
25+
| **Whisper Model Path** | Without "Assets" directory. For example: "UnityNeuroSpeech/Whisper/ggml-medium.bin" |
26+
27+
> In one scene can only be one UNS Manager.
28+
29+
📝 When you're done, click **Create UnityNeuroSpeech manager in scene**.
30+
You can now create your first talkable agent!

‎mkdocs.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ nav:
1818
- Quickstart: quickstart.md
1919
- Unity:
2020
- Configure Settings: unity/configure-settings.md
21+
- Creating UNS Manager: unity/creating-uns-manager.md
2122
- Creating Agent: unity/creating-agent.md
2223
- Building Game: unity/building-game.md
2324
- API Reference: unity/agent-api.md

0 commit comments

Comments
 (0)