Skip to content

Improve configuration, parameters, packaging #16

@swarnat

Description

@swarnat

Hy,

I just push my first TP Plugin with your SDK: https://github.com/swarnat/TouchPortal_OSC_General
Thanks for your work.

I have some notes, if we can improve this node-api a little bit, because I created functions, which makes it easier to work with the sdk in three points.
When you will agree, I would like to prepare a merge request from this new repository, after the topics are tested in production environments:

  • There should be a base repository a developer can use to start from.

Configuration

  • I added a config.js File, which contain pluginId and updateUrl. This allows me to use the plugin in several places and make index.js independent from pluginId.
  • Basically this index.js is almost a generic one and can be a start point within an example. It simple calls a function from a file for a defined action. So the plugin developer for "simple" plugins can be focus on their topics. Maybe we got something similar for events and states. But about this I need to understand how they are working.

Parameter

  • Because this is my first TouchPortal plugin, maybe it won't work or will got problems I currently not see. But this function should be a part of API. For me it makes it much easier to work with action data.

Packaging
Your Discord Plugin was my preset for this first plugin. But I do not have "7z" as available command. So I removed this external dependency and implemented the zip/tpp creation within nodejs code. I think this is much better to use: https://github.com/swarnat/TouchPortal_OSC_General/blob/main/bin/tp-packaging-win.js

Stefan

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions