Master Control Console
Documentation on this page is intended for customers of HeroEngine managing their own server(s).
- This page is about the Master Control application. For the Console window in HeroBlade, see HeroBlade Console Panel.
This tool is designed to help you configure and monitor your own server cluster, and is not used to monitor servers in the HeroCloud. Tools for measuring load and performance help you plan your capacity needs over time.
Contents |
Installing Master Control Console
For those licensees with Full or Source licenses, the Console will be available as a private Download, or may be sent to you via email.
For access to the Master Control, please contact your technical support list.
For other types of licenses, the Master Control is maintained and updated by HeroEngine.
Running Master Control Console
Once installed, it should run automatically and popup a login screen. To start it again later, it is run as a normal Windows application, via the Start Menu. It should be available at the top of the Start Menu, or to navigate to it manually, it should be under "All Programs/HeroEngine Tools".
Configuration
Master Control Console reads a configuration file MasterControlConsole.sys when it is run which tells it the server and port to which it is supposed to communicate. This file is typically created as a part of the installation process, but may be modified by hand if required.
Host=mcd.hero.s.heroengine.net
Port=46894
Command line options
A Windows shortcut can be established which allows command line arguments to automatically fill in certain parameters such as account name and password. For example:
C:\Program Files\HeroEngine\Tools\MASTERCONTROLCONSOLE\MasterControlConsole.exe" host=server.heroengine.com account=username
Available options include:
- host
- The domain
- account
- The account name of the individual with Master Control access
- password
- The password of the individual with Master Control access
Controlling Access to Master Control Console
Direct access control controls permission to access and utilize various functionality in Master Control Console. A typical HeroEngine installation will include a shortcut on the desktop of the Windows World Server to run Direct Access Control. Accounts to which you wish to grant access to Master Control to administer your server should be granted the HE-OPERATOR role.
Sections
The main sections of the Console are:
- The Tree View
- The Status Window
- The Chat Window
- The Button Toolbar
- The Logging Window
The Tree View
In the Component Tree view, there will be a list of Servers, and a list of Worlds. Opening a World displays a list of Services in that World. Opening a Service displays the list of Processes in that Service.
Servers
This provides a list, by name, of all of the physical hardware servers in this particular Master Control's Universe. Each one will be color-coded depending on its status:
- Yellow = Firing up
- Green = Running
- Orange = Shutting down
- Flashing Red = Disconnected or crashed
- Red = Shutdown, or not connected to the Master Control
To connect to the Master Control, the daemon FireUp must be run on the hardware server. Most of them should already be configured to automatically run this daemon when they are booted up.
Worlds
- See also: Adding a World
Clicking on the name of each World (such as HJDEV or SANDBOX) displays the various Services within that game world, and their respective Daemon processes. The Daemons are color-coded just like the servers -- if they are all green, then they are all running.
Several different worlds may be listed for a given universe. The names will vary from licensee to licensee, but typical names might be:
- UNIVERSE SERVICES
- HJDEV
- HJSANDBOX
(etc.)
Naming worlds
You can name your worlds whatever you would like! If you have a full license, you can change a name via the Edit Config option in the Master Control (see Editing configuration values). To add a new world, see Adding a World.
If you have another type of license, please ask your contact at HeroEngine about renaming worlds.
Specific world services
Each of these services generates unique processes for its specific world.
| Daemon | Description |
| REPOSITORY SERVICE | |
| Repository Dude Manager Daemon | This process is what the Repository browser connects to. It handles all traffic between the browser and repository server. |
| Repository Server Daemon | Handles all resource requests, changes, etc. and talks directly to the database. |
| Repository Server Director | Starts up multiple repository server daemons, based on load, primary used by the graphical engine clients |
| Thumbnail Creator | Creates thumbnails of all images and other appropriate resources for display in client applications such as the Repository browser and the FS Selector |
| CORE SERVICE | |
| PO Router Daemon | This is the Post office router. It is used to coordinate all post offices. |
| Log Database | This process receives all log messages and stores them in a database. NOTE: This is currently not being used |
| Authenticator | This process is responsible for validating usernames/passwords by talking with UACCESS. |
| ID SERVER | This process gives out unique IDs. |
| GAME SERVICE | |
| DOM Coordinator | This process coordinates DOM changes between servers. |
| Dude Server | This is where users connect with HeroBlade via the Dude Server to login to the game. All traffic (game, resources, etc) goes though here. |
| World Server | Dynamically starts and manages all Area servers |
| Client HeroScript Compiler Server | Compiles scripts for the client |
| HeroScript Compiler Server | Compiles scripts for the server |
| Search Server | Searches through the entire database of client- and server-side HSL script code text for specific words |
| Texture Copy and Mip | (only used in version 1.0 characters) Watches the Repository for artists adding files that need to have multiple Mip levels calculated, and automatically performs the calculation. Note: May not run in all worlds. |
| Physics Server Director | Responsible for dynamically spinning up the Physics Servers as needed and load-balancing. |
| Test Director | (optionally present) Responsible for dynamically spinning up and coordinating Test Clients as needed. See Automated testing |
| Test Client |
The Status Panel
The Logging Panel
The Button Toolbar
- Fireup - Starts the currently selected static process. If a world is selected, starts the static processes in that world in their defined startup order.
- Shutdown - Requests the currently selected process to shut down. If a world is selected, the processes in that world will be shutdown in the reverse startup order.
- Restart - This is the same as hitting the Shutdown button followed by the Fireup button.
- Terminate - Instructs the Fireup daemon to terminate the selected process.
- Edit Config - Opens the configuration editing panel (see Editing configuration values).
- Edit Worlds - Opens the world editor window.
- Sound - When highlighted, sound events will play in response to chat messages.
