{"id":13408434,"url":"https://github.com/matt-m-o/YomiNinja","last_synced_at":"2025-03-14T13:31:12.059Z","repository":{"id":195714982,"uuid":"689087800","full_name":"matt-m-o/YomiNinja","owner":"matt-m-o","description":"Open-source OCR and dictionary tool.","archived":false,"fork":false,"pushed_at":"2024-07-22T18:05:34.000Z","size":1928,"stargazers_count":377,"open_issues_count":56,"forks_count":8,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-03-05T17:57:08.424Z","etag":null,"topics":["dictonary","language-learning","languages","ocr","overlay"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/matt-m-o.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":null,"patreon":"YomiNinja","open_collective":null,"ko_fi":"mattmo","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2023-09-08T19:12:55.000Z","updated_at":"2025-03-05T16:42:37.000Z","dependencies_parsed_at":"2023-11-22T14:45:01.688Z","dependency_job_id":"34e3cb15-7eb2-4048-b6c5-007285564129","html_url":"https://github.com/matt-m-o/YomiNinja","commit_stats":null,"previous_names":["matt-m-o/yomininja"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matt-m-o%2FYomiNinja","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matt-m-o%2FYomiNinja/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matt-m-o%2FYomiNinja/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matt-m-o%2FYomiNinja/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/matt-m-o","download_url":"https://codeload.github.com/matt-m-o/YomiNinja/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243584194,"owners_count":20314716,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dictonary","language-learning","languages","ocr","overlay"],"created_at":"2024-07-30T20:00:52.849Z","updated_at":"2025-03-14T13:31:10.495Z","avatar_url":"https://github.com/matt-m-o.png","language":"TypeScript","funding_links":["https://patreon.com/YomiNinja","https://ko-fi.com/mattmo"],"categories":["System-wide"],"sub_categories":[],"readme":"# YomiNinja\r\n\r\nYomiNinja is an application for extracting text from any type of visual content and is designed with language learners in mind.\r\n\r\n## Demonstration with [10ten](https://github.com/birchill/10ten-ja-reader)\r\n\r\nhttps://github.com/matt-m-o/YomiNinja/assets/25914763/2bb02444-fc41-44e7-bc9e-c66d0d40d7b3\r\n\r\n## Demonstration with [Yomichan](https://github.com/FooSoft/yomichan)\r\n\r\nhttps://github.com/matt-m-o/YomiNinja/assets/25914763/1868db47-5b50-44c1-a5b3-694d46c69e28\r\n\r\nThe extracted text overlays the original content, allowing for quick look-ups with pop-up dictionaries like [10ten](https://github.com/birchill/10ten-ja-reader), [Yomitan](https://github.com/themoeway/yomitan) and [Inkah](https://chromewebstore.google.com/detail/inkah-chinese-korean-pop/pcgmedbmchghfgikplcimdmfldfnecec). \u003cbr\u003e\r\nIt minimizes distractions and simplifies the process of looking up unfamiliar words. \u003cbr\u003e\r\nThis is especially beneficial for language learners who study through videos or games.\r\n\r\nYomiNinja is perfect for:\r\n\r\n- Language learners who study through games, videos, or any other visual content.\r\n- Anyone who values a distraction-free, efficient way to look up unfamiliar words.\r\n- Users looking for seamless text extraction and workflow improvement.\r\n\r\nCheck out this [video](https://www.youtube.com/watch?v=sF1isrgjwZI) by [ganqqwerty](https://github.com/ganqqwerty) to get started quickly and easily!\r\n\r\n## Dictionary Extensions\r\nYomiNinja supports web browser dictionary extensions, enabling convenient word lookup without external applications. \u003cbr\u003e\r\nWhile not all extensions are currently installable, [10Ten](https://github.com/birchill/10ten-ja-reader) and [Yomitan](https://github.com/themoeway/yomitan) have been successfully tested and are included as pre-installed options for simplified installation. \u003cbr\u003e\r\n\r\n\r\n## Installation\r\n### Windows\r\nYou need Windows 10 or 11 and [VCRedist](https://www.techpowerup.com/download/visual-c-redistributable-runtime-package-all-in-one/) installed. \u003cbr\u003e\r\nIf you are using the N or KN edition of Windows 10 or 11, please be aware that you will also need to install the [Media Feature Pack](https://support.microsoft.com/en-us/topic/media-feature-pack-list-for-windows-n-editions-c1c6fffa-d052-8338-7a79-a4bb980a700a). This is necessary to ensure that all the required DLLs are installed.\r\n\r\n[Download](https://github.com/matt-m-o/YomiNinja/releases) and install the latest YomiNinja release. \u003cbr\u003e\r\n\r\n### Linux\r\nYomiNinja currently offers support for distros using the X11 window system. Wayland is not supported due to its limitations with global shortcuts and window positioning.\r\n1. Install [xdotool](https://github.com/jordansissel/xdotool?tab=readme-ov-file#installation).\r\n2. Download the YomiNinja package corresponding to your distribution.\r\n3. Install the package. For example, on Debian-based distributions:\r\n\r\n    ```commandline\r\n    sudo dpkg -i yomininja-e_x.x.x_amd64.deb\r\n    ```\r\n### macOS\r\n[Download](https://github.com/matt-m-o/YomiNinja/releases) and install the latest YomiNinja release (.dmg file). \u003cbr\u003e\r\n\r\nNotes:\r\n- The list of available languages for the Apple Vision OCR engine depends on your macOS version.\r\n- Manga OCR will be supported in version 0.8 and above.\r\n- Native support for ARM64 (Apple Silicon) is coming in version 0.8 and above.\r\n\r\n\r\n\r\n## Current features\r\n\r\n- Text extraction from the entire screen or specific window.\r\n- Built-in pop-up dictionaries.\r\n- Chrome Extensions (partial support).\r\n- OCR Templates (predefined text areas, optimizing OCR efficiency).\r\n- Auto OCR.\r\n- Text to speech.\r\n- WebSocket for Texthookers.\r\n\r\n\r\n## Planned Features\r\n\r\n- Text extraction from snip.\r\n- Anki integration.\r\n- History.\r\n- Text translation.\r\n- Support for more OCR engines.\r\n- Support for more TTS voices.\r\n\r\n\r\n## Supported Languages\r\n\r\n- English\r\n- Japanese\r\n- Chinese\r\n- Korean\r\n\r\n## Supported OCR Engines\r\n\r\n- [PaddleOCR](https://github.com/PaddlePaddle/PaddleOCR)\r\n- [Google Cloud Vision](https://cloud.google.com/vision/docs)\r\n- [Google Lens](https://lens.google/intl/pt-BR/#translate)\r\n\r\n## Building\r\n1. Clone the git repository\r\n    ```commandline\r\n    git clone https://github.com/matt-m-o/YomiNinja.git \u0026\u0026 cd YomiNinja\r\n    ```\r\n\r\n2. Build OCR services:\r\n    ```commandline\r\n    cd ./ocr_services/py_ocr_service\r\n    ./gen_grpc_service.bat\r\n    ./build.bat\r\n    cd ../..\r\n    ./copy_py_ocr_service_build.bat\r\n    ```\r\n   \r\n3. Based on your platform, download and extract the latest build of [PPOCR-Inference-Service](https://github.com/matt-m-o/PPOCR-Inference-Service/releases) into the appropriate directory:\r\n\r\n    - Windows: `./bin/win32/ppocr`\r\n    - Linux: `./bin/linux/ppocr`\r\n\r\n4. (optional) Download [10ten v1.15.1](https://github.com/birchill/10ten-ja-reader/releases/tag/v1.15.1) for Chrome, and place the zip file into the following directory:\r\n       \r\n       ./yomininja-e/extensions/\r\n\r\n5. Install node modules. Note: `--force` is used due to outdated react-furi peerDependencies, but it should function normally.\r\n    ```commandline\r\n    cd yomininja-e \u0026\u0026 npm install --force\r\n    ```\r\n6. Generate gRPC Protobuf types\r\n    ```commandline\r\n    npm run grpc-types\r\n    ```\r\n7. Build\r\n    ```commandline\r\n    npm run dist\r\n    ```\r\n\r\n\r\n## Inspired by:\r\n- [Yomichan](https://github.com/FooSoft/yomichan)\r\n- [mokuro](https://github.com/kha-white/mokuro)\r\n- [kanjitomo-ocr](https://github.com/sakarika/kanjitomo-ocr)\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatt-m-o%2FYomiNinja","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmatt-m-o%2FYomiNinja","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatt-m-o%2FYomiNinja/lists"}