Pre-flight check

Before getting started, there are a few things you'll need and some other things you might want to know.

Things you'll need

  • A 'modern' web browser.
    • We'll use Google Chrome for this guide, but Firefox or Brave should also work fine.
  • Visual Studio Code (Windows, Mac OS, Linux) or any other C#-compatible code editor.
    • We strongly suggest using VSCode to follow along with this tutorial, although Visual Studio will also work fine.
    • Extensions - VSCode has a strong emphasis on extensions to make your IDE work for you.
      • C# - Extension for debugging and linting. This will provide code completion and “intellisense” in your code editor.
        • ⚠️
          This extension uses OmniSharp, which it will install automatically. If you do not see code completion and debugging you should try one of these two solutions:
          • Install the .NET 6 SDK so that OmniSharp can rely on it.
          • Try changing the OmniSharp setting to allow it to use versions of .NET older than .NET 6.
            • Image without caption
      • Optional: glTF Tools - Extension for viewing models locally.
  • Access to a command line for your operating system.
    • We'll use the Windows Command Prompt for this guide, but other operating system command prompts should work similarly.
      • Windows: Hypar is known to work on the windows command prompt and git bash.
        • Some users have experienced issues using Hypar on PowerShell. PowerShell is not recommended.
      • Mac: Hypar is known to work on bash and zsh.
      • Linux: Hypar is known to work on zsh.
  • .NET Core 3.1
    • Hypar uses the cross-platform .NET Core SDK created and maintained by Microsoft. The version number is important! There might be issues with earlier or later versions of .NET Core. Be sure to download the SDK installer from the left-hand side, not the runtime.
      • M1 Mac Users:
        • Ensure arm64 version is installed.
        • Documented issue with dotnet sdk -
          • The .NET install on an M1 MacBook is not saved to the expected path /usr/local/bin
            Quick solve after .NET 3.1 Core install:
            sudo ln -s /usr/local/share/dotnet/x64/dotnet /usr/local/bin/
  • .NET 6.0
    • Although .net 6.0 is not used by Hypar functions yet, newer releases of the C# extensions for Visual Studio Code require .net 6.0 be installed to provide code analysis, syntax highlighting, and code completion.
    • Hypar will be moving to .net 6.0 in the future, and the requirement to install two versions of .net will be removed.