ClipForge

---

ClipForge is a simple Discord bot that lets you record and create video clips from your Discord voice channels. It continuously records and makes it easy to save highlights without hassle. Clips are hosted through a web interface using the Caddy web server, so you can access them anytime.

Features

• Continuous video recording with clipping functionality.
• Manual login to Discord with session persistence.
• Hosted video files accessible via a web interface.
• Automated startup scripts for streamlined usage.

---

Prerequisites

1. Node.js: Install Node.js and npm (Download here).
2. Caddy Web Server: Install the Caddy web server (Installation guide).
3. Git: For cloning the repository.
4. VPS: Use a VPS for best results. Mainly for the Hosting part.

---

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/clipforge.git
   cd clipforge

2. Install dependencies:

   npm install

---

Configuration

1. Replace Necessary Values in main.js

Edit the main.js file and replace the following placeholders with your actual values:

const DISCORD_URL = 'DISCORD_VOICE_CHANNEL_URL'; // Replace with the URL of your Discord voice channel.
const USER_DATA_DIR = '/opt/clipforge/user_data'; // Path to the session data directory.
const RECORDING_DIR = '/opt/clipforge/captures'; // Path to the directory for saving recordings.
const HOSTED_DIR = '/opt/clipforge/hosted'; // Path to the directory for hosting clips.
const DISPLAY = ':99'; // Display server configuration (default).
const WEB_SERVER_PORT = 8080; // Port for the local web server.
const PIPE_PATH = '/tmp/clipforge-pipe'; // Path for the pipe file.
const BOT_TOKEN = 'YOUR_BOT_TOKEN'; // Replace with your Discord bot token.
const COMMAND_CHANNEL_ID = 'COMMAND_CHANNEL_ID'; // Replace with your Discord command channel ID.
const CLIP_DOMAIN = 'example.com'; // Replace with your domain for accessing clips.

2. Create a Discord Bot

1. Go to the Discord Developer Portal.
2. Create a new application and navigate to the "Bot" tab.
3. Add a bot to your application and copy the bot token.
4. Replace YOUR_BOT_TOKEN in main.js with your copied bot token.
5. Invite your bot to your server using the OAuth2 URL generator with the necessary permissions to manage channels and send messages.

3. Manual Discord Login

The open_browser.js script is used for manual Discord login and session persistence:

1. Run the open_browser.js script:

   node open_browser.js

2. Log in to Discord manually through the opened browser.

3. The session data will be saved in the user_data/ directory.

4. Web Hosting Setup

1. Configure the Caddyfile to host files in the captures/ directory. By default, the Caddyfile is located at /etc/caddy/:

   :80
   root * /path/to/clipforge/captures
   file_server
   

1.1 If you are using a Domain the Caddyfile will look similar to this:

{
    email email@example.com
}

example.com {
    # Serve video files directly
    root * /opt/clipforge/hosted
    file_server {
        index off
    }

    # Proxy all other paths to FileBrowser
    reverse_proxy / localhost:9090 {
        header_up Host {host}
        header_up X-Real-IP {remote_host}
        header_up X-Forwarded-For {remote_host}
        header_up X-Forwarded-Proto {scheme}
    }

    log {
        output stdout
        format console
    }
}

2. Start the Caddy web server:

   caddy run

---

Usage

1. Run the startup script (use tmux for persistence):

   ./start.sh

Discord Commands

/join

Makes the bot join the current voice channel and starts recording.

/clip

Saves a clip from the active recording. Default duration is 1 Minute.

/stop

Stops the continuous recording of the voice channel.

/leave

Disconnects the bot from the current voice channel.

Clip will be sent to the Discord Channel (as URL not as File)

---

Current Issues

Recording File Size: Currently, the bot continuously records, which causes the recording file size to grow indefinitely. When a /clip command is issued, the full recording file is temporarily copied to extract the clip, which can take a long time for large recordings. This may also lead to timing mismatches in the clips.

Upcoming Features

• Process: Make it a Process or Binary
• OBS Integration: Future updates will integrate OBS with its replay buffer to handle recording and clipping efficiently.
• Auto-Join Voice Calls: The bot will automatically join a voice call when a user enters the channel.
• Discord Full Screen: Support for full-screen Discord functionality.

---

Directory Structure

• captures/: Directory for saved video outputs.
• user_data/: Stores persistent session data for Discord.
• open_browser.js: Script for manual Discord login.
• main.js: Primary script for video recording and management.
• Caddyfile: Configuration file for the Caddy web server.
• start.sh: Shell script to automate the startup process.

---

Troubleshooting

• Session Issues: If main.js cannot access Discord, ensure you have logged in using open_browser.js and session data is correctly saved in user_data/.

• Caddy Hosting: Ensure the Caddyfile path matches the correct directory and that the server has permission to access the files.

---

License

MIT License

---

Contribution

Feel free to submit issues or pull requests to improve ClipForge!