Aictionary  by ahpxex

Cross-platform desktop dictionary app for English learning

Created 4 months ago
755 stars

Top 46.1% on SourcePulse

GitHubView on GitHub
Project Summary

A desktop dictionary application designed for speed, conciseness, and effective English learning. It targets users seeking detailed explanations and quick lookups, offering a significant benefit through its hybrid approach of local data and LLM-powered enrichment.

How It Works

Aictionary is a cross-platform desktop application built using the Avalonia UI framework. It provides fast word lookups leveraging a pre-downloaded vocabulary of the 25,000 most frequent English words. For terms not found locally, it integrates with large language models (requiring an OpenAI API key) to generate comprehensive definitions. The application emphasizes a responsive user experience with a lightweight, always-available lookup window and keyboard shortcuts, alongside local caching for offline access and history management.

Quick Start & Requirements

  • Installation:
    • macOS: Download Aictionary.dmg, drag the App to Applications.
    • Windows: Select self-contained or framework-dependent build based on .NET runtime.
    • Linux: Execute the provided binary or compile from source. Debian/Ubuntu users can build/install .deb packages (scripts/build-deb.sh). Arch Linux users can build/install .pkg.tar.zst (scripts/build-arch.sh).
  • Prerequisites:
    • OpenAI API Key (for LLM-driven definitions).
    • .NET 8.0 SDK (for building from source).
  • Links: Installation instructions are detailed within the project documentation.

Highlighted Details

  • Offers detailed Chinese explanations, including semantic context, example sentences, and common collocations, suitable for technical and academic use.
  • Features a real-time, keyboard-navigable lookup window designed for minimal context switching during English material review.
  • Automatic local caching of query history and definitions enables offline access, with options to refresh data.
  • Provides multiple distribution formats: self-contained, framework-dependent, and platform-specific installers (e.g., macOS DMG).

Maintenance & Community

The project welcomes feedback and contributions via GitHub Issues and Pull Requests. Discussions are encouraged for expanding vocabulary, adapting to new platforms, or integrating alternative LLMs. Specific community channels (like Discord/Slack) or a public roadmap are not detailed in the provided documentation.

Licensing & Compatibility

  • License: Not specified in the provided documentation.
  • Compatibility: Cross-platform support for Windows, macOS, and Linux via the Avalonia UI framework. Requires .NET 8.0 runtime for framework-dependent builds.

Limitations & Caveats

Full functionality, particularly for out-of-vocabulary words, relies on an external OpenAI API Key. Building from source necessitates the .NET 8.0 SDK. The project's license is not explicitly stated, posing a potential adoption blocker.

Health Check
Last Commit

3 months ago

Responsiveness

Inactive

Pull Requests (30d)
0
Issues (30d)
0
Star History
14 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.