Skip to content

Ajatt-Tools/rikaitan

Β 
Β 

Repository files navigation

Rikaitan

Firefox release Chromium release Chat

Project Introduction

πŸ‘‹ This project is a community-driven fork of Yomichan. The original developer quit and deleted Yomichan from extension stores. Our primary objective is to maintain the project, ensuring it remains functional on the most recent browser versions and that any bugs are fixed.

As requested by the original creator, the project has been given a new name: Rikaitan, in the style of the previous name.

Contributing

Given this is a distributed effort, we wholeheartedly welcome any new contributors. Please feel free to look through the issue tracker, or join us on the DJT Matrix.

What's Rikaitan?

Rikaitan turns your web browser into a tool for building Japanese language literacy by helping you to decipher texts which would be otherwise too difficult to tackle. This extension is similar to 10ten Japanese Reader for Firefox and Rikaikun for Chrome, but it stands apart in its goal of being an all-encompassing learning tool as opposed to a mere browser-based dictionary.

Rikaitan provides advanced features not available in other browser-based dictionaries:

  • Interactive popup definition window for displaying search results.
  • On-demand audio playback for select dictionary definitions.
  • Kanji stroke order diagrams are just a click away for most characters.
  • Custom search page for easily executing custom search queries.
  • Support for multiple dictionary formats including EPWING via the Rikaitan Import tool.
  • Automatic note creation for the Anki flashcard program via the AnkiConnect plugin.
  • Clean, modern code makes it easy for developers to contribute new features.

Term definitions Kanji information Dictionary options Anki options

Helpful information

Installation

Rikaitan is available for Firefox-based web browsers and Chromium-based web browsers. We recommend LibreWolf as your everyday web browser. Ungoogled-chromium is a good alternative.

Download from Firefox Browser add-ons:

image

Download from Chrome Web Store:

image

Note: chromium-web-store can be used to allow installing extensions directly from Chrome Web Store.

Basic Usage

  1. Click the rikaitan icon Rikaitan button in the browser bar to open the quick-actions popup.

    rikaitan main popup
    • The cog cog button will open the Settings page.
    • The magnifying glass magnifying glass button will open the Search page.
    • The question mark symbol question mark button will open the Information page.
    • The profile icon profile button will appear when multiple profiles exist, allowing the current profile to be quickly changed.
  2. Import the dictionaries you wish to use for term and kanji searches, head over to the the dictionary docs to get set up! If you do not have any dictionaries installed or enabled, Rikaitan will warn you that it is not ready for use by displaying an orange exclamation mark over its icon. This exclamation mark will disappear once you have installed and enabled at least one dictionary.

    custom dictionaries list
  3. Webpage text can be scanned by moving the cursor while holding a modifier key, which is Shift by default. If definitions are found for the text at the cursor position, a popup window containing term definitions will open. This window can be dismissed by clicking anywhere outside of it.

    popup with search terms
  4. Click on the loudspeaker icon speaker button to hear the term pronounced by a native speaker. If an audio sample is not available, you will hear a short click instead. For more options, see Audio Configuration.

  5. Click on individual kanji in the term definition results to view additional information about those characters, including stroke order diagrams, readings, meanings, as well as other useful data.

    popup with kanji details

To further enhance your Rikaitan experience, it's worth integrating with Anki, a spaced-repetition flashcard program to help solidify the words you encounter.

Licenses

Required licensing notices for this project follow below:

  • EDRDG License
    This package uses the 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 license.

  • Kanjium License
    The pitch accent notation, verb particle data, phonetics, homonyms and other additions or modifications to EDICT, KANJIDIC or KRADFILE were provided by Uros Ozvatic through his free database.

Third-Party Libraries

Rikaitan uses several third-party libraries to function. Below are links to homepages, snapshots, and licenses of the exact versions packaged.

Name Installed version License type Link
@zip.js/zip.js 2.7.32 BSD-3-Clause git+https://github.com/gildas-lormeau/zip.js.git
dexie 3.2.4 Apache-2.0 git+https://github.com/dfahlander/Dexie.js.git
dexie-export-import 4.0.7 Apache-2.0 git+https://github.com/dexie/Dexie.js.git
rikaitan-handlebars 1.0.0 MIT n/a
parse5 7.1.2 MIT git://github.com/inikulin/parse5.git
wanakana 5.3.1 MIT git+ssh://git@github.com/WaniKani/WanaKana.git

About

πŸ““ Japanese pop-up dictionary extension for Chrome and Firefox. A community-maintained version of Yomichan.

Resources

License

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 80.8%
  • HTML 11.1%
  • CSS 6.6%
  • Handlebars 1.4%
  • Python 0.1%
  • TypeScript 0.0%