Skip to content

sejtam-dev/StreamDockSDK

Repository files navigation

StreamDock SDK (C#)

License CI NuGet Docs

Build StreamDock plugins in C# — fast, clean, and async-first. 🚀


🚀 What’s inside

  • C# SDK for the StreamDock WebSocket plugin protocol
  • Example plugin showing real-world actions (buttons + knobs)
  • Property Inspector helpers and UI patterns
  • i18n-ready Property Inspector (language auto-detected)

✨ Why you’ll like it

  • Async-first API
  • Typed events (less trial & error with raw JSON)
  • Action handler pattern (keeps plugin code clean)
  • Built-in logging (log4net)
  • i18n-friendly Property Inspector (language auto-detected)
  • Practical by default — easy to copy, tweak, and ship

🧰 Requirements

  • Windows 10+
  • .NET SDK (currently targeting .NET 9)
  • StreamDock software installed

🔨 Quick start

Option A: Build → Install

cd .\ExamplePlugin\Scripts
.\Build.ps1
.\Install.ps1

Option B: Build & Install (one command)

cd .\ExamplePlugin\Scripts
.\BuildAndInstall.ps1

🤝 Contributing

Contributions are welcome! 🧡

  • Found a bug or a protocol mismatch? Open an issue.
  • Please include logs + raw JSON payloads when possible (it helps a lot).

📄 License

MIT — see LICENSE.


If this project helps you, consider giving it a ⭐️