[Guide] Ghost++

=====================
GHost++ Version 13.0
=====================

GHost++ is a port of the original GHost project to C++ (ported by Trevor Hogan).
The original GHost project can be found here: http://ghost.pwner.org/
You can compile and run GHost++ on Windows or Linux with this release although the code should be mostly portable to other operating systems such as OS X with only very minor changes.
Since it is written in native code you do not need to install the .NET framework on Windows or Mono on Linux.

#####################
# BOT CONFIGURATION #
#####################

### the log file

bot_log =

### the language file

bot_language = language.cfg

### new patch version

bot_patch23ornewer = 1

### the path to your local Warcraft III directory
### this path must contain war3.exe, storm.dll, and game.dll
### this path must end in your system's path seperator (i.e. "\" on Windows or "/" on Linux)
### if this path contains War3Patch.mpq the bot will attempt to extract "Scripts\common.j" and "Scripts\blizzard.j" on startup and write them to bot_mapcfgpath (which is defined later in this file)
### common.j and blizzard.j are only required for automatically calculating map_crc, you do not need them if your map config files already contain map_crc

bot_war3path = C:\Program Files\Warcraft III\

### the address GHost++ will bind to when hosting games (leave it blank to bind to all available addresses)
### if you don't know what this is just leave it blank

bot_bindaddress =

### the port GHost++ will host battle.net games on (this must be different from your admingame_port)

bot_hostport = 6000

### maximum number of games to host at once

bot_maxgames = 5

### command trigger for ingame only (battle.net command triggers are defined later)

bot_commandtrigger = !

### the path to the directory where you keep your map config files (must end in your system's path seperator)
### this directory can also contain common.j and blizzard.j (extracted from War3Patch.mpq)
### common.j and blizzard.j are only required for automatically calculating map_crc, you do not need them if your map config files already contain map_crc

bot_mapcfgpath = mapcfgs\

### the path to the directory where you keep your savegame files (must end in your system's path seperator)

bot_savegamepath = savegames\

### the path to the directory where you keep your map files (must end in your system's path seperator)
### GHost++ doesn't require map files but if it has access to them it can send them to players and automatically calculate most map config values
### GHost++ will search [bot_mappath + map_localpath] for the map file (map_localpath is set in each map's config file)

bot_mappath = maps\

### whether to save replays or not

bot_savereplays = 0

### the path to the directory where you want GHost++ to save replays (must end in your system's path seperator)

bot_replaypath = replays\

### the bot's virtual host name as it appears in the game lobby
### colour codes are defined by the sequence "|cFF" followed by a six character hexadecimal colour in RRGGBB format (e.g. 0000FF for pure blue)
### the virtual host name cannot be longer than 15 characters including the colour code, if you try to go over this limit GHost++ will use the default virtual host name

bot_virtualhostname = |cFF4080C0GHost

### whether to hide each player's IP address from other players or not

bot_hideipaddresses = 0

### whether to require spoof checks or not
### disabling spoof checks just turns off automatic spoof checks and requiring players to be spoof checked before starting the game
### spoof checks need to be enabled if you want GHost++ to detect which realm each player came from (use the !check command to see the realm)
### you can always manually spoof check by whispering the bot (and in fact is required before running admin commands)

bot_spoofchecks = 1

### whether to display game refresh messages by default
### this can always be changed for a particular game with the !refresh command

bot_refreshmessages = 0

### whether to automatically lock games when the owner joins

bot_autolock = 0

### whether to automatically save games when a player disconnects
### this can always be changed for a particular game with the !autosave command

bot_autosave = 0

### whether to allow map downloads or not
### set to 0 to disable map downloads
### set to 1 to enable map downloads
### set to 2 to enable conditional map downloads (an admin must start each map download with the !download or !dl command)

bot_allowdownloads = 1

### whether to ping players during map downloads or not
### GHost++ will always stop pinging any players who are downloading the map
### this config value determines whether GHost++ should stop pinging *all* players when at least one player is downloading the map

bot_pingduringdownloads = 0

### the maximum number of players allowed to download the map at the same time

bot_maxdownloaders = 3

### the maximum combined download speed of all players downloading the map (in KB/sec)

bot_maxdownloadspeed = 100

### use LC style pings (divide actual pings by two)

bot_lcpings = 1

### auto kick players with ping higher than this

bot_autokickping = 400

### automatically close the game lobby if a reserved player (or admin) doesn't join it for this many minutes
### games which are set to automatically start when enough players join are exempt from this limit (e.g. autohosted games)

bot_lobbytimelimit = 10

### the game latency
### this can always be changed for a particular game with the !latency command (which enforces a minimum of 50 and a maximum of 500)

bot_latency = 100

### the maximum number of packets a player is allowed to get out of sync by before starting the lag screen
### before version 8.0 GHost++ did not have a lag screen which is the same as setting this to a very high number
### this can always be changed for a particular game with the !synclimit command (which enforces a minimum of 10 and a maximum of 10000)

bot_synclimit = 50

### whether votekicks are allowed or not

bot_votekickallowed = 1

### the percentage of players required to vote yes for a votekick to pass
### the player starting the votekick is assumed to have voted yes and the player the votekick is started against is assumed to have voted no
### the formula for calculating the number of votes needed is votes_needed = ceil( ( num_players - 1 ) * bot_votekickpercentage / 100 )
### this means it will round UP the number of votes required
### if you set it to 100 it will require 2/3, 3/4, 4/5, 5/6, 6/7, 7/8, 8/9, 9/10, 10/11, and 11/12 votes to pass
### if you set it to 90 it will require 2/3, 3/4, 4/5, 5/6, 6/7, 7/8, 8/9, 9/10, 9/11, and 10/12 votes to pass
### if you set it to 80 it will require 2/3, 3/4, 4/5, 4/6, 5/7, 6/8, 7/9, 8/10, 8/11, and 9/12 votes to pass
### if you set it to 70 it will require 2/3, 3/4, 3/5, 4/6, 5/7, 5/8, 6/9, 7/10, 7/11, and 8/12 votes to pass
### if you set it to 60 it will require 2/3, 2/4, 3/5, 3/6, 4/7, 5/8, 5/9, 6/10, 6/11, and 7/12 votes to pass

bot_votekickpercentage = 100

### the default map (the .cfg is added automatically)

bot_defaultmap = dota6.59d

### the MOTD file
### the first 8 lines of this file will be displayed when a player joins the game
### if this file doesn't exist a default MOTD will be used

bot_motdfile = motd.txt

### the gameloaded file
### the first 8 lines of this file will be displayed when the game finished loading (after the player loading times are displayed)

bot_gameloadedfile = gameloaded.txt

### the gameover file
### the first 8 lines of this file will be displayed when the game is over
### this only works when using a stats class - note: at the time of this writing the only stats class is for DotA maps

bot_gameoverfile = gameover.txt

############################
# ADMIN GAME CONFIGURATION #
############################

### whether to create the admin game or not (see readme.txt for more information)

admingame_create = 0

### the port GHost++ will host the admin game on (this must be different from your bot_hostport)

admingame_port = 6113

### the admin game password

admingame_password =

##########################
# DATABASE CONFIGURATION #
##########################

### database type
### use "sqlite3" for a local SQLite database
### use "mysql" for any MySQL database

db_type = sqlite3

### sqlite3 database configuration
### this is only used if your database type is SQLite

db_sqlite3_file = ghost.dbs

### mysql database configuration
### this is only used if your database type is MySQL

db_mysql_server = localhost
db_mysql_database = ghost
db_mysql_user = YOUR_USERNAME
db_mysql_password = YOUR_PASSWORD
db_mysql_port = 0

############################
# BATTLE.NET CONFIGURATION #
############################

### which battle.net server to connect to
### 1.) useast.battle.net
### 2.) uswest.battle.net
### 3.) asia.battle.net
### 4.) europe.battle.net
### note that each banned player is tied to the realm it was created on and the realm is case sensitive
### so if you change your realm from useast.battle.net to USEAST.BATTLE.NET it'll still connect but anyone previously banned will not be counted as banned until you change it back

bnet_server = server.eurobattle.net

### your Warcraft III: Reign of Chaos CD key

bnet_cdkeyroc = FFFFFFFFFFFFFFFFFFFFFFFFFF

### your Warcraft III: The Frozen Throne CD key

bnet_cdkeytft = FFFFFFFFFFFFFFFFFFFFFFFFFF

### your battle.net username

bnet_username = paiN_bot

### your battle.net password

bnet_password = paiN_bot_Password

### the first channel to join upon entering battle.net

bnet_firstchannel = W3-Bots

### the root admin on this battle.net server only

bnet_rootadmin = paiN

### command trigger for this battle.net server only

bnet_commandtrigger = !

### whether to automatically add your friends list to each game's reserved list

bnet_holdfriends = 1

### whether to automatically add your clan members list to each game's reserved list

bnet_holdclan = 1

### you will need to edit this section of the config file if you're connecting to a PVPGN server
### your PVPGN server operator will tell you what to put here

bnet_custom_war3version = 24
bnet_custom_exeversion = 230 1 24 1
bnet_custom_exeversionhash = 48 158 165 202
bnet_custom_passwordhashtype = pvpgn

###

In battle.net (via local chat or whisper at any time):
!addadmin add a new admin to the database
!addban add a new ban to the database for this realm
!ban alias to !addban
!say /join change channel
!close close slot
!countadmins display the total number of admins
!countbans display the total number of bans for this realm
!deladmin remove an admin from the database
!delban remove a ban from the database for this realm
!end end a game in progress (disconnect everyone)
!exit [force] shutdown ghost++, optionally add [force] to skip checks
!getgame display information on a game in progress
!getgames display information on all games
!load load a config file (for changing maps) - the ".cfg" is automatically appended to the filename
!map alias to !load
!open open slot
!priv host private game
!privby host private game by another player (gives access to admin commands in the game lobby and in the game)
!pub host public game
!pubby host public game by another player (gives access to admin commands in the game lobby and in the game)
!quit [force] alias to !exit
!say send to battle.net as a chat command
!sp shuffle players
!start [force] start game, optionally add [force] to skip checks
!stats [name] display basic player statistics, optionally add [name] to display statistics for another player (can be used by non admins)
!statsdota [name] display DotA player statistics, optionally add [name] to display statistics for another player (can be used by non admins)
!swap swap slots
!unban alias to !delban
!unhost unhost game in lobby
!version display version information (can be used by non admins)
[color=green]In game lobby:[/color
!a alias to !abort
!abort abort countdown
!checkban check if a user is banned on this realm
!close close slot
!comp create a computer in slot of skill (skill is 0 for easy, 1 for normal, 2 for insane)
!compcolour (s) (c) change a computer's colour in slot (s) to (c) (c goes from 1 to 12)
!comphandicap (s) (h) change a computer's handicap in slot (s) to (h) (h is 50, 60, 70, 80, 90, or 100)
!comprace (s) (r) change a computer's race in slot (s) to (r) (r is "human", "orc", "night elf", "undead", or "random")
!compteam (s) (t) change a computer's team in slot (s) to (t) (t goes from 1 to # of teams)
!from display the country each player is from
!hold hold a slot for someone
!kick kick a player (it tries to do a partial match)
!latency set game latency (50-500)
!open open slot
!ping [number] ping players, optionally add [number] to kick players with ping above [number]
!priv rehost as private game
!pub rehost as public game
!refresh enable or disable refresh messages
!sendlan (ip) [port] send a fake LAN message to IP address (ip) and port [port], default port is 6112 if not specified
!sp shuffle players
!start [force] start game, optionally add [force] to skip checks
!stats [name] display basic player statistics, optionally add [name] to display statistics for another player (can be used by non admins)
!statsdota [name] display DotA player statistics, optionally add [name] to display statistics for another player (can be used by non admins)
!swap swap slots
!unhost unhost game
In game:
!addban add a new ban to the database for this realm (it tries to do a partial match)
!ban alias to !addban
!checkban check if a user is banned on this realm
!end end the game (disconnect everyone)
!kick kick a player (it tries to do a partial match)
!latency set game latency (50-500)
!muteall mute global chat (allied and private chat still works)
!synclimit set sync limit for the lag screen (10-10000), leave blank to see current sync limit
!unmuteall unmute global chat
ATTENTION : All commands are listed with default '!' trigger. If you change it for some other ( like '.' ) commands will be different, obviously