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

  • All contributions are welcome

  • See CONTRIBUTING for more information on how to contribute

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.1.1.tar.gz (149.1 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.1.1-py3-none-any.whl (179.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mirumoji-3.1.1.tar.gz
Algorithm Hash digest
SHA256 d78b9e424378910fe29ff16e9648dd0cddcb199707905a4bf23deddd45210128
MD5 ca2e7dea80ff4104dff0ae2f5544aa21
BLAKE2b-256 d8d81a02f7652b7a15fd61440ee72d677c2a421ab8333d39cdba2fb1c6370e6d

See more details on using hashes here.

Provenance

The following attestation bundles were made for mirumoji-3.1.1.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.1.1-py3-none-any.whl.

File metadata

  • Download URL: mirumoji-3.1.1-py3-none-any.whl
  • Upload date:
  • Size: 179.9 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.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a77648f9e0164840f4937d6b9b45e76cf2927c1e128af6e825564adda5a26f0a
MD5 5b88f2a7b73f0aeaa07547607f7b9093
BLAKE2b-256 b3babbefb92d58dd307ac30e2c27847d8f3100d45ce4a9662dd231666edb043d

See more details on using hashes here.

Provenance

The following attestation bundles were made for mirumoji-3.1.1-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