PingToob Companion

A lightweight desktop application that monitors your microphone audio levels and sends them to the PingToob Streamlabs Desktop App.

👀 Overview

🎤 Simple microphone level monitoring
📡 Seamless integration with PingToob Streamlabs Desktop App
🚀 Easy to use - just click and go
💪 Lightweight and efficient
🔒 Secure local communication

🎯 How to Use

1. Install PingToob Companion
2. Launch the application
3. Click the Mic button to start monitoring
4. The app will automatically send audio levels to PingToob Streamlabs Desktop App

🛫 Development Setup

# clone the project
git clone https://github.com/pingtoob/pingtoob-companion.git

# enter the project directory
cd pingtoob-companion

# install dependency
npm install

# develop
npm run dev

🐞 Debug

📂 Directory structure

├── electron                                 Electron-related code
│   ├── main                                 Main-process source code
│   └── preload                              Preload-scripts source code
│
├── release                                  Generated after production build, contains executables
│   └── {version}
│       ├── {os}-{os_arch}                   Contains unpacked application executable
│       └── {app_name}_{version}.{ext}       Installer for the application
│
├── public                                   Static assets
└── src                                      Renderer source code, your React application

🔧 Features

• Real-time microphone level monitoring
• Automatic connection to PingToob Streamlabs Desktop App
• Simple one-click operation
• Minimal resource usage
• Cross-platform support

📝 License

MIT License

🤝 Contributing

Contributions, issues, and feature requests are welcome!

📦 Publishing Releases

To publish new releases to GitHub, you'll need to set up a Personal Access Token (PAT):

1. Go to GitHub Token Settings
2. Click "Generate new token (classic)"
3. Name your token (e.g., "PingToob Companion Publisher")
4. Select the following permissions:
   • repo (Full control of private repositories)
   • workflow (Update GitHub Action workflows)
5. Click "Generate token"
6. Copy your token immediately (you won't be able to see it again!)

Set up the token in your environment:

# Windows (PowerShell)
$env:GH_TOKEN="your-token-here"

# macOS/Linux
export GH_TOKEN="your-token-here"

To publish a new release:

1. Update the version in package.json
2. Run:

npm run publish

This will build the app and create a new GitHub release with portable executables.

🔄 Release URLs

To access the latest release, you can use these URLs:

• Latest release page:

https://github.com/Better-Scenes/pingtoob-companion/releases/latest

• Direct download URLs for latest assets:

# Windows portable executable
https://github.com/Better-Scenes/pingtoob-companion/releases/latest/download/PingToob.Companion_portable_1.0.0.exe

# Mac zip
https://github.com/Better-Scenes/pingtoob-companion/releases/latest/download/PingToob.Companion_1.0.0.zip

The /latest endpoint will always redirect to the most recent release, making it perfect for auto-update implementations or direct download links that should always point to the newest version.