Creating Plug-ins

[Eagle]

Its possible to add your own class library (.NET assembly) to FLAC which can recieve server notifications and is able to send its own events. Which notifications and events are available can be found in the documentation found in this section. These help pages are updated automatically when new features become available.

I've created an example project to demonstrate how you can receive notifications and send your own events. Binaries required to build your own assembly are included in this project, latest versions can be downloaded from the binaries thread.

PlugIn example project

The way this project is setup will allow you to use the resulting assembly not only in the current version of FLAC, but all builds after that. No need to rebuild your own plugins with each release, which will make distribution to others interrested in the plugin functionality a viable option.

The build assembly can be loaded in FLAC by adding a new file to the My Docs\FLAntiCheat folder with the name: DynamicAssemblies.xml
Multiple plugins can be added, simply add another plugin tag to plugins. The content of this file for including the example class library is as follows:


<?xml version="1.0" encoding="utf-8"?>
<dynamic_assemblies xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <plugins>
    <plugin assembly="C:\FlacPlugins\FlacPlugIn.Example.dll" listener="FlacPlugIn.Example.NotificationHandler" />
  </plugins>
</dynamic_assemblies>


Note!
FLAC loads the plugins on startup, if you make changes to the config file or plugin itself... make sure you restart FLAC to use/test these changes.

[Unicornz]

mmm i thought yours would be avail for download eagle ?

[Eagle]

It is, in the news section of the FLAC forum

[Unicornz]

i'm going blind m8 sorry

[Unicornz]

tried building the example, built ok, added to the repective file and it works now i need to learn what can be done and how todo it..

simple things first, anyone got any pointers

[bulldogg]

i first started by looking at making a custom command to send some preset text to a player, for me it was some server rules,

so i used PrivateChat.Fire(user, string.Format("TEXT")); to send text to the player using the command, thats pretty much as simple as it gets. if you wanted to make something like this take a look at the suicide example

youd rename the internal class to something such as rules and the public class to rules aswell. change the description and replace whats inside

public override void Execute(Player user, string parameters) {

}

with the code to send a private message to a player which would be PrivateChat.Fire(user, string.Format("TEXT"));

build and test. from there i went to getting it to read the rules from a file allowing admins to change the rules to their server rules

have a read of the documentation www.xs4all.nl/~marends/documentation/ it really helped me alot

[Eagle]

See if you understand all that has been included in the example, and when you do you could have a look at the EagleWare.Libraries.FLServerCommunications.Events and EagleWare.Libraries.FLServerCommunications.Notifications namespaces in the documentation to see what else is available. Let me know how you're progressing

[Unicornz]

build and test. from there i went to getting it to read the rules from a file allowing admins to change the rules to their server rules

i cant find anything telling me how to read from a file though and for what i have in mind i need to find this first

[Eagle]

You'll find all you need here, also if you google for .NET in combination with file reading or whatever else you might need, you're sure to find tutorials concerning