1. Files configuration
Before beginning the patch preparation, configure the necessary files. There are two files that need to be set up before the Dashboard files can be placed in their target location:
- \Server\ConnectServer\config.ini
- \Client\Data\Local\ServerInfo.bmd (XML)
1.1 ServerInfo.bmd (XML)
Open the ServerInfo.xml and locate the following (supported files version required):
<Dashboard Enabled="0" ExeName="Dashboard.exe" Path="Dashboard" IsNative="1" MainProcessName="main" MemoryShareName="IGCDashBoard" />
- Enabled: Activates or deactivates run of the dashboard, 0/1,
- ExeName: The name of dashboard binary, including file extension,
- Path: Path to the dashboard binary file, relative to the game client root folder. Do not include leading or trailing slashes; this field can be left blank to run the dashboard from the client root,
- IsNative: Set to 1 if using IGC Dashboard, otherwise leave disabled, 0/1,
- MainProcessName: The actual name of the game client binary file, which defaults to "main," excluding the file extension,
- MemoryShareName: A unique name that allows the dashboard and client to share character and server information. Use alphanumeric characters only.
Encode the file to BMD using ToolKit Lite or Premium.
1.2 Config.ini (ConnectServer)
Open the config.ini of ConnectServer and locate the following (supported files version required):
[Dashboard] MemoryShareName = IGCDashBoard DiscordAppID = 0
- MemoryShareName: A unique identifier that enables the dashboard and client to share character and server information. It must match the configuration in ServerInfo.bmd (XML).
- DiscordAppID: Accepts the Discord application ID for purpose of Discord Rich Presence. Requires external configuration as outlined in the Discord documentation, 0 to ignore.
To obtain Discord App ID configured Discord Account and Server/Community is required. Go to https://discord.com/developers/applications and create new application. For detailed guide refer to Discord Documentation.
Short Guide
- Open Discord Application center: https://discord.com/developers/applications
- Click New Application → enter application name, it will be displayed as your Rich Presence main name
- Accept Terms & Conditions → click Create
- Copy Application ID
- Fill other necessary data, such as application description website URL/Legal/Privacy URLs, other as required → click Save Changes
2. Client dashboard patch files
By default, the dashboard files are located in the Dashboard folder, which should be placed in the root directory of the Game Client, alongside main.exe. It might be necessary to modify the location of the dashboard files according to the earlier configuration in ServerInfo.bmd (XML).
Once dashboard files are on its place, locate two files and open them in text editor:
- setting.json
- Strings.xml
setting.json
{ "DashBoardPath": "Dashboard", "RestoreProcessOnClose": true }
- DashBoardPath: Path to the dashboard binary file, relative to the game client root folder. Must match configuration of Dashboard Path in ServerInfo.bmd (XML).
- RestoreProcessOnClose: Determines whether to restore hidden game client processes when the dashboard application is closed. If set to false, the game client window can only be restored by reattaching the game client processes after running the dashboard application. The window_handle.json file cannot be manually modified; if it has been altered, it may be necessary to terminate the game client processes via Task Manager.
Strings.xml
The file contains language strings that can be translated to desired language. Ensure the file encoding is always set to UTF-8. Point particular attention to explanatory comments located in the file. This tutorial will only clarify purpose of selected strings from DISCORD and GENERAL sections.
<General> <String Id="0" Text="Blue MU Server" /> <String Id="1" Text=" died!" /> <String Id="2" Text="The application is running in the background, check your tray." /> <String Id="3" Text="Blue MU - Dashboard" /> </General> <Discord> <String Id="0" Text="Season 19, come play with us!" /> <String Id="1" Text="Part 2-3" /> <String Id="2" Text="SITE" /> <String Id="3" Text="https://mydomain.com" /> <String Id="4" Text="DISCORD" /> <String Id="5" Text="https://discord.gg/AFSDFgdFHG" /> <String Id="6" Text="image_large" /> <!-- Large Image Key --> <String Id="7" Text="Let's go!" /> <!-- Large Image Description --> <String Id="8" Text="Level: " /> <String Id="9" Text="Character: " /> <String Id="10" Text="Part 2-3" /> <String Id="11" Text="Season 19, come play with us!" /> <String Id="12" Text="image_small" /> <!-- Small Image Key --> <String Id="13" Text="Let's go!" /> <!-- Small Image Description --> </Discord>
General
- 0: Server name, title used across multiple places, e.g. Windows Notification Balloon.
- 1: Part of character death notification, placed after character name, e.g. Black Mage died!
- 2: Text that will appear on notification balloon when minimizing the dashboard application before it goes to tray area
- 3: Text that will appear when placing mouse over the tray icon
Discoed
- 0: Rich presence details text to mention
- 1: Rich presence state text to mention
- 2: Label text for website button, can be used for other purpose
- 3: The URL of the website
- 4: Label for Discord Invitation button, can be used for other purpose
- 5: Discord server invitation URL
- 6: A name (key) of image file used for large image avatar in rich presence, can be left blank
- 7: Description text for large image avatar
- 8, 9, 10, 11: Static texts used for purpose of rich presence update notifications
- 12: A name (key) of image file used for small image avatar in rich presence, can be left blank
- 13: Description text for small image avatar
To get valid value for purpose of Discord strings 6 and 12 (large/small image key) go to https://discord.com/developers/applications, edit previously created application and upload the images under Rich Presence → Art Assets tab.
Short Guide
- Open Discord Application center: https://discord.com/developers/applications
- Left click on previously created application
- Open Rich Presence → Art Assets tab
- Copy Application ID
- Under Rich Presence Assets section click Add Image
- The name under the file was uploaded with be a key value for small/large image
Newly uploaded Images may appear under Rich Presence Assets area even after 45 minutes from upload time. Avoid reuploading the files.
You may continue to configure your rich presence by completing all available fields and uploading Invitation Cover Image.
4. Change of Dashboard icon
The binary file icon cannot be changed, however it is possible to override icon visible on the taskbar and system tray. To do this, place an ICO-format icon file with the appropriate name in the root folder of the dashboard.
