Skip to content

MatteoLucerni/typescript-spark-lol-vocalizer

Repository files navigation

Spark LoL Voice Assistant

Description

Spark LoL Voice Assistant is a real-time voice notification system designed to enhance your League of Legends gaming experience. By providing instant audio alerts for critical in-game events such as dragon spawns, objective captures, turret destructions, and more, Spark ensures you stay informed without diverting your attention from the action on screen. Whether you're tracking important objectives or coordinating with your team, Spark keeps you one step ahead with timely and customizable voice notifications.

Features

  • Real-Time Voice Alerts: Receive instant audio notifications for key in-game events.
  • Comprehensive Event Monitoring: Tracks a wide range of events including dragon spawns, Baron Nashor kills, turret destructions, and player deaths.
  • Customizable Notifications: Choose which events to monitor and personalize the vocal messages to suit your preferences.
  • Intuitive User Interface: Easily configure settings and manage notifications through a user-friendly interface.
  • Low Resource Usage: Optimized to run seamlessly in the background without impacting game performance.
  • Multilingual Support: Supports multiple languages for vocal alerts to cater to a diverse user base.
  • Extensible Architecture: Modular design allows for easy addition of new features and event types.

Technologies Used

  • TypeScript: Primary programming language for robust and scalable code.
  • Overwolf API: Integrates directly with League of Legends to capture real-time game data.
  • Electron: Framework for building cross-platform desktop applications.
  • Node.js: Runtime environment for executing JavaScript code server-side.
  • WebSocket: Enables real-time communication between the game client and the application.
  • Responsive Design: Ensures the application interface is accessible and user-friendly across various screen sizes.

Installation

Prerequisites

  • Windows 10 or Later: Spark LoL Voice Assistant is compatible with Windows 10 and newer versions.
  • League of Legends: Ensure that League of Legends is installed and updated to the latest version.

Steps

  1. Download the Installer

    Visit the Spark LoL Voice Assistant Releases page and download the latest installer for your system.

  2. Run the Installer

    Double-click the downloaded installer file and follow the on-screen instructions to install Spark LoL Voice Assistant on your computer.

  3. Launch the Application

    After installation, launch Spark LoL Voice Assistant from the desktop shortcut or the Start menu.

  4. Initial Setup

    • Upon first launch, you'll be prompted to grant necessary permissions for the application to access League of Legends data.
    • Configure your preferred settings, such as selecting which events to monitor and customizing alert voices.

Usage

  1. Start the Application

    Ensure Spark LoL Voice Assistant is running before launching League of Legends. The application will automatically detect when the game is active.

  2. Configure Event Alerts

    • Open the settings panel within Spark.
    • Select the events you wish to receive voice alerts for, such as dragon spawns, Baron kills, turret destructions, etc.
    • Customize the voice messages and set the volume levels according to your preference.
  3. In-Game Alerts

    • As you play, Spark will monitor the game and provide voice notifications for the selected events.
    • Alerts will play automatically, allowing you to stay informed without interrupting your gameplay.
  4. Manage Notifications

    • Use the application interface to enable or disable specific alerts on the fly.
    • Update settings at any time to refine which events you receive notifications for.
  5. Exit the Application

    • To safely terminate Spark LoL Voice Assistant, click the "Exit" button within the application or close it from the system tray.

Contributing

Contributions are welcome to help improve and expand Spark LoL Voice Assistant! To contribute:

  1. Fork the Repository

    Click the "Fork" button at the top of the Spark LoL Voice Assistant GitHub repository to create your own copy.

  2. Clone Your Fork

    git clone https://github.com/your-username/spark-lol-voice-assistant.git
    cd spark-lol-voice-assistant
  3. Create a New Branch

    git checkout -b feature/your-feature-name
  4. Implement Your Changes

    Make your desired changes and enhancements to the codebase.

  5. Commit Your Changes

    git add .
    git commit -m "Add a new feature or fix a bug"
  6. Push to Your Fork

    git push origin feature/your-feature-name
  7. Open a Pull Request

    Navigate to the original repository and open a pull request detailing your changes.

Please ensure your code follows the project's coding standards and includes appropriate tests.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Disclaimer

Using third-party software with League of Legends may violate the game's Terms of Service. Use Spark LoL Voice Assistant at your own risk. Ensure that you do not compromise your account's integrity or violate game rules.


Stay updated with the latest versions and features by following the repository!

About

Real-time voice notification system designed to enhance your League of Legends gaming experience

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •