Skip to content

OverlayFox/CaspawCG

Repository files navigation

CaspawCG

A GoLang + Wails application designed to integrate the CasparCG server with dynamic data sources.

CaspawCG enables real-time graphics control for live broadcasting by connecting CasparCG Server with external data sources like Google Sheets, providing a UI inspired by CharacterWorks.

Features

  • 🎨 Live Graphics Control - Real-time control of CasparCG graphics and templates
  • 📊 Data Source Integration - Pull data from Google Sheets and other sources
  • 🖥️ Modern UI - Built with Wails for a native desktop experience
  • Real-time Updates - Event-driven architecture for instant data synchronization
  • 🎯 Layout Management - Flexible layout configuration system
  • 🔧 Multi-Server Support - Connect to multiple CasparCG servers simultaneously

For Developers

Prerequisites

Development

  1. Clone the repository:
git clone https://github.com/yourusername/CaspawCG.git
cd CaspawCG
  1. Install dependencies:
# Install Go dependencies
go mod download

# Install Linter
make install-dev

# Install frontend dependencies
cd frontend
npm install
cd ..
  1. Start CasparCG
# Starts CasparCG 2.5.0 with a base config
# Run each make command in a new terminal session
make caspar-scanner
make caspar-server
  1. Run the application:
# Run in development mode
make dev

Configuration

  1. Copy the example configuration file:
cp config.example.yaml config.yaml
  1. Edit config.yaml with your settings:
data_source_manager:
  google_sheet_data_sources:
    - spreadsheet_id: "your_spreadsheet_id_here"
      credentials_file_path: "path/to/credentials.json"

casparcg_client:
  - host: "localhost"
    port: 5250

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  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 MIT License - see the LICENSE file for details.

Acknowledgments

Support

For issues, questions, or suggestions:

About

A CasparCG client inspired by CharacterWorks

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Contributors