--------------------------------------------
[Cardinal Main Menu System by Metahusk | Community Project | Steam Server Browser, Credits, and Game Settings](http://repositories.metahusk.com/menu.hg):
An Unreal Engine 4 Community Online Menu System By Metahusk
--------------------------------------------

**Source Location:** [Repository Webpage](http://repositories.metahusk.com/menu.hg)

> **Clone Source Over HTTP:** http://repositories.metahusk.com/menu.hg

**Built Using:** [Unreal 4 Engine](http://www.unrealengine.com/what-is-unreal-engine-4) developed by [Epic Games, Inc.](http://epicgames.com) 

--------------------------------------------
About This Project
--------------------------------------------
We are releasing the game menu from our game, Cardinal Fall, to the community for free. 
This project packages a combination of other community projects to create a single, easy to implement menu system. 
We will do our best to update the project with new engine releases.

--------------------------------------------
Getting Started 
--------------------------------------------
1. Create a Project Directory folder in your Unreal 4 Projects Directory.
> **Example Structure:** C:\Users\User\Documents\Unreal Projects\Directory_Name

2. Download the project or Clone the development files to your Unreal 4 Projects Directory using your favorite mercurial client.
>  **Hg Repository URL:** http://repositories.metahusk.com/menu.hg

 > **Common Mercurial Clients:** [SourceTree](http://www.sourcetreeapp.com/), [TortoiseHG](http://tortoisehg.bitbucket.org/), or [SmartGitHG](http://www.syntevo.com/smartgit/)

3. Download and Install Microsoft's Visual Studio Community 2015 for Windows Desktop
>  [Visual Studio Community 2015](https://www.visualstudio.com)

4. Navigate to \Your_Directory\Plugins and extract the files in VictoryPlugin(newest-version).zip to the plugins directory into a folder called VictoryPlugin
>  **Plugins Directory Structure:** \Your_Directory\Plugins\VictoryPlugin\"plugin files"

5. Navigate to \Your_Directory\Plugins and extract the files in MainMenuLib(newest-version).zip to the plugins directory into a folder called MainMenuLib
>  **Plugins Directory Structure:** \Your_Directory\Plugins\MainMenuLib\"plugin files"

6. Navigate to \Your_Directory\Plugins and extract the files in AdvancedSessions(newest-version).zip to the plugins directory into a folder called AdvancedSessions
>  **Plugins Directory Structure:** \Your_Directory\Plugins\AdvancedSessions\"plugin files"

7. Execute cardinal.uproject and click _Yes_ to Recompile Project Modules.
8. Enable The Web Browser Plugin at Edit -> Plugins -> Widgets -> Web Browser
9. Navigate to the MainMenu Blueprints folder at \Cardinal\MainMenu\Blueprints
10. Insert your GameModes into Enum_GameModes, list your available map names to Enum_Maps, and set your server host's preferred maximum number of players to Enum_NumberOfPlayers using the supplied pattern. 
For skipped number of player options, use the enumeration's integer. For the number of players option you'd like available, spell out the integer. 
For example: 0, 1, Three will make a server with a maximum of "Three Players." (Please note the game modes and player limits are not implemented in the actual project. This is up to the end user to implement.)
11. Enjoy :)
***NOTE: To utilize Steam you must launch as a "Standalone Game" or utilize a packaged build with Steam running.***

--------------------------------------------
Known Bugs
--------------------------------------------
**Bug:** Client Returning to "Main Menu" can't join another game.
**Fix:** Fixed 08/07/2016 at Changeset - a1943cb579fc

**Bug:** The Editor's Play In Viewport option does not stretch the menu title bar all the way to the edge of the screen on some resolutions
**Fix:** Use Play In New Editor Window

**Bug:** Split screen settings not specific to player
**Fix:** None available, unknown fix

--------------------------------------------
Project Credits
--------------------------------------------
 **Project Credits:** 
Metahusk, mordentral, rama, Thaddeus Delude (parvan), The Tune Peddler, ZioYuri78

**Cardinal Menu:**
This project was put together by Metahusk using a collection of community content. Please credit everyone listed here and provide a link to our websites.

**Project Blueprints:**
This project’s blueprint files are released under the Creative Commons Attribution 4.0 International License. CC BY 4.0
Please provide credit where credit is due. You must credit the following people listed below. You can find this information in the project’s readme.
(https://creativecommons.org/licenses/by/4.0/) 

**Main Menu by ZioYuri78:**
The basic menu framework is an adaptation of ZioYuri78’s ‘Main menu and in game menu with basic game, graphics, controls and audio settings.’
(https://forums.unrealengine.com/showthread.php?103583-C-Blueprint-Main-menu-and-in-game-menu-with-basic-game-graphics-controls-and-audio-settings)

**Online Browser by mordentral:**
The online browser utilizes mordentral’s Advanced Sessions Plugin.
(https://forums.unrealengine.com/showthread.php?69901-Advanced-Sessions-Plugin)

**Rebindable Keys by rama:**
The key binding system utilizes Rama’s UMG Rebindable Key System, Rebind keys at Runtime.
(https://forums.unrealengine.com/showthread.php?51449-Full-Project-Rama-s-UMG-Rebindable-Key-System-Rebind-keys-at-Runtime!)

**Background Music by The Tune Peddler:**
The music used in this project is owned by The Tune Peddler. You do not have permission to use the project’s music without agreeing to the terms at The Tune Peddler’s website. (As of July 2016, this includes a $5 a month subscription fee.)
(http://thetunepeddler.com/)

--------------------------------------------
License Information
--------------------------------------------
The Menu System Was Adapted From Cardinal Fall: ©2016 Nonprofit Videogame Development Group, Inc.  All rights reserved.  
This Menu System is free to use under the Creative Commons Attribution 4.0 International License. CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/) 3rd Party Assets are discussed in the credits section above.