Virtual Goods & Currencies
Virtual Goods
The “Virtual Goods” section of SLOT can be accessed via the main menu and contains the following menus:
- Items
- Bundles
- Item groups
- Gacha
- Shop management
- Promotions
Items
The items screen is used to create and manage any items in the game that are handled via the SpilSDK/SLOT inventory feature. These items can be used with other features such as the in-game shop and as rewards for the daily bonus screen, push notifications, splash screens, deep links etc. Items can be created via the “Create item” button on the top-left corner of the screen.
Items have the following properties:
- Item Id: Unique, automatically generated, used to identify the item.
- Bundle Id: Unique, automatically generated, used to identify a bundle. Items do not have a “price” and cannot be sold in the in-game shop, only bundles can be sold. Bundles are collections of one or more items with added price information. Each item is automatically assigned to a new bundle when created.
- Name: A unique name for the item. Only used internally for SLOT users, not meant to be displayed in-game.
- Item group: User-defined name for a group of items, multiple items can be assigned to the same group. Only used internally for SLOT users, not meant to be displayed in-game.
- Price: A numerical value, together with the “Currency” property this determines the price of this item’s bundle in the in-game shop.
- Currency: One of the currencies defined via the Virtual Currencies menu, together with the “Price” property this determines the price of this item’s bundle in the in-game shop.
- Type: “Consumable”, “Booster” or “Permanent”. Only used for reporting, doesn’t have any practical use. A consumable item is destroyed when used, a permanent item is always active and cannot be used, a booster can be used and may be destroyed but is effective only for a limited time.
- Initial: The amount of this item that new players receive when starting the game.
- Display name: Accessed via the localisation button. A list of localised names for the item that can be displayed in-game.
- Display description: Accessed via the localisation button. A list of localised descriptions for the item that can be displayed in-game.
- Image: Accessed via the localisation button. A list of localised images for the item that can be displayed in-game.
- Active: Indicates whether an item is active or inactive. Items cannot be deleted, only disabled. When an item is disabled the data for the item is not sent to the client.
- Properties: A user-defined json blob with additional properties for an item (Currently under construction, to be added soon).
Item are listed in the items menu, on the right side of the items menu you’ll find the following buttons:
Edit: Used to edit Name, Item Group, Price, Currency, Type and Initial properties.
Localisation: Use to edit Display name, Display description and Image for each language/region.
Activate/Deactivate: Used to enable/disable an item. Items cannot be deleted, only disabled. When an item is disabled the data for the item is not sent to the client. This should not cause problems for the SpilSDK, even if players have the item in their inventory. If the game request or edits a disabled item by id then the SDK will indicate that the item does not exist.
Segmentation
The items feature supports segmentation so that unique item configurations can be sent to specific user groups. For more information see the segmentation section of the SLOT documentation.
Bundles
Items do not have a “price” and cannot be sold in the in-game shop, only bundles can be sold. Bundles are collections of one or more items, currencies and/or gacha boxes with added price information (for gacha boxes see the “Gacha” section of this article). Bundles can be created via the “Create bundle” button on the top-left corner of the screen.
Note: Only manually created bundles appear in the bundles list. Bundles that are automatically created for each item/gacha do not appear in this list, prices for these bundles should be managed via the Items or Gacha menu.
Bundles have the following properties:
- Id: Unique, automatically generated, used to identify the bundle.
- Name: A unique name for the bundle. Only used internally for SLOT users, not meant to be displayed in-game.
- Item group: Not used, will be removed.
- Price: A numerical value, together with the “Currency” property this determines the price of the bundle in the in-game shop.
- Currency: One of the currencies defined via the Virtual Currencies menu, together with the “Price” property this determines the price of the bundle in the in-game shop.
- Display name: Accessed via the localisation button. A list of localised names for the bundle that can be displayed in-game.
- Display description: Accessed via the localisation button. A list of localised descriptions for the bundle that can be displayed in-game.
- Image: Accessed via the localisation button. A list of localised images for the bundle that can be displayed in-game.
- Active: Indicates whether a bundle is active or inactive. Bundles cannot be deleted, only disabled. When a bundle is disabled the data for the bundle is not sent to the client.
Entities per bundle (bundle contents)
The items per bundle menu appears on the right side of the bundles list when a bundle is clicked. Items/currencies/gacha’s can be added to a bundle via the “Create bundle item” button on the top-left corner of the menu.
- Type / Entity type: Can be “item”, “currency” or “gacha”.
- Name / Entity: Name of the item/currency/gacha box. Only used internally for SLOT users, not meant to be displayed in-game.
- Amount: The amount of items/currency/gacha’s.
On the right side of the bundles list and the entities per bundle list you’ll find the following buttons:
Edit: Used to edit Name, Price, and Currency properties for a bundle or Type, Name and Amount properties for an item/currency/gacha in a bundle.
Localisation: Use to edit Display name, Display description and Image for a bundle for each language/region.
Activate/Deactivate: Used to enable/disable a bundle. Bundles cannot be deleted, only disabled. When a bundle is disabled the data for the bundle is not sent to the client. This should not cause problems for the SpilSDK. If the game request or edits a disabled bundle by id then the SDK will indicate that the bundle does not exist.
Remove: Removes an item/currency/gacha from the bundle.
Segmentation
The bundles feature supports segmentation so that unique bundle configurations can be sent to specific user groups. For more information see the segmentation section of the SLOT documentation.
Item groups
Item groups allow SLOT users to group multiple items by a common name. Item groups are only used internally for SLOT users and are not meant to be displayed in-game. Item groups can be created via the “Create item group” button on the top-left corner of the screen.
Item groups have the following properties:
- Id: Unique, automatically generated, used to identify the item group.
- Name: A unique name for the item. Only used internally for SLOT users, not meant to be displayed in-game.
Item groups can be assigned to items via the items menu.
Gacha
Gacha boxes or Gacha’s are collections of one or more items and/or currencies that each have a “weight”. When opening a Gacha box the user receives one of the items/currencies at random, where Items/currencies with a higher weight have a greater chance of being awarded. Gacha boxes can be created via the “Create gacha” button on the top-left corner of the screen.
Gacha’s have the following properties:
- Item Id: Unique, automatically generated, used to identify the gacha.
- Bundle Id: Unique, automatically generated, used to identify a bundle. Gacha’s do not have a “price” and cannot be sold in the in-game shop, only bundles can be sold. Bundles are collections of one or more items/gacha’s with added price information. Each gacha is automatically assigned to a new bundle when created.
- Name: A unique name for the gacha. Only used internally for SLOT users, not meant to be displayed in-game.
- Price: A numerical value, together with the “Currency” property this determines the price of this gacha’s bundle in the in-game shop.
- Currency: One of the currencies defined via the Virtual Currencies menu, together with the “Price” property this determines the price of this gacha’s bundle in the in-game shop.
- Initial: The amount of this gacha that new players receive when starting the game.
- Display name: Accessed via the localisation button. A list of localised names for the gacha that can be displayed in-game.
- Display description: Accessed via the localisation button. A list of localised descriptions for the gacha that can be displayed in-game.
- Image: Accessed via the localisation button. A list of localised images for the gacha that can be displayed in-game.
- Active: Indicates whether a gacha is active or inactive. Gacha’s cannot be deleted, only disabled. When a gacha is disabled the data for the gacha is not sent to the client.
Entities per gacha (gacha contents)
The items per gacha menu appears on the right side of the gacha’s list when a gacha is clicked. Items/currencies can be added to a gacha via the “Create gacha item” button on the top-left corner of the menu.
Entities per gacha have the following properties:
- Position: The position of the item in the Gacha, can be used when displaying the contents of the gacha in-game.
- Type / Entity type: Can be “item” or “currency”.
- Name / Entity: Name of the item/currency. Only used internally for SLOT users, not meant to be displayed in-game.
- Amount: The amount of items/currency.
- Weight: A numerical value indicating the relative weight of each item. All weights are added together and a random number is chosen to determine the item to be awarded. For instance, 3 items with weight 1 would each have a 33% chance of being awarded. A random number between 1 and 3 (inclusive) is chosen, if the result is 1 then the first item is chosen, if it is 2 the second item is chosen, if it is 3 the third item is chosen.
On the right side of the gacha’s list and the entities per gacha list you’ll find the following buttons:
Edit: Used to edit Name, Price, and Currency properties for a bundle or Type, Name and Amount properties for an item/currency/gacha in a bundle.
Localisation: Use to edit Display name, Display description and Image for a bundle for each language/region.
Activate/Deactivate: Used to enable/disable a bundle. Gacha’s cannot be deleted, only disabled. When a gacha is disabled the data for the gacha is not sent to the client. This should not cause problems for the SpilSDK. If the game request or edits a disabled gacha by id then the SDK will indicate that the gacha does not exist.
Remove: Removes an item/currency from the gacha box. Note: Deleting gacha boxes should not be possible, they can only be deactivated. This button will be removed from the gacha’s list in the future.
Segmentation
The gacha feature supports segmentation so that unique gacha configurations can be sent to specific user groups. For more information see the segmentation section of the SLOT documentation.
Shop management
To be added.
Promotions
To be added.
Virtual Currencies
The “Virtual Currencies” section of SLOT can be accessed via the main menu and contains the following menus:
- Currencies
Currencies
The currencies screen is used to create and manage any currencies in the game that are handled via the SpilSDK/SLOT wallet feature. These currencies can be used with other features such as the in-game shop and as rewards for the daily bonus screen, push notifications, splash screens, deep links etc. Currencies can be created via the “Create currency” button on the top-left corner of the screen.
Currencies have the following properties:
- Id: Unique, automatically generated, used to identify the currency.
- Name: A unique name for the currency. Only used internally for SLOT users, not meant to be displayed in-game.
- Initial: The amount of this currency that new players receive when starting the game.
- Type: “Premium” or “Non-Premium”. Premium currencies can be bought for real money (IAPs), non-premium currencies are earned in-game,
- Display name: Accessed via the localisation button. A list of localised names for the currency that can be displayed in-game.
- Display description: Accessed via the localisation button. A list of localised descriptions for the currency that can be displayed in-game.
- Image: Accessed via the localisation button. A list of localised images for the currency that can be displayed in-game.
- Active: Indicates whether a currency is active or inactive. Currencies cannot be deleted, only disabled. When a currency is disabled the data for the currency is not sent to the client.
Currencies are listed in the currencies menu, on the right side of the currencies menu you’ll find the following buttons:
Edit: Used to edit Name, Type and Initial properties.
Localisation: Use to edit Display name, Display description and Image for each language/region.
Activate/Deactivate: Used to enable/disable a currency. Currencies cannot be deleted, only disabled. When a currency is disabled the data for the currency is not sent to the client. This should not cause problems for the SpilSDK, even if players have the currencies in their wallet. If the game request or edits a disabled currency by id then the SDK will indicate that the currency does not exist.
Segmentation
The currencies feature supports segmentation so that unique currency configurations can be sent to specific user groups. For more information see the segmentation section of the SLOT documentation.