Skip to content

TrueBurn/firebot-giveaway-obs-overlay

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Firebot Giveaway OBS Overlay

A stylish, animated overlay for Firebot giveaways with Warframe-inspired design.

Usage

  1. Start the application
  2. Add a Browser Source in OBS Studio pointing to http://localhost:5243/giveaway
  3. Configure the overlay settings through the Setup page
  4. Start your giveaway in Firebot
  5. The overlay will automatically update based on the giveaway status

Configuration

The application can be configured through the appsettings.json file:

{
  "AppSettings": {
    "FireBotFileFolder": "G:\\Giveaway",    // Directory where Firebot stores giveaway files
    "CountdownMinutes": 59,                 // Default countdown minutes
    "CountdownSeconds": 59,                 // Default countdown seconds
    "PrizeSectionWidthPercent": 75,         // Width percentage for prize section
    "PrizeFontSizeRem": 4.5,                // Font size for prize text
    "TimerFontSizeRem": 3.0,                // Font size for timer
    "EntriesFontSizeRem": 3.0               // Font size for entries counter
  }
}

Configuration Options:

  • FireBotFileFolder: Set this to the directory where Firebot stores your giveaway files
  • CountdownMinutes and CountdownSeconds: Default duration for giveaways
  • PrizeSectionWidthPercent: Controls the layout width distribution (50-90%)
  • PrizeFontSizeRem, TimerFontSizeRem, EntriesFontSizeRem: Font size settings

OBS Integration

  1. In OBS Studio, add a new Browser Source
  2. Set the URL to http://localhost:5243/giveaway
  3. Recommended dimensions:
    • Width: 1200px
    • Height: 300px
  4. Important Browser Source settings:
    • Enable "Refresh browser when scene becomes active"
    • Enable "Shutdown source when not visible" for better performance
    • Set custom CSS to body { background-color: rgba(0, 0, 0, 0); margin: 0px auto; overflow: hidden; }

Features

  • 🎮 Warframe-inspired design
  • ✨ Animated effects and transitions
  • 🎯 Real-time entry counter with animations
  • 🏆 Celebratory winner announcement with animated trophies
  • 🎨 Gradient color schemes with animated borders
  • 📱 Responsive layout with customizable dimensions
  • ⏱️ Configurable countdown timer
  • 🔧 Easy setup page for all customization options

Setup Page Options

The setup page allows you to configure:

  • Countdown timer duration
  • Firebot file path
  • Layout proportions
  • Font sizes for all elements

Development

The project is built using:

  • ASP.NET Core 8.0
  • Blazor Server
  • Bootstrap 5.1
  • CSS animations

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Commit your changes
  4. Push to the branch
  5. Create a Pull Request

Acknowledgments

  • Built for integration with Firebot
  • Inspired by the Warframe community and streaming aesthetics
  • Special thanks to all contributors and testers

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published