This plugin allows you to create customizable UI with multiple tabs. This is useful for providing command help or other server information.
"\n" does not work, create new textline instead. "\t" works for tab indentation. Any UTF8 symbol should work, you just need to put /uXXXX, where XXXX is a UTF-8 symbol code. To display double quote (") in text, use two single quotes (').
The plugin also supports images on pages; see example config for more info.
You may configure a plugin to show info on server join using ShowInfoOnPlayerInit option in config.
Config file is in file: oxide/config/ServerInfo.json. Previous versions of the plugin that user server_info_text.json will be upgraded automatically by the plugin. If you experience any issues with this - please post at plugin's thread.
You may trigger upgrade by changing a config option "UpgradeConfig" to true.
To validate your config, use: JSON Formatter & Validator. Configuration is pretty straightforward: Tabs, text, show on join.
Chat Commands
- /info -- Show available info to self
Text Formatting
The plugin creates a panel with tabs that you define in a config file. Tab consists of a header (tab name), page, and background image(s). One text line takes from button list to right edge of panel."\n" does not work, create new textline instead. "\t" works for tab indentation. Any UTF8 symbol should work, you just need to put /uXXXX, where XXXX is a UTF-8 symbol code. To display double quote (") in text, use two single quotes (').
Formatting Examples
- <color=#ff0000>your text</color> -- Changes text to the color red
- <b>your text</b> -- Changes text to bold formatting
- <i>your text</i> -- Changes text to be italicized
- <size=40>your text</size> -- Changes text font size to 40
The plugin also supports images on pages; see example config for more info.
Configuration
The settings and options can be configured in the ServerInfo file under the config directory. The use of an editor and validator is recommended to avoid formatting issues and syntax errors.You may configure a plugin to show info on server join using ShowInfoOnPlayerInit option in config.
Config file is in file: oxide/config/ServerInfo.json. Previous versions of the plugin that user server_info_text.json will be upgraded automatically by the plugin. If you experience any issues with this - please post at plugin's thread.
You may trigger upgrade by changing a config option "UpgradeConfig" to true.
To validate your config, use: JSON Formatter & Validator. Configuration is pretty straightforward: Tabs, text, show on join.
Global Settings
Note about colors: all colors are formatted in RRGGBBAA format. Wikipedia RRGGBB is for the color hex representation and AA is for alpha channel. Use any color picker of your choice.- "TabToOpenByDefault" : 0 - zero based index of tab to open by default
- "ShowInfoOnPlayerInit" : true - show info window when player joins server
- "Position": {"MinX": 0.15,"MaxX": 0.9,"MinY": 0.2,"MaxY": 0.9} - Position of window
- "BackgroundImage": {"Enabled": false,"Position": {"MinX": 0.0,"MaxX": 1.0,"MinY": 0.0,"MaxY": 1.0},"Url": "Black Backgrounds #6889756","TransparencyInPercent": 100} - position, url and transparency settings for background image.
- "ActiveButtonColor": "#00FFFFFF" - #RRGGBBAA color for active button
- "BackgroundColor": "#000000FF"- #RRGGBBAA color for window background
- "PrevPageButtonColor": "#7F7F7FFF",- #RRGGBBAA color for prev page button
- "NextPageButtonColor": "#7F7F7FFF",- #RRGGBBAA color for next page button
- "CloseButtonColor": "#7F7F7FFF",- #RRGGBBAA color for close button
- "InactiveButtonColor": "#7F7F7FFF",- #RRGGBBAA color for inactive button
- "NextPageText": "Next Page"
- "PrevPageText": "Prev Page"
- "CloseButtonText": "Close"
Per Tab Settings
- _"ButtonText": "First Tab" - _tab button text
- _"HeaderText": "First Tab" - _tab header text
- "TabButtonAnchor": 4 - alignment of text of tab button (values from 0 to 9)
- "OxideGroup": "" - empty string for access to everyone. Otherwise write here group names such as: admin, moderator, owner, vip, whatever
- "TextAnchor": 3, - alignment of text lines of all pages in this tab.
- "TextFontSize": 16, - Default font size for tab text
- "HeaderFontSize": 32, - Header font size
- "HeaderAnchor": 0, - alignment of text of header
- "TabButtonFontSize": 16, - Font size for tab button
- "Pages": - contains pages that may contain text and images
Per Page Settings
- TextLines - list of lines of text that are displayed in this page. Each line - 1 row
- ImageSettings - list of images that appear on the background of page