Ocularum

A modern Electron-based Twitch viewer with autotune capabilities. Ocularum allows you to watch your favorite Twitch streamers with enhanced features like automatic stream launching and multi-stream viewing.

Features

• Twitch Integration: Authenticate with Twitch and browse your followed channels
• Stream Viewing: Watch Twitch streams with quality selection
• Autotune: Automatically start streams when your favorite streamers go live
• Multi-Stream Support: Watch multiple streams simultaneously with custom layouts
• Notifications: Get notified when followed streamers go live
• Cross-Platform: Works on Windows, macOS, and Linux

Getting Started

Prerequisites

• Node.js (v14 or later)
• Python 3.7+
• Streamlink

Installation

From Releases

1. Download the latest release for your platform from the Releases page
2. Install the application following the platform-specific instructions

Building from Source

1. Clone the repository

   git clone https://github.com/bluntwizard/Ocularum.git
   cd Ocularum
   

2. Install dependencies

   npm install
   

3. Set up Python environment

   pip install -r python/requirements.txt
   

4. Create a .env file with your Twitch API credentials:

   TWITCH_CLIENT_ID=your_client_id
   TWITCH_CLIENT_SECRET=your_client_secret
   

5. Start the development server

   npm run dev
   

Documentation

• User Guide - How to use Ocularum
• Developer Guide - How to develop for Ocularum
• Technical Architecture - Technical overview
• Project Roadmap - Future development plans

Contributing

We welcome contributions to Ocularum! Please see CONTRIBUTING.md for details on how to contribute.

License

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

Acknowledgments

• Electron - For the cross-platform desktop app framework
• React - For the UI library
• Streamlink - For the stream handling capabilities
• Twitch API - For the Twitch integration
• Material-UI - For the component library