SeniorProject - Lune Ai Assistant

🧠 MMM-AI-Assistant – Prerequisites & Setup Guide

This document outlines all required dependencies and setup steps needed to run the AI assistant both standalone (test mode) and inside MagicMirror².

---

📦 Prerequisites

Before running this project, ensure the following are installed on your system:

---

1. Node.js (Required)

• Version: 18 or higher
• Check installed version:

node -v

• Download: https://nodejs.org/

👉 Node 18+ is required for built-in fetch support.

---

2. npm (Node Package Manager)

• Comes with Node.js
• Verify installation:

npm -v

---

3. Ollama (Local AI Runtime)

This project uses a local large language model via Ollama.

Install Ollama:

https://ollama.com

Pull required model:

ollama pull llama3

Run the model:

ollama run llama3

👉 This must be running BEFORE starting the assistant.

---

4. Operating System Requirements

macOS

• Fully supported ✅
• Built-in TTS works out of the box

Windows

• Supported ⚠️
• TTS depends on installed system voices

Linux (Optional)

• May require additional speech engines (e.g., espeak)

---

5. Text-to-Speech Dependency

This project uses the Node package:

npm install say

Notes:

• macOS → uses native say voices
• Windows → uses SAPI voices (may differ)
• Ensure system audio is enabled

---

6. Additional Node Packages

Install all required dependencies:

npm install

Or manually:

npm install say readline-sync

---

🧪 Standalone Testing Requirements

To run the assistant outside MagicMirror:

Required file:

• test.js

Run:

node test.js

---

⚠️ Common Issues

❌ Ollama not running

• AI will not respond
• Fix: run ollama run llama3

---

❌ No speech output

• Check system volume
• Verify say works manually:

say "Hello"

---

❌ Module errors (missing packages)

Run:

npm install

---

✅ Summary Checklist

Before running, ensure:

• Node.js 18+ installed
• npm installed
• Ollama installed
• llama3 model downloaded
• Ollama running
• Dependencies installed (npm install)
• Audio working (for TTS)

---

🚀 You're Ready!

Once all prerequisites are complete, you can:

• Run locally → node test.js
• Run in MagicMirror → npm run start

---

📌 Notes

This project is designed to:

• Run fully locally (no external APIs)
• Be cross-platform compatible
• Integrate seamlessly into MagicMirror²

---