Skip to content

Home

Jump to bottom
Oddbjørn Bakke edited this page May 8, 2021 · 7 revisions

Welcome to the TouchPortalSDK wiki!

  • Navigation to the right ->

Or just read the API Documentation from TouchPortal.

A protip, the people on the TouchPortal discord server are really friendly, and the plugin developers there are very helpful.

Goals of this SDK:

  • Target Full Framework and dotnet core:

This plugin targets netstandard2.0, and is used both with FullFramework and dotnet core projects.
Reason for supporting Full Framework is that there is certain things that dotnet core does not support well on Windows yet, ex. Bluetooth stacks.
Also some applications with plugin support does not support dotnet core type projects.

  • A simple NuGet:

When we do changes in this SDK, it will deploy as a NuGet package for simple use.

  • Working with console and UI:

Yes, you read correctly. The SDK might work with UI Applications... but why you might ask?
One thing is making popup messages etc., but some .Net functionality is only available with WinForms, WPF or UWP.

  • Working on Windows and macOS:

TouchPortal works on both Windows and macOS, this plugin should therefor also work on both Windows and macOS.
However, the Windows version will be more tested, as it's more common. And if there ever comes a TP for Linux, it should work there as well.

  • Similarities with other SDKs:

We want this to be similar to other SDKs, not only because it then is easier to maintain. But also because it's then less fragile for changes by TouchPortal.

  • Open and free

We are using MIT license here, so you can do whatever you want with this code. If developers disappears from the face of the earth, no problem. Take the code, make it your own.

Future updates/changes?

I would like to see more samples and examples, tips and tricks. Actually anything that can help you making better plugins.

Could be nice with a github action thingy that checks the entry.tp version for creating new releases.

Another thing I have looked at, is generating the entry.tp file. I do have a repository that does a lot of the same things as the TP Java SDK, using Source Generators etc.
However, even though this code works, it's just a proof of concept, with pretty poor code quality that does not deserve to be public available. But if you want this to happen, or want to see the code, please tell me.

Clone this wiki locally