World Editor

From HEWIKI
Jump to: navigation, search

He server.png Documentation on this page is intended for customers of HeroEngine managing their own server(s).

The World Editor allows you to create/destroy worlds (and DreamManagers), as well as import/export them. The World Editor is a tool which is accessed via the Master Control Console.

Any user with the "Monitor" permission can view the worlds, however to make any changes the "Edit Worlds" permission is required.

Note: Only customers with full or source licenses can modify values via the Master Control Console.

Contents

Accessing the World Editor

To access the World Editor, login to the Master Control Console, and then click the Edit Worlds button on the toolbar.

Mcc mainToolbar editWorldsBtn.png

World Management

The World Editor Window
  • Worlds Tab
    • Name - This is the world name displayed in Master Control Console.
    • Job - This will show the name and progress of the running job on that world if there is one.
    • Prefix - This is the prefix of the database schemas.
    • Database - This is the database where the world is located.
  • DreamManagers Tab
    • Job - This will show the name and progress of the running job on that DreamManager if there is one.
    • Prefix - This is the prefix of the database schemas.
    • Database - This is the database where the world is located.



Create World

To create a new world from the World Editor > Worlds tab > Click the Create World button to open the Create World window.

Create World Window
  • Database - Select the database that will host the schemas for the world.
  • Import File - Select the file to import the world's schemas from.
  • Prefix - This should be a short abbreviation of the world's name. Its used in several places,
  • World Name - The name of the world shown to end users.
  • Fireup Name - The name of the primary machine running the world's processes.
  • Fireup Machine - The DNS or IP address of the primary machine running the world's processes
  • SD Transports - The transport of the service directory that the world reports to. Multiple entires can be seperated by a pipe | character.
  • World Type - The type of world. This controls some inital configuration options.
  • Company - This option controls the location of the Local Repository Cache. All worlds that you wish to share the same cache on disk must share the same value.
  • Setup DreamManager - Check this box to also setup a new DreamManager, if you want to use an existing one it must be configured seperatly.
    • Database - Select the database that will host the schema for the DreamManager.
    • Import File - Select the file to import the DreamManagers schema from.
    • Universe - The universe to add the service for the DreamManager process.
    • Service - The servers to add the DreamManager process.
    • Fireup Name - The name of the machine to run DreamManager process.
    • Fireup Machine - The DNS or IP address of the machine running the DreamManager process.
    • PO Transport - The Post Office transport for the world.

Destroy World

Confirm World Destruction Window
  • Export world first - Check this box if you want to create an export of the world before destroying it.
    • Version - The version of the export. This will be including in the file name of the export.
    • Overwrite - Check this box to overwrite an existing export with the same name if one exists.
  • Confirm the world name below - Type the name of the world in this box.
  • Confirm the prefix below - Type the prefix of the world in this box.

NOTE: The Destroy button will not enable until the world name and prefix have been entered into the boxes.

Create World Configuration

Create World Configuration Window
  • Database - Select the database that will host the schemas for the world.
  • Fireup Name - The name of the primary machine running the world's processes.
  • Fireup Machine - The DNS or IP address of the primary machine running the world's processes
  • World Name - The name of the world shown to end users.
  • Prefix - This should be a short abbreviation of the world's name. Its used in several places,
  • SD Transports - The transport of the service directory that the world reports to. Multiple entires can be seperated by a pipe | character.
  • World Type - The type of world. This controls some inital configuration options.
  • Company - This option controls the location of the Local Repository Cache. All worlds that you wish to share the same cache on disk must share the same value.

Delete World Configuration

Delete World Configuration Window
  • Confirm the universe name below - Type the universe name.

NOTE: The Delete button will not enable until the universe name is entered into the box.

Import World

Import World Window
  • Database - Select the database that will host the schemas for the world.
  • Import File - Select the file to import the world's schemas from.
  • Prefix - This should be a short abbreviation of the world's name. Its used in several places,
  • Overwrite - Check this box to overwrite any existing schemas with the same prefix.

Export World

Export World Window
  • Version - The version of the export. This will be including in the file name of the export.
  • Overwrite - Check this box to overwrite an existing export with the same name if one exists.
  • include history - Include things such as pervious versions of repository files and scripts.

DreamManager Management

See also: DreamManager

Create DreamManager

Create DreamManager Window
  • Database - Select the database that will host the schemas for the world.
  • Import File - Select the file to import the DreamManagers schemas from.
  • Prefix - This should be a short abbreviation of the world's name.
  • Universe - The universe to add the service for the DreamManager process.
  • Service - The servers to add the DreamManager process.
  • Fireup Name - The name of the machine to run DreamManager process.
  • Fireup Machine - The DNS or IP address of the machine running the DreamManager process.
  • PO Transport - The Post Office transport for the world.

