Mal.Mdk2.ModAnalyzers 2.1.4

There is a newer version of this package available.
See the version list below for details.
dotnet add package Mal.Mdk2.ModAnalyzers --version 2.1.4                
NuGet\Install-Package Mal.Mdk2.ModAnalyzers -Version 2.1.4                
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="Mal.Mdk2.ModAnalyzers" Version="2.1.4" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Mal.Mdk2.ModAnalyzers --version 2.1.4                
#r "nuget: Mal.Mdk2.ModAnalyzers, 2.1.4"                
#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 Mal.Mdk2.ModAnalyzers as a Cake Addin
#addin nuget:?package=Mal.Mdk2.ModAnalyzers&version=2.1.4

// Install Mal.Mdk2.ModAnalyzers as a Cake Tool
#tool nuget:?package=Mal.Mdk2.ModAnalyzers&version=2.1.4                

MDK Analyzers


The game Space Engineers (by Keen Software House, no affiliation) supports scripting and modding using the C# language, but limited by a built-in whitelist to protect against dangerous or destructive code. This analyzer aims to inform the developer when they're trying to use parts of the .NET framework or game API they are not allowed to use.

This package is part of the MDK2 project.


Usage:

Simply reference the nuget package in your mod project. It should automatically start analyzing your project.

Nuget unfortunately does not notify you when there's updates to nuget packages, so you should check manually now and again, especially after game updates.

Ignoring paths and folders

Edit your project file. Within the first <PropertyGroup>, add

<Mdk-IgnorePaths>$(Mdk-IgnorePaths)|PathToIgnore\**\*</Mdk-IgnorePaths>

Everything in that path, recursively, will now be ignored by the analyzer. Add multiple patterns with |:

<Mdk-IgnorePaths>$(Mdk-IgnorePaths)|FirstPath\**\*|**\*.debug.cs</Mdk-IgnorePaths>

Including the $(Mdk-IgnorePaths) will add to the ignore list rather than replace it.


Disclaimer:

These tools are an independent creation and is not endorsed, sponsored, nor affiliated with Keen Software House. "Space Engineers" is a trademark of Keen Software House. All trademarks and copyrights used are properties of their respective owners. The use of "Space Engineers" in these tools is for reference purposes only and does not imply any association or endorsement.

There are no supported framework assets in this 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

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.1.10 343 8/24/2024
2.1.9 188 7/7/2024
2.1.8 582 1/29/2024
2.1.7 643 11/18/2023
2.1.4 1,848 11/17/2023 2.1.4 is deprecated because it has critical bugs.
2.1.3 1,726 11/5/2023
2.1.2 1,722 11/5/2023
2.1.1 1,727 11/5/2023
2.1.0 1,798 11/5/2023

v.2.1.4
- Legal crap, version parity

v.2.1.3
- _Someone_ left in a debugger call...

v.2.1.2
- New whitelist cache was actually _not_ embedded...
- Fixed <Mdk-IgnorePaths> not actually working for multipaths because ; is a reserved character

V.2.1.1
- Fixed bad default ignore path

V.2.1.0
- Nuget Rename (I am _so_ sorry, it had to be done, won't happen again, I promise)
- Added support for <Mdk-IgnorePaths> (see readme for instructions)
- Updated whitelist cache