Skip to content

docs: eve-agent => vael and instructions for Tkinker #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jmoody wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: eve-agent => vael and instructions for Tkinker #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
73988b7
docs: eve-agent => vael
jmoody May 20, 2026
f57ca3e
add Tkinter as a system-level dependency
jmoody May 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 22 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,12 +113,30 @@ Parallel processes:
- [Claude Desktop](https://claude.ai/download)
- An EVE Online account
- A Discord server (optional, for phone alerts)
- **Tkinter** (required for the game overlay — see platform notes below)

#### Tkinter installation

Tkinter is a system-level dependency that must be installed separately from pip packages:

```bash
# macOS (Homebrew)
brew install python-tk@3.13 # Match your Python version

# Ubuntu/Debian
sudo apt install python3-tk

# Fedora
sudo dnf install python3-tkinter

# Windows — included with the official Python installer (no action needed)
```

### 1. Clone and install

```bash
git clone https://github.com/filt3rr/eve-agent.git
cd eve-agent
git clone https://github.com/filt3rr/vael.git
cd vael
python -m venv .venv

# Windows
Expand Down Expand Up @@ -153,7 +171,7 @@ Edit `.env` with your credentials:
EVE_CLIENT_ID=your_client_id
EVE_CLIENT_SECRET=your_client_secret
EVE_CALLBACK_URL=http://localhost:8765/callback
EVE_USER_AGENT=eve-agent/0.1 (your_email@example.com)
EVE_USER_AGENT=vael/0.1 (your_email@example.com)
DISCORD_WEBHOOK_URL=https://discord.com/api/webhooks/... # optional
```

Expand Down Expand Up @@ -256,7 +274,7 @@ Generate my weekly digest
## Project Structure

```
eve-agent/
vael/
├── src/eve_agent/
│ ├── auth.py # EVE SSO OAuth2 + PKCE + encrypted tokens
│ ├── cache.py # ESI response cache (SQLite, respects Expires headers)
Expand Down