Difference between revisions of "FFA/FFABot/Instructions"

From Armagetron
Line 20: Line 20:
 
The source can be found at [http://github.com/joshuagranger/cIRC my GitHub page]. However, I have provided you with a zip file in these instructions. If you wish to download it straight from GitHub, simply click "Download .ZIP file" on the lower right hand side. The benefit of using my zip file is that it is potentially easier to navigate through and understand than downloading it from GitHub. Simply extract my zip and open the Solution file. I had to deal with a lot of extra folders when using the GitHub zip files. You are free to do whichever you wish.
 
The source can be found at [http://github.com/joshuagranger/cIRC my GitHub page]. However, I have provided you with a zip file in these instructions. If you wish to download it straight from GitHub, simply click "Download .ZIP file" on the lower right hand side. The benefit of using my zip file is that it is potentially easier to navigate through and understand than downloading it from GitHub. Simply extract my zip and open the Solution file. I had to deal with a lot of extra folders when using the GitHub zip files. You are free to do whichever you wish.
 
====Windows====
 
====Windows====
<pre>1. Optain the source code from GitHub or from [http://www.latech.edu/~jmg075/WindowsFFABot.zip this .zip file].
+
1. Optain the source code from GitHub or from [http://www.latech.edu/~jmg075/WindowsFFABot.zip this .zip file].<b>
2. Open the Solution file (.sln) and make sure it loads properly inside your IDE. Recommended IDE for this process is Visual Studio.</pre>
+
2. Open the Solution file (.sln) and make sure it loads properly inside your IDE. Recommended IDE for this process is Visual Studio.<b>
3. Click "Build."
+
3. Click "Build."</b>
4. Navigate to the output folder and you should have a built executable file.
+
4. Navigate to the output folder and you should have a built executable file.</b>
  
 
====Linux====
 
====Linux====
<pre>1. Optain the source code from GitHub or from [http://www.latech.edu/~jmg075/LinuxFFABot.zip this .zip file].
+
1. Optain the source code from GitHub or from [http://www.latech.edu/~jmg075/LinuxFFABot.zip this .zip file].
 
1*. If you download the file from GitHub, you may run into problems (I did). Instead, I recommend getting the source from the .zip file I have provided you in  
 
1*. If you download the file from GitHub, you may run into problems (I did). Instead, I recommend getting the source from the .zip file I have provided you in  
 
the previous line. It has been set up to load properly with MonoDevelop.
 
the previous line. It has been set up to load properly with MonoDevelop.
 
2. Open the Solution file (.sln) (preferably using MonoDevelop).
 
2. Open the Solution file (.sln) (preferably using MonoDevelop).
 
3. Click "Build."
 
3. Click "Build."
4. Assuming no errors, you should be able to navigate to the output folder and see an executable file.</pre>
+
4. Assuming no errors, you should be able to navigate to the output folder and see an executable file.
  
 
==Instructions==
 
==Instructions==

Revision as of 12:33, 24 August 2014

Preliminary Information

This is meant to be a complete guide to using the FFABot. This article should leave you with full understanding of how to use it.

Step 1: Installation (Obtaining an executable of the program)
Step 2: Running the program
Step 3: Communicating with the bot

Installation

Before you utilize this bot, you must first have the working program on your computer. There are two options when it comes to this regard: you can build the program yourself from source or you can download the executable file and simply click on it. Below you will find the executable files for Linux and Windows, as well as the source for both. There is no need to have an "installer" as it is a standalone application which has no external settings.

Executable

For Windows: Click here to download the executable file.

For Linux: Click here to download the executable file. *Note: it was built from Kubuntu, but I imagine it should still work on most distros.

In both cases, be sure to click save file rather than "open", or "run"

Build from Source

The source can be found at my GitHub page. However, I have provided you with a zip file in these instructions. If you wish to download it straight from GitHub, simply click "Download .ZIP file" on the lower right hand side. The benefit of using my zip file is that it is potentially easier to navigate through and understand than downloading it from GitHub. Simply extract my zip and open the Solution file. I had to deal with a lot of extra folders when using the GitHub zip files. You are free to do whichever you wish.

Windows

1. Optain the source code from GitHub or from this .zip file. 2. Open the Solution file (.sln) and make sure it loads properly inside your IDE. Recommended IDE for this process is Visual Studio. 3. Click "Build." 4. Navigate to the output folder and you should have a built executable file.

Linux

1. Optain the source code from GitHub or from this .zip file. 1*. If you download the file from GitHub, you may run into problems (I did). Instead, I recommend getting the source from the .zip file I have provided you in the previous line. It has been set up to load properly with MonoDevelop. 2. Open the Solution file (.sln) (preferably using MonoDevelop). 3. Click "Build." 4. Assuming no errors, you should be able to navigate to the output folder and see an executable file.

Instructions