Gas2D 0.3.0

dotnet add package Gas2D --version 0.3.0
                    
NuGet\Install-Package Gas2D -Version 0.3.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Gas2D" Version="0.3.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Gas2D" Version="0.3.0" />
                    
Directory.Packages.props
<PackageReference Include="Gas2D" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Gas2D --version 0.3.0
                    
#r "nuget: Gas2D, 0.3.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Gas2D@0.3.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Gas2D&version=0.3.0
                    
Install as a Cake Addin
#tool nuget:?package=Gas2D&version=0.3.0
                    
Install as a Cake Tool

gas2d

Gas2D 0.3.0 is a small 2D game layer on top of yak2d. You write a tree of screens that decides what runs, what draws and who gets input; put scenes of entities with components in them when you need a world; and hand the root screen to a Director, which runs everything on yak2d's window.

demo

The parts

  • Director: yak2d's application. It walks the screen tree once per update and once per frame, owns the resources shared by every screen (Director.Shared), and shuts everything down in order (Director.Shutdown).
  • Screens: a tree of Screens with fades, Replace and loading screens, inherited time (Paused, TimeScale, OwnClock) and Covers.
  • Scenes, entities and components: a screen's Scenes, each running entities and their components on a fixed tick (Tick), drawn smoothly between ticks.
  • Rendering: DrawStages filled by a Painter, and a Chain of steps per screen (draw, effects, groups, panes, children); producer chains render into RenderTargets.
  • Physics: Box2D (Box2D.NET) behind gas2d's PhysicsWorld, with Physics and PhysicsBody for scenes.
  • Swarms: Swarm<T>, many small things as plain structs.
  • Input: named actions (InputActions) routed through the screen tree, with InputBelow filters and pointer mapping.
  • Assets: an asset store with a LoadSet per screen, background loading and hot reload.
  • Sound: AudioBus trees with ducking, music hand-over and positioned sound (SoundEmitter).
  • Additions: tweens, a camera rig, state machines, prefabs and pooling, save and load, a debug overlay and replay.

A first game

One screen that owns a camera and a draw stage, fills the stage each frame, and closes when the "quit" action is pressed. The same code is in chapter 1 of the guide.

using System.Numerics;
using Gas2D;
using Colour = Yak2D.Colour;
using CoordinateSpace = Yak2D.CoordinateSpace;
using KeyCode = Yak2D.KeyCode;
using Launcher = Yak2D.Launcher;
using TextJustify = Yak2D.TextJustify;

InputActions actions = new InputActions();
actions.Define("quit", Binding.Key(KeyCode.Escape));

Director director = new Director(new HelloScreen(), new GameSettings { Title = "hello" })
{
    Actions = actions
};

Launcher.Run(director);

public sealed class HelloScreen : Screen
{
    // Screen space: (0, 0) is the middle of the window and nothing moves with a camera
    private static readonly Layer Front = new Layer(0, CoordinateSpace.Screen);

    private readonly DrawStage stage;
    private float angle;

    public HelloScreen()
    {
        Camera camera = Own(new Camera(960, 540));
        stage = Own(new DrawStage(camera) { Name = "hello" });
    }

    protected override void OnUpdate(float seconds)
    {
        angle += seconds;

        if (Input.Pressed("quit"))
        {
            // Closing the root screen ends the game
            Close();
        }
    }

    protected override void OnDraw(Painter paint)
    {
        paint.Text(stage, Front, "hello, gas2d", new Vector2(0f, 60f), 48f, Colour.White, TextJustify.Centre);
        paint.Rect(stage, Front, Vector2.Zero, new Vector2(80f, 80f), Colour.Orange, rotation: angle);
    }
}

The repository

  • src/Gas2d: the library (namespace Gas2D)
  • src/Gas2d.Demo: a small game using every part (dotnet run --project src/Gas2d.Demo)
  • src/Gas2d.Tests: unit tests (dotnet test in src/)
  • docs/guide/: the user guide, starting at docs/guide/index.md, with migrating from 0.2.1
  • docs/screen-tree-design.md: how it fits together and why
  • docs/how-gas2d-works.txt: the same, in plain text

Using the Gas2D package

Gas2D is published on nuget.org (0.3.0 at the time of writing):

dotnet add package Gas2D

Publishing

  1. Bump <Version> in src/Gas2d/Gas2d.csproj: patch for fixes, minor for new API, major for breaking changes.
  2. Push to main. CI (.github/workflows/publish.yml) tests, packs, pushes the package to nuget.org and waits until the new version is live.

A version is never re-published: if <Version> is already on nuget.org, CI skips the push. The nuget.org API key is the NUGET_API_KEY repository secret; nuget.org keys must expire in 30 days or less, so renew it before it lapses (an expired key fails the publish job).

Local feed (optional)

To try unreleased changes in an isolated build (no sibling source, no network), pack to a local folder feed. Use a pre-release version such as 0.3.1-local.1, so it never clashes with a published one.

  1. One-off: register the feed, e.g. dotnet nuget add source ~/nuget-local -n local.
  2. Set <Version> to the pre-release version and pack: dotnet pack src/Gas2d/Gas2d.csproj -c Release -o ~/nuget-local. Never re-pack a version that was already packed: NuGet caches packages by version and would keep serving the old one.
  3. Update the Gas2D package version in the consuming repo and restore it once, so the package lands in your NuGet cache (~/.nuget/packages), which is where offline builds find it.
Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.3.0 11 11/16/2026
0.2.1 53 11/15/2026