diff --git a/Projects/Battleship-Bot.md b/Projects/Battleship-Bot.md new file mode 100644 index 00000000..4e4d7a88 --- /dev/null +++ b/Projects/Battleship-Bot.md @@ -0,0 +1,32 @@ +# Battleship Bot + +**Tier:** 3-Advanced + +Battleship Bot is takes the [Battleship Game Engine](./Battleship-Game-Engine.md) +to the next level. This challenge uses your Battleship Game Engine to create a +presentation layer using Discord's bot API to allow you to play the game +via a Discord chat. + +## User Stories + +- [ ] User can display game rules by entering `bb help` into the chat window. +- [ ] User can start a game by entering `bb start` into the chat +- [ ] User can target a cell by enteering `bb shoot r,c` into the chat window, where `r` and `c` are the row and column coordinates of the cell to be targeted. +- [ ] User can see the game board showing hits and misses displayed by the bot after each shot is taken +- [ ] User can see an congratulations message after the shot that sinks the last remaining ship. + +## Bonus features + +- [ ] User can surrender a game by entering `bb surrender` in the chat window. +- [ ] User can see a card containing a graphical representation of the hits and misses rather than a simple 2D table of characters. + +## Useful links and resources + +- [Battleship Game Engine](./Battleship-Game-Engine.md) +- [How to Create a Discord Bot Under 15 Minutes](https://medium.freecodecamp.org/how-to-create-a-discord-bot-under-15-minutes-fb2fd0083844) +- [Using Embeds in Messages](https://anidiots.guide/first-bot/using-embeds-in-messages) +- [Discord Developer Portal](https://discordapp.com/developers/docs/intro) + +## Example projects + +- [Gamebot(Battleship)](https://repl.it/talk/challenge/GameBot-Battleship/8813) diff --git a/README.md b/README.md index bca41fd8..3b1c3efd 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,7 @@ required to complete them. | Name | Description | Tier | | -------------------------------------------------------------- | ---------------------------------------------------- | ---------- | +| [Battleship Bot](./Projects/Battleship-Bot.md) | Create a Discord bot that plays Battleship | 3-Advanced | | [Battleship Game Engine](./Projects/Battleship-Game-Engine.md) | Create a callable engine to play the Battleship game | 3-Advanced | | [Chat App](./Projects/Chat-App.md) | Real-time chat interface | 3-Advanced | | [GitHub Timeline](./Projects/GitHub-Timeline-App.md) | Generate a timeline of a users GitHub Repos | 3-Advanced |