mirror of
https://github.com/xiaoyifang/goldendict-ng.git
synced 2024-12-05 00:24:06 +00:00
260 lines
9.8 KiB
Markdown
260 lines
9.8 KiB
Markdown
# GoldenDict-ng
|
||
|
||
[](https://crowdin.com/project/goldendict-ng)
|
||
[](https://sonarcloud.io/summary/new_code?id=xiaoyifang_goldendict)
|
||
[](https://github.com/xiaoyifang/goldendict-ng/actions/workflows/windows-6.x-xapian.yml)
|
||
[](https://github.com/xiaoyifang/goldendict-ng/actions/workflows/ubuntu-6.2-xapian.yml)
|
||
[](https://github.com/xiaoyifang/goldendict-ng/actions/workflows/macos-homebrew-xapian.yml)
|
||
|
||
The Next Generation GoldenDict. A feature-rich open-source dictionary lookup program,
|
||
supporting [multiple dictionary formats](https://xiaoyifang.github.io/goldendict-ng/dictformats/) and online
|
||
dictionaries.
|
||
|
||
| Linux | Windows | macOS |
|
||
|--|--|--|
|
||
| [<img src="website/docs/img/linux_genshin.webp" width="500"/>](https://xiaoyifang.github.io/goldendict-ng/) | [<img src="website/docs/img/windows_white.webp" width="500"/>](https://xiaoyifang.github.io/goldendict-ng/) | [<img src="website/docs/img/mac_black.webp" width="500"/>](https://xiaoyifang.github.io/goldendict-ng/) |
|
||
|
||
# Some significant features of this fork
|
||
|
||
- webengine with latest html/css feature support
|
||
- support >4GB dictionary
|
||
- support highdpi screen resolution
|
||
- built with xapian as fulltext engine
|
||
- support Qt5.15.2 and higher ,include latest Qt6
|
||
- performance optimization(eg. >10000000 headwords support)
|
||
- anki integration
|
||
- dark theme
|
||
- daily auto release support
|
||
- lots of bug fixes and improvements
|
||
|
||
## Installation
|
||
|
||
### Downloads
|
||
|
||
* [Latest stable version](https://github.com/xiaoyifang/goldendict/releases/latest)
|
||
* [Daily pre-release builds](https://github.com/xiaoyifang/goldendict/releases).
|
||
|
||
Both Qt5 and Qt6 builds are provided.
|
||
|
||
## Windows
|
||
|
||
Choose either
|
||
|
||
* `****-installer.exe ` for traditional installer experience
|
||
* `****.zip` for simply unzip and run experience
|
||
|
||
If Qt's version is not changed, you can also download a single `goldendict.exe` and drop it into previous installation's folder.
|
||
|
||
## Linux
|
||
|
||
* `.Appimage` can be used in any recent linux distros.
|
||
* [Debian packages](https://tracker.debian.org/pkg/goldendict-webengine) are available in Debian 12 or later.
|
||
* [Ubuntu packages](https://launchpad.net/ubuntu/+source/goldendict-webengine) are available in Ubuntu 23.04 or later.
|
||
* Archlinux can use [goldendict-ng-git](https://aur.archlinux.org/packages/goldendict-ng-git). Built binary is also availiable from [archlinuxcn's repo](https://github.com/archlinuxcn/repo/tree/master/archlinuxcn/goldendict-ng-git).
|
||
* [Gentoo package from PG_Overlay](https://gitlab.com/Perfect_Gentleman/PG_Overlay/-/blob/master/app-text/goldendict/goldendict-9999-r6.ebuild)
|
||
* openSUSE ships an old version of this fork.
|
||
|
||
> Help wanted to package this GoldenDict for linux distros.
|
||
|
||
## macOS
|
||
|
||
One of the `.dmg` installers.
|
||
|
||
## Help GoldenDict's Development
|
||
|
||
GoldenDict is developed by volunteers.
|
||
|
||
All kinds of help like answering questions, bug reporting, testing, translation and coding are welcomed.
|
||
|
||
To translate the interface, you can use the Crowdin <https://crowdin.com/project/goldendict-ng>
|
||
|
||
To start development, check out [developer guide](https://xiaoyifang.github.io/goldendict-ng/developer/)
|
||
|
||
## Build from source
|
||
|
||
### Dependencies
|
||
|
||
* C++17 compiler
|
||
* Qt 5.15 or latest QT version 6.X
|
||
* Various libraries on Linux, see below
|
||
* On Mac and Windows all the libraries are included in the repository
|
||
* Qt Creator is recommended for development
|
||
|
||
Steps below are using qt5, and you may use qt6 by replacing `5` with `6`.
|
||
|
||
#### Ubuntu
|
||
|
||
```
|
||
sudo apt-get install git pkg-config build-essential qt5-qmake \
|
||
libvorbis-dev zlib1g-dev libhunspell-dev x11proto-record-dev \
|
||
libxtst-dev liblzo2-dev libbz2-dev \
|
||
libavutil-dev libavformat-dev libeb16-dev \
|
||
libqt5svg5-dev libqt5x11extras5-dev qttools5-dev \
|
||
qttools5-dev-tools qtmultimedia5-dev libqt5multimedia5-plugins libqt5webchannel5-dev qtwebengine5-dev \
|
||
libqt5texttospeech5-dev
|
||
```
|
||
|
||
#### Fedora 35
|
||
|
||
```
|
||
sudo dnf install git pkg-config libzstd-devel opencc-devel xz-devel xz-lzma-compat\
|
||
libvorbis-devel zlib-devel hunspell-devel lzo-devel bzip2-devel \
|
||
ffmpeg-devel eb-devel qt5-qtx11extras-devel libXtst-devel \
|
||
libxkbcommon-devel qt5-qtbase qt5-qttools qt5-qtsvg-devl qt5-qtwebengine-devel qt5-qtmultimedia-devel
|
||
```
|
||
|
||
### Build steps
|
||
|
||
Clone this repository:
|
||
```
|
||
git clone https://github.com/xiaoyifang/goldendict-ng.git
|
||
```
|
||
|
||
#### Linux build
|
||
|
||
```
|
||
cd goldendict-ng && qmake-qt5 && make
|
||
```
|
||
|
||
#### macOS build
|
||
|
||
```
|
||
brew install qt # or use official offline installer
|
||
qmake CONFIG+=release CONFIG+=zim_support CONFIG+=chinese_conversion_support QMAKE_APPLE_DEVICE_ARCHS="x86_64 arm64"
|
||
make
|
||
make install
|
||
```
|
||
|
||
#### Windows build
|
||
|
||
the source code has offered precompile x64 windows libs on winlibs/lib/msvc. you can build your own version either.
|
||
|
||
To build with Visual Studio.
|
||
check this [how to build with visual studio](howto/how%20to%20build%20and%20debug%20with%20VS2019.md)
|
||
|
||
Alternatively, you might want to load `goldendict.pro` file from within Qt Creator.
|
||
|
||
### Build Configurations
|
||
|
||
**Notice**: All additional configs for `qmake` that must be combined in one of pass config options to `qmake`:
|
||
```
|
||
qmake-qt5 "CONFIG+=release" "CONFIG+=zim_support" "CONFIG+=chinese_conversion_support"
|
||
```
|
||
|
||
To ensure the changes applied, you may want to use `make clean` before `make`.
|
||
|
||
#### Building with Chinese conversion support
|
||
|
||
To add Chinese conversion support you need at first install libopencc-dev package, then pass `"CONFIG+=chinese_conversion_support"` to `qmake`.
|
||
|
||
```
|
||
sudo apt-get install libopencc-dev
|
||
```
|
||
|
||
#### Building with Zim dictionaries support
|
||
|
||
To add Zim and Slob formats support you need at first install lzma-dev and zstd-dev packages, then pass `"CONFIG+=zim_support"` to `qmake`
|
||
|
||
```
|
||
sudo apt-get install liblzma-dev libzstd-dev libzim-dev
|
||
```
|
||
|
||
**Note**: Some linux distros do not support latest zim version, so you need to compile from latest source.
|
||
On Windows, you can use vcpkg to compile the libzim
|
||
```
|
||
vcpkg install libzim:x64-windows
|
||
```
|
||
and copy the corresponding(debug/release) library to the `winlibs/lib` folder. the zim's `include` directory to the `winlibs/include` directory.
|
||
|
||
|
||
#### Building without Epwing format support
|
||
|
||
If you have problem building with libeb-dev package, you can pass
|
||
`"CONFIG+=no_epwing_support"` to `qmake` in order to disable Epwing format support
|
||
|
||
#### Building without internal audio players
|
||
|
||
If you have problem building with FFmpeg (for example, very old linux distro), you can pass
|
||
`"CONFIG+=no_ffmpeg_player"` to `qmake` in order to disable FFmpeg internal audio player back end.
|
||
|
||
If you have problem building with Qt5 Multimedia or experience GStreamer run-time errors (for example, Ubuntu 14.04), you can pass
|
||
`"CONFIG+=no_qtmultimedia_player"` to `qmake` in order to disable Qt Multimedia internal audio player back end.
|
||
|
||
#### Building with xapian
|
||
|
||
build xapian from source, download and extract the xapian-core source code.
|
||
|
||
```
|
||
./configure
|
||
make
|
||
make install
|
||
```
|
||
|
||
On Windows,follow the instructions in the xapian-core/INSTALL Visual Studio parts.（**xapian does not support to use the Debug lib in Windows. have to debug in release version mode using xapian's release lib**）.
|
||
A precompiled version of xapian lib has provided in winlibs
|
||
On Linux, install libxapian-dev package using package manager.
|
||
On Mac, use homebrew to install xapian `brew install xapian`
|
||
|
||
Goldendict-ng has used xapian as the default and the only one fulltext engine.
|
||
|
||
#### use iconv (recommend to enable)
|
||
use `CONFIG+=use_iconv` to enable this feature. when enabled ,iconv will be used to convert encoding other than the QTextCodec(which will be deprecated in future Qt version)
|
||
|
||
```
|
||
qmake "CONFIG+=use_iconv"
|
||
```
|
||
|
||
when enabled ,iconv should be installed on the platform at the same time.
|
||
|
||
#### use breakpad
|
||
|
||
use `CONFIG+=use_breakpad` to enable this crash dump. when enabled [breakpad](https://chromium.googlesource.com/breakpad/breakpad/+/master/docs), goldendict will generate a crash dump alongside with Goldendict in the `crash` directory.
|
||
|
||
on Windows:
|
||
`vcpkg install breakpad:x64-windows-release` and copy the installed packages into `thirdparty/breakpad` directory.
|
||
with a structure like this:
|
||
```
|
||
├─breakpad
|
||
│ ├─include
|
||
│ │ ├─client
|
||
│ │ │ └─windows
|
||
│ │ │ ├─common
|
||
│ │ │ ├─crash_generation
|
||
│ │ │ ├─handler
|
||
│ │ │ └─sender
|
||
│ │ ├─common
|
||
│ │ │ └─windows
|
||
│ │ └─google_breakpad
|
||
│ │ ├─common
|
||
│ │ └─processor
|
||
│ └─lib
|
||
```
|
||
|
||
on Mac/Linux:
|
||
[vcpkg](https://techviewleo.com/install-vcpkg-c-library-manager-on-linux-macos-windows/) can also be used or you can just install breakpad from source or use precompiled packages.
|
||
|
||
Then enable google breakpad like this with qmake:
|
||
|
||
```
|
||
qmake "CONFIG+=use_breakpad"
|
||
```
|
||
|
||
## Support
|
||
|
||
Bug reporting: [GoldenDict issue tracker](https://github.com/xiaoyifang/goldendict-ng/issues)
|
||
|
||
General discussions: [discussions](https://github.com/xiaoyifang/goldendict-ng/discussions)
|
||
|
||
## License
|
||
|
||
This project is licensed under the <b>GNU GPLv3+</b> license, a copy of which can be found in the `LICENSE.txt` file.
|
||
|
||
## History
|
||
|
||
The original project was developed at <http://goldendict.org/> and <https://github.com/goldendict/goldendict>.
|
||
|
||
## Thank JetBrains for the help
|
||
|
||
[](https://jb.gg/OpenSourceSupport)
|
||
|