Download Vizard Source Code
===========================

.. important::

   Vizard is a Unity game engine project and requires the `Unity Editor <https://unity.com/>`__
   to open the project, run it locally, and build platform-specific binaries.

.. image:: /_images/static/basiliskVizardLogo.png
   :align: right
   :scale: 50 %

The Vizard source code is hosted openly on `GitHub <https://github.com>`__. Visit
the `AVSLab Vizard repository <https://github.com/AVSLab/vizard>`__ and download or
clone the source code.

Vizard is developed using the Git version control system. The following steps
explain how to clone the repository or pull updates to an existing local copy:

#. If needed, create your own `GitHub <https://github.com>`__ account.
#. Open the `Vizard GitHub repository <https://github.com/AVSLab/vizard>`__ in a browser.
#. In the repository clone panel, select the ``https`` option instead of ``ssh``.
#. Copy the project URL ``https://github.com/AVSLab/vizard.git``.
#. Clone the repository with your preferred Git client. If using SourceTree, select
   ``Clone From URL``, paste the Vizard repository URL, and select the ``master``
   branch to pull the code for the most recent release.

.. important::

   The Vizard repository uses git lfs to store large files, including textures. This content should be included during cloning, but if missing, git lfs may need to be initialized for the local repository and the files pulled.

The local Vizard project is then ready to be opened with the Unity Editor and compiled.