Nakama Online Subsystem Plugin for Unreal Engine

Welcome to the Online Subsystem Nakama Plugin repository for Unreal Engine!

This plugin provides an implementation of the Online Subsystem for Nakama, enabling seamless integration of Nakama's features into your Unreal Engine projects.

Read more about Nakama: https://heroiclabs.com/nakama/

Importance of Online Subsystem in Unreal Engine

The Online Subsystem in Unreal Engine is a crucial component that allows developers to incorporate various online features into their games. It simplifies tasks such as authentication, leaderboards, matchmaking, and more.

By leveraging the Online Subsystem Nakam Plugin, you can seamlessly integrate Nakama's powerful backend services into your Unreal Engine game, enhancing its online capabilities.

Read more about Online Subsystem: https://docs.unrealengine.com/5.2/en-US/online-subsystem-in-unreal-engine/

Installation and Usage

To use this plugin in your Unreal Engine game project, follow these steps:

1. Clone this repository to your local machine or download the source code as a zip file.
2. Create a "Plugins" folder within your Unreal Engine game project (if it doesn't exist already).
3. Copy the entire contents of the Nakama Online Subsystem Plugin into the "Plugins" folder.
4. Open your Unreal Engine project.
5. Navigate to the "Edit" menu and click on "Plugins."
6. Look for the "Online Subsystem Nakama" plugin in the list, and make sure it's enabled.
7. Add config below to DefaultEngine.ini or your specific platforms under "Config" folder

   [OnlineSubsystemNakama]
   bEnable=True
   ServerKey=defaultkey
   ServerUrl=localhost
   ServerPort=7350
   UseSSL=False
   TickIntervalMS=50

8. You're all set! You can now start using Nakama's online services in your Unreal Engine game through Online Subsystem

Please note that this plugin requires the official Nakama plugin as a dependency. You can find it at https://github.com/heroiclabs/nakama-unreal.

Make sure to install the Nakama plugin before using this Nakama Online Subsystem Plugin.

Official Documentation

For detailed information on how Online Subsystem Nakama Plugin works by Nakama Core Library, refer to the official Nakama documentation at https://heroiclabs.com/docs/nakama/client-libraries/unreal/.

The documentation will guide you through the setup, configuration the server and details about API

Development Status

This plugin is currently in development. Some modules, such as authentication, have been implemented, and we are continuously working on enhancing and expanding its features.

I encourage you guys to check back regularly for updates and improvements.

Contribution

I welcome contributions from the community to make this plugin even better. Whether it's bug fixes, new features, or improvements, your contributions are valuable.

Feel free to open issues, submit pull requests, and collaborate with us to take this project forward.

Thank you for choosing the Nakama Online Subsystem Plugin for Unreal Engine. Happy developing!