Pyplanet messages plugin documentation

by teemann (https://github.com/teemann/)

This is an app for pyplanet that enables you to show arbitrary messages on the screen. Those messages can be in the form of

• Text (formatted using $...)

• Images

• Custom partial manialinks

• Periodic chat messages

Text and Images can also link to a website (e.g. Discord link). Of course, custom manialinks also support this feature, you will need to add it to your manialink though.

Configuration

To access the messages dialog, type //messages in the chat (only admin). You will then see a dialog similar to this:

The two columns in this table are

• Type

• Name

which can both be configured in the configuration dialog.

Adding a new message

To add a new message, click the New Button (top-right). This will open another dialog.

Editing an existing message

To edit a message, click the small cog icon for the message. This will open the same dialog that will be opened by clicking New, but it will be filled with the data that was saved before.

Deleting a message

To delete a message, use the small trashcan icon. When clicked, you will be asked if you are sure. Warning: Once deleted, the message cannot be restored.

Configuring a message

The configuration dialog for messages looks like this:

Name

A message should have a name, so you can easily identify it in the messages dialog.

Position

Specifies the position where the message should be shown. The coordinates are the same as used by manialinks. X goes from -160 to 160 (left to right), Y goes from -90 to 90 (bottom to top). Z can be an arbitrary value. Note: Currently, all messages are displayed on top of the other widgets of pyplanet. Z can be used to specify the Z-Order of messages only. Note: This value is not used if type is XML.

Value

This is the value of the message. If the type is Text, this is the text that will be shown. Multiple lines are supported. Formatting is also supported. If the type is Image, this is a URL to an Image that should be shown. If the type is XML, this is a manialink. Internally this will then be wrapped by <frame></frame>. If the type is Chat, value specifies a text that will be sent in the chat periodically.

Type

This can be

• Text

• Image

• XML

• Chat

See Value for an explanation. Note: When using Image you might have to rejoin the server to see the image.

Link

This is only used if the type is either Text or Image. Specifies a link that will be opened when a player clicks on the message. Note: When a player uses the Steam version of the game and the links starts with http(s)://, the link will be opened in the Steam-overlay browser. If http(s):// is omitted, the link will be opened in the standard browser (e.g. Chrome).

Size

This option is only shown and used if the selected type is Image.

Here you can specify the preferred size of the image (in manialink units, so 320x180 equals the size of the screen). The option Keep aspect ratio can be disabled, so the image will be distorted if the wrong dimensions are used.

Periodic chat messages

When there are multiple messages with the type Chat, these will be sent in the chat one after another. The waiting time between messages is always the same. Once the last message was sent, it starts over with the first one again. There is no way of specifying the order in which the chat messages will be sent. Theoretically, the order might even change between restarts of pyplanet.

Configuring the interval

To configure the interval in which the chat messages should be sent, change the setting Messages interval. This can be found in the normal pyplanet settings (//settings). This app will wait the configured time between sending the messages.

Source : https://github.com/teemann/pyplanet-messages