Workstation Setup for HeroEngine
- Providing instructions on how to setup workstations in preparation for compiling the HeroEngine code.
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.
- Get the latest video card drivers for your workstation
- Run Windows Update and make sure you are up to date
- As of January 2014, HeroEngine uses Microsoft Visual Studio 2013
- MUST BE installed to c:\vs2k13
- Install Visual Studio 2013. Select "Full installation" when prompted.
- Re-run Windows Update to make sure everything is actually up to date
- Configure Visual Studio to insert 4 spaces for each tab
- Setup local symbol cache for both Visual Studio installations
- Go to Tools -> Options -> Debugging -> Symbols
- Add Symbol file (.pdb) locations: http://msdl.microsoft.com/download/symbols
- Set the Cache symbols from symbol servers to a local directory, e.g.: c:\symbols
- Click Ok
- Setup native code debugging
- In the Solution Explorer go to the HeroBlade project -> Properties -> Debug
- Under the Enable Debuggers section check Enable unmanaged code debugging
- Save all
- Obtain the config file to run HeroBlade
- Download the latest HeroBlade from your launcher
- Copy the heroblade.cfg file from the launcher install directory to your .../heroblade/RunWin32/ directory
- Current supported version is 2.6
- NOTE: Windows x64 OS requires the Python 32 bit (x32) installer. DO NOT install the native Python x64
- Check the Windows System PATH environment variable to ensure that install directory has been added
- Current supported version is 5.10
- For Windows, Strawberry Perl is recommended but not required
If Building HeroEngine Server, Install Oracle Client
- Run setup.exe
- Choose custom installation, then select everything (better to select more than you need, than miss something)
- Install to a directory with no spaces, no special characters, e.g.: c:\Oracle
- Accept default port number.
- On the "Oracle Net Configuration Assistant: Welcome" screen, do not select "Perform typical configuration."
- 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).
- Install ODAC1020221
- Win7 or Server 2k8R2 are not "valid" OSes in the older version of ODAC so run it via a shortcut using the -ignoreSysPrereqs flag.
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:
- sudo apt-get install g++-multilib
Installing OpenGL Dev Files
Install the following packages:
- sudo apt-get install mesa-common-dev
- sudo apt-get install libx11-dev
- sudo apt-get install libglu1-mesa-dev
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
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.
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.