# IdleKit Data Change Log

## Version L.4.0, xxxx-xx-xx
* `GLOBAL` - Added `AvatarCollectionData` sheet
* `MAIN GAME` - Added `AvatarsUnlockRewardData` sheet

## Version L.3.0, 2021-07-26
* `GLOBAL` - Added `leaderboards` sheet
* `MAIN GAME` - Added `items.PromoData` sheet
* `MAIN GAME` - Added a variety of sheets for representing `TriggerData` objects which trigger promos
* `MAIN GAME` - Added `StoreProductData` sheet for storing all products (`IPurchasable`) that can be sold in a content
* `GLOBAL`,`MAIN GAME` Added sheets for `items.AvatarCollectionData` and `AvatarsUnlockRewardData`

## Version L.0.0, 2020-11-18
---

This update brings support for new **StoreEntity**s, including **StoreReward**s and **StoreUpgradeableCurrencyCollection**s. Data shared by Events and the Main Game have been moved to the Global balance, such as Tags and Currencies. The Front Loaded Mini Event, Fast Break Event, and Stair Master Event have been removed temporarily, but will be available in a future release.

### ALL CONTENTS

#### **Content**

* Updated Header to support StoreTimedReward changes
    * `timerTrunkId` → `storeTimedRewardId`

#### **Currency**

* Removed `shrd_currency_hard` from Main Game and Event balances, and added to Global balance.
* Updated all default `customExchangeValue`s
  * `0` → `-1`
* Added new `customRampingIncrement` for all currencies
  * `-1`
  
#### **ModifierFormula**

All ModifierFormula data has been moved from Main Game and Event balances to the Global balance.

#### **ModifierGroup**

All ModifierGroup data has been moved from Main Game and Event balances to the Global balance.

#### **Stage**

* Added Header to support StoreUpgradeableCurrencyCollection feature
    * `storeUpgradeableCurrencyCollectionId`

#### **StoreReward**
    
* **NEW**

#### **Tag**

All Tags and Rarity data has been moved from Main Game and Event balances to the Global balance.

* Added Rarity Header to support StoreUpgradeableCurrencyCollection ramping increments
    * `defaultRampingIncrement`

#### **StoreTimedReward - TimedReward & TimerTrunk Refactor**

TimedReward has been removed and TimerTrunk have been replaced by the StoreTimedReward.

#### **StoreUpgradeableCurrencyCollection**
    
* **NEW**

#### **TimeSkipReward**
    
* **NEW**

#### **UpgradeableCurrency**

* Added Header to support StoreUpgradeableCurrencyCollection ramping increments
    * `customRampingIncrement`

### MAIN GAME

#### **Content**

* Updated StoreTimedReward name
  * `mg_showcase_timertrunk` → `mg_store_timed-reward`

#### **CurrencyReward**

* Added new CurrencyReward
    * `mg_reward_currency_soft_store-sml`
    * `mg_reward_currency_soft_store-med`
    * `mg_reward_currency_soft_store-lrg`

#### **Goal**

* Renamed goal to reflect StoreTimedReward changes
    * `mg_goal_collect_rewardtype_gachatimertrunk` →  `mg_goal_collect_reward_gachastoretimedreward`

#### **Stage**

* Added new `storeUpgradeableCurrencyCollectionIds/0` for each Stage.

#### **StoreReward**

* Added new StoreReward
    * `mg_store_reward_sc-sml`
    * `mg_store_reward_sc-med`
    * `mg_store_reward_sc-lrg`
    * `mg_store_reward_timeskip_1hr`
    * `mg_store_reward_timeskip_4hr`
    * `mg_store_reward_timeskip_24hr`

#### **StoreTimedReward**

* Renamed StoreTimedReward to reflect TimerTrunk refactor
    * `mg_showcase_timertrunk` → `mg_store_timed-reward`

#### **StoreUpgradeableCurrencyCollection**

* Added new StoreUpgradeableCurrencyCollection
    * `mg_store_collection_stage001` through `mg_store_collection_stage025`

#### **TimeSkipReward**

* Added new TimeSkipReward
    * `mg_reward_timeskip_1hr`
    * `mg_reward_timeskip_4hr`
    * `mg_reward_timeskip_24hr`

### CHOSEN ONE ( Event )

#### **Stage**

* Added new `storeUpgradeableCurrencyCollectionIds/0` for the Stage.

#### **StoreReward**

* Added new StoreReward
    * `ev-CO_store_reward_sc-sml`
    * `ev-CO_store_reward_sc-med`
    * `ev-CO_store_reward_sc-lrg`
    * `ev-CO_store_reward_timeskip_1hr`
    * `ev-CO_store_reward_timeskip_4hr`
    * `ev-CO_store_reward_timeskip_24hr`

#### **StoreTimedReward**

