# Base

## Localization

Whole resource using English localization as default. 

To translate messages follow steps below:

* Move to **Locale** folder of **Advent Season** plugin
* Just make duplicate of EN.yml file. 
* Rename it and write the name of the file into **config.yml**.

#### Example

```yaml
#LocaleFile: EN.yml
Prefix:
  Base: "&5&lAdvent Season &6\u2771"
  ...
```

```yaml
#LocaleFile: SK.yml (Slovak)
Prefix:
  Base: "&5&lAdventná Sezóna &6\u2771"
  ...
```

```yaml
Locale:
  Primary: SK #Previously EN
```

### Multi localization

Plugin is able to hold different localisations at the same time. It’s up to player, which localisation wants to display.

{% hint style="info" %}
Secondary localizations do not have to contain all translations. In case of secondary translation does not contain requested path, the primary file is used to fetch data.
{% endhint %}

```yaml
#config.yml
Locale:
  Primary: EN
  Secondary:
  - SK
  - CZ
  ...
```

## Storage

Space where to save required data.

Supported storages

* `MySQL`
* `SQLite`

If you prefer **MySQL** Storage before **SQLite**, you need to fill variables at **config.yml**.

```yaml
Storage:
  Type: "MySQL"
  Host: "IP"
  Port: 3306
  Database: "db"
  User: "name"
  Password: "*****"
```

{% hint style="warning" %}
There is required that ProfileStorage and this plugin is using the same source of storage!
{% endhint %}

## Automatic updates

At loading of the resource, system checks if new version is released.

If the downloader is enabled, system automatically downloades and updates the resource.

```yaml
UpdateChecker:
  AutomaticDownload: true
```

If disabled, only console message about new version is displayed.

## Analytics

Plugin sends anonymous data such as version of this resource, your server version and addition data of configuration. These data will help me in future development. All requests are asynchronous, so it has no impact on server's performance.

If you don't want to share these data, you can easily disable it.

```yaml
Analytics:
  Active: false
```

### **Data collected from your server about AdventSeason**

```json
{
   "Options":{
      "ChristmasMail":{
         "Activity":true,
         "MailBox":{
            "Capacity":{
               "Extension":2,
               "Default":9
            }
         },
         "Figure":{
            "Particle":{
               "Activity":true
            },
            "Mode":"ARMOR_STAND"
         }
      },
      "SaintNicholas":{
         "Activity":true,
         "Figure":{
            "Particle":{
               "Activity":true
            },
            "Mode":"ARMOR_STAND"
         }
      },
      "Grinch":{
         "Activity":true,
         "Loot":{
            "DefaultProbability":25.0
         },
         "Figure":{
            "Particle":{
               "Activity":true
            },
            "Mode":"ARMOR_STAND"
         }
      },
      "AdventCalendar":{
         "Activity":true,
         "Season":{
            "OpeningTime":"00:00",
            "OpeningType":"STRICT"
         },
         "Reward":{
            "Benefit":{
               "Activity":false
            },
            "DefaultChoiceType":"QUICK__BASE"
         },
         "Figure":{
            "Particle":{
               "Activity":true
            },
            "Mode":"ARMOR_STAND"
         }
      },
      "Economy":{
         "Experience":false,
         "VaultWrapper":false
      },
      "GUI":{
         "WindowItemType":"ICON",
         "WindowOrder":"RANDOM"
      },
      "Carol":{
         "Activity":true,
         "Mode":"AROUND_POINT"
      },
      "Visual":{
         "BossBar":{
            "Activity":true
         },
         "ExtensiveLogging":{
            "Activity":true
         }
      }
   },
   "CarolPlayer":"NONE"
}
```