Delete DreamManager schema

Delete DreamManager Schema Window
  • Export first - Check this box if you want to create an export of the DreamManager before destroying it.
    • Version - The version of the export. This will be including in the file name of the export.
    • Overwrite - Check this box to overwrite an existing export with the same name if one exists.
    • Clean Only - This option is only intended to by used by the HeroEngine team to create an empty DreamManager with no content.

Create DreamManager Configuration

Create DreamManager Configuration Window
  • Universe - The universe to add the service for the DreamManager process.
  • Service - The servers to add the DreamManager process.
  • Fireup Name - The name of the machine to run DreamManager process.
  • Fireup Machine - The DNS or IP address of the machine running the DreamManager process.
  • Database - Select the database that will host the schemas for the world.
  • Schema - Select the DreamManagers schema to configure a DreamManager process to use.
  • PO Transport - The Post Office transport for the world.

Import DreamManager

Import DreamManager Window
  • Database - Select the database that will host the schema for the DreamManager.
  • Import File - Select the file to import the DreamManagers schema from.
  • Prefix - This should be a short abbreviation of the world's name.
  • Overwrite - Check this box to overwrite any existing schemas with the same prefix.

Export DreamManager

Export DreamManager Window
  • Version - The version of the export. This will be including in the file name of the export.
  • Overwrite - Check this box to overwrite an existing export with the same name if one exists.
  • Clean Only - This option is only intended to by used by the HeroEngine team to create an empty DreamManager with no content.

View

Jobs

Job Viewer Window
  • World - The name of the world the job is working on.
  • Job - The name of the job.
  • Status - The current status of the job.
  • Log - Log messages from the job.
  • Progress - Shows the progress of the job. Blue indicates in progress, Green indicates the job finished successfully, Red indicates the job ended unsuccessfully.

Logs

Log Viewer Window
  • Database - Select the database for the log you want to view.
  • Log File - Select the log file you want to view.


Advanced Usage

Bulk Customizing Developer World Data

The Customize Developer Data Dialogue enables users to quickly set common values for multiple worlds without having to edit each world manually.

Screenshot of the Mass-Configure Worlds dialogue window.

Customizable Values

Values which the tool allows you to set include

World Name

The name of the world visible to the user from his or her individual Service directory.

World Description

The customer-provided description for the world.

Universe Name

The MCC user-only visible version of the world name, displayed within the component tree on the left of the main window (containing a list of all worlds on the cluster).

Local Repository Cache (LRC) Path

The location on the customer's machine where all repository files are stored when he or she logs in to the world using HeroBlade.


Required Information

For a world to be modified, a universe prefix must be provided as a unique identifier to that world. This value can not be changed. Each row in the customization dialogue will correspond to a single world configuration job. The format for a single job (row) is a tab-delimited set of text values.

<Universe Prefix><tab><World Name><tab><World Description><tab><Universe Name><tab><LRC Path>

Tab-delimited .txt files can also be imported. This is an example of one such file.

X_020_00124	world name 1	world description 1	universe name 1	lrc path 1
X_020_00125	world name 2	world description 2	universe name 2	lrc path 2
X_020_00126	world name 3	world description 3	universe name 3	lrc path 3


While it is recommended that a World Name at least be provided, it is only required that a single configuration job (row) contain a Universe Prefix identical to an already existing world on the cluster with the same Universe Prefix. If this is not the case, the configuration job will not continue.


When a user attempts to submit one or more configuration jobs, the user-input data is first validated. Checks are run to ensure that none of the values contain special characters or begin with a number or character. If invalid data is found, the user is notified of the offending value and the row in which it is located. Once all user-input values have been validated, additional values which have not been filled in by the user can be automatically generated by the configuration tool. Before continuing with the configuration job, the newly generated values are also verified.

The Customization Procedure

Confirmation of completion

Assuming all provided information is complete and valid, the bulk customize developer world data dialogue will perform one world configuration at a time. Depending on the number of worlds being configured, this process can take several seconds. Until the job is complete, the user will not be allowed to perform any input action. All contorls are disabled. 


Afterwards a dialogue box will appear, notifying the user that all configurations have been completed and a "/shutdown" is required to finalize the operation. Type "/shutdown" without quotes into the chat panel input box and press Enter on the keyboard to finish.



Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox