Project Clippi

An Automation Framework for Super Smash Bros. Melee [![Build Status](https://github.com/vinceau/project-clippi/workflows/build/badge.svg)](https://github.com/vinceau/project-clippi/actions?workflow=build) [![License](https://img.shields.io/badge/license-MIT-brightgreen)](https://github.com/vinceau/project-clippi/blob/master/LICENSE) Project Clippi is your must-have Slippi toolkit for tapping into real-time game data and processing replay files. Automatically execute actions when an in-game event occurs. Automatically find and curate combos for that sick combo video. Automatically rename and reorganise your SLP files. Everything is open source and fully-customisable. The possibilities are endless.

Screenshots

_Detect events and execute actions!_ ![Project Clippi main screenshot](docs/images/1-automator.png) _Built in replay processor helps you find combos and organise your SLP replays!_ ![slp file processor screenshot](docs/images/2-processor.png) _Easily play and record SLP files with a single click!_ ![Project Clippi playback queue screenshot](docs/images/3-playback.png)

Highlights

Detect in game events and execute arbitrary actions
Customisable profiles for easy combo curation and combo video generation
Automatically record Dolphin gameplay footage without black frames
One-click sort and rename your SLP files with ease
Twitch and OBS integration

Download

Project Clippi is available on Windows, MacOS, and Linux. Check out the releases page to download the latest version.

Usage

To make combo videos using the Project Clippi, check out this guide on using the Replay Processor.

To turn SLP files into video using the Project Clippi, check out this guide on using the Playback Queue.

To take advantage of real-time game events using the Automator, you will need to connect Project Clippi to one of the following console sources:

Slippi Dolphin (guide)
Wii Console Relay via Slippi Launcher (guide)

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.
PRs are welcome and encouraged! Do make sure to read through the development guidelines though.

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, the rest of the Project Slippi team, and all the Project Clippi supporters.

License

This software is released under the terms of MIT license.

vinceau / project-clippi

readme