Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Harsha200105/DesktopAssistant/llms.txt

Use this file to discover all available pages before exploring further.

The config.ini file is required by the Windows entry point (Jarvis2_4windows.py). On startup the script checks for its presence with os.path.isfile('./config.ini') and exits with an error message if the file is missing. Every runtime setting — from your name used in greetings to microphone sensitivity and email credentials — is read from this file at launch.

Full config.ini template

Copy the block below into src/config.ini and fill in the values that apply to your setup:
[DEFAULT]
master = YourName
search_engine = Google
debug = False
musicpath = 
voice = Male
rate = 150
volume = 100
energy_threshold = 300

[EMAIL]
server = smtp.gmail.com
port = 587
username = 
password = 

Parameter reference

[DEFAULT] section

master
string
required
Your name. Jarvis uses it in time-based greeting messages such as "Good Morning YourName". Set this to whatever you want Jarvis to call you.
search_engine
string
default:"Google"
The default search engine used by the search command. Built-in options are Google, Bing, DuckDuckGo, and Youtube. You can also supply a custom domain name (e.g. stackoverflow) — Jarvis validates the domain by making a test request to https://<value>.com and, if it responds with HTTP 200, uses it as the search base URL. If the domain is unreachable, Jarvis falls back to Google.
debug
boolean
default:"False"
When set to True, Jarvis replaces microphone input with a keyboard prompt (Command |--> ). Use this when you want to test commands without a working microphone or audio drivers.
musicpath
string
Absolute path to your music folder, including a trailing separator — for example C:\Users\You\Music\. The play music command looks for files named music1.mp3 through music4.mp3 inside this directory.
voice
string
default:"Male"
TTS voice gender. Accepted values are Male and Female. Male maps to voices[0].id and Female to voices[1].id in the pyttsx3 SAPI5 voice list. You can change this at runtime with the change voice to male/female command.
rate
integer
default:"150"
Speech rate in words per minute passed to pyttsx3’s rate property. Lower values produce slower speech; higher values produce faster speech. Can be changed at runtime with the change rate to <number> command.
volume
integer
default:"100"
Speaker volume on a scale of 0 to 100. Internally the value is divided by 100 before being passed to pyttsx3 (engine.setProperty('volume', int(volume)/100)). Can be changed at runtime with the change volume to <number> command.
energy_threshold
integer
default:"300"
Microphone energy threshold used by speech_recognition. Higher values require louder audio before Jarvis starts recording; lower values make the microphone more sensitive. Adjust this if Jarvis mis-triggers in a noisy environment or fails to detect quiet speech.

[EMAIL] section

server
string
default:"smtp.gmail.com"
SMTP server hostname for outgoing mail. The default is Gmail’s SMTP server. Change this if you use a different email provider (e.g. smtp.office365.com for Outlook).
port
integer
default:"587"
SMTP port. Port 587 is the standard port for STARTTLS. Most providers that support STARTTLS use this port.
username
string
The full email address used to authenticate with the SMTP server and as the From address when sending mail (e.g. you@gmail.com).
password
string
Password for the email account. For Gmail with two-factor authentication enabled, use a 16-character App Password instead of your account password. See Email Setup for details.

Placing config.ini

The file must live in the src/ directory, alongside the Python source files. All three Python modules (Jarvis2_4windows.py, actions.py, commands.py) call config.read('config.ini') with a relative path, so the working directory when you run Jarvis must also be src/.
# Correct — run from inside the src/ directory
cd src
python Jarvis2_4windows.py
If you run the script from the project root instead of src/, Python will look for config.ini in the root directory and not find it. Always cd into src/ first, or adjust the path in the source files.
Set debug = True while you’re getting started. Jarvis will prompt you for commands at the terminal instead of listening through the microphone, so you can verify that every setting is correct before switching to voice input.

Build docs developers (and LLMs) love