KappaDuck.Quack 0.3.0-alpha.20251225053402

Quack! 🦆

Quack! is a fast, lightweight, and user-friendly 2D/3D game engine built on SDL and its extensions (SDL_image, SDL_mixer, SDL_ttf). It is designed for modern .NET 9+ games and applications. It provides a clean, flexible and intuitive API that simplifies game development by hiding low-level complexities. It offers a range of features such as rendering (SDL_renderer and SDL_gpu), input handling, audio playback, resource management, window management, and more.

Quack & SDL compatibility

Below is a list of Quack! versions and their compatible SDL versions:

Support for SDL_mixer is planned for future releases. It needs SDL3 3.4.0 which is not yet released.

The current Quack! development can update the SDL dependencies many times before the release.

Cross-platform support

Quack! currently supports Windows, with Linux support planned for future releases.

The API is designed to be cross-platform, so porting to other platforms should be straightforward.

Other platforms may be considered in the future, but there are no current plans for them.

Installation

Quack! is available as a NuGet package. You can install it using the following command:

dotnet add package KappaDuck.Quack -v 0.2.0

or by adding the following line to your .csproj file:

<PackageReference Include="KappaDuck.Quack" Version="0.2.0" />

or by using the NuGet Package Manager in Visual Studio or JetBrains Rider.

Usage

A simple example of how to use Quack! to create a window:

using KappaDuck.Quack.Events;
using KappaDuck.Quack.Windows;

using Window window = new("Minimal window", 800, 600)
{
    Resizable = true
};

while (window.IsOpen)
{
    while (window.Poll(out Event e))
    {
        if (e.RequestQuit())
        {
            window.Close();
            return;
        }
    }
}

You can find more examples in the Examples directory.

Development

To build Quack! from source, you will need the following tools installed:

Prerequisites

• .NET 9.0 SDK
• .NET 10.0 SDK

The SDK includes everything you need to build and run .NET applications on your machine.

• Docker Desktop

Docker is used to create SDL binaries for different platforms in a consistent environment.

Setup

After installing the prerequisites, you can set up the project by following these steps:

Clone the repository

git clone https://github.com/KappaDuck/quack.git

Navigate to the project directory

cd quack

Install SDL and its extensions using the provided script

Make sure you have .NET 10.0 SDK and Docker installed, to do dotnet run app.cs.

# On Windows:
dotnet ./SDL3/build.cs

# On Linux:
chmod +x ./SDL3/build.cs # Make the script executable. No need to do this every time.
./SDL3/build.cs

Open the solution file in your preferred IDE (e.g., Visual Studio, Rider, etc.):

Any IDE doesn't support single-file execution, so you will need to run as CLI.

Visual Code have intellisense support for single-file but can't run it directly.

To test any features, you can run the examples provided in the Examples directory or create a file named quack.playground.cs at the root and run it directly.

The quack.playground.cs file is ignored by git, so you can use it to test your code without affecting the repository.

You can use the following code snippet as a starting point for your quack.playground.cs file:

#!/usr/bin/env dotnet

// Ignore the warning about missing copyright header in this file
#:property NoWarn=IDE0073
#:property TargetFramework=net10.0
#:property IncludeNativeLibraries=true
#:project KappaDuck.Quack

using KappaDuck.Quack.Events;
using KappaDuck.Quack.Windows;

using Window window = new("Quack! Playground", 800, 600)
{
    Resizable = true
};

while (window.IsOpen)
{
    while (window.Poll(out Event e))
    {
        if (e.RequestQuit())
        {
            window.Close();
            return;
        }
    }
}

# On Windows:
dotnet ./quack.playground.cs

# On Linux:
chmod +x ./quack.playground.cs # Make the script executable. No need to do this every time.
./quack.playground.cs

Credits

Quack! leverages and draws inspiration from the following projects:

• SDL
• SDL_image
• SDL_ttf
• SDL_mixer
• LazyFoo
• Sayers.SDL2.Core
• SDL3-CS
• SFML