Skip to content

rotero08/NihongoAutoTracker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

274 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

WXT TypeScript pnpm Svelte


NihongoAutoTracker

An unofficial, customizable browser extension for NihongoTracker that automates and streamlines your Japanese immersion logging.

Get it on Firefox Add-onsΒ Β  Chrome Web Store - Coming Soon


Table of Contents


✨ Features

Queue System

Logs are stored in a local queue, giving you complete control over your data before it hits the server. There are various options to automate the process.

  • Session Management: Group multiple short sessions of the same media together.
  • Manual Overrides: Edit time, character counts, dates, volume, and title before hitting "Send".
  • Smart Matching: Search and match your reading material (Light Novels) to ensure accurate logging to NihongoTracker. A green checkmark appears when matched.
  • End-of-Day Sync: Optionally set the extension to automatically flush your queue and send everything right before midnight.
  • Stats Dashboard: View a quick summary of your Japanese learning stats (the complete set of stats remains in the main NihongoTracker dashboard).
  • Stremio & Trakt Integration: Sync your anime or movie watched history from Stremio to NihongoTracker automatically using Trakt.

Quick Popup Menu Full Dashboard View
Compact Extension Popup Full Settings and Queue Page

Advanced Video Tracking

Never forget to log a video again. The extension integrates smoothly into your viewing experience without cluttering the screen.

  • In-Player Badge: Injects a sleek, non-intrusive tracking badge directly into the player to monitor current and total session time.
  • Quick Context Menu: Right-click any YouTube video or link to log it instantly to NihongoTracker without opening a single menu.
  • Smart Auto-Logging: Optionally set thresholds (e.g., 95% completion or 30 minutes watched) to log content automatically in the background without sending it to the queue.

YouTube Tracking Badge

  • Playlist Logger: Bulk-log entire playlists or select specific videos directly from the YouTube sidebar or playlist header. Includes smart filters to automatically hide non-Japanese content.

Playlist Logger Selector

Reading & Context Menu Logging

Track your reading progress actively and seamlessly sync with popular web readers.

  • Reader Integrated Dashboard: Seamlessly syncs your reading sessions from Ttu Reader, Yatsu Reader, and Yomiyasu Reader in the background.
  • Fully Compatible with Jiten & Whisruns: Integrates perfectly with Jiten dictionary and ttu/yatsu whispersync tools, maintaining layout styling and dynamic icon positioning.
  • Cohesive Design: Match the visual appearance of your dashboard and popup directly to your reader's design for a unified workspace.
  • Compact Timer Overlay: A sleek, draggable overlay tracks your active reading time on non-reader websites (e.g. Wikipedia, Asahi Shinbun). Can be customized.
  • Integrated Matching Logic: Match your reading material inside the reader before sending it to the queue, ensuring every send is correctly matched.

Reader Integration Session History & Tracking
Searching and matching a Light Novel Active reading session and history

  • Text Context Menu: Highlight Japanese text on any webpage, right-click, and log it instantly. The extension calculates character counts and reading time automatically.

Context menu logging showing 'Log to NihongoTracker

Configurable & Customizable

  • Theme Management: Choose from multiple pre-built themes, or create, import, and share your own custom designs.
  • Site Filters: Maintain Allow/Skip lists for the reading overlay to control exactly where tracking occurs.
  • Flexible Logic: Toggle time tracking, switch between auto and manual modes, and set playlist-specific Japanese content filters.
  • Togglable Options: Various options to personalize your viewing and reading experience.
  • Regex Engine: Define custom regex rules for control over automatic title and volume detection.

πŸ“¦ Installation

Firefox

Get the official extension directly from the Firefox Add-ons Store.

Chrome (Manual Installation)

The Chrome Web Store version is coming soon. In the meantime, you can install the production build manually:

  1. Download the latest production build from the Releases page (look for the Chrome .zip file).
  2. Extract the ZIP file somewhere safe on your computer.
  3. Open Chrome and navigate to chrome://extensions/.
  4. Enable Developer mode via the toggle in the top-right corner.
  5. Click the Load unpacked button in the top-left corner and select the extracted folder.

πŸ› οΈ Development Setup

If you want to contribute or build the project from source, ensure you have pnpm installed.

  1. Clone this repository:

    git clone https://github.com/rotero08/NihongoAutoTracker.git
    cd NihongoAutoTracker
  2. Install dependencies:

    pnpm install
  3. Start the development server:

    pnpm dev

Note: WXT will automatically open a custom browser instance with the extension pre-loaded for hot-reloading.


πŸš€ Building for Production

To compile production-ready bundles for both major web stores simultaneously, run:

pnpm run zip:all

The compiled, ready-to-upload compression files will be located in the .output/ directory.


πŸ€– Automatic Deployment & Releases

This repository is configured with GitHub Actions to automate building, publishing, and updating the extension.

To learn how to trigger a new deployment, automatically sync this description to the Firefox Add-ons Store, and retrieve the signed .xpi file, see the Release Guide.


πŸ”’ Privacy Policy

NihongoAutoTracker is designed with a strict focus on user privacy:

  • No analytical tracking, ads, or telemetry software are bundled with this extension.
  • Your logging history, preferences, and API keys reside completely locally in your browser storage.

For detailed information on data processing, please view the full Privacy Policy.


βš–οΈ Attribution & License

This extension interacts with NihongoTracker. All data retrieved from the site is licensed under CC BY-NC-SA 4.0.

This is an independent project and is not affiliated with or endorsed by NihongoTracker. Consistent with the source license, this extension is strictly NonCommercial.

About

An unofficial browser extension for NihongoTracker. Automates Japanese immersion logging for YouTube, web readers (Ttu, Yatsu), and highlighted text with smart auto-logging and a queue system.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors