Request: Guide on getting started with MDK2 development

[Voxar]

Hi! I'm kind of new to the whole DotNet world but would love to add features to MDK2 myself. I just don't know how to get started with that at all!

I think the main blocker for me is how to build MDK2 and get the fresh build into any IDE, perhaps something on debugging as well.
From there I can probably figure things out.

Thanks for these plugins, I would not gotten far into SE scripting without it.

[malware-dev]

I haven't even had the chance to write the necessary documentation on all the features 😆

The system is designed to be built here on GitHub. When I push to the master branch, GitHub Actions build everything and publish what needs to be published. However, if you compile in release mode, you can find the built nuget packages in the output folders.

As for debugging - that's easy: MDK2 itself isn't an addin, it's just a command line program. As such, it can simply be run with the appropriate arguments, in debug mode.

Or, one writes unit tests.

I need to warn you. I will not blindly merge just any new feature into MDK2 proper. You need to respect the coding style, and the feature needs to match my vision of what MDK2 is to be. I have to be careful with this because in the end, it'll be my responsibility. So if you want to add features in a way that everyone will benefit from, I suggest to discuss them first. Otherwise you are of course quite welcome to build yourself your own version.

[Voxar]

Thanks! That's a helpful start.

I'm happy with being able to add features for myself :)
Simple things like

• Try to fix the copy to clipboard function
• Option to automatically copy to clipboard after build
• A way to manually order where some code end up in the finished script (so I always get Program() & Main() at the top for example)
• Help adding requested features that I could have use for as well

[malware-dev]

1. I'm not aware there's anything wrong with the clipboard function?
   The error you get is external. The OS itself is denying access to the clipboard. There isn't much that can be done by that from the client's PoV

2. You can already order the code. In the top of a file, add // <mdk sortorder="<number>" />
   See what I mean about not having documented everything yet? :P

[malware-dev]

Also, I am in the process of completely rewriting the Notifier program. MDK itself has no function to copy to clipboard at all, because it doesn't make sense: It's purely a command line application.

[Voxar]

Hi! I found a mod that reloads local scripts automatically in PB's so I don't really need to fix the clipboard or add auto copy! And your sortorder tag works good enough as well, thank you for pointing that out! So I haven't gotten started yet.

Regarding the sort order: it only sorts files that have the tag, so files without the tag can still appear above a file with the tag. This means that simply adding sortorder=0 to the Program.cs file isn't enough. It's a minor detail, but I would expect any file with a sortorder to be ordered above files without it.

Anyway, we got a bit off topic here. Once I get into it I'll write up a little beginners guide.

[malware-dev]

Try negative sortorder