lancommander-ref/MHServerEmu
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add LiveLoadingTips documentation and example

Browse source
This commit is contained in:
Crypto137 2023-10-20 19:08:40 +03:00
parent e39735c9e1
commit 6a808f2791
5 changed files with 95 additions and 47 deletions
Download patch file Download diff file Expand all files Collapse all files

7
assets/LiveLoadingTips.xml Normal file
View file

@ -0,0 +1,7 @@
<LoadingTips Version="1" Date="2017-11-27">
<Tip Name="LiveTipsHelp">
<Priority>true</Priority>
<Enable>true</Enable>
<Locale(en_us)>You can change what is displayed here by editing LiveLoadingTips.xml.</Locale(en_us)>
</Tip>
</LoadingTips>

23
docs/Constants.md Normal file
View file

@ -0,0 +1,23 @@
# Constants
This file lists various constants used by the client.
## Locale Website Codes
- en_us
- zh_tw
- fr_fr
- de_de
- ja_jp
- ko_kr
- pt_br
- ru_ru
- es_mx

2
docs/Index.md
View file

@ -16,6 +16,8 @@ If you would like to help with the development, here are some resources you can
- [ClientLaunchParameters.md](./ClientLaunchParameters.md) - lists various launch parameters that you can use when running the client (such as enabling verbose logging).
- [Constants.md](./Constants.md) - lists various constants used by the client.
For specific topics see these:
- [ClientConfig.md](./ClientConfig.md) - ClientConfig.xml file structure.

16
docs/SetupAdvanced.md
View file

@ -45,3 +45,19 @@ The client uses an embedded web browser for some of its UI panels. MHServerEmu p
Restart the server, and you should be able to see an example store home page when you open the in-game store. You can set other pages by editing various url options in `Config.ini` (e.g. `NewsUrl` to change the content of the news window). For more information on the embedded browser see [EmbeddedBrowser.md](./EmbeddedBrowser.md).
Please note that the embedded browser is a 2014 version of the Chromium Embedded Framework (CEF), and using for general web browsing brings with it major security risks. You should use it only for displaying the content you trust.
## Setting Up Live Tips
The client can download additional loading screen tips from the server.
1. Copy the [LiveLoadingTips.xml](./../assets/LiveLoadingTips.xml) file provided in this repository to `Apache24\htdocs`.
2. Set `EnableLiveTips` and `EnableLiveTipsDownloader` in `SiteConfig.xml` to `true`.
3. Set `LoadScreenTipsURL` in `SiteConfig.xml` to `http://localhost/LiveLoadingTips.xml`.
4. (Optional) Adjust `LiveTipsQueryInterval` in `SiteConfig.xml` to your preferred query interval (by default the client queries new tips every 15 minutes).
5. Edit `LiveLoadingTips.xml` to add your own tips.
For tips to actually show up they need to have text matching the client's locale. For a list of locale website codes see [Constants.md](./Constants.md). The client updates tips only when the `Date` attribute of the root node of LiveLoadingTips.xml is different from the previous update.

94
docs/SiteConfig.md
View file

