2

Getting Started

dnesov edited this page 2025-07-02 00:32:23 +02:00

Table of Contents

• Getting Started
• Installing Voile as a Git submodule
• Shipping your game

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

🧭 Overview

• Introduction
• Getting Started
• Roadmap

🏗 Architecture

• System Architecture

🛠️ Development

• Build Instructions

🔍 Manual

Core

• Game entry point
• Systems
• Resource management
• Working with text resources

I/O

• Loading files

Input

• Getting input
• Input actions

Rendering

• Rendering system overview
• Custom shaders
• Rendering Pipeline

UI

• UI system overview
• Widgets
• Containers
• Styling
• Layout
• Custom widgets and containers
• Debugging UI

Debugging

• Profiler methods
• Viewing profiler reports

📖 Reference

• Glossary
• FAQ