Chickensoft.UMLGenerator 0.2.3

.NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Chickensoft.UMLGenerator --version 0.2.3
                    


                    

                
NuGet\Install-Package Chickensoft.UMLGenerator -Version 0.2.3
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="Chickensoft.UMLGenerator" Version="0.2.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Chickensoft.UMLGenerator" Version="0.2.3" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Chickensoft.UMLGenerator" />
                    


                            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 Chickensoft.UMLGenerator --version 0.2.3
                    


                    

                
#r "nuget: Chickensoft.UMLGenerator, 0.2.3"
#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 Chickensoft.UMLGenerator@0.2.3
#: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=Chickensoft.UMLGenerator&version=0.2.3
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Chickensoft.UMLGenerator&version=0.2.3
                    


                            Install as a Cake Tool

🔀 UMLGenerator

Chickensoft Badge Discord line coverage branch coverage

A tool for generating UML diagrams from C# code, designed to work seamlessly with Godot and .NET projects. UMLGenerator simplifies visualizing complex class hierarchies, and relationships through automated diagram creation.

<p align="center"> <img alt="Chickensoft.UMLGenerator" src="docs/icon.png" width="200"> </p>

📌 Overview

UMLGenerator produces PlantUML .puml files from your codebase, enabling easy visualization of:

  • Class inheritance trees
  • Component relationships
  • Method call dependencies

The generated diagrams are placed alongside source files with the *.g.puml extension, ready for rendering with PlantUML, VSCode extension, or the Jetbrains plugin.

🧰 Key Features

  • Automatic diagram generation from tscn and C# code
  • Integration with Godot.NET projects
  • Real-time visualization via IDE plugins

📚 Getting Started

  1. Install the UMLGenerator package from nuget
  2. (Optional) Add <AdditionalFiles Include="**/*.tscn"/> to the csproj so that all .tscn files within the project directory are found (may want to exclude addons)
  3. Add [ClassDiagram(UseVSCodePaths = true)] attribute to classes.
    1. If you use Jetbrains Rider, either remove UseVSCodePaths, or set it to false
using Chickensoft.UMLGenerator
    
public interface IGame
{
    void StartGame();
    void LoadGame();
    void SaveGame();
}
    
[ClassDiagram(UseVSCodePaths = true)] 
public class Game : Node, IGame 
{
	public IGameRepo GameRepo { get; set; } = null!;
	public IGameLogic GameLogic { get; set; } = null!;
    
    // ... (implementation details) 
}
  1. Build your project
  2. Open the generated .g.puml files

This would generate a PlantUML file showing:

  • Class relationships
  • Interface implementations
  • Method signatures

🖼️ Visualizing UML Diagrams

Generated .puml files can be visualized using PlantUML. For example:

classDiagram

  Game --> GameRepo
  Game --> GameLogic
  
  class Game {
      void StartGame()
      void LoadGame()
      void SaveGame()
  }
  
  class GameRepo {
      
  }
  
  class GameLogic {
      
  }
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

  • .NETStandard 2.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on Chickensoft.UMLGenerator:

Repository Stars
chickensoft-games/GameDemo
The Chickensoft Game Demo — a fully tested, third-person 3D game built with Godot and C#. Now with saving and loading!
Version Downloads Last Updated
1.0.0 130 10/23/2025
0.2.3 334 10/4/2025
0.2.2 216 9/24/2025
0.2.1 414 9/18/2025
0.2.0 423 8/10/2025
0.1.6 286 7/13/2025
0.1.5 255 6/23/2025
0.1.4 307 6/18/2025
0.1.3 178 6/16/2025
0.1.2 228 6/2/2025
0.1.1 180 6/2/2025
0.1.0 185 5/26/2025
0.0.9 175 5/26/2025
0.0.8 186 5/20/2025
0.0.7 163 5/20/2025
0.0.6 165 5/20/2025
0.0.5 176 5/19/2025
0.0.4 173 5/19/2025
0.0.3 171 5/19/2025
0.0.2 171 5/19/2025
0.0.1 131 5/18/2025
0.0.0-devbuild 128 5/18/2025

UML Generator release.