@ -8,53 +8,53 @@ Early versions of the game cannot start without a SiteConfig. You can work aroun
The fields and their default values are embedded in the executable. Some fields have alternate values from an archived test center SiteConfig.
| Name | Type | Default Value | Note |
| ----------------------------------- | ---- | ------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
| AuthServerAddress | str | auth.marvelheroes.com | Archived value: auth.testcenter.marvelheroes.com |
| AuthServerUrl | str | /AuthServer/Login/IndexPB | |
| AuthServerTicketUrl | str | | |
| AuthServerPort | str | 443 | Always 443 in Shipping builds |
| CrashReportHost | str | hq-gar-dev01 | Archived value: auth.testcenter.marvelheroes.com |
| CrashReportUrl | str | /MinidumpWebService/Home/ProcessPostedDump | Archived value: /CrashDumpFrontend/Multipart/ProcessCrashReport |
| CrashReportPort | int | 80 | |
| VerifyFailureHost | str | localhost | Archived value: hq-sis01-qa01.hq-california.com |
| VerifyFailureUrl | str | / | Archived value: /CrashDumpFrontend/Multipart/ProcessVerifyReport |
| VerifyFailurePort | int | 80 | |
| ReportSuggestionHost | str | hq-gar-dev01 | Archived value: auth.testcenter.marvelheroes.com |
| ReportSuggestionUrl | str | /BugAndFeatureWebService/NewSuggestion | |
| ReportSuggestionPort | int | 80 | |
| OnCloseUrl | str | | |
| OnCloseUrlSteam | str | | |
| AccountWebsiteUrl | str | https://www.marvelheroes.com | |
| AccountRegistrationUrl | str | https://login.marvelheroes.com/registration.php?pcode= | |
| SteamAccountRegistrationUrl | str | https://login.marvelheroes.com/registration.php?pcode=steam | |
| SteamMicroTransactionCompleteHost | str | partner.marvelheroes.com | Beta 1.9 value: hq-gar-dev01 |
| SteamMicroTransactionCompletePort | int | 443 | |
| SteamMicroTransactionCompleteUrl | str | /steam/finalize | Beta 1.9 value: /echowebservice |
| SteamMicroTransactionCompleteUseSsl | bool | true | |
| DriverUpdateURL | str | https://marvelheroes.com/support/drivers | |
| AllowNonSteamStoreInSteamBuild | bool | false | |
| InGameHelpURL | str | https://d5.parature.com/ics/support/default.asp?deptID=15144 | |
| LowMemoryURL | str | https://forums.marvelheroes.com/discussion/comment/1179527/#Comment_1179527 | |
| ForgotPasswordURL | str | https://login.marvelheroes.com/forgotpassword.php | |
| VerifyEmailURL | str | https://login.marvelheroes.com | |
| ChangePasswordURL | str | https://login.marvelheroes.com/dashboard/changepassword.php | |
| EnableLiveTips | bool | false | |
| EnableLiveTipsDownloader | bool | false | |
| LoadScreenTipsURL | str | http://cdn.marvelheroes.com/marvelheroes/liveloadingtips.xml | |
| LiveTipsQueryInterval | int | 15 | |
| ConfirmEmailFAQ | str | https://d5.parature.com/ics/support/default.asp?deptID=15144 | |
| YouTubeVideoPlayer | str | http://storecdn.marvelheroes.com/cdn/youtubePlayer.html?videoId=%S&height=%d&width=%d&protoId=%S | |
| YouTubeVideoPlayerPlaylist | str | http://storecdn.marvelheroes.com/cdn/youtubePlayer.html?playlist=%S&height=%d&width=%d&protoId=%S | |
| BinkMovieUrl | str | http://storecdn.marvelheroes.com/cdn/videos/%s | |
| EnabledLocales | str | chi.all;deu.all;eng.all;fra.all;jpn.all;kor.all;por.all;rus.all;sg1.all;sg2.all;sg3.all;spa.all | |
| LoginDownloadURL | str | | |
| LoginStreamURL | str | | |
| CatalogDownloadHost | str | | |
| ServerStatusUrlPC | str | https://marvelheroes.com/status/PC | Added in 1.53 |
| ServerStatusUrlPS4 | str | https://marvelheroes.com/status/PS4 | Added in 1.53 |
| ServerStatusUrlXBoxOne | str | https://marvelheroes.com/status/XBOXONE | Added in 1.53 |
| ServerStatusMessageUrl | str | https://marvelheroes.com/platform | Added in 1.53 |
| Name | Type | Default Value | Note |
| ----------------------------------- | ---- | ------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| AuthServerAddress | str | auth.marvelheroes.com | Archived value: auth.testcenter.marvelheroes.com |
| AuthServerUrl | str | /AuthServer/Login/IndexPB | |
| AuthServerTicketUrl | str | | |
| AuthServerPort | str | 443 | Always 443 in Shipping builds |
| CrashReportHost | str | hq-gar-dev01 | Archived value: auth.testcenter.marvelheroes.com |
| CrashReportUrl | str | /MinidumpWebService/Home/ProcessPostedDump | Archived value: /CrashDumpFrontend/Multipart/ProcessCrashReport |
| CrashReportPort | int | 80 | |
| VerifyFailureHost | str | localhost | Archived value: hq-sis01-qa01.hq-california.com |
| VerifyFailureUrl | str | / | Archived value: /CrashDumpFrontend/Multipart/ProcessVerifyReport |
| VerifyFailurePort | int | 80 | |
| ReportSuggestionHost | str | hq-gar-dev01 | Archived value: auth.testcenter.marvelheroes.com |
| ReportSuggestionUrl | str | /BugAndFeatureWebService/NewSuggestion | |
| ReportSuggestionPort | int | 80 | |
| OnCloseUrl | str | | |
| OnCloseUrlSteam | str | | |
| AccountWebsiteUrl | str | https://www.marvelheroes.com | |
| AccountRegistrationUrl | str | https://login.marvelheroes.com/registration.php?pcode= | |
| SteamAccountRegistrationUrl | str | https://login.marvelheroes.com/registration.php?pcode=steam | |
| SteamMicroTransactionCompleteHost | str | partner.marvelheroes.com | Beta 1.9 value: hq-gar-dev01 |
| SteamMicroTransactionCompletePort | int | 443 | |
| SteamMicroTransactionCompleteUrl | str | /steam/finalize | Beta 1.9 value: /echowebservice |
| SteamMicroTransactionCompleteUseSsl | bool | true | |
| DriverUpdateURL | str | https://marvelheroes.com/support/drivers | |
| AllowNonSteamStoreInSteamBuild | bool | false | |
| InGameHelpURL | str | https://d5.parature.com/ics/support/default.asp?deptID=15144 | |
| LowMemoryURL | str | https://forums.marvelheroes.com/discussion/comment/1179527/#Comment_1179527 | |
| ForgotPasswordURL | str | https://login.marvelheroes.com/forgotpassword.php | |
| VerifyEmailURL | str | https://login.marvelheroes.com | |
| ChangePasswordURL | str | https://login.marvelheroes.com/dashboard/changepassword.php | |
| EnableLiveTips | bool | false | If this is enabled and EnableLiveTipsDownloader is disabled, the client loads live tips from DefaultLoadingScreenTips.xml in its config directory. |
| EnableLiveTipsDownloader | bool | false | |
| LoadScreenTipsURL | str | http://cdn.marvelheroes.com/marvelheroes/liveloadingtips.xml | |
| LiveTipsQueryInterval | int | 15 | In minutes |
| ConfirmEmailFAQ | str | https://d5.parature.com/ics/support/default.asp?deptID=15144 | |
| YouTubeVideoPlayer | str | http://storecdn.marvelheroes.com/cdn/youtubePlayer.html?videoId=%S&height=%d&width=%d&protoId=%S | |
| YouTubeVideoPlayerPlaylist | str | http://storecdn.marvelheroes.com/cdn/youtubePlayer.html?playlist=%S&height=%d&width=%d&protoId=%S | |
| BinkMovieUrl | str | http://storecdn.marvelheroes.com/cdn/videos/%s | |
| EnabledLocales | str | chi.all;deu.all;eng.all;fra.all;jpn.all;kor.all;por.all;rus.all;sg1.all;sg2.all;sg3.all;spa.all | |
| LoginDownloadURL | str | | |
| LoginStreamURL | str | | |
| CatalogDownloadHost | str | | |
| ServerStatusUrlPC | str | https://marvelheroes.com/status/PC | Added in 1.53 |
| ServerStatusUrlPS4 | str | https://marvelheroes.com/status/PS4 | Added in 1.53 |
| ServerStatusUrlXBoxOne | str | https://marvelheroes.com/status/XBOXONE | Added in 1.53 |
| ServerStatusMessageUrl | str | https://marvelheroes.com/platform | Added in 1.53 |
## Removed Fields