Discord

Welcome to WBUI2!

This mod is a "rework" of the popular mod "Editable Server UI (WBUI)" from ASE.

The mod gives you the ability to show rules, settings, upcoming events or general information about your server.

besides displaying useful informations to your players it gives you the ability to add buttons, which directly open the browser to your community website, support discord or to the ASE website so your players are always up to date with one click away directly from the game!

Please note that this mod is still in the development stage and you may encounter bugs.

Settings

INI Settings

INI Header:
[WBUI2]

  • JsonURL="URL" (Default: "https://pastebin.com/raw/rB8NFyDV") - If you don't use INI, you have to host the file as "raw" somewhere and enter the URL wrapped in double quotes. You can use services like Pastebin ( https://pastebin.com ). After uploading the file, you'll find a button called "raw." Click the button and copy the URL.

JSON Settings:

  • OpenButton: 0/1/2/3/4/5/6 (Default: 0) - Determines the button the player needs to press to open the UI.
    • 0=F1, 1=F2, 2=F3, 3=F4, 4=F5, 5=Delete, 6=Home
  • HideIcon: true/false (Default: false) - If true the icon in the bottom left corner vanishes after some time.
  • HideIconAfter: Integer (Default: 60) - Determines after how many seconds the icon vanishes.
  • IconURL: "URL" (Default: "https://i.imgur.com/OZ6xOjY.png") - You can upload a custom image somewhere ( https://imgur.com ), and it will be used as the icon in the bottom left.
  • DisableIconText: true/false (Default:false) - If true the text "F1 for Info" will not be displayed.
  • IconPosition: 0/1/2/3 (Default:0) - Set the position of the Icon.
    • 0=Top Left, 1=Top Right, 2=Bottom Right, 3=Bottom Left.
  • IconTextColor: 0/1/2/3/4/5/6/7/8 (Default: 0) - Sets the color of the "F1 For Info" text.
    • 0=Light Blue, 1=Red, 2=Green, 3=Blue, 4=Yellow, 5=Orange, 6=Violet, 7=Black, 8=White
  • OpenOnStart: true/false (Default: true) - If true the UI will open automatically after the player spawns.
  • OpenOnStartOnlyNewPlayers: true/false (Default: true) - If true the UI only opens automatically the first time the player spawns on the server.
  • UpdateInterval: Integer (Default: 12) - This value determines the time in hours the mod automatically pulls the JSON from the URL to update settings.

General information:

  • For the rest of the settings, please check out the example JSON linked here ( https://pastebin.com/bT9WVwqK ).
  • To pass the JSON validation, use "\n" to generate newlines. Although the mod should handle regular newlines just fine.
  • Special characters like double quotes have to be escaped with a "\".
  • Be careful with the file size of the images. The server has to download them every time the server starts and when it updates the JSON. Additionally, the server has to transfer them to the client.
  • You can add as many tabs and links as you want. you just have to follow the syntax. At some point it just wont fit anymore.
  • You can trigger an update of the JSON via console command: cheat scriptcommand WBUI2 update

CF

Welcome to WBUI2

This mod is a "rework" and port of the popular mod "Editable Server UI (WBUI)" from ASE.
The mod gives you the ability to show rules, settings, upcoming events or general information about your server.

Besides displaying useful informations to your players it gives you the ability to add buttons, which directly open the browser to your community website, support discord or to the ASE website, so your players are always up to date with one click away directly from the game!

Please note that this mod is still in the development stage and you may encounter bugs.

Settings

INI Settings

INI Header:

[WBUI2]

  • JsonURL="URL" (Default: "default-json") - You have to host the file as "raw" somewhere and enter the URL to it wrapped in " ". You can use pastebin.com. After uploading the file you'll find a button called "raw". click the button and copy the URL. Or use any other hosting site which offers linking to a raw JSON output.

JSON Settings

  • OpenButton: 0/1/2/3/4/5/6 (Default: 0) - Determines the button the player needs to press to open the UI. 0=F1, 1=F2, 2=F3, 3=F4, 4=F5, 5=Delete, 6=Home
  • HideIcon: true/false (Default: false) - If "true," the icon in the top left corner vanishes after some time.
  • HideIconAfter: Integer (Default: 60) - Determines after how many seconds the icon vanishes.
  • IconURL: "URL" (Default: "default-icon") - You can upload a custom image somewhere ( "imgur" ), and it will be used as the icon in the top left.
  • DisableIconText: true/false (Default:false) - If true the text "F1 for Info" will not be displayed.
  • IconPosition: 0/1/2/3 (Default:0) - Set the position of the Icon.
    0=Top Left, 1=Top Right, 2=Bottom Right, 3=Bottom Left
  • IconTextColor: 0/1/2/3/4/5/6/7/8 (Default: 0) - Sets the color of the "F1 For Info" text.
    0=Light Blue, 1=Red, 2=Green, 3=Blue, 4=Yellow, 5=Orange, 6=Violet, 7=Black, 8=White
  • OpenOnStart: true/false (Default: true) - If true, the UI will open automatically after the player spawns.
  • OpenOnStartOnlyNewPlayers: true/false (Default: true) - If true, the UI only opens automatically the first time the player spawns on the server.
  • UpdateInterval: Integer (Default: 12) - This value determines the time in hours the mod automatically pulls the JSON from the URL to update settings.

General Information:

  • For the rest of the settings, please check out the example JSON linked here ( example-JSON ).
  • To pass the JSON validation, use "\n" to generate newlines. Although the mod should handle regular newlines just fine.
  • Special characters like double quotes have to be escaped with a "\".
  • Be careful with the file size of the images. The user have to download the images.
  • You can trigger an update of the JSON via console command: cheat scriptcommand WBUI2 update

Join my Discord if you need further help

Edit Report
Pub: 05 Nov 2023 07:39 UTC
Edit: 05 Nov 2023 07:44 UTC
Views: 16