Skip to content

Its-Haze/lcu-events

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

5 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

LCU-Events

LCU Events

A powerful desktop application for real-time League Client event monitoring

Features β€’ Demo β€’ Installation β€’ Development

🎯 Overview

LCU Events is a high-performance desktop application that provides real-time monitoring and debugging capabilities for the League of Legends Client. Built with modern technologies including Wails, React, TypeScript, and Go, it offers a seamless experience for developers and enthusiasts alike.

✨ Features

LCU Event GUI Demo

Core Capabilities

  • πŸ”Œ Real-time Event Monitoring: WebSocket-based event subscription to the League Client API
  • πŸ” Advanced Filtering: Powerful event filtering and processing pipeline
  • πŸ”„ Reliable Connection: Automatic reconnection with exponential backoff
  • πŸ›‘οΈ Type Safety: Full TypeScript integration for robust event handling
  • ⚑ Performance: Efficient Go backend with minimal memory footprint
  • 🎨 Modern UI: Responsive React frontend with TailwindCSS
  • πŸ”„ Auto Updates: Seamless version checking and updates

πŸ› οΈ Tech Stack

Frontend

React 18+ TypeScript TailwindCSS React Query WebSocket

  • React 18+ with TypeScript
  • TailwindCSS for modern styling
  • React Query for efficient state management
  • WebSocket event handling
  • Responsive design with CSS Grid/Flexbox

Backend

Go 1.18+ LCU-gopher Wails WebSocket Goroutines

  • Go 1.18+ for high performance
  • LCU-gopher for LCU API integration
  • WebSocket event subscription with automatic reconnection
  • Event filtering and processing pipeline
  • Concurrent event handling with goroutines
  • Comprehensive error handling and logging

πŸ“₯ Installation

Windows

  1. Download the latest release
  2. Run the installer
  3. Launch from Start Menu or Desktop shortcut

πŸš€ Development

Prerequisites

Go 1.18+ Node.js NSIS Wails CLI

  • Go 1.18+
  • Node.js 16+
  • NSIS (for Windows installer)
  • Wails CLI

Quick Start

# Clone the repository
git clone https://github.com/its-haze/lcu-events.git
cd lcu-events

# Install dependencies
cd frontend && npm install && cd ..

# Start development
wails dev

Building

Windows

# Build the application
wails build -platform windows/amd64

# Build with installer
wails build -platform windows/amd64 -nsis

Development Build

# Start development server
wails dev

# Build development version
wails build -debug

πŸ“ License

This project is licensed under the MIT License - see the LICENSE file for details.

🀝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

πŸ› Known Issues

  • None at the moment

πŸ“ž Support

If you encounter any issues or have questions, please:

  1. Search existing issues
  2. Create a new issue if needed

πŸ™ Acknowledgments

  • Wails for the amazing framework
  • LCU-gopher for LCU API integration
  • All contributors and users of the project

About

LCU Events is a powerful desktop application for real-time League Client event monitoring

Topics

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors