/project-clippi

Automation framework for Slippi

Primary LanguageTypeScriptMIT LicenseMIT

Project Clippi Logo

Project Clippi

An Automation Framework for Super Smash Bros. Melee

Build Status License

Project Clippi is your portal into real-time game data. Detect an event → execute an action. Someone did a sick combo? Twitch clip it. A new game is starting? Change OBS scenes. A player died? Play a sound. Everything is open source and fully-customisable. The possibilities are endless.

Project Clippi main screenshot

Detect events and execute actions!

slp file processor screenshot

Built in replay processor helps you find combos and organise your SLP replays!

Highlights

  • Detect in game events and execute arbitrary actions
  • Customisable profiles for easy combo curation and combo video generation
  • One-click sort and rename your SLP files with ease
  • Twitch and OBS integration

Download

Download Project Clippi for your operating system using the links below or check out the releases page for more information.

Getting Started

You have two options when connecting Project Clippi to a Slippi source. You can connect to a console source using the Slippi Desktop App as a relay, or connect to a folder that has live SLP files being written to it. e.g. Slippi Dolphin. Follow the links below based on what source you are connecting to.

Contributing

If you found Project Clippi useful and would like to give back here's how you can:

  • Spread the word! The more people that use it, the more Project Clippi can improve!
  • If you have ideas for new features, or would like to report a bug, please tweet at @ProjectClippi.
  • If you are gifted in the way of code, you can help by adding more detectable events and more executable actions. Dive into the docs for the slp-realtime library which underpins this project and the source code for the Project Clippi front-end.

Development

Start the development server using:

yarn run start

The development server includes HMR and auto-reloading so changes to both the main and renderer processes should auto-update.

To create a binary package:

yarn run dist

For more detailed instructions on development and building the project from source, check out the Build Process section.

Acknowledgements

Project Clippi wouldn't be here without the work of Jas Laferriere and the rest of the Project Slippi team, and all the Project Clippi supporters.

License

This software is released under the terms of MIT license.