Getting Started

Search…
Getting Started
In Order to start creating Plugins for Synapse you have to install the SynapseSL Nuget first.                              You can install it (in Visual Studio) by clicking on Project -> Manage NuGet Packages -> Browse -> Type in the search : SynapseSL -> Install.
The First Line of Code
Now that Synapse is installed in your project we can start with developing a Plugin!
In order to do this you must add using Synapse.Api.Plugin at the top of your PluginClass which must inherit Synapse.Api.Plugin.AbstractPlugin and contains the override void Load() method. The Next step is that we add the Attribute Synapse.Api.Plugin.PluginDetails to the head of the PluginClass.
Doing that should resolve in a Plugin that is looking like this:
1
using Synapse.Api;
2
using Synapse.Api.Plugin;
3
​
4
namespace FirstPlugin
5
{
6
    [PluginInformation(
7
        Name = "FirstPlugin", //The Name of Your Plugin
8
        Author = "Dimenzio", // Your Name
9
        Description = "My First Awesome Plugin", // A Description of your Plugin
10
        LoadPriority = 0, //When your Plugin should get loaded (use 0 if you don't know how to use it)
11
        SynapseMajor = 2, //The Synapse Version for which this Plugin was created for (SynapseMajor.SynapseMinor.SynapsePatch => 2.7.0)
12
        SynapseMinor = 7,
13
        SynapsePatch = 0,
14
        Version = "v.1.0.0" //The Current Version of your Plugin
15
        )]
16
    public class PluginClass : AbstractPlugin
17
    {
18
        public override void Load()
19
        {
20
            Logger.Get.Info("Hello World");
21
        }
22
​
23
        //This Method is completely optional and you may not need it.
24
        //It's called whenever Synapse tries to reload all config files inside the system.
25
        public override void ReloadConfigs()
26
        {
27
        }
28
    }
29
}
Copied!
The method Load will be called by Synapse when your plugin gets loaded. (You can add an Logger.Get.Info("Hello World"); to send a "Hello World" to the ServerConsole)
Additional information for more advanced developers: The AbstractPlugin also has the fields for information (PluginInformation) and PluginDirectory (It gives your own working directory).
Next step is to look into:
Events
Hosting - Previous
Keybind System
Next - Development
Events
Last modified 1mo ago
Copy link
Contents
The First Line of Code