Self-Hostable Japanese Language Immersion Tool
Project description
mirumoji
An open-source, self-hosted Japanese immersion toolkit. Drop in a video, an anime episode, a drama, or an audio clip and Mirumoji gives you clickable tokenized subtitles with instant dictionary lookups, Whisper-powered transcription, SRT generation, clip saving, and one-click Anki export. All running locally in Docker, with optional cloud GPU and LLM features
Quickstart
Mirumoji runs as a local Docker Compose Application. The quickest way to start is to download the
Desktop Launcher for your platform
Detailed Walkthroughs
-
Full Walkthrough →
GUI Setup -
CLI Setup Walkthrough →
CLI Setup -
Manual Setup Walkthrough →
Manual Setup
Features
| Interactive Player | Load any video and .srt subtitles for clickable, tokenized Japanese lines with instant dictionary pop-ups |
| Transcription & SRT | Generate subtitles and transcribe audio with faster-whisper, on a local or cloud GPU |
| Dictionary & Analyzer | Wildcard dictionary search (kotobase) + a paste-in text analyzer with furigana |
| LLM Breakdowns | Optional GPT / Claude / Gemini word & sentence breakdowns with fully customizable prompts |
| Clips & Anki | Save video segments with their word breakdowns and export them as an Anki deck |
| Profiles | Keep files, transcripts, clips, and LLM templates organized per profile on the server |
| CLI & Desktop GUI | Run the docker compose application with mirumoji up or the desktop launcher |
Help
| Documentation | Guides, Full Python API Reference, Full Frontend API Reference |
| Setup Guide | CLI, GUI, and Manual setup |
| Using a GPU | Local GPU vs. Modal Cloud GPU |
| Changelog | Changed Between Versions |
| Live Preview | View a live preview of the frontend (not backend running) |
Contributing
Pull Requests, bug reports, and feature requests are all welcome.
See
CONTRIBUTINGfor the dev container setup, quality gates, and PR conventions.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mirumoji-3.0.0rc2.tar.gz.
File metadata
- Download URL: mirumoji-3.0.0rc2.tar.gz
- Upload date:
- Size: 111.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
edb15dd78f08f34c3829ce5515149a9557fa5242a1dd29939f0086242074c5ad
|
|
| MD5 |
c79d9cdd16af03e069addcff33ab7992
|
|
| BLAKE2b-256 |
5e47412f8434e01092a7cbeb1a8c223ac29c62beb1d832100f0a45dfa356fb4e
|
Provenance
The following attestation bundles were made for mirumoji-3.0.0rc2.tar.gz:
Publisher:
release.yaml on svdC1/mirumoji
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mirumoji-3.0.0rc2.tar.gz -
Subject digest:
edb15dd78f08f34c3829ce5515149a9557fa5242a1dd29939f0086242074c5ad - Sigstore transparency entry: 1810322741
- Sigstore integration time:
-
Permalink:
svdC1/mirumoji@0effbe289ef8813ba6762818238b34f97ab18c81 -
Branch / Tag:
refs/tags/v3.0.0rc2 - Owner: https://github.com/svdC1
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yaml@0effbe289ef8813ba6762818238b34f97ab18c81 -
Trigger Event:
push
-
Statement type:
File details
Details for the file mirumoji-3.0.0rc2-py3-none-any.whl.
File metadata
- Download URL: mirumoji-3.0.0rc2-py3-none-any.whl
- Upload date:
- Size: 139.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d9a29340cf5375babb1bde6df6bae0bf7874852a5b1d432ca7f48a269f430ec0
|
|
| MD5 |
949c5f4671b5b044f41060924690afaa
|
|
| BLAKE2b-256 |
3c570e11f0cf1ced93f21e3fa96741dfafa354dd4e06eb8d8d655f51e0622767
|
Provenance
The following attestation bundles were made for mirumoji-3.0.0rc2-py3-none-any.whl:
Publisher:
release.yaml on svdC1/mirumoji
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
mirumoji-3.0.0rc2-py3-none-any.whl -
Subject digest:
d9a29340cf5375babb1bde6df6bae0bf7874852a5b1d432ca7f48a269f430ec0 - Sigstore transparency entry: 1810322749
- Sigstore integration time:
-
Permalink:
svdC1/mirumoji@0effbe289ef8813ba6762818238b34f97ab18c81 -
Branch / Tag:
refs/tags/v3.0.0rc2 - Owner: https://github.com/svdC1
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yaml@0effbe289ef8813ba6762818238b34f97ab18c81 -
Trigger Event:
push
-
Statement type: