Skip to content

A modern desktop streaming client built with Electron and Vue.js, designed to provide a seamless video streaming experience with advanced features and customization options.

License

Notifications You must be signed in to change notification settings

Kamiikaze/AdvS-Client

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

GitHub Release GitHub Release Date GitHub Downloads (all assets, all releases) GitHub Actions Workflow Status CodeFactor GitHub License

wakatime GitHub Published At GitHub Created At


AdvS-Client

A modern desktop streaming client built with Electron and Vue.js, designed to provide a seamless video streaming experience with advanced features and customization options.

🎯 Why AdvS-Client?

AdvS-Client was created to offer users a dedicated desktop application for streaming content with enhanced privacy, performance, and user experience features. The application provides a native desktop experience with integrated ad-blocking, history tracking, and an intuitive interface built on modern web technologies.

🌐 Supported Streaming Sources

AdvS-Client is designed to work with the following streaming platforms:

The application provides a unified interface to browse, search, and watch content from these platforms with enhanced features like ad-blocking, watch history, and improved video playback.

Platform Features

  • Unified Library: Access content from both platforms in one application
  • Cross-Platform History: Track your viewing progress across all sources
  • Consistent Experience: Same interface and features regardless of the source
  • Episode Management: Easy navigation through seasons and episodes
  • Direct Streaming: Stream content directly without browser overhead

Note: AdvS-Client acts as a client interface only. All content is provided by the respective streaming platforms. The application does not host, modify, or redistribute any content.

✨ Features

🎬 Video Streaming

Advanced video player powered by Vidstack with support for multiple streaming formats. Watch your favorite shows with a smooth, responsive playback experience.

πŸ“š Show Library Management

Browse and manage your show library with an organized dashboard. The application maintains an up-to-date list of available content with automatic updates.

πŸ“– Watch History

Track your viewing progress automatically. Resume watching from where you left off with built-in watch history functionality.

πŸ›‘οΈ Ad-Blocking

Integrated ad-blocking using Ghostery's Electron ad-blocker. Enjoy uninterrupted streaming with built-in protection against ads and trackers.

πŸ–₯️ System Tray Integration

Minimize to system tray for quick access. Control playback and access features directly from your taskbar.

πŸ”„ Auto-Updates

Automatic update checking ensures you always have the latest features and security improvements.

🎨 Modern UI

Beautiful, responsive interface built with Vuetify 3. Enjoy a clean, material design experience with dark mode support.

⚑ High Performance

Built on Electron with optimized rendering and resource management for smooth performance even during intensive streaming.

πŸ”— Deep Linking

Support for advs:// protocol for seamless integration with external applications and web browsers.

πŸ–ΌοΈ Desktop Shortcuts

Create desktop shortcuts for quick access to your favorite shows.

πŸ•ΉοΈ Discord Rich Presence

Shows what you're currently watching as your Discord activity β€” configurable and fully integrated with Discord RPC.

πŸ”„ Sync Watch State

Optionally sync your watch progress back to AniWorld.to and S.to, keeping everything in sync across platforms.

πŸ› οΈ Tech Stack

Frontend

  • Vue 3 - Progressive JavaScript framework
  • Vuetify 3 - Material Design component framework
  • Pinia - State management
  • Vue Router - Routing and navigation
  • Vidstack - Advanced video player
  • Vite - Next-generation build tool
  • TypeScript - Type-safe development

Backend (Electron)

  • Electron - Cross-platform desktop framework
  • GrandLineX - Modular kernel architecture
  • SQLite - Local database
  • Ghostery Ad-Blocker - Ad and tracker blocking
  • Discord RPC - Manages Discord Activity
  • TypeScript - Type-safe development

πŸ“‹ Requirements

  • Node.js 22.x or higher
  • npm, yarn, pnpm, or bun package manager

πŸš€ Installation

Development Setup

  1. Clone the repository:
git clone https://github.com/yourusername/advs-client.git
cd advs-client
  1. Install frontend dependencies:
cd frontend
npm install
  1. Install electron dependencies:
cd ../electron
npm install

Running in Development Mode

Start Frontend Development Server:

cd frontend
npm run dev

Start Electron Development:

cd electron
npm run startDev

Building for Production

Build the Application:

cd electron
npm run make

This will create distributable packages in the electron/out directory.

πŸ“¦ Project Structure

advs-client/
β”œβ”€β”€ electron/            # Electron main process
β”‚   β”œβ”€β”€ res/             # Resources (icons, preload, etc.)
β”‚   └── src/
β”‚   β”‚   β”œβ”€β”€ modules/     # Application modules
β”‚   β”‚   β”œβ”€β”€ window/      # Window management
β”‚   β”‚   └── util/        # Utilities
β”‚
β”œβ”€β”€ frontend/            # Vue.js frontend application
β”‚   β”œβ”€β”€ public/          # Static assets
β”‚   └── src/
β”‚       β”œβ”€β”€ assets/      # Resources (icons, etc.)
β”‚       β”œβ”€β”€ components/  # Vue components
β”‚       β”œβ”€β”€ lib/         # Utilities, Types
β”‚       β”œβ”€β”€ pages/       # Application pages
β”‚       β”œβ”€β”€ plugins/     # Vue plugins
β”‚       β”œβ”€β”€ router/      # Vue router
β”‚       β”œβ”€β”€ store/       # Pinia stores
β”‚       └── styles/      # Stylesheets
β”‚
β”œβ”€β”€ CODE_OF_CONDUCT.md
β”œβ”€β”€ CONTRIBUTING.md
β”œβ”€β”€ LICENSE.md
└── README.md

πŸ”§ Configuration

The application stores its configuration in the following locations:

Windows

Files Path
Installation %LOCALAPPDATA%/AdvS-Client
Logs / Database %USERPROFILE%/AdvS-Client
Browser %APPDATA%/AdvS-Client

🀝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request. By contributing to this project, you agree that your contributions will be licensed under the GNU AGPL-3.0 License.

How to Contribute

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

πŸ“ License

This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0) - see the LICENSE.md file for details.

What does this mean?

  • βœ… You can use, modify, and distribute this software
  • βœ… You can contribute to this project
  • βœ… Any modifications must be open-sourced under the same license
  • ❌ Commercial use requires open-sourcing all modifications
  • ❌ You cannot use this software in proprietary/closed-source products

⚠️ Important Notice

This project does NOT host, store, or distribute any copyrighted content. AdvS-Client is a streaming client interface that connects to external streaming providers. All content is streamed from third-party sources.

This project is NOT intended for commercial use. It is provided as-is for personal, educational, and non-commercial purposes only. Any commercial use must comply with the AGPL-3.0 license terms, requiring all modifications to be open-sourced.

The developers of AdvS-Client are not responsible for how users choose to utilize this software or for any content accessed through it. Users are responsible for ensuring their use complies with applicable laws and regulations in their jurisdiction.


Made with ❀️ using Vue.js and Electron

About

A modern desktop streaming client built with Electron and Vue.js, designed to provide a seamless video streaming experience with advanced features and customization options.

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks