Skip to content

Latest commit

 

History

History
301 lines (206 loc) · 17.7 KB

CHANGELOG.md

File metadata and controls

301 lines (206 loc) · 17.7 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

[2.0.0] - 2024-02-01

Changed

  • The use cases are now compatible with the Deployment package an can now deploy most of their service configuration thanks to the Deployment window.
  • Reverted project to be on 2021.3 by default so that we enable an easier compatibility with all current LTS version.
  • For the sake of simplicity, ccd addressable features and the Over the Air Content use case have been removed. Addressables and CCD are demonstrated in a number of other samples already.
  • For the sake of simplicity, ads features and the Ads use case have been removed. Ads are demonstrated in a number of other samples already.

Fixed

  • Battle Pass README had the incorrect key name for its virtual purchase. The correct key name is BATTLE_PASS_PURCHASE.
  • Battle Pass README didn't list the entire Game Override content for the BATTLE_PASS_REWARDS_FREE and BATTLE_PASS_REWARDS_PREMIUM keys. That has been added in separate Game Overrides documentation files.
  • Seasonal Events README had the wrong name for its Cloud Code scripts. Both should start with the prefix SeasonalEvents_.
  • Removed legacy fields that prevented remote config to be parsed.
  • WebGL compatibility issues with Cloud Code and the Virtual Shop

[1.10.0] - 2023-10-12

Changed

  • Upgraded the project from Unity Editor version 2020.3.46f1 to 2022.3.11f1.
  • Updated readme files to fit better default Economy configurations.
  • Updated readme files to fit better default Remote-Config configurations.

Fixed

  • Removed outdated configurations causing issues with the BattlePass sample.

[1.9.1] - 2023-03-29

Changed

  • Add popups to explain cause when client is forced back to the main menu in Serverless Multiplayer Game due to host leaving or kicking player out of lobby.
  • Turned off Interpolate in the Serverless Multiplayer Game to improve responsiveness in the game scene and reduce the 'host advantage' in gameplay. The flag is located in the player avatar prefabs' ClientNetworkTransform component.

[1.9.0] - 2023-03-15

Added

  • Serverless Multiplayer Game use case sample which demonstrates how to utilize game lobbies and compete in a simple real-time arena-style game where players collect coins for points.

Changed

  • Upgraded the project from Unity Editor version 2020.3.20f1 to 2020.3.41f1.
    • Updated various non-UGS packages to their latest versions that are verified for Unity Editor 2020.3.41f1.
  • Removed RemoteConfigService.instance.SetCustomUserId() call from ClientVersionCheck.cs as calling that method is only necessary in very specific circumstances, and ClientVersionCheck is not one of those circumstances. You can see an example of a circumstance where it is necessary in ABTestLevelDifficulty/RemoteConfigManager.cs.
  • Minor refactors to files to support newly applied linting rules.
  • Updated Unity Services packages to latest released as of 2023-03-13.

[1.8.1] - 2023-01-20

Fixed

  • The BattlePass_ClaimTier.js, BattlePass_GainSeasonXP.js, and BattlePass_PurchaseBattlePass.js Cloud Code sample scripts were outdated and have now been updated to work with the latest backend data model described in the Battle Pass README.md file.
  • The Battle Pass README.md file now includes the required "service" fields in the examples for defining rewards in the Game Overrides section.

[1.8.0] - 2022-11-09

Added

  • Added a Project Inbox feature to the Start Here scene that allows the UGS Use Cases Development team to send messages with updates about the project to our users.

Changed

  • Reformated namespaces to align with service namespaces and eliminate nested namespaces.
  • Added parameter types to all docs for Cloud Code scripts and improved overall table alignment in plain text editors.
  • Updated Unity Gaming Services packages and related packages to the latest stable packages released as of 2022-11-07.
    • Addressables updated from 1.20.5 to 1.21.1
    • Authentication updated from 2.0.0 to 2.3.1
    • Cloud Code updated from 2.0.1 to 2.1.2
    • Economy updated from 2.0.4 to 3.0.0
      • Replaced usages of deprecated property CustomData with newer property CustomDataDeserializable.
    • Mediation updated from 1.0.4 to 1.0.5
    • Remote Config updated from 3.1.3 to 3.2.2

Fixed

  • Fixed an issue in the Battle Pass where if an Economy error (such as a rate limit error) was generated while trying to claim a tier, the Cloud Code script was not properly throwing the error, and the tier was marked as claimed even though the reward was not given.

[1.7.0] - 2022-10-12

Changed

  • The Idle Clicker Mini-Game has been extensively reworked to now permit merging and unlocking of wells. These features demonstrate upgrading units and a generic unlock manager which monitors in-game achievements to unlock new gameplay options as the game progresses.
  • Client Minimum version has been updated to 1.7.0 due to many breaking changes caused by renaming configuration entries in the backend, as well as revamp of the Idle Clicker use case.
  • Also note that if you have an existing player account, you should use the A/B Testing use case to sign out and in as a new player, due to Cloud Save keys being renamed.
  • Updated Unity Gaming Services packages to the latest stable group of packages released as of 2022-10-11.
    • Mediation updated from 0.5.1-preview.1 to 1.0.4
  • Updated other supporting packages to their latest verified versions (Test Framework, 2D packages, IDE packages).
  • Cloud Save keys have been updated in the Battle Pass, Command Batching, Loot Boxes with Cooldown, and Seasonal Events use cases to align with the naming conventions of the other use cases.
  • Updated UGS scripts, variables, virtual purchases, remote config items, etc. to include an appropriate prefix describing the Use Case which requires it. This change does not effect items used by multiple Use Cases nor does it effect Currencies.
  • Updated SeasonalEvents_GrantEventReward script to use a better practice when getting Cloud Save values to ensure the correct keys are saved to the correct variables.
  • Added some additional helpful information to the Over-The-Air use case's README documents.
  • Fixed minor title centering issue in popup messages.

Removed

  • Removed unused CloudCodeExceptionParsedMessage struct that was in most CloudCodeManagers.

Known Issues

  • Because of a potential compatibility issue with Xcode version 14 and CocoaPods (used by the Mediation package), this project may not run properly when built with Xcode version 14.

[1.6.0] - 2022-08-24

Added

  • In-Game Mailbox use case which demonstrates a way that developers can send in-game messages to their players, including with gifts of various game currencies and inventory items, using Economy, Remote Config, Game Overrides, and Cloud Code.

Changed

  • Updated Unity Gaming Services packages to the latest stable group of packages released as of 2022-08-23.
    • Mediation updated from 0.5.0-preview.5 to 0.5.1-preview.1
    • Addressables updated from 1.20.3 to 1.20.5
  • Updated all Cloud Code scripts to use the most recent versions of the Cloud Code Service SDKs used within them.
    • Economy updated from 2.0 to 2.3
      • This update required changes to some method signatures.
    • Cloud Save updated from 1.0 to 1.2
    • Remote Config updated from 1.0 to 1.1
  • If a Cloud Code rate limit is reached, the exception log in the console now includes the RetryAfter value.

Fixed

  • Implemented a patch to the User Reporting tool to fix an issue that resulted in occasional memory leak and errors in the console.
    • Note: A newer version of the User Reporting tool is not yet publicly available, so this fix has been cherry-picked.
  • Implemented custom gradle settings files to prevent a dependency conflict warning when switching to the Android build target.

[1.5.1] - 2022-07-26

Changed

  • Updated the Mediation package to 0.5.0.
    • This upgrade fixes unexpected warnings that were appearing in non-Mediation-related scenes.
    • The new version deprecated two sync methods in favor of async methods, so we're now using the newer async methods.
    • This upgrade makes a cleaner distinction between supported and unsupported platforms for Mediation.
    • When the build target is Android or iOS, rewarded ads will work normally. In other build targets, ads will be disabled.
  • Added a label to the Daily Rewards use case UI to indicate how many seconds are in a day.
    • Also decreased the day length from 30 seconds to 10 seconds.

[1.5.0] - 2022-07-19

Added

  • Over-The-Air Content Delivery use case which demonstrates how you can use Cloud Content Delivery, Addressables, and Remote Config to download new content to a game while the game is running.

Changed

  • Updated Unity Gaming Services packages to the latest stable group of packages released as of 2022-07-18.
    • Changes to this project were not needed as a result of any of these updates.

Fixed

  • Fixed Daily Rewards use case so it doesn't fail if any currencies are missing custom data or addressable address.

[1.4.2] - 2022-06-22

Changed

  • Updated Unity Gaming Services packages to the latest stable group of packages released as of 2022-06-07.
    • Economy and Remote Config API names changed which required trivial code updates.
    • EconomyService.Instance.Configuration.GetX methods now fetch and cache the latest Remote Config configuration as well. This change introduced a potential race condition if the Economy configuration call and the RemoteConfigService.Instance.FetchConfigsAsync call were in the same Task.WhenAll. They have now been separated out.

Fixed

  • There was a bug where if a new Economy Configuration was published, neither the client nor cloud code would get the latest Economy configuration until the cache expired on its own (after a few days).
    • Fixed by adding a call to EconomyService.Instance.Configuration.GetCurrenciesAsync() during the initialization flow of each use case; this method call forces the Economy configuration cache to be updated.
    • Note that this call must be finished before any other Economy or Remote Config async calls are started.
  • Fixed a bug in the Virtual Shop use case. If an Inventory Item or Currency in Economy doesn't have any CustomData, that caused a null reference in the client at runtime.

[1.4.1] - 2022-06-01

Changed

  • Various improvements to all readme documentation.
  • Updated Unity Gaming Services packages to the latest stable group of packages released as of 2022-05-31.
    • No notable deprecations or breaking changes.
    • Authentication updated to release 2.0.0 (Changelog).
  • No longer validating the UGS Use Cases project versions (minimum, latest) if those keys don't exist in Remote Config. This will make it smoother for a user who recreates the backend for this project using their own account.

[1.4.0] - 2022-05-17

Changed

  • Updated Unity Gaming Services packages to the latest stable group of packages released as of 2022-05-11.
    • Some UGS SDK classes were deprecated and moved. We've updated the sample code to use the new classes.
    • The Cloud Code 422 error message format has changed. We've updated our error handling for all sample code to account for the updated message format.
    • Cloud Code method signatures have changed from accepting a single parameter object to accepting a Dictionary of parameters instead. We've updated the sample code to use the new method signatures.
  • HUD updates in the Rewarded Ad With Unity Mediation use case have been delayed until the rewarded ad is completely watched, this way the HUD shows an update to the new balance only once, after all possible reward distributions are complete.
  • Added Editor popup dialog when, based on minimum client version number, the UGS samples project is too old to run.
  • Fixed issue with Idle Clicker Use Case Sample where placing wells at invalid locations caused additional water to be dispensed for subsequent well placements.

Removed

  • Analytics has been removed from the Seasonal Events use case, see the A/B Test use case for an example of working with Unity Analytics.

Added

  • Virtual Shop use case which demonstrates a key feature in many games: allowing players to use in-game currency to purchase items and resources to facilitate a server-authoritative in-game economy with multiple store pages and server-managed badges.

[1.3.1] - 2022-04-13

Changed

  • Fixed a bug in Seasonal Events which caused the incorrect season to appear when the client's clock was incorrect. This could cause the client to appear to claim the wrong season or be unable to claim subsequent seasons when server already claimed it.
  • Fixed a bug which caused the Battle Pass to occasionally throw a null ref exception during initialization.
  • Fixed a bug which caused the Battle Pass to sometimes fail to start the new season because of a clock mismatch between the client and the server. The use case has been made more server-authoritative by always using the server timestamp when deciding which is the current season.
  • Fixed a bug in AB Test where under certain circumstances Cloud Save keys weren't getting created as expected.
  • Fixed Addressables build issue on mobile by adding call to Addressables BuildPlayerContent call when building.

[1.3.0] - 2022-03-21

Added

  • Rewarded Ad use case which demonstrates how to offer rewarded ads via Unity Mediation to give bonus rewards at the end of a level.
  • Daily Rewards use case sample demonstrates an escalating series of daily rewards incentivizing players to keep logging in to claim better and better prizes.
  • Enabled the Unity Cloud Diagnostics service for this project. Crashes and exceptions are automatically sent to the backend for analysis, so that we can ensure the quality of the samples. You can disable Cloud Diagnostics in the Services window.
  • Added the User Reporting feature, so you can send us feedback about the samples from directly within the sample scenes, with automatic screenshots included. This is a feature you can use in your projects for your customers to send feedback to your Unity Dashboard.

Changed

  • Updated Unity Services packages to the group of packages released as of 2022-03-21.
  • Fixed minor UI bug where Cloud AI Use Case Sample cursor does not appear correctly at startup or when moved between plays.
  • Improved throw handling to permit Cloud Code to throw standard and custom exceptions which are caught and handled correctly in Unity client scripts.
  • Changed the name of the project from "Game Operations Samples" to "Unity Gaming Services Use Cases".
  • Removed unused networking and multiplayer-related packages.
  • Renamed existing "Daily Rewards" use case to "Loot Boxes With Cooldown" to better describe its behavior and avoid confusion with existing live games that use a monthly calendar to grant rewards on a daily basis.

[1.2.0] - 2022-02-09

Added

  • "Cloud AI Mini Game" use case sample demonstrates server authoritative gameplay in a simple Tic-Tac-Toe game played against AI running on UGS with persistent state, Currency rewards, stats, and straightforward AI.
  • "Command Batching" use case demonstrates how to group game Commands into a single batch for server processing.
  • "Battle Pass" use case sample demonstrates a seasonal reward tier system with a free track and a premium track.

Changed

  • Updated Unity Services packages to the group of packages released as of 2022-02-07. If there are any Burst errors logged after updating, restart Unity, or delete the Library folder to resolve the errors.
  • In the AB Test scene, after calling Authentication.Instance.SignOut a call to Authentication.Instance.ClearSessionToken has been added to maintain current functionality of being able to immediately sign in again as a new anonymous user.
  • Disabled "Reset Starter Pack" button during startup and when starter pack has not been purchased.
  • Disabled playfield buttons during startup in Idle Clicker use case sample to permit initialization to complete before making UGS requests.
  • Fixed singletons so they don't break when multiple components accidentally added to the same scene.

[1.1.0] - 2022-01-12

Added

  • "Idle Clicker Mini-Game" use case sample that demonstrates server authoritative game state in real time, similar to idle clicker and social games.

Changed

  • Limited the frame rate during play mode to 30 FPS.
  • Prevented Cloud Code double seasonal reward distribution in Seasonal Event use case.
  • Updated RewardPopup prefab to allow for codeless customization.

[1.0.1] - 2021-11-29

Added

  • All use case scenes now have a back button to return to the Start Here scene during Play Mode.
  • Show the currency reward on the player's level-up popup for the AB Test Level Difficulty Sample Use Case.
  • README asset files have been added. They have the same content as the existing markdown README files, but these show up with proper formatting in the Inspector window when selected.
  • Examples for how to use the Analytics service have been added to the AB Test Level Difficulty and Seasonal Events use cases.
  • Additional Editor Analytics events to help Unity improve the samples.

Changed

  • General code cleanup in the samples.
  • RemoteConfigManager in AB Test Level Difficulty Use Case now uses Remote Config's ConfigManager.FetchConfigsAsync() method, instead of the older (non-async) ConfigManager.FetchConfigs() method.

[1.0.0] - 2021-10-20

This is the initial public release of Game Operations Samples.

Features

  • Use Case Samples:
    • AB Test Level Difficulty
    • Daily Rewards
    • Loot Boxes
    • Seasonal Events
    • Starter Pack