Skip to content

DongInSong/HoloAlarm

Repository files navigation

api HoloAlarm

License Last Commit GitHub Downloads (all assets, all releases)

Overview

Dark Mode HoloAlarm: Your Compact Hololive Stream Companion

HoloAlarm is a sleek, fan-made desktop app for Hololive dedicated Hololive fans. With its vertical, edge-docking layout and card-based UI, it keeps you updated on live and upcoming streams—without cluttering your screen.

Key Features:

  • Minimalist Design: A slim, bar-shaped window that stays out of your way.
  • Card-Based UI: Easily browse streams in a clean, organized layout.
  • Live Notifications: Get instant updates so you never miss a stream.
  • Customizable: Personalize your experience with features like 'Favorites' and 'Dark Mode'.

⚠️ Note: Since the application is not code-signed, Windows SmartScreen may show a warning when running the file. You can verify the source code and releases on GitHub before running the application.

Usage (Windows)


  1. Download the Application

  2. - Visit the GitHub Releases page.

    - Download the latest `.exe` file from the assets section.


  3. Get API Key from Holodex

  4. - Go to the Holodex website and log in.

    - Navigate to the `Account` > `Developer Settings` page.

    - Click the "New API Key" button to generate a new API key.

    - Copy the generated API key.


  5. Run the Application and Set API Key

  6. - When you first run the application, you will be prompted to enter the Holodex API key.

    - Paste the copied API key into the input field and save.

api

Configuration

The application settings are stored in localSetting.json. You can find this file in the following locations depending on your operating system:

  • Windows: C:\Users\{USERNAME}\AppData\Roaming\HoloAlarm\localSetting.json
  • Linux: ~/.config/HoloAlarm/localSetting.json
  • macOS: ~/Library/Application Support/HoloAlarm/localSetting.json

Build and Run

To build and run this application locally, follow these steps:

  1. Clone the repository:

    git clone https://github.com/DongInSong/HoloAlarm.git
    cd HoloAlarm
  2. Install dependencies:

    npm install
  3. Run the application:

    npm start

Release

You can create distributable packages for Windows and Linux using the following commands:

  • For Windows (x64):

    npm run build:win64
  • For Linux (x64):

    npm run build:linux64

The release files will be located in the dist/ directory.

License

This application is powered by the Holodex API.

In compliance with the Holodex API license, this project acknowledges Holodex as the data source and provides a link to their service. The source code includes notices referring to the Holodex Public License and its disclaimer of warranties. We are committed to adhering to their terms of service.

Hololive Production

This is a fan-made application and is not affiliated with Hololive Production or COVER Corporation. All icons, talent names, and other related assets are the property of COVER Corporation. This application is created in accordance with COVER Corporation's derivative works guidelines.

About

Holodex api desktop app

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published