From 0026e57e642bc9e048b59f56aafef47706ea6505 Mon Sep 17 00:00:00 2001 From: Archi Date: Thu, 18 May 2023 12:24:48 +0200 Subject: [PATCH] Misc doc --- ArchiSteamFarm/Plugins/Interfaces/IWebInterface.cs | 3 +++ 1 file changed, 3 insertions(+) diff --git a/ArchiSteamFarm/Plugins/Interfaces/IWebInterface.cs b/ArchiSteamFarm/Plugins/Interfaces/IWebInterface.cs index 994289b57..d9541facf 100644 --- a/ArchiSteamFarm/Plugins/Interfaces/IWebInterface.cs +++ b/ArchiSteamFarm/Plugins/Interfaces/IWebInterface.cs @@ -23,6 +23,9 @@ using Newtonsoft.Json; namespace ArchiSteamFarm.Plugins.Interfaces; +/// +/// Implementing this interface allows you to provide your own (custom) web interface files that will be exposed by standard ASF's IPC interface. In order to achieve that, you must include a directory with your web interface (html, css, js) files together with your plugin's DLL assembly, then specify path to it in and finally the path under which you want to host those files in . +/// public interface IWebInterface : IPlugin { /// /// Specifies physical path to static WWW files provided by the plugin. Can be either relative to plugin's assembly location, or absolute. If you don't know better, we recommend value of "www", which assumes that you ship "www" directory together with your plugin's main DLL assembly, similar to ASF.