# HG changeset patch # User Thaddeus Delude # Date 2016-07-29 06:37:06 # Node ID e4c3beaea22e2d41d20f6b6d76455a62117513b9 # Parent aa7a5c57a8a85b63a857ebcdb82ac8ecd3774d77 readme diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,64 @@ +-------------------------------------------- +[Cardinal Main Menu System by Metahusk | 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) + +-------------------------------------------- +Development Files | Getting Started Directions +-------------------------------------------- +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 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. Enjoy :) + +-------------------------------------------- +Project Credits +-------------------------------------------- + **Project Lead:** +Thaddeus Delude + **Writing:** +Rebecca Frymire + **Audio:** freesounds.org: 18hiltc, cabled_mess, tekgnosis, longhairman, RutgerMuller, joshuaempyre, qubodup, klankbeeld + +-------------------------------------------- +License Information +-------------------------------------------- +Cardinal Fall: ©2016 Nonprofit Videogame Development Group, Inc. All rights reserved. + _**3rd Party Assets**_ +Assets located in the \InfinityBladeEffects and \InfinityBladeFireLands directory are Property of [Epic Games, Inc.](http://epicgames.com) +Assets located in the \MixamoAnimPack directory are Property of [Adobe Systems Incorporated](https://www.mixamo.com/) +You must follow the licensing requirements set the respective owners. These assets cannot be used outside of the Unreal 4 Engine. + +-------------------------------------------- +Adapted From Trial of Might +-------------------------------------------- +Open Steam +Extract Plugins From Zip Folders to /Plugins +Open CardinalMenu.uproject +Enable Web Browser Plugin Edit -> Plugins -> Widgets -> Web Browser +Restart Editor +Press Play \ No newline at end of file