From 51c10a2a2f50f206294bbb5113053e62a5c9f49c Mon Sep 17 00:00:00 2001 From: JSC Date: Sun, 5 Oct 2025 16:33:12 +0200 Subject: [PATCH] Remove README.md file as part of project cleanup --- README.md | 166 ------------------------------------------------------ 1 file changed, 166 deletions(-) diff --git a/README.md b/README.md index 41382fb..e69de29 100644 --- a/README.md +++ b/README.md @@ -1,166 +0,0 @@ -# SDB Audio Extractor Chrome Extension - -A Chrome extension that allows you to extract audio from YouTube videos directly to your SDB soundboard application. - -## Features - -- 🎵 Extract audio from YouTube videos with one click -- 🔐 Secure API token authentication -- ⚡ Immediate response - extraction happens in the background -- 📝 Right-click context menu support -- ⚙️ Easy configuration through options page -- 🔄 Real-time status updates - -## Installation - -### Method 1: Developer Mode (Recommended) - -1. Download or clone this extension to your computer -2. Open Chrome and navigate to `chrome://extensions/` -3. Enable "Developer mode" in the top right corner -4. Click "Load unpacked" and select the `chrome-extension` folder -5. The extension should now appear in your extensions list - -### Method 2: Pack and Install - -1. In Chrome, go to `chrome://extensions/` -2. Enable "Developer mode" -3. Click "Pack extension" -4. Select the `chrome-extension` folder as the root directory -5. Click "Pack Extension" to create a `.crx` file -6. Install the `.crx` file by dragging it to the extensions page - -## Configuration - -Before using the extension, you need to configure your API credentials: - -1. Click the extension icon in Chrome's toolbar -2. Click "Configure API Token" or right-click the extension and select "Options" -3. Follow these steps to get your API token: - - Open your SDB soundboard application (usually at http://192-168-100-199.sslip.io) - - Log into your account - - Navigate to your user settings or profile page - - Generate a new API token - - Copy the token -4. Paste the token in the "API Token" field -5. Verify the "API Base URL" (default: http://192-168-100-199.sslip.io) -6. Click "Test Connection" to verify everything works -7. Click "Save Settings" - -## Usage - -### Method 1: Extension Popup - -1. Navigate to any YouTube video page -2. Click the SDB Audio Extractor extension icon in your toolbar -3. The popup will show the current video title and URL -4. Click "Extract Audio" to start the extraction -5. The extension will send the request to your SDB backend -6. Check your soundboard application for the extracted audio - -### Method 2: Right-Click Context Menu - -1. Navigate to any YouTube video page -2. Right-click anywhere on the page -3. Select "Extract Audio with SDB" from the context menu -4. You'll receive a notification when the extraction starts - -## Requirements - -- Chrome browser (version 88+) -- SDB soundboard backend running and accessible -- Valid API token from your SDB user account -- Internet connection for YouTube access - -## File Structure - -``` -chrome-extension/ -├── manifest.json # Extension configuration -├── popup.html # Main popup interface -├── popup.js # Popup functionality -├── options.html # Configuration page -├── options.js # Options page functionality -├── content.js # YouTube page integration -├── background.js # Background service worker -├── icon16.png # Extension icon (16x16) -├── icon48.png # Extension icon (48x48) -├── icon128.png # Extension icon (128x128) -└── README.md # This file -``` - -## Permissions - -The extension requires the following permissions: - -- `activeTab`: To access the current YouTube tab -- `storage`: To save your API configuration -- `https://www.youtube.com/*`: To work on YouTube pages -- `http://localhost:8000/*`: To communicate with your SDB backend - -## Troubleshooting - -### "API token not configured" Error - -- Make sure you've configured your API token in the extension options -- Verify the token is correctly copied from your SDB account - -### "Cannot connect to API server" Error - -- Check that your SDB backend is running (usually on port 8000) -- Verify the API Base URL in the extension options -- Make sure there are no firewall issues blocking localhost connections - -### "Authentication failed" Error - -- Your API token might be expired or invalid -- Generate a new API token in your SDB account -- Update the token in the extension options - -### Extension not working on YouTube - -- Make sure you're on a YouTube video page (youtube.com/watch?v=...) -- Try refreshing the page and clicking the extension again -- Check the browser console for any error messages - -### Right-click menu not appearing - -- The context menu only appears on YouTube video pages -- Make sure the extension is enabled and properly loaded -- Try reloading the extension in chrome://extensions/ - -## Development - -To modify or extend this extension: - -1. Make your changes to the source files -2. Go to `chrome://extensions/` -3. Click the refresh button on the SDB Audio Extractor extension -4. Test your changes - -### Adding New Features - -- Modify `manifest.json` for new permissions or files -- Update `popup.html` and `popup.js` for UI changes -- Modify `content.js` for YouTube page interaction -- Update `background.js` for background functionality - -## Security Notes - -- Your API token is stored locally in Chrome's sync storage -- The extension only communicates with YouTube and your configured SDB backend -- No data is sent to third-party services -- Always use HTTPS in production environments - -## Support - -If you encounter issues: - -1. Check the troubleshooting section above -2. Verify your SDB backend is running and accessible -3. Check the browser console for error messages -4. Ensure your API token is valid and has proper permissions - -## License - -This extension is part of the SDB soundboard project. \ No newline at end of file