Skip to content

HowToBuild.md

Latest commit

 

History

History
80 lines (62 loc) · 3.25 KB

HowToBuild.md

File metadata and controls

80 lines (62 loc) · 3.25 KB
Raw

How to Build ⚒️

Preparing the build environment

Development of the game has been done on Windows and Linux devices.

  1. Install Unity version 2019.4.2f1 (We recommend installing via Unity Hub. You should also be able to retrieve it from here: https://unity3d.com/get-unity/download/archive)

  2. Install yarn

  3. If you also want to edit source code and don't want to use a plain text editor, you should also install an editor with support or plugins for C# (Rider, Visual Studio Code, ...) and for Typescript (WebStorm, ...).

    For further instructions regarding development, see the development setup hints.

This guide assumes the reader knows how to execute commands from a command line like bash.

Automatic Build Script

If you do not want to manually build and bundle every component of the game, you can use an included build script which will build all components and bundle them into a standalone distributable folder for Linux or Windows.

Follow these steps:

  1. Open ../SynergyQuest in the Unity editor.
  2. Select "SynergyQuest Build" in the menu bar at the top of the editor window
  3. Select "Windows Build" or "Linux Build", depending on the system for which you want to bundle the game.
  4. The build process will now start and take quite some time. As soon as it completes, a popup will appear informing you about the location where the build has been saved.
  5. Optional: ZIP the build folder for distribution

Building Manually

Building the Controller Web App

Execute the following commands:

cd Controller/controller-client-lib
yarn install
yarn build

cd ../sensor-input-lib
yarn install
yarn build

cd ../controller-app
yarn install
yarn upgrade ../controller-client-lib
yarn upgrade ../sensor-input-lib
yarn build

Building a required Helper Web App

Execute the following commands:

cd Controller/ssl-warning-info
yarn install
yarn build

Building the Main Game

  1. Build the Controller Web App first.
  2. Open /SynergyQuest in the Unity Editor and build the project for Linux and / or Windows. For the remainder of the guide we assume the build is saved in SynergyQuest/Build/SynergyQuest.
  3. Create a folder SynergyQuest/Build/SynergyQuest/controller-app and copy all files in Controller/controller-app/build/* into there
  4. Create a folder SynergyQuest/Build/SynergyQuest/ssl-warning-info and copy all files in Controller/ssl-warning-info/build/* into there
  5. (Optional: Generate SSL certificate used by game. This is not strictly required since a pre-built certificate with a ridiculous expiration date (900 years) is already shipped with this repository. Still, on Linux systems with openssl installed, a certificate can be built by running Certificates/generate-self-signed.sh.)
  6. Create a folder SynergyQuest/Build/SynergyQuest/Certificates and copy Certficates/generated/server.pfx into it.
  7. Done, you can now run the executable produced by Unity
  8. (If you want to distribute the game, put SynergyQuest/UsageNotes/ReadMe.txt also into the folder and ZIP SynergyQuest/Build/SynergyQuest.)