SerpentModding.CustomCSharpModules
1.1.1
dotnet add package SerpentModding.CustomCSharpModules --version 1.1.1
NuGet\Install-Package SerpentModding.CustomCSharpModules -Version 1.1.1
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="SerpentModding.CustomCSharpModules" Version="1.1.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="SerpentModding.CustomCSharpModules" Version="1.1.1" />
<PackageReference Include="SerpentModding.CustomCSharpModules" />
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 SerpentModding.CustomCSharpModules --version 1.1.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: SerpentModding.CustomCSharpModules, 1.1.1"
#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 SerpentModding.CustomCSharpModules@1.1.1
#: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=SerpentModding.CustomCSharpModules&version=1.1.1
#tool nuget:?package=SerpentModding.CustomCSharpModules&version=1.1.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
SerpentModding
SerpentModding is a modular .NET 9 Windows Forms library designed to provide advanced UI management, animated transitions, and robust logging for desktop applications. It is intended for developers who want to build modern, extensible, and visually appealing WinForms applications with minimal boilerplate.
Features
- UIController: Static class for managing the main window's title, icon, and animated transitions between registered
UserControl
views. Supports multiple transition directions and easing modes for smooth UI animations. - KITTScanner: A reusable component that displays a KITT-style scanning beam animation on any target
Control
. Fully customizable in color, speed, and beam width. - Logger: A singleton logger with support for log levels, file and console output, and automatic exception handling. Designed for easy integration and robust diagnostics.
Use Cases
- Rapidly build modular WinForms applications with animated UI transitions.
- Add visually engaging scanning effects to controls (e.g., dashboards, status panels).
- Integrate structured logging and error tracking into your application.
Quick Start
1. UIController Example
// Initialize in your main form
UIController.Init(this);
UIController.RegisterControl("Home", homeUserControl);
UIController.RegisterControl("Settings", settingsUserControl);
// Remove a registered control by name
UIController.RemoveControl("Settings");
// Switch views with animation
UIController.ShowControl("Home", UIController.TransitionDirection.Left, 500, UIController.EasingMode.EaseInOut);
// Set window title and icon
UIController.SetWindowTitle("My App");
UIController.SetWindowIcon(myIcon);
2. KITTScanner Example
// Attach to a Panel or any Control
var scanner = new KITTScanner(myPanel)
{
BeamWidth = 80,
Speed = 5,
MainColor = Color.Lime
};
scanner.Start();
// ... later
scanner.Stop();
3. Logger Example
Logger.Instance.Initialize(LogLevel.Info);
Logger.Instance.Info("Application started");
Logger.Instance.Error("Something went wrong", ex);
API Overview
- UIController:
Init
,RegisterControl
,ShowControl
,SetWindowTitle
,SetTemporaryTitle
,ResetTitle
,SetWindowIcon
- KITTScanner:
KITTScanner(Control target)
,Start()
,Stop()
,BeamWidth
,Speed
,MainColor
- Logger:
Initialize
,Log
,Trace
,Debug
,Info
,Warn
,Error
,Fatal
,ReadAllLogs
,GetLogFilePath
Requirements
- .NET 9 SDK
- Windows OS
License
See LICENSE for details.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net9.0-windows7.0 is compatible. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net9.0-windows7.0
- No dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.