project-slippi / slippi-launcher

The way to play Slippi Online and watch replays.
GNU General Public License v3.0
246 stars 127 forks source link

Launcher icon Slippi Launcher

Build Status License

The Slippi Launcher acts as a one stop shop for everything Slippi related. It handles updating Slippi Dolphin, playing Slippi Online, launching and analyzing replays, and more.

This repository is part of the Project Slippi ecosystem. For more information about all of the Project Slippi projects, visit https://github.com/project-slippi/project-slippi.

Build Instructions

Prerequisites

These are the applications you will need to install in order to build this project:

Build Steps

Recommended IDE

For development, we recommend using VSCode with the following plugins:

These extensions will provide automatic formatting and warnings about code quality issues before you commit/push.

Project Structure

The src folder is split into the following:

The renderer folder is organised as follows:

Contributing

Contributions are welcome! The issues section contains some good first ideas. When making a PR, ensure you are not PRing your main branch and always describe the feature and what testing you've done so far.

Acknowledgements

This application uses Electron React Boilerplate as a base and includes most changes up to commit 10c22e5.

License

Slippi Launcher is released as open source software under the GPL v3 license. See the LICENSE file in the project root for the full license text.