diff --git a/README.md b/README.md index 3e3d895a66bedb439885d755c1081474cce340ab..c834722c95d83258a23bd397e32e4c22526de535 100644 --- a/README.md +++ b/README.md @@ -36,10 +36,39 @@ First, you have to set up a development environment: 2. Follow the [UFrameIT server installation guide](https://github.com/UniFormal/MMT/blob/devel/src/frameit-mmt/installation.md) to run the server 3. In Unity, select the scene MainMenue.unity (You can find it in Assets\Scenes\Menues) and run the game (Play Button). From there you can try out "TechDemo A" in the "Demo Category"; click on it to expand a list of levels to choose from. -### Building and starting the FrameIT Server -1. Build FrameIT Server to JAR -2. Download Archives folder -3. Start Server with Command: +### Building and starting the UFrameIT Server for standalone run. + +1. Get JAR-file of the UFrameIT Server + * Download a prebuild Version here: Not Uploaded Yet + * Or build your own JAR as described in the following chapter "Build FrameIT Server to JAR" below. +3. Download Archives folder + * [archives](https://github.com/UFrameIT/archives) +5. Start Server with Command: + * ``` + Java -jar YourUFrameITServer.jar -bind :PortOfNewServer -archive-root LinkToFolderArchives + Example: Java -jar frameit-mmt.jar -bind :8085 -archive-root C:\Users\abc\xyz\archives + ``` + +#### Build FrameIT Server to JAR + +##### First time setting up +1. Open in Intellij the project with the UFrameIT Server. +2. Navigate in Intellij to: File -> Project Structure -> Artifacts +3. In the Artifacts Menue, press the icon "+" than choose JAR -> From modules with dependencies +4. In the new Menue "CreateJAR from Modules" + * find "Module:" and select "frameit-mmt" + * find "Main Class:" and search for the "Server" or set the path to the Server: + Link: ... -> frameit-mmt -> src -> info.kwac.mmt.frameit -> communication -> server -> Server + * Set "JAR files from libraries" to "extract to the target JAR". + * Press "Ok" +5. "Press OK" +6. Follow steps from next chapter: + +##### Build the JAR +1. Open in Intellij the project with the UFrameIT Server. +2. Navigate in Intellij to: Build -> Build Artifacts -> SelectYourArtifact + +* [General to_JAR-file Tutorial](https://riptutorial.com/intellij-idea/example/16922/building-a--jar) ## Useful Links for new Developers