An open API service indexing awesome lists of open source software.

https://github.com/rutvij26/zilean

An AI agent that watches your League of Legends game in real time and delivers contextual tips to your screen while you play
https://github.com/rutvij26/zilean

agentic-ai claude electron league-of-legends typescript

Last synced: 3 months ago
JSON representation

An AI agent that watches your League of Legends game in real time and delivers contextual tips to your screen while you play

Awesome Lists containing this project

README

          

# Zilean - LoL AI Agent

An AI agent that watches your League of Legends game in real time and delivers contextual tips to your screen while you play — no manual prompting, no tab-switching.

![CI](https://github.com/rutvij26/zilean/actions/workflows/ci.yml/badge.svg)
![Release](https://img.shields.io/github/v/release/rutvij26/zilean)

## Features

- Delivers real-time tips directly to your screen as the game unfolds
- Transparent overlay — stays on top of the game, never breaks your focus
- Watches your gold, items, kills, objectives, and game phase automatically
- Calls Claude only when something meaningful changes (not every tick)
- Alt+C to show or hide the overlay instantly
- Auto-updates via electron-updater on launch or from tray

## Requirements

- Windows 10/11 (x64)
- An Anthropic API key — the app will not function without one
- Get one at console.anthropic.com
- Cost: approximately $0.05-0.15 per 30-minute game (claude-sonnet-4-6 at roughly 10 API calls per game)
- See anthropic.com/pricing for current rates

## Installation

Download the latest release from the [Releases page](https://github.com/rutvij26/zilean/releases):

- `Zilean Setup x.y.z.exe` — NSIS installer (recommended)
- `Zilean x.y.z.exe` — portable, no install needed

Windows SmartScreen may show a warning on first run. Click "More info" then "Run anyway" — this is expected for unsigned open-beta software.

## Usage

1. Install and launch Zilean
2. Open Settings with `Alt+,` and paste your Anthropic API key
3. Start a League of Legends game — coaching begins automatically

## Keyboard Shortcuts

| Shortcut | Action |
|----------|--------|
| `Alt+C` | Toggle overlay |
| `Alt+,` | Open Settings |

## Development

**Prerequisites:** Node.js 20+, League of Legends (or mock data)

```bash
git clone https://github.com/rutvij26/zilean.git
cd zilean
npm install
npm run dev
```

For V2 postgres/pgvector features:
```bash
docker compose up -d
npm run dev
```

```bash
npm test # Run all tests
npm run typecheck # TypeScript check
npm run build:win # Produce dist/ with NSIS installer + portable exe
```

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for setup, branch naming, commit format, and PR checklist.

## License

[PolyForm Noncommercial 1.0.0](LICENSE) - free for personal and educational use, not for commercial use.