DUXPLIMA Documentation

Concepts

What a client asks for, entries, colour roles, the two platforms, and languages on the server list.

The ping

A client that shows a server in its list sends a ping. The answer carries the description (two lines), the icon, the online and maximum counts, a list of names for the hover, and a protocol version and name. uxmMOTD builds every part of that answer.

flowchart LR
  C[Client server list] -->|ping| S[Proxy or server]
  S --> E{Maintenance?}
  E -- on --> M[maintenance entry, hover, icon]
  E -- off --> R[Next entry by rotation]
  R --> A[Lines, icon, counts, hover]
  M --> A
  A --> C

Entries

An entry is two lines and an optional icon. motd.entries is a list of them and motd.rotation picks one per ping. Maintenance has one entry of its own.

Roles, not colours

A line names a role such as <value>, <good> or <accent>; the colour behind each role is in theme.conf. One edit there repaints every line of every UXM plugin.

Two platforms

PaperVelocity
AnswersPings to this serverPings to the whole network
Maintenance gateAt login, before the player existsAt login on the proxy
Bypass permissionNot available: only the exempt listsuxmmotd.maintenance.bypass
Kick screen languageThe server's default languageThe player's
PermissionsDeclared with defaultsNo defaults: the console may run everything, a player needs the node

Languages

The server list entry is your own writing in config.conf, in whatever language you write it. The message files hold the command replies and the maintenance kick screen.

Related: Your first entry, Entries