Awesome

rikaikun <!-- omit in toc -->

rikaikun is a Chrome extension that helps you to read Japanese web pages by showing the reading and English definition of Japanese words when you hover over them.

Table of Contents <!-- omit in toc -->

• Background
  • Current Goals
• Install
  • Via the Chrome Web Store
  • Via Microsoft Edge Add-ons
  • As an Unpacked Extension
• Usage
  • Features
  • Options
    • Keyboard Shortcuts
• Maintainers
• Credits
• Contributing
  • Contributors ✨
• License

Background

rikaikun is a port of Rikaichan I started in 2010 when Chrome released its extension API. It was originally hosted on Google Code until Google Code was canceled and everything was migrated to GitHub.

Rikaichan was a Firefox extension that emulated the popup translations of RikaiXUL. It was the best Japanese-to-English inline translation tool in the browser.

I started with the idea that I would create the Chrome equivalent of Rikaichan from scratch using my own ideas. However, after I tried Rikaichan, I realized that it was already quite good, and starting from scratch would be wasting the excellent work of its developers. Instead, I forked Rikaichan and updated the APIs to work with the Chrome extension model.

In 2018, Firefox killed the extension model that Rikaichan was based on, but other similar extensions have since been created and ported to various browsers. Not much was happening with rikaikun during that time but we've started to work on it again!

Current Goals

• Refactor code base such that it becomes very easy to maintain and contribute to.
• Fix bugs in dictionary output.
• Work on new features like other dictionaries, OCR, and static popup/lookup bar. Feel free to suggest/:thumbsup: more.

Install

Via the Chrome Web Store

Visit rikaikun on the Chrome Web Store and click 'Add to Chrome'.

Via Microsoft Edge Add-ons

Visit rikaikun on Microsoft Edge Add-ons and click 'Get'.

As an Unpacked Extension

You can also install rikaikun from the source as an unpacked extension:

• Get the latest release from Github:
• Follow these instructions from the web-scrobbler Chrome extension. (substituting rikaikun where appropriate)

Usage

Activate the extension by clicking on the 理 in the top right. When the introductory pop up appears, rikaikun is ready for action.

When rikaikun is active, hovering over Japanese words will trigger a translation pop-up.

See it in action in this Youtube demo by Tariq Sheikh.

Features

• Read out the Japanese words using Chrome Text To Speech capabilities. (Off by default)
• Change where the popup appears on your screen. (Where your mouse cursor is by default)
• Copy current definitions to they keyboard.
• Add a delay before popup is shown to avoid constant distractions.
• Require a modifier key to be held down in order to see popups.
• Hide definitions to see only the readings of words.

Options

You can access the options from the extension page if you have it installed or by right clicking on the rikaikun icon.

Keyboard Shortcuts

Maintainers

@melink14

Credits

• Jon Zarate for their work on Rikaichan
• Todd Rudick for their work on the original RikaiXUL
• This extension uses JMdict/EDICT and KANJIDIC dictionary files. These files are the property of the Electronic Dictionary Research and Development Group, and are used in conformance with the Group's licence.

Contributing

Contribute by submitting pull requests, filing bug reports, requesting features and more!

See the contributing file for the full details!

Small note: If editing the README, please conform to the standard-readme specification.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

License

GPL-3.0 © 2020 Erek Speed