Skip to content

CHANGELOG.md

Latest commit

 

History

History
353 lines (280 loc) · 11.2 KB

CHANGELOG.md

File metadata and controls

353 lines (280 loc) · 11.2 KB

Change Log

All notable changes to this project are documented below.

The format is based on keep a changelog and this project uses semantic versioning.

[3.0.0] - 2026-05-11

Added

  • Async Future-based API.
  • Missing Server-to-server methods.
  • Auto-generation from Nakama/Satori schema.
  • Extensive Integration Test suite.

Changed

  • Function signatures (please refer to documentation).
  • Component lifetimes are less coupled to Unreal Engine Garbage Collector.

Fixed

  • Improved consistency across the SDK.
  • Revamped real-time websocket code.

This is a major release with a larger list of changes. For more information on the current version and the differences to previous versions, please refer to documentation and the migration guide.

[2.11.2] - 2026-04-27

Added

  • Server-side Satori events: #165

Changed

  • Removed Legacy *Core/ code: #166

Fixed

  • Missing member initializations: #164

[2.11.1] - 2026-04-09

Added

  • List Parties API: #156

Fixed

  • Client compilation issue: #160

  • Other minor improvements and fixes.

[2.11.0] - 2025-11-11

Added

  • Satori API: For CPP and Blueprints.
  • Delete User Nakama API callback.
  • Nakama Realtime client can be setup with a custom WebSocket implementation. Calling UNakamaRealtimeClient::UseCustomWebsocket(TSharedPtr) before Connect allows using a different implementation or configuring the current implementation differently than our default.
  • Nakama Realtime client now has cpp native delegates alongside the already existing dynamic delegates, allowing binding to delegates from outside managed memory types.

Changed

  • Removed unnecessary re-serialization when processing incoming messages.
  • RPC Nakama API callback now returns a boolean indicating success or failure of the synchronous part of the function.
  • Nakama Blueprint APIs now have a default, this means that have input array pins can be left empty if not used.

Fixed

  • Client compilation for Unreal 5.6 Engine.

[2.10.1] - 2025-03-06

Fixed

  • Fixed client compilation for Unreal 5.5 Engine.
  • Fixed corner case memory leak.
  • Fixed crash when searching for session variables that do not exist.
  • Fixed const issues from using NakamSession given back by delegate.

[2.10.0] - 2024-04-04

Changed

  • Changed ENakamaErrorCode enum casts to match official GRPC error codes. Any user client code checking against specific error values should be aware of this change.

Added

  • Added UNakamaClient.BanGroupUsers.

[2.9.9] - 2024-03-28

Fixed

  • Fixed return payload of UNakamaRealtimeClient.FollowUsers.

Added

  • Added UNakamaSession.GetRefreshExpireTime to get expiry time of refresh token.

[2.9.8] - 2024-03-21

Fixed

  • Fixed assignment of language tags when updating groups.
  • Fixed checking of bound status of OnDisconnect callback in socket.

[2.9.7] - 2024-02-29

Changed

  • Removed deprecated NakamaCore from .uplugin module list. This will improve the build experience for mobile platforms.

Fixed

  • Fixed test suite compatibility with Unreal 4 Engine.
  • Fixed unnecessary lambda capture of HTTP request object.

[2.9.6] - 2024-02-06

Fixed

  • Fixed serialization of party join requests.

[2.9.6] - 2024-02-06

Fixed

  • Fixed serialization of party join requests.

[2.9.5] - 2024-02-02

Fixed

  • Fixed realtime client compatibility with Unreal 4 Engine.

[2.9.4] - 2023-11-1

Fixed

  • Fixed automatic importing of steam friends during the Steam authentication process if import was passed.

[2.9.3] - 2023-10-27

Fixed

  • Fixed importing of steam friends.

[2.9.2] - 2023-10-23

Fixed

  • Fixed lifetime of socket request contexts.
  • Fixed build warnings about enum default values.

Changed

  • Tests are now only enabled in developer builds by default.

[2.9.1] - 2023-10-11

Fixed

  • Fix support for non-ASCII characters in session authentication tokens.
  • Fixed an internal import and enum name that could cause compilation failures depending on the project's build flags.

[2.9.0] - 2023-10-04

Added

  • Added TFunction support to our API calls for more concise use of callbacks.
  • The implementation of the NakamaUnreal has been rewritten to use native Unreal types rather than the prebuilt NakamaCore. The user-facing API should remain unchanged.
    • This should resolve linking issues users have when depending on NakamaUnreal. NakamaUnreal is the recommended way to use our library, but NakamaCore is still available for users who want to use nakama-cpp in Unreal Engine.
  • Introduced a Blueprint-based test project.
  • Added feature parity with Nakama 3.17.
  • Added use of FDateTime for reading session create and expiry time.

Fixed

  • Fixed x64 detection on pre-5.2.0 versions of Unreal.

[2.8.2] - [2023-08-01]

Fixed

  • Fixed loading of Websocket Module.

Added

  • Added Windows Arm64 support to the NakamaCore module.
  • Added Windows arm64/x64 debug support to the NakamaCore module.
  • Fixed architecture detection code on pre-5.2.0 versions of Unreal.

[2.8.1] - [2023-07-26]

Fixed

  • Fixed a compiler error in Android section of build script.

[2.8.0] - [2023-07-25]

Changed

  • Updated to nakama-cpp 2.8.0.
  • Refactored Nakama Core test suite to run on target devices rather than editor host.
  • Updated how nakama-cpp is pulled into nakama-unreal. It is now done using vcpkg rather than via custom builds from within nakama-cpp.

Fixed

  • Fixed Unreal Websocket transport throwing an exception if going out of scope without being explictly disconnected.
  • Fixed how Unreal Engine finds and loads the Nakama Linux shared object library.

[2.7.0] - [2023-01-10]

Added

  • Added Android support.
  • Added Authentication Refresh node for Blueprints.
  • Added Update Chat Message node for Blueprints.
  • Added IsConnected function to Realtime Client.
  • Added GetHeartbeatIntervalMs function to Realtime Client.
  • Added SetHeartbeatIntervalMs function to Realtime Client.
  • Added ALL to ENakamaGroupState enum.
  • Added RPCHttpKey function to Client for calling an RPC via HTTP key.

Changed

  • Updated transport logic for UE4 support.
  • Various improvements to client logic.

Fixed

  • Fixed issue with create client node in demo project.
  • Version property now copied correctly in FNakamaStoreObjectAck constructor.
  • Fixed compilation issue on Linux.

[2.6.0] - [2022-09-09]

Added

  • Added support for Unreal native types. Use the NakamaUnreal module and see the README for details on how to use it.
  • Added support for Blueprints. Use the NakamaBlueprints module if you are interested and see the README for details on how to use it.
  • Old functionality exposed in previous releases has been moved to NakamaCore. The other modules depend on NakamaCore.

[2.5.0] - [2021-09-13]

Added

  • Added realtime parties support.

Fixed

  • Fixed assignment of cursor in listing of storage objects.

[2.4.0] - [2020-11-01]

Added

  • Support server 2.13.0
  • Added authentication with Apple ID: authenticateApple, linkApple and unlinkApple
  • Added demoteGroupUsers
  • Added NClientInterface::rpc with http key
  • Added disableTime to NAccount
  • Added updateTime to NFriend
  • Improve future-compatibility with server changes

Fixed

  • Fix listFriends failing on 2.3.0 against 2.13.0 server

[2.3.0] - [2020-02-29]

Fixed

  • fix crash when response is received after NClient was deleted

[2.2.4] - 2019-12-08

Fixed

  • fix uint16_t is too small for our match data (#25)
  • fix getUsername and getUserId in session wrapper
  • RPC call fails when body is empty
  • RPC payload differences between Rest and RT clients

[2.2.2] - 2019-10-03

Added

  • Support Linux

[2.2.0] - 2019-09-16

Added

  • Support server 2.7
  • Support UE 4.23

Changed

  • Following client API has been added/changed to support server 2.7:
    • NSessionInterface
      • getVariables
      • getVariable
    • NClientInterface
      • authenticateDevice
      • authenticateEmail
      • authenticateFacebook
      • authenticateGoogle
      • authenticateGameCenter
      • authenticateCustom
      • authenticateSteam
      • listFriends
      • createGroup
      • listGroupUsers
      • listUserGroups
    • NRtClientInterface
      • joinMatch
  • Updated optional lib to v.3.2.0

[2.1.0] - 2019-06-19

Added

  • REST client (HTTP/1.1).
  • Add tournament start active time to the API response.
  • Add "Activity timeout" to Websocket.

Changed

  • Now we use one C++ REST library for all platforms instead of Websocketpp and IXWebsocket.
  • gRPC client is off.

Fixed

  • Fixed loading dynamic library on Mac.

[2.0.3] - 2019-05-01

Added

  • support Windows (VS 2015, 2017, 2019).

Fixed

  • enable SSL for IXWebsocket.

[2.0.2] - 2019-04-16

Changed

  • Now targeting nakama 2.x on Mac and iOS

[0.10.1] - 2018-02-16

Changed

  • Now targeting nakama 1.4.0

Fixed

  • Updated session parsing to look for "han" for handle keyword.
  • Added correct purchase records processing.

[0.10.0] - 2017-12-05

Changed

  • Now targeting nakama 1.3.0

[0.9.0] - 2017-12-03

Added

  • Advanced Matchmaking with custom filters and user properties.
  • Expose Collation ID when client operations result in an error.

Changed

  • Now targeting nakama 1.1.0

[0.8.1] - 2017-09-28

Changed

  • Now targeting nakama 1.0.1

[0.8.0] - 2017-09-28

Added

  • A paging cursor can now be serialized and restored.
  • New storage partial update feature.
  • New storage list feature.
  • A session now exposes .ExpiresAt and .Handle from the token.

Changed

  • Added default builder for notification list and remove messages.
  • A group self list operation now return the user's membership state with each group.
  • A group leave operation now return a specific error code when the last admin attempts to leave.

[0.7.0] - 2017-09-26

Added

  • Add new In-App Notification feature.
  • Add new In-App Purchase Validation feature.

Changed

  • Update Client to support the new batching API.

[0.6.1] - 2017-06-03

Changed

  • Support for Nakama API 0.13.0
  • New matchmaking feature.
  • Optionally send match data to a subset of match participants.
  • Expose a way to toggle TCP_NODELAY socket option.
  • Send RPC messages to run custom code.
  • Fetch users by handle.
  • Add friend by handle.
  • Filter by IDs in leaderboard list message.
  • Storage messages can now set records with public read permission.
  • Update user fetch add handle method name to match changes in nakama-unity 0.6.1.

Fixed

  • Dispatch callbacks when sending match data.
  • Improve leaderboard list message to handle multiple filters.

[0.5.1] - 2017-06-01

Added

  • Support for Nakama API 0.12.1
  • Support for fetching groups by name.

[0.5.0] - 2017-06-01

Added

  • Support for Nakama API 0.12.0
  • Blueprint support
  • Add support for dynamic leaderboards.
  • Add error codes for error messages in server protocol.

Changed

  • Update session token parse code for user's handle.
  • Update user presence protocol message to contain user handles.

[0.4.2] - 2017-03-21

Added

  • Initial public release - modeled after nakama-unity 0.4.2