The OBS Detector Chrome Extension is a simple utility that allows users to quickly identify whether the OBS WebSocket server is actively running on their local machine. It provides an instant visual feedback via the browser's toolbar. This is useful for developers who are building applications that interact with OBS via the WebSocket API. This extension is only meant to be used as a template for other developers to build upon. It is not extremely useful for the average user.
- Instant Status: Quickly view the running status of your OBS WebSocket server directly from your browser.
- Badge Indicators: Uses color-coded badge text (ON/OFF) to visually represent the WebSocket server's status.
- Simple Interaction: Click on the extension icon to get a more detailed status in a popup.
- Clone or download this repository to your local machine.
- Open Chrome and navigate to
chrome://extensions/. - Ensure "Developer mode" is enabled (toggle the switch in the top-right).
- Click on "Load unpacked" and select the directory where you saved/cloned this extension.
- The OBS Detector icon should now appear in your browser's toolbar.
Ensure that the OBS WebSocket plugin is installed and running in OBS. By default, this extension checks for a WebSocket server on localhost at port 4444. If the OBS WebSocket server is running, the extension badge will display "ON" with a green background. If not, it will display "OFF" with a red background.
If you encounter any issues or unexpected behavior:
- Navigate to
chrome://extensions/. - Find the OBS Detector extension and click on "Inspect" for the background page.
- Check the console logs for any messages or errors.
Contributions, bug reports, and feature requests are welcome! Feel free to open an issue or submit a pull request.
This project is open-source and available under the MIT License.