Skip to content

Latest commit

 

History

History
86 lines (71 loc) · 5.92 KB

README-en.md

File metadata and controls

86 lines (71 loc) · 5.92 KB

Neko Game

中文 | English

📝 Overview

Neko Game is a tailored gacha analysis and game management application designed to enhance your gaming experience. It features a modern, customizable user interface to help you record, analyze, and optimize your gaming activities. Built on Electron, the app integrates various useful functionalities such as gacha analysis for Wuthering Waves, Genshin Impact, Honkai Star Rail, and Zenless Zone Zero, game time tracking, time trend visualization, and more.

Recommended Reading: Spend 5 minutes reading this document to quickly get started with Neko Game.

preview

Features

  • Game Tracking: Automatically tracks and records game playtime with detailed statistics.
  • Gacha Analysis: One-click analysis for gacha data from Wuthering Waves, Honkai Star Rail, Genshin Impact, and Zenless Zone Zero. Links are automatically copied.
  • Gacha Data Import/Export: Supports UIGF 4.0 export/import for Genshin, Honkai Star Rail, and Zenless Zone Zero. Wuthering Waves data can be exported to Excel.
  • Game Library Management: Easily add, edit, and delete games from your library for tracking.
  • Data Analysis: Visualize trends and gain insights into your gaming habits through rich analytics.
  • Seamless Usage: Minimize to system tray, run in the background, and enable auto-start at login.
  • Data Storage: Safely store game data locally or configure automatic cloud upload. Configuration Guide
  • Automatic Data Sync: Sync data across devices via GitHub or Gitee. (Mobile support requires the corresponding app version, downloadable from Baidu Cloud.)
  • High Performance, Low Resource Use: Optimized for low power consumption and high efficiency without impacting your daily usage.
  • Stay Up-to-Date: Receive notifications for new versions and enjoy automatic updates.

Installation

  • From Releases (Recommended): Download the latest .exe file from the Releases page and install.
  • From Baidu Cloud: Download the archive from Baidu Cloud, extract it, and install.

Developer Installation

  1. Clone this repository: 
    git clone https://github.com/Summer-Neko/NekoGame.git
  2. Navigate to the project directory: 
    cd nekogame
  3. Install dependencies: 
    npm install
  4. Run the app in development mode: 
    npm start

Usage Guide

  • Gacha Analysis: Open the gacha page in the game within the last 30 minutes, then click refresh.
  • Add a Game: Click "Add Game," fill in the required details (name, icon, poster, and game path—ensure the path points to the game's main executable, not the launcher), and save.
  • Edit a Game: Select a game from the library, click "Edit," update its details, and save changes.
  • Delete a Game: Use the "Delete" option in the game's details menu to remove it and its related data.
  • Settings: Enable all three general options for seamless usage. Configure data sync and custom window options here.
  • Game Images: Obtain images from SteamGridDB (recommended, search with the English name of the game). Animated images are supported.
  • Time Tracking: Games in the library will automatically track usage time without manual intervention.

Project Screenshots

image image image image

Troubleshooting & Roadmap

Common Issues

  • Missing Tray Icon: Ensure the icon path is correct in the packaging configuration.
  • Gacha Records Not Found: Confirm the game is installed correctly and has not been manually moved.
  • Unrecorded Playtime: Reload the app or use the refresh function to restart tracking. Verify that the selected path points to the game's main executable, not the launcher.
  • Invalid Path or Images: Check for special characters in file paths and ensure images are correctly referenced. Verify the file extensions are valid.
  • Permission Errors: If the error message includes gameTracker.js, it can be ignored. Restart the app if it persists.
  • Unknown Publisher Warning: This can be safely ignored.
  • Slow Gacha Link Retrieval: For Genshin Impact and Zenless Zone Zero, log files change with each version. To avoid frequent updates, version configurations are hosted on GitHub, which might cause delays.

Known Limitations

  • Playtime tracking in complex environments may require further optimization.
  • Gacha analysis and import/export are only tested for the Chinese servers; international servers are not yet supported.
  • Handling of very old playtime data (e.g., from 10 years ago) needs improvement.
  • Current analytics display only up to six months of playtime data (older data is not deleted but not actively displayed).

Future Updates

  • i18n (Internationalization) support
  • Additional functionalities
  • Optimized data visualization

Asset Usage Instructions

  • The background illustrations and project icons displayed on this page are sourced from the internet. I sincerely thank the artists for their contributions. If you are the author or believe that certain illustrations should not be used, or if you are willing to provide artist information, please contact me.
  • This application utilizes the UIGF API for mutual conversion between item_id and name.