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.
These are the applications you will need to install in order to build this project:
git clone https://github.com/project-slippi/slippi-launcher.git
yarn install
to install all dependenciesyarn run start
to run the app in develop modeyarn run package
to build a releaseFor 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.
src
folder is split into the following:common
main
and renderer
processes. Thus the code written should be agnostic to which thread its being imported from.main
renderer
<module>
renderer
folder is organised as follows:components
containers
lib
.lib
styles
views
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.
This application uses Electron React Boilerplate as a base and includes most changes up to commit 10c22e5.
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.