# **Siero**
Siero is a Discord bot for Granblue Fantasy crews. She can help you save your sparks, simulate gacha, and more.

See the [wiki](https://github.com/jedmund/siero-bot/wiki) for more on how to use Siero, or keep scrolling!.

# **Commands**
## **Sparks**
#### Shorthand
This guide uses `$spark`, but Siero will also listen if you use `$s`. You can always access help in Discord with `$spark help`.

#### Currency
When using Siero's spark commands to record your progress, you must specify a `currency`. The `currency` argument accepts both singular and pluralized nouns.
```ruby
$spark set 100 crystals
$spark add 1 ticket
$spark remove 2 tentickets
```

#### Commands
Siero provides a variety of ways to interact with your spark.

See the current status of your spark
```ruby
$spark status
```

Set an amount of a single currency
```ruby
$spark set <amount> <currency>

# Example
$spark set 100 crystals
```

Add an amount of a single currency to your total
```ruby
# Both of these work!
$spark add <amount> <currency>
$spark save <amount> <currency>

# Example
$spark save 100 crystals
```

Remove an amount of a single currency from your total
```ruby
# Both of these work!
$spark remove <amount> <currency>
$spark spend <amount> <currency>

# Example
$spark spend 100 crystals
```

Quickly set amounts for all currencies
```ruby
$spark quicksave <crystals> <tickets> <tentickets>

# Example
$spark quicksave 45200 78 2
```

#### Spark Target

Set a target for your spark
```ruby
$spark target set <item>

# Example
$spark target set Ixaba
$spark target set Sturm (Grand)

# Use the keyword "(Unreleased)" to set units 
# that haven't been released yet as your target
$spark target set Alliah (Unreleased)
```

Check your spark target
```ruby
$spark target
```

#### Leaderboard

Show a leaderboard of the top savers in the past 14 days (Server-only)
```ruby
$spark leaderboard
```

Show a leaderboard of the lowest savers in the past 14 days (Server-only)
```ruby
$spark loserboard
```

## **Gacha**
#### Shorthand
This guide uses `$gacha`, but Siero will also listen if you use `$g`. You can always access help in Discord with `$gacha help`.

#### Commands
Siero provides a variety of ways to help with your gambling addiction.

A single Premium Gala draw
```ruby
$gacha yolo
```

A 10-part Premium Gala draw
```ruby
$gacha ten
```

A spark (30 10-part Premium Gala draws)
```ruby
$gacha spark
```

Pull until you get a target item
```ruby
$gacha until <item>

# Example
$gacha until Belial
```

#### Galas and Seasons
When using Siero's gacha commands, you can add a **gala** and/or a **season**.

**Galas** will affect the gacha pool as well as the draw rate.
```ruby
# The default gala is "premium", which is a 3% draw rate with the base gacha pool.
# These two commands do the same thing:
$gacha ten
$gacha ten premium

# "flash" and "legend" increase the draw rate to 6% and adds their respective characters to the gacha pool.
$gacha spark flash
$gacha spark legend

# You can also use shorthand for "flash" and "legend" respectively.
$g yolo ff
$g yolo lf
```

**Seasons** only affect the gacha pool. The available seasons are `valentine`, `summer`, `halloween`, and `holiday`.
```ruby
# You have to specify a gala if you want to also add a season
# This will NOT work:
$gacha ten summer

# But this will work!
$gacha ten premium summer

# Of course, you can also combine seasons with the rate-up galas:
# Fun fact: These combinations never happen in the real game!
$gacha spark flash halloween
$gacha spark legend holiday
```

#### Rate-ups
You can set rate-ups for the gacha rolls that you perform to more accurately simulate Granblue Fantasy's gacha system.

**Rate-ups only affect your rolls.** Other members of your server will need to set their own rate-ups or copy yours.

The rate-up system will only evaluate the units that appear in the gala or season applied when a roll command is used. For example, if you have a rate-up for Sturm (Flash Gala) and Reinhardtzar (Legend Gala), and use `$gacha spark flash`, Reinhardtzar will not appear and his rate will not be calculated when determining final item rates.

Checking your rate-up
```ruby
$gacha rateup check
```

Setting your rate-up
```ruby
$gacha rateup set <item> <rate>, [...]

# Example
$gacha rateup set Pholia (Grand) 0.3
$gacha rateup set Pholia (Grand) 0.3, Cain (Grand) 0.3
```

Clearing your rate-up
```ruby
$gacha rateup clear
$gacha rateup reset
```

Copying another member's rate-up 
Note: You must mention the user you're copying from
```ruby
$gacha rateup copy <@user>

# Example
$gacha rateup copy @jedmund
```

## **Contributing**
Please read and understand the [Code of Conduct](https://github.com/jedmund/siero-bot/blob/master/CONTRIBUTING.md) before contributing to the project.

## **License**
Siero is licensed under GNU General Public License 3.0.

In short, this means that you are free to use, modify, or distribute this code in your own projects, as long as you properly attribute the code and the derivative project is open source. 

You can learn more in the [LICENSE](https://github.com/jedmund/siero-bot/blob/master/LICENSE) file.


Siero

A Granblue Fantasy bot that lets you simulate gacha, save your spark, and more!

Voting for Siero

Do you want to support us?