* Renamed StoreTimedReward to reflect TimerTrunk refactor
    * `ev-CO_showcase_timer_trunk` → `ev-CO_store_timed-reward`

#### **StoreUpgradeableCurrencyCollection**

* Added new StoreUpgradeableCurrencyCollection
    * `ev-CO_store_collection_stage001`

#### **TimeSkipReward**

* Added new TimeSkipReward
    * `ev-CO_reward_timeskip_1hr`
    * `ev-CO_reward_timeskip_4hr`
    * `ev-CO_reward_timeskip_24hr`

### GLOBAL

#### **Currency**

* Added `shrd_currency_hard`

#### **EventSettings**

* Removed EventSettings for temporarily unsupported Events
    * `ev-FB_settings_0001`
    * `ev-SM_settings_0001`
    * `mi-FL_settings_0001`

## **- - - ! REMOVED CONTENT ! - - -**

### FRONT LOADED ( Mini Event )

* **Mini Event Balance Removed**

### FAST BREAK ( Event )

* **Event Balance Removed**

### STAIR MASTER ( Event )

* **Event Balance Removed**

---
## Version 1.4.0, 2020-10-16
---

In addition to providing new Event and Mini Event balances, this update extends Generators and Collectors to allow Rewards to be set as Payout Entities. Previously, `PayoutCurrencyId` could only be defined as either a Currency or UpgradeableCurrency; This update extends this functionality to allow for both explicit and random rewards, as well as Gachas, to be paid out by Generators and Collectors.


### ALL CONTENTS

#### **GeneratorBalance**

* Updated Headers to support Payout changes
  * `basePayout` → `basePayoutAmount`
  * `payoutCurrencyId` → `payoutEntityId`

#### **CollectorBalance**

* Updated Headers to support Payout changes
  * `basePayout` → `basePayoutAmount`
  * `payoutCurrencyId` → `payoutEntityId`


## **- - - ! NEW CONTENT ! - - -**

### CHOSEN ONE ( Event )

* **NEW Event Balance added**

### FRONT LOADED ( Mini Event )

* **NEW Mini Event Balance added**

## Version 1.3.0, 2020-09-02
---

This update brings support for the new **Collector**s feature. This feature is demonstrated in the Main Game Content, with additional Event Balances, utilizing this feature, becoming available in a future release.

#### **Collector**

* **NEW**

#### **CollectorBalance**

* **NEW**

#### **CollectorEntity**

* **NEW**

#### **Content**

* **NEW** **Collector**-specific array has been added to **Content**

  * `collectorEntityIds/`


### MAIN GAME

#### **GeneratorBalance x GeneratorEntity Refactor**

GeneratorBalance and GeneratorEntity have been refactored to support Collectors implementation. The following properties have been moved from **GeneratorEntity** into **GeneratorBalance**:

* `costToBuy`
* `buyCurrencyId`
* `upgradeableCurrencyBuyRequirements/0/upgradeableCurrencyId`
* `upgradeableCurrencyBuyRequirements/0/upgradeableCurrencyLevel`
* `costToAutomate`
* `automateCurrencyId`
* `upgradeableCurrencyAutomationRequirements/0/upgradeableCurrencyId`
* `upgradeableCurrencyAutomationRequirements/0/upgradeableCurrencyLevel`

#### **ModifierGroup**

* Added new *Collector*-specific Groups
  * `shrd_group_collector_payout_product`
  * `shrd_group_collector_speed_product`

#### **ModifierFormula**

* Added new *Collector*-specific Formulas
  * `shrd_formula_collector_payout`
  * `shrd_formula_collector_speed`

#### **Tag**

* Added new *Collector*-specific Rarity and Tag
  * `shrd_rarity_legendary`
  * `shrd_tag_collector`

#### **Collector**

* Added new Collector for Showcase Collector
  * `mg_collector01`

#### **CollectorBalance**

* Added new CollectorBalance for Showcase Collector
  * `mg_collectorbal_01`

#### **CollectorEntity**

* Added new CollectorEntity for Showcase Collector
  * `mg_collectorentity_01`

#### **UpgradeableCurrency**

* Added new UpgradeableCurrency for Showcase Collector
  * `mg_upgradeable_col01`

#### **Stage**

* Added **`availableCurrencyIds/1`** for `mg_stage007`
  * `null` → `mg_upgradeable_col01`

#### **Content**

* Added **`collectorEntityIds/0`** for `mg_content`
  * `null` → `mg_collectorentity_01`

#### **GeneratorBalance**

* ***Bug Fix:*** Added **`modifierDatas/0/amounts/21`** for `mg_bizbal_gen1304`
  * `null` → `32768000000000`

## **- - - ! NEW CONTENT ! - - -**

### STAIR MASTER ( Event )

* **NEW Event Balance added**

