Home - Incomplete-Infinity/eve-companion GitHub Wiki

โœจ EVE Companion App

Welcome to the official Wiki for the EVE Companion App, a modular and extensible desktop toolkit for players of EVE Online. Built with Electron, it provides in-game and out-of-game features to support fleet coordination, market tracking, character tools, industry, and more.


๐Ÿš€ Project Goals

  • Provide a fully featured app for pilots, fleet commanders, corporations, and alliances
  • Integrate EVEโ€™s Swagger Interface (ESI) for real-time data access
  • Enable local-first storage and performance via IndexedDB
  • Present a highly themed, immersive, sci-fi-inspired interface
  • Focus on rapid delivery, using external libraries first and replacing them later

โš™๏ธ Core Tech Stack

  • Electron + Forge + Webpack โ€“ Desktop shell and module bundling
  • Zustand โ€“ Lightweight global state management
  • Dexie.js โ€“ IndexedDB wrapper for local caching
  • ESI Swagger Client โ€“ Auto-generated TypeScript/JavaScript client
  • three.js, d3.js, Chart.js, svg.js โ€“ Visuals, maps, graphs, and fittings
  • Halfmoon, Topcoat, Augmented UI โ€“ Styling and interface components
  • tippy.js, notyf, interact.js โ€“ Tooltips, notifications, window behavior

๐Ÿงฑ Directory Overview

Folder Purpose
src/js/main/ Core logic classes, one per file
src/api/esi/ Auto-generated Swagger client for ESI
style-guide/ Theme settings, UI references
docs/ JSDoc output
img/ Logos, design inspiration

๐Ÿ“š Next Steps

Start exploring detailed topics below: