Asteroids in .NET Framework, .NET 9, WinUI3, Maui, Electron, AvaloniaUI, and Blazor WebAssembly

Live Demo: https://aesalazar.github.io/AsteroidsWasm/

This project is a POC to determine the plausibility of writing a .NET Standard library and using it across devices INCLUDING WebAssembly (WASM). The root library, Asteroids.Standard, encapsulates all logic for rendering the classic '80s video game. None of this is meant to be production-worthy. It is more me just messing around trying to see what works.

The original code was adopted from a very cool WinForms project on CodePlex by Howard Uman, circa 2004:

https://www.codeproject.com/articles/7428/c-asteroids

Which now resides here:

https://github.com/unhuman/csharp-asteroids

It was chosen because it was already in C# and very straight forward in terms of inheritance and logic. Separating the logic from the UI layer was relatively simple.

Currently, the project is made of the following:

• Asteroids.Standard - .Net Standard Library containing the game engine.

• Asteroids.WinForms - Reconstructed WinForms GUI that uses the game engine with a PictureBox as the main renderer.

• Asteroids.Wpf - Equivalent WPF GUI to the WinForms applications that uses a WPF WriteableBitmap as the main renderer with help from the WritableBitmapEx library.

• Asteroids.Blazor.Wasm - WebAssembly project that uses Microsoft's Blazor Client to allow cross-compiling the C# code to WASM so it can be rendered in a browser (see below for more info).

• Asteroids.Blazor.Server - Similar to the Wasm project but instead uses Microsoft's Blazor Server to execute the application server-side (see below for more info).

• Asteroids.Blazor.Electron - Similar to the above Blazor Server project but running inside Electron to execute the code as a Desktop application.

• Asteroids.Blazor.Maui - Similar to the Blazor WASM project but instead uses Blazor Hybrid MAUI to host the same game engine as a desktop or mobile app (see below for more info).

• Asteroids.BlazorComponents - Blazor Class Library that contains the actual game engine instantiated object and associated HTML and JavaScript bridge to allow rendering in the browser.

• Asteroids.WinUI3 - XAML-based WinUI 3 project, similar to the WPF and now-removed Xamarin (see notes) projects. It uses the SKXamlCanvas as a base class for the main render control.

• Asteroids.AvaloniaUi - XAML-based AvaloniaUI project, similar to the WPF project. It uses the platform's own Canvas as a base for the graphics rendering and the VLC library for playing sounds.

General Notes

All applications are written in Visual Studio and can be launch simply by doing Debug -> Start New Instance. All are fully functional in terms of sound and keyboard support.

Note that all projects in this repository were updated using Visual Studio 2022 but should be editable in the latest Visual Studio Code; otherwise they can be started via Command Line.

Performance is getting fairly close between the different platforms as they continue to improve. For desktop, MAUI and WinUI are very smooth for game play and have the ability to play more then one sound at a time. An intresting note is that the Desktop Electron app also plays equally as well.

Another interesting comparison is between .net 8 and .net framewwork 4.8 when running the WinForms and WPF. The performance difference is very dramatic with the framework versions being almost unplayable.

.NET 8 Notes

All .NET 9 applications including Blazor are tested on version 9.0.100 (runtime 9.0.0) of the SDK so remember to have it installed. You can check what versions are installed (you can have multiple) by entering in a command prompt:

dotnet --info or dotnet --version

You can install the latest via Winget using:

winget install dotnet-sdk-8

To run all projects in this solution requires the installation of Visual Studio 2022 or the latest Visual Studio Code.

Blazor Notes

Microsoft has made Blazor officially part of .NET Core. It was first included in 3.0 Preview 4. Prior to that it was a separate library/install.

The difference between the Wasm and Server projects is the hosting model. With Blazor, you have the option to either fully host the code and application Client-Side via WebAssembly or Server-Side with updates pushed to the Client via SignalR. In a production application, the choice would be highly dependent on the situation and more information can be found on Microsoft's Hosting Models Page.

To build the app, simply do it from Visual Studio - just make sure you have all dependencies listed on their Getting Stated page at Blazor.

Building from CLI in the Asteroids.Blazor.Wasm project folder is also an option:

dotnet build -c Release

To run the application, simply hit F5 or ctrl+F5 in Visual Studio. Or from the CLI:

dotnet run

The app can be published with:

dotnet publish -c Release

Blazor Electron Notes

The Blazor Electron project is probably the most experimental of all in this repo. It uses the Electron.NET wrapper in conjunction with a Blazor Server app to show a the game in a Desktop application.

It requires the global installation of the ElectronNet.CLI before it can be ran:

dotnet tool install ElectronNET.CLI -g

Once done, it can be ran like any other project from within Visual Studio.

NOTE: Electron.NET requires node.js and npm so make sure to have them installed. If you do not just grab the latest LTS:

https://nodejs.org/en/

NOTE 2: Sometimes I get an "is being used by another process" error when attempting to start from Visual Studio. I have not been able to narrow it down but it seems to be a known issue with the package. You can easily tell by trying to delete the obj or bin folders and getting file lock errors. If it happens, look in Task Manager for any running instances of electron.exe . Kill them and it should resolve.

Blazor MAUI Notes

This was created using the Visual Studio Wizard for a Blazor MAUI project. The Weather demo components were removed along with a general cleanup. Then a reference to the Astorids.BlazorComponents project was made and added to the main layout. It is very similar to how the Asterdoids.Blazor.Wasm project works.

I left all of the Platform resources as is (Windows, Android, iOS, etc.). I have only tested Windows and Android, both of which started up flawlessly. Android used the same simiulator I had created for the new removed Asteroids.Xamarin.Andoird project. I didnt have an Apple developer subscription available but I image it will work with little effort.

If you get an error when trying to start the MAUI Android app, you may need to install WASI workload:

dotnet workload install wasi-experimental

WinUI 3

This was created using an new empty WinUI project in Visual Studio and referencing Asteroids.Standard. It uses the SkiaSharp SKXamlCanvas to provide rendering.

The .csproj file has been modified so the application can be ran/debugged withOUT always installing it to the Windows OS (the default behavior):

<PropertyGroup>
    <!--SUPRESS PACKAGING-->
    <WindowsPackageType>None</WindowsPackageType>

    <!-- Bundle the WinUI3 components -->
    <WindowsAppSDKSelfContained>true</WindowsAppSDKSelfContained>
</PropertyGroup>

AvaloniaUI Notes

The AvaloniaUI platform is relatively new and an interesting one. It is designed with the WPF developer in mind but allows for, in theory, running on just about any Operating System. This current implementation is very basic but is fully functional on Windows. It has not yet been tested in other Operating Systems.

Since it is meant to run on "anything", it cannot use the built in .NET sound player. Instead, it references the VLC library which is pretty much universally available.

Xamarin Notes (removed)

Orginally, this repo included a set of Xamarin projects for Windows Desktop and Android. These have since been removed since Xamarin has been deprecated by Microsoft. If you still wish to see these, you can check it the prior commit:

https://github.com/aesalazar/AsteroidsWasm/tree/update-aspnet-core-8.0.4