# 🍯 NectarSTT  
**Nectar Speech-to-Text Engine**

NectarSTT (Nectar Speech To Text) is a Python-based speech recognition engine designed for real-time, offline-capable voice input. It is built to be modular, extensible, and suitable for AI assistants, automation systems, and accessibility tools.

This project focuses on **accurate speech recognition**, **low latency**, and **tight integration with AI pipelines**.

---

## ✨ Features

- 🎙️ Real-time speech-to-text
- 🧠 Modular engine design (easy to extend)
- ⚡ Optimized for low latency
- 🔌 Designed to integrate with AI / assistant systems
- 🖥️ Cross-platform (Windows, Linux)
- 🧩 Compatible with TTS pipelines (Piper / eSpeak NG)

---

## 📁 Project Structure
```
NectarSTT/
│
├── Production/
|   ├── InnoScript/ 
|   |   └── NectarSTT.iss
|   ├── icons8-speak-48
|   ├── LICENSE
|   ├── NectarSTT.reg
|   ├── postinstall.txt
|   └── preinstall.txt
|
├── Main-Engine/
│ ├── STT-Engine/ # Speech-to-text core
│ ├── TTS-Engine/ # Text-to-speech core
│ ├── Model/ # Speech models 
| ├── Sound/ # Sound Effects
| ├── Source/ # Test Code
│ └── Images/ # UI / assets
│
├── .gitignore
├── README.md
├── Main.py
└── requirements.txt
```
> ⚠️ **Note:** Large models and voice data are present in Realese.

---

## 🛠️ Installation

### 1️⃣ Clone the repository
```bash
git clone https://github.com/headlessripper/NectarSTT.git
cd NectarSTT
```
---

### 2️⃣ Create a virtual environment (recommended)
python -m venv venv
venv\Scripts\activate 

### 3️⃣ Install dependencies
pip install -r requirements.txt


---

## 📦 Models & Assets

Due to GitHub size limits, speech models and voice data are zipped into **Main-Engine.zip**.  
This archive contains:

- `Main-Engine/Model/`
- `Main-Engine/TTS-Engine/`

Extract `Main-Engine.zip` into the project directory before running NectarSTT.

> 💡 A setup script or model downloader may be added in future releases.

---

### ▶️ Usage

Example (basic run):

- `python main.py`

Or import as a module:

- `from nectar_stt import recognize_speech`
```
text = recognize_speech()
print(text)
```
---

## ⚙️ Configuration

You can configure:

- 🎤 Microphone device
- ⏱️ Timeout values
- 🌐 Language
- 🧠 Model selection

These settings can be adjusted in the engine UI or directly in the code, depending on your integration needs.


---

## 🚀 Roadmap / Ideas

- Automated model download & setup script
- Extended TTS engine support
- Additional language models
- Optional Futher GPU acceleration (where supported)
- Enhanced logging and debugging tools

---

## 🤝 Contributing

Contributions are welcome!

You can:

- 🐛 Report bugs
- 💡 Suggest new features
- 🔧 Submit pull requests

Please open an issue to discuss major changes before starting work.

---

## 📜 License
Use a Custom License
---

## ⭐ Support

If you find **NectarSTT** useful:

- ⭐ Star the repository
- 🐞 Report issues
- 💬 Share feedback and ideas

---

**Built with ❤️ in Python for high-quality, low-latency speech recognition.**
