Installation Guide

These installation instructions will guide you through the processes of downloading and compiling SteamBot. There are no releases yet and the bot source code must be cloned from Github and compiled in order to run it.

Install Git

Find a Git installation for your platform and install it. On Windows systems you can use [Github for Windows] (http://windows.github.com/). Whatever you install, it should provide a command prompt shell or integrate with an existing system prompt.

Getting the Code

You can NOT use the Github zip file download. You must clone the repository

To clone the git repository available here on Github, type this into your command prompt:

$ git clone https://github.com/Jessecar96/SteamBot.git

Once this is done, you'll need to initialize the sub-modules that SteamBot requires to be downloaded. To do this this command at the command prompt:

$ cd SteamBot
$ git submodule update --init

This will place SteamBot's needed external dependencies in SteamBot\Lib\. Once these are downloaded you have all the files needed to compile the source code.

Compiling the Code

To compile the source code use your favorite C# IDE to open [the solution file] (https://github.com/Jessecar96/SteamBot/blob/master/SteamBot.sln).

Development was done in Microsoft Visual Studio 2010 and MonoDevelop and both of those IDE can be used to compile the code. Visual Studio does provide a free "Express Edition" that can be used and MonoDevelop is a free and open source IDE.

Once the code is compiled it should output an executable to SteamBot\Bin\<type>\SteamBot.exe where <type> is either Debug or Release depending on what you have selected. The default should be Debug. You can now move to configuring your bots via the settings.json file.

Note, if you are using MonoDevelop and get an error similar to The type or namespace name 'ProtoBuf' could not be found in the global namespace, the work around is to build the solution twice. This error occurs because MonoDevelop doesn't contain a way to specify build order, and certain projects within the solution must be built before another (mainly protobuf-net needs to be built before SteamKit). Another option is to use Visual Studio 2010. Note that the solution file is currently for Visual Studio 2010. If you are using a new version, you may need to respecify build order.

Configuring your Bot

Using the settings.json file is the main way to configure the bot. See the [Configuration Guide] (Configuration-Guide) for detailed information about using this file to configure your bot.