HeroEngine Publish

From HEWIKI
Revision as of 19:16, 9 November 2012 by HE-ALEX (Talk | contribs)
Jump to: navigation, search

HeroEngine Publish (also called HE Publish) is the set of tools (HEPublishBuilder and HEPublishApply) that provide the ability to build and deploy publish packages. These tools are used by the HeroEngine team to assemble updates to the DOM/GOM that are components of a new release, they are not intended for use by licensees.


To follow the steps on this page, you need access to certain tools, which can be downloaded from the MMO Platform downloads page:

Information needed from your Development Director:

HeroEngine Publish also uses a GNU LGPL licensed compression program called 7-zip to compress its publish packages. 7-Zip binaries and source code may be found at http://www.7zip.org.

Shutdown Clean_Test in Master Control ShutdownCleanTest.jpg

ShutdownCleanTestConfirm.jpg
Open HE Publish Builder

  It is a separate application, which can be accessed via your Start Menu. If you do not have it installed yet, you can download it.
HE Publish Builder.jpg
Select New... from Package Package New.jpg
Define the New Package:

a. Enter a directory on your local harddrive to store the files or accept default;

b. Enter current version and hotfix numbers;

c. Select package type;

d. Click OK.
CreateNewPackage.jpg
Verify the Distribution Packages, and that the numbers are correct.

Also review the messages in the Build Process Output window, to ensure that there are no errors.
ValidatePackage1.jpg

ValidatePackage2.jpg
Select the Source Configuration Strings from the Master Control Select From Master Control.jpg
Enter Service Database connection information
  • Service Schema is fs_Service
  • Service Password is fs_Service's connection password
  • Service Database is hj0db (note: that's a zero)
  • Username is your simu- username
Enter Service Database Information.jpg
The World Schema Selection Dialog is opened
  • Each World Schema requires
    • A Server GOM Schema
    • A Client GOM Schema
    • A Repository Schema
  • Each Schema requires
    • A Schema Name
    • A Password
    • A Database
  • Repository Schemas also require a Support Tag which holds the World's Repository Name
World And Associated Schemas Dialog.jpg
If the DEV_SERVER_GOM, DEV_CLIENT_GOM and DEV_REPOSITORY Schemas do not exist, they must be added. For information on how to do this, see Adding schemas during HeroEngine Publish Add New Schema.jpg
If the HJ_DEV World does not exist, it must be added. See Adding worlds during HeroEngine Publish Add New World.jpg
Select the HJ_DEV world by double-clicking it, or single-clicking it then pressing OK Select World And Associated Schemas.jpg
Review HJ_DEV's information to ensure that you have selected the correct schemas and names. Any wrong information must be corrected by re-entering the Master Control Connection, deleting incorrect entries and re-entering correct information. Review Selected World Information.jpg
Select DOM Tab Select DOM Tab.jpg
Generate Server DOM Database
This may take a couple minutes, wait until it no longer says Busy at the bottom of the HE Publish Builder window
GenerateServerDOM.jpg
Validate Server DOM Database ValidateServerDOM.jpg
Generate Client DOM Database
This may take a couple minutes, wait until it no longer says Busy at the bottom of the HE Publish Builder window
GenerateClientDOM.jpg
Validate Client DOM Database ValidateClientDOM.jpg
Select Repository Tab Select Repository Tab.jpg
Generate Repository Database
This may take a couple minutes, wait until it no longer says Busy at the bottom of the HE Publish Builder window
GenerateRepository.jpg
Validate Repository Database ValidateRepository.jpg
Finalize the package. This bundles all necessary files into a single self extracting archive named the same as your package file.
This may take a couple minutes, wait until it no longer says Busy at the bottom of the HE Publish Builder window
PackageFinalize.jpg

FinalizeOutput.jpg
Launch the self extracting package executable Launch Self Extracting Package.jpg
Confirm that you wish to install the HeroEngine package Confirm Package Installation.jpg
After the package is extracted HEPublishApply automatically launches and detects the Hero Engine package file. HE Publish Apply.jpg
Press the "Update World" button Select Update World.jpg
Enter Service Database connection information
  • Service Schema is fs_Service
  • Service Password is fs_Service's connection password
  • Service Database is hj0db (note: that's a zero)
  • Username is your simu- username
Enter Service Database Information2.jpg
The World Schema Selection Dialog is opened World And Associated Schemas Dialog.jpg
If the CLEAN_SERVER_GOM, CLEAN_CLIENT_GOM and CLEAN_REPOSITORY Schemas do not exist, they must be added. See Adding Clean Schemas Add New Schema.jpg
If the CLEAN_TEST World does not exist, it must be added. See Adding worlds during HeroEngine Publish Add New World.jpg
Select the CLEAN_TEST world by double-clicking it, or single-clicking it then pressing OK. World alteration preparations now begin.
This may take a couple minutes, wait until it no longer says Busy at the bottom of the HE Publish Builder window
Select Clean Test World.jpg
You will now be queried as to which parts of the package to apply. Check with your Dev Director as to which parts need to be applied, or simply select ALL which will automatically check all boxes.
When preparations are complete, select OK to apply alterations to the CLEAN_TEST server. Apply World Alterations.jpg
When Ready (no longer busy), Close HE Publish Apply

Verification

If you want to verify the publish:

Note: The CLEAN_TEST world name is being used here only for example purposes, and will probably be different to what you will be using for your own system
Recursively Watch GAME under CLEAN_TEST in Master Control
In the Master Control Console, right-click on the CLEAN_TEST world, and select Watch/Recursive
 
Clear the logging window
Right-click on the logging window in the Master Control Console, and select CLEAR
Fireup CLEAN_TEST
Login to clean test using HeroBlade
Select the Client GOM
Open the Console Window to access the CLI
Enter "|recompileallscriptsbytecode " as a CLI command
This may take a few minutes
When done (Master Control Console will say Finished Recompiling in the Logging Window), enter "HSCS recompileallscriptsbytecode" as a CLI command
When done (Master Control Console will say Finished Recompiling), copy the Logging window in Master Control Console to a text editor
Search for "Request 0" to identify extraction and compile errors
If there are any errors, the identified HSL script needs to be repaired, probably by your local GameMasters. After the fix, this entire publish package needs to be restarted from step #1

Lather, rinse, repeat, until there no further errors.

Next steps

Once you have received the new version of HeroEngine, you must upgrade the executables running on your world. For a full licensee, this means running the Deploy. For a source licensee, this means compiling the new source code, and deploying it.

See: Upgrading worlds

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox