Skip to content

vhrita/paladins-dynamic-overlay

Repository files navigation

Paladins Dynamic Overlay

๐ŸŒ Available Languages

๐Ÿ“Œ Table of Contents

๐Ÿ† About the Project

The Paladins Dynamic Overlay was originally created in 2018 as a private personal project to enhance the streaming experience for the game Paladins. Now, in 2025, it is being refactored and open-sourced.

๐Ÿ”— For more details on this journey, check out my LinkedIn post.

๐Ÿš€ Current Features

โœ… Built with Next.js โœ… WebcamOverlay with manual character selection โœ… Dynamic border color and character image change โœ… Resizable WebcamOverlay component

๐Ÿ”จ Upcoming Features (In Development Order)

  1. ๐Ÿ›  Component Editing Page
  2. ๐Ÿ”— Exportable overlay links for OBS integration
  3. ๐Ÿ† Streamer name displayed alongside the WebcamOverlay border
  4. ๐ŸŽจ Animated Borders for WebcamOverlay
  5. ๐Ÿ”ฅ Animated effects around character images
  6. ๐Ÿ–ผ๏ธ Presets for character images (including GIFs)
  7. ๐ŸŽญ Text Banner Component (e.g., "Latest Follower")
  8. ๐Ÿ“„ Complete pages where multiple components can be combined and exported
  9. ๐Ÿ–ฑ๏ธ Drag and Drop support for image positioning
  10. ๐Ÿ”„ Logged-in Area for automatic character updates via Paladins API

๐Ÿ’ก Possible Future Enhancements

  • ๐ŸŒ Fully customizable overlays with any images and colors, beyond just Paladins themes

๐Ÿ“‚ Repository Structure

  • master โ†’ Contains the stable refactored version.
  • refactor โ†’ Features in development before merging into master.
  • legacy โ†’ The original 2018 version, available for comparison.

โš™ Running the New Project

๐Ÿ“Œ 1. Setting Up the Environment

  1. Clone the repository:
    git clone https://github.com/vhrita/paladins-dynamic-overlay.git
    cd paladins-dynamic-overlay
  2. Install dependencies:
    npm install
  3. Run the development server:
    npm run dev
  4. Access it at:
    http://localhost:3000
    

โš™ Running the legacy Project

๐Ÿ“Œ 1. Checkout the legacy Branch

  1. Clone the repository if you haven't already:
    git clone https://github.com/vhrita/paladins-dynamic-overlay.git
    cd paladins-dynamic-overlay
  2. Switch to the legacy branch:
    git checkout legacy

๐Ÿ“Œ 2. Setting Up Credentials

  • paladins.js โ†’ Replace YOUR_PALADINS_API_KEY and devId.
  • spotify.js โ†’ Fill in YOUR_CLIENT_ENCODED and YOUR_SPOTIFY_AUTH_CODE.

๐Ÿ“Œ 3. Running a Local Server

  • Using VS Code Live Server:
    1. Install the Live Server extension in VS Code.
    2. Right-click index.html and select Open with Live Server.
    3. The project will automatically open in your browser.

๐Ÿ“Œ 4. Accessing HTML Files

Page Local URL Description
Main Overlay 127.0.0.1/index.html Main overlay interface.
Currently Playing 127.0.0.1/current_playing.html Displays Spotify song info.
Be Right Back 127.0.0.1/coming_soon.html Streamer away screen.

๐Ÿ“œ License

This project is licensed under the Creative Commons Attribution-NonCommercial 4.0 (CC BY-NC 4.0). This means:

โœ… You can:

  • Use, modify, and share this project for personal and non-commercial purposes.
  • Modify the code as needed, as long as you credit the original author.

โŒ You cannot:

  • Use this project for commercial purposes without explicit permission.
  • Claim ownership of the original project.
  • Distribute modified versions without indicating that changes were made.

For more details, see the LICENSE file.


Now you're ready, enjoy! ๐Ÿš€

About

๐ŸŽฎ Dynamic Overlay for Paladins streamers โ€“ originally created in 2018, now being refactored with modern technologies. ๐Ÿš€

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors