Workstation Setup for HeroEngine

From HEWIKI
Jump to: navigation, search

He source.png Documentation on this page is intended for use by customers who have access to HeroEngine source code under their license agreement.

Contents

Providing instructions on how to setup workstations in preparation for compiling the HeroEngine code.

Windows

Microsoft Visual Studio 2013

NOTE: DO NOT install Microsoft Visual Studio into a directory that contains special characters such as parentheses, e.g.: "C:\Program Files (x86)\...", as Oracle is unable to handle these types of directory names and this will cause preprocessing and compilation of firestorm and server components to fail.

  1. Go to Tools -> Options -> Debugging -> Symbols
  2. Add Symbol file (.pdb) locations: http://msdl.microsoft.com/download/symbols
  3. Set the Cache symbols from symbol servers to a local directory, e.g.: c:\symbols
  4. Click Ok
  1. In the Solution Explorer go to the HeroBlade project -> Properties -> Debug
  2. Under the Enable Debuggers section check Enable unmanaged code debugging
  3. Save all
  1. Download the latest HeroBlade from your launcher
  2. Copy the heroblade.cfg file from the launcher install directory to your .../heroblade/RunWin32/ directory


Python


Perl



If Building HeroEngine Server, Install Oracle Client

  1. Run setup.exe
  2. Choose custom installation, then select everything (better to select more than you need, than miss something)
  3. Install to a directory with no spaces, no special characters, e.g.: c:\Oracle
  4. Accept default port number.
  5. On the "Oracle Net Configuration Assistant: Welcome" screen, do not select "Perform typical configuration."
  6. On the "Oracle Net Configuration Assistant: Naming Methods Configuration" screen:

          a. remove "Local Naming"      

          b. add "Easy Connect Naming"      

          c. click Next, Next, and Finish.

     7.  Set the environment variable VS_ORACLE_HOME to the root of your Oracle installation, e.g.: C:\oracle


If Building/Running Tools that Communicate Directly with Oracle, Install ODAC

Tools such as Direct Access Control and DBMigration communicate directly with oracle over ODAC using a newer version of ODAC than is included in the client installation (above).

Linux

Installation Notes

These installation notes reflect usage of Ubuntu 10.x.  While technically other distributions should work, Ubuntu was chosen as it's a standard desktop distro, and due to the graphics support and ease of package installation.  While you may be able to run Suse or Debian as well, don't try and use CentOS or another server OS which lacks, or has problems with, OpenGL support and compatibility.


Installing (Extra) Standard Dev Files

Install the following packages:


Installing OpenGL Dev Files

Install the following packages:



gcc Version

All client code is currently compiled against gcc 4.4.3


Recommended Development Setup

While you can use other applications, the following are recommended:


P4v - Perforce visual client and file browser (you can drag & drop directly into UltraEdit)

gedit - Simple graphical editor

UltraEdit - Editor with syntax highlighting

Terminal - To build the make files


Make Files

Individiual make files are located under each project in a .../compiler/linux directory.

To build a given make file, e.g.:

make -f foofile.mk debug

To redirect standard and compile error output to the same text file, e.g.:

make -f foofile.mk debug > output.txt 2>&1


There are two main projects, one for client build and one for server build, located in the branch root's .../build/ directory.

$(ROOT)/build/client

$(ROOT)/build/server

$(ROOT)/build/shared

The shared directory contains configuration data common to both builds

Building the appropriate client or server make file will cascade through and build all dependent make files.





See also

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox