Milkshake.NET 1.0.0

.NET 7.0 This package targets .NET 7.0. The package is compatible with this framework or higher. 
dotnet add package Milkshake.NET --version 1.0.0                

                    
                

            
NuGet\Install-Package Milkshake.NET -Version 1.0.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="Milkshake.NET" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Milkshake.NET --version 1.0.0                

                    
                

            
#r "nuget: Milkshake.NET, 1.0.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. 
// Install Milkshake.NET as a Cake Addin
#addin nuget:?package=Milkshake.NET&version=1.0.0

// Install Milkshake.NET as a Cake Tool
#tool nuget:?package=Milkshake.NET&version=1.0.0

Milkshake.NET

A library for meme generation, based specifically on Milkshake Simulator, though also Feijoada Simulator and ShitpostBot 5000, using ImageMagick (Magick.NET). It was developed for its use on Discord, but it possibly runs on any platform.

Requirements

Milkshake.NET requires .NET 7 and Magick.NET for functioning.

Documentation

Proper documentation and guide will be written after I'm done with this semester on college. The core of the library revolves around the Milkshakes, which are the main objects, they are:

  1. The Source - Any image added with the intent of serving as the "protagonist" of a generated image. A source can have tags to specify its type.
  2. The Template - The image used as a base for the Generation. Sources will be placed either over or under the Template.
  3. The Topping - A set of properties inherently dependant of the designated Template. A topping can also have tags.
  4. The Generation - It is the resulting Milkshake, being the metadata of the generated image.

Tags

There are 8 tags the user can choose:

  1. Any
  2. Person
  3. Symbol
  4. Object
  5. Shitpost
  6. Picture
  7. Post
  8. Text

Milkshake Instance

An Instance is the context for the data Milkshake.NET can access, there can be multiple Instances.

Credits

This project is totally inspired on my friend Mateusão's Milkshake Simulator project, which is a Discord bot with the same base functionality.

Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  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. 
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
1.0.0 661 6/13/2023

First release.