Skip to content

Commit

Permalink
add readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
Julien Boidin committed Oct 29, 2023
1 parent d96c643 commit 3a48f44
Showing 1 changed file with 54 additions and 0 deletions.
54 changes: 54 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Rune Card Plugin for SW-Exporter

The Rune Card plugin for SW-Exporter allows you to log details of runes as you obtain them in the game Summoners War Sky Arena.

![rune card plugin](https://i.imgur.com/FTgPbBG.png)

## Table of Contents

1. [Requirements](#Requirements)
2. [Installation](#installation)
3. [Configuration](#configuration)
4. [Usage](#usage)
5. [Explanation](#explanation)

## Requirements

Download and install [sw-exporter](https://github.com/Xzandro/sw-exporter)

## Installation

To install the Rune Card plugin, follow these steps:

1. Download the Rune Card plugin `.asar` file
2. Place this file in your SW-Exporter `plugins` folder.
3. Restart SW-Exporter so that the plugin is recognized.

## Configuration

Once the plugin is installed, you can configure it by following these steps:

1. Open SW-Exporter and go to the plugins section.
2. Select the Rune Card plugin from the list of available plugins.
3. Configure the plugin according to your preferences using the following settings:

![rune card settings](https://i.imgur.com/WZWJOwg.png)

- `Stars`: The minimum number of stars to display the rune card. (1 by default)
- `Common`: Show common runes (⚪).
- `Magic`: Show magic runes (🟢).
- `Rare`: Show rare runes (🔵).
- `Hero`: Show hero runes (🟣).
- `Legend`: Show legendary runes (🟠).

4. Save your settings and close the configuration window.

## Usage

Once the plugin file is installed, it will start working automatically when you open SW-Exporter and play Summoners War. The runes you get in the game will be displayed in SW-Exporter with all the details you have configured.

## Explanation

The Rune Card plugin allows you to view all the detailed information of the runes you obtain in the game. This includes the rune's main and secondary stats, its star rating, its quality (common, magic, rare, heroic, or legendary), and much more. This information is presented in the form of "rune cards" that are easy to read and understand, helping you make informed decisions about which runes to keep and which to sell.

![rune card explanation](https://i.imgur.com/2ZjbbDp.png)

0 comments on commit 3a48f44

Please sign in to comment.