---
## Version 1.2.0, 2020-07-02
---

This update brings support for 2 new features: **Track**s and **TimedTrack**s. These features are not currently represented in the IdleKit Showcase, but Headers and Data Structure can be viewed in the CSVs for this release. Functionality can be viewed and tested in the Track example, provided in the idlekit-examples repo.

#### Track

* Includes 3 **Track** types:
  * `GoalTrack`
  * `PassiveGoalTrack`
  * `MilestoneTrack`

#### TimedTrack

* Includes 2 **TimedTrack** types:
  * `TimedGoalTrack`
  * `TimedMilestoneTrack`



---
## Patch 1.1.1, 2020-05-29
---
### MAIN GAME

#### ModifierFormula
* **ModifierFormula** for `shrd_formula_generator_payout` was missing `shrd_group_boost_payout_product`
  * `base * shrd_group_generator_payout_product * shrd_group_currency_payout_productt` → `base * shrd_group_generator_payout_product * shrd_group_currency_payout_product * shrd_group_boost_payout_product`

### FAST BREAK ( Event )

#### TimedReward
* `durationInSeconds` for `ev-FB_showcase_timer_trunk` was reduced from 4 hours to 2 hours
  * `14400` → `7200`

---
## Version 1.1.0, 2020-05-25
---
### MAIN GAME

#### Content
* Extended **`initialCurrencyAmounts/`** for **StandardContent** and **StandardEventContent**
  * `initialCurrencyAmounts/9/currencyId`
  * `initialCurrencyAmounts/9/currencyAmount`
* Extended **`tradeDataIds/`** for **StandardContent** and **StandardEventContent**
  * `tradeDataIds/5`

#### Stage
* Extended **`goalDataSequences/`**
  * `goalDataSequences/1/goalIds/28` - `goalDataSequences/1/goalIds/34`
  * `goalDataSequences/2/goalIds/26` - `goalDataSequences/2/goalIds/28`

#### Tag
* Updated all **Rarity** ids and dataNames
  * `shrd_raritynull` → `shrd_rarity_null`
  * `shrd_common` → `shrd_rarity_common`
  * `shrd_uncommon` → `shrd_rarity_uncommon`
  * `shrd_rare` → `shrd_rarity_rare`
  * `shrd_epic` → `shrd_rarity_epic` 
    * **NOTE:** *References updated in **Trade**, **Currency**, and **UpgradeableCurrency***

#### UpgradeableCurrency
* Removed unused **UpgradeableCurrencies**
  * `mg_upgradeable_global05`
  * `mg_upgradeable_global06`
  * `mg_upgradeable_gen01_worker03`
  * `mg_upgradeable_gen02_worker03`
    * **NOTE:** *References removed from **Stage** and **CurrencyReward***

#### CurrencyReward
* Removed `mg_reward_fallback_game_50`
* Added `mg_reward_milestone_placeholder`

#### GachaReward
* Updated **`mg_gacha_timertrunk`** id and dataName
  * `mg_gacha_timertrunk` → `mg_gacha_store_timed`
    * **NOTE:** *Reference updated in **TimedReward***

#### GeneratorBalance
* Extended **`modifierDatas/`**
  * `modifierDatas/0/amounts/82` - `modifierDatas/0/amounts/108` 

#### GeneratorUnitTargetSequence
* Extended **`generatorUnitTargetIds/`**
  * `generatorUnitTargetIds/83` - `generatorUnitTargetIds/106`  

### GLOBAL

#### Content
* Extended **`initialCurrencyAmounts/`** for **StandardContent** and **StandardEventContent**
  * `initialCurrencyAmounts/9/currencyId`
  * `initialCurrencyAmounts/9/currencyAmount`
* Extended **`tradeDataIds/`** for **StandardContent** and **StandardEventContent**
  * `tradeDataIds/5`

#### Stage
* Extended **`goalDataSequences/`**
  * `goalDataSequences/1/goalIds/28` - `goalDataSequences/1/goalIds/34`
  * `goalDataSequences/2/goalIds/26` - `goalDataSequences/2/goalIds/28`

#### GeneratorBalance
* Extended **`modifierDatas/`**
  * `modifierDatas/0/amounts/82` - `modifierDatas/0/amounts/108` 

#### GeneratorUnitTargetSequence
* Extended **`generatorUnitTargetIds/`**
  * `generatorUnitTargetIds/83` - `generatorUnitTargetIds/106`  

#### EventSettings
* Removed **EventSettings** placeholder data
  * `ev_settings_0001`
  * `ev_settings_0002`
* Added new **EventSettings** for NEW EVENT BALANCE
  * `ev-FB_settings_0001`

## **- - - ! NEW CONTENT ! - - -**

### FAST BREAK ( Event )

* **NEW Event Balance added**
---