CDGPlayer Libraries

CDGPlayer provides browser karaoke playback libraries under the @cxing/cdg-\* package family.

BREAKING CHANGE: The legacy CDGPlayer and CDGControls monolithic packages have been deprecated and replaced with a modular package architecture. See the migration guide for details.

Packages

• @cxing/cdg-core: CD+G parsing, instruction execution, and frame rendering primitives.
• @cxing/cdg-loader: zip/file/url loading with normalized track payloads and metadata.
• @cxing/cdg-player: high-level playback orchestration, audio sync, and rendering dispatch.
• @cxing/cdg-controls: framework-agnostic controls model and UI control builders.
• @cxing/logger: standalone scoped logging utility shared across runtime packages.

Install

Install the packages your app needs.

• Minimal playback setup: @cxing/cdg-player
• Loader-only integrations: @cxing/cdg-loader
• UI control integrations: @cxing/cdg-controls
• Runtime logging integrations: @cxing/logger

Documentation

• Getting started
• Migration guide
• Logger contract
• Loader contract
• Player contract
• Controls contract
• Framework-agnostic implementation guide
• React implementation guide

Repository Contribution

Repository setup, CI/CD workflows, and branch protection policy are documented in CONTRIBUTING.md.