Nakama and Amazon GameLift Native Integration Goes Live 🎉 Read Our Announcement

Login to Heroic Cloud

Configurations #

Hiro provides a number of configuration parameters that you can use to customize the default user experience for its systems.

Achievements #


Property	Subproperty	Description
`auto_claim`		Whether the achievement reward should be given automatically upon completion.
`auto_claim_total`		Whether the achievement total reward should be given automatically upon completing this and all sub-achievements.
`auto_reset`		Whether the achievement should reset after completion.
`name`		The display friendly name of this achievement.
`category`		The category name for this achievement.
`description`		The description for this achievement.
`count`		The initial count towards progress for this achievement.
`max_count`		The number of times this achievement can be progressed before it can be claimed.
`duration_sec`		How long (in seconds) this achievement is available for progression after creation. Used for limited time achievements.
`reset_cronexpr`		The reset interval in CRON format.
`precondition_ids`		An array of achievement ids the user must have completed to qualify for starting this achievement.
`reward`		An object that defines what rewards a player should receive once they complete this achievement.
`sub_achievements`		An object with the same Schema as the root `achievements` object, used to define nested achievements.
`total_reward`		An object that defines what rewards a player should receive once they have completed this achievement and all sub achievements.
`additional_properties`		A `string:string` dictionary of key value pairs that can contain additional context.

Economy #

User initialization #


Property	Description
`currencies`	A `string:int` dictionary of currencies and quantities the user should start with.
`items`	A `string:int` dictionary of items and quantities the user should start with.

Inventory Items #


Property	Description
`name`	The name for this item.
`description`	The description for this item.
`category`	The category for this item.
`item_sets`	An array of `string` values that indicate which item sets this item belongs to.
`max_count`	The maximum number of this item a user can own.
`stackable`	A `bool` value indicating whether this item can stack.
`consumable`	A `bool` value indicating whether this item can be consumed.
`consume_reward`	A reward object that defines what rewards a user can or will receive for consuming the item.
`string_properties`	A map of `string` values that define item specific metadata.
`numeric_properties`	A map of `number` values that define item specific metadata.

Donations #


Property	Subproperty	Description
`name`		The name for this donation.
`description`		The description for this donation.
`count`		The initial count to start this donation with.
`max_count`		The maximum amount of donations required for this to be completed.
`user_contribution_max_count`		The maximum amount of times each user can donate towards this donation.
`duration_sec`		How long (in seconds) this donation is active.
`reward`		An object that defines what rewards a player should receive once the donation is fulfilled.
`contributor_reward`		An object that defines what rewards the sender should receive once the donation is fulfilled.
`additional_properties`		A `string:string` dictionary of key value pairs that can contain additional context.

Placements #


Property	Subproperty	Description
`reward`		An object that defines what rewards a player should receive once they purchase this item.
`additional_properties`		A `string:string` dictionary of key value pairs that can contain additional context.

Store items #


Property	Subproperty	Description
`name`		The name for this store item.
`description`		The description for this store item.
`category`		The category for this store item.
`cost`		The cost for this store item, either in soft currency using the `currencies` subproperty or via IAP using the `sku` subproperty.
	`currencies`	A `string:int` dictionary of currencies and quantities the user must pay to purchase this item.
	`sku`	The SKU code of the in-app purchase the user must complete to obtain this item.
`reward`		An object that defines what rewards a player should receive once they purchase this item.
`additional_properties`		A `string:string` dictionary of key value pairs that can contain additional context.

Energy #


Property	Subproperty	Description
`start_count`		The initial amount of this energy a user should start with.
`max_count`		The maximum amount of this energy a user can possess at any time.
`refill_count`		The amount of this energy refilled after each interval (defined in `refill_time_sec`).
`refill_time_sec`		The time in seconds it takes for this energy to refill by `refill_count` amount.
`implicit`		If `true` the user starts with this energy, if `false` they must be granted this energy.
`reward`		An object that defines what rewards a player should receive when spending this energy.
`additional_properties`		A `string:string` dictionary of key value pairs that can contain additional context.

Leaderboards #


Property	Subproperty	Description
`id`		The id of this leaderboard.
`sort_order`		The leaderboard sort type (e.g. `asc` or `desc`).
`operator`		The leaderboard operation (e.g. `set`, `best`, `incr`, or `decr`).
`reset_schedule`		The reset schedule of this leaderboard expressed as a CRON expression.
`authoritative`		Whether scores must be submit to this leaderboard authoritatively.
`regions`		An array of strings representing available regions for the leaderboard.

Teams #


Property	Subproperty	Description
`max_team_size`		The maximum number of members for a team.

Unlockables #

Slots #


Property	Subproperty	Description
`max_active_slots`		The maximum number of slots a player can have active at any time.
`active_slots`		The number of active slots, if any, each player starts with.
`slots`		The total number of slots, active and inactive, a player can have.
`slot_cost`		The cost to purchase additional active slots.
	`currencies`	A `string:int` dictionary of the currencies and amounts required to purchase additional slots.

Unlockable #


Property	Subproperty	Description
`probability`		An `int` value indicating the likelihood this unlockable item is the one received by the player.
`name`		The name of this unlockable.
`category`		The category, if any, of this unlockable.
`description`		The description of this unlockable.
`start_cost`		The cost to begin unlocking this unlockable.
	`currencies`	A `string:int` dictionary of the currencies and amounts required as the start cost.
`wait_time_sec`		The total time (in seconds) a player must wait before this item in unlocked.
`cost`		The cost to advance the wait time by one unit of time, defined in `cost_unit_time_sec`.
	`currencies`	A `string:int` dictionary of the currencies and amounts required.
`cost_unit_time_sec`		The amount of time to be advanced on `wait_time_sec` for each `cost` purchase.
`reward`		An object that defines what rewards the player should receive after unlocking this unlockable.
`additional_properties`		A `string:string` dictionary of key value pairs that can contain additional context.

Table of Contents