Skip to content

Latest commit

 

History

History
73 lines (50 loc) · 3.34 KB

README_EN.md

File metadata and controls

73 lines (50 loc) · 3.34 KB
Raw

YUKI
YUKI - Yummy Utterance Knowledge Interface

JavaScript Style Guide GPL 3.0 LICENSE Build status

中文 • English

how it looks

Emergency Announcement

In the evening of May 30th, 2020, many users faced an error reporting window with error ERR: TypeError: Cannot read property 'target' of undefined. Through investigation, this report is due to the highly instability of ColorfulClouds API. Now a emergency patch of version 0.14.3 has been released to repair that problem. However, at present ColorfulClouds API still cannot be used, hence users of all versions please kindly disable ColorfulClouds API (Method: open config\config.json in YUKI root directory, change the enable property of the object with name = '彩云' in the onlineApis array from true to false). After disabling, the problem will be resolved without upgrading to v0.14.3.

Download

  1. Click Here
  2. Click " > Assets " under the description of latest version, and the first ZIP file is the compiled version of YUKI

Motivation

We already have Visual Novel Reader (VNR), so why another galgame translator?

Well, there are three reasons:

  1. VNR uses Python (even Python 2) for UI generation, which is extremely slow and unnecessary.
  2. sakuradite.com is down, seems there is no official maintenance for VNR.
  3. VNR has so many features (I mean, Python scripts), which can cause desperation when trying to modify/add one.

However, if using Qt5, it can be such an annoy thing to manage memory/i18n/configuration manually.

So, using Electron as frontend and traditional Windows API (Text Hooker wrapped as a native Node module) as backend seems a good idea.

Features

  • Real-time text extractor from running Galgame
  • Get translation from dictionary: JBeijing, etc.
  • Get translation from online translator API: Google, Baidu, Youdao, etc.
  • Programmable external translator API (refer to JavaScript files in config\ folder for examples)
  • Show on floating window on top of game window
  • Custom online API settings: URL, request format, response regex parser
  • Support extension

TODO

Usage

After installing Node.js and yarn, run the following commands in any folder:

git clone https://github.com/project-yuki/YUKI.git
cd YUKI
yarn
yarn dev

License

YUKI is licensed under GPLv3.

I'd like to use MIT license, but the upstream softwares (Text Hooker for example) are licensed under GPL, so, no choice.