Configs & Translations

Search…
Config.syml
The config.syml is the file which Synapse stores all plugin information, even yours.
First of all create a Class which inherit from AbstractConfigSection or IConfigSection and add all fields in it which you need for your Config. Then if you want to explain a certain config inside the config.syml, add the attribute Description to the fields.
Example:
1
using Synapse.Config
2
​
3
namespace FirstPlugin
4
{
5
    public class MyPluginConfiguration : AbstractConfigSection
6
    {
7
        [Description("How long the Broadcast should be shown")]
8
        public ushort broadcastTime { get; set; } = 5;
9
    }
10
}
Copied!
After this add a field to your plugin class and give it the Attribute Synapse.Api.Plugin.Config (optionally you can give the Section a name by adding section = "MySectionName")
Example:
1
using Synapse.Api;
2
using Synapse.Api.Plugin;
3
​
4
namespace FirstPlugin
5
{
6
    [PluginInformation(
7
        Name = "FirstPlugin",
8
        Author = "Dimenzio",
9
        Description = "My First Awesome Plugin", // A Description for your Plugin
10
        LoadPriority = 0
11
        SynapseMajor = 2,
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
        [Config(section = "FirstPlugin")]
19
        public MyPluginConfiguration Config { get; set; }
20
​
21
        public override void Load()
22
        {
23
            Logger.Get.Info("Hello World");
24
            SynapseController.Server.Events.Player.PlayerLeaveEvent += OnLeave;
25
        }
26
​
27
        public void OnLeave(Synapse.Api.Events.SynapseEventArguments.PlayerLeaveEventArgs ev)
28
        {
29
            Map.Get.SendBroadcast(Config.broadcastTime, "A Player left the Server");
30
        }
31
    }
32
​
33
    public class MyPluginConfiguration : AbstractConfigSection
34
    {
35
        [Description("How long the Broadcast should be shown")]
36
        public ushort broadcastTime { get; set; } = 5;
37
    }
38
}
Copied!
The Config fields will be reloaded by Synapse so you don't have to worry needing to update this.
SynapseTranslation
The Synapse Translation system allows you to add multiple translations to your Plugin so that the hoster can easily just choose the one that they want
First of all create a Class which inherit from IPluginTranslation (You can find it in the namespace Synapse.Translation) and add all fields in it which you need for your Translation. Then if you want to explain a certain config inside the translation file, add the attribute Description to the fields.
Example
1
using Synapse.Translation;
2
​
3
namespace FirstPlugin
4
{
5
    public class PluginTranslation : IPluginTranslation
6
    {
7
        public string Broadcast { get; set; } = "A Player left the Server"
8
    }
9
}
Copied!
After this add a field with the type SynapseTranslation<YourTranslationClassHere> to your plugin class and give it the Attribute Synapse.Api.Plugin.SynapseTranslation
Now can you Add Translations of Your Plugin inside the Load method and get the currently Active Translation with .ActiveTranslation
Example:
1
using Synapse.Api;
2
using Synapse.Api.Plugin;
3
using Synapse.Translation;
4
​
5
namespace FirstPlugin
6
{
7
    [PluginInformation(
8
        Name = "FirstPlugin",
9
        Author = "Dimenzio",
10
        Description = "My First Awesome Plugin",
11
        LoadPriority = 0,
12
        SynapseMajor = 2,
13
        SynapseMinor = 7,
14
        SynapsePatch = 0,
15
        Version = "v.1.0.0" //The Current Version of your Plugin
16
        )]
17
    public class PluginClass : AbstractPlugin
18
    {
19
        [Config(section = "FirstPlugin")]
20
        public static PluginConfig Config { get; set; } //It doesn't have to be static but it made it easier to access
21
​
22
        [SynapseTranslation]
23
        public static new SynapseTranslation<PluginTranslation> Translation { get; set; }
24
​
25
        public override void Load()
26
        {
27
            Logger.Get.Info("Hello World");
28
            
29
            PluginTranslation.AddTranslation(new PluginTranslation()); // This Creates the default Translation for English
30
            PluginTranslation.AddTranslation(new PluginTranslation
31
            {
32
                Broadcast = "Ein Spieler hat den Server Verlassen"
33
            }, "GERMAN");
34
            
35
            SynapseController.Server.Events.Player.PlayerLeaveEvent += OnLeave;
36
        }
37
​
38
        public void OnLeave(Synapse.Api.Events.SynapseEventArguments.PlayerLeaveEventArgs ev)
39
        {
40
            Map.Get.SendBroadcast(Config.broadcastTime, Translation.ActiveTranslation.Broadcast);
41
        }
42
    }
43
​
44
    public class PluginConfig : AbstractConfigSection
45
    {
46
        [Description("How long the Broadcast should be shown")]
47
        public ushort broadcastTime { get; set; } = 5;
48
    }
49
    
50
    public class PluginTranslation : IPluginTranslation
51
    {
52
        [Description("The Message that is shown when someones leave")]
53
        public string Broadcast { get; set; } = "A Player left the Server"
54
    }
55
}
Copied!
The new (line 23) is needed in this case Because it prevents from accessing the old Translation System which you could access with plugin.Translation
SYML File's
A Documentation for the SYML will follow in the future
Development - Previous
CustomRoles
Next - Development
MapPoint
Last modified 6mo ago
Copy link
Contents
Config.syml
SynapseTranslation
SYML File's