utarwyn/discord-tictactoe repository overview

⁠ An innovative Bot for playing Tic Tac Toe on Discord!
Created with discord.js⁠.

⁠ ⁠ ⁠ ⁠

"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⁠. 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.

⁠Installation

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

The bot works out-of-the-box. But if you want to configure it, check config.example.json⁠ 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⁠ 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⁠:
   npm install discord-tictactoe@^4 or yarn add discord-tictactoe@^4
3. Import module into your script:

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

   Copy
4. Check usage examples in this wiki page⁠.

⁠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⁠.

⁠License

"Discord TicTacToe" is open-sourced software licensed under the Apache-2.0 license⁠.

---