lancommander-ref/MHServerEmu
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
MHServerEmu/docs/Setup/AdvancedSetup.md
Crypto137 126640ce88 Add locale documentation
2023-11-16 04:57:03 +03:00

4.5 KiB
Raw Blame History

Advanced Setup

Below are some of the more advanced setup topics you might be interested in. For first-time setup instructions please see Initial Setup.

Enabling Accounts

By default the BypassAuth option in Config.ini is enabled. This makes the server accept any login information and always use a stub account, which is not ideal for anything beyond basic single player testing. To be able to save data and have multiple clients able to connect you need to disable BypassAuth and set up accounts.

You can create and manage accounts by using ! commands in the server console or the in-game chat window. Here are some commands to get you started:

  • !account create [email] [playerName] [password] - creates a new account with the specified email, player name, and password. Email and player name must be unique for each account.

  • !account userlevel [0|1|2] - sets user level for the specified account to user (0), moderator (1), or admin (2). Higher user levels enable additional in-game command privileges, up to being able to manage other accounts and shut down the server.

  • !account password [email] [newPassword] - changes password for the specified account.

For a more in-depth list of commands see Server Commands or type !commands.

Setting Up Remote Connections

To allow remote clients to connect to your server you need to set up your Apache to function as a reverse proxy server.

  1. Add ProxyPass /AuthServer http://localhost:8080 and ProxyPassReverse /AuthServer http://localhost:8080 to httpd-ssl.conf, similar to how you have added Rewrite lines during the initial setup.

  2. Create a copy of your SiteConfig.xml in Apache24\htdocs and replace the AuthServerAddress value in it with your server's public IP address or domain name.

  3. Replace BindIP in Config.ini with your local IP address or 0.0.0.0. This has to be an IP address and not domain name.

  4. Replace PublicAddress in Config.ini with your public address (this can be an IP address or a domain name, like in SiteConfig.xml).

After doing the above steps you can connect to the server remotely by either editing ClientConfig.xml on the client's machine or launching the game with the following parameter: -siteconfigurl=yourserveraddress.com/SiteConfig.xml. To connect to the server from the same machine it is being hosted on you need to use the original SiteConfig.xml that points to localhost.

Please keep in mind that MHServerEmu is experimental software still heavily in development, and hosting a publicly available server on the Internet brings with it potential security risks.

Setting Up In-Game Store and News

The client uses an embedded web browser for some of its UI panels. MHServerEmu provides some options that allow you to make use of this feature.

  1. Copy the mhgame_store_home folder provided in this repository to Apache24\htdocs.

  2. Set OverrideStoreUrls in Config.ini to true.

  3. Set StoreHomePageUrl in Config.ini to http://localhost/mhgame_store_home.

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 Embedded Browser.

Please note that the embedded browser is a 2014 version of the Chromium Embedded Framework (CEF), and using it for general web browsing is a major security risk. 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 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 supported locale website codes see here. The client updates tips only when the Date attribute of the root node of LiveLoadingTips.xml is different from the previous update.