https://github.com/utarwyn/discord-tictactoe

Highly customizable innovative Discord Bot for playing Tic-Tac-Toe 🎮🏅
https://github.com/utarwyn/discord-tictactoe

discord discord-bot discord-games discord-js tic-tac-toe

Last synced: about 23 hours ago
JSON representation

Highly customizable innovative Discord Bot for playing Tic-Tac-Toe 🎮🏅

• Host: GitHub
• URL: https://github.com/utarwyn/discord-tictactoe
• Owner: utarwyn
• License: apache-2.0
• Created: 2017-10-26T17:50:52.000Z (about 7 years ago)
• Default Branch: next
• Last Pushed: 2024-12-20T04:51:12.000Z (4 days ago)
• Last Synced: 2024-12-20T07:08:40.452Z (4 days ago)
• Topics: discord, discord-bot, discord-games, discord-js, tic-tac-toe
• Language: TypeScript
• Homepage: https://npmjs.com/package/discord-tictactoe
• Size: 1.51 MB
• Stars: 99
• Watchers: 6
• Forks: 37
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        

  

  

  



  


    

      An innovative Bot for playing Tic Tac Toe on Discord!

      


      Created with discord.js.

    

  


  


    

    

    

    

  

  

  



## About

"Discord TicTacToe" is a **self-hosted NodeJS bot** which allows you to play the popular TicTacToe game on Discord.

Invite your friends or play against our robot, a fearsome opponent. Use `/tictactoe` command to challenge someone else

and use buttons to play, so simple! Works **out-of-the-box**, no configuration needed.

If you have a problem when using the bot, or you want to propose a new feature, feel free to open an issue.

Have fun! 🥳

## Requirements

Before installing the bot, you need to create your own [Discord Application][6].

Then, you can install the bot via Docker or npm (check below!). If you are not a programmer, I recommend you to opt for Docker because its the easiest solution.

> [!IMPORTANT]

> Make sure your Discord bot has these permissions in all channels where games can be played:

> "Read message history", "Send messages", "View channel", "Application commands" or "Add reactions" depending on what you plan to use.

## Installation

The module is suitable for discord.js **v13** and **v14**. Check the table below to see which version meets your needs.

| discord.js | Node.JS | Module    | Status      | NPM package              | Docker image                    |

| ---------- | ------- | --------- | ----------- | ------------------------ | ------------------------------- |

| v14.\*     | 16.11+  | v4.\*     | Active      | discord-tictactoe@^4     | utarwyn/discord-tictactoe@4     |

| v13.\*     | 16.6+   | v3.\*     | Active      | discord-tictactoe@^3     | utarwyn/discord-tictactoe@3     |

| ~~v12.\*~~ | ~~14+~~ | ~~v2.\*~~ | End-of-life | ~~discord-tictactoe@^2~~ | ~~utarwyn/discord-tictactoe@2~~ |

The bot works **out-of-the-box**. But if you want to configure it, check [config.example.json][7] file in the config folder.

## Running via Docker

1. Make sure to have Docker installed.

2. Start Docker container based on one of our [DockerHub images][1] using an API token:\

   `docker run -e TOKEN=YOUR_TOKEN utarwyn/discord-tictactoe@4`

3. You can pass options directly with `-e OPTION_NAME=option_value` or use the option `-v $(pwd)/config/config.json:/app/config/config.json` to load an entire config file.

## Running via Node.js

1. Check with `node -v` that you are running appropriate Node.js version.

2. Install the project from [npm][2]:\

   `npm install discord-tictactoe@^4` or `yarn add discord-tictactoe@^4`

3. Import module into your script:

   ```javascript

   const TicTacToe = require('discord-tictactoe');

   ```

4. Check usage examples in this [wiki page][10].

## Setup slash command ✨

Slash command are enabled by default **starting from v3**!\

Just mention the bot with `tttdeploy` somewhere in your server to install it (admin only).

🚀 Want more info? Check [this detailed guide][8].

## License

"Discord TicTacToe" is open-sourced software licensed under the [Apache-2.0 license][3].

---

> GitHub [@utarwyn][4]  ·  Twitter [@Utarwyn][5]

[1]: https://hub.docker.com/r/utarwyn/discord-tictactoe

[2]: https://www.npmjs.com/package/discord-tictactoe

[3]: https://github.com/utarwyn/discord-tictactoe/blob/next/LICENSE

[4]: https://github.com/utarwyn

[5]: https://twitter.com/Utarwyn

[6]: https://discordapp.com/developers/applications

[7]: https://github.com/utarwyn/discord-tictactoe/blob/next/config/config.example.json

[8]: https://github.com/utarwyn/discord-tictactoe/wiki/Using-slash-command-in-V3-and-V4

[9]: https://github.com/utarwyn/discord-tictactoe/wiki/Using-slash-command-in-V2

[10]: https://github.com/utarwyn/discord-tictactoe/wiki/Usage-examples-with-Node.js