Skip to content

Latest commit

 

History

History
99 lines (63 loc) · 2.79 KB

contributing.md

File metadata and controls

99 lines (63 loc) · 2.79 KB
Raw

Contributing

Prerequisites

  • GPU capable PC
  • A supported OS
    • Windows 10
    • MacOSX
    • Linux (with appimage support)

Clone this repo

git clone https://github.com/RustyRaptor/SolvAR.git

Installing Unity and setup the editor

Install Unity Hub

Install the correct version of unity and the modules

  • Go to Installs

![picture 2]({{ site.baseurl }}/img/UnityHub1.png "image title")

  • Click add
  • Select the recommended LTS version of unity 2019.4

![picture 3]({{ site.baseurl }}/img/UnityHub2.png "image title")

  • Click next
  • Select the required modules
  • Android Build support
    • Android SDK and NDK Tools
    • OpenJDK

![picture 4]({{ site.baseurl }}/img/UnityHub3.png "image title")

  • Click next and wait for the unity version to finish downloading ![picture 5]({{ site.baseurl }}/img/UnityHub4.png "image title")

Setup The project and import our packages

  • In Unity Hub
    • Go to Projects
    • Click new project
    • Select 3D as the template and put it in a folder of your choice
      • NOT IN THE GIT REPO FOLDER
    • Click Create and wait for unity editor to load

![picture 6]({{ site.baseurl }}/img/UnityHub5.png "image title")

  • Once Unity is loaded
    • Make sure the "Projects" tab is selected in the bottom left

![picture 7]({{ site.baseurl }}/img/UnityEditor1.png "image title")

  • Find the file in our main git repo called SolvAR_Unity_v0.05.unitypackage

    • This contains the code and assets for our project.
    • As of writing this it is located in SolvAR/Working_Packages/SolvAR_Unity_v0.05.unitypackage

  • When you find the file open it in a separate file browser and drag the file from the file browser into the blank space under the Assets folder.

![picture 8]({{ site.baseurl }}/img/UnityEditor2.png "image title")

  • This will open a dialog to import the package
  • Click "Import" and wait till finished.

![picture 9]({{ site.baseurl }}/img/UnityEditor3.png "image title")

  • Once imported you may encounter errors about missing packages.

![picture 10]({{ site.baseurl }}/img/UnityEditor4.png "image title")

  • To fix this go Window > Package Manager
  • Wait for all the packages to finish loading.
  • Select Advanced (top leftish)
  • Select "Show Preview Packages" and confirm
  • Wait for them to reload

![picture 11]({{ site.baseurl }}/img/UnityEditor5.png "image title")

  • Look for the ARFoundation and ARSubsystems packages
  • Install each of them and wait till finished ![picture 12]({{ site.baseurl }}/img/UnityEditor6.png "image title")
  • Exit package manager.
  • Now the errors should be gone and left with benign warnings in yellow instead of red

![picture 13]({{ site.baseurl }}/img/UnityEditor7.png "image title")