> For the complete documentation index, see [llms.txt](/llms.txt)

# GS2-Idle API Reference

Idle reward feature




This service provides idle rewards.
It implements a mechanism to earn rewards based on the time spent not playing the game.

Multiple idle rewards can be provided.
Players can have one waiting time per category.

Categories can be used as independent idle-reward units, such as "automatic recovery of a character's stamina", "automatic mining at a mining site", or "automatic generation of materials".

For each category, you can set how many minutes of idle time grants a reward and the initial value of the maximum idle time.
The maximum idle time can be raised per player. Whether to reset unused idle time after receiving rewards or carry it over to the next time can be selected via `rewardResetMode`.

Define the list of items obtainable after a set idle time has elapsed for idle rewards.
Multiple rewards (up to 10) can be set up, such as "experience + items".

Sometimes you want more randomness in the reward contents.
In such cases, set up GS2-Lottery's lottery process for the rewards.

Each category can be associated with a GS2-Schedule event so that idle rewards linked to the event can be implemented.

By using GS2-Buff, you can correct the category model's `acquireActions` or the per-player `maximumIdleMinutes` with buffs, dynamically adjusting the contents of idle rewards and the maximum idle time according to events and campaigns.

For example, operations such as "idle rewards are 1.5x on weekends" or "players holding a specific title get +60 minutes of maximum idle time" are possible.

[Introduction to Microservices / GS2-Idle](../../microservices/idle)



- [GS2-Idle Buff Reference](/api_reference/idle/buff/)
  
- [GS2-Idle Deploy/CDK Reference](/api_reference/idle/deploy/)
  
- [GS2-Idle Master Data Reference](/api_reference/idle/master_data/)
  
- [GS2-Idle Script Trigger Reference](/api_reference/idle/script/)
  
- [GS2-Idle SDK API Reference](/api_reference/idle/sdk/)
  
- [GS2-Idle SDK for Game Engine API Reference](/api_reference/idle/game_engine/)
  
- [GS2-Idle Transaction Actions](/api_reference/idle/stamp_sheet/)