Muppet GUIs

A mod that can show and remove messages on the screen via GUIs as required. Designed for use with streaming integrations.

While many mods will include GUI alerts for their events, when activating effects via RCON/Stream Integration it is often nice to have some notification text made prominent to viewers of the stream. This mod aims to provide some functions to help with this by allowing GUIs to be created and removed adhoc as desired.

Add Simple Message ===============

A remote call/command to put a message in-game within a GUI to players. Supports options around auto closing or close X button, white or black listing named players from the message, as well as the look and feel of the message. Also includes a timer option to count up/down.

Options

The mandatory option categories are listed below.

| Option Group | Option Name | Mandatory | Value Type | Details | | --- | --- | --- | --- | --- | | audience | logic | mandatory | string | The logic to be applied with the players option to define which connected players see the message. Valid values only, not and all. | | audience | players | special | string[] | An array of players to have the logic applied to. If the logic option is only or not then the players list is mandatory. If the logic option is all then the players list will be ignored and can be either not provided or be nil. | | message | position | mandatory | string | Position on the screen. Valid values top, left, center, aboveCenter, belowCenter. See Notes for details. | | message | fontSize | mandatory | string | The size of the text. Valid values: small, medium, large, huge, massive, gigantic. | | message | fontStyle | mandatory | string | The style of the text. Valid values: regular, semibold, bold. | | message | fontColor | optional | string | The color of the text. See notes for valid list of color options. If not provided or nil the default of white is used. | | message | simpleText | mandatory | string | The text to be shown in the message. To include a timer using its Option Group options see the notes section. | | message | maxWidth | optional | uint | Max width of the message box in pixels. Suggested minimum value is 200 and a large width of 1000. Text will wrap on to multiple lines automatically within the set width. Don't provide the option or set to nil if no max width is desired. Default is no max width and this works fine with shorter messages. | | message | background | optional | string | The background type of the GUI. Either main, contentInnerLight, transparent, brightRed, brightGreen, brightOrange. Defaults to main. | close | timeout | special | uint | Either timeout or xbutton must be specified. If Timeout is provided and greater than 0 the message will auto close after this number of seconds. | | close | xbutton | special | boolean | Either timeout or xbutton must be specified. If XButton is enabled (true) then a close X button will be shown on the top right of the GUI message. | | close | xbuttonColor | optional | string | The color of the close button if its enabled. Either white or black. Defaults to white. |

The optional option categories are listed below. You can either include the Option Group's options or not, based on your usage.

| Option Group | Option Name | Mandatory | Value Type | Details | | --- | --- | --- | --- | --- | | timer | startingValue | mandatory | int | The number of seconds to start the timer at (positive or negative whole number). | | timer | countDirection | optional | string | The direction to count in, either down or up. Defaults to down. | | timer | displayFormat | optional | string | The time unit to format the number as, either second or minute. A value of minute will also show the seconds. Defaults to second. |

They are defined to the command/remote call as an object of Option Group fields. With each option group field being an object of it's fields.

• Format: table<string, table<string, any> >
• Partial example: { audience = {logic="all"} }

Returns

None of the returned values have to be captured in to a variable, unless you actively want to use them.

Values are only returned to Remote Interface calls and not to Factorio Command.

| Returned order number | Details | | --- | --- | | First | The Id of the message created. This can be used when calling to remove a message later on if desired. This is for advanced usage scenarios when you want to remove a GUI prior to it being manually closed or reaching its timeout. |

Notes

• position options are all relative and will be added to the end of any GUIs in that position on the screen. top is along the top of the screen, left to right. left is along the left edge of the screen, top to bottom. center is in the very center middle of the screen (horizontally and vertically), multiple GUIs expand horizontally. aboveCenter is about 1/3 down from the top middle of the screen, multiple GUIs expand horizontally. belowCenter is about 1/3 up from the bottom middle of the screen, multiple GUIs expand horizontally. If other mods add GUIs to the center of the screen then these will stack horizontally to this mod's 3 center position message GUIs.
• fontSize option names correspond to specific font sizes available: small = 12, medium = 16, large = 18, huge = 36, massive = 60, gigantic = 100.
• fontColor options can be found either in the mod files at utility\lists\colors.lua or at the website https://www.rapidtables.com/web/color/html-color-codes.html. The option defaults to the value of white.