Skip to content

Getting Started

Jump to bottom
Michael Starrett edited this page May 21, 2020 · 45 revisions

Get the Landmarks master project folder and open it in Unity

  1. Fork and clone or simply download the repository here

    • Landmarks utilize a forking workflow, also referred to as a fork-and-pull or fork-and-branch workflow). You can learn more about this workflow here. It is recommended that users fork the public repository and then clone their forked repository to a local repository where they can add their own features to be merged into Landmarks. A useful guide for completing this process can be found here.
    • Even if you don't intend to contribute your changes to Landmarks, it is still recommended that you fork and clone the repository. Tracking your forked repository with git and keeping it linked to the official repository allows you to easily stay up-to-date with any new developments and improvements to Landmarks as well as contribute your changes later should you ever change your mind.
    • I've made a video tutorial detailing the initial setup process for Unity, Github, and Landmarks (click the image below or right-click and open in a new tab/window): Image AltText
    • For more information on using Landmarks with Git, watch the video below (click or right-click and open in a new tab/window): Image AltText

  2. Open the project in Unity. I do my best to stay up-to-date in using the most recent LTS release of Unity from the previous calendar year (e.g., in May of 2019 Landmarks used Unity2018.4.1f1 (LTS)). I recommend downloading UnityHub to manage versions (getting started with UnityHub)

  3. That's it! Play around in the prebuilt demo scene (Assets/Landmarks/Scenes/demo/demo_SimpleSample_50x50.unity) to get familiar with Landmarks and see a configured and functioning simple navigation experiment, or follow one of the tutorials below to learn how to add new tasks to an existing Landmarks-compatible environment (Assets/Landmarks/Scenes/SimpleSample_50x50.unity) or create your own new Landmarks-compatible scene from scratch using the _Landmarks_ unity prefab (Assets/Landmarks/Prefabs).

Other tutorials for getting started with Landmarks

• Open a functional Navigation Experiment

• Add new tasks to an existing Landmarks-compatible environment

• Create a Landmarks-compatible Environment from scratch

NOTICE This guide is a living document. If you have any questions or issues, please let us know by emailing Mike Starrett at [email protected].

Clone this wiki locally