Skip to content

Commit 2be417e

Browse files
committed
partial
1 parent 2f75f22 commit 2be417e

File tree

1 file changed

+28
-42
lines changed

1 file changed

+28
-42
lines changed

README.md

Lines changed: 28 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,23 @@
22

33
> **Formerly NetAlert-3.0**
44
5-
YODA is a voice-activated **Intrusion Detection System** designed for real-time LAN monitoring. Built with a hacker-themed dashboard and live network visualization, YODA tracks every device on your network and provides instant status updates.
5+
YODA is a voice-activated **Intrusion Detection System** designed for real-time LAN monitoring. The core feature is **voice control** - use natural language commands to manage your network, including kicking devices off your network, querying the number of active devices, and requesting detailed node information. All data is visualized through a hacker-themed dashboard with live network monitoring and Matrix-style effects.
66

7-
**🤖 AI-Powered (Coming Soon)** - We're working on integrating AI for intelligent threat detection and anomaly analysis. Contributions welcome!
7+
**🤖 AI-Powered (Coming Soon)** - Integrating AI for intelligent threat detection and anomaly analysis. Contributions welcome!
88

99
---
1010

11-
## Features
11+
## Features
1212

13-
- 🔍 **Real-time device discovery** via ARP scanning
14-
- 🎨 **Hacker-themed web dashboard** with Matrix effects
15-
- 📊 **Live monitoring** of IP, MAC, hostname, vendor info
16-
- 🗣️ **Voice commands** (hold spacebar to activate)
17-
- 🔴 **Online/Offline tracking** for all network nodes
18-
-**No symlinks required** - data served directly from memory
19-
- 🌐 **Cross-platform** support (Linux, macOS, Windows)
13+
- Real-time device discovery via ARP scanning
14+
- Hacker-themed web dashboard with Matrix effects
15+
- Live monitoring of IP, MAC, hostname, vendor info
16+
- Voice commands for network management
17+
- Online/Offline tracking for all network nodes
2018

2119
---
2220

23-
## 🚀 Quick Start
21+
## Quick Start
2422

2523
1. **Clone and navigate**
2624
```bash
@@ -30,20 +28,29 @@ YODA is a voice-activated **Intrusion Detection System** designed for real-time
3028
2. **Setup virtual environment**
3129
```bash
3230
python3 -m venv venv
33-
source venv/bin/activate # On Windows: venv\Scripts\activate
31+
source venv/bin/activate
3432
```
3533

3634
3. **Install dependencies**
3735
```bash
3836
pip install -r ../requirements.txt
3937
```
4038

41-
4. **Run YODA**
39+
4. **Install mpg123 (required for voice commands)**
40+
```bash
41+
# Debian/Ubuntu
42+
sudo apt install mpg123
43+
44+
# Arch
45+
sudo pacman -S mpg123
46+
```
47+
48+
5. **Run YODA**
4249
```bash
4350
sudo venv/bin/python nsm_main.py
4451
```
4552

46-
5. **Access the dashboard**
53+
6. **Access the dashboard**
4754
- The program will prompt you for:
4855
- **Interface** (e.g., `eth0`, `wlan0`)
4956
- **Subnet** (e.g., `192.168.1.0/24`)
@@ -52,7 +59,7 @@ YODA is a voice-activated **Intrusion Detection System** designed for real-time
5259

5360
---
5461

55-
## 🎮 Usage
62+
## Usage
5663

5764
- **Auto-refresh**: Dashboard updates every 2 seconds (configurable)
5865
- **Search & Filter**: Find nodes by IP, hostname, vendor, or MAC
@@ -62,37 +69,16 @@ YODA is a voice-activated **Intrusion Detection System** designed for real-time
6269

6370
---
6471

65-
## 🤝 Contributing
72+
## Contributing
6673

67-
Contributions are **welcome**, especially for:
68-
- 🤖 **AI integration** for threat detection
69-
- 🔒 **Automated blocking/prevention** features
70-
- 🎤 **Enhanced voice commands**
71-
- 📡 **Port scanning integration**
74+
Contributions are welcome, especially for:
75+
- AI integration for threat detection
76+
- Automated blocking/prevention features
77+
- Enhanced voice commands
78+
- Port scanning integration
7279

7380
Submit PRs to [github.com/nsm-barii/netalert-3.0](https://github.com/nsm-barii/netalert-3.0)
7481

7582
---
7683

77-
## 📋 Requirements
78-
79-
- Python 3.x
80-
- Scapy
81-
- Rich (for CLI)
82-
- See `requirements.txt` for full dependencies
83-
84-
---
85-
86-
## 📁 Project Structure
87-
88-
```
89-
nsm_modules/ # Backend Python modules
90-
web_modules/ # Frontend (HTML/CSS/JS)
91-
├── yoda.html # Main dashboard
92-
├── css/ # Styles
93-
└── js/ # JavaScript + Matrix effects
94-
```
95-
96-
---
97-
9884
**Built by NSM Barii** | [GitHub](https://github.com/nsm-barii/netalert-3.0) | Contributions Welcome

0 commit comments

Comments
 (0)