Skip to content
Warcraft III game hosting bot
Branch: uc
Clone or download
Pull request Compare This branch is 16 commits ahead of uakfdotb:luna.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
StormLib
bncsutil
ghost
.gitignore
LICENSE
README.md
cron_functions.php
default.cfg
ghost_readme.txt
install.sql
ipblacklist.txt
language.cfg
triggers.sql

README.md

GPLv3 License

UC-GHost

uc-ghost is a hosting bot for the Warcraft III multiplayer game. The main purpose of this bot is to automate game hosting and provide additional features, enabling server-like hosting for Warcraft III rather than relying on players serving as hosts.

uc-ghost is forked from ent-ghost by Jack Lu, which was in turn forked from the original GHost++ project by Trevor Hogan.

Installation

The follow libraries are required, and are probably available in your preferred package manager:

A MySQL server is also required and expected to already be setup. This installation guide does not cover how to setup a MySQL server.

On Debian they may be installed, along with basic dependencies for compilation and git, using the following command:

sudo apt-get install build-essential git libboost1.55-all-dev libgeoip-dev libgmp-dev zlib1g-dev libbz2-dev libmysqlclient-dev

After all the requirements are installed, you may procede with the compilation.

  1. Download the repository and enter it
git clone https://github.com/naanselmo/uc-ghost.git
cd uc-ghost
  1. Compile BNCSUtil and install it
cd bncsutil/src/bncsutil
make
make install
cd ../../..
  1. Compile StormLib and install it
cd StormLib/stormlib
make
make install
cd ../..
  1. Compile UC-Ghost and move the binary
cd ghost
make
mv ghost++ ..
  1. Create a user in your MySQL server with full rights to a database that uc-ghost will be using. The tables should be created using the provided install.sql file. This user's credentials will be used during step 8.

  2. Download MaxMind's Legacy GeoIP databases in binary format from here, renaming the extracted file to geoip.dat (or configuring "bot_geoipfile" in step 8 to match the file name and location).

  3. Create the default directories and files (other names may be used provided they're specified during step 8)

mkdir mapcfgs maps replays savegames
touch gameloaded.txt gameover.txt phrases.txt motd.txt welcome.txt
  1. Copy default.cfg to ghost.cfg and make your changes. Please note that ghost.cfg is loaded after default.cfg, meaning it will override any settings that are redefined. You may skip this step and modify default.cfg directly, and any undefined values will use the defaults specified in the source code.

    It is especially important to properly configure the database and bnet settings, located near the end of the file. Without these parameters properly configured the bot will not run properly, if at all.

  2. Use one of the following methods to keep the bancache and gametrack tables up to date:

  • (Recommended) Add the MySQL triggers in triggers.sql to your database.
  • (Not recommended) Create a script based around the cron_functions.php file and execute it frequently through cron.
  1. (Optional) Modify the extra configuration files: gameloaded.txt, gameover.txt, motd.txt, phrase.txt, welcome.txt

Your installation should now be ready for use.

Overview of files and directories

This section is a guide on the typical configuration files used for uc-ghost

default.cfg

This is the first configuration file that is loaded.

This file's syntax is relatively simple, as seen in this snippet:

# This is a comment
## This is also a comment
##...# And so is this, with any amount of #s
property1 = value1

# The empty line was ignored
property2 = value2
property3 = value3

ghost.cfg

This configuration file is similar to default.cfg and is optional. Its syntax is exactly the same as in default.cfg, and will override any values that aren't redefined.

This becomes useful when you wish to run multiple bots with similar but not identical configuration files, and wish to modify them all at once: the default.cfg may be shared, and contain the values that are shared, while your ghost.cfg file may contain unique values such as accounts and ports.

language.cfg

# This line is completely ignored
##...# And so is this one, no matter how many #s

# That empty line was also ignored
lang_0001 = Text between dollar-signs are keywords that may be [$REPLACED$] during runtime.
lang_0002 = Only $CERTAIN$ $KEYWORDS$ are $ACTUALLY$ replaced.
# That previous line may be parsed into "Only $CERTAIN$ replaced_keyword are $ACTUALLY$ replaced."
# And just because a keyword worked on a previous line, doesn't mean it'll work again.
# Each line has its own individual replacements from variables during runtime.

geoip.dat

This is MaxMind's Legacy GeoIP database, in binary format, that can be downloaded from here. There's not much to say about it.

welcome.txt

The contents of this file will be whispered to every user that joins the bot's channel. For this reason, it is a good idea to keep it short and concise. Multi-line messages may not be fully delivered, and may cause issues when multiple users join the channel in quick succession.

Like in language.cfg, certain keywords are replaced. At the moment the following keywords may be used:

  • $USER$ - Replaced with the user's name
  • $CLANRANK$ - Replaced with the user's rank in the clan, should he be in it. If the user is not in the bot's clan, the value will be "Non-Member"
  • $CHANNEL$ - Replaced with the current channel

motd.txt

The contents of this file will be sent to every user that enters the lobby. Since it isn't sent through Battle.net, and is instead delivered as a lobby message, it can be multiline without any problems. You can therefore write in as much information as you'd like, up to a maximum of 8 lines.

Similar to language.cfg and welcome.txt, certain keywords are replaced. At the moment the following keywords may be used:

  • $BOTNAME$ - Replaced with the bot's name
  • $PLAYERNAME$ - Replaced with the user's name
  • $GAMENAME$ - Replaced with the current game name
  • $HCLSTRING$ - Replaced with the current HCL string, if any

gameloaded.txt

The contents of this file will be sent as an All-Chat message as soon as every player has finished loading the game.

gameover.txt

The contents of this file will be sent as an All-Chat message whenever the game is about to end. Not every game supports this message.

phrase.txt

Each line of this file is a possible message to be sent out when using the "slap" command.

Similar to other files with keyword replacements, this file allows two keywords:

  • $USER$ - Replaced with the user's name
  • $VICTIM$ - Replaced with the victim's name, victim being whoever the command is used on.

Additional Reading

This readme isn't a comprehensive guide, and the original GHost++ readme remains extremely useful. No adaptations have been made to this file, apart from removing the compilation section.

The official GHost++ forum is also extremely useful.

License

uc-ghost is mostly licensed under GPLv3. The files modified by this project are all covered by GPLv3. Certain files were not modified by this project but are included in this repository as dependencies, and may or may not be licensed under GPLv3.

Any license or copyright notice contained within a file has priority over the GPLv3 license, should they differ.

You can’t perform that action at this time.