diff --git a/DEPLOY.md b/DEPLOY.md index 288a0cb6248d07f55f380c0194abc4edb63a9b27..8081ace60f597fccfecadbc41d42f1d7ca64fef6 100644 --- a/DEPLOY.md +++ b/DEPLOY.md @@ -24,7 +24,33 @@ at the same time with the *same* version number. ## Deploying Binaries for UFrameIT -- Archive type - - - For Linux and macOS, deploy `.tar.gz` files (-> smallest file size as compared to `.zip` and `.tar`). - - For Windows, deploy `.zip` files (-> guaranteed compatibility among end users since Windows Explorer can open them) +### Archive type + +- For Linux and macOS, deploy `.tar.gz` files (-> smallest file size as compared to `.zip` and `.tar`). +- For Windows, deploy `.zip` files (-> guaranteed compatibility among end users since Windows Explorer can open them) + +### Building Binaries (MultiBuild.bat can be used to do this automatically. MultiBuild.sh is maybe outdated and needs adjustments) +- Make sure Support for all build target platforms is installed: + - Open Unity Hub -> Installs -> Choose Version -> Add Modules -> Check the following: Windows Build Support, Linux Build Support, Mac Build Support + +- Make sure to copy a suitable frameit-server.jar and a corresponding archives-folder into "Assets/StreamingAssets": + - For creating a frameit-server.jar with corresponding archives, follow https://github.com/UniFormal/MMT/tree/devel/src/frameit-mmt + +- Make sure to build with the unity-version that's set as the default-version for the project + +- Build Binaries (HINT: THE BUILD FOR macOS USUALLY ONLY WORKS IF IT'S BUILT FROM A MAC) + - Via Command Line: see MultiBuild.bat + - Via Unity-UI: File -> Build Settings... -> Choose "Target Platform" and "Architecture" -> Build + +### Building Archives +- For Windows: zip -r <TARGET-DIR>/FrameWorld_Windows.zip <SOURCE-DIR> +- For Linux/macOS: tar -zcvf UFrameIT-3.0-<TARGET>.tar.gz <SOURCE-DIR> + +### Hints for deployment +- The build for macOS usually only works if it's built from a Mac +- If the resulting binary does not work properly, please go through the player.log file (https://docs.unity3d.com/Manual/LogFiles.html) + - Linux: ~/.config/unity3d/CompanyName/ProductName/Player.log + - macOS: ~/Library/Logs/Company Name/Product Name/Player.log + - Windows: C:\Users\username\AppData\LocalLow\CompanyName\ProductName\Player.log +- For problems concerning the appearance of the game, please open the Unity-Project and adjust the Project-/Player-Settings: Edit -> Project Settings... -> Player -> Resolution and Presentation +- For changing the scenes that will be build please change the Build-Settings: File -> Build Settings... -> Scenes in Build