# Ciyue

[![GitHub Release](https://img.shields.io/github/v/release/mumu-lhl/Ciyue)](https://github.com/mumu-lhl/Ciyue/releases/latest)
[![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/mumu-lhl/Ciyue/total)](https://github.com/mumu-lhl/Ciyue/releases/latest)
[![F-Droid Version](https://img.shields.io/f-droid/v/org.eu.mumulhl.ciyue)](https://f-droid.org/packages/org.eu.mumulhl.ciyue/)
[![Translation status](https://hosted.weblate.org/widget/ciyue/svg-badge.svg)](https://hosted.weblate.org/engage/ciyue/)

English | [中文](./README_CN.md)

A mdict dictionary with Android/Windows/Linux support.

## Features

* 📄 Support MDX/MDD (not on Linux yet)
* 🔍 Support multiple dictionaries search and display
* 🎨 Support Material You
* 🌐 AI Translate (Support OpenAI, Gemini, Deepseek...)
* 🔈 Support reading aloud
* 🔖 Bookmarking words to the word book

## Screenshots

| <img src="./metadata/en-US/images/phoneScreenshots/1.png"> | <img src="./metadata/en-US/images/phoneScreenshots/2.png"> | <img src="./metadata/en-US/images/phoneScreenshots/3.png"> | <img src="./metadata/en-US/images/phoneScreenshots/4.png"> | <img src="./metadata/en-US/images/phoneScreenshots/5.png"> |
|-|-|-|-|-|

## Install

[![Packaging status](https://repology.org/badge/vertical-allrepos/ciyue.svg)](https://repology.org/project/ciyue/versions)

[<img src="https://github.com/NeoApplications/Neo-Backup/raw/034b226cea5c1b30eb4f6a6f313e4dadcbb0ece4/badge_github.png"
    alt="Get it on GitHub"
    height="80">](https://github.com/mumu-lhl/Ciyue/releases/latest)
[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
     alt="Get it on F-Droid"
     height="80">](https://f-droid.org/packages/org.eu.mumulhl.ciyue/)

### Arch Linux

You can install Ciyue from the [AUR](https://aur.archlinux.org/packages/ciyue) or [archlinuxcn](https://github.com/archlinuxcn/repo/tree/master/archlinuxcn/ciyue) repository via your choice of [AUR helpers](https://wiki.archlinux.org/title/AUR_helpers).

```bash
yay -S ciyue
```

### AppImage

- Install via [AppMan](https://github.com/ivan-hc/AppMan) (rootless)

  ```bash
  appman -i ciyue
  ```
- Install via [AM](https://github.com/ivan-hc/AM)

  ```bash
  am -i ciyue
  ```

## Recommended Dictionaries

See [Wiki](https://github.com/mumu-lhl/Ciyue/wiki#recommended-dictionaries).

## Permissions

### INTERNET (Internet)

Ciyue uses WebView to display words in a dictionary, and WebView needs INTERNET permission to work, even if when displaying local data.

When checking for updates or requesting third-party services (such as AI Provider), Ciyue will use this permission. Ciyue will not independently initiate requests. 

## Discord

[Join our Discord server](https://discord.gg/BazBZuvKZG) to connect with the community!

QQ Group: `1057888678`

## Translation

You can visit [Weblate](https://hosted.weblate.org/engage/ciyue/) to add languages or fill in translations.

[![Translation status](https://hosted.weblate.org/widget/ciyue/multi-auto.svg)](https://hosted.weblate.org/engage/ciyue/)

## Sponsors

Thanks to their sponsorship for supporting the development of Ciyue!

You can donate at [Afdian](https://afdian.com/a/mumulhl), [Unifans](https://app.unifans.io/c/mumulhl) (Global), or wechat qr code:

<img height="300" src="./assets/wechat_pay.webp">

||
|-|
|The Blank Peiming|
|爱发电用户_c3f76|
|爱发电用户_8267c|
|蕬縌玢沰|
|爱发电用户_1b0db|
|爱发电用户_nW9j|

## Contributing

See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines on how to contribute to this project.

## Contributors

[![Contributor](https://contrib.rocks/image?repo=mumu-lhl/Ciyue)](https://github.com/mumu-lhl/Ciyue/graphs/contributors)

## Terms of Services

[Terms of Services](./TERMS_OF_SERVICE.md)

## Privacy Policy

[Privacy Policy](./PRIVACY_POLICY.md)

## Disclaimer

Using Ciyue means you acknowledge and agree that the maintainers and contributors of Ciyue are not responsible for any direct or indirect losses, problems, or adverse consequences arising from the use of Ciyue. This software is provided "as is," and users assume all risks associated with its use. 

## License

[MIT](./LICENSE)
