Voile/Voile/docs/getting-started.md

Getting Started

Note

Installation process is subject to change. Currently, Voile doesn't have a dedicated NuGet package and template, so the only way to obtain it is by using it as a git submodule and referencing Voile's .csproj in your project.

Installing Voile as a Git submodule

1. Create a new console project hosting your game with dotnet new console.
2. Add Voile as a Git submodule with git submodule add <REPOSITORY PATH>. For more information about submodules, refer to the official manual.
3. Include Voile.csproj in your project's .csproj file. Example:

    <ItemGroup>
        <ProjectReference Include="../Path/To/Voile/Repository/Voile.csproj" />
    </ItemGroup>

4. Create a new C# source file hosting your game. For an example, refer to the Introduction page.

Shipping your game