Preset UI apps upon joining the server

Resource & Plugin Area Modding Help
1

I want to create a bunch of ui apps, dashboard, balance, status, etc. But i cant get it to appear upon joining the server, i have to go into the apps menu and enable it manually. Is there a way to have a set of apps or one app that pops open upon connecting? I see some servers using custom ui apps, that toggle each other with buttons, not sure how i can achieve that.

2

You an create your own layout in Client/YourMod/settings/ui_apps/layouts/default/yourlayout.uilayout.json that will have your ui setup, and it will be added to the player’s list of layouts that they can select.

If you want the layout to be selected automatically, i find that the multiplayer.uilayout.json layout is auto-selected when joining a server, so adding your own Client/YourMod/settings/ui_apps/layouts/default/multiplayer.uilayout.json will overwrite that one and be the default layout on join.

3

You are correct in how to get a UI layout applied but PLEASE do not overwrite the original multiplayer one, it could cause issues when users try to join other servers.

Instead create your own and then select it once the user has finished loading into the session.

4

After looking through the discord, the correct way is adding a layout file to YourMod/settings/ui_apps/layouts/default/yourlayout.uilayout.json using multiplayer.uilayout.json as a template, changing type to yourlayout and then in your mod running

function M.onWorldReadyState(state)
    if state == 2 then
        core_gamestate.setGameState('multiplayer', 'yourlayout', 'multiplayer')
    end
end