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.
- Added a method resetLeaderboardRankings to Leaderboards v1 to reset leaderboard data for specific users
- Added Leaderboards V2 - with methods getLeaderboardV2, getLeaderboardsV2, getLeaderboardV2Rankings, getLeaderboardV2Ranking, resetLeaderboardV2Rankings, and accompanying scheme. The responses have changed, as well as the mechanics under the hood of how leaderboards operate
- Added leaderboard v2 update monitor
- Added leaderboard v2 API fetcher to the client
- Class
LeaderboardUpdateMonitor
has been updated. Use to get notified one the leaderboard changes. startMonitorLeaderboardUpdates
has been added to start listening on leaderboard updates- Added models for leaderboard updates
- One minor thing with brower deploment has been fixed
This release primary focus has been on adding leaderboards. We added ready-to-use leaderboard prefabs. More Info on the leaderboards can be found in our developer documentation
- Added
setUserInfo
andsetUserInfo
toAuthApi
to set usernames and avatars - Added Leaderboards (Classes, Models, ...)
challenge_xp
added toBattlePassLevelChallenge
object.
user_token
added toChallengeWebhookPayload
object.challenge_auto_activated
added toChallenge
object. Indicates if a challenge is automatically handled by the SCILL backend.challenge_description
added toChallenge
object.
displayShortTimeleft
paramater(optional) added to thetimeLeft
function as boolean.- Default is
false
and display time remaining asTime remaining: 1hour, 39 minutes, 16 seconds
, iftrue
time remaining is displayed asTime remaining: 1d 01:39:16
format.
- Added
getUnresolvedPersonalChallenges
function to theChallengesApi
which is a duplicate of getPersonalChallenges right now. - Added
getAllPersonalChallenges
function to theChallengesApi
which also returns finished challenges.
- Fixed calculation of minutes in
timeLeft
helper function.
- Added number of days to
timeLeft
helper function.
- Added pre-built browser bundle to published package.
- Use
prepare
instead ofpostinstall
for improved npm compatibility.
- Resolved circular dependency related to monitoring of Challenges and Battle Passes.
- Improved compatibility with Angular, Vue.js and React apps.
- Added
challenge_goal_condition
to theBattlePassLevel
object. - Added
level_reward_type
to theBattlePassLevel
object.
challenge_reward_type
should not be used anymore as it has been replaced bylevel_reward_type
inBattlePassLevel
- Added
challenge_goal_condition
to theChallenge
object. - Added
challenge_reward_type
to theChallenge
object. - Added
image_xs
,image_s
,image_m
,image_l
andimage_xl
toBattlePass
object.
- Changed type of
challenge_reward
in theChallenge
object from integer to string
- Added Realtime Notification System for Challenges and Battle Passes.
- Reworked Battle Pass System.