Skip to content

Manage League of Legends account's configs to export and import them easily between numerous accounts

License

Notifications You must be signed in to change notification settings

VGontier-cmd/summoner-configs

Repository files navigation

Summoner's Configs logo

Summoner's Configs

⭐ Star us on GitHub if you find the app useful.

Version

Version

Description

This application enables League of Legends players to manage the configurations of different League accounts and switch between them easily. It is built using an Electron, Vite, React, and Sass boilerplate, all in Typescript.

Features

  • Manage your different accounts configurations
  • Import and export them easily

How to use

1️ - Launch the League of Legends client and Summoner's Configs application.

2️ - Configure your Lol configuration path in the application using the "gear" button.

3️ - Import your account configurations by clicking on the import button in our application and choosing a profile name.

4️ - Repeat the import for each of your league accounts.

5️ - Now that you have all your configurations, you can easily switch from one to another by exporting them.

Please note that each time you import a profile into the League Client, you need to start a game to take it into account (this can be a custom game or anything else).

Preview

Img1    Img2

Releases

🖥️ Windows:

Installation for contributors

To run this application locally, follow these steps:

Clone the repository:

git clone https://github.com/VGontier-cmd/summoner-configs.git

Navigate to the project directory:

cd summoner-configs

Install the dependencies:

pnpm install

Usage

After installing the dependencies, you can start the application using the following command:

pnpm run dev

Contributing

We welcome contributions from the community. To contribute to this project, please follow these steps:

Fork the repository

Go to the GitHub repository you want to contribute to and click on the "Fork" button at the top right corner of the page. This will create a copy of the repository under your GitHub account.

Clone the repository

On your forked repository, click the "Code" button and copy the URL. Open your terminal and run the following command

git clone summoner-configs

Create a new branch

Create a new branch for your contribution using the following command:

git checkout -b your-branch

Replace your-branch with a descriptive name.

Commit your changes and push your changes

git add .
git commit -m "..."
git push origin my-branch

Create a pull request

Go to your forked repository on GitHub and you should see a message suggesting to create a pull request. Click on the "Compare & pull request" button, review your changes, and click "Create pull request". Provide a descriptive title and explanation of your changes in the pull request description.

Collaborate and iterate: The repository owner will review your pull request and may provide feedback or request changes. Engage in the discussion, make the necessary adjustments, and push new commits to your branch. The pull request will update automatically.

Merge the pull request: Once your pull request has been approved, the repository owner will merge your changes into the main repository. Congratulations, you've successfully contributed to the project!

Tips

Remember to regularly sync your forked repository with the original repository to stay up to date with the latest changes. You can do this by adding the original repository as a remote and pulling from it.

Packaging and Distribution

To package and distribute the Electron app for different operating systems, you can use the following commands:

Build and package the app

pnpm run build 
pnpm run package

The packaging is only supporting Windows.

License

This project is licensed under the MIT License.

Authors:

Feedback and Support

If you have any questions, or suggestions, or encounter any issues, please open an issue on GitHub or contact us directly.

Thank you for using our application! We hope you find it useful.

Disclaimer

This project isn’t endorsed by Riot Games and doesn’t reflect the views or opinions of Riot Games or anyone officially involved in producing or managing League of Legends. League of Legends and Riot Games are trademarks or registered trademarks of Riot Games, Inc. League of Legends © Riot Games, Inc.