Updated README and actions.txt

Author: Sehelitar

Kick.bot.csproj

@@ -44,6 +44,9 @@
   </ItemGroup>
 
   <ItemGroup>
+    <None Update="actions.txt">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
     <None Update="LICENSE.txt">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>

README.md

@@ -1,7 +1,82 @@
 # Kick.com integration for Streamer.bot
 
-Documentation is coming soon.
+This integration for Streamer.bot is very "raw" for the moment but covers all the basics.
+You will get :
 
-# License
+* Custom events triggers for all basic streaming events : new followers, subs, resubs, gifts and even moderation
+events and messages events.
+* 2 C# methods to send messages and replies to your chat.
+* Support for Streamer.bot commands ! Yes, the ones from the "Commands" tab.
+
+Just take a look to the triggers in ``Custom`` => ``Kick`` and see by yourself :)
+
+**Contact**
+
+[![Kick](https://play-lh.googleusercontent.com/66czInHo_spTFWwLVYntxW8Fa_FHCDRPnd3y0HT14_xz6xb_lqSv005ARvdkJJE2TA=s32-rw)](https://kick.com/sehelitar)
+[![Twitch](https://play-lh.googleusercontent.com/QLQzL-MXtxKEDlbhrQCDw-REiDsA9glUH4m16syfar_KVLRXlzOhN7tmAceiPerv4Jg=s32-rw)](https://twitch.tv/sehelitar)
+[![Twitter/X](https://play-lh.googleusercontent.com/XyI6Hyz9AFg7E_joVzX2zh6CpWm9B2DG2JuEz5meCFVm4-wTKTnHgqbmg62iFKe4Gzca=s32-rw)](https://twitter.com/sehelitar)
+[![Youtube](https://play-lh.googleusercontent.com/lMoItBgdPPVDJsNOVtP26EKHePkwBg-PkuY9NOrc-fumRtTFP4XhpUNk_22syN4Datc=s32-rw)](https://youtube.com/@sehelitar)
+
+### -- WARNING --
+
+Compatible only with Streamer.bot **> 0.2.0**
+
+## Compilation
+
+To fully compile this extension from scratch, you need to have access to my Kick API implementation (added as a
+submodule in ``KickAPI``). That implementation, based on the actual private API, is in a private repository.
+I could make it public, but since this is a private API and the public one should be up soon, I made the choice to
+not release it. This extension will use the new public API as soon as possible, and all sources will be released then.
+
+However, all release packages come with a compiled version of Kick.dll you can use as a reference in this project,
+so you actually CAN compile it that way.
+
+## Installation
+
+To install this extension, download the latest release available and copy all files into ``dlls`` folder of your
+Streamer.bot installation.
+Then, import ``actions.txt`` into Streamer.bot using the Import button in the top toolbar of the app.
+
+If the installation is successful, a browser window will open. If not, check if the code in the imported action
+can compile successfuly and have no missing references. All required references are in the ``dlls`` folder of SB,
+no other download is necessary.
+
+You just have to authenticate yourself on Kick, the browser window will close by itself once it's done.
+A Windows notification will appear to confirm your authentication is successful.
+
+## Usage
+
+Just add Kick triggers to your actions and see for yourself !
+
+All triggers mimic Twitch events (as far as I could), so Twitch documentation for the corresponding triggers applies.
+(see https://wiki.streamer.bot/en/Platforms/Twitch/Events)
+
+And for both C# methods, some arguments are required to be set before calling any of them :
+
+### SendMessage
+
+| Argument | Type   | Value  |
+| :----- | :----- | :----- |
+| message | string | The message you want to send. |
+
+### SendReply
+
+| Argument | Type   | Value  |
+| :----- | :----- | :----- |
+| reply | string | The message you want to send. |
+| message | string | Content of the message you are replying to. |
+| msgId | string | Id of the message you are replying to. |
+| user | long | Username of the user you are replying to. |
+| userId | string | Id of the user you are replying to. |
+
+Note : If you reply to a message in an action that was called by a message/command trigger, all these arguments but
+your reply will already be set.
+
+## Bugs
+
+Feel free to open an issue on Github if you have a problem. Please provide a maximum of informations, including
+bot logs and instructions to reproduce your problem.
+
+## License
 
 This project is distributed under MIT License.

actions.txt

@@ -0,0 +1 @@
+U0JBRR+LCAAAAAAABADdWFuPosoWfj/J+Q+dfj5tEGVGd7IfBBXB1hm8gHLcD1VQAk1xGS4qvTP//axCRWw1kz2TeTmddLqpdfvqW1+tUv7+97+enp53JEm9KHz+46n1n3LBC+IoyfRqmT8uB17oBXlwWX/mGnyDez5ZSYZg7W/2AI8hCghzGXuW38BRdvQCA8ozN0qYaU5cQr0MJZVtV0/dOqcGg01SK/Hi7GQsk1pR8PQ18XYoI0+9r8qTF2bESRDzedpGydM8SwiASFj1xjNL9P2I1EZXSJHFQlJY+e9x5elsKs2ezSoKCKPPuNl6sW1iv7Qxtl/QJ4JeWqjTavMItVptfEZbhn3LSc4ICHNK6+skRJgSljNLcnJlOVg0t8kwiYKRl2ZRUoDTFtH0yqvOq3ihtbQ5SZTHZ+OVBdE9KtJZHt5LmaDQjoKedWL3xm5FoZUnCQmze9Ys8RwH+sb4++uq5i2vH7i92VAd86O+n/rqhU694zeRPiFxj3o7csv0cdNkS2BLFrkBWJqlPzYbwwNe9ulmM/GsJEqjbdaYDhabzTAByPso8T+1N5tduwFS5VrN7mYTpFaUUA83bEo/AoKcC8jZJ7vNpq7Ml8On9kt5jl4wnKBGu15OtGijlxahpcBOky0CtA9y/xTeeZFmJPgNGRcubNCGFv2G3FKUkF8k+AblAqV+2hgcMhKy+fM7SIazl3kBaZziz4//dCP9gf7z+H+Q9md094OUEARUleP6V+Nh2JU5rlP89fFc4yIjUmSXI8VeTWMcWM6yRd9tWc++7Lnxx7VXf7rD8oGuW7MY88L7q29THOgFMiaf+1rctHiam4X4ioxpUo+f8/QNFYKEW1rdb0FWU840uFyX3cI0hj4yhPBuXTqLrEB3TZnFCcv1appY7+lUCvV3FqMMsnjNp/nC6PqmcQBcQ22+ALvDja2R7mGZvinyNIW4d2Uw1eYDmmOWS+PGBOpJ885OGQguNpYO5teOLbsU/KO1IeSmsYfnjrPmuzns9c2WRA5XMcDFyqSKpOa2cUgVD2yF6Nqr2Q4bQw54cIEvAXLtcCAAb9ox10rnkKznNuBar2bUlETgRC/U1gTquC7zxT2osRKb6+AQrwsReGD5Js6RB8Ay8h2rNSuO+58q2lL4Mlvuna9zscTCeJS0Eue3vhapkq5SE3plGsKbuZoccRgzX5FpoMiAjdffLX5YkEUEvPmqtDxyasqHtIzXaNnX10Dd2ZLgY3nP/L69XursXgtxsODaoS6J/flg+GXGLR3AZeoDV134lqP5+mTRtJzXorNjOdmvNVJjOxhy5lwEfcz60BeKQ83R+EMMWDmlzzk41FPcZ/2keyugPONMGQCOgc4zn4Vc6iQ3V4pT//8jF4rUc5RRxSmPeeoroAW00qJxZYc6HvyVeqoWdLkzDtC+Npd63VI//ZrPh16OJR80HjGbsz3n7D2qPWwyreFwBlwzDpy4Xl+Xh+9wbua20Y5AuwIOJo4p66lp2K4tLx2m3WN+X7VHqlDGst5pNDY9t+Ly6+LEoeSf7L56xW+gt458TlNkwF4kJz5yBr4GDcbVuiCCtiMWx7QNPPv6akotr9c9c814LOM06tr8MIbzcsaRP+CqxIOMdXTVuxvMtPI9Ybpo/s7+pOUhhvNRzie2x/XKdqHPla5e6ZRbr9RKO+wc6XJ3AfMjqOOSDD21+OUv5u1EGueKC18YLmq5tyeutnOR8fGGJHdIZOBzxOZr2zHnftnjY12mP2GCeXtgGmrTLBxf8fU2nNs98LnDXu+TMsrodq5Uvbvoj3bH5TykXah90pe4tw01ZTNlHXR3WBKhNsy3Y1/OPpWWpeWtVr9U+qOFuZo1raDtgA6b5uKsYbF7jj//vcxjdYf5vbPkod+DJrVaU9fkl9F4Xqu5mhXksofLunbq87LSJfRN8BdGOcNCc+66VmC/v0riBJV3jAAaFfpIHrIZnh65gPiVSu2RXmCY21ao09p+KtxSqfNpNB7UuRbp+C6uCw9mMGS6qe2F+2ecDFVqwd0Bvaidcwo4/Wo+1M//aUZXZ+0qhzwszNYkhfuq0i7Ms/P9VukF7hbOXqm5MpoVtnEPe09lvV/zTjRbuXCPiDAHurkiL+OL72V+1fgN1nAvX3TRu2hzVOV+pMsRcKqz+3FuCAFuTX6kkSseZrzOlTPKh/s+6L7/H3AhWUEXPgNMXYa/2tcPdFKf+exzmz1QC8wPfdgDm1MVtzC7QqvY1+/RXDt/Jqlm16Pz3qvPnEcz7a5+K75l08Wj6d2zyHJvtT//vPkCGyfEioLYo4++wdqEomKeoSR74JCiHZmRNKfZItJR4rEXD3e+wVe+V17PN4COL0I+NdsdDm2tF/K5i17aGD6pIwT/kY7V6nRJB1md7k3onniOy2ByDe6jLStiVq/Lfj7azi80PrxEKW0PX6QcwYY2ObCC9fXvl4c7bypkVuz2NYYVUYrilNg1+9l8Snj2P770uUoB4UGAQvt6kX31Sy6pIM33/wFqlhDMixMAAA==