Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
RimuruDev committed Nov 12, 2023
1 parent 47f81b3 commit 6f7334e
Showing 1 changed file with 58 additions and 0 deletions.
58 changes: 58 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Tic Tac Toe in Unity Editor

[English](README.md) | [Русский](README_RU.md)

Welcome to the Tic Tac Toe game designed for the Unity Editor, created by RimuruDev. This simple yet fun editor extension allows you to play the classic Tic Tac Toe game right within Unity!

## Installation

### Prerequisites
- Unity Editor (2019.4 or later recommended).

### Steps
1. **Download the Package:**
- Navigate to the [Releases](https://github.com/RimuruDev/Unity-TicTacToeEditorWindow/releases) section of this repository.
- Download the latest release of the Tic Tac Toe Unity package.

2. **Importing in Unity:**
- Open your Unity project.
- Go to `Assets` -> `Import Package` -> `Custom Package...`
- Select the downloaded Tic Tac Toe package and import it into your project.

## How to Play

1. **Open the Game:**
- In Unity, go to the menu bar.
- Navigate to `RimuruDev Games` -> `Tic Tac Toe`.
- Click on it to open the Tic Tac Toe editor window.

2. **Playing the Game:**
- The game is a standard 3x3 Tic Tac Toe.
- Click on an empty cell to make a move.
- The game alternates turns between X and O.
- The game announces a winner or a draw and resets automatically.

## Contributing

Interested in contributing to this project? We welcome all kinds of contributions, from bug fixes to feature enhancements.

1. **Fork the Repository:**
- Fork the [Tic Tac Toe repository](https://github.com/RimuruDev/Unity-TicTacToeEditorWindow) on GitHub.

2. **Make Your Changes:**
- Clone your fork locally.
- Make your changes in a new branch.

3. **Submit a Pull Request:**
- Push your changes to your fork.
- Open a pull request in the original repository.

Don't hesitate to submit issues or feature requests on the [GitHub Issues](https://github.com/RimuruDev/Unity-TicTacToeEditorWindow/issues) page!

## Contact

If you have any questions or suggestions, feel free to reach out to RimuruDev:
- Email: rimuru.dev@gmail.com
- GitHub: [RimuruDev](https://github.com/RimuruDev)
- LinkedIn: [Rimuru's LinkedIn](https://www.linkedin.com/in/rimuru/)
- GitHub Organization: [Rimuru-Dev](https://github.com/Rimuru-Dev)

0 comments on commit 6f7334e

Please sign in to comment.