Encompass-FNA-Template/README.md

FNA-VSCode-Template

Template and build tasks for developing a cross-platform multi-target .NET Framework, Mono, and .NET 5 FNA project in VSCode.

The generated solution file will also work in regular Visual Studio.

Features

• Includes project boilerplate code
• Build tasks for both .NET Framework, Mono, and .NET 5 side by side
• VSCode debugger integration

Requirements

• Git or Git for Windows on Windows
• .NET 5 SDK
• .NET Framework 4.6.1 Developer Pack on Windows
• Build Tools for Visual Studio 2019 on Windows
• Mono on OSX or Linux
• Visual Studio Code
• VSCode C# Extension
• VSCode Mono Debug Extension if debugging using Mono

Installation

• Make sure you have Git Bash from Git for Windows if you are on Windows
• Download this repository
• Run install.sh
• Move the newly created project directory wherever you want
• On Windows, add C:\Program Files (x86)\Microsoft Visual Studio\2019\BuildTools\MSBuild\Current\Bin to your system environment PATH variable after installing Build Tools for VS 2019

Usage

• Open the project directory in VSCode
• Press Ctrl-Shift-B to open the build tasks menu
• Framework tasks use .NET Framework to build and run (Windows only)
• Mono tasks use Mono to build and run
• 5 tasks use .NET 5 to build and run
• Press F5 to build and debug

Acknowledgments

Thanks to Andrew Russell and Caleb Cornett's FNA templates for a starting point for this template.