TBA

Incoming

List of packets coming into the Venice Unleashed client from the WebUI (WebUI to client, client handles these packets)

Testing

Incoming packets can be tested using the Venice Unleashed UI debugger or using the Venice Unleashed integrated debugger for WebUI.

Using the integrated debugger (recommended)

Note: You can view on how to enable and use the Venice Unleashed WebUI debugger on their documentation page.

1. Launch a game using the -dwebui flag and open the debugger located on 127.0.0.1:8884
2. Join a server having fun-bots enabled and running and open the fun-bots debugger.
3. The console is automatically opened upon opening the debugger.

Functions

Function	Description
FUI_SEND(packetId: string, packetData: JSON)	Simulate the web page sending a JSON packet to the Venice Unleashed client. This packet can be viewed in the Venice Unleashed game console.

Using webbrowser

Open the WebUI/index.html using a browser (Chromium based browser recommended) and open the F12 console.

Functions

Function	Description
FUI_SEND(packetId: string, packetData: JSON)	Simulate the web page sending a JSON packet to the Venice Unleashed client. The result of this function cannot be tracked due it not being able to be received by the client.

List

BLA BLA BLA

Packet ID	Structure	Description	Note
PONG	Content Cell	T	-
TOGGLE_UI	{status: bool}	Show or hide the UI	Used in function ShowLargeUI. Identical for outgoing

Outgoing

BLA BLA BLA

List

BLA BLA BLA

Packet ID	Structure	Description	Note
TOGGLE_UI	{status: bool}	Show or hide the UI	Identical for incoming
SHOW_NOTIFICATION	See: SHOW_NOTIFICATION	Show a notification on the screen	-
SHOW_ALERT	See: SHOW_ALERT	Show a dialog box on the screen	-

SHOW_NOTIFICATION

This will show a notification above all other elements on the user's screen.

Body

Key	Type	Description	Note	Required
uuid	UUID	Unique ID for notification	Used to alter an existing alert	Yes
text	string	Text to show on the alert	-	Yes
expiration	long	Time in milliseconds before the notification disappears, if -1 it'll stay on there forever (can be removed using the UUID later)	-	Yes
icon	icon object	See icon object	-	No

Example:

{uuid = MathUtils:RandomGuid(), text = "Example demo", expiration = 5000, icon = {icon = "fas-fa-user", color = "success", animation = "rubberBand"}}

Icon object

Used to show icon next-to notification, if null it will show no icon next-to the notification.

Key	Type	Description	Required
icon	string	A font-awesome icon (eg. "fas fa-user")	Yes
color	string	A valid color	No
animation	string	A valid attention seeker animate.css name	No

Example: {icon = "fas-fa-user", color = "success", animation = "rubberBand"}

SHOW_ALERT

This will show an alert box with options for the user to select.