RNtaate / tic-tac-toe

This project emulates the tic-tac-toe game obtained from the Odin project https://www.theodinproject.com/courses/ruby-programming/lessons/oop

Tic Tac Toe

Implementation of tic tack toe game as outlined here by the Odin Project.

Essential parts of this doc (Table of content)

Description of tic-tac-toe

How to open the tic-tac-toe game

How to play tic-tac-toe

Contributions

Authors

Description of tic-tac-toe

Tic-tac-toe (American English), noughts and crosses (British English), or Xs and Os is a paper-and-pencil game for two players, X and O, who take turns marking the spaces in a 3×3 grid. The player who succeeds in placing three of their marks in a horizontal, vertical, or diagonal row is the winner. Read more on wikipedia...

This project is the implementation of that tic-tac-toe, which is run on CLI (Command Line Interface), anyone can play it.

Game Board	Winning Board

Built With

• Ruby

How to open the tic-tac-toe game

This game can be played on two platforms:

A. Your computer

B. Online

A. On your computer

Pre-requisites

1. You should have Ruby installed on your computer.
2. Your computer should be able to run terminal or command prompt or bash or Powershell commands.

A. 1. Using Our Release tag

1. Click here and download the zip file of this game
2. Unzip the downloaded file to the folder of your choice
3. Open terminal inside the unzipped folder
4. Run the following command to start the game:

    bin/main.rb

5. At that point you should see the game starting and follow the rules of the game.

A. 2. Using repository

1. Run this command git clone https://github.com/RNtaate/tic-tac-toe.git to clone the repository to your local computer
2. Run cd tic-tac-toe to go inside the game's folder
3. Run the following command to start the game:

    bin/main.rb

5. At that point you should see the game starting and follow the rules of the game.

B. Online

1. click on one of the following links descholar's link or Roy's link
2. When the link has been opened, click the green run button you will see at the top, and follow the game instructions to play.

Note: Whenever you terminate the game before you start it again, remember to clear your terminal by running this command clear

How to play tic-tac-toe

1. When the game is opened, it shows all of the instructions and asks you if you want to continue, you are supposed to enter y if you want to continue, otherwise enter any other key to terminate the game.
2. When you select to continue, the game will ask you names for Player 1 and Player 2.
3. After that it will start to show any player turn using the names you have just entered
4. The very first player, will be assigned X as their mark which will be displayed on the board in accordance with the position they played / selected
5. The second player, will be assigned O as their mark which will be displayed on the board in accordance with the position they played / selected
6. The board is made of nine positions which are numbered, if you enter a number, the number of that position will be replaced with your mark, and it won't be available for being played until game win or game draw
7. When your mark is aligned horizontally, or vertically, or diagonally, that will be a game win
8. When all of the positions have been played, without a game win, that will be a game draw
9. At the end of every game win or game draw, the game will ask if you want to play another round, you are supposed to enter y if you want to continue, otherwise enter any other key to terminate the game.
10. The valid numbers to play are between 1 - 9, if you play something other than that such as word, or letter, or a number above of 9 or below 1 such as zero or negative, or an already played position, the game will show a warning message and it asks you to enter another one which is valid

Contributions

There are two ways of contributing to this project:

1. If you see something wrong or not working, please check the issue tracker section, if that problem you met is not in already opened issues then open the issue by clicking on new issue button.

2. If you have a solution to that, and you are willing to work on it, follow the below steps to contribute:

   1. Fork this repository
   2. Clone it on your local computer by running git clone https://github.com/your-username/tic-tac-toe.git Replace your username with the username you use on github
   3. Open the cloned repository which appears as a folder on your local computer with your favorite code editor
   4. Create a separate branch off the master branch,
   5. Write your codes which fix the issue you found
   6. Commit and push the branch you created
   7. Raise a pull request, comparing your new created branch with our original master branch here

Authors

👤 Mugirase Emmanuel

• Github: @descholar-ceo
• Twitter: @descholar3
• Linkedin: MUGIRASE Emmanuel

👤 Roy Ntaate

• Github: @RNtaate
• Twitter: @RNtaate
• Linkedin: roy-ntaate

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

• Microverse
• The Odin Project

📝 License

This project is MIT licensed.