Skip to content

README.md

Latest commit

 

History

History
236 lines (158 loc) · 7.72 KB

README.md

File metadata and controls

236 lines (158 loc) · 7.72 KB

🌍 FloatQuickTrans🎉

A Professional Floating AI Translation Tool

Real-time streaming translation • Multi-window support • Text-to-speech • Always on top

❗️严禁他人将本软件直接下载，加上 “会员/升级“按钮 后上传到 app store 等的类似行为，谢谢！！

Version Platform License

English • 简体中文 • 繁體中文 • 日本語 • Français • Deutsch • Español • 한국어 • Русский • Türkçe

👀 Quick Look (Videos)

IMAGE ALT TEXT HERE IMAGE ALT TEXT HERE

✨ Features

🚀 Core Capabilities

  • 🌊 Real-time Streaming Translation - Watch translations appear as they're generated
  • 🪟 Multi-window Support - Create multiple translation windows with Cmd+N/Ctrl+N
  • 🔊 Text-to-Speech - Listen to translations in 30+ languages
  • 📌 Always on Top - Floating window stays above all applications
  • 🎯 Global Hotkeys - Quick access with Cmd+Shift+Y or Option+Space

🤖 AI Provider Support

  • TODO: OpenAI GPT - GPT-3.5, GPT-4, GPT-4o
  • DeepSeek - High-quality translations
  • Google Gemini - Advanced AI capabilities
  • TODO:Claude - Anthropic's powerful language model

⚠️ OpenAI and Claude: No API keys available yet, so no support for now. Sorry about that.

🌐 Language Support

  • 30+ Languages - Major world languages supported
  • Smart Detection - Automatic input language recognition
  • Flexible Input - Support for various language name formats

🖼️ Screenshots

Main Interface

Floating window stays above all applications

image image

Multi-window Mode

Settings Panel

Go https://aistudio.google.com/app/apikey 🧚‍♀️

Or https://platform.deepseek.com/usage 🐳

🚀 Quick Start

Prerequisites

  • Node.js 18+
  • pnpm (recommended) or npm

Installation

# Clone the repository
git clone https://github.com/hughedward/FloatQuickTrans.git
cd FloatQuickTrans

# Install dependencies
pnpm install

Development

# Start development server
pnpm dev

Build

# Build for your platform
pnpm build

# Platform-specific builds
pnpm build:mac    # macOS
pnpm build:win    # Windows
pnpm build:linux  # Linux

⚙️ Configuration

API Setup

  1. Click the Settings button in the app
  2. Choose your preferred AI provider
  3. Enter your API key
  4. Select default translation language

Supported Providers

Provider API Key Required Features
OpenAI TODO GPT-3.5, GPT-4, GPT-4o
DeepSeek ✅ High-quality translation
Google Gemini ✅ Advanced AI capabilities
Claude TODO Anthropic's language model

🎮 Usage

Basic Translation

  1. Input Text - Type or paste text to translate
  2. Set Target Language - Click language button to change
  3. Translate - Press Cmd+Enter or click translate
  4. Listen - Click 🔊 icon to hear pronunciation

Multi-window Workflow

  1. Create New Window - Press Cmd+N (macOS) or Ctrl+N (Windows)
  2. Independent Translation - Each window works separately
  3. Compare Results - Use multiple windows to compare translations

Global Hotkeys

  • Cmd+Shift+Y / Ctrl+Shift+Y - Show/hide all windows
  • Cmd+N / Ctrl+N - Create new translation window
  • Cmd+Enter - Execute translation
  • ESC - Close current window

🛠️ Development

Tech Stack

  • Frontend: React 19 + TypeScript
  • Desktop: Electron 35
  • Build Tool: Vite + electron-vite
  • Styling: CSS with glass morphism effects

Project Structure

src/
├── main/           # Electron main process
├── renderer/       # React frontend
├── preload/        # Electron preload scripts
└── model/          # AI providers & language maps

🫰Contributing

We welcome contributions from the community! If you'd like to contribute, please follow these steps:

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature/git checkout -b bugfix/fix-xxx)
  3. Commit your changes (git commit -m 'Add amazing feature'/git commit -m 'Fix xxx bug:xxxx').Make your changes and commit them with descriptive messages/shotcuts.Please write comments in the code as much as possible.
  4. Push to the branch (git push origin feature/amazing-feature/git push origin bugfix/fix-xxx).Please keep the code clean.
  5. Open a Pull Request. Submit a pull request.It is recommended to focus on a single feature or fix, avoiding making too many changes at once.
  6. We'll review your PR and merge it once it's ready. We'll also appreciate it if you're willing to help review other PRs as well!

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

Made with ❤️ for the global community

⭐ Star this project • 🐛 Report Bug • 💡 Request Feature

Star History

Star History Chart

thanks https://www.star-history.com/#hughedward/FloatQuickTrans&Date

image

If you find my work helpful, I’d be truly grateful if you’d consider sponsoring me.

image image Sponsor me image Your support is the driving force behind my creations.🎉