Donations #

Donations are a way for players to share in-game items, such as currencies, consumables, or collectables. Each user has their own storage object that represents the donations they have, which may be active or expired.

You can customize the donation rules to meet your social and gameplay requirements, such as restricting the number of times a user can send contributions to another user, how many donations can be active at any time, or whether donations can only be made between users who are part of a team, are friends, or have completed some other kind of gameplay together.

Customization parameters #

The following JSON represents the customization parameters you can use to configure donations for the economy system.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22

{
  "donations": {
    "<donationId1>": {
      "cost": {
        "currencies": {
          "coins": 10
        },
        "items": {}
      },
      "count": 1,
      "description": "Description for donation one",
      "duration_sec": 10000,
      "max_count": 10,
      "name": "Donation one",
      "recipient_reward": {},
      "contributor_reward": {},
      "user_contribution_max_count": 2,   
      "additional_properties": {
        "<propertyName>": "value"
      }
    }
}

Each individual donation is keyed by id and may define the following:

Donation #

Donation Cost #