explaingit

hiram-wong/zyfun

8,460TypeScriptAudience · generalComplexity · 2/5LicenseSetup · easy

TLDR

Free cross-platform desktop app for playing on-demand video and live streams from user-configured online sources, running on Windows, macOS, and Linux.

Mindmap

mindmap
  root((zyfun))
    Content types
      On-demand video
      Live streams
    Platforms
      Windows
      macOS
      Linux
    Features
      Multiple playback engines
      One-key hide
      Local history
    Tech stack
      TypeScript
      Electron
Click or tap to explore — scroll the page freely

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

Things people build with this

USE CASE 1

Play on-demand films and TV shows from custom-configured JSON source lists on your desktop.

USE CASE 2

Watch live streams from user-defined sources and switch between multiple playback engines without restarting.

USE CASE 3

Store viewing history and settings locally and quickly hide the app window with a single key shortcut.

Tech stack

TypeScriptElectron

Getting it running

Difficulty · easy Time to first run · 5min

Personal use only, the README requires uninstalling within 24 hours and prohibits commercial use.

Personal use only, must be uninstalled within 24 hours, commercial use is prohibited.

In plain English

Zyfun is a free, cross-platform desktop application for playing video content from online sources. It runs on Windows 10 and above, macOS 12 and above, and Linux, and is built with Electron, the same framework used by many popular desktop apps. The app lets you manage collections of video sources, which you configure using a structured JSON format, and play content from those sources using one of several built-in playback engines. The interface covers two main content types: on-demand video (films and TV shows) and live streams. You can switch between multiple playback engines without restarting the app. A one-key hide shortcut lets you quickly conceal the application window. History and settings data are stored locally on your machine in platform-specific directories the README documents for each operating system. The README states the software is for personal use only, instructs users to uninstall it within 24 hours, and prohibits commercial use. The project emphasizes that the app itself does not store or distribute video content, it is a playback tool that connects to external sources the user configures. The project originated as a continuation of ZY-Player. Downloads are available for Windows (x64 and ARM64), macOS (x64 and ARM64), and Linux (x64 and ARM64) through the GitHub releases page. A nightly build is also available for each platform. The README includes troubleshooting steps for common installation issues on each operating system, such as the macOS security warning for unverified apps and missing system libraries on Linux.

Copy-paste prompts

Prompt 1
I want to add a custom video source to Zyfun. What JSON format does the source list need to follow, and how do I load it into the app?
Prompt 2
Zyfun supports multiple playback engines. How do I switch between them inside the app while content is running?
Prompt 3
I installed Zyfun on macOS and see a security warning about an unverified app. What steps do I take to open it anyway?
Prompt 4
Where does Zyfun store my history and settings on Windows versus macOS versus Linux?
Open on GitHub → Explain another repo

← hiram-wong on gitmyhub — every repo by this author, as a profile.

Verify against the repo before relying on details.