birchill / 10ten-ja-reader

A browser extension to translate Japanese by hovering over words.
https://addons.mozilla.org/firefox/addon/10ten-ja-reader/
GNU General Public License v3.0
608 stars 45 forks source link
addon dictionary firefox japanese rikaichamp rikaichan rikaikun web-extension webextension
10ten Japanese Reader

10ten Japanese Reader

Hi fellow Japanese reader! Formerly known as Rikaichamp, this browser extension lets you look up Japanese words with the hover of a mouse or tap of a screen.

Follow @10tenstudy automated test status

Table of Contents

Installing

Features

Usage

By default, you can enable the 10ten Japanese Reader by either:

Alternatively, a lot of users find it helpful to have the extension permanently enabled but configured to only show the pop-up when either Alt or Ctrl is pressed.

The other keys are as follows:

Action Key
Switch dictionary (words → kanji → names) Shift / Enter
Show kanji results only Shift (disabled by default)
Toggle display of definitions d (disabled by default)
Move the popup up or down j / k (disabled by default)
Enter copy mode c
(Copy mode) Copy entry e
(Copy mode) Copy tab-separated fields y
(Copy mode) Copy word/kanji w
(Copy mode) Select next entry c

Building a release from source

You may also build the add-ons using a source package from the Releases page and running the following commands:

export RELEASE_BUILD=1
pnpm install
pnpm package:firefox
# Or `yarn package:firefox` for versions 0.20.0 and earlier
# Or `yarn package` for versions 0.5.8 and earlier

(Note that you may ignore the .js files associated with each release. These are published simply to provide a public URL for each version of the source files to associating stack traces from error reports.)

The above builds the package for Firefox. Use pnpm package:chrome to build the Chrome package, pnpm package:edge for Edge, pnpm package:safari for Safari, or pnpm package:thunderbird for Thunderbird.

Note: For versions prior to and including 0.5.5 pnpm install will try to install husky but fail so you will need to run pnpm install --ignore-scripts.

To build the latest trunk version please see CONTRIBUTING.md.

Contributing

Please see CONTRIBUTING.md.

Contributors

Thank you to everyone who has contributed including the following people (emoji key):

SaltfishAmi
SaltfishAmi

💻 🌍
Claudio Freitas
Claudio Freitas

💻
Kala-J
Kala-J

💻 🔣
ispedals
ispedals

💻
YUKI
YUKI "Piro" Hiroshi

🌍
kikaxa
kikaxa

💻
Edho Arief
Edho Arief

💻
Erek Speed
Erek Speed

💻
Jamie Birch
Jamie Birch

💻 🤔 🐛 📦
Martin Böhm
Martin Böhm

🐛 🤔
nicolasmaia
nicolasmaia

🐛 🤔
Jack Arrington
Jack Arrington

💻 📖
Eneas
Eneas

💻
Phong Phan
Phong Phan

💻
Mai Lavelle
Mai Lavelle

💻

This project follows the all-contributors specification. Contributions are very welcome!