Skip to content

Conversation

@Thiritin
Copy link
Contributor

@Thiritin Thiritin commented Jun 18, 2025

Checks

https://github.com/Thiritin/kimai-streamcontroller-action

@G4PLS
Copy link
Member

G4PLS commented Jun 18, 2025

Why is there a requirements.txt file? This is not needed and is as far as I know getting ignored when installing the Plugin

Manifest looks also not right.
supported-app-versions does not exist. We have minimum-app-version and app-version

os and python-dependencies are not needed in the manifest as they dont do anything in the app

description should be changed to descriptions to provide translations. If you cant translate in other languages you only add the english translation

author is not used in the manifest anymore

Also please provide a correct thumbnail, the resolution for that should be 1000x360 and it should be either PNG or JPEG

@Thiritin
Copy link
Contributor Author

Why is there a requirements.txt file? This is not needed and is as far as I know getting ignored when installing the Plugin

https://streamcontroller.core447.com/streamcontroller/docs/latest/plugin_dev/submitting/submitting/#2-verify-requirements

The wiki indicated that it was needed. Is it not required to have this file?

@Thiritin
Copy link
Contributor Author

Manifest looks also not right. supported-app-versions does not exist. We have minimum-app-version and app-version

os and python-dependencies are not needed in the manifest as they dont do anything in the app

description should be changed to descriptions to provide translations. If you cant translate in other languages you only add the english translation

author is not used in the manifest anymore

Also please provide a correct thumbnail, the resolution for that should be 1000x360 and it should be either PNG or JPEG

I updated the manifest to match what you requested, also added a thumbnail.

@G4PLS
Copy link
Member

G4PLS commented Jun 19, 2025

A few more things that I just noticed.
I know the Template or the Wiki is a little bit outdated, I hope those get updated at some point to reflect newer versions of StreamController at some point.

Language

Could you maybe specify the language a little bit more? So using someting like en_US when you use United States english as an example

If youre not sure just use en_US, this is the "default" that most plugins use.

Descriptions

You could also add short-descriptions those are visible on the store page directly while the descriptions only get shown when someone clicks on the plugin.

descriptions and short-descriptions work the exact same with the only difference that short-descriptions should be, well, shorter

App Version

Could you provide an app-version? This makes it so StreamController knows the app-version that this plugin uses. You can just look at the version you developed with (Example: 1.5.0.beta.11) and paste that in there

Github

I just noticed you are missing the github section aswell. In there you just add the link to the github repo. In your case: https://github.com/Thiritin/kimai-streamcontroller-action

Manifest/About

In general If you want to get a better overview what you can add into the mainfest or the about.json file you can look at this plugin: https://github.com/G4PLS/AudioControl
In there I have everything you can add to the manifest, the about.json is missing a few things.

The about.json file is completely optional.

@Core447
Copy link
Member

Core447 commented Jun 19, 2025

@Thiritin First of all: Amazing work with your plugin!

I think you forgot to add the actual thumbnail png in the repo?
Just ping me here when you added it and also the things G4PLS mentioned.

@G4PLS
Copy link
Member

G4PLS commented Jun 19, 2025

I think you forgot to add the actual thumbnail png in the repo?

No the thumbnail is added. Its under assets -> thumbnail.png

@Thiritin
Copy link
Contributor Author

A few more things that I just noticed. I know the Template or the Wiki is a little bit outdated, I hope those get updated at some point to reflect newer versions of StreamController at some point.

Language

Could you maybe specify the language a little bit more? So using someting like en_US when you use United States english as an example

If youre not sure just use en_US, this is the "default" that most plugins use.

Descriptions

You could also add short-descriptions those are visible on the store page directly while the descriptions only get shown when someone clicks on the plugin.

descriptions and short-descriptions work the exact same with the only difference that short-descriptions should be, well, shorter

App Version

Could you provide an app-version? This makes it so StreamController knows the app-version that this plugin uses. You can just look at the version you developed with (Example: 1.5.0.beta.11) and paste that in there

Github

I just noticed you are missing the github section aswell. In there you just add the link to the github repo. In your case: https://github.com/Thiritin/kimai-streamcontroller-action

Manifest/About

In general If you want to get a better overview what you can add into the mainfest or the about.json file you can look at this plugin: https://github.com/G4PLS/AudioControl In there I have everything you can add to the manifest, the about.json is missing a few things.

The about.json file is completely optional.

I have updated the manifest and added the about.json 😄

@G4PLS
Copy link
Member

G4PLS commented Jun 20, 2025

Only have 2 things about the about.json

You provide an empty Contributors row, you can just completely remove that. Everything in about.json is optional.

The same with the release-notes, you set a path but there is no actual changelog file
If you dont want to create one your can just completely remove that section aswell

Other than that everything looks good to me

@Core447
Copy link
Member

Core447 commented Jun 24, 2025

No the thumbnail is added. Its under assets -> thumbnail.png

Ah ok. Only looked at the root directory as the thumbnail path in the manifest is thumbnail.png.

@Thiritin I opened a PR to fix this: Thiritin/kimai-streamcontroller-action#1

@Thiritin
Copy link
Contributor Author

Resolved merge conflict and approved the PR @Core447 :-)

@Core447
Copy link
Member

Core447 commented Jun 24, 2025

Resolved merge conflict and approved the PR @Core447 :-)

Nice. Sorry that I didn't said this in my last message: Can you please remove the requirements.txt file? Cause if it's present SC will install the mentioned requirements into its own environment which is not ideal.

Will merge after that - sorry again

@Core447 Core447 merged commit 48ce3c0 into StreamController:main Jun 25, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants