Skip to content

Hexanol777/Kikiyomu

Repository files navigation

KikiYomu

KikiYomu is a lightweight, real-time Text-to-Speech (TTS) application that monitors your clipboard and instantly uses AI voice models to have anime-style characters narrate Japanese text from games or visual novels.


Features

  • Real-Time TTS: Automatically reads aloud Japanese text copied to your clipboard.
  • Speaker Tag Handling: Option to remove speaker tags like 【Name】 commonly found in RPGMaker and WolfRPG games.
  • Game Compatibility: Designed to work well with most visual novels and games that use stylized dialogue formatting.
  • User-Friendly GUI: Simple GUI.
  • Manual Control Over TTS: Lets the user Force-read texts even when filtered out by the model.
  • Image OCR Support: extracts Japanese text from images in your clipboard using OCR — Use with a snip tool for best result.
  • GPU Acceleration: Optional — Uses GPU if available for faster OCR/Voice-over.

Installation

Prerequisites

Setup Instructions

  1. Clone the Repository

    git clone https://github.com/yourusername/KikiYomu.git
    cd KikiYomu
    
  2. Install Python Dependencies

pip install -r requirements.txt
  1. Download Pretrained Voice Models

Visit the following Hugging Face repository to download the Pretrained AI voice models:

AI-Voice Models

Place the .pth model files into the models/ directory.

Usage

  1. Start the App
    python gui.py
  • Additionally you can just you run the KikiYomu.py file in command line as it still offers most utilities.
  1. Load a Model
  • In the "Models" panel, select a .pth model and click "Select Model".
  1. Configure Settings (if needed)
  • Set the opening/closing signs used for spoken text (e.g., 「 and 」).

    • If your are playing an RPGMaker game, Enable the checkbox to remove RPGMaker/WolfRPG-style speaker tags (【Name】) at the start of lines.
  • Adjust playback speed with the slider.

  1. Copy Text to Speak

Copy any Japanese line of text to the clipboard. If it passes the filters, KikiYomu will automatically speak it aloud using the selected AI voice.

Credits

  • Voice Models: zomehwh's VITS Models on Hugging Face

About

聞き読む. real-time text-to-speech tool for VNs

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages