Skip to main content

Self-Hostable Japanese Language Immersion Tool

Project description

mirumoji

PyPI License Docs Docker Pulls Release Action GitHub Downloads (all assets, all releases)

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 subtitle generation, clip saving, and Anki export. All running locally in Docker, with optional cloud GPU and LLM features

Mirumoji Demo


Quickstart

Mirumoji runs as a local Docker Compose Application

The quickest way to start is to download the Desktop Launcher for your platform and follow the Setup Walkthrough

Alternatives

You can also setup Mirumoji Manually, or through its CLI


Features

Interactive Player Load Videos + Subtitles For Clickable, Tokenized Japanese Lines With Dictionary Pop-Ups
Transcription Generate Subtitles + Transcribe Audio with faster-whisper, on a Local / Cloud GPU
Dictionary Wildcard dictionary search (kotobase) + a paste-in text analyzer with furigana
LLM Optionally Use Gemini / Claude / GPT API Keys (Or Your Own Local LLM Server) To Generate Sentence Breakdowns With Fully Customizable Prompts
Clips + Anki Save Video Segments With Their Word Breakdowns And Export Them As An Anki Deck
Profiles Keep Generated Files, Transcripts, Clips, and LLM Templates Organized Per Profile On The Server
Launcher Easily Run The Docker Compose Application Via The CLI Or The Desktop Launcher

Help

Documentation Guides + Full Backend / Frontend API Reference
Setup Guide CLI + GUI + Manual setup
Using a GPU Local GPU x Modal Cloud GPU
Changelog What Changed Between Versions
Live Preview Test The Frontend (No Backend Running)

Contributing

Pull Requests, bug reports, and feature requests are all welcome.

See CONTRIBUTING for the dev container setup, quality gates, and PR conventions.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mirumoji-3.0.0.tar.gz (114.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mirumoji-3.0.0-py3-none-any.whl (143.0 kB view details)

Uploaded Python 3

File details

Details for the file mirumoji-3.0.0.tar.gz.

File metadata

  • Download URL: mirumoji-3.0.0.tar.gz
  • Upload date:
  • Size: 114.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mirumoji-3.0.0.tar.gz
Algorithm Hash digest
SHA256 0177c2309745c36abfc13e4627a4314e4dc7aaf6e7a26e46a7d9434723d582af
MD5 ae5ab93bfc192a4c68dfd7bf6825a326
BLAKE2b-256 31a5bac5d2e43b664386cf481d082caab41d6b838368dc007c8b1a12ea158f7b

See more details on using hashes here.

Provenance

The following attestation bundles were made for mirumoji-3.0.0.tar.gz:

Publisher: release.yaml on svdC1/mirumoji

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mirumoji-3.0.0-py3-none-any.whl.

File metadata

  • Download URL: mirumoji-3.0.0-py3-none-any.whl
  • Upload date:
  • Size: 143.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mirumoji-3.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ad1d763b05fe4602bed6e62810595d6f1562ccb97c799101a71b11661671156b
MD5 8f0a3c5ad3402287c326d418e052ec70
BLAKE2b-256 2e2ca82f5fe8ab32c7947aff7c99dbe9ab6a2c433ff1c0a2b944196dce48c0dd

See more details on using hashes here.

Provenance

The following attestation bundles were made for mirumoji-3.0.0-py3-none-any.whl:

Publisher: release.yaml on svdC1/mirumoji

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page