Plugins

[dzinks2009]

Hello, I was wondering how I could add plugins to the developer version. I added the .cs file from Visual Studio to folder Plugins but it didn't work.

My code:

using System;
using System.Linq;
using TS3Client;
using TS3Client.Commands;
using TS3Client.Full;

public class NowPlaying : ITabPlugin
{
	public void Initialize(MainBot bot) {

	}

	public void Dispose() {

	}
}

Errors:
The type or namespace name 'MainBot' could not be found (are you missing a using directive or an assembly reference?)
The type or namespace name 'ITabPlugin' could not be found (are you missing a using directive or an assembly reference?)

[Flakebi]

It seems like the Plugin-API changed but the wiki article was not updated.
This is how you can create a plugin in the new system:

using System;
using System.Linq;
using TS3AudioBot;
using TS3AudioBot.Plugins;
using TS3Client;
using TS3Client.Commands;
using TS3Client.Full;

public class NowPlaying : IBotPlugin
{
	public Bot bot { get; set; }

	public void Initialize()
	{
		Console.WriteLine("Bot: " + bot.GetInfo());
	}

	public void Dispose()
	{
	}
}

Public properties are automagically set when the plugin is loaded (here).

[dzinks2009]

Thanks, that works. But my plugin still doesn't launch. What I did is add a new class to the Plugins folder. Is that the right way to do it or not?

[Flakebi]

Yes that’s right, then you have to write !plugin list to show all available plugins and !plugin load <plugin id, for example 0> (or unload) to load the plugin.

[dzinks2009]

When I do !plugin list I get

"AudioBot": No plugins found!

[Flakebi]

Hm, it works for me, I have PluginManager::PluginPath=Plugins in configTS3AudioBot.cfg
and the file is in Plugins/plugin.cs (relative to the config file).

[dzinks2009]

Which version do you use?

[Flakebi]

I’m using the current develop branch (commit b529f8e)

[dzinks2009]

PluginManager::PluginPath=Plugins
My "solution" looks like this: https://scr.hu/4XvVmL

Am I doing this wrong?

[Flakebi]

Oh, now I understand.
You do not need to add the plugin files to the solution, you even don’t need to recompile the bot.
You can just put the raw .cs files into a Plugins folder beside the config. The bot will fetch them at runtime (when you say !plugin list) and compile them himself.

[dzinks2009]

OMG! Thanks :D It works.

For others if they're wondering about this:

create a folder called Plugins in the built solution and add your plugins there. Then you can type !plugins list to the bot and load them.

[dzinks2009]

@Flakebi Do you know how I can call this function?

		private void RegisterNotification(string target, ChannelIdT channel)
		{
			var ev = new CommandParameter("event", target.ToLowerInvariant());
			if (target == "channel")
				Send("servernotifyregister", ev, new CommandParameter("id", channel));
			else
				Send("servernotifyregister", ev);
		}

It's located in TS3Client/Query/Ts3QueryClient.cs

[Flakebi]

I guess this is only for the query client (which means the bot does not connect as a normal TS client but as a serverquery) so you probably want to have a look at TS3Client/Full/Ts3FullClient.cs (or e.g. TS3AudioBot/TeamspeakControl.cs.

You can use these classes by adding them as a property:

using System;
using System.Linq;
using TS3AudioBot;
using TS3AudioBot.Plugins;
using TS3Client;
using TS3Client.Commands;
using TS3Client.Full;

public class NowPlaying : IBotPlugin
{
	public Bot bot { get; set; }
	public TeamspeakControl ts { get; set; }

	public void Initialize()
	{
		Console.WriteLine("Bot: " + bot.GetInfo());
		ts.SendChannelMessage("Hi there");
	}

	public void Dispose()
	{
	}
}

[dzinks2009]

Alright, also I found

		private void InvokeEvent(LazyNotification lazyNotification)
			case NotificationType.ServerGroupList: break;

in Ts3FullClient in TS3Client.
Is there a way I can use this?