diff --git a/DeveloperSetup.md b/DeveloperSetup.md new file mode 100644 index 0000000..9422937 --- /dev/null +++ b/DeveloperSetup.md @@ -0,0 +1,24 @@ +# Developer Setup + +The MediocreMapAssistant2 uses the Unreal Engine 4 for it's development. + +## Windows Developer Setup Instructions +### Visual Studio and Build Tools +* Install Visual Studio Community Edition +* Install Visual Studio component MSVC v140 - VS 2015 C++ build tools (v14.00) +* Install Windows SDK v8.1 + +### Install Unreal Engine 4 +* Download and install the Epic Games launcher +* Install Unreal Engine from Epic Games Launcher, select the version which is indicated in "MediocreMapAssistant2.uproject" file +* Install the required plugins "VaRest" and "LE Extended Standard Library" into the engine (if you skip this step the editor will guide you through this when opening the project) + +### Load and run the project +* Clone the project from github into your local development folder (this step requires git) +* Start the Unreal Enginge from the Epic Games Launcher +* browse for the existing project and open "MediocreMapAssistant2.uproject" from the github project folder +* upon the first start the editor likely wants to rebuild your project +* for starting the application you can click "Play" + +### Errors +* A first starting point for errors are the logs in "Saved\Logs" diff --git a/README.md b/README.md index dd2e066..979782b 100644 --- a/README.md +++ b/README.md @@ -190,3 +190,6 @@ Min Time and Max Time specifies time of effect from a note. * Timing Track * Lightmap Integration * Bookmarks for collaborations + +## Developer setup +There is a [short tutorial](DeveloperSetup.md) for setting up your [development environment](DeveloperSetup.md) if you want to contribute to the mapping assistant. \ No newline at end of file