Coder Social home page Coder Social logo

aselunar / rikaikun Goto Github PK

View Code? Open in Web Editor NEW

This project forked from melink14/rikaikun

0.0 0.0 0.0 759.19 MB

Translate Japanese by hovering over words.

Home Page: https://chrome.google.com/webstore/detail/rikaikun/jipdnfibhldikgcjhfnomkfpcebammhp

License: GNU General Public License v3.0

Shell 0.08% JavaScript 4.96% TypeScript 92.32% CSS 2.51% HTML 0.13%

rikaikun's Introduction

rikaikun

Chrome Web Store Chrome Web Store Users Mergify Status codecov Codacy Badge Code Style: Prettier License GPL-3.0 Standard Readme Compliant Conventional Commits All Contributors Contributor Covenant

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

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:

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

Key Explanation
A Alternate popup location
Y Move popup location down
C Copy to clipboard
D Hide/show definitions
Shift/Enter Switch dictionaries
B Previous character
M Next character
N Next word
J Scroll back definitions
K Scroll forward definitions

Maintainers

@melink14

Credits

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):


Aaron Muir Hamilton

💻

Arseny Tolmachev

💻

Baardman82

🐛

Bazz

💻

Brian Birtles

💻

ChocoChopin

🐛 🤔

Darren Lester

💻

Davies Odu

💻

Erek Speed

💻 👀 🐛 📆 🤔 📖

Jake

💻

MayamaTakeshi

💻

Muhammad Afham Awisul Islah

💻

Samuel Dunlap

💻

Stephie

👀 💻 📖

Tobi Owoputi

💻 🐛

Versus

💻

Ville Kohonen

💻

Vwing

💻

Yash Bajaj

📖

deshaun93

💻

ollkorrekt

🐛

qkjosh

🐛 💻

sdcr

🔣

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

License

GPL-3.0 © 2020 Erek Speed

rikaikun's People

Contributors

dependabot[bot] avatar melink14 avatar semantic-release-bot avatar rikaikun-bot avatar allcontributors[bot] avatar birtles avatar tobiowo avatar deshaun93 avatar darren-lester avatar bazz1tv avatar versusvoid avatar vwing avatar jakeh avatar stephie avatar xorgy avatar eiennohito avatar mayamatakeshi avatar maawisul avatar samdunlap avatar vikohone avatar yash8202 avatar davodu avatar joshua-webdev avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.