Compiling RCBot2 Options

[Cheeseh]

1. Use Visual Studio 2005/2008 (windows)

2. Use a tool such as Ankhsvn or TortoiseSVN for Visual Studio 2005/2008 (windows)
http://ankhsvn.open.collab.net/
http://tortoisesvn.net/

3. Get the appropriate HL2 SDK, from https://github.com/alliedmodders/hl2sdk/ this has updated SDK code
(TF2 SDK https://github.com/alliedmodders/hl2sdk/tree/tf2 )
(DODS https://github.com/alliedmodders/hl2sdk/tree/dods )
(HL 2 DM https://github.com/alliedmodders/hl2sdk/tree/hl2dm)

4. Get the code from sourceforge SVN by opening an SVN project in VS Studio (using AnkhSVN)
https://sourceforge.net/scm/?type=svn&group_id=248612
download the rcbot2 source: using this command svn checkout svn://svn.code.sf.net/p/rcbot2/code/ rcbot2-code
or this server checkout svn://svn.code.sf.net/p/rcbot2/code/

Make sure the project is in the HL2 SDK folder/utils/rcbot2

(Also if you wish to change any code for others to see, make a sourceforge.net username and ask me to add you to the list of coders.)

5. Mar 2013 - note that the latest releases hook to the engine to work properly. This solves many problems that the past rcbot had, but it may create problems in the future, for example TF2 updates may change the engine. For that reasons, if the bot crashes, keep up to date with the website at:
http://www.sourcemodplugins.org/vtableoffsets
and keep the rcbot_runplayer_cmd updated to the latest PlayerRunCommand offset number for windows (the linux offset is added automatically in the bot if the windows offset is correct) .
At this time of speaking, the offset is 418 for tf2 and 417 for DOD:s
Linux offsets are shifted by 1

6. Get coding!

Linux instructions + Makefile are here:

http://sourceforge.net/p/rcbot2/wiki/Compiling%20in%20Linux/

Make file for linux by bir3yk in code form below (NOTE if you copy/paste this into a new file, you must change any spaces to tabs)

CODE

#
# SDK Makefile for x86 Linux
#
#

#############################################################################
# Developer configurable items
#############################################################################

# the name of the mod binary (_i486.so is appended to the end)
#NAME=server
NAME=HPB_bot2

# the location of the vcproj that builds the mod
#MOD_PROJ=../game/server/server_hl2mp-2005.vcproj
MOD_PROJ=../utils/RCBot2/HPB_Bot2.vcproj

# the name of the mod configuration (typically <proj name>_<build type><build target>)
#MOD_CONFIG=ServerHL2MP_ReleaseWin32
MOD_CONFIG=HPB_bot2_ReleaseWin32

# the directory the base binaries (tier0_i486.so, etc) are located
# this should point to your orange box subfolder of where you have srcds installed.
#GAME_DIR=~/srcds/orangebox
GAME_DIR=/home/hlds/steam/orangebox

# the path to your mods directory
# set this so that 'make install' or 'make installrelease' will copy your binary over automatically.
#MOD_DIR=$(GAME_DIR)/SampleMod
MOD_DIR=$(GAME_DIR)/

# compiler options (gcc 3.4.1 will work - 4.2.2 recommended)
#CC=/usr/local/bin/gcc
#CPLUS=/usr/local/bin/g++
#CLINK=/usr/local/bin/gcc
#CPP_LIB="/usr/local/lib/libstdc++.a /usr/local/lib/gcc/i686-pc-linux-gnu/4.2.2/libgcc_eh.a"
#CC=/usr/bin/gcc
#CPLUS=/usr/bin/g++-4.1
#CLINK=/usr/bin/gcc-4.1
CPP_LIB=" /usr/lib/gcc/i486-linux-gnu/4.1.3/libstdc++.a /usr/lib/gcc/i486-linux-gnu/4.1.3/libgcc_eh.a"
C = /usr/bin/gcc-4.1
CPLUS = /usr/bin/g++-4.1
CLINK = /usr/bin/gcc-4.1
#CPP_LIB = "libstdc++.a libgcc_eh.a"


# GCC 4.2.2 optimization flags, if you're using anything below, don't use these!
#OPTFLAGS=-O1 -fomit-frame-pointer -ffast-math -fforce-addr -funroll-loops -fthread-jumps -fcrossjumping -foptimize-sibling-calls -fcse-follow-jumps -fcse-skip-blocks -fgcse -fgcse-lm -fexpensive-optimizations -frerun-cse-after-loop -fcaller-saves -fpeephole2 -fschedule-insns2 -fsched-interblock -fsched-spec -fregmove -fstrict-overflow -fdelete-null-pointer-checks -freorder-blocks -freorder-functions -falign-functions -falign-jumps -falign-loops -falign-labels -ftree-vrp -ftree-pre -finline-functions -funswitch-loops -fgcse-after-reload
OPTFLAGS=-O1 -fomit-frame-pointer -ffast-math -fforce-addr -funroll-loops -fthread-jumps -fcrossjumping -foptimize-sibling-calls -fcse-follow-jumps -fcse-skip-blocks -fgcse -fgcse-lm -fexpensive-optimizations -frerun-cse-after-loop -fcaller-saves -fpeephole2 -fschedule-insns2 -fsched-interblock -fsched-spec -fregmove -fdelete-null-pointer-checks -freorder-blocks -freorder-functions -falign-functions -falign-jumps -falign-loops -falign-labels -ftree-vrp -ftree-pre -finline-functions -funswitch-loops -fgcse-after-reload

#OPTFLAGS=

# put any compiler flags you want passed here
USER_CFLAGS=

# Link Libraries
#LIBFILES= \
#  $(LIB_DIR)/lib/linux/tier1_486.a \
#  $(LIB_DIR)/lib/linux/choreoobjects_486.a \
#  $(LIB_DIR)/lib/linux/particles_486.a \
#  $(LIB_DIR)/lib/linux/dmxloader_486.a \
#  libtier0.so \
#  libvstdlib.so \
#  libsteam_api.so \
#  $(LIB_DIR)/lib/linux/tier3_486.a \
#  $(LIB_DIR)/lib/linux/tier2_486.a \
#  $(LIB_DIR)/lib/linux/tier1_486.a \
#  $(LIB_DIR)/lib/linux/mathlib_486.a \


# link flags for your mod, make sure to include any special libraries here
#NOTE: YES we want to include the lib files 2 times. We've run into problems with the 1-pass linker not bringing in symbols it should.
#LDFLAGS="-lm -ldl $(LIBFILES) $(LIBFILES)"
LIB_DIR = $(SOURCE_DIR)/lib/linux
LDFLAGS = "-lm -ldl  $(LIB_DIR)/mathlib_i486.a libtier0.so libvstdlib.so  $(LIB_DIR)/tier1_i486.a $(LIB_DIR)/tier2_i486.a $(LIB_DIR)/tier3_i486.a "

# XERCES 2.6.0 or above ( [url=http://xml.apache.org/xerces-c/]http://xml.apache.org/xerces-c/[/url] ) is used by the vcproj to makefile converter
# it must be installed before being able to run this makefile
# if you have xerces installed already you should be able to use the two lines below
#XERCES_INC_DIR=/usr/include
#XERCES_LIB_DIR=/usr/lib
XERCES_INC_DIR=/opt/include
XERCES_LIB_DIR=/opt/lib

#############################################################################
# Things below here shouldn't need to be altered
#############################################################################
MAKE=make

# the dir we want to put binaries we build into
BUILD_DIR=.
# the place to put object files
BUILD_OBJ_DIR=$(BUILD_DIR)/obj

# the location of the source code
SOURCE_DIR=..

# the CPU target for the build, must be i486 for now
ARCH=i486
ARCH_CFLAGS=-mtune=i686 -march=pentium -mmmx -msse -pipe

# -fpermissive is so gcc 3.4.x doesn't complain about some template stuff
BASE_CFLAGS=-DVPROF_LEVEL=1 -DSWDS -D_LINUX -DLINUX -DNDEBUG -fpermissive -Dstricmp=strcasecmp -D_stricmp=strcasecmp -D_strnicmp=strncasecmp -Dstrnicmp=strncasecmp -D_snprintf=snprintf -D_vsnprintf=vsnprintf -D_alloca=alloca -Dstrcmpi=strcasecmp

SHLIBEXT=so

SHLIBCFLAGS=-fPIC
SHLIBLDFLAGS=-shared -Wl,-Map,$@_map.txt -Wl

#flags passed to the compiler
CFLAGS="$(USER_CFLAGS) $(DEFINES) $(ARCH_CFLAGS) $(OPTFLAGS) $(BASE_CFLAGS) -Usprintf=use_Q_snprintf_instead_of_sprintf -Ustrncpy=use_Q_strncpy_instead -Ufopen=dont_use_fopen -UPROTECTED_THINGS_ENABLE"

# define list passed to make for the sub makefile
BASE_DEFINES=CC=$(CC) CPLUS=$(CPLUS) CPP_LIB=$(CPP_LIB) \
    BUILD_DIR=$(BUILD_DIR) BUILD_OBJ_DIR=$(BUILD_OBJ_DIR) \
    SOURCE_DIR=$(SOURCE_DIR) SHLIBLDFLAGS=$(SHLIBLDFLAGS) SHLIBEXT=$(SHLIBEXT) \
    CLINK=$(CLINK) CFLAGS=$(CFLAGS) LDFLAGS=$(LDFLAGS) \
    ARCH=$(ARCH) GAME_DIR=$(GAME_DIR) MOD_CONFIG=$(MOD_CONFIG) NAME=$(NAME) \
    XERCES_INC_DIR=$(XERCES_INC_DIR) XERCES_LIB_DIR=$(XERCES_LIB_DIR)

# Project Makefile
MAKE_MOD=Makefile.server
MAKE_VCPM=Makefile.vcpm
MAKE_PLUGIN=Makefile.plugin

all: check vcpm server

check:
    if [ -z "$(CC)" ]; then echo "Compiler not defined."; exit; fi
    if [ ! -d $(BUILD_DIR) ];then mkdir $(BUILD_DIR);fi
    cd $(BUILD_DIR)

vcpm:
    $(MAKE) -f $(MAKE_VCPM) $(BASE_DEFINES)

server: vcpm
    if [ ! -f "libtier0.so" ]; then ln -s $(GAME_DIR)/bin/libtier0.so .; fi
    if [ ! -f "libvstdlib.so" ]; then ln -s $(GAME_DIR)/bin/libvstdlib.so .; fi
#    if [ ! -f "libsteam_api.so" ]; then ln -s $(GAME_DIR)/bin/libsteam_api.so .; fi
# When running over samba we need to copy the files because symlinking isn't possible.
#    cp -f $(GAME_DIR)/bin/tier0_i486.so .
#    cp -f $(GAME_DIR)/bin/vstdlib_i486.so .
#    cp -f $(GAME_DIR)/bin/steam_api_i486.so .

    ./vcpm $(MOD_PROJ)
    $(MAKE) -f $(MAKE_MOD) $(BASE_DEFINES)

plugin:
    $(MAKE) -f $(MAKE_PLUGIN) $(BASE_DEFINES)

clean:
     $(MAKE) -f $(MAKE_VCPM) $(BASE_DEFINES) clean
     $(MAKE) -f $(MAKE_PLUGIN) $(BASE_DEFINES) clean
     $(MAKE) -f $(MAKE_MOD) $(BASE_DEFINES) clean

install:
    cp -f $(NAME)_$(ARCH).so $(MOD_DIR)/bin/$(NAME)_$(ARCH).so

installrelease:
    cp -f $(NAME)_$(ARCH).so $(MOD_DIR)/bin/$(NAME)_$(ARCH).so
    strip $(MOD_DIR)/bin/$(NAME)_$(ARCH).so

[Cheeseh]

add this before IServerGameDLL in eiface.h

this was just for the bot to be backward compatible with non orange box mods

CODE

define INTERFACEVERSION_SERVERGAMEDLL_VERSION_4    "ServerGameDLL004"
#define INTERFACEVERSION_SERVERGAMEDLL_VERSION_5    "ServerGameDLL005"
#define INTERFACEVERSION_SERVERGAMEDLL_VERSION_6    "ServerGameDLL006"
#define INTERFACEVERSION_SERVERGAMEDLL                "ServerGameDLL007"

//-----------------------------------------------------------------------------
// Purpose: These are the interfaces that the game .dll exposes to the engine
//-----------------------------------------------------------------------------
abstract_class IServerGameDLL_004
{
public:
    // Initialize the game (one-time call when the DLL is first loaded )
    // Return false if there is an error during startup.
    virtual bool            DLLInit(    CreateInterfaceFn engineFactory,
                                        CreateInterfaceFn physicsFactory,
                                        CreateInterfaceFn fileSystemFactory,
                                        CGlobalVars *pGlobals) = 0;
    
    // This is called when a new game is started. (restart, map)
    virtual bool            GameInit( void ) = 0;

    // Called any time a new level is started (after GameInit() also on level transitions within a game)
    virtual bool            LevelInit( char const *pMapName,
                                    char const *pMapEntities, char const *pOldLevel,
                                    char const *pLandmarkName, bool loadGame, bool background ) = 0;

    // The server is about to activate
    virtual void            ServerActivate( edict_t *pEdictList, int edictCount, int clientMax ) = 0;

    // The server should run physics/think on all edicts
    virtual void            GameFrame( bool simulating ) = 0;

    // Called once per simulation frame on the final tick
    virtual void            PreClientUpdate( bool simulating ) = 0;

    // Called when a level is shutdown (including changing levels)
    virtual void            LevelShutdown( void ) = 0;
    // This is called when a game ends (server disconnect, death, restart, load)
    // NOT on level transitions within a game
    virtual void            GameShutdown( void ) = 0;

    // Called once during DLL shutdown
    virtual void            DLLShutdown( void ) = 0;

    // Get the simulation interval (must be compiled with identical values into both client and game .dll for MOD!!!)
    // Right now this is only requested at server startup time so it can't be changed on the fly, etc.
    virtual float            GetTickInterval( void ) const = 0;

    // Give the list of datatable classes to the engine.  The engine matches class names from here with
    //  edict_t::classname to figure out how to encode a class's data for networking
    virtual ServerClass*    GetAllServerClasses( void ) = 0;

    // Returns string describing current .dll.  e.g., TeamFortress 2, Half-Life 2.  
    //  Hey, it's more descriptive than just the name of the game directory
    virtual const char     *GetGameDescription( void ) = 0;      
    
    // Let the game .dll allocate it's own network/shared string tables
    virtual void            CreateNetworkStringTables( void ) = 0;
    
    // Save/restore system hooks
    virtual CSaveRestoreData  *SaveInit( int size ) = 0;
    virtual void            SaveWriteFields( CSaveRestoreData *, const char *, void *, datamap_t *, typedescription_t *, int ) = 0;
    virtual void            SaveReadFields( CSaveRestoreData *, const char *, void *, datamap_t *, typedescription_t *, int ) = 0;
    virtual void            SaveGlobalState( CSaveRestoreData * ) = 0;
    virtual void            RestoreGlobalState( CSaveRestoreData * ) = 0;
    virtual void            PreSave( CSaveRestoreData * ) = 0;
    virtual void            Save( CSaveRestoreData * ) = 0;
    virtual void            GetSaveComment( char *comment, int maxlength, float flMinutes, float flSeconds, bool bNoTime = false ) = 0;
    virtual void            WriteSaveHeaders( CSaveRestoreData * ) = 0;
    virtual void            ReadRestoreHeaders( CSaveRestoreData * ) = 0;
    virtual void            Restore( CSaveRestoreData *, bool ) = 0;
    virtual bool            IsRestoring() = 0;

    // Returns the number of entities moved across the transition
    virtual int                CreateEntityTransitionList( CSaveRestoreData *, int ) = 0;
    // Build the list of maps adjacent to the current map
    virtual void            BuildAdjacentMapList( void ) = 0;

    // Retrieve info needed for parsing the specified user message
    virtual bool            GetUserMessageInfo( int msg_type, char *name, int maxnamelength, int& size ) = 0;

    // Hand over the StandardSendProxies in the game DLL's module.
    virtual CStandardSendProxies*    GetStandardSendProxies() = 0;

    // Called once during startup, after the game .dll has been loaded and after the client .dll has also been loaded
    virtual void            PostInit() = 0;
    // Called once per frame even when no level is loaded...
    virtual void            Think( bool finalTick ) = 0;

#ifdef _XBOX
    virtual void            GetTitleName( const char *pMapName, char* pTitleBuff, int titleBuffSize ) = 0;
#endif

    virtual void            PreSaveGameLoaded( char const *pSaveName, bool bCurrentlyInGame ) = 0;

    // Returns true if the game DLL wants the server not to be made public.
    // Used by commentary system to hide multiplayer commentary servers from the master.
    virtual bool            ShouldHideServer( void ) = 0;

    virtual void            InvalidateMdlCache() = 0;

    // * This function is new with version 6 of the interface.
    //
    // This is called when a query from IServerPluginHelpers::StartQueryCvarValue is finished.
    // iCookie is the value returned by IServerPluginHelpers::StartQueryCvarValue.
    // Added with version 2 of the interface.
    virtual void            OnQueryCvarValueFinished( QueryCvarCookie_t iCookie, edict_t *pPlayerEntity, EQueryCvarValueStatus eStatus, const char *pCvarName, const char *pCvarValue ) = 0;
    
    // Called after the steam API has been activated post-level startup
    virtual void            GameServerSteamAPIActivated( void ) = 0;
    
    virtual void            GameServerSteamAPIShutdown( void ) = 0;
};