Skip to content

Commit 71f6c5f

Browse files
authored
Update README.md
Добавил описание на английском языке.
1 parent 733bbcd commit 71f6c5f

1 file changed

Lines changed: 150 additions & 62 deletions

File tree

README.md

Lines changed: 150 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,134 +1,222 @@
11
# ChatCaster 🎮🎙️
2-
**Голосовой ввод текста для геймеров с геймпадом**
2+
**Voice input for gamepad gamers | Голосовой ввод для геймеров с геймпадом**
33

4-
> Забудьте о мучениях с виртуальной клавиатурой в играх! Говорите - мы печатаем.
4+
[🇬🇧 English](#english) | [🇷🇺 Русский](#русский)
5+
6+
---
7+
8+
## English
9+
10+
> Forget about struggling with virtual keyboards in games! Speak - we type.
11+
12+
**ChatCaster** solves every gamepad gamer's biggest pain point: **how to quickly type in chat without putting down your controller?**
13+
14+
Simply press your custom button combo on gamepad, say what you want to type, and text automatically appears in game chat. Everything happens in 1-2 seconds!
15+
16+
### ✨ Key Features
17+
18+
🎯 **Universal Input**
19+
- Works in **any** application: Steam Input, game chats, Discord, even Notepad
20+
- Supports gamepads and keyboards
21+
- Instant speech recognition (1-2 seconds)
22+
23+
🌍 **Multilingual & Translation**
24+
- **5 most popular Steam languages**
25+
- **Auto-translation between languages**
26+
- Speak Russian → get English text in chat
27+
- All language combinations work both ways
28+
29+
**Easy to Use**
30+
- **No complex setup** - just plug in microphone and you're ready
31+
- Customizable button combinations on gamepad/keyboard
32+
- Long press = delete all text in field
33+
- Different recognition models (accuracy vs speed balance)
34+
35+
**Accessibility**
36+
- **Full gaming participation** for those who can only use gamepad
37+
- **Keyboard alternative** for limited hand mobility
38+
- **Voice text control** in any applications, not just games
39+
- **Equal opportunities** in multiplayer games
40+
41+
### 🎮 How It Works
42+
43+
1. **Play with gamepad** in any game
44+
2. **Press combination** (e.g., LB+RB)
45+
3. **Say** what you want to type (up to 30 seconds)
46+
4. **Text automatically** appears in game chat
47+
48+
**Example:**
49+
```
50+
🎙️ You say: "Привет, как дела?"
51+
⌨️ Chat shows: "Hey, how's it going?"
52+
```
553

6-
## 🚀 Что это такое?
54+
### 📥 Installation
755

8-
ChatCaster решает главную боль всех геймеров на геймпаде: **как быстро написать в чат, не отвлекаясь от игры?**
56+
1. Download latest version from [Releases](../../releases)
57+
2. Extract archive
58+
3. Run `ChatCaster.exe`
59+
4. Connect microphone and gamepad
60+
5. Ready! 🎉
61+
62+
### ⚙️ Configuration
63+
64+
**First Launch:**
65+
Works out-of-the-box with default settings.
66+
67+
**Available Settings:**
68+
- **Recognition Model** - choose balance between accuracy and speed
69+
- **Button Combinations** - set comfortable key combinations
70+
- **Languages** - select input and output languages for translation
71+
72+
### 🛠️ System Requirements
73+
74+
- **Windows** (Linux and macOS in development)
75+
- **Microphone** (any)
76+
- **Gamepad** or keyboard
77+
- **.NET Runtime** (installs automatically)
78+
79+
> **Note**: Application developed and tested with Xbox gamepad. Other gamepads may not work in all cases.
80+
81+
### 📺 Demo
82+
83+
[**5-minute YouTube Demo**](https://youtu.be/p_exJzcF1so) (Russian audio with English subtitles available)
84+
85+
---
86+
87+
## Русский
88+
89+
> Забудьте о мучениях с виртуальной клавиатурой в играх! Говорите - мы печатаем.
90+
91+
**ChatCaster** решает главную боль всех геймеров на геймпаде: **как быстро написать в чат, не отвлекаясь от игры?**
992

1093
Просто нажмите настроенную комбинацию кнопок на геймпаде, скажите что хотите написать, и текст автоматически появится в игровом чате. Всё происходит за 1-2 секунды!
1194

12-
## Основные возможности
95+
### Возможности
1396

14-
### 🎯 Универсальный ввод
97+
🎯 **Универсальный ввод**
1598
- Работает в **любых** приложениях: Steam Input, игровые чаты, Discord, даже Блокнот
1699
- Поддержка геймпадов и клавиатуры
17100
- Мгновенное распознавание речи (1-2 секунды)
18101

19-
### 🌍 Многоязычность
102+
🌍 **Многоязычность и перевод**
20103
- **5 самых популярных языков** Steam
21104
- **Автоматический перевод между языками**
22105
- Говорите на русском → получаете английский текст в чате
23106
- Все комбинации языков работают в обе стороны
24107

25-
### Простота использования
108+
**Простота использования**
26109
- **Никаких сложных настроек** - подключил микрофон и готово
27110
- Настраиваемые комбинации кнопок на геймпаде/клавиатуре
28111
- Долгое зажатие = удаление всего текста в поле
29112
- Различные модели распознавания (точность vs скорость)
30113

31-
## 🎮 Как это работает?
114+
**Поддержка людей с ограниченными возможностями**
115+
- **Полноценное участие в играх** для тех, кто может использовать только геймпад
116+
- **Альтернатива клавиатуре** при ограниченной подвижности рук
117+
- **Голосовое управление текстом** в любых приложениях, не только играх
118+
- **Равные возможности** в многопользовательских играх
119+
120+
### 🎮 Как это работает
32121

33122
1. **Играете с геймпадом** в любую игру
34123
2. **Нажимаете комбинацию** (например, LB+RB)
35-
3. **Говорите** что хотите написать (до 10 секунд)
124+
3. **Говорите** что хотите написать (до 30 секунд)
36125
4. **Текст автоматически** появляется в чате игры
37126

38-
### Пример использования:
127+
**Пример использования:**
39128
```
40129
🎙️ Вы говорите: "Привет, как дела?"
41130
⌨️ В чате появляется: "Hey, how's it going?"
42131
```
43132

44-
## 🛠️ Системные требования
45-
46-
- **Windows** (Linux и macOS в разработке)
47-
- **Микрофон** (любой)
48-
- **Геймпад** или клавиатура
49-
- **.NET Runtime** (устанавливается автоматически)
50-
51-
> **Примечание**: Приложение разработано и протестировано на Xbox геймпаде. Другие геймпады могут работать не во всех случаях.
52-
53-
## 📥 Установка
133+
### 📥 Установка
54134

55135
1. Скачайте последнюю версию из [Releases](../../releases)
56136
2. Распакуйте архив
57137
3. Запустите `ChatCaster.exe`
58138
4. Подключите микрофон и геймпад
59139
5. Готово! 🎉
60140

61-
## ⚙️ Настройка
141+
### ⚙️ Настройка
62142

63-
### Первый запуск
143+
**Первый запуск:**
64144
Приложение работает сразу "из коробки" с настройками по умолчанию.
65145

66-
### Доступные настройки:
146+
**Доступные настройки:**
67147
- **Модель распознавания** - выберите баланс между точностью и скоростью
68148
- **Комбинации кнопок** - настройте удобные для вас сочетания
69149
- **Языки** - выберите входной и выходной языки для перевода
70150

71-
## 🎯 Применение
151+
### 🛠️ Системные требования
152+
153+
- **Windows** (Linux и macOS в разработке)
154+
- **Микрофон** (любой)
155+
- **Геймпад** или клавиатура
156+
- **.NET Runtime** (устанавливается автоматически)
157+
158+
> **Примечание**: Приложение разработано и протестировано на Xbox геймпаде. Другие геймпады могут работать не во всех случаях.
159+
160+
### 🎯 Применение
72161

73-
### 🎮 Для геймеров:
162+
**🎮 Для геймеров:**
74163
- Быстрые команды команде в CS2, Valorant, Dota 2
75164
- Общение в MMO играх не отрывая рук от геймпада
76165
- Стримы без засветки клавиатуры
77166

78-
### ♿ Для людей с ограниченными возможностями:
79-
- **Полноценное участие в играх** для тех, кто может использовать только геймпад
80-
- **Альтернатива клавиатуре** при ограниченной подвижности рук
81-
- **Голосовое управление текстом** в любых приложениях, не только играх
82-
- **Социализация в играх** без барьеров ввода текста
83-
- **Равные возможности** в многопользовательских играх
84-
85-
### 💬 Как переводчик:
167+
**💬 Как переводчик:**
86168
- Общение с иностранными игроками
87169
- Изучение языков в игровой форме
88170
- Быстрый перевод фраз
89171

90-
## 🤝 Поддержка проекта
172+
**♿ Для инклюзивного гейминга:**
173+
- Социализация в играх без барьеров ввода текста
174+
- Альтернативный способ ввода текста
175+
- Полноценное участие в онлайн-сообществе
91176

92-
Этот проект разрабатывается одним человеком в свободное время.
177+
### 📺 Демонстрация
93178

94-
**Автор**: Самоучка .NET разработчик, в поисках Junior позиции
179+
[**5-минутное демо на YouTube**](https://youtu.be/p_exJzcF1so)
95180

96-
### 📧 Связь:
97-
- **Telegram**: [@BMBasharov](https://t.me/BMBasharov)
98-
- **Email**: basharovbmkz@gmail.com
181+
## 🛣️ Roadmap | Планы развития
99182

100-
> Если вы представитель IT-компании и ищете Junior .NET разработчика - буду рад рассмотреть предложения!
183+
- ✅ Windows version | Windows версия
184+
- 🔄 Linux support | Поддержка Linux
185+
- 🔄 macOS support | Поддержка macOS
186+
- 📋 Saved phrases/commands | Сохранённые фразы/команды
187+
- 🎨 UI themes | Темы оформления
188+
- 🔧 Advanced settings | Расширенные настройки
101189

102-
## 🛣️ Планы развития
190+
## ❓ FAQ
103191

104-
- ✅ Windows версия
105-
- 🔄 Linux поддержка
106-
- 🔄 macOS поддержка
107-
- 📋 Сохранённые фразы/команды
108-
- 🎨 Темы оформления
109-
- 🔧 Расширенные настройки
192+
**Q: Does the app work offline? | Работает ли приложение офлайн?**
193+
A: Yes, all speech recognition happens locally on your computer. | Да, все распознавание происходит локально на вашем компьютере.
110194

111-
## ❓ FAQ
195+
**Q: What languages are supported? | Какие языки поддерживаются?**
196+
A: 5 most popular Steam languages with automatic translation between them. | 5 самых популярных языков Steam с автоматическим переводом между ними.
112197

113-
**Q: Можно ли использовать приложение для людей с ограниченными возможностями?**
114-
A: Да! Приложение отлично подходит для людей, которые по различным причинам не могут использовать клавиатуру, но могут говорить и управлять геймпадом. Работает в любых приложениях, не только в играх.
198+
**Q: Can I use it with keyboard only? | Можно ли использовать только с клавиатурой?**
199+
A: Yes, the app supports any key combinations. | Да, приложение поддерживает любые комбинации клавиш.
115200

116-
**Q: Работает ли приложение офлайн?**
117-
A: Да, все распознавание происходит локально на вашем компьютере.
201+
**Q: Is it resource-heavy? | Потребляет ли много ресурсов?**
202+
A: Depends on the recognition model chosen. You can adjust accuracy/performance balance. | Зависит от выбранной модели распознавания. Можно настроить баланс точность/производительность.
118203

119-
**Q: Какие языки поддерживаются?**
120-
A: 5 самых популярных языков Steam с автоматическим переводом между ними.
204+
## 🤝 Support the Project | Поддержка проекта
121205

122-
**Q: Можно ли использовать только с клавиатурой?**
123-
A: Да, приложение поддерживает любые комбинации клавиш.
206+
This project is developed by one person in spare time. | Этот проект разрабатывается одним человеком в свободное время.
207+
208+
**Author | Автор**: Self-taught .NET developer seeking Junior position | Самоучка .NET разработчик, в поиске Junior позиции
209+
210+
### 📧 Contact | Связь:
211+
- **Telegram**: [@BMBasharov](https://t.me/BMBasharov)
212+
- **Email**: basharovbmkz@gmail.com
124213

125-
**Q: Потребляет ли много ресурсов?**
126-
A: Зависит от выбранной модели распознавания. Можно настроить баланс точность/производительность.
214+
> If you represent an IT company looking for a Junior .NET developer - I'd be happy to consider offers! | Если вы представитель IT-компании и ищете Junior .NET разработчика - буду рад рассмотреть предложения!
127215
128216
---
129217

130-
**Понравился проект? Поставьте звездочку!**
218+
**Like the project? Give it a star! | Понравился проект? Поставьте звездочку!**
131219

132-
💡 **Есть идеи или нашли баг?** Создайте [Issue](../../issues)
220+
💡 **Have ideas or found a bug? Create an [Issue](../../issues) | Есть идеи или нашли баг? Создайте [Issue](../../issues)**
133221

134-
🔧 **Хотите внести вклад?** Pull Request'ы приветствуются!
222+
🔧 **Want to contribute? Pull requests are welcome! | Хотите внести вклад? Pull Request'ы приветствуются!**

0 commit comments

Comments
 (0)