DUXPLIMA Documentation

Concepts

The sixteen colours, solid and cycling glows, how a glow is drawn, and why it is global.

Sixteen colours

A client draws an outline in one of sixteen colours and no other. Each has an id and a node:

IdNameNode
blackBlackuxmglow.colour.black
dark_blueDark Blueuxmglow.colour.dark_blue
dark_greenDark Greenuxmglow.colour.dark_green
dark_aquaDark Aquauxmglow.colour.dark_aqua
dark_redDark Reduxmglow.colour.dark_red
dark_purpleDark Purpleuxmglow.colour.dark_purple
goldGolduxmglow.colour.gold
grayGrayuxmglow.colour.gray
dark_grayDark Grayuxmglow.colour.dark_gray
blueBlueuxmglow.colour.blue
greenGreenuxmglow.colour.green
aquaAquauxmglow.colour.aqua
redReduxmglow.colour.red
light_purpleLight Purpleuxmglow.colour.light_purple
yellowYellowuxmglow.colour.yellow
whiteWhiteuxmglow.colour.white

A colour's name is its id written out, the same in every language.

Three modes

ModeWhat the player sees
OffNo outline
SolidOne colour
CycleTwo to eight colours in turn, each held for the player's interval

A player has one mode at a time. Choosing a colour replaces a cycle; starting a cycle replaces a colour.

How a glow is drawn

The client takes the outline's colour from the colour of the scoreboard team that holds the player's name. uxmLib owns that team and composes it from what each plugin contributes, so a chat tag and a glow live on one name. uxmGlow contributes a colour and nothing else.

Two things follow:

  • The colour is global. Every viewer sees the same one.
  • A name carries one colour. When two plugins both want it, the one that asked last wins and the other is named in the log once.

Remembered and checked

The choice is stored. At join it is read again and every colour in it is checked against the player's nodes: a colour they no longer hold is not restored, and they read glow.lapsed. That is what makes a colour that came with a rank leave with it.

One clock

One shared task drives every cycling player, waking every cycle.tick-ms. The cost grows with the number of cycling players, not with the number of colours. A player's interval is rounded up to the next multiple of the tick.

Related: Colours and cycles, Permissions