By completing this guide, you should be able to create an in-game client Web Interface.
This guide explains how to enable the Web Interface system, create a new Web Interface window, and access it through Game Guides.
Before creating or using any Web Interface window, you must enable the Web Interface feature from the _RefSetting table.
Execute the following SQL query:
UPDATE vPlus.._RefSetting
SET [Value] = 1
WHERE CodeName128 = 'WEB_INTERFACE_ENABLE';
Open the _RefWebInterface table as shown:
CodeName - A unique identifier for the Web Interface.
CaptionStrID - The window title. It must be added to textuisystem.txt.
Width and Height - The resolution of the Web Interface window.
BaseURL - The URL that will be opened inside the game client.
IsActive - Enables or disables the Web Interface. 0 = inactive, 1 = active.
Fill in the parameters, then insert a new row into the _RefWebInterface table:
The only available method to access the Web Interface from the game client is through Game Guides.
Open the _RefGameGuides table as shown:
CodeName - The code name of the Game Guide.
GuideIcon1 - Icon displayed before the animation starts.
GuideIcon2 - Icon displayed after the animation starts.
AnimationTime - Duration of the transition between GuideIcon1 and GuideIcon2.
ActionType - Defines the action type.
ActionData - Data used depending on the selected ActionType.
IsActive - Enables or disables the Game Guide. 0 = inactive, 1 = active.
ActionType values:
1 - Execute procedure
2 - Interface toggle
3 - Open website link
4 - Open Web Interface
ActionData values:
Procedure - Procedure name
Interface toggle - Interface ID from ginterface.txt
Website link - Website URL
Open Web Interface - Web Interface ID from _RefWebInterface
Fill in the parameters, then insert a new row into the _RefGameGuides table:
Add the data to the refgameguides and refwebinterface files, then upload them to:
Media/server_dep/silkroad/textdata/gopro
NOTE: Make sure the IsActive parameter is written as 0 or 1, not true or false.
Each connected character has a unique TokenID stored in the vPlus.._OnlinePlayers table.
When a character opens the Web Interface through the game client, this TokenID is automatically sent within the HTTP request headers.
This allows your website to securely identify the character and interact with in-game data without requiring an additional login.
Congratulations, you have successfully enabled the Web Interface system and created your first Web Interface window.