TricksterCards / TricksterBots

Suggest methods for bots used in Trickster Cards.
MIT License
9 stars 8 forks source link

TricksterBots

This repository contains the source for for the suggest methods of the Trickster Cards bots (computer players) along with a Web API driver for local testing.

Requirements

Getting Started

Create and clone a fork of this repository from which to submit pull requests. If you're not familiar with GitHub's pull request process you can learn about using GitHub Desktop to accomplish this here:

After installing the requirements and cloning this repository, open the Visual Studio solution file TricksterBots.sln. This will open a solution with 3 projects: TestBots, TricksterBots, and WebAPI.

Bot source is located in the Bots folder in the TricksterBots project. It is organized into game folders. Most games have only file file: gameBot.cs.

Documentation on the classes and interfaces used by the bots can be viewed at https://www.trickstercards.com/home/help/BotClasses.html.

Testing

Unit testing is done using the TestBots project. These are the tests that will run automatically against any pull requests. You can use the Test Explorer in Visual Studio to run the full suite or individual tests on your own machine.

Local testing in a live game (optional) is done using the WebAPI project. It contains Web API controllers that invoke the suggest methods on a game's bot. Start this project -- generally with debugging -- and click the link on the top line of the Trickster Web Bot API page displayed. To watch suggestion activity, open the browser's dev tools, and display the console. Filter the messages with "Bot suggested" and you'll see only the messages for the bot calls.