Skip to content

opeik/runback

Repository files navigation

Contributors Forks Stargazers Issues License


Logo

Runback

Broadcast graphics for fighting games
Download · Report Bug · Request Feature

Table of Contents

  1. About The Project
  2. Screenshots
  3. Getting Started
  4. Usage
  5. Roadmap
  6. Contributing
  7. License

About The Project

Runback Screen Shot 1

Runback is a broadcast graphics system designed for fighting games tournaments, featuring:

  • Scoreboard and commentator overlays
  • Player management
  • Player import and export
  • Player detail overrides for on-the-fly editing
  • Auto gamertag Latinization for non-Latin scripts
  • smash.gg integration
    • Import tournament entrant data
  • Light and dark mode
  • Windows, macOS, Linux support

Built With

Screenshots

Runback Screen Shot 2 Runback Screen Shot 3

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

  • git
  • npm
  • yarn
  • node

Building

  1. Clone NodeCG

    git clone https://github.com/nodecg/nodecg
  2. Install NodeCG npm packages

    cd nodecg && npm install --production
  3. Clone runback

    cd bundles && git clone https://github.com/opeik/runback
    cd runback && git submodule update --init --recursive
  4. Install runback npm packages

    yarn install
  5. Build runback

    yarn watch
  6. Start the NodeCG server

    node ../..
  7. Open http://localhost:9090/

Usage

Installing

  • Download runback from the releases page
  • Once installed, open runback; the Dashboard tab will open

Importing overlays

  • Open the Graphics tab
  • Click and drag from the "Drag into OBS" button into OBS for the overlay you wish to import
    • If you're on macOS, click and drag isn't supported in OBS; use the settings below
  • Edit the newly created Browser Source, set:
    • FPS to 60
    • Shutdown source when not visible to ON
    • Refresh browser when scene becomes available to ON
  • Screenshot for reference

Setup smash.gg integration

Import players from smash.gg

  • Open the Dashboard tab
  • Click "Set Tournament" and enter the tournament URL
  • Click "Fetch Entrants"
    • The players will be imported and can be found in the Players tab

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/amazing-feature)
  3. Commit your Changes (git commit -m 'Add some amazing feature')
  4. Push to the Branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

License

Distributed under the GPLv3 License. See LICENSE.md for more information.