about document

[KazukiOmata]

I would like a SAMPLE and DOCUMENT.
Can you add a document?

[gri-gus]

@KazukiOmata Hi, I'm currently developing a debug mode. I don't know the timing, but documentation will definitely be added later.
Now you can try using the library. Its code is quite simple to understand.
I added an example using the library to the README.

[thelulzy]

@gri-gus

Now you can try using the library.

I'm trying to learn how to use the library, but I'm not sure how to test it locally.
The reference example repository for loremflickr seems to package its release as an executable com.ggusev.loremflickr.streamDeckPlugin, but I can't seem to find any documentation how they went from their python code and run.bat to this executable.

It would be nice to have a "minimum viable product" example, such as incrementing a visible counter on button press, and have documentation on how to get it running locally on your Stream Deck.

[thelulzy]

Something similiar to this but even simpler: https://github.com/elgatosf/streamdeck-counter

[gri-gus]

@thelulzy Hello. I took your advice and added information about creating and packaging the plugin. There are also many new features and a Debug mode.
Already available in updated version: v1.0.0

[thelulzy]

@thelulzy Hello. I took your advice and added information about creating and packaging the plugin.

Thanks! I'm giving it a try. I installed a dependency for what I'm trying to do using pip install <package-name>, which ends up in <project-dir>\.venv\Lib\site-packages but doesn't end up in \AppData\Roaming\Elgato\StreamDeck\Plugins\com.bestdeveloper.mytestplugin.sdPlugin\code\venv\Lib\site-packages.

Am I doing something wrong?

[gri-gus]

@thelulzy Have you added your package to <project-dir>/code/requirements.txt ?
If not, then go to <project-dir> in the terminal and use the command pip freeze > code/requirements.txt.

Here's an example from loremflickr-streamdeck-plugin: click

<project-dir>\.venv\Lib\site-packages is your virtual environment in the project. But not in the plugin. The plugin must somehow know what exactly to install in its virtual environment after installation in the Stream Deck application. <project-dir>/code/requirements.txt is exactly what is needed for this.