Chickensoft.UMLGenerator 0.0.0-devbuild

This is a prerelease version of Chickensoft.UMLGenerator.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Chickensoft.UMLGenerator --version 0.0.0-devbuild
                    
NuGet\Install-Package Chickensoft.UMLGenerator -Version 0.0.0-devbuild
                    
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.0.0-devbuild" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Chickensoft.UMLGenerator" Version="0.0.0-devbuild" />
                    
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.0.0-devbuild
                    
#r "nuget: Chickensoft.UMLGenerator, 0.0.0-devbuild"
                    
#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.0.0-devbuild
                    
#: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.0.0-devbuild&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=Chickensoft.UMLGenerator&version=0.0.0-devbuild&prerelease
                    
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

🧪 Example

using Chickensoft.UMLGenerator
    
public interface IGame
{
    void StartGame();
    void LoadGame();
    void SaveGame();
}
    
[GenerateUML] 
public class Game : Node, IGame 
{
	public IGameRepo GameRepo { get; set; } = null!;
	public IGameLogic GameLogic { get; set; } = null!;
    
    // ... (implementation details) 
}

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 {
      
  }

📚 Getting Started

  1. Install the UMLGenerator package
  2. Add [GenerateUML] attribute to classes
  3. Build your project
  4. Open the generated .g.puml files
There are no supported framework assets in this 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.1.6 178 7/13/2025
0.1.5 210 6/23/2025
0.1.4 263 6/18/2025
0.1.3 144 6/16/2025
0.1.2 196 6/2/2025
0.1.1 153 6/2/2025
0.1.0 155 5/26/2025
0.0.9 145 5/26/2025
0.0.8 151 5/20/2025
0.0.7 141 5/20/2025
0.0.6 138 5/20/2025
0.0.5 146 5/19/2025
0.0.4 140 5/19/2025
0.0.3 148 5/19/2025
0.0.2 137 5/19/2025
0.0.1 99 5/18/2025
0.0.0-devbuild 104 5/18/2025

UML Generator release.