Skip to content

VNTimeTracker Guide

VNTimeTracker is a simple Python application designed to help you read more by accurately tracking your time spent reading visual novels.

Time tracker main window

Installation

Download Options

You have two options for getting VNTimeTracker:

Download the latest binary from the releases tab and simply run the executable file.

Option 2: Run from Source

Clone the repository and install dependencies:

git clone https://github.com/drinosaret/VNTimeTracker.git
cd VNTimeTracker
pip install -r requirements.txt

Run the application:

python run.py

Initial Setup

Prerequisites

Before starting, ensure you have:

  • The Japanese visual novel you want to track ready to launch (Check the sources list for information on finding untranslated Japanese games)

Global Settings Configuration

Before you start tracking, configure the global settings to suit your needs:

  • Daily Goal Time: Set your target reading time per day
  • AFK Threshold: Determines how long the timer waits before stopping when no activity is detected
  • Language Settings: Choose between English or Japanese for the UI

Setting Up Game Tracking

Step-by-Step Process

  1. Launch your game: Open the visual novel you want to track first
  2. Open VNTimeTracker: Start the time tracker application

  3. Search for your VN: Under "VN Search," search for the VN you are playing and select the correct title

    Can't find your VN?

    If you don't see your VN, search for it on VNDB and make sure you are using the correct title. If the game you are playing is not on VNDB, consider adding it to the database.

  4. Select the process: Choose the process name (it should be the filename of the exe you ran to start the game)

  5. If you don't see it, try pressing the refresh button
  6. Start tracking: Once you have selected both the game and process, click "Select Game and Process" to begin

Using the Tracker

Status Indicators

If things are configured correctly, both the timer in the main window and the overlay should increase when you are in the window of the game you are tracking.

Color Code:

  • Green: Active (in-game and actively reading)
  • Yellow: AFK (in-game, but not active)
  • Red: Away (out-of-game)

Customization Options

You can customize the tracker interface to suit your preferences:

  • Overlay opacity: Change the opacity of the overlay window or disable it completely
  • Minimize to tray: The main window can be minimized to the system tray if you find it distracting
  • Window layout: Click in the middle of the window and drag to enlarge or hide the left or right components, allowing you to display only one side in the main window if desired

Main window alternate view

For any other questions or issues, you can check the GitHub repository for more information or to open an issue.