Skip to content

Latest commit

 

History

History
61 lines (55 loc) · 3.79 KB

readme_developers.md

File metadata and controls

61 lines (55 loc) · 3.79 KB
Raw

arcor2_editor

Instalation

  • clone this repo a switch to the directory:

    git clone [email protected]:robofit/arcor2_areditor.git
cd arcor2_areditor/

  • get submodules (there is one private, see below):

    git submodule update --init

  • create symlink of the submodules to the Assets folder:

    Windows:

    cd scripts
.\link_submodules.bat

    Linux:

    cd scripts
./link_submodules.sh

  • download multimedia files from LFS:

    git lfs install
git lfs pull

  • when downloading Unity (current version for this project is 2022.3.5f1) choose modules according to your needs (e.g. Android build support for creating .apk files)

  • Get third party assets. BUT-based developers may ask to get access to a private repository (added as submodule of this repo - don't forget to add your ssh public key to your GH account). External developers will have to get following assets from Unity AssetStore (extract and copy into Assets/Submodules):

    • Lunar Mobile Console (optional)
    • Loading screen animation
    • Modern UI Pack
    • UI Graph
    • Joystick Pack
    • Native Camera for Android & iOS (only if you want to build Android version)
    • Trilib 2 - manually delete folder Trilib/Plugins/NewtonSoft.Json/ otherwise, there will be most likely conflicts
    • Simple Collada
      • requires to apply patch (/scripts/ColladaImporter.patch and /scripts/StringExtensions.patch) on script ColladaImporter.cs and OrbCreationExtensions/StringExtensions.cs
      • SimpleCollada asset must be moved to Assets/Submodule folder in order to patch script works
      • on Windows, you can download UnxUtils and use batch file in /scripts/patch_simple_collada_asset.bat (if UnxUtils extracted to "C:\Program Files") or use this command:
      path_to_UnxUtils\UnxUtils\usr\local\wbin\patch.exe ..\arcor2_AREditor\Assets\Submodules\SimpleCollada\ColladaImporter.cs -i ColladaImporter.patch
path_to_UnxUtils\UnxUtils\usr\local\wbin\patch.exe ..\arcor2_AREditor\Assets\Submodules\SimpleCollada\OrbCreationExtensions\StringExtensions.cs -i StringExtensions.patch
      • on Linux, you can use bash script in /scripts/patch_simple_collada_asset.sh

  • delete folder repository\arcor2_AREditor\Assets\Submodules\TriLib\TriLibSamples

  • in Unity, go to Project Settings -> XR -> ARCore Extensions and change Android Authentication Strategy from "Keyless" to "Api Key"

Building

  • when platform is set to Android - building .apk or want to use AR Foundation Remote:
    • Add "AR_ON" to Scripting Define Symbols in Project Settings -> Player -> Other Settings
  • when platform is set to Android - running play mode in Unity:
    • Remove "AR_ON" from Scripting Define Symbols in Project Settings -> Player -> Other Settings
  • when platform is set to Standalone:
    • No need of (un)setting "AR_ON" in Scripting Define Symbols, it is ignored
  • note: IL2CPP scripting backend is meant mainly for releases, while for faster development cycle the Mono backend is suitable (can be changed in Project Settings -> Player -> Other Settings)