config.yml¶

config.yml represents basic configuration of plugin. Player caching, database management and fallback motd are here.

Table of Contents

settings
database
- type
- mysql
- sqlite

settings ¶

settings:
  animations:
    default:
      dynamic: generic_dynamic
      static: generic_static
    host.macizun.me:
      dynamic: generic_dynamic
      static: generic_static
  caching:
    time: 604800000
    parts:
      face: 'http://cravatar.eu/avatar/<player value="name">/64.png'
  fallback:
    motd: "This is the fallback MOTD It will be used: \nWhen the duration is reached, or an animation fails"
    favicon: favicon.png
    #status-bar: "&7Players: {server:onlineplayers}/{server:maxplayers}" #Uncomment if you want custom status-bar on failsafe
    player-sample:
    - "&7Here is the static player sample"
    - "&7It is &ac&bo&cl&1o&2r&3a&db&el&4e"
    - "&7One frame only"
  debug: false
  max-connections-per-ip: 5
  formatting:
    time-format: '{0} days {1}:{2}:{3}'
    date-format: 'MM-dd-yyyy h:mm a'

animations ¶

Warning

Do not remove default key You can assign STATIC variable to dynamic field, but never DYNAMIC to static.

This section holds list of animations assigned to forced hosts.
    default:
      dynamic: generic_dynamic
      static: generic_static
    host.macizun.me:
      dynamic: generic_dynamic
      static: generic_static

caching ¶

  caching:
    time: 604800000
    parts:
      face: 'http://cravatar.eu/avatar/<player value="name">/64.png'
time

Specify time after which cache files will be regenerated for certain players

parts

Note

Removing parts will result in no caching, so your best bet if you are not using player parts is just to remove it.

Key is used for file name and <player> variable in animation

fallback ¶

  fallback:
    motd: "This is the fallback MOTD It will be used: \nWhen the duration is reached, or an animation fails"
    favicon: favicon.png
    #status-bar: "&7Players: {server:onlineplayers}/{server:maxplayers}" #Uncomment if you want custom status-bar on failsafe
    player-sample:
    - "&7Here is the static player sample"
    - "&7It is &ac&bo&cl&1o&2r&3a&db&el&4e"
    - "&7One frame only"
This section holds fallback motd that is being sent to clients under specific circumstances:

Animation passes duration threshold

Connection exceeds see max-connection-per-ip

Connection address is specified in blacklist.yml

motd

It is basically a description, it contains two lines (they have to be separated with n though)

favicon

Warning

Don’t put animated icon, it will not work.

Favicon that will be displayed next to fallback motd.

status-bar

Warning

Uncommenting status-bar will result in red cross in fallback motd.

Status bar is a line displayed on player count slot.

player-sample

Warning

Player sample will display x and more.. if status-bar is disabled

Holds list of strings displayed when client hovers over status-bar.

debug ¶

  debug: false
This boolean will help you determinate what ips are pinging your server. It’s especially helpful for looking for server list’s ips.

max-connection-per-ip ¶

Warning

Don’t go lower than 1, it will cause your animatedmotd to stop working.
  max-connections-per-ip: 5
This variable prevents abuse regarding bandwidth usage, connections exceeding this limit will be given see fallback motd.

formatting ¶

  formatting:
    time-format: '{0} days {1}:{2}:{3}'
    date-format: 'MM-dd-yyyy h:mm a'
Formatting is used for formatting countdowns and some bukkit sided variables.

time-format

Is used for countdowns where {0} are days, {1} hours, {2} minutes and {3} seconds

date-format

Is used for bukkit variables: first-played and last-played

database ¶

Database is used for storing player data for DYNAMIC animations. Currently AnimatedMOTD supports sqlite, flatfile and mysql.

database:
    type: sqlite
    mysql:
      host: localhost
      port: 3306
      username: user
      password: pass
      database: animatedmotd
    sqlite:
      file: players.db

type ¶

    type: sqlite
There are three options available:

sqlite (default)

mysql

flatfile - May be the fastest

none - Completely disables database, if you are not using DYNAMIC animations it will speed up things for you.

Plugin will automatically create tables for your database.

mysql ¶

Warning

Specyfing wrong connection details may cause lag or unexpected breakage.
    mysql:
      host: localhost
      port: 3306
      username: user
      password: pass
      database: animatedmotd
If you want to use mysql you probably know how to set this up.

sqlite ¶

    sqlite:
      file: players.db
Sqlite is a reliable and fast flat-file database.

file

If for whatever reason you want to change file where player data is stored you can change it here.