sif-calculator/README.md

ラブライブ！スクールアイドルフェスティバルのjavascriptヘルパー

# SIF Calculator
[![npm version](https://badge.fury.io/js/sif-calculator.svg)](https://badge.fury.io/js/sif-calculator)

ラブライブ！スクールアイドルフェスティバルのjavascriptヘルパー

### インストール
`npm install sif-calculator`

### 使用法

```javascript
const sifCalculator = require('sif-calculator'); // commonJS/webpack/Node.js;
```

```html
<script src="dist/sifCalculator.js"></script> <!-- window.sifCalculator -->
```

#### LPについて
LPはRank 1で25から始まり、2の倍数で1ずつ増加していく。(例:Rank 2=26、Rank 4=27…)   
ただしRank 300を超えるとRankが3上がるごとに1ずつ増加していく。(例:Rank 300=175、Rank 303=176…)   
現在、1000を超えてもそちらの変化はない模様。
```javascript
const lp = sifCalculator.getLpByRank(101);
```

#### 友達の上限について
友達の上限はRank 1で10人から始まり、5の倍数で1ずつ増加していく。(例:Rank 5=11、Rank 10=12…)   
Rank 50以降はRankが10上がるごとに1ずつ増加していく。(例:Rank 50=20、Rank 60=21…)   
上限はRank 840での99人。
```javascript
const lp = sifCalculator.getFriendsByRank(101);
```

#### EXPについて
RankあたりのRank upに必要なEXPは以下の式で求めることができる。
> Rank upに必要なEXP = 34.45 × 求めたいRank - 551

ただし、Rank 33までは必要EXPの増加量が一定ではないため、上記の式で求めることはできない。   
また、Rank 34以降でも経験値の増加量には若干のブレがあり、上記の式を用いても±2程度の誤差が生じる。  
2014年7月31日のアップデートにより、Rank 100未満のRank upに必要なEXPが半分になった。   
この措置は現在のRankから適用されるものであるため、既にRank 100以上の人には適用されない。 
```javascript
const exp = sifCalculator.getExpByRank(101);
``` 

### テストを実行する
```bash
npm install
npm test
```

### ライセンス
[MIT license](http://opensource.org/licenses/mit-license.php)