Merge pull request #2 from immutable/DX-2223

DX-2223: Added Readme guides

.gitattributes

@@ -1 +1,2 @@
 *.uasset filter=lfs diff=lfs merge=lfs -text
+*.mp4 filter=lfs diff=lfs merge=lfs -text

4.27/passport-features/README.md

@@ -1,3 +1,18 @@
+> [!WARNING]  
+> This sample game is in development and login functionality does not work yet. Please use Unreal Engine 5.2 working sample if you can.
+
+# passport-features
+
+This sample game demos the passport login/logout functionality using [unreal-immmutable-sdk](https://github.com/immutable/unreal-immutable-sdk) plugin
+
+## Quick Start
+
+### Pre-requisites
+
+* Unreal Engine 4.27
+* Visual Studio 2019
+* Jet brains Rider (Recommended)
+
 ## MacOSX issues
 
 * The game does not compile using UE 4.27.2 on MacOS Ventura 13.4.1 due to engine source code errors. To fix this, we added additional compiler arguments to the game's `*.Target.cs` files ([file 1](blob/main/4.27/passport-features/Source/endlessrun.Target.cs) and [file 2](blob/main/4.27/passport-features/Source/endlessrunEditor.Target.cs)).

5.2/passport-features/README.md

@@ -1,22 +1,32 @@
 # passport-features
 
-This game demos the passport login/logout feature
+This sample game demos the passport login/logout functionality using [unreal-immmutable-sdk](https://github.com/immutable/unreal-immutable-sdk) plugin
 
-# Running the game
+## Quick Start
 
-## Pre-requisites
+### Pre-requisites
 
 * Unreal Engine 5.2
 * Visual Studio 2022
-* Rider (Recomended)
+* Jet brains Rider (Recommended)
 
-## Launch
+### Run game
 
 * Open the project file `endlessrun.uproject`
-* Build project using Jetbrains Rider or Visual Studio application
-* Run the MainMenu for game
+* Build project using Jetbrains Rider or Visual Studio IDE
+* Open MainMenu at `5.2/passport-features/Content/ThirdPersonBP/UI/MainMenu/MainMenu.uasset`
+* Press play button to run the game
 
-To test passport login functionality
+### Game Play Functionality
+
+* The game is to avoid blocking trees and collect coins. Once 10 or more coins are collected, the game will prompt to login with Passport to continue playing.
+* Press `Continue with Passport` button to login, it will then launch a browser to authenticate with Passport login flow. Once authenticated, the game will continue.
+
+### Test passport login functionality provided by [unreal-immmutable-sdk](https://github.com/immutable/unreal-immutable-sdk) plugin
 
 * Navigate to Content Browser -> Plugins -> Blueprints -> PassportBlueprintSample
 * Play game (should launch browser for authentication)
+
+### Demo
+
+<video src="Sample%20UE5%20Game%20Demo.mp4" controls title="Sample UE5 Game Demo"></video>

CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2023-08-23
+
+### Added
+
+- Initial sample game (passport-features) for Unreal Engine 5.2
+- UE 5.2 passport-features: Passport login/logout functionality implemented
+- UE 4.27 passport-features: Fix for compile errors on MacOS

README.md

@@ -1,3 +1,13 @@
+<div align="center">
+  <p align="center">
+    <a  href="https://docs.x.immutable.com/docs">
+      <img src="https://cdn.dribbble.com/users/1299339/screenshots/7133657/media/837237d447d36581ebd59ec36d30daea.gif" width="280"/>
+    </a>
+  </p>
+</div>
+
+---
+
 # sample-unreal-game
 
 Sample Unreal Game using Unified SDK features provided by <https://github.com/immutable/unreal-immutable-sdk> plugin.
@@ -24,4 +34,79 @@ git pull --recurse-submodules
 
 ## Running the Game
 
-See corresponding game folder README.md for instructions on how to run the game.
+See corresponding game folder README.md for instructions on how to run the game.
+
+- [UE5.2 Passport Features Demo](5.2/passport-features/README.md)
+- [UE4.27 Passport Features Demo](4.27/passport-features/README.md)
+
+## Changelog Management
+
+The following headings should be used as appropriate.
+
+- Added
+- Changed
+- Deprecated
+- Removed
+- Fixed
+
+What follows is an example with all the change headings, for real world use only use headings when appropriate.
+This goes at the top of the CHANGELOG.md above the most recent release.
+
+```markdown
+...
+
+## [Unreleased]
+
+### Added
+
+for new features.
+
+### Changed
+
+for changes in existing functionality.
+
+### Deprecated
+
+for soon-to-be removed features.
+
+### Removed
+
+for now removed features.
+
+### Fixed
+
+for any bug fixes.
+
+...
+```
+
+## Contributing
+
+If you would like to contribute, please read the following:
+
+- We use the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/#specification) when writing our commit messages. Why use Conventional Commits? Read [here](https://www.conventionalcommits.org/en/v1.0.0/#why-use-conventional-commits).
+
+## Getting Help
+
+Immutable X is open to all to build on, with no approvals required. If you want to talk to us to learn more, or apply for developer grants, click below:
+
+[Contact us](https://www.immutable.com/contact)
+
+### Project Support
+
+To get help from other developers, discuss ideas, and stay up-to-date on what's happening, become a part of our community on Discord.
+
+[Join us on Discord](https://discord.gg/TkVumkJ9D6)
+
+You can also join the conversation, connect with other projects, and ask questions in our Immutable X Discourse forum.
+
+[Visit the forum](https://forum.immutable.com/)
+
+#### Still need help?
+
+You can also apply for marketing support for your project. Or, if you need help with an issue related to what you're building with Immutable X, click below to submit an issue. Select _I have a question_ or _issue related to building on Immutable X_ as your issue type.
+
+[Contact support](https://support.immutable.com/hc/en-us/requests/new)
+
+## License
+Immutable Unity SDK repository is distributed under the terms of the [Apache License (Version 2.0)](LICENSE).