From 65514e795f36097aba85287e2c3c0d4b52f6251b Mon Sep 17 00:00:00 2001 From: Darren Paxton Date: Wed, 10 Dec 2025 14:37:22 -0500 Subject: [PATCH] Added README --- README.md | 82 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 82 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..0917fcc --- /dev/null +++ b/README.md @@ -0,0 +1,82 @@ +# FabSwingers Chat Enhancements + +A Tampermonkey userscript that adds useful features to the FabSwingers chat. + +## Features + +- **MaxDockedCams** - Override the limit on how many webcam feeds you can dock +- **Keep Alive** - Automatically sends a message to prevent being timed out for inactivity (default: 10 minutes) +- **Multi-Poke** - Adds a "10x" button next to each user's poke button to send 10 pokes rapidly +- **Draggable Buttons** - All control buttons can be dragged anywhere on screen and positions are saved + +## Installation + +### Step 1: Install Tampermonkey + +#### Firefox +1. Go to [Tampermonkey for Firefox](https://addons.mozilla.org/en-US/firefox/addon/tampermonkey/) +2. Click "Add to Firefox" +3. Click "Add" when prompted for permissions + +#### Chrome +1. Go to [Tampermonkey for Chrome](https://chrome.google.com/webstore/detail/tampermonkey/dhdgffkkebhmkfjojejmpbldmpobfkfo) +2. Click "Add to Chrome" +3. Click "Add extension" when prompted + +### Step 2: Install the Script + +1. Click this link to install the script directly: + + **[Install Script](https://git.upto.im/geekery/scripts/raw/branch/main/cams.js)** + +2. Tampermonkey will open and show you the script +3. Click "Install" to add it + +The script will automatically update when new versions are released. + +## Usage + +Once installed, visit the FabSwingers chat. You'll see three buttons in the top-right corner: + +| Button | Function | +|--------|----------| +| **10x ON/OFF** | Toggle multi-poke buttons on user list | +| **Keep Alive ON** | Shows status and interval; click to configure | +| **Set MaxDockedCams** | Click to set custom docked cam limit | + +### Moving Buttons + +All buttons are draggable. Click and drag to reposition them anywhere on screen. Positions are saved automatically. + +### Keep Alive Settings + +Click the Keep Alive button to open settings: +- Adjust interval (1-30 minutes) +- Start/Stop the timer +- Enabled by default on page load + +### Multi-Poke + +When enabled, an orange "10x" button appears next to each user's poke button. Clicking it sends 10 pokes in rapid succession with a countdown display. + +## Troubleshooting + +**Buttons not appearing?** +- Make sure Tampermonkey is enabled +- Refresh the page +- Check that the script is enabled in Tampermonkey dashboard + +**Keep Alive not working?** +- Make sure you have a public chat room open (General Chat, Directing Room, etc.) +- Check browser console for error messages + +**Positions reset?** +- Positions are stored in localStorage. Clearing browser data will reset them. + +## Updating + +The script checks for updates automatically. You can also manually update: +1. Click the Tampermonkey icon +2. Go to Dashboard +3. Click the script name +4. Click "Check